EncryptedSharedPreferences: 概要、APIと使い方

EncryptedSharedPreferencesとは？

EncryptedSharedPreferences はandroidx.security.cryptoパッケージのクラスで、AndroidX Security 1.0.0（2019）で導入されました。SharedPreferencesインターフェースを実装していますが、すべての書き込み操作（putString、putInt、putBooleanなど）は事前にデータを暗号化し、読み取り操作はデータを復号化してから返します。

通常のSharedPreferencesの問題点

標準のSharedPreferencesは、アプリのディレクトリ（/data/data/package/shared_prefs/）にあるXMLファイルにデータを保存します。ファイルは暗号化されておらず、デバイスへのルートアクセスやバックアップ解析により、すべてのデータがプレーンなXMLとして読み取られます。認証トークン、APIキー、ユーザーの個人データが攻撃者にアクセス可能になります。

EncryptedSharedPreferencesはライブラリレベルでこの問題を解決します。データはディスクに書き込む前に暗号化され、読み取り時に復号化されます。開発者が手動で暗号化関数を呼び出す必要はなく、APIは通常のSharedPreferencesと同じです。

歴史とバージョン

AndroidX Securityライブラリv1.0.0は2019年12月にリリースされました。EncryptedSharedPreferencesは、Cipher + SharedPreferencesによる手動暗号化の旧来の手法を置き換えました。現在の安定版は1.1.0-alpha06（2024）で、API 19+をサポートしています。このライブラリはJetpackの一部であり、追加の権限は必要ありません。

Google Security Blog（2024）によると、EncryptedSharedPreferencesはクラウド同期を必要としない機密性の高いアプリ設定を保存する推奨方法です。より複雑なシナリオでは、SQLCipher暗号化を使用したRoomが推奨されています。

EncryptedSharedPreferencesの仕組み

EncryptedSharedPreferencesは2層の暗号化スキームを使用します。Master KeyはAndroid Keystoreに保存され、派生キーがデータ暗号化に使用されます。これにより、Keystoreの保護と対称暗号化のパフォーマンスを組み合わせています。

暗号化スキーム: AES-256 GCM + SIV

値にはAES-256 GCM（Galois/Counter Mode）が使用されます。これはデータの機密性と整合性を保証する認証暗号化モード（AEAD）です。キー（パラメータ名）にはAES-256 SIV（RFC 5297）が適用されます。これは内容を公開せずにキーを検索するために必要な決定論的暗号化です。

EncryptedSharedPreferencesの各ファイルには、暗号化されたキーと値のペアが含まれています。ファイル構造は、最初にメタデータ（バージョン、キー識別子）を含むヘッダー、次に暗号化されたエントリのリストです。ファイルは有効なXMLではなく、テキストエディタでは読み取れません。

MasterKeyとKeyStore

MasterKeyクラスは、Android Keystoreに保存される256ビットのマスターキーの作成と管理を担当します。MasterKey.Builderを使用すると、ストレージタイプ（Keystoreまたはソフトウェア）、生体認証保護、キーの有効期間を設定できます。デフォルトでは、マスターキーはAndroid KeystoreでAES/GCM/NoPaddingアルゴリズムを使用して生成されます。

import androidx.security.crypto.MasterKey
import androidx.security.crypto.EncryptedSharedPreferences

fun getEncryptedPrefs() {
    val masterKey = MasterKey.Builder(context)
        .setKeyScheme(MasterKey.AES256_GCM_SPEC)
        .build()

    val prefs = EncryptedSharedPreferences.create(
        context,
        "secure_prefs",
        masterKey,
        EncryptedSharedPreferences.PrefKeyEncryptionScheme.AES256_SIV,
        EncryptedSharedPreferences.PrefValueEncryptionScheme.AES256_GCM
    )
}

暗号化のセットアップと設定

EncryptedSharedPreferences.createは5つのパラメータを受け取ります。コンテキスト、ファイル名、マスターキー、キー暗号化スキーム、値暗号化スキームです。スキームの選択はパフォーマンスとセキュリティレベルに影響します。

キー暗号化スキーム

AES256_SIV — 決定論的暗号化: 同じキーは常に同じ暗号文を生成します。これはキー検索（SharedPreferences.getX(key)）に必要です。欠点: 攻撃者は繰り返される暗号文を照合して、どのキーが使用されているかを特定できます。AES256_SIV2 — 追加のランダム化を備えた改良版。

値にはAES256_GCMが使用されます。GCMは各値に12バイトのIV（初期化ベクトル）と16バイトの認証タグを追加します。これにより、機密性（誰も値を読めない）と認証（誰も検出されずに値を改ざんできない）が提供されます。

生体認証によるマスターキー保護

MasterKey.BuilderのsetUserAuthenticationRequired(true)メソッドは、Keystoreからマスターキーを取得する前に生体認証を要求します。これにより追加のレイヤーが追加されます。アプリがロック解除されたデバイスで実行されている場合でも、攻撃者はFace IDやTouch IDなしではEncryptedSharedPreferencesを読み取れません。

