auth0/SimpleKeychain — Gitpedia

Version
Build Status

License

📚 Documentation • 🚀 Getting Started • 📃 Support Policy • 💬 Feedback

Migrating from 0.x? Check the Migration Guide.

Documentation

Examples - explains how to use more advanced features.
API Documentation - documentation auto-generated from the code comments that explains all the available features.
Auth0 Documentation - explore our docs site and learn more about Auth0.

Getting Started

Requirements

iOS 14.0+ / macOS 11.0+ / tvOS 14.0+ / watchOS 7.0+
Xcode 16.x
Swift 6.0+

[!IMPORTANT]
Check the Support Policy to learn when dropping Xcode, Swift, and platform versions will not be considered a breaking change.

Installation

Swift Package Manager

Open the following menu item in Xcode:

File > Add Packages...

In the Search or Enter Package URL search box enter this URL:

text
https://github.com/auth0/SimpleKeychain

Then, select the dependency rule and press Add Package.

Cocoapods

Add the following line to your Podfile:

ruby
pod 'SimpleKeychain', '~> 1.0'

Then, run pod install.

Carthage

Add the following line to your Cartfile:

text
github "auth0/SimpleKeychain" ~> 1.0

Then, run carthage bootstrap --use-xcframeworks.

Usage

Learn about more advanced features in Examples ↗

See all the available features in the API documentation ↗

swift
let simpleKeychain = SimpleKeychain()

You can specify a service name under which to save items. By default the bundle identifier of your app is used.

swift
let simpleKeychain = SimpleKeychain(service: "Auth0")

Store a string or data item

swift
try simpleKeychain.set(accessToken, forKey: "auth0-access-token")

Check if an item is stored

swift
let isStored = try simpleKeychain.hasItem(forKey: "auth0-access-token")

Retrieve a string item

swift
let accessToken = try simpleKeychain.string(forKey: "auth0-access-token")

Retrieve a data item

swift
let accessToken = try simpleKeychain.data(forKey: "auth0-credentials")

Retrieve the keys of all stored items

swift
let keys = try simpleKeychain.keys()

Remove an item

swift
try simpleKeychain.deleteItem(forKey: "auth0-access-token")

Remove all items

swift
try simpleKeychain.deleteAll()

Error handling

All methods will throw a SimpleKeychainError upon failure.

swift
catch let error as SimpleKeychainError {
    print(error)
}

Support Policy

This Policy defines the extent of the support for Xcode, Swift, and platform (iOS, macOS, tvOS, and watchOS) versions in SimpleKeychain.

Xcode

The only supported versions of Xcode are those that can be currently used to submit apps to the App Store. Once a Xcode version becomes unsupported, dropping it from SimpleKeychain will not be considered a breaking change, and will be done in a minor release.

Swift

The minimum supported Swift minor version is the one released with the oldest-supported Xcode version. Once a Swift minor becomes unsupported, dropping it from SimpleKeychain will not be considered a breaking change, and will be done in a minor release.

Platforms

We support only the last four major versions of any platform, including the current major version.

Once a platform version becomes unsupported, dropping it from SimpleKeychain will not be considered a breaking change, and will be done in a minor release. For example, iOS 14 will cease to be supported when iOS 18 gets released, and SimpleKeychain will be able to drop it in a minor release.

In the case of macOS, the yearly named releases are considered a major platform version for the purposes of this Policy, regardless of the actual version numbers.

Feedback

Contributing

We appreciate feedback and contribution to this repo! Before you get started, please see the following:

Raise an issue

To provide feedback or report a bug, please raise an issue on our issue tracker.

Vulnerability reporting

Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

<picture> <source media="(prefers-color-scheme: light)" srcset="https://cdn.auth0.com/website/sdks/logos/auth0_light_mode.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://cdn.auth0.com/website/sdks/logos/auth0_light_mode.png" width="150"> </picture> Auth0 is an easy-to-implement, adaptable authentication and authorization platform. To learn more check out <a href="https://auth0.com/why-auth0">Why Auth0?</a> This project is licensed under the MIT license. See the <a href="./LICENSE"> LICENSE</a> file for more info.