iOS 16：秘密値の保存、FaceID認証に基づく個人情報の表示/非表示（LARight）

Last updated at 2022-11-19Posted at 2022-07-19

iOS 16でリリースされた新しいLARightオブジェクトを使用すると、以下のことが可能になります。

キーチェーンにデータを簡単に保存 (例えば、ログイントークンの保存など)
生体認証やデバイスのパスコードによる認証 (例えば、FaceID を使ってアプリの一部のエリアをロックするなど)
アプリ全体で生体認証のステータスを共有する。
.redactedを使用して、ユーザーが認証していない場合の情報を隠します。

新しいiOS 16.1 betaでは、ユーザーがLARightのロックを解除しようとすると、特別なシステムダイアログが表示されるようになりました。

キーチェーンにデータを簡単に保存

センシティブなデータを保存するには、まずデータを Data 形式に変換する。例えば、ユーザトークンの文字列をutf8エンコーディングでデータに変換することができる。

guard let encodedData = secretValue.data(using: .utf8) else {
    return
}

次に、将来的にデータを取得する方法を定義します（たとえば、生体認証またはデバイスのパスコードフォールバック付きの生体認証など）。ここでは、デバイスのパスコードを使用するフォールバックのある生体認証（FaceIDまたはTouchID）を使用するように定義しています。

func store(data: Data, withIdentifier: String) async throws {
+    let right = LARight(requirement: .biometry(fallback: .devicePasscode))
}

そして、その定義されたメソッドを使って認証を試み、使えるかどうかを確認します。その後、クレデンシャルを識別子（例えばapi_key）付きで保存します。

func store(data: Data, withIdentifier: String) async throws {
    let right = LARight(requirement: .biometry(fallback: .devicePasscode))
+    try await right.authorize(localizedReason: "Authenticate to access stored secret data.")
+    _ = try await LARightStore.shared.saveRight(right, identifier: withIdentifier, secret: data)
}

FaceID機能を使用するために、Info.plistファイルにNSFaceIDUsageDescriptionを追加することを忘れないでください。

また、let right = LARight(requirement: .biometry) という権限で、バイオメトリクス認証のみを定義することもできます。ただし、そのようにすると、バイオメトリクス認証でしかデータにアクセスできなくなります。例えば後でユーザーがFaceIDをオフにした場合、データにアクセスすることはできなくなります。

識別子が毎回変わる場合は、Core DataやUserDefaultsなどのどこかに識別子を保存することを忘れないようにしましょう。

キーチェーンからのデータ取得

過去に保存したデータを再利用するには、まず識別子からLARightをロードします。次に、そのLARightを認証します。
このとき、システムは権利の作成時に定義された認証方法を使用します。
認証が完了したら、データを読み込みます。

ここでは、Swiftの新しい機能である await を使用していることに注意してください。
これは、データの読み取りが認証を待つことを意味します。

func fetchData(withIdentifier: String) async throws -> Data {
    let right = try await LARightStore.shared.right(forIdentifier: withIdentifier)
    try await right.authorize(localizedReason: "Authenticate to access stored secret data.")
    return try await right.secret.rawData
}

完全なコード

データの読み書きのデモのための完全なコードです。

//
//  SecretStoreDemo.swift
//  LARightStoreDemo
//
//  Created by Sora on 2022/07/19.
//

import SwiftUI
import LocalAuthentication

struct SecretStoreDemo: View {
    
    @State private var dataIdentifier: String = "demo"
    @State private var secretValue: String = ""
    @State private var statusStr: String = ""
    
    var body: some View {
        Form {
            Section {
                TextField("Data identifier", text: $dataIdentifier)
                TextField("Secret value", text: $secretValue)
            }
            Section {
                Button("Save value") {
                    guard let encodedData = secretValue.data(using: .utf8) else {
                        self.statusStr = "Failed to encode string into data"
                        return
                    }
                    Task {
                        do {
                            try await store(data: encodedData, withIdentifier: self.dataIdentifier)
                            statusStr = "Saved!"
                            secretValue = ""
                        } catch {
                            self.statusStr = error.localizedDescription
                        }
                    }
                }
                .disabled(secretValue.isEmpty || dataIdentifier.isEmpty)
                
                Button("Read value") {
                    Task {
                        do {
                            let data = try await fetchData(withIdentifier: dataIdentifier)
                            guard let decodedStr = String(data: data, encoding: .utf8) else {
                                self.statusStr = "Failed to decode data into string"
                                return
                            }
                            self.secretValue = decodedStr
                        } catch {
                            self.statusStr = error.localizedDescription
                        }
                    }
                }
                .disabled(dataIdentifier.isEmpty)
                
                Button("Delete data") {
                    Task {
                        try? await removeData(withIdentifier: dataIdentifier)
                        secretValue = ""
                    }
                }
                .disabled(dataIdentifier.isEmpty)
            }
            Section {
                if !statusStr.isEmpty {
                    Text(statusStr)
                }
            }
        }
    }
    
