Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gilzoide/unity-key-value-store-apple-keychain
Key-Value Store implementation for Unity backed by macOS/iOS/tvOS/visionOS Keychain services
https://github.com/gilzoide/unity-key-value-store-apple-keychain
apple ios key-value key-value-store keychain keychain-services macos tvos unity unity2d unity3d upm upm-package visionos
Last synced: 2 days ago
JSON representation
Key-Value Store implementation for Unity backed by macOS/iOS/tvOS/visionOS Keychain services
- Host: GitHub
- URL: https://github.com/gilzoide/unity-key-value-store-apple-keychain
- Owner: gilzoide
- License: unlicense
- Created: 2024-03-29T20:54:34.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-03-31T22:55:50.000Z (9 months ago)
- Last Synced: 2024-11-10T16:13:15.416Z (about 1 month ago)
- Topics: apple, ios, key-value, key-value-store, keychain, keychain-services, macos, tvos, unity, unity2d, unity3d, upm, upm-package, visionos
- Language: C#
- Homepage:
- Size: 97.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Apple Keychain Key-Value Store for Unity
[](https://openupm.com/packages/com.gilzoide.key-value-store.apple-keychain/)
[Key-Value Store](https://github.com/gilzoide/unity-key-value-store) implementation backed by macOS / iOS / tvOS / visionOS [Keychain Services](https://developer.apple.com/documentation/security/keychain_services).
## Features
- [GenericPasswordKeychainItemKeyValueStore](Runtime/GenericPasswordKeychainItemKeyValueStore.cs): Key-Value Store implementation that stores data into a Generic Password Keychain Item.
Value data is stored as a `NSMutableDictionary` and serialized using `NSKeyedArchiver`.
- Supports the following Keychain Item attributes:
+ [Account](https://developer.apple.com/documentation/security/ksecattraccount)
+ [Service](https://developer.apple.com/documentation/security/ksecattrservice)
+ [Access Group](https://developer.apple.com/documentation/security/ksecattraccessgroup): allows accessing shared keychain groups
+ [Label](https://developer.apple.com/documentation/security/ksecattrlabel)
+ [Description](https://developer.apple.com/documentation/security/ksecattrdescription)
+ [Synchronizable](https://developer.apple.com/documentation/security/ksecattrsynchronizable): synchronization with iCloud
+ [Use Data Protection Keychain](https://developer.apple.com/documentation/security/ksecusedataprotectionkeychain): only relevant on macOS
## Dependencies
- [Key-Value Store](https://github.com/gilzoide/unity-key-value-store): interface used by this implementation, which also provides custom object serialization out of the box.
## How to install
Either:
- Use the [openupm registry](https://openupm.com/) and install this package using the [openupm-cli](https://github.com/openupm/openupm-cli):
```
openupm add com.gilzoide.key-value-store.apple-keychain
```
- Install using the [Unity Package Manager](https://docs.unity3d.com/Manual/upm-ui-giturl.html) with the following URL:
```
https://github.com/gilzoide/unity-key-value-store-apple-keychain.git#1.0.0-preview4
```
- Clone this repository or download a snapshot of it directly inside your project's `Assets` or `Packages` folder.
## Basic usage
```cs
using Gilzoide.KeyValueStore.AppleKeychain;
using UnityEngine;
// 1. Instantiate a GenericPasswordKeychainItemKeyValueStore with the Keychain Item attributes
var keychainItemAttributes = new GenericPasswordKeychainAttributes
{
Service = Application.identifier,
Description = "Small secrets used by the game",
IsSynchronizable = true, // synchronizable with iCloud
};
var kvs = new GenericPasswordKeychainItemKeyValueStore(keychainItemAttributes);
// 2. Set/Get/Delete values
kvs.SetBool("finishedTutorial", true);
kvs.SetString("username", "gilzoide");
Debug.Log("Checking if values exist: " + kvs.HasKey("username"));
Debug.Log("Getting values: " + kvs.GetInt("username"));
Debug.Log("Getting values with fallback: " + kvs.GetString("username", "default username"));
// Like C# Dictionary, this idiom returns a bool if the key is found
if (kvs.TryGetString("someKey", out string foundValue))
{
Debug.Log("'someKey' exists: " + foundValue);
}
kvs.DeleteKey("someKey");
// 3. Save the updated data into the keychain
kvs.Save();
// 4. Dispose of the GenericPasswordKeychainItemKeyValueStore when done
// This ensures the native data gets released correctly
kvs.Dispose();
```