
# SecretTemplate

`SecretTemplate` は、アプリ独自の秘密情報を、ログインがトークンを保持するのと同じストアであるプラットフォームの安全なストレージに保持する Bean です。オブジェクトをアプリケーションの `ObjectMapper` で JSON として、その名前空間 (デフォルトは `app.`) の下に書き込むので、アプリのキーがログインのもの (`oauth2.`) と出会うことはありません。Spring Vault の `VaultTemplate` (パスによる秘密情報) と `RedisTemplate` (シリアライザーを通したオブジェクト) に似た形をしています。

## 使う理由

PIN、API キー、暗号化されたデータベースの鍵は、共有の設定ではなく、キーチェーンや Keystore に置くべきものです。`SecretStore` はキーで文字列を保持します。テンプレートはオブジェクト、JSON、名前空間を加えるので、アプリは `secrets.write('pin', settings)` と書くだけで済みます。

## 例

```dart
@Introspected()
class PinSettings {
  const PinSettings({required this.hash, required this.attempts});

  final String hash;
  final int attempts;
}

@Service()
class Pin {
  Pin(this._secrets);

  final SecretTemplate _secrets;

  Future<void> save(String hash) =>
      _secrets.write('pin', PinSettings(hash: hash, attempts: 0));

  Future<PinSettings?> current() => _secrets.read<PinSettings>('pin');

  Future<void> forget() => _secrets.delete('pin');
}
```

## メソッド

| メソッド | 意味 |
|---|---|
| `write(key, value)` | テンプレートの名前空間の下に、オブジェクトを JSON として書き込む |
| `read<T>(key)` | それを読み戻す。ない場合は `null` |
| `delete(key)` | それを削除する |
| `keys()` | テンプレートのキー |
| `deleteAll()` | テンプレートのキーを取り除く。ストア自身の `deleteAll()` は、ログインのトークンも含めすべてを取り除く |

## 制限

- **データではなく、小さな秘密情報。** 各値はキーチェーンの項目、暗号化された設定、ファイル、キーリングのエントリーです。データベースではなく、呼び出しのたびに遅くなります。多くのデータ (ローカルのデータベース、ファイル) を保護するには、それを暗号化し、その暗号化の鍵だけをここに保持してください。
- **Web はなし。** ブラウザーには安全なストレージがないので、Web ではすべての呼び出しが (返される `Future` の中で) `UnsupportedError` で失敗します。メモリーや `localStorage` にフォールバックすることは決してありません。そこではサーバーが秘密情報を保持します。
- **置き換え可能。** それらを置き換えるには、`SecretTemplate` や `SecretStore` の Bean を宣言してください。

## Spring (Java) との対応

Spring Vault の `VaultTemplate` は、Vault サーバー上にパスで秘密情報を保持します。ここでは、保管庫はデバイスの安全なストレージです。

## 関連項目

- [トークンとログインウィンドウ](tokens-and-login-window.md)
- [アプリのファイル](../spring-boot-starter-flutter/files.md)
