📚 文档 • 🚀 快速开始 • 📃 支持策略 • 💬 反馈

从 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 中打开以下菜单项

File > Add Packages...

在 Search or Enter Package URL 搜索框中输入此 URL

https://github.com/auth0/SimpleKeychain

然后，选择依赖规则并按 Add Package。

将以下行添加到您的 Podfile

pod 'SimpleKeychain', '~> 1.0'

然后，运行 pod install。

将以下行添加到您的 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 版本不再受支持，从 SimpleKeychain 中删除它将不被视为重大更改，并且将在次要版本中完成。

最低受支持的 Swift 次要版本是与最旧受支持的 Xcode 版本一起发布的版本。 一旦 Swift 次要版本不再受支持，从 SimpleKeychain 中删除它将不被视为重大更改，并且将在次要版本中完成。

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

一旦平台版本不再受支持，从 SimpleKeychain 中删除它将不被视为重大更改，并且将在次要版本中完成。 例如，当 iOS 18 发布时，iOS 14 将停止支持，并且 SimpleKeychain 将能够在次要版本中删除它。

对于 macOS，每年的命名版本被视为本策略的主要平台版本，无论实际版本号如何。

我们感谢您对此仓库的反馈和贡献！在您开始之前，请参阅以下内容

• Auth0 的通用贡献指南
• Auth0 的行为准则指南
• SimpleKeychain 的贡献指南

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

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

Auth0 是一个易于实施、适应性强的身份验证和授权平台。 要了解更多信息，请查看 为什么选择 Auth0？

本项目采用 MIT 许可证。 有关更多信息，请参见 LICENSE 文件。