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
如果你想安装最新版本,请使用以下pod在Podfile
中安装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包管理器
- ForgeRock iOS SDK从3.0.0版本及以上可通过Swift包管理器获取。任何较老版本(2.2.0及以下)只能通过Cocoapods获取。
FRGoogleSignIn
模块当前在Swift包管理器中不可用;请使用Cocoapods来集成FRGoogleSignIn
模块。
- 在Xcode菜单中,选择
文件
->Swift包
->添加包依赖...
- 选择要集成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
自动用户界面。其他功能包括
- OAuth 2.0 访问令牌
- 注销
- 收集设备信息
- 获取当前用户的详细信息
- 越狱检测
在
/FRexampleObjC/FRexampleObjC/Configs/FRAuthConfig.plist
文件中配置您的 AM 实例设置,以使用此示例应用。 -
Objective-C 示例 -
/FRexampleObjC/
本示例 Objective-C 应用演示了如何对接 AM 实例进行身份验证,包括使用和未使用
FRUser
自动用户界面。其他功能包括
- 注销
- 收集设备信息
- 获取当前用户的详细信息
- 越狱检测
在
/FRExample/FRExample/Configs/FRAuthConfig.plist
文件中配置您的 AM 实例设置,以使用此示例应用。 -
身份验证器应用示例 -
/FRAuthenticatorExample/
此身份验证器示例应用演示了基于 HMAC 和基于时间的单次密码,以及与 ForgeRock 实现的访问管理器(AM)的推送注册和身份验证。
文档
SDK 的文档在 BackStage 提供,包括以下主题
- 介绍 SDK 特性
- 为 SDK 准备 AM
- API 参考文档
支持
如果您遇到任何问题,请确保检查我们的 故障排除 页面。
无论何时需要我们协助,都可以提交支持单;以下是一些适合开启工单(但不仅限于)的情况示例
您可以使用 BackStage 提交工单,这是我们用于提供 ForgeRock 服务的单一入口客户支持门户。
BackStage 显示所有当前打开的工单,并允许您通过点击 新建工单 提交新的工单。
贡献
如果您想为此项目做出贡献,您可以将存储库分叉,在您的机器上克隆它并开始。
免责声明
ForgeRock 以“原样”为基础提供此代码,不提供任何形式的保证,法律允许的最大范围内。ForgeRock 没有声明或担保或保证此代码的使用、与该代码相关的任何数据或信息的准确性、及时性或完整性,ForgeRock 在此明确放弃所有明示、默示或法定的保证,包括但不限于商品性、适销性、特定用途适用性和任何侵权保证。ForgeRock 对因使用、实施或配置此代码而产生的任何责任概不承担,包括但不限于用于任何商业目的。有关代码使用的任何诉讼或诉讼只能在该法院提出,该法院位于 ForgeRock 居住地或在 ForgeRock 主要业务进行的司法管辖区,并受该司法管辖区法律管辖,但不包括其冲突法规定。
许可
此项目使用 MIT 许可证许可 - 请参阅LICENSE文件以获取详细信息
© 版权所有 2022 ForgeRock AS。保留所有权利