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 包
->添加包依赖...
- 选择要集成 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访问令牌
- 注销
- 收集设备信息
- 获取当前用户的详细信息
- 越狱检测
配置您的AM实例设置到
/FRexampleObjC/FRexampleObjC/Configs/FRAuthConfig.plist
文件中,以使用此示例应用程序。 -
Objective-C示例 -
/FRexampleObjC/
此示例Objective-C应用演示了在AM实例中进行认证,包括与和不使用
FRUser
自动用户界面。其他功能包括
- 注销
- 收集设备信息
- 获取当前用户的详细信息
- 越狱检测
配置您的AM实例设置到
/FRExample/FRExample/Configs/FRAuthConfig.plist
文件中,以使用此示例应用程序。 -
认证器应用程序示例 -
/FRAuthenticatorExample/
此认证器示例应用程序演示了基于HMAC和时间的高斯单次密码,以及与ForgeRock访问管理器的推注册和认证。
文档
SDK文档提供在 BackStage,包括以下主题
- 介绍SDK功能
- 为使用SDK准备AM
- API参考文档
支持
如果您遇到任何问题,请务必检查我们的 故障排除页面。
您可以在需要我们帮助时提交支持工单;以下是一些适当的开启工单的时间点(但这并非限制)
您可以使用 BackStage 提交工单,这是我们客户支持门户,为ForgeRock服务提供一站式访问。
后台展示了所有当前打开的支持工单,并允许您通过点击 新建工单 来创建一个新的工单。
贡献
如果您想为此项目贡献力量,您可以复制存储库,将其克隆到您的机器上并且开始。
免责声明
此代码由ForgeRock按“原样”提供,不提供任何形式的保证,法律法规允许的最大范围内。 ForgeRock不保证或保证或作出任何有关使用此代码或与此代码相关的任何数据或信息的准确性、及时性或完整性的保证,并且ForgeRock在此明确拒绝所有明示的或暗示的或法定保证,包括但不限于商销性、适合特定用途的保证以及任何不侵权的保证。 ForgeRock不对由此代码的使用、实施或配置产生的任何责任承担责任,包括但不限于任何商业用途的使用。与代码使用相关的任何诉讼只能在该司法管辖区内的法院提起,ForgeRock居住在该司法管辖区内或在该司法管辖区域内进行其主要商业活动,并受该司法管辖区法律管辖,适用其冲突法规定。
许可证
本项目遵循MIT许可证 - 详细内容请参阅LICENSE文件。
© 版权所有 2022 ForgeRock AS。保留所有权利。