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
- 从3.0.0版本开始,ForgeRock iOS SDK可以通过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应用程序演示了如何使用和未使用
FRUser
自动用户界面验证AM实例。其他功能包括
- OAuth 2.0 访问令牌
- 注销
- 收集设备信息
- 获取当前用户的详细信息
- 越狱检测
在文件
/FRexampleObjC/FRexampleObjC/Configs/FRAuthConfig.plist
中配置您的AM实例设置,以使用此示例应用程序。 -
Objective-C 示例 -
/FRexampleObjC/
此Objective-C应用程序示例演示了如何使用和未使用
FRUser
自动用户界面验证AM实例。其他功能包括
- 注销
- 收集设备信息
- 获取当前用户的详细信息
- 越狱检测
在文件
/FRExample/FRExample/Configs/FRAuthConfig.plist
中配置您的AM实例设置,以使用此示例应用程序。 -
Authenticator 应用程序示例 -
/FRAuthenticatorExample/
此Authenticator样本应用程序演示了基于HMAC和时间的一次性密码,以及与ForgeRock Access Manager的推送注册和身份验证。
文档
SDK的文档提供在BackStage上,包括以下主题
- 引入SDK功能
- 为使用SDK准备AM
- API参考文档
支持
如果您遇到任何问题,请务必检查我们的故障排除页面。
您可以随时提交支持工单;以下是一些适当的提交工单的示例(但不仅限于此)
您可以使用 BackStage 账号,我们的客户支持门户网站,提供一站式访问ForgeRock服务。
BackStage 显示所有当前打开的支持工单,并允许您通过点击 新建工单 来创建一个新的工单。
贡献
如果您想为此项目做出贡献,您可以为仓库分叉,将其克隆到您的计算机上并开始。
免责声明
本代码由ForgeRock提供,以“现状”为基础,不提供任何形式的担保,以法律允许的最大范围为准。ForgeRock不保证或声明或保证此代码的使用或与此代码相关的任何数据或信息的准确性、及时性或完整性,并在此明确拒绝所有明示的、默示的或法定的担保,包括但不限于适销性、特定用途的适用性和任何不侵犯担保。ForgeRock不对任何使用、实施或配置此代码的行为或其他相关行为产生的或产生的任何责任负责,包括但不限于用于任何商业目的的使用。仅能在此地的法院提起与代码使用相关的任何诉讼,ForgeRock居住或在此地开展其主要业务的司法管辖区,且受该管辖区的法律约束,不包括其法律冲突条款。
许可证
本项目使用MIT许可证授权 - 有关详细信息,请参阅 LICENSE 文件
© 版权所有2022 ForgeRock AS。保留所有权利