SIWE技术指南:为Dapp构建以太坊身份验证系统

SIWE技术实现指南:构建强大的Dapp身份验证系统

SIWE(Sign-In with Ethereum)是一种在以太坊上验证用户身份的方式,类似于发起交易,证明用户对钱包的控制权。目前主流钱包插件都支持这种简单的身份验证方式,只需在插件中签名即可。

本文主要讨论以太坊上的签名场景,不涉及其他公链。

何时需要使用SIWE

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

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

对于以查询为主的应用,如类似etherscan的区块浏览器,则可以不使用SIWE。

虽然在Dapp前端连接钱包后似乎已经证明了身份,但对于需要后端支持的接口调用,仅传递地址是不够的,因为地址是公开信息,容易被冒用。

SIWE使用手册:如何让你的Dapp更加强大?

SIWE的原理和流程

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

连接钱包

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

签名

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

  1. 从后端获取随机生成的Nonce值,与当前地址关联。

  2. 前端构建签名内容,包括Nonce值、域名、链ID等信息,使用钱包提供的方法签名。

  3. 将签名发送给后端进行校验。

获取身份标识

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

SIWE使用手册:如何让你的Dapp更加强大?

实践指南

以下将介绍如何在Nextjs项目中实现SIWE功能,返回JWT用于身份校验。

环境准备

  1. 安装Nextjs:

npx create-next-app@14

  1. 安装SIWE相关依赖:

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

SIWE使用手册:如何让你的Dapp更加强大?

引入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;

SIWE使用手册:如何让你的Dapp更加强大?

添加连接按钮

在组件中添加连接钱包和签名按钮:

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

JWT: {jwt}
); }

SIWE使用手册:如何让你的Dapp更加强大?

接口实现

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使用手册:如何让你的Dapp更加强大?

优化建议

为提高SIWE登录速度,建议使用专门的节点服务。以ZAN节点服务为例,获取以太坊主网HTTPS RPC连接后,替换publicClient的默认RPC:

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

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

SIWE使用手册:如何让你的Dapp更加强大?

此页面可能包含第三方内容,仅供参考(非陈述/保证),不应被视为 Gate 认可其观点表述,也不得被视为财务或专业建议。详见声明
  • 赞赏
  • 5
  • 分享
评论
0/400
MrRightClickvip
· 07-16 07:52
签名就得了 不搞这么复杂
回复0
熊市资深生存者vip
· 07-16 03:02
又整这种高大上的玩意儿
回复0
戴上帽子说话vip
· 07-13 20:00
就这验证难度 套个壳都能过
回复0
NFT梦游者vip
· 07-13 19:58
有啥可纠结的 连就完事了
回复0
BlockTalkvip
· 07-13 19:57
身份验证这么麻烦干啥
回复0
交易,随时随地
qrCode
扫码下载 Gate APP
社群列表
简体中文
  • 简体中文
  • English
  • Tiếng Việt
  • 繁體中文
  • Español
  • Русский
  • Français (Afrique)
  • Português (Portugal)
  • Bahasa Indonesia
  • 日本語
  • بالعربية
  • Українська
  • Português (Brasil)