跳过内容

Supabase Google 登录 - 通用设置

GitHub

简体中文

《简介》

本指南将指导您如何使用 Capacitor 社交登录插件将 Google Sign-In 与 Supabase 身份验证集成。该设置允许您在移动平台上使用本机 Google Sign-In,同时利用 Supabase Auth 进行后端身份验证。

前提条件

《前提条件》

开始之前,请确保您已完成以下步骤:

  1. 创建 Supabase 项目

  2. 阅读 Google 登录通用设置 指南以设置 Google OAuth 凭证

  3. 遵循各个平台的指南以设置 Google OAuth 凭证以适应您的目标平台:

在 Supabase 中启用 Google OAuth 提供者

在 Supabase 中启用 Google OAuth 提供者
  1. 前往您的 Supabase 控制台

  2. 点击您的项目

    项目选择器
  3. 前往 Authentication 菜单

    Supabase 认证菜单
  4. 点击 Providers 标签

    Supabase 提供商标签
  5. 找到 Google 提供商

    Supabase Google 提供商
  6. 启用提供商

    Supabase Google 提供商启用
  7. 为您计划使用的平台添加客户端 ID

    Supabase Google 提供商添加客户端 ID
  8. 点击 Save 按钮

    Supabase Google Provider 保存

Voilà, you have now enabled Google Sign-In with Supabase Authentication

Google Sign-In with Supabase Authentication Helper

How Google Sign-In with Supabase Authentication Helper Works

This section explains how the Google Sign-In integration with Supabase works under the hood. Understanding this flow will help you implement and troubleshoot the authentication process.

在本指南中,这并不需要。

Section titled “1. 随机数生成”

实现生成一个安全的随机数对,遵循 Supabase 随机数要求:

// Generate URL-safe random nonce
function getUrlSafeNonce(): string {
const array = new Uint8Array(32);
crypto.getRandomValues(array);
return Array.from(array, (byte) => byte.toString(16).padStart(2, '0')).join('');
}
// Hash the nonce with SHA-256
async function sha256Hash(message: string): Promise<string> {
const encoder = new TextEncoder();
const data = encoder.encode(message);
const hashBuffer = await crypto.subtle.digest('SHA-256', data);
const hashArray = Array.from(new Uint8Array(hashBuffer));
return hashArray.map((b) => b.toString(16).padStart(2, '0')).join('');
}
// Generate nonce pair
async function getNonce(): Promise<{ rawNonce: string; nonceDigest: string }> {
const rawNonce = getUrlSafeNonce();
const nonceDigest = await sha256Hash(rawNonce);
return { rawNonce, nonceDigest };
}

流程:

  • rawNonce: URL安全的随机字符串(64 个十六进制字符)
  • nonceDigest: SHA-256 哈希值 rawNonce (十六进制编码)
  • nonceDigest 传递给 Google Sign-In → Google 将随机数摘要包含在 ID 令牌中
  • rawNonce 传递给 Supabase → Supabase 哈希原始随机数并与令牌的随机数进行比较

The function initializes the plugin and signs in with Google:

await SocialLogin.initialize({
google: {
webClientId: 'YOUR_WEB_CLIENT_ID.apps.googleusercontent.com',
// iOS only:
iOSClientId: 'YOUR_IOS_CLIENT_ID.apps.googleusercontent.com',
mode: 'online', // Required to get idToken
},
});
const response = await SocialLogin.login({
provider: 'google',
options: {
scopes: ['email', 'profile'],
nonce: nonceDigest, // Pass the SHA-256 hashed nonce
},
});

在将令牌发送到 Supabase 之前,实现验证 JWT 令牌:

function validateJWTToken(idToken: string, expectedNonceDigest: string): { valid: boolean; error?: string } {
const decodedToken = decodeJWT(idToken);
// Check audience matches your Google Client IDs
const audience = decodedToken.aud;
if (!VALID_GOOGLE_CLIENT_IDS.includes(audience)) {
return { valid: false, error: 'Invalid audience' };
}
// Check nonce matches
const tokenNonce = decodedToken.nonce;
if (tokenNonce && tokenNonce !== expectedNonceDigest) {
return { valid: false, error: 'Nonce mismatch' };
}
return { valid: true };
}

为什么在 Supabase 之前验证?

验证 JWT 令牌并将令牌发送到 Supabase 有几个重要的目的:

  1. 防止无效请求:如果令牌的受众或 nonce 不匹配,Supabase 将拒绝令牌。验证令牌首先避免了不必要的 API 调用并提供了更清晰的错误消息。

  2. 令牌缓存问题:在某些平台(尤其是 iOS)上,Google Sign-In SDK 可能会缓存令牌以提高性能。当返回缓存令牌时,缓存令牌可能使用了不同的 nonce(或没有 nonce),导致 Supabase 拒绝令牌并显示“nonce 不匹配”错误。通过在发送到 Supabase 之前验证令牌,我们可以早期检测到此问题并自动重试使用新令牌。

  3. 安全 (iOS): 在 iOS 上,验证确保令牌是为您的特定 Google Client IDs 发出的,防止使用其他应用程序意图的令牌引起潜在的安全问题。

  4. 更好的错误处理: 检测问题之前 Supabase 允许自动重试逻辑,这对于处理 iOS 缓存问题至关重要。

如果验证失败,函数自动:

  1. 从 Google 登出(清除缓存令牌 - iOS 上至关重要)
  2. 尝试一次重新认证(强制使用正确的 nonce 生成新令牌)
  3. 如果重试也失败,则返回错误

最后,经过验证的令牌被发送到 Supabase:

const { data, error } = await supabase.auth.signInWithIdToken({
provider: 'google',
token: googleResponse.idToken,
nonce: rawNonce, // Pass the raw (unhashed) nonce
});

完整的Code参考

标题:完整的Code参考

完整实现可在 示例应用的 supabaseAuthUtils.ts 文件中找到,包括:

  • getUrlSafeNonce() - 生成 URL 安全的随机非对称密钥
  • sha256Hash() - 使用 SHA-256 哈希字符串
  • getNonce() - 生成非对称密钥 pair
  • decodeJWT() - 解码 JWT token
  • validateJWTToken() - 验证 JWT audience 和 nonce
  • authenticateWithGoogleSupabase() - 主要身份验证函数,自动重试

请参阅针对目标平台的设置指南:

继续 Supabase Google 登录 - 通用设置

继续使用 Supabase Google 登录 - 通用设置

如果您正在使用 Supabase Google 登录 - 通用设置 来规划身份验证和帐户流程,连接它与 使用 @capgo/capacitor-social-login 为使用 @capgo/capacitor-social-login 的本地能力 使用 @capgo/capacitor-social-login 为 @capgo/capacitor-social-login 的实现细节 使用 @capgo/capacitor-passkey 为 @capgo/capacitor-passkey 的实现细节 使用 @capgo/capacitor-native-biometric 为 @capgo/capacitor-native-biometric 的实现细节 双重认证 双重认证的实现细节。