Skip to content

ユースケース — ストアバックエンドを自前実装する ​

同梱の SQL アダプタ は WithNaming でテーブル名を差し替えられますが、カラム構成はアダプタが所有します。カラム名まで自由にしたい場合(reshape できない既存スキーマ、暗号化カラム、他システムと共有するテーブル、あるいは SQL ですらないバックエンド)は、store のサブストアインターフェースを自分で実装し、その集約を op.WithStore に渡します。本ライブラリは物理名を一切観測しません。コードが行をマップする先の store.* Go 構造体だけを見ます。

この経路は、SQL アダプタでは永続化境界を表せない場合だけ選んでください。自由度は最大ですが、bearer secret のハッシュ化、sentinel エラー、並行性、トランザクションをすべて自分で守る必要があります。既定カラムで足りるなら SQL アダプタを使い、ユーザ検索だけが独自ならユーザストアだけを差し替える方が単純です。

この分担は、片側が動かせず、もう片側が完全に自由です。各操作が何を意味するかは本ライブラリが固定し、その byte をどう保存するかはバックエンド側が決めます。

本ライブラリが固定するもの組み込み側が選ぶもの
nil 以外が必須のサブストアすべてのテーブル名とカラム名
op.New が検証する拡張インターフェースSQL / KV / DB を使わない実装
失敗モードごとの sentinel エラー暗号化・シャーディング・テナント分離
単一勝者の遷移と原子性トランザクションの実装方法
bearer secret の保存前ハッシュ化ダイジェストの計算方法と pepper

この 2 列を分ける境界が op.WithStore です。

ストアの境界を越えるのは構造体とエラーだけ
各ストア操作が何を保証しなければならないかは本ライブラリが持ち、それを実際にどう保存するかは自前のバックエンドが持ちます。境界を越えるのは store パッケージの Go 構造体と sentinel エラーだけです。ライブラリが持つのは「意味」「この認可コードを消費する」が何を保証すべきかどのエラーがどの結果を表すかop.WithStorestore.*store.Err*自前のバックエンドが持つのは「表現」行、item、キー、TTL — 都合のよい形で既に運用しているデータベースに合わせる
越えるのはこれだけです。だからアダプタはレビューできます。間違えうる論点はすべて表現の側にあり、そのどれにもインタフェースの契約が答えを与えているからです。

この境界を越えるのは store.* Go 構造体と sentinel エラーだけです。境界の向こう側にあるもの(名前、エンジン、エンコーディング)は OP からは一切見えません。

ソース: examples/26-byo-store-from-scratch — 手書きの vault_* スキーマを持つ SQLite 上に store.Store を完全実装し、CI で実際のブラウザログイン往復を通して検証しています。

何を実装するか ​

store.Store は小さなサブストアインターフェースの集約です(各インターフェースは 1 レコード種別を所有し、メソッドは 1〜6 個)。どれを nil 以外にする必要があるかは、有効にする grant と機能によって決まります。op.New はコアのサブストアと、有効にした grant が必要とするサブストアを検査し、足りないものをまとめて 1 つのエラーで報告します。認可コードフローをフルに提供する OP では、次を実装します。

サブストアインターフェースメソッドnil 以外が必須になる条件
クライアントstore.ClientStoreGetClient(動的登録をサポートしない限り ClientRegistry は不要)常に
ユーザstore.UserStore(op.PrimaryPassword を使うなら store.UserPasswordStore)FindBySubject / FindByUsername / ReadPasswordHashclient_credentials 以外の grant を使うとき。store.Store の一部ではなく、op.WithUserStore で渡すか、op.PrimaryPassword の Store として渡します。既存ユーザストアの投影 を参照
消費済み JTIstore.ConsumedJTIStoreMark / Has常に
認可コードstore.AuthorizationCodeStoreSave / Find / Consumegrant.AuthorizationCode
リフレッシュトークンstore.RefreshTokenStoreSave / Find / Consume / RevokeChain / RevokeByGrantgrant.RefreshToken
grantstore.GrantStoreSave / Find / FindBySubjectClient / ListBySubject / Delete / HasAnyclient_credentials 以外の grant
セッションstore.SessionStoreSave / Find / Touch / Delete / ListByChooserGroupgrant が /auth を mount する
インタラクションstore.InteractionStoreCASSave / Find / Delete / CompareAndSwap / DeleteIfUnchangedgrant が /auth を mount する
PARstore.PushedAuthRequestStoreSave / Find / Consumefeature.PAR
アクセストークンstore.AccessTokenRegistryRegister / Find / RevokeByJTI / RevokeByGrant / GC失効戦略 RevocationStrategyJTIRegistry(このとき op.New は nil を拒否します)。下記の補足も参照
grant 失効store.GrantRevocationStoreRevokeGrant / RevokeJTI / IsRevoked / GC既定の戦略 RevocationStrategyGrantTombstone
認証ロックアウトstore.AuthnLockoutStore(store.AuthnLockoutProvider 経由で解決)store.AuthnLockoutStore を参照ログインフローにパスワードまたは二要素目のステップがある
メタデータstore.MetadataStoreGet / Set実装を推奨(下記)

