跳过内容

Supabase Apple Login on Android

GitHub

前提条件

前提条件

本指南将帮助您在 Android 上将 Apple Sign-In 与 Supabase 身份验证集成。假设您已经完成:

步骤 1:部署后端 Edge Function

步骤 1:部署后端 Edge Function

首先,我们需要部署 Supabase Edge Function 来处理 Apple OAuth 回调。

  1. 导航到您的 Supabase 项目目录

    终端窗口
    cd your-project/supabase
  2. 创建边缘函数 (如果不存在)

    终端窗口
    supabase functions new apple-signin-callback
  3. 复制边缘函数 code

    完整的边缘函数实现可在示例应用中找到 复制以下文件到您的项目中:.

    - 主边缘函数 __CAPGO_KEEP_0__

    • supabase/functions/apple-signin-callback/index.ts - Main edge function code
    • supabase/functions/apple-signin-callback/deno.json - Main edge function __CAPGO_KEEP_0__ jose library for JWT signing)
  4. 配置 JWT 验证

    Apple OAuth 回调端点必须是公开的(无需身份验证)因为 Apple 会重定向到它。更新你的 supabase/config.toml file:

    [functions.apple-signin-callback]
    enabled = true
    verify_jwt = false # Important: Set to false for public OAuth callback
    import_map = "./functions/apple-signin-callback/deno.json"
    entrypoint = "./functions/apple-signin-callback/index.ts"
  5. 部署函数

    终端窗口
    supabase functions deploy apple-signin-callback
  6. 获取函数 URL

    部署后,您将获得类似于:

    https://your-project-ref.supabase.co/functions/v1/apple-signin-callback

    如果您找不到它,请执行以下操作:

    1. 打开 https://supabase.com/dashboard/project/YOUR_PROJECT_REF/functions
    2. 点击 apple-signin-callback 函数 URL 以复制它。 Supabase Functions Apple Sign-In Callback

步骤 2:配置 Apple Developer Portal

Step 2: 配置 Apple 开发者门户

