ForgeRock SDK for iOS
ForgeRock iOS SDK 允许您快速将 ForgeRock 身份平台 集成到您的 iOS 应用程序中。
使用 SDK 依赖 ForgeRock 访问管理 (AM) 产品中的智能身份验证,通过回调轻松遍历身份验证树的每个阶段。
要求
- ForgeRock 身份平台
- 访问管理 (AM) 6.5.2+
- iOS 12 和以上
- Xcode
- Swift 5.x 或 Objective-C
- CocoaPods 或 Swift Package Manager(可选)
安装
Cocoapods
要在您的 Podfile
中使用以下 pods 安装最新版本的 FR iOS SDK 模块:
pod 'FRAuth' // Authentication module for Access Manager
pod 'FRUI' // UI SDK demonstrates FRAuth SDK functionalities
pod 'FRProximity' // Add-on for FRAuth's Device Profile feature related to location, and BLE
pod 'FRAuthenticator' // Authenticator module that generates HOTP, TOTP, and Push registration/authentication
pod 'FRGoogleSignIn' // Social Login module for Google Sign In
pod 'FRFacebookSignIn' // Social Login module for Facebook Login
pod 'FRDeviceBinding' // Add-on for Device Binding feature
Swift Package Manager
- ForgeRock iOS SDK 从 3.0.0 版本开始通过 Swift Package Manager 提供。任何旧版本(2.2.0 和以下)仅通过 Cocoapods 提供。
FRGoogleSignIn
模块目前在 Swift Package Manager 中不可用;请使用 Cocoapods 以集成FRGoogleSignIn
模块。
- 在 Xcode 菜单中,选择
文件
->Swift Packages
->添加包依赖项...
- 选择要集成 ForgeRock iOS SDK 的项目
- 输入仓库的 URL:
https://github.com/ForgeRock/forgerock-ios-sdk
- 选择要集成到项目中的模块
入门指南
要尝试 ForgeRock iOS SDK 示例,请执行以下步骤
- 根据文档所述设置访问管理(AM)
- 克隆此仓库
git clone https://github.com/ForgeRock/forgerock-ios-sdk.git
- 在 Xcode 中打开
SampleApps/QuickstartExample/Quickstart.xcodeproj
文件。 - 打开
/Quickstart/FRAuthConfig.plist
并编辑值以匹配您的 AM 实例。 - 确保活动方案为 "Quickstart",然后单击 运行 按钮。
示例
ForgeRock 提供这些示例以帮助演示 SDK 功能
-
Swift 示例 -
/FRExample/
此 Swift 应用程序示例演示了对 AM 实例进行身份验证,包括带
FRUser
自动用户界面和不带FRUser
自动用户界面。其他功能包括
- OAuth 2.0 访问令牌
- 注销
- 收集设备信息
- 获取当前用户的详细信息
- 越狱检测
配置您的 AM 实例设置在
/FRexampleObjC/FRexampleObjC/Configs/FRAuthConfig.plist
文件中,以使用此示例应用程序。 -
Objective-C 示例 -
/FRexampleObjC/
此 Objective-C 应用程序示例演示了对 AM 实例进行身份验证,包括带
FRUser
自动用户界面和不带FRUser
自动用户界面。其他功能包括
- 注销
- 收集设备信息
- 获取当前用户的详细信息
- 越狱检测
配置您的 AM 实例设置在
/FRExample/FRExample/Configs/FRAuthConfig.plist
文件中,以使用此示例应用程序。 -
认证应用程序示例 -
/FRAuthenticatorExample/
此认证示例应用程序演示了使用 HMAC 和基于时间的单次密码,以及使用 ForgeRock 访问管理器的推送注册和身份验证。
文档
SDK 的文档提供在 BackStage 上,包括以下主题:
- 介绍 SDK 功能
- 准备 AM 用于与 SDK 一起使用
- API 参考文档
支持
如果您遇到任何问题,请务必检查我们的 故障排除 页面。
您可以在需要我们协助时随时提出支持票据;以下是一些打开票据的适当情况(但不仅限于此):
您可以使用 BackStage 提出支持票据,这是我们的客户支持门户,可提供一站式访问 ForgeRock 服务。
BackStage 显示所有当前打开的支持票据,并允许您通过单击 新建票据 来打开一个新的票据。
贡献
如果您想为此项目做出贡献,您可以分叉存储库,将其克隆到您的机器上,然后开始工作。
免责声明
此代码由ForgeRock以“按原样”为基础提供,不承担任何形式的保证,在法律允许的最大范围内。ForgeRock不代表或保证也不会对与该代码相关或该代码相关的任何数据或信息的准确性、时效性或完整性做出任何保证,ForgeRock在此特此驳回所有保证,无论明示或默示或法律性质,包括但不限于适销性、特定用途适用性和任何侵权保证。ForgeRock不对任何与使用、实施或配置此代码相关的责任有任何责任,包括但不限于用于任何商业目的的使用。与代码的使用相关的任何诉讼只能在该司法管辖区内的ForgeRock居住或ForgeRock的主要业务活动开展的地方的法院提起,并受该司法管辖区法律(不包括其冲突法规定)的约束。
许可协议
本项目受MIT许可证许可 - 有关详细信息,请参阅LICENSE文件。
版权所有©2022 ForgeRock AS。保留所有权利。