FRAuth 4.5.0

FRAuth 4.5.0

James GoRodrigo ReisLuis SanchesStoyan PetrovGeorge BafaloukasLuis SanchesVahan Harutyunyan维护。



FRAuth 4.5.0

  • 作者:
  • ForgeRock

Cocoapods Build and Test

Logo

ForgeRock SDK for iOS

变更日志 · 支持 · 文档


The ForgeRock iOS SDK enables you to quickly integrate the ForgeRock Identity Platform into your iOS apps.

Use the SDKs to leverage Intelligent Authentication in ForgeRock's Access Management (AM) product, to easily step through each stage of an authentication tree by using callbacks.

系统要求

  • ForgeRock Identity Platform
    • 访问管理 (AM) 6.5.2+
  • iOS 12 及更高版本
  • Xcode
  • Swift 5.x 或 Objective-C
  • CocoaPods 或 Swift Package Manager(可选)

安装

Cocoapods

如果你的需求是安装最新版本,请在Podfile中使用以下pod来安装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获取。任何低于3.0.0的版本(2.2.0及以下)仅通过Cocoapods可用。
  • FRGoogleSignIn模块目前在Swift Package Manager中不可用;请使用Cocoapods来集成FRGoogleSignIn模块。
  1. 在Xcode菜单中,选择文件 -> Swift Packages -> 添加包依赖...
  2. 选择要集成ForgeRock iOS SDK的项目
  3. 输入仓库的url: https://github.com/ForgeRock/forgerock-ios-sdk
  4. 选择要集成到项目中模块

入门指南

要尝试ForgeRock iOS SDK示例,请按照以下步骤操作

  1. 按照文档描述设置访问管理(AM)
  2. 克隆此仓库
    git clone https://github.com/ForgeRock/forgerock-ios-sdk.git
    
  3. Xcode打开SampleApps/QuickstartExample/Quickstart.xcodeproj文件。
  4. 打开/Quickstart/FRAuthConfig.plist并修改值以匹配你的AM实例。
  5. 确保活动方案为"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访问管理器的推送注册和身份验证。

文档

SDK的文档提供在 BackStage,包括以下主题

  • 介绍SDK功能
  • 准备AM以与SDKS一起使用
  • API参考文档

支持

如果您遇到任何问题,请务必查看我们的 故障排除

您可以在需要我们协助时提出支持工单;以下是一些合适的提出工单的示例(但不仅限于)

  • ForgeRock软件的疑似错误或问题。
  • 寻求帮助 - 请先查看 文档知识库

您可以通过 BackStage 提交工单,BackStage 是我们提供的一站式客户支持门户,可访问 ForgeRock 服务。

BackStage 展示了所有当前打开的工单,并允许您通过单击 新建工单 来提交新工单。

贡献

如果您想为此项目做出贡献,您可以将仓库 fork 到您的机器上并开始。

免责声明

此代码由 ForgeRock 按照法律允许的范围内以“现状”提供,不提供任何形式的保证。ForgeRock 不代表、保证或作出任何关于此代码的使用、任何数据或与此代码相关的信息的准确性、及时性或完整性的保证,并且 ForgeRock 在此明确排除所有明示、默示或法定的保证,包括但不限于适销性、特定用途适用性和非侵权保证。ForgeRock 对与任何使用、实施或配置此代码相关的任何索赔或损失均不承担任何责任,包括但不限于用于任何商业目的的使用。关于使用此代码的任何诉讼只能在此代码所在司法管辖区或 ForgeRock 主要商业活动的法院提起,并受该司法管辖区法律的约束,不包括其法律冲突条款。

许可协议

本项目采用 MIT 许可协议 - 详细信息请参阅 LICENSE 文件


© 版权所有 2022 ForgeRock AS。保留所有权利