SimpleKeychain

📚 文档 • 🚀 入门 • 📃 支持政策 • 💬 反馈

从0.x版本迁移？请查看迁移指南。

文档

• 示例 - 解释如何使用更高级的功能。
• API文档 - 从代码注释自动生成的文档，解释了所有可用的功能。
  • SimpleKeychain
  • 可访问性
  • SimpleKeychainError
• Auth0文档 - 浏览我们的文档站点，了解更多关于Auth0的信息。

入门

要求

• iOS 14.0+ / macOS 11.0+ / tvOS 14.0+ / watchOS 7.0+
• Xcode 15.x
• Swift 5.9+

[!重要] 查看支持政策以了解何时放弃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

仅支持当前可用于向App Store提交应用程序的Xcode版本。一旦某个Xcode版本不再受支持，从SimpleKeychain中删除它不会被视为重大变更，并将在次要版本中进行。

Swift

支持的最低Swift次要版本是与最老支持的Xcode版本一起发布的版本。一旦某个Swift次要版本不再受支持，从SimpleKeychain中删除它不会被视为重大变更，并将在次要版本中进行。

平台

我们仅支持任何平台的最后四个主要版本，包括当前的主要版本。

一旦某个平台版本不再受支持，从SimpleKeychain中删除它不会被视为重大变更，并将在次要版本中进行。例如，当iOS 18发布时，iOS 14将不再受支持，SimpleKeychain可以在次要版本中删除它。

对于macOS，年度命名的发布版本被视为本政策目的下的主要平台版本，无论实际版本号如何。

反馈

贡献

我们感谢对这个仓库的反馈和贡献！在开始之前，请查看以下内容：

• Auth0的一般贡献指南
• Auth0的行为准则指南
• SimpleKeychain的贡献指南

提出问题

要提供反馈或报告错误，请在我们的问题跟踪器上提出问题。

漏洞报告

请不要在公共GitHub问题跟踪器上报告安全漏洞。负责任的披露计划详细说明了披露安全问题的程序。

---

<p align="center"> <picture> <source media="(prefers-color-scheme: light)" srcset="https://yellow-cdn.veclightyear.com/2b54e442/77252771-c2d0-4773-a230-22ae076b598e.png" width="150"> <source media="(prefers-color-scheme: dark)" srcset="https://cdn.auth0.com/website/sdks/logos/auth0_dark_mode.png" width="150"> <img alt="Auth0 Logo" src="https://yellow-cdn.veclightyear.com/2b54e442/77252771-c2d0-4773-a230-22ae076b598e.png" width="150"> </picture> </p> <p align="center">Auth0是一个易于实施、可适应的身份验证和授权平台。要了解更多信息，请查看<a href="https://auth0.com/why-auth0">为什么选择Auth0？</a></p> <p align="center">本项目根据MIT许可证授权。有关更多信息，请参阅<a href="./LICENSE">许可证</a>文件。</p>