@capgo/capacitor-social-login

所有社交登录插件都在一个插件中.

开始 GitHub

概述

@capgo/capacitor-social-login 是Web、iOS和Android的所有在一处的社交验证插件.

它实现：

Google Sign-In with Android Credential Manager
使用Apple进行登录，包括Android上的OAuth
Facebook登录，使用当前的Facebook SDK
Twitter/X通过OAuth 2.0
通用OAuth2和OIDC提供者，包括 GitHub、Microsoft Entra ID、Auth0、Okta、Keycloak和其他符合标准的服务器

它也是从Ionic Appflow Social Login或Ionic Auth Connect迁移的Capgo路径。

Fork和迁移说明

该插件最初是 @codetrix-studio/capacitor-google-auth原包被视为已归档，因此Capgo维护此插件作为支持的替代品。

如果您仍在使用 @codetrix-studio/capacitor-google-auth,请遵循遗留Google Auth迁移指南.

如果您从Ionic Auth Connect迁移，使用内置 SocialLoginAuthConnect wrapper包裹 auth0, azure, cognito, okta和 onelogin 提供者名称：

兼容性

插件版本	Capacitor 兼容性	维护
v8.x	v8.x	是
v7.x	v7.x	按需
v6.x	v6.x	否
v5.x	v5.x	否

Capacitor 的主要版本号决定了该插件的主要版本号。例如，使用插件 v8 时，Capacitor 应该是 8。仅最新的主要版本号被积极维护。

视频教程

观看插件设置和登录流程的快速演示。

核心功能

initialize - 初始化插件。
login - 使用所选提供商登录。
logout - 登出。
isLoggedIn - 是否已登录。

公共 API

方法	描述
`initialize`	初始化插件。
`login`	使用所选提供商登录。
`logout`	注销。
`isLoggedIn`	是否已登录。
`getAuthorizationCode`	获取当前授权 code。
`refresh`	刷新访问令牌。
`refreshToken`	OAuth2 刷新令牌助手，用于内置 OAuth2 提供商。
`handleRedirectCallback`	仅限 Web：处理 OAuth 重定向回调并返回解析结果。
`decodeIdToken`	解码 JWT（通常是 OIDC ID 令牌）以获取其声明。
`getAccessTokenExpirationDate`	将访问令牌过期时间戳（以毫秒为单位的 Unix 时间戳）转换为 ISO 日期字符串。
`isAccessTokenAvailable`	检查是否有可用的访问令牌（非空）。
`isAccessTokenExpired`	检查是否有过期的访问令牌。
`isRefreshTokenAvailable`	检查是否有可用的刷新令牌（非空）。
`providerSpecificCall`	执行提供商特定的调用。
`getPluginVersion`	获取本地 Capacitor 插件版本。
`openSecureWindow`	打开一个安全的窗口进行 OAuth2 认证。对于 web，应该在重定向页面中包含 code，通过广播通道将重定向 URL 发送到应用程序，类似于： `html <html> <head></head> <body> <script> const searchParams = new URLSearchParams(location.search) if (searchParams.has("code")) { new BroadcastChannel("my-channel-name").postMessage(location.href); window.close(); } </script> </body> </html>` 对于移动设备，应该有一个重定向 URI，打开应用程序，类似于： `myapp://oauth_callback/` 并且确保在 app 的 info.plist 中注册： `xml <key>CFBundleURLTypes</key> <array> <dict> <key>CFBundleURLSchemes</key> <array> <string>myapp</string> </array> </dict> </array>` 并且在 AndroidManifest.xml 文件中： `xml <activity> <intent-filter> <action android:name="android.intent.action.VIEW" /> <category android:name="android.intent.category.DEFAULT" /> <category android:name="android.intent.category.BROWSABLE" /> <data android:host="oauth_callback" android:scheme="myapp" /> </intent-filter> </activity>` .

真实数据来源

此参考是从 src/definitions.ts 在 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 的细节，双因素身份验证来实现双因素身份验证的细节， [__CAPGO_KEEP_0__] (企业级 SSO) 关于 [__CAPGO_KEEP_0__] (企业级 SSO) 的实现细节。