SIWE在Web3應用中的應用與實踐

SIWE(Sign-In with Ethereum)是一種基於以太坊的用戶身分驗證方式,類似於錢包發起交易,用於證明用戶對錢包的控制權。目前主流錢包插件已廣泛支持這種簡單的身分驗證方式,只需在插件中對信息進行籤名即可。本文主要討論以太坊上的籤名場景,不涉及其他公鏈。

SIWE的適用場景

SIWE主要用於解決錢包地址的身分驗證問題。如果你的應用具有以下需求,可以考慮使用SIWE:

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

對於以查詢功能爲主的應用,如區塊瀏覽器等,可以不使用SIWE。

雖然在應用前端通過錢包連接可以表明身分,但對於需要後端支持的接口調用,僅傳遞地址是不夠的,因爲地址是公開信息,容易被他人盜用。

SIWE的原理與流程

SIWE的流程可概括爲三個步驟:連接錢包、籤名、獲取身分標識。

連接錢包

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

籤名

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

1. 獲取Nonce值:調用後端接口獲取隨機Nonce值,並與當前地址關聯。

2. 構建籤名內容:包括Nonce值、域名、鏈ID、籤名內容等,使用錢包提供的方法進行籤名。

3. 發送籤名:將籤名發送給後端進行驗證。

獲取身分標識

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

實踐指南

以下介紹如何在應用中快速接入SIWE,目標是返回JWT用於用戶身分校驗。注意,此示例僅用於展示基本流程,生產環境使用可能存在安全隱患。

環境準備

本文使用Next.js開發全棧應用,需要準備Node.js環境。

安裝依賴

首先安裝Next.js:

npx create-next-app@14

進入項目目錄後運行:

npm run dev

安裝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 ( <>

接口實現

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, }); }

驗證消息接口

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, }); }

性能優化

爲提高SIWE登入的響應速度,建議使用專門的節點服務替代默認RPC節點。本文使用ZAN的節點服務,可在其控制臺獲取RPC連接。

替換publicClient的默認RPC:

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

這可以顯著減少驗證時間,提高接口速度。