ロックアウトストアは、総当たり対策ゲートの失敗カウンタを保持します。ログインフローに失敗を数えるステップ(パスワード、二要素目、または CountFailures を指定した ExternalStep)があり、どこからも解決できない場合、op.New は op.ErrAuthnLockoutStoreRequired で失敗します。集約側が store.AuthnLockoutProvider(store.Store に AuthnLockouts() store.AuthnLockoutStore を加えたもの)を実装するか、op.WithAuthnLockoutStore でストアを渡してください。同梱アダプタ(inmem、SQL、DynamoDB、composite)はいずれも提供しています。

アクセストークン用と opaque アクセストークン用のサブストアは、どの失効戦略・形式を設定していても、失効と introspection が参照します。SQL アダプタが oidc_access_tokens と oidc_opaque_access_tokens をどの構成でも確認するのはこのためで、行が現れるのは JTI レジストリか opaque 形式を使うときだけです。op.New が nil を拒否するのは表に挙げた構成だけですが、戦略や形式を変える前に発行したトークンを失効できるよう、両方を実装してください。

それ以外のアクセサは、対応する機能を有効にしない限り nil を返してかまいません。OpaqueAccessTokens(opaque 形式のアクセストークンを使うときだけ)、InitialAccessTokens と RegistrationAccessTokens(動的登録)、DeviceCodes、CIBARequests です。op.New は nil を検出し、それを必要とするオプションを後から panic させるのではなく構築時に拒否します。GrantRevocations を省くには、あわせて op.WithAccessTokenRevocationStrategy(op.RevocationStrategyNone) を指定する必要があります(非 FAPI 配備専用)。

Metadata には、op.New が起動のたびに確認する subject 発行モード(public か pairwise か)が保存されます。アクセサが nil でも起動時の警告が出るだけですが、その場合は既存の grant ストアに対する public と pairwise の切り替えを誰も検出できず、影響を受けるすべてのユーザの sub が気付かれずに変わります。実装してください。

構築時に要求される capability ​

サブストアそのものとは別に、OP はいくつかの拡張インターフェースをランタイムの型アサーションで検出します。ある capability を core のサブストアではなく拡張に置くのは、その capability を必要としない OP も構築できるからです。/auth を一度も mount しない machine-to-machine のバックエンドに、ブラウザフロー用の仕組みまで実装させる理由はありません。バックエンド作者にとって重要なのは、設定されたフローが壊れる拡張の欠落は op.New で検証され、実際のリクエスト中に発覚することはないという点です。エラーはインターフェース名と、それを必須にした条件の両方を示します。

拡張判定対象必須になる条件
store.Transactional集約 Storegrant が /auth を mount する
store.InteractionStoreCASStore.Interactions()grant が /auth を mount する
store.GrantClientListerStore.Grants()grant が /auth を mount する
store.RefreshRetryResponseStoreStore.RefreshTokens()refresh_token が有効で cookie 鍵が設定されている
store.ClientRegistry集約 Storeop.WithDynamicRegistration
store.StaticClientReconciler集約 Storeop.WithStaticClients

現状 /auth を mount するのは grant.AuthorizationCode だけなので、client_credentials、device_code、CIBA だけを支えるストアは上位 3 つのいずれも必要としません。

