SIWE: 让你的DApp更加强大的身份验证方式

SIWE(Sign-In with Ethereum)是一种在以太坊上验证用户身份的方法,类似于发起交易,证明用户对钱包的控制权。目前大多数钱包插件都支持这种简单的身份验证方式,只需在插件中对信息进行签名即可。本文主要讨论以太坊上的签名场景,不涉及其他公链。

项目是否需要SIWE?

如果你的DApp有以下需求,可以考虑使用SIWE:

• 拥有自己的用户体系
• 需要查询与用户隐私相关的信息

但如果你的DApp主要是查询功能,如etherscan这类应用,则不一定需要SIWE。

虽然在DApp上连接钱包后就代表了对钱包的所有权,但这只对前端有效。对于需要后端支持的接口调用,仅传递地址是无法证明身份的,因为地址是公开信息。

SIWE的原理和流程

SIWE的流程可以概括为三个步骤:连接钱包 - 签名 - 获取身份标识。

连接钱包

这是一个常见的Web3操作,通过钱包插件在DApp中连接钱包。

签名

签名步骤包括获取Nonce值、钱包签名和后端签名校验。

首先调用后端接口获取Nonce值,后端会生成随机Nonce并与地址关联。前端获取Nonce后构建签名内容,包括Nonce、域名、链ID等,使用钱包提供的方法进行签名,然后将签名发送给后端。

获取身份标识

后端校验签名通过后,会返回用户身份标识,如JWT。前端后续请求时带上地址和身份标识,即可证明对钱包的所有权。

实践SIWE

我们将使用Next.js开发一个支持SIWE的DApp,目标是返回JWT用于身份校验。

准备工作

1. 安装Next.js:

npx create-next-app@14

2. 安装SIWE相关依赖:

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

引入Wagmi

在layout.tsx中引入WagmiProvider:

typescript "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} > <jwtprovider.provider value="{jwt}">{children}</jwtprovider.provider> ); };

export default WagmiProvider;

添加连接按钮

typescript "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接口

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

验证消息接口

typescript 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节点服务为例,获取以太坊主网HTTPS RPC连接后,替换publicClient的默认RPC:

typescript const publicClient = createPublicClient({ chain: mainnet, transport: http('), //ZAN节点服务RPC });

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