Auth0.swift: トークンの保存と更新

Auth0.swift でユーザーのログイン状態を維持する

offline_access スコープを含めて認証を行うと、リフレッシュトークン が返されます。これを使うと、資格情報を再度求めることなく新しいトークンをリクエストできます。

Credentials Manager

Auth0.swift には、資格情報の保存と更新を簡単に行うためのユーティリティクラスが用意されています。資格情報 インスタンスから accessToken または idToken プロパティにアクセスできます。これは、ユーザーの資格情報を管理するための推奨方法です。

まず、Auth0 モジュールをインポートします。

import Auth0

次に、Universal Login ページを表示します。

let credentialsManager = CredentialsManager(authentication: Auth0.authentication())

Auth0
    .webAuth()
    .scope("openid profile offline_access")
    .start { result in
        switch result {
        case .success(let credentials):
            // 資格情報をCredentials Managerに渡す
            credentialsManager.store(credentials: credentials)
        case .failure(let error):
            // エラーを処理する
        }
}

アプリをアンインストールしても、Keychain の項目は削除されません。そのため、初回起動時にアプリの Keychain 項目を必ずすべて消去することをおすすめします。

資格情報の確認

アプリの起動時に簡単なチェックを行い、更新可能な資格情報がマネージャーに保存されていることを確認しておくと便利です。保存されていない場合は、ユーザーに認証を促すことができます。

guard credentialsManager.canRenew() else {
    // ログインページを表示する
}

ユーザー資格情報の取得

次のようにして、ユーザーの資格情報を取得できます。

credentialsManager.credentials { result in 
    switch result {
    case .success(let credentials):
        // 有効な資格情報です。`idToken`、`accessToken` などのトークンプロパティにアクセスできます
    case .failure(let error):
        // エラーを処理し、ログインページを表示します
    }
}

token の有効期限が切れている場合でも、ユーザーの資格情報の更新方法はまったく同じです。Credentials Manager は資格情報を自動的に更新し、更新後の資格情報を Keychain に保存したうえで、資格情報またはエラーのいずれかを含む Result を返します。

代替方法 - SimpleKeychain

このセクションは、Credentials Manager を使いたくない開発者向けです。トークンを安全に保存できるよう、システムの Keychain を簡単に扱える軽量なラッパーである SimpleKeychain を用意しています。

まず、SimpleKeychain モジュールをインポートします。

import SimpleKeychain

次に、インスタンスを作成して必要なトークンを保存します。この場合は、認証が正常に完了した後、access_token と refresh_token を Keychain に保存します。

let keychain = SimpleKeychain(service: "Auth0")

Auth0
    .webAuth()
    .scope("openid profile offline_access")
    .start { result in
        switch result {
        case .success(let credentials):
            guard let refreshToken = credentials.refreshToken else { 
                // エラーを処理する 
                return
            }
            // トークンを保存する
            do {
                try keychain.set(credentials.accessToken, forKey: "access_token")
                try keychain.set(refreshToken, forKey: "refresh_token")
            } catch {
                // エラーを処理する
            }
            // この時点でアプリのメインフローに遷移するとよいでしょう
        case .failure(let error):
            // エラーを処理する
        }
}

それらを保存しておけば、いつでも新しい資格情報インスタンスを取得できます。

ユーザーの資格情報の更新

let keychain = SimpleKeychain(service: "Auth0")

Auth0
    .authentication()
    .renew(withRefreshToken: refreshToken)
    .start { result in
        switch(result) {
        case .success(let credentials):
            // Refresh Tokenのローテーションが有効な場合、新しいリフレッシュトークンが発行されます
            // 無効な場合は新しいアクセストークンのみが発行されます
            guard let refreshToken = credentials.refreshToken else { 
                // エラー処理
                return
            }
            // 新しいトークンを保存する
            do {
                try keychain.set(credentials.accessToken, forKey: "access_token")
                try keychain.set(refreshToken, forKey: "refresh_token")
            } catch {
                // エラー処理
            }
        case .failure(let error):
            // エラー処理
        }
}