store.StaticClientReconciler は、op.New の最後に op.WithStaticClients の内容を 1 回の原子的な呼び出しで投入するために使われます。実装がなければ op.New はこのオプションを拒否します。

  • Transactional は store.Tx を返し、その AuthorizationCodes()、Grants()、RefreshTokens()、PushedAuthRequests()、AccessTokens()、OpaqueAccessTokens()、GrantRevocations() は 1 つの下層トランザクションにバインドされます。認可の完了処理は grant、PAR の消費、認可コードの永続化をまとめて commit するため、署名や永続化の失敗が「request_uri だけ消費されてコードは出ていない」状態を作れません。トランザクション内の grant 読み出しは行ロック、serializable 分離、または同等の競合検出を Save の前に効かせる必要があります。ロックなしの SELECT と無条件の Save を 1 トランザクションに束ねただけでは、並行する同意更新は失われます。Sessions、Interactions、ConsumedJTIs は意図的に Tx から外してあります。
  • InteractionStoreCAS は、上記の永続化が始まる前に終端インタラクションを不変にします。CompareAndSwap は RawState が変化していないときだけレコードを置き換え(競合時は ErrConflict、不在または期限切れなら ErrNotFound)、DeleteIfUnchanged は競合が無かった場合にのみ削除します。
  • GrantClientLister は Back-Channel Logout の一斉通知が使う、上限付きの audience ビューです。ListClientIDsBySubject(ctx, subject, cursor, limit) は安定した昇順で最大 limit 件の client ID を返し、続きがあれば NextCursor を添えます。クエリ自体を limit+1 行に制限してください。ListBySubject を呼んで結果を切り出す実装では、ログアウト通知 1 件あたりのデータベース負荷とクライアントレジストリ参照を抑えるという目的が失われます。
  • RefreshRetryResponseStore は、封緘済みのトークンレスポンスを消費済みの前任トークンに紐づけて保存します。本ライブラリのリフレッシュ再試行の猶予期間中に、連鎖を分岐させず同じ後継トークンを返すためです。RFC 9700 §4.14.2 はローテーションと再利用検知を扱いますが、この猶予期間は規定していません。SaveRotationWithRetry は後継レコードと封緘済み blob を 1 つの操作で書き込む必要があり、それを原子的にできないバックエンドはこのインターフェースを公開してはなりません。blob は不透明な値として扱い、前任トークンの一方向ハッシュを鍵にし、保持期間は前任トークンの寿命を超えないようにします。

次の拡張は任意で、無くても OP は起動を拒否せず機能を縮退させます:

拡張判定対象欠けたときに失われるもの
store.RevokeByClientStore.RefreshTokens() とアクセストークン系サブストア動的登録クライアントの削除時、そのサブストアの一括失効カスケードが飛ばされる
store.RefreshChainResolverStore.RefreshTokens()chain の走査が保存ハンドル参照ではなく Find 経由になる
store.OpaqueAccessTokenChainRevokerStore.OpaqueAccessTokens()リフレッシュのローテーションが、自分の chain だけでなく grant 全体の opaque アクセストークンを失効させる
store.IssuanceRevocationCheckerStore.GrantRevocations()リフレッシュトークン 1 つの失効が、同じ grant の他のリフレッシュ連鎖と未引き換えの認可コードの発行まで拒否する
store.SchemaValidator構成が使うすべての storeop.New の構築時スキーマ検査が行われない(ValidateSchema はカタログを読むだけ)。テーブルやカラムの欠落は、それに触れる最初のリクエストで表面化する

Provider のメソッドが要求する拡張 ​

Provider のメソッドは設定ではなく呼び出しなので、op.New はそのメソッドが必要とするものを確認しません。代わりにメソッドが、最初の書き込みの前に確認します。

拡張判定対象要求するメソッド欠けたときの結果
store.SessionSubjectDeleterStore.Sessions()Provider.ForgetSubjectconfiguration_error。何も変更しない
store.AuthnLockoutDeleterlockout ストアProvider.ForgetSubjectconfiguration_error。何も変更しない