现在我们需要配置 Apple 开发者门户,使用后端 URL,并获取所有所需的值。

  1. 遵循 Apple 登录 Android 设置指南

    完成 Apple 登录 Android 设置指南 到:

    • 创建服务 ID
    • 生成私钥 (.p8 文件)
    • 获取您的团队 ID 和密钥 ID
    • 配置返回 URL
  2. 在 Apple 开发者门户中设置返回 URL

    在配置 Apple 开发者门户中的返回 URL(Apple 指南第 6.9 步)时,请使用您的 Supabase Edge Function URL:

    https://your-project-ref.supabase.co/functions/v1/apple-signin-callback

    重要:使用 Supabase Edge Function URL

    不要 使用 Apple Login Android 设置指南中的重定向 URL .该指南使用自定义后端服务器 URL。对于 Supabase 集成,必须 使用您的 Supabase Edge Function URL 精确匹配要求

  3. Collect all required values

    完成 Apple 设置指南后,您应该已经收集了以下内容:

    • APPLE_TEAM_ID: Apple Developer Team ID
    • APPLE_KEY_ID: Apple Developer Portal 中的 Key ID
    • APPLE_PRIVATE_KEY: Apple Developer Portal 中的 .p8 私钥文件(需要 base64 编码)
    • ANDROID_SERVICE_ID:您的Apple服务ID(例如, com.example.app.service)
    • BASE_REDIRECT_URL:您的深度链接URL(例如, capgo-demo-app://path)

步骤 3: 设置 Supabase 秘密

标题:步骤 3:设置 Supabase 秘密

现在我们需要配置环境变量(秘密)来为 Supabase Edge Function 配置

  1. 编码您的私钥

    首先,使用 base64 编码您的 Apple 私钥 (.p8 文件)

    终端窗口
    base64 -i AuthKey_XXXXX.p8

    复制整个输出(它是一个单独的长字符串)

  2. 使用 Supabase 设置 CLI 秘密

    终端窗口
    supabase secrets set APPLE_TEAM_ID=your_team_id
    supabase secrets set APPLE_KEY_ID=your_key_id
    supabase secrets set APPLE_PRIVATE_KEY=your_base64_encoded_key
    supabase secrets set ANDROID_SERVICE_ID=your.service.id
    supabase secrets set BASE_REDIRECT_URL=your-app://path
    supabase secrets set APPLE_REDIRECT_URI=https://your-project-ref.supabase.co/functions/v1/apple-signin-callback
  3. 如果您更喜欢使用仪表板:

    如果您更喜欢使用仪表板:

    1. 前往您的Supabase项目仪表板
    2. 导航到 边缘功能设置密钥
    3. 为每个密钥变量添加其值

步骤 4:使用身份验证助手

标题为“步骤 4:使用身份验证助手”

现在您可以在应用中使用身份验证助手 code。

完整的实现可在 示例应用的 supabaseAuthUtils.ts 文件中找到。

使用身份验证助手

复制到剪贴板
import { authenticateWithAppleSupabase } from './supabaseAuthUtils';
const result = await authenticateWithAppleSupabase();
if (result.success) {
console.log('Signed in:', result.user);
// Navigate to your authenticated area
} else {
console.error('Error:', result.error);
}

当使用助手函数时

助手函数

__CAPGO_KEEP_0__ authenticateWithAppleSupabase __CAPGO_KEEP_0__ 必须更新以下值以匹配您的配置: 更新

  1. - 将此设置为您的 Supabase Edge Function URL: redirectUrl 复制到剪贴板

    const redirectUrl = platform === 'android'
    ? 'https://your-project-ref.supabase.co/functions/v1/apple-signin-callback'
    : undefined;
  2. - 将此设置为您的 Apple Service ID: clientId 复制到剪贴板

    await SocialLogin.initialize({
    apple: {
    clientId: isIOS
    ? undefined // iOS uses bundle ID automatically
    : 'your.service.id.here', // Your Apple Service ID for Android
    redirectUrl: redirectUrl,
    },
    });

查看 完整的实现 参考资料。

  1. 构建并运行您的 Android 应用

    终端窗口
    npx cap sync android
    npx cap run android
  2. 测试身份验证流程

    • 点击“使用 Apple 登录”按钮
    • 您应该在浏览器中看到 Apple OAuth 页面
    • After authenticating, you should be redirected back to your app
    • 检查控制台日志是否有错误
  3. 验证流程

    完整流程应该是:

    1. 用户点击“使用 Apple 登录”
    2. 应用程序打开 Apple OAuth 的浏览器
    3. 用户使用 Apple 进行身份验证
    4. Apple 重定向到: https://your-project-ref.supabase.co/functions/v1/apple-signin-callback
    5. 边缘函数交换 code 为令牌
    6. 边缘函数重定向到: your-app://path?id_token=...&access_token=...
    7. 安卓应用程序接收深度链接并处理身份令牌
    8. 应用程序使用身份令牌登录 Supabase

故障排除

故障排除

如果身份验证失败:

  • 重定向 URI 不匹配: 检查 Apple Developer Portal 中的 Return URL 与 APPLE_REDIRECT_URI secret
  • 深度链接不工作: 检查 AndroidManifest.xml 意图过滤器与您的 BASE_REDIRECT_URL
  • 缺少密钥: 验证所有密钥是否正确设置 supabase secrets list
  • 令牌交换失败: 检查 Supabase Dashboard 中的边缘函数日志以获取详细的错误消息
  • App 未接收到回调: 确保 onNewIntent 在 MainActivity 中正确实现了
  • Review 的 示例应用程序 code 用于参考

在 Android 上,Apple Sign-In 使用 OAuth 重定向流程:

  1. 初始化: 插件使用您的 Service ID 和后端重定向 URL 进行初始化
  2. OAuth 流程: 打开一个浏览器/Chrome 自定义标签页,访问 Apple 的 OAuth 页面
  3. 后端回调: Apple 重定向到您的 Supabase Edge 函数,带有一个授权 code
  4. 令牌交换: Edge 函数使用 Apple 的令牌端点交换 code 为令牌
  5. 深度链接重定向: Edge 函数重定向到您的应用程序,带有身份令牌
  6. Supabase 身份验证: 应用程序接收令牌并登录到 Supabase

此流程是必要的,因为 Apple 没有为 Android 提供本机支持的 Sign in with Apple。

继续使用 Supabase Apple 登录(Android)

继续使用 Supabase Apple Login on Android

如果您正在使用 Supabase Apple Login on Android 来规划认证和账户流程,连接它与 使用 @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 中的实现细节 双因素认证 双因素认证的实现细节。