SIWE:增強Dapp身分驗證的強大工具

SIWE(Sign-In with Ethereum)是一種在以太坊上驗證用戶身分的方法,類似於發起交易,證明用戶對錢包的控制權。目前大多數主流錢包插件都已支持這種簡單的身分驗證方式,只需在插件中對信息進行籤名即可。

本文將重點討論以太坊上的籤名場景,不涉及其他公鏈如Solana、SUI等。

何時需要使用SIWE?

如果你的Dapp具有以下需求,可以考慮使用SIWE:

• 擁有獨立的用戶系統
• 需要查詢與用戶隱私相關的信息

對於主要提供查詢功能的Dapp(如區塊瀏覽器),可以不使用SIWE。

雖然在Dapp上連接錢包後似乎已經證明了身分,但這只對前端有效。對於需要後端支持的接口調用,僅傳遞地址是不夠的,因爲地址是公開信息,容易被冒用。

SIWE的原理和流程

SIWE的流程可以概括爲三個步驟:連接錢包 - 籤名 - 獲取身分標識。讓我們詳細了解這三個步驟。

連接錢包

這是常見的Web3操作,通過錢包插件在Dapp中連接用戶錢包。

籤名

SIWE的籤名步驟包括獲取Nonce值、錢包籤名和後端籤名校驗。

首先需要調用後端接口獲取Nonce值。後端會生成隨機Nonce並與當前地址關聯,爲後續籤名做準備。

前端獲取Nonce值後,構建籤名內容,通常包括Nonce值、域名、鏈ID和籤名內容等。然後使用錢包提供的方法對內容進行籤名。

最後將籤名發送給後端進行驗證。

獲取身分標識

後端校驗籤名通過後,會返回用戶身分標識,如JWT。前端後續請求時帶上地址和身分標識,即可證明對錢包的所有權。

實踐SIWE

我們將使用Next.js開發一個簡單的SIWE應用,目標是讓Dapp能夠返回JWT用於身分驗證。注意,此演示僅用於介紹基本流程,生產環境中可能存在安全隱患。

準備工作

我們需要準備好Node.js環境,並使用Next.js開發全棧項目。

安裝依賴

首先安裝Next.js:

npx create-next-app@14

按提示完成安裝後,進入項目目錄並運行:

npm run dev

訪問localhost:3000即可看到基本的Next.js項目。

安裝SIWE相關依賴

我們將使用Ant Design Web3,它免費、持續維護,使用體驗類似普通組件庫,且支持SIWE。安裝命令如下:

npm install antd @ant-design/web3 @ant-design/web3-wagmi wagmi viem @tanstack/react-query --save

引入Wagmi

在layout.tsx中引入WagmiProvider:

javascript "use client"; import { getNonce, verifyMessage } from "@/app/api"; import { Mainnet, MetaMask, OkxWallet, TokenPocket, WagmiWeb3ConfigProvider, WalletConnect, } from "@ant-design/web3-wagmi"; import { QueryClient } from "@tanstack/react-query"; import React from "react"; import { createSiweMessage } from "viem/siwe"; import { http } from "wagmi"; import { JwtProvider } from "./JwtProvider";

const YOUR_WALLET_CONNECT_PROJECT_ID = "c07c0051c2055890eade3556618e38a6"; const queryClient = new QueryClient();

const WagmiProvider: React.FC = ({ children }) => { const [jwt, setJwt] = React.useState(null);

return ( <wagmiweb3configprovider siwe="｛｛" getnonce:="" async="" (address)=""> (await getNonce(address)).data, createMessage: (props) => { return createSiweMessage({ ...props, statement: "Ant Design Web3" }); }, verifyMessage: async (message, signature) => { const jwt = (await verifyMessage(message, signature)).data; setJwt(jwt); return !!jwt; }, ｝｝ chains={[Mainnet]} transports=｛｛ [Mainnet.id]: http(), ｝｝ walletConnect=｛｛ projectId: YOUR_WALLET_CONNECT_PROJECT_ID, ｝｝ wallets={[ MetaMask(), WalletConnect(), TokenPocket({ group: "Popular", }), OkxWallet(), ]} queryClient={queryClient} > {children} ); };

export default WagmiProvider;

然後添加連接錢包按鈕:

javascript "use client"; import type { Account } from "@ant-design/web3"; import { ConnectButton, Connector } from "@ant-design/web3"; import { Flex, Space } from "antd"; import React from "react"; import { JwtProvider } from "./JwtProvider";

export default function App() { const jwt = React.useContext(JwtProvider);

const renderSignBtnText = ( defaultDom: React.ReactNode, account?: Account ) => { const { address } = account ?? {}; const ellipsisAddress = address ? ${address.slice(0, 6)}...${address.slice(-6)} : ""; return Sign in as ${ellipsisAddress}; };

return ( <>

至此,我們已經實現了基本的SIWE登入框架。

接口實現

現在我們來實現後端校驗用戶身分的接口。

Nonce

Nonce用於增加籤名的可靠性。我們生成隨機字符串並與地址建立關聯:

javascript import { randomBytes } from "crypto"; import { addressMap } from "../cache";

export async function GET(request: Request) { const { searchParams } = new URL(request.url); const address = searchParams.get("address");

if (!address) { throw new Error("Invalid address"); } const nonce = randomBytes(16).toString("hex"); addressMap.set(address, nonce); return Response.json({ data: nonce, }); }

signMessage

signMessage通常由錢包插件完成,我們使用Wagmi的籤名方法。

verifyMessage

後端需要驗證籤名內容並進行安全性校驗:

javascript import { createPublicClient, http } from "viem"; import { mainnet } from "viem/chains"; import jwt from "jsonwebtoken"; import { parseSiweMessage } from "viem/siwe"; import { addressMap } from "../cache";

const JWT_SECRET = "your-secret-key"; // 請使用更安全的密鑰,並添加過期校驗等

const publicClient = createPublicClient({ chain: mainnet, transport: http(), });

export async function POST(request: Request) { const { signature, message } = await request.json();

const { nonce, address = "0x" } = parseSiweMessage(message);

if (!nonce || nonce !== addressMap.get(address)) { throw new Error("Invalid nonce"); }

const valid = await publicClient.verifySiweMessage({ message, address, signature, });

if (!valid) { throw new Error("Invalid signature"); }

const token = jwt.sign({ address }, JWT_SECRET, { expiresIn: "1h" }); return Response.json({ data: token, }); }

優化建議

爲提高驗證速度,建議使用專門的節點服務。可以使用ZAN的節點服務,獲取HTTPS RPC連接後替換代碼中的默認RPC:

javascript const publicClient = createPublicClient({ chain: mainnet, transport: http('), //ZAN節點服務RPC });

這將顯著減少驗證時間,提升接口速度。