SessionSubjectDeleter が加えるのは DeleteBySubject(ctx, subject) です。期限切れかどうかを問わず、その subject のセッションをすべて消し、チューザグループを共有するものを含め、別 subject のセッションは残します。セッションが無ければ nil を返し、空の subject はエラーです。AuthnLockoutDeleter が加えるのは Delete(ctx, subject) で、記録が無ければ store.ErrNotFound を返します。同梱のインメモリ、SQL、DynamoDB アダプタは両方を実装しています。Redis は lockout ストアを持たないため、セッション側だけを実装します。composite アダプタは、バックエンドのストアをそのまま返します。ForgetSubject を呼ばないバックエンドは、実装を省けます。ユーザの消去を参照してください。

推測せず contract で確かめる

op/store/contract は core の契約をバックエンドに対して実行し、未実装の拡張はスキップします。どの capability が実際に揃ったかは、このスイートが教えてくれます。ユーザストアは store.Store のアクセサではないため、スイートは Backend.Users フィールドで受け取り、nil ならユーザ関連のケースをスキップします。

バンドル済みの store を自前のラッパで包むと、ラッパがこれらのインターフェースを転送しない限り、拡張は見えなくなります。ラッパに対する型アサーションは、内側の store がそのメソッドを実装していても失敗し、エラーも出ません。op.New は、op.WithLogger のロガー(未設定なら slog.Default())に、構成が使おうとしているのに store が実装していない任意 capability を、<サブストア>: <インターフェース> の形でまとめた INFO ログを 1 行出します。対象は store.IssuanceRevocationChecker と store.OpaqueAccessTokenChainRevoker で、動的登録を使う場合は store.GrantSubjectLister と store.RevokeByClient も加わります。OP は起動し、上の表のフォールバックで動きます。ラッパを導入したら、このログ行を確認してください。

実装すべき並行性の契約 ​

現在の store インターフェースは、セキュリティに関わる read-modify-write の規則を明示しています。近い動作で済ませるのではなく、バックエンドの契約として実装してください。

  • store.TOTPRecord.Version と store.EmailOTPRecord.Version は、保存後にストアが発行するゼロでない opaque token です。等価性だけに使い、増分、順序比較、削除 / 再作成後の再利用、JSON 文書への露出をしてはいけません。Put は呼び出し側の record を変更せず新しい token を割り当て、CompareAndSwap は next.Version == previous.Version を要求し、読み出した token を受け取り、Version を含む保存済み record 全体をフィールド単位で比較し、どちらの入力も変更せず新しい後継 token を割り当てます。古い、または不正なスナップショットには store.ErrAlreadyConsumed を返します。
  • store.CIBARequestStore.Approve は Pending → Approved を原子的に遷移させます。遅延解決型の record にすでに空でない Subject があり、別の subject を渡した場合は store.ErrConflict を返して record を変更しません。空の subject は 1 回だけ設定できます。不在または期限切れには store.ErrNotFound、Pending でない record の承認には store.ErrConflict を返します。Consume は Approved → Consumed の単回遷移を別に行い、Consumed には store.ErrAlreadyConsumed、Pending または Denied には store.ErrConflict を返します。
  • CIBA は集約の store.Transactional クラスタの外にあります。Approve と Consume は read と write を分けて近似せず、それぞれで原子的な遷移を提供してください。
  • store.InteractionStoreCAS は RawState を byte 単位で比較します。byte 列をそのまま保持し、CompareAndSwap / DeleteIfUnchanged を原子的に実行してください。JSON の再エンコードや whitespace の正規化で version を変えると、正しい完了処理まで store.ErrConflict になります。RawState を含む全フィールドが同一の replacement も成功した適用として扱います。更新行数が 0 だからといって競合と判断してはいけません。
  • store.GrantRevocationStore.RevokeGrant は冪等で、tombstone を広げる方向にしか更新しません。並行する呼び出しは、最も新しい RevokedAt と ExpiresAt に収束させます。行ロック、GREATEST()、条件付き書き込みのいずれかを使ってください。呼び出し側が決めた値を読んでから書き戻す方式では、先に読んだ cascade が最後に書き込み、もう一方が失効させたばかりのアクセストークンを復活させてしまいます。
  • store.GrantStore.Save は既存 grant を更新します。トランザクション中に row を lock するか、serializable isolation を使うか、古い基礎に対して store.ErrConflict を返してください。ロックなしの read と無条件の save では、並行する同意更新を黙って失います。

