KeychainAccessでKeychainを簡単に扱おう

Keychain

そもそも Keychain を使うメリットは何なのかという事になります。

似たような仕組みに UserDefaults があるのですが、何が違うのかを考えてみましょう。

	UserDefaults	Keychain
アプリ削除	データ消失	消えない
データ保存先	アプリ内	Keychain
暗号化	されない	される
データの共有	不可	条件を満たせば可能
他アプリからのデータ共有	不可	条件を満たせば可能
利用目的	非セキュアなデータ保存	パスコードなどの保存

データを共有するかどうかはおいといて、セキュアにデータを保存できるのが Keychain の強みとなります。アプリを削除してもデータが消えないというのは便利な気がしますね。

例えば Salmonia であれば Keychain に iksm_session を保存しておけばアプリを削除しても復活できるのは便利です。

KeychainAccess

Keychain にアクセスするのはめんどくさいのですが、KeychainAccessというライブラリを使えば簡単にアクセスできます。

が、これを使っても少し面倒な一面があるのでそれを更に便利にするための Extension を考えます。

1
import KeychainAccess
2

3
var keychain: Keychain {
4
    let server = "tkgstrator.work"
5
    return Keychain(server: server, protocolType: .https)
6
}
7

8
enum KeyType: String, CaseIterable {
9
    case iksmSession = "iksmSession"
10
    case sessionToken = "sessionToken"
11
}
12

13
extension Keychain {
14
    func setValue(value: String, forKey: KeyType) {
15
        try? keychain.set(value, key: forKey.rawValue)
16
    }
17

18
    func getValue(forKey: KeyType) -> String? {
19
        return try? keychain.get(forKey.rawValue)
20
    }
21

22
    func remove(forKey: KeyType) {
23
        try? keychain.set(nil, key: forKey.rawValue)
24

25
        // こっちでもいけるかも
26
        try? keychain.remove(forKey.rawValue)
27
    }
28
}

例えば上のような Extension を考えます。すると以下のようなコードでデータの読み書きができるようになります。

今回データの読み書きに Enum を使ったのは Typo によるキー指定のミスをなくすためです。キーの数が多ければミスも増えると思うので、Enum を使ったほうが良いかもしれません。

ただ、Enum が多いと書くのが面倒なので一つや二つくらいであれば直接指定でもいいのかも。

1
// データ保存
2
keychain.setValue(value: "IKSM SESSION", forKey: .iksmSession)
3

4
// データ取得
5
let iksmSession = keychain.getValue(forKey: .iksmSession)
6

7
// データ削除
8
keychain.remove(forKey: .iksmSession)

NSData や String の保存には対応しているっぽいのですが、Bool や Int の保存は現状できないっぽい感じでしょうか。まあ必要とあらば上手く変換したりすればいけるのではないかと思います。

@youtube