从 0.x 迁移?请参阅 迁移指南。
文档
入门
需求
- iOS 12.0+ / macOS 10.15+ / tvOS 12.0+ / watchOS 6.2+
- Xcode 13.x / 14.x
- Swift 5.x
Note 检查支持政策了解何时丢弃Xcode、Swift和平台版本将不会被考虑为重大变更。
安装
Swift包管理器
在Xcode中打开以下菜单项
文件 > 添加包...
在搜索或输入包URL搜索框中输入此URL
https://github.com/auth0/SimpleKeychain
然后,选择依赖规则,点击添加包。
CocoaPods
将以下行添加到您的Podfile
pod 'SimpleKeychain', '~> 1.0'
然后,运行pod install
。
Carthage
将以下行添加到您的Cartfile
github "auth0/SimpleKeychain" ~> 1.0
然后,运行carthage bootstrap --use-xcframeworks
。
用法
在示例页面
在API 文档
let simpleKeychain = SimpleKeychain()
您可以为要保存的项目指定一个服务名称。默认使用应用程序的包标识符。
let simpleKeychain = SimpleKeychain(service: "Auth0")
存储字符串或数据项
try simpleKeychain.set(accessToken, forKey: "auth0-access-token")
检查是否存储了某个项目
let isStored = try simpleKeychain.hasItem(forKey: "auth0-access-token")
检索一个字符串项
let accessToken = try simpleKeychain.string(forKey: "auth0-access-token")
检索一个数据项
let accessToken = try simpleKeychain.data(forKey: "auth0-credentials")
检索所有存储项的键
let keys = try simpleKeychain.keys()
删除一个项
try simpleKeychain.deleteItem(forKey: "auth0-access-token")
删除所有项
try simpleKeychain.deleteAll()
错误处理
所有方法在失败时都会抛出SimpleKeychainError
异常。
catch let error as SimpleKeychainError {
print(error)
}
支持政策
本政策定义了SimpleKeychain对Xcode、Swift和平台版本(iOS、macOS、tvOS和watchOS)提供的支持范围。
Xcode
SimpleKeychain支持的唯一Xcode版本是可以用于向App Store提交应用程序的版本。一旦某个Xcode版本变为不受支持,从SimpleKeychain中删除它将不会被认为是一个破坏性变更,并且将在一个**小版本**中完成。
Swift
最低支持的Swift次要版本是最旧的受支持的Xcode版本发布的那一个。一旦某个Swift次要版本变为不受支持,从SimpleKeychain中删除它将不会被认为是一个破坏性变更,并且将在一个**小版本**中完成。
平台
只支持最后四个主要平台版本,从
- iOS 12 开始
- macOS 10.15
- macCatalyst 13
- tvOS 12
- watchOS 6.2
一旦某个平台版本不再受支持,从 SimpleKeychain 中删除它将不会被视为破坏性更改,并将随 minor 发布版本完成。例如,当 iOS 17 发布时,iOS 13 将不再受支持,SimpleKeychain 将能够在 minor 发布版本中将其删除。
在 macOS 的情况下,根据此政策,年度命名的发布版本被视为一个主要平台版本,无论实际版本号如何。
反馈
贡献
我们赞赏对这个仓库的反馈和贡献!在你开始之前,请查看以下内容
提出问题
要提供反馈或报告错误,请在我们的问题追踪器上提出问题。
漏洞报告
请勿在公开的 GitHub 问题跟踪器上报告安全漏洞。关于《负责任的披露计划》的详细说明,请参阅负责任的披露计划。
Auth0 是一款易于实现和适应性强的身份验证和授权平台。了解更多信息,请访问为什么选择 Auth0?
本项目受 MIT 许可证许可。有关更多信息,请参阅Licence 文件。