SQL アダプタはこれらの version token を oidc_totp_secrets.row_version と oidc_email_otps.row_version に保存します。version-aware writer を起動する前に SQL の migration 順序を確認してください。各 sentinel と遷移の実行可能な基準は contract suite です。

contract harness の contract.TOTPFactory は、store.TOTPStore そのものではなく、Store フィールドに store.TOTPStore を持つ contract.TOTPBackend を返します。任意の Diverge hook では Version を変えずに保存済み record を外部から変更するケースも検証できるため、バックエンドは record 全体の compare-and-swap を強制しなければなりません。

これらの SQL 名は同梱アダプタ固有です。BYO バックエンドは別のカラムや非 SQL の表現を選べますが、registration-token store には RegistrationAccessToken.AllowedScopes を保存し、MFA store には最初のリクエスト前から同等の opaque compare-and-swap 状態を用意する必要があります。

認可ごとの状態とリフレッシュ連鎖 ​

grant は 1 人のユーザと 1 つのクライアントの全認可で共有され、新しい認可のたびに書き換えられます。以前の認可コード、リフレッシュ連鎖、アクセストークンが後の認可の内容を報告しないよう、OP は認可時点の状態を発行するレコードにコピーします。次のフィールドを保存し、そのまま返してください。

レコード往復させるフィールド
store.AuthorizationCodeAuthTime、ACR、AMR、AuthorizationDetails、Claims、AuthorizationRecorded
store.RefreshTokenAuthTime、ACR、AMR、AuthorizationDetails、Claims、AuthorizationRecorded、ChainID
store.OpaqueAccessTokenAuthTime、ACR、AMR、AuthorizationDetails、Claims、AuthorizationRecorded、ChainID
store.GrantTombstoneAccessTokensOnly
  • AuthorizationRecorded は、他のフィールドが発行時に書き込まれたことを示す true です。false で読み戻された行は、grant から解決されます。これらを一切保存しないバックエンドでも動作はしますが、同じユーザとクライアントの後の認可によって、以前のトークンが報告する内容が変わります。フィールドは一括して保存するか、まったく保存しないかのどちらかにしてください。
  • ChainID は chain の根で割り当てられるランダムな非秘密値で、ローテーションのたびに引き継がれます。リフレッシュのローテーションは、自分の ChainID を持つ opaque アクセストークンだけを失効させるので、1 台のデバイスでリフレッシュしても、同じクライアント上の他のセッションは終了しません。これを有効にするには store.OpaqueAccessTokenChainRevoker.RevokeByChain(ctx, grantID, chainID) を実装します。空の chainID は何にも一致しません。
  • AccessTokensOnly は、リフレッシュトークン 1 つを /revoke で失効させたときに書く tombstone の印です。grant のアクセストークンは対象にしますが、同じ grant の他のリフレッシュ連鎖や未引き換えの認可コードは拒否してはいけません。grant 全体の cutoff とは別に保持してください。IsRevoked は両方を、store.IssuanceRevocationChecker.IsIssuanceRevoked は grant 全体の cutoff だけを参照します。このフィールドを落とすバックエンドは過剰に失効させます。どの tombstone も grant 全体を終了させるからです。

どちらの任意インターフェースも実装しないストアは、grant 全体に作用する動作のままです。1 つの chain の失効やローテーションが、同じ grant 配下のすべての chain に及びます。

クライアントシークレット: 現行と旧 ​

store.Client には、SecretHash の隣に 2 つのフィールドがあり、confidential クライアントが無停止でシークレットをローテーションできるようにします(無停止でシークレットをローテーションするを参照)。クライアントを永続化する ClientStore は、両方を往復させる必要があります。

フィールド意味ゼロ値
PreviousSecretHash直近のローテーション前に使われていたシークレットのハッシュ。SecretHash と同じエンコーディング旧シークレットなし
PreviousSecretExpiresAtPreviousSecretHash が認証に使えなくなる時刻。秒精度で比較される旧シークレットなし

