FAQ
このページは「最初に見るべき場所」のひとつです。下に並んでいる質問は理屈ではなく、Maintainer が examples を書いたり Conformance ハーネスを回したりする途中で実際にハマったものばかりです。
- セットアップと基本必須 4 オプション、マウント先、Issuer 正規化、最小構成
- FAPI 2.0Baseline と Message Signing、DPoP / mTLS の選択
- トークンとローテーションリフレッシュ rotation の grace、
offline_access、TTL 分離 - DPoP と送信者制約DPoP nonce の配布、対応アルゴリズムの絞り込み理由
- ストレージ既存 users テーブルの扱い、アダプタ選択、composite の制約
- UI と SPASPA 駆動(React / Vue / Svelte / …)、CORS、同意画面のカスタム
- 認証と MFAパスワード / TOTP / passkey、step-up、リスクベース
- ログアウトFront-Channel を持たない理由、Back-Channel fan-out のギャップ
- ネイティブアプリとループバック
127.0.0.1redirect_uri のオプトイン - 観測性
/metricsを自動マウントしない理由、監査イベントカタログ - 適合性とバージョンREVIEW の意味、認証の称し方、pre-v1.0 の pin 戦略
- よくあるエラー
redirect_uri不一致、alg not allowed、jkt mismatch - 採用判断本番投入の可否、セキュリティ報告の経路
セットアップと基本
op.New(...) がエラーを返すのはなぜ?
必須 4 オプションに「安全なデフォルト」が存在しないためです。ゼロ値で黙って動くのではなく、op.New は構築時にエラーを返して止めます:
| オプション | これが無いと |
|---|---|
WithIssuer | OP が署名 / 名前空間に使う識別子が無い |
WithStore | clients / codes / tokens の永続化先が無い |
WithKeyset | ID Token に署名できない |
WithCookieKey | session / CSRF cookie を封緘できない |
エラーは欠けた項目名を明示するので、起動時のタイポは「実行時の謎」ではなくビルド時エラーになります。
推奨パターン
32 バイトの cookie 鍵を環境ごとに 1 度 crypto/rand で生成し、config / シークレットマネージャー経由で渡してください。標準的な 30 行のセットアップは examples/01-minimal/main.go を参照。
OP はどこにマウントすればいい? prefix を変えても大丈夫?
http.Handler をマウントしたパスにそのまま乗ります。プレフィックスは自由です — mux.Handle("/oidc/", op.StripPrefix("/oidc", h)) でも mux.Handle("/", h) でも変わりなく動きます。Discovery document には設定された issuer + マウント prefix が埋め込まれるので、RP からは一貫した URL として見えます。
最小構成は?
handler, err := op.New(
op.WithIssuer("https://op.example.com"),
op.WithStore(inmem.New()),
op.WithKeyset(myKeyset),
op.WithCookieKey(cookieKey), // 32 バイト
)4 オプションのみ、暗黙のデフォルトはなし。詳細は 最小構成 OP。
「Issuer の末尾にスラッシュは禁止」って本当?
本当です。RFC 9207 のミックスアップ防御はエコシステム全体での iss のバイト一致比較に依存しているので、op.WithIssuer は単一の正規形を強制します。次は全部弾きます:
- 末尾スラッシュ(
https://op/→ 不可) - scheme の大文字小文字混在(
HTTPS://op→ 不可) - デフォルトポート(
https://op:443→ 不可) - fragment(
https://op#x→ 不可) - query(
https://op?x=1→ 不可) - path に
..を含む
なぜこんなに厳しいの?
RP の検証側でも、片側に正規形でない 1 文字が紛れただけでバイト一致が崩れ、ミックスアップ防御が静かに無効化されます。本番に届く前に構築時エラーとして弾くために、構築時に厳しめに正規化しています。詳細は 設計判断 §9。
FAPI 2.0
op.WithProfile(profile.FAPI2Baseline) で具体的に何が ON になる?
1 行で、仕様が要求する 6 つのスイッチがまとめて入ります:
feature.PARとfeature.DPoPを有効化;token_endpoint_auth_methods_supportedを FAPI allow-list(private_key_jwt/tls_client_auth/self_signed_tls_client_auth)に絞る;- alg 制約を FAPI 部分集合にロック;
redirect_uriの完全一致を強制(ワイルドカード不可);- すべての code 要求で PKCE 必須;
- すべての authorize 要求で
stateまたはnonce必須。
プロファイル指定後にこれらと矛盾するオプションを重ねると、op.New がエラーを返します。
プロファイルは意図的に剛直 — 黙って緩めると FAPI 2.0 が買ってくれる監査保証が崩れるためです。
Baseline と Message Signing — どちらが必要?
| Baseline | Message Signing |
|---|---|
| PAR + PKCE + DPoP / mTLS | + JAR(署名付き authorization 要求) |
| + JARM(署名付き authorization 応答) |
RP 側で 非否認性 (non-repudiation) — authorize 要求 / 応答の署名による否認防止、オープンバンキングの監査連鎖など — が必要なら Message Signing。それ以外は Baseline で足ります。
DPoP なしで FAPI 2.0 を回せる?
可能です。feature.MTLS を有効化し、FAPI クライアントを tls_client_auth / self_signed_tls_client_auth で構成すれば mTLS 送信者バインディングに切り替わります。FAPI 2.0 §3.1.4 は「DPoP または mTLS」を要求しており、本ライブラリはどちらでも受理します。
トークンとローテーション
リフレッシュトークンのリトライで invalid_grant が返る — 既に通信中だったのに
ローテーション後の 猶予期間 (grace period) に守られているケースです。デフォルトは 60 秒。ローテーションのネットワーク往復が落ちても、猶予期間内に前のリフレッシュトークンを提示すれば、新しいアクセストークンを返します(再ローテーションは発生しません)。期間を過ぎたか、再利用検知で chain が失効しているケースでは invalid_grant になります。
期間を調整したいとき
op.WithRefreshGracePeriod(90 * time.Second) で延長できます。op.WithRefreshGracePeriod(-1) で猶予期間を完全に無効化(厳密な single-use)できます。詳細は 設計判断 §2。
リフレッシュトークンが返ってこないのはなぜ?
次の 3 つすべて が必要です。
- 付与された scope に
openidが含まれている。 - 付与された scope に
offline_accessが含まれている。 - クライアントの
GrantTypesにrefresh_tokenが含まれている。
ひとつでも欠けると、トークンエンドポイントは access_token + id_token を返して成功扱いとなり、refresh_token フィールドは付きません。
なぜ既定が厳しい解釈なの?
OIDC Core 1.0 §11 は offline_access 無しでも refresh token を発行できる余地を残していますが、それを許すと「同意 UI が約束した範囲」と「監査ログに残る範囲」がずれます。本ライブラリは両者が初期状態から一致するように、狭い解釈を既定にしています。詳細は 設計判断 §3。
「ログイン状態の維持」と通常セッションを TTL で分けたい
op.WithRefreshTokenOfflineTTL(...) で offline_access chain と通常ローテーションの TTL を分離できます。token.issued 監査イベントが extras.offline_access=true を出力するので、SOC ダッシュボードで chain を分けて可視化できます。
DPoP と送信者制約
DPoP nonce はなぜ必要? どう配るのが正解?
なぜ必要か。 RFC 9449 §8 で OP がサーバ供給 nonce を DPoP-Nonce レスポンスヘッダ経由でクライアントに渡し、事前生成された proof による攻撃を緩和できます。
どう配るか。 本ライブラリは in-memory のリファレンス実装と差し込み口を同梱しています:
src := op.NewInMemoryDPoPNonceSource(ctx, rotate) // demo グレード
op.WithDPoPNonceSource(src)実装例は examples/51-dpop-nonce。
複数インスタンス構成
プロセスローカルな nonce ソースはレプリカを跨げません。HA 構成では共有ストア(Redis)を DPoPNonceSource の裏に置いてください。Redis nonce ソースをライブラリに同梱しないのは意図的です — オプション群(TTL、ローテーション周期、ローテーション境界の取りこぼし許容度)が運用ごとに違いすぎるためです。
dpop_signing_alg_values_supported に RS256 が含まれていないのはなぜ?
意図的です。DPoP の discovery リストは ES256, EdDSA, PS256 で、コードベース全体の JOSE allow-list よりも狭くしています。RS256 は ID Token 署名では使えますが、DPoP proof は FAPI が推奨する部分集合に絞っています。
ストレージ
既存の users テーブルを置き換えないといけない?
いいえ。ライブラリは users テーブルを直接読み書きしません。op.Authenticator(または同梱の TOTP step を使う構成)と store.UserStore を既存スキーマに合わせて実装するだけです。OP は「このクレデンシャルは有効か」「この subject にはどんな claim があるか」を尋ねるだけで、それ以外で users テーブルに触ることはありません。
どのストレージアダプタを選べばいい?
| アダプタ | 想定 |
|---|---|
inmem | テスト、demo、単一プロセス開発 |
sql(SQLite / MySQL / Postgres) | 単一の永続バックエンド。最短で本番に乗せられる選択 |
redis(揮発サブストア専用) | composite で sql と組み合わせ、hot / cold を分離 |
composite | hot / cold 分離。「永続バックエンドは 1 つ」を構築時に強制 |
dynamodb | 予定(v1.x) |
SQL ストア と Hot / Cold 分離 を参照。
composite.New が起動時に設定を拒否する
トランザクションクラスタの不変条件があるためです — トランザクション系サブストア(clients / codes / refresh tokens / access tokens / IATs)は 同じ バックエンドを共有する必要があります。揮発スライス(sessions / DPoP nonce キャッシュ / JAR jti レジストリ)だけが別バックエンドに置けます。composite.New は構築時にこれを検証し、トランザクションを 2 つのストアに跨がせる設定を拒否します。
UI と SPA
SPA からログイン / 同意を駆動するには?
op.WithSPAUI(op.SPAUI{LoginMount: "/login", StaticDir: "./web/dist"})これだけで SPA shell + JSON state 面がマウントされます — 外側 mux で振り分ける必要はありません:
| Path | 役割 |
|---|---|
/login/{uid} | SPA shell(index.html を返す) |
/login/state/{uid} | prompt JSON(GET / POST / DELETE) |
/login/assets/{path...} | 静的アセット |
SPA(React / Vue / Svelte / Angular / vanilla、フレームワーク不問)は /login/state/{uid} から prompt を fetch し、{state_ref, values} を X-CSRF-Token ヘッダ(prompt.csrf_token を echo する double-submit cookie)と共に POST します。終端で返る {type:"redirect", location} エンベロープを window.location.href で辿れば完了です。
詳細は SPA / カスタム interaction と examples/10-react-login。
SPA-safe なエラー描画
エラーページは CSP default-src 'none'; style-src 'unsafe-inline' の下で <div id="op-error" data-code="..." data-description="..."> を出力するので、SPA ホストはマークアップを parse することなく selector で取得できます。
CORS — SPA の origin を許可するには?
op.WithCORSOrigins("https://app.example.com")WithCORSOrigins を呼ばない場合、登録済み redirect URI から allowlist が自動導出されます。詳細は SPA 向け CORS。
ライブラリを fork せずに同意画面をカスタマイズしたい
可能です。op.WithConsentUI(template) でデフォルト consent HTML を差し替えられます。完全なコントロールが欲しければ op.WithSPAUI で SPA を出します。テンプレートシームの例は examples/11-custom-consent-ui。
認証と MFA
パスワード / TOTP / passkey の検証はどこにある?
ライブラリは op.PrimaryPassword、op.StepTOTP、op.RuleAlways などのビルディングブロックを提供します。これらを op.LoginFlow に組み合わせて、どの factor をどの順で実行するかを決めます。クレデンシャルストレージは store.UserPasswords() / store.TOTPs() などを組み込み側で実装します。完全カスタムな factor が必要なら op.Authenticator を実装してください。詳細は examples/20-mfa-totp 以降を参照してください。
Step-up 認証はどう実装する?
クライアント別ポリシーで op.RuleACR(level) を使います。RP が現セッションよりも高い acr_values を要求すると、OP は WWW-Authenticate: error="insufficient_user_authentication"(RFC 9470)を返します。セッションは authenticator チェーンを通って step-up し、その後再開します。詳細は examples/23-step-up。
リスクベース MFA は?
op.RuleRisk(...) が、組み込み側で用意する RiskAssessor の評価結果を受け取ります。RiskOutcome は明示的な RiskScore を持ちます。詳細は examples/21-risk-based-mfa。
ログアウト
Front-Channel Logout が無いのはなぜ?
モダンブラウザの既定(third-party cookie の段階廃止、SameSite=Lax 既定など)が、Front-Channel Logout 1.0 / Session Management 1.0 が要求する「iframe ベースのセッション通知」を実質的に動かなくしました。ライブラリは代わりに RP-Initiated Logout 1.0 + Back-Channel Logout 1.0 を提供しています。詳細は 設計判断 §5。
Back-Channel Logout の fan-out で一部の RP に届かない
セッションが揮発ストアに置かれているケースで起こります。fan-out が走る前にセッションレコードが追い出された場合(Redis TTL がネットワーク分断中に切れたなど)、ライブラリはレコードを再構成できません。
op.AuditBCLNoSessionsForSubject 監査イベントがそのギャップを記録し、op.WithSessionDurabilityPosture で設定したポスチャと組み合わせることで、SOC ダッシュボードで「揮発配置における想定内のギャップ」と「永続配置における想定外のギャップ」を区別できます。揮発配置における best-effort は設計上の挙動です — 詳細は 設計判断 §10。
ネイティブアプリとループバック
CLI の 127.0.0.1:54312/cb 形式の redirect_uri が拒否された
デフォルトの redirect-URI マッチはバイト完全一致(OAuth 2.1 / FAPI 2.0)です。ループバックのポートワイルドカード(RFC 8252 §7.3)は クライアント単位でオプトイン — 登録済みの redirect_uris にループバック URI を含めれば、scheme が http、host が 127.0.0.1 または [::1]、path / query / fragment が完全一致のときに限り、ポート不一致を許容します。localhost は不可(DNS rebinding リスク)。詳細は 設計判断 §4。
観測性
op.WithPrometheus(...) を設定したのに /metrics が無い
ライブラリは /metrics を マウントしません。op.WithPrometheus(reg) は OP が絞り込んで保持するカウンタを、利用者が渡した registry に登録するだけです。
HTTP ルートのマウントはルーター側の責務です — トレーシング(otelhttp.NewMiddleware を被せる側)も、リクエスト所要時間ヒストグラム(ミドルウェアを被せる側)も同じ分離方針です。OP は OIDC 業務系の カウンタ / スパン / 監査イベントのみを発行し、HTTP ライフサイクルの観測は組み込み側に委ねます。
詳細は examples/52-prometheus-metrics。
ライブラリはどんな監査イベントを出す?
op/audit.go 内の op.Audit* 定数で列挙された有限カタログです:
| カテゴリ | カバー範囲 |
|---|---|
authorize.* | authorize endpoint の結果 |
token.* | トークン発行 / refresh / revoke |
session.* | セッションのライフサイクル |
consent.* | 同意判断 |
logout.* | ログアウト fan-out |
dcr.* | Dynamic Client Registration |
各イベントは request-id / subject / client-id を必ず持ち、加えてカテゴリ別フィールドを持つ extras map を運びます。購読は op.WithAuditLogger(...)(*slog.Logger)経由で行い、構造化ログエントリとしてカタログ名と extras 属性が記録されます。
適合性とバージョン
README に「138 PASSED, 0 FAILED」とあるけど、OFCS UI には REVIEW も出る
OFCS の判定は 3 値で、OP の不具合と言えるのは FAILED だけです:
| 判定 | 意味 |
|---|---|
PASSED | テスト実行 / OP は仕様どおりに振る舞った |
REVIEW | テスト実行 / OP は正しく振る舞った — 人間が UI 成果物(描画されたエラーページのスクリーンショット等)を目視確認する必要がある |
FAILED | OP が誤った挙動を返した |
本ハーネスは REVIEW を自動 pass にせず、そのまま記録します。本ライブラリの FAILED はゼロです。完全な内訳は OFCS 適合状況 を参照してください。
「OIDF 認証取得済み」と称してよい?
不可です。本プロジェクトは OpenID Foundation の会員費を支払っておらず、公式認証も取得していません。OFCS のベースラインは仕様適合性の再現可能なスナップショットであって、認証ではありません。詳細は セキュリティ方針を参照してください。
Pre-v1.0 — タグに pin すべき?
すべきです。v1.0 までは公開 Go API が任意の minor リリースで破壊的変更を受ける可能性があります。go.mod でタグを pin し、バージョン更新のたびに CHANGELOG を確認してください。BREAKING エントリを必ず明示するのがプロジェクトの約束です。
よくあるエラー
invalid_request: redirect_uri does not match a registered URI
redirect-URI 完全一致に引っかかっています。よくある原因 3 つ:
- 末尾スラッシュのドリフト(
/cbと/cb/)。 - デフォルトポートが片側だけ含まれる(
https://rp.example.com:443/cbとhttps://rp.example.com/cb)。 - CLI / ネイティブアプリのループバックで、RFC 8252 §7.3 のオプトインをしていない(前述)。
invalid_client: alg not allowed
クライアントの request_object_signing_alg / token_endpoint_auth_signing_alg がコードベースの allow-list(RS256、PS256、ES256、EdDSA)に含まれていません。FAPI 2.0 plan ではクライアントを PS256(または ES256 / EdDSA)に絞り込んでください — FAPI 2.0 は RS256 を禁じています。
invalid_dpop_proof: jkt mismatch
DPoP proof の公開鍵 thumbprint(RFC 7638)が、アクセストークンにバインドされた cnf.jkt と一致しません。これは送信者バインディングが正しく機能している証拠で、proof が違う鍵で生成されたか、アクセストークンが別クライアント向けかのどちらかです。
/par 成功後に invalid_request_uri が返る
認可コード発行後に /authorize?request_uri=… へ再度アクセスしています。request_uri はコード発行時点で one-time として消費されます(RFC 9126 §2.2、詳細は 設計判断 §1)。/par をやり直して新しい URI を発行してください。
採用判断
本番で使ってよい?
セキュリティ方針 — 特に「ここに 無い もの」のセクション — を読んでから判断してください。短くいえば、RP / OP / ユーザを自社管理する内部用途には適合します。第三者監査トレイルや公式認証が出荷条件にあるなら、本ライブラリは選ばないでください。
セキュリティ問題はどう報告する?
GitHub Security Advisories からプライベートに報告してください。完全なポリシーは 脆弱性報告ガイド を参照してください。