重要: setUserAuthenticationRequiredを使用する場合、ユーザーが生体認証を変更または削除すると、マスターキーは使用できなくなります。KeyPermanentlyInvalidatedExceptionを処理し、データ移行を伴う新しいマスターキーを作成する必要があります。

fun createBiometricKey(): MasterKey {
    return MasterKey.Builder(context)
        .setKeyScheme(MasterKey.AES256_GCM_SPEC)
        .setUserAuthenticationRequired(true)
        .setRequestStrongBoxBacked(true)
        .build()
}

fun writeSecureToken(token: String) {
    try {
        prefs.edit().putString("auth_token", token).apply()
    } catch (e: KeyPermanentlyInvalidatedException) {
        // 生体認証が変更されました — キーを再作成する必要があります
    }
}

Kotlinでの使用例

Kotlinを使用したAndroidアプリでのEncryptedSharedPreferences統合の完全な例を見てみましょう。androidx.security:security-cryptoライブラリはGradle経由で追加されます。

依存関係の追加

build.gradle（app）ファイルに追加: implementation "androidx.security:security-crypto:1.1.0-alpha06"。Kotlinプロジェクトの場合は、kotlin-stdlibも必要です。MasterKeyの初期化は1回だけ行われ、通常はApplication.onCreateまたはDIコンテナを介して行われます。

データの読み取りと書き込み

EncryptedSharedPreferencesインスタンスを作成した後、APIは通常のSharedPreferencesと変わりません。edit()はEditorを返し、すべてのメソッド（putString、getString、putBoolean、getBoolean）は同様に動作します。唯一の違いは内部にあります。データは書き込み時に暗号化され、読み取り時に復号化されます。

class AuthRepository(context: Context) {
    private val prefs = createEncryptedPrefs(context)

    fun saveCredentials(login: String, password: String) {
        prefs.edit()
            .putString("login", login)
            .putString("password", password)
            .apply()
    }

    fun getToken(): String? {
        return prefs.getString("auth_token", null)
    }

    fun clearAll() {
        prefs.edit().clear().apply()
    }
}

通常のSharedPreferencesからの移行

暗号化されていないSharedPreferencesからEncryptedSharedPreferencesに既存のデータを移行するには: 古いファイルからすべてのデータを読み取り、新しいEncryptedSharedPreferencesを作成し、すべてのデータを書き込み、古いファイルを削除します。Googleは組み込みのマイグレーターを提供していないため、開発者が手動で実装します。

通常のSharedPreferencesとの比較

SharedPreferencesとEncryptedSharedPreferencesの選択は、保存するデータの種類によって異なります。UI設定（テーマ、言語、並び順）には通常のSharedPreferencesで十分です。機密情報（トークン、パスワード、キー）にはEncryptedSharedPreferencesが必須です。

パフォーマンス

EncryptedSharedPreferencesは暗号化操作のため、通常よりも低速です。1つの文字列値の書き込みには約5〜15ミリ秒かかります（データサイズとAESハードウェアアクセラレーションに依存）。読み取りは2〜5ミリ秒です。ほとんどのアプリではこれは目立ちませんが、バッチ操作（移行、復元）ではcommit()ではなくapply()を使用してください。

セキュリティ

通常のSharedPreferencesは暗号化による保護を一切提供しません。XMLファイルはルートアクセスを持つプロセスやadbバックアップを介して読み取られます。EncryptedSharedPreferencesはアプリケーションレベルでデータを暗号化し、マスターキーはオプションのハードウェア保護（StrongBox）付きでAndroid Keystoreに保存されます。

EncryptedSharedPreferencesを選ぶべき場合

EncryptedSharedPreferencesを使用して保存: OAuthリフレッシュトークン、外部サービス用のAPIキー、ユーザーのメールアドレスや電話番号、機密性の高いアプリ設定（PIN、認証フラグ）。EncryptedSharedPreferencesは生体認証データや大きなドキュメントの保存には適していません。代わりにEncryptedFileまたはSQLCipherを使用したRoomを使用してください。

一般的なルール: データ漏洩がユーザーやビジネスに害を及ぼす場合はEncryptedSharedPreferencesを使用します。データが外観的なもの（テーマ、言語、並び順）のみの場合は通常のSharedPreferences。EncryptedSharedPreferencesは最初から実装するのが理にかなっており、リファクタリングは不要です。既存のプロジェクトでの置き換えには移行と古い暗号化されていないデータの処理が必要です。

EncryptedSharedPreferencesはアプリ実行中のデータは保護せず、ディスク上のみであることに注意してください。攻撃者がプロセスメモリにアクセスできる場合、復号化されたデータが傍受される可能性があります。追加の保護として、難読化のためにProGuard/DexGuardを使用してください。