期限は epoch 秒で保存し、読み出すときは time.Unix(n, 0).UTC() に戻します。0 はゼロ値の time.Time に対応させます。同梱のアダプタも同じ方法です。ハッシュが空でないのに期限がゼロの場合、旧シークレットは決して受理されません。そのため、これらのフィールドより前に作られたレコードには、ゼロ値が安全な既定値になります。

これらを無視するバックエンドでも、動作は続きます。現行のシークレットはこれまでどおり認証に使えます。失われるのは重複期間だけです。旧シークレットを読み戻せないため、受理されることがありません。また、旧シークレット付きでシードした静的クライアントは、比較のたびに保存済みのレコードと異なるため、op.SyncStaticClients は実行のたびに updated と報告します。SQL アダプタの場合、既存のデータベースには、新しいバイナリを起動する前に oidc_clients の列を追加する必要があります。足りない列は ValidateSchema が報告します。Store.Migrate が適用でき、各方言の文は、スキーマファイルと同じ場所の MIGRATIONS.md にあります。往復の確認は契約テストスイートが行います。

op.New が、保存済みのクライアントと食い違う静的シードを拒否するとき、エラーは食い違ったフィールドを名指しし、op.SyncStaticClients を案内します。独自バックエンドが同じ一覧を自前のツールで使いたい場合は、store.StaticClientDifferences(a, b *store.Client) を呼びます。2 つのレコードが等価なとき、またはどちらかが nil のときは nil を返し、そうでなければ食い違うフィールド名を store.Client の宣言順で返します。

store.Client には RFC 8705 §2.1.2 の matcher 5 つ(TLSClientAuthSubjectDN、TLSClientAuthSANDNS、TLSClientAuthSANURI、TLSClientAuthSANIP、TLSClientAuthSANEmail)もあります。tls_client_auth のクライアントを扱うバックエンドは、これらも保存してください。保存しないと、そのクライアントの証明書を照合できません。

カラム名は自由 ​

example は、すべてのテーブルとカラムに意図的に非 OIDC 的な名前を付けてこの点を証明しています。本ライブラリはどれも気にしません。

ストアのレコードexample のテーブルexample のカラム
クライアントvault_relying_partiesrelying_party、redirect_targets、permitted_scope
ユーザvault_principalsprincipal(subject)、login_handle、secret_phc
認可コードvault_grant_codestoken_secret_digest、principal、relying_party、ledger_id、requested_scope、expires_epoch、consumed_epoch
リフレッシュトークンvault_renewal_slipstoken_secret_digest、ledger_id、is_void
grantvault_consent_ledgerledger_id、principal、relying_party、requested_scope、is_revoked
PARvault_pushed_handleshandle_digest
セッションvault_browser_seatsseat_id、chooser_band
アクセストークンvault_wire_tokensticket_id(jti)、ledger_id、is_void

principal が subject、relying_party が client id、ledger_id が grant id です。物理スキーマを store.* 構造体へマップするのは、サブストア実装だけです。

守るべき契約 ​