    func store(data: Data, withIdentifier: String) async throws {
        let right = LARight(requirement: .biometry(fallback: .devicePasscode))
        try await right.authorize(localizedReason: "Authenticate to access stored secret data.")
        _ = try await LARightStore.shared.saveRight(right, identifier: withIdentifier, secret: data)
    }
    
    func fetchData(withIdentifier: String) async throws -> Data {
        let right = try await LARightStore.shared.right(forIdentifier: withIdentifier)
        try await right.authorize(localizedReason: "Authenticate to access stored secret data.")
        return try await right.secret.rawData
    }
    
    func removeData(withIdentifier: String) async throws {
        try await LARightStore.shared.removeRight(forIdentifier: withIdentifier)
    }
    
}

アプリ全体のFaceID認証

ユーザーの詳細なプロフィール情報など、アプリにはセンシティブな情報を含むエリアが複数存在する場合があります。各ビューが表示されるたびにFaceID認証を呼び出すのは難しいかもしれません。

LARightを使えば、アプリ全体でユニバーサルなFaceID認証を行うことができます。
ユーザーの認証状況を保持し、認証を解除することでユーザーをサインアウトさせることも可能です。

アプリ全体で共有するオブジェクトを作成

まず、アプリ全体で共有されるオブジェクトを作成します。
これにより、ユーザーが認証されると、アプリ内のすべてのビューがこの変更を知ることができます。

import Foundation
import SwiftUI
import LocalAuthentication

class AppWideAuthentication: NSObject, ObservableObject {
    
    static let shared = AppWideAuthentication()
    
    @Published var loginRight = LARight(requirement: .biometry(fallback: .devicePasscode))
    @Published var currentLoginState: LARight.State = .unknown
    
}

上記のコードでは、共有オブジェクトを作成しています。アプリのすべてのビューで、AppWideAuthentication.sharedを使用してアクセスします。

また、2つの @Published 変数があります。SwiftUIのビューでは、値が変更されたときに、公開された変数を参照するビュー要素が自動的にリロードされます。

次に、ログインとサインアウトのための関数コードを追加します。

class AppWideAuthentication: NSObject, ObservableObject {
    
    static let shared = AppWideAuthentication()
    
    @Published var loginRight = LARight(requirement: .biometry(fallback: .devicePasscode))
    @Published var currentLoginState: LARight.State = .unknown
    
+    func login() async throws {
+        try await loginRight.authorize(localizedReason: "Authenticate to access stored secret data.")
+        DispatchQueue.main.async {
+            self.currentLoginState = self.loginRight.state
+        }
+    }
+
+    func logout() async {
+        await loginRight.deauthorize()
+        DispatchQueue.main.async {
+            self.currentLoginState = self.loginRight.state
+        }
+    }
    
}

サインインとサインアウトのボタンをビューに追加します。

struct FaceIDAuthDemo: View {
    
    @ObservedObject var appAuth = AppWideAuthentication.shared
    
    var body: some View {
        Form {
            Button("Login") {
                Task {
                    try? await appAuth.login()
                }
            }
            Button("Logout") {
                Task {
                    await appAuth.logout()
                }
            }
            Label((appAuth.currentLoginState == .authorized) ? "Authorized" : "No access", systemImage: (appAuth.currentLoginState == .authorized) ? "checkmark.circle.fill" : "xmark")
        }
    }
    
}

また、アプリの他のビューでも、ユーザーの認証状況を確認できるようになりました。

struct ContentView: View {
    
    @ObservedObject var appAuth = AppWideAuthentication.shared
    
    var body: some View {
        Label((appAuth.currentLoginState == .authorized) ? "Authorized" : "No access", systemImage: (appAuth.currentLoginState == .authorized) ? "checkmark.circle.fill" : "xmark")
    }
    
}

使い方としては、ユーザーがFaceIDで認証されていない場合に、.redactedというビューモディファイアを使ってプライベートな情報を隠すことができます。

struct ContentView: View {
    
    @ObservedObject var appAuth = AppWideAuthentication.shared
    
    var body: some View {
        Text("Your account ID is xxxxxx")
            .redacted(reason: (appAuth.currentLoginState == .authorized) ? [] : .placeholder)
    }
    
}