ForgeRock for iOS SDK
ForgeRock iOS SDK允许您快速将ForgeRock身份平台集成到您的iOS应用中。
使用SDKs利用ForgeRock访问管理(AM)产品的智能身份验证实现,通过回调函数轻松遍历身份验证树的每个阶段。
需求
- ForgeRock身份平台
- 访问管理(AM)6.5.2+
- iOS 12 及以上
- Xcode
- Swift 5.x 或 Objective-C
- CocoaPods 或 Swift Package Manager(可选)
安装
苹果开发者课程
若要安装最新版本,请在您的 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 包管理器获得。任何更早版本的 SDK(2.2.0 及以下版本)仅通过 Cocoapods 提供。
- 目前 Swift 包管理器中不可用
FRGoogleSignIn
模块;请使用 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应用样例演示了如何使用
FRUser
自动用户界面或无需使用FRUser
自动用户界面对AM实例进行认证。其他特性包括:
- OAuth 2.0访问令牌
- 注销
- 收集设备信息
- 获取当前用户的详细信息
- 越狱检测
要使用此样例应用程序,请在
/FRexampleObjC/FRexampleObjC/Configs/FRAuthConfig.plist
文件中配置您的AM实例设置。 -
Objective-C样例 -
/FRexampleObjC/
这个样例Objective-C应用程序演示了如何使用
FRUser
自动用户界面或无需使用FRUser
自动用户界面对AM实例进行认证。其他特性包括:
- 注销
- 收集设备信息
- 获取当前用户的详细信息
- 越狱检测
要使用此样例应用程序,请在
/FRExample/FRExample/Configs/FRAuthConfig.plist
文件中配置您的AM实例设置。 -
身份验证器应用样例 -
/FRAuthenticatorExample/
此身份验证器样例应用程序演示了基于HMAC和时间的一次性密码,以及与ForgeRock的Access Manager进行的推送注册和认证。
文档
SDK的文档在《BackStage》上提供,包括以下主题:
- 介绍SDK特性
- 为使用SDK准备AM
- API参考文档
支持
如果您遇到任何问题,请务必查看我们的“故障排除”页面。
可以在需要我们协助时随时提出支持单;以下是一些适当的打开支持单的例子(但不仅限于以下情形):
- 在 ForgeRock 软件中发现的疑似错误或问题。
- 请求帮助 - 请首先查阅《文档》和《知识库》。
您可以使用我们的客户支持门户《BackStage》提出支持单,该门户可提供一站式访问 ForgeRock 服务。
后台显示所有当前打开的支持工单,并可点选新建工单按钮创建新工单。
贡献
如果您想为此项目做贡献,您可以将仓库fork到自己的机器上,并从这里开始。
免责声明
ForgeRock提供的代码是以“原样” Basis提供的,不提供任何类型的保证,最大范围允许的法律。ForgeRock不就使用该代码或与该代码相关的任何数据或信息的准确性、及时性或完整性作出任何陈述、保证或保证,包括但不限于关于商品性、适合特定用途和任何不侵犯保证的隐含保证。 ForgeRock不对使用、实施或配置本书档产生的任何责任负有责任,包括但不限于用于任何商业目的的使用。仅能以ForgeRock居住或主要业务所在法院的法院提起诉讼或诉讼,并受该州法律管辖,不包括其法律冲突条款。
许可协议
本项目采用MIT许可协议 - 请参见LICENSE文件以获取详细信息。
© 版权2022 ForgeRock AS。保留所有权利。