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

这可以显著减少验证时间,提高接口速度。