サブストアの godoc が規範です。コンパイルが通っても、これらを無視するバックエンドはインターフェースを満たしていません。

  1. 保存前ハッシュ(hash-on-store)。 AuthorizationCode.ID、RefreshToken.ID、PushedAuthRequest.URI は opaque な bearer secret であり、所持しているだけで引き換えられます。提示された値を保存前にハッシュし(SHA-256、できればサーバ側 pepper で HMAC 化)、ダイジェストのみを保存し、Find / Consume では提示値をハッシュしてダイジェストを引き、constant-time で比較します。example は自己完結のため pepper なしの SHA-256 を使い、in-memory リファレンスと同じ方針にしています。本番バックエンドは pepper を加えるべきです。
  2. sentinel エラー。 store.ErrNotFound、store.ErrAlreadyExists、store.ErrAlreadyConsumed、store.ErrConflict、store.ErrTxRequired を、メソッドの godoc が定める箇所で正確に返します(sql.ErrNoRows → ErrNotFound、2 回目の Consume → ErrAlreadyConsumed)。呼び出し側は errors.Is でこれらを判別します。列挙された失敗モードに別のエラーを返すと、コンパイルが通っても契約違反です。
  3. 原子性と single-winner 遷移。 認可コードの引き換え、リフレッシュトークンのローテーション、PAR の消費は、いずれも複数のレコード種別にまたがります。本ライブラリは各サブストアの Save / Consume がそれ自体で原子的であることに依拠します。ブラウザの authorization-code フローを支えるバックエンドは、複数サブストアの書き込みが 1 つの下層トランザクションを共有するよう store.Transactional を実装しなければなりません(構築時に要求される capability を参照)。有効な live record に対する単回または条件付き遷移は、並行する caller のうちちょうど 1 つだけが成功し、他は規定の sentinel を返します。完全な record が変わらない idempotent replacement も成功です。更新行数が 0 だからといって競合と判断してはいけません。単回 Consume / TOTP Accept は、nil を返す前に消費または進捗状態を保存し、Email OTP Consume は入力の ConsumedAt が zero でもゼロでない ConsumedAt を保存します。example は同梱アダプタと同じ方式で実装しています — サブストアは *sql.DB と *sql.Tx の両方が満たす小さな querier インターフェースを受け取り、BeginTx がクラスタのサブストアを 1 つの *sql.Tx にバインドして返します。
  4. 認可コードでは期限を消費済み判定より先に確認します。 AuthorizationCodeStore.Consume は、期限切れかつ消費済みのコードに store.ErrNotFound を返します。期限切れが優先されます。期限内で消費済みなら store.ErrAlreadyConsumed を返します(利用できる場合は record も返し、呼び出し側が RFC 6749 §4.1.2 の replay cascade 用に GrantID を復元できるようにします)。この ErrAlreadyConsumed は replay の証拠として cascade を起動します。期限切れだけの場合は通常の invalid-grant として扱い、cascade を起動しません。正常な consume はゼロでない ConsumedAt を返します。
  5. リフレッシュのローテーションでは replay の証拠を維持します。 RefreshTokenStore.Consume も期限判定を優先します。期限切れかつ消費済みの row は store.ErrNotFound、期限内の replay は record と store.ErrAlreadyConsumed を返し、OP が chain root を復元できるようにします。ローテーションの save は、Revoked の親に対して redeemable な子を残さず、原子的に store.ErrAlreadyConsumed を返さなければなりません。親が見つからない場合は retention で回収済みの可能性があり、revocation の証拠にはならないため、子を保存します。SaveRotationWithRetry にも同じ親 record の規則が適用されます。
  6. Session、interaction、device code の record には限定されたライフサイクル契約があります。 SessionStore.Touch が変更するのは ExpiresAt と UpdatedAt だけです。他のすべての field と secondary index を維持し、値が変わらない冪等な更新も成功として扱います。期限切れ時刻を持つ SessionStore.Save または InteractionStore.Save は、期限切れ record 自体を保存しなくてもかまいません。ただし同じ ID の有効な record がある場合は削除または置き換えが必要で、以前の record を有効なまま残してはなりません。DeviceCodeStore.FindByUserCode は一致した公開状態の ID を空にして返し、user code から redeemable な device_code credential が漏れないようにします。
  7. PAR の期限判定は Find 側、Consume 側ではありません。 PushedAuthRequestStore.Find は、ブラウザが request_uri を /auth に持ち込んだ時点の presentation-time expiry gate です。Consume は単回使用性だけを強制し、提示後に ExpiresAt を過ぎたことだけを理由に拒否してはいけません。そうしないと、ログイン / MFA / consent が長引いた正常フローが、OP が要求を受け付けた後の code 発行時点で失敗します。

どの方式が合うか ​

やりたいこと採用する方式
既定のテーブルで、永続化だけしたいSQL アダプタ
テーブル名は独自、カラムは既定でよいSQL アダプタ + WithNaming
既存の users テーブルを残し、OIDC レコードは既定でよいユーザストアを自前実装する
テーブル名もカラム名もすべて独自にしたい、または非 SQL バックエンドこのページ

動かす ​

sh
(cd examples/26-byo-store-from-scratch && GOWORK=off go run -tags example .)

example は OP を :8080、ペアの RP を :9090 で起動します。[email protected] / demo でサインインすると、RP の /me ページに払い出された ID Token の claim が表示されます。すべて vault_* スキーマから提供されています。

続きはこちら ​