Skip to content

可観測性 ​

本番で必要な可視化は 4 系統あります。ここでいう 監査イベント は、OP がセキュリティ上意味のある判断(ログイン、トークン発行、リフレッシュトークンの再利用など)ごとに出す構造化レコードのことで、プロセスの動作を伝える運用ログとは別物です。

系統載るものOP 側の差し込み口組み込み側の責務
運用ログリクエストエラー、設定の問題、起動時の状態WithLogger(*slog.Logger)構造化ログの送り先
監査イベント発火するシグナルと予約語(カタログ)WithAuditLogger(*slog.Logger)SOC パイプライン
メトリクスOIDC の業務カウンタWithPrometheus(*prometheus.Registry)/metrics ルート
トレースリクエストスパン内蔵なしhttp.Handler を otelhttp.NewMiddleware でラップ

ライブラリはこれらを意図的に分離しています。任意のサブセットだけを組み込むことができます。

OP はイベントを出し、振り分けは運用基盤が担う
OP はプロトコル層の監査イベントを出し、その外側の HTTP 層はリクエスト ID とトレーススパンを出します。運用基盤がその両方を、運用ログ・監査ログ・メトリクス・トレースへ振り分けます。出す側届く先自前の HTTP 層OP を既に包んでいるミドルウェアリクエスト ID · スパン · status · latencyOP のハンドラプロトコル処理だけを担う監査イベント — 判断 1 件につき 1 つ運用ログこのリクエストで何が起きたか監査ログ誰に何がいつ許可されたかPrometheusエンドポイントごとの流量とレイテンシOpenTelemetryOP が収まっているスパン
本ライブラリは logger も registry も exporter も持ちません。イベントを出すだけで、振り分けは既存の基盤に任せます。だから OP は既存のダッシュボードの隣ではなく、その中に現れます。

構造化ログ ​

go
logger := slog.New(slog.NewJSONHandler(os.Stdout, nil))

op.New(
    /* ... */
    op.WithLogger(logger),
)

運用ログがカバーする範囲:

  • 起動時の設定警告。有効にしていない grant を名指しする静的クライアントごとの警告と、WithLogger も WithAuditLogger も未設定のときの警告を含みます。
  • 外向きの取得(RP の JWKS、JAR の request_uri、Client ID Metadata Document、sector_identifier_uri)が private-network の deny-list に拒否されたときの WARN。解除する WithAllowPrivateNetwork のオプション名が添えられます。WithAllowPrivateNetwork の対象ごとの起動ログもあり、宛先が open な dynamic registration や Client ID Metadata Documents で呼び出し側から決まる場合は WARN になります。
  • 機密クライアントが、有効なプロファイルが PKCE を必須にしたためだけで code_challenge 欠落により /authorize で拒否されたときの client_id ごとの WARN。op.WithProfile(profile.OIDCCore) が示されます。
  • user store が標準 claim を誤った JSON 型で返し、その claim を除外したときの claim 名ごとの WARN。
  • エンドポイント内部のエラー(典型的には IsServerError(err) が一致するもの — エラーカタログ を参照)。
  • ストアバックエンドの障害。

WithLogger を渡さない場合、構築時の診断(構成の警告や claim_source などの起動時のログ行)は slog.Default() に出力され、リクエスト時の記録は破棄されます。渡したハンドラは redaction フックで自動的にラップされ、OAuth/OIDC の認証情報にちなんだ名前の属性(access_token、refresh_token、id_token、code、code_verifier、client_secret、password、state、nonce、dpop、authorization、cookie、set-cookie、request_uri、device_code、user_code など)や、名前に secret、token、password、assertion、bearer、private_key を含む属性は、ハンドラに到達する前にマスクされます。

監査ログ ​

監査イベントは保管期間・索引・アクセス制御が運用ログとは違うので、独立した出力先(sink)にします:

go
auditFile, _ := os.OpenFile("/var/log/op/audit.jsonl",
    os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0600)
auditLogger := slog.New(slog.NewJSONHandler(auditFile, nil))

op.New(
    /* ... */
    op.WithAuditLogger(auditLogger),
)

各イベントは JSON 1 行で記録されます。すべてのレコードに audit="true" が付くので、共有のハンドラでも監査行だけを専用の出力先へ振り分けられます。event 属性にはイベント名("login.failed" など)が入り、msg は人間向けの短いメッセージです。actor_id、client_id、session_id、request_id、ip、user_agent、tag は設定時だけ出力され、空でない extras グループにカテゴリ固有のフィールドが入ります。全イベント名は 監査イベントカタログ を参照してください。

WithAuditLogger を渡さない場合、監査レコードは WithLogger のロガーへ流れます。どちらも渡さなければ破棄されます。op.New は戻る前に startup.profile を 1 件書き出します。宣言した profile・feature・grant と、そこから解決された方針(PKCE、PAR、sender constraint、有効期限など)を持つため、以降のレコードを読む基準となる構成が監査ストリームの先頭に残ります。

WithAuditLogger のハンドラは、リクエストの goroutine 上で同期的に実行され、OP はその戻りを待ってからレスポンスを書きます。出力先が遅いと、その遅延がトークン・認可・ログアウトのすべてのリクエストに乗ります。遅い I/O や無制限の queue でブロックさせず、並行呼び出しに対して安全にしてください。最終的な出力先がリモートなら、上限付きで並行安全な queue にレコードを渡します。OP はリトライせず、ハンドラが panic してもリクエストは失敗させずに回復します。カタログには OP が発火しない予約語もあるため、すべての定数を発火の証拠として扱わないでください。

1 本のストリームを複数の出力先へ

1 つの *slog.Logger を fan-out 用のハンドラに通せば、ファイル + Loki + Splunk に同時に流せます。OP は自身で slog.Record を構築し、logger の Handler().Handle(...) に直接渡します。logger.LogAttrs(...) でイベントを作り直すことはありません。これにより WithClock が供給した監査 timestamp が保たれます。

introspection の store 障害 ​

opaque access token または refresh token の lookup が store.ErrNotFound を返す場合は通常の inactive 結果であり、障害イベントは発火しません。それ以外の lookup error では、store_unavailable reason を付けた error level の audit.IntrospectionError (introspection.error) を発火します。/introspect の通信路上の応答は HTTP 200 と {"active":false} のままなので、アラートと調査では 5xx counter ではなく監査ストリームを参照してください。同じイベントは、/introspect でクライアント認証に失敗した場合の記録にも使われます。このエンドポイントが client_authn.failure ではなく専用のシグナルを持つのはそのためです。

Prometheus メトリクス ​

go
reg := prometheus.NewRegistry()

op.New(
    /* ... */
    op.WithPrometheus(reg),
)

// /metrics は好きなルートにマウント。通常は公開 OP のリスナでは
// なく、認可境界の裏に置く。
mux := http.NewServeMux()
mux.Handle("/metrics", promhttp.HandlerFor(reg, promhttp.HandlerOpts{}))
go http.ListenAndServe("127.0.0.1:9090", mux)

ライブラリは /metrics をマウントしません。ルートと境界は組み込み側が選択します。カウンタは監査カタログから厳選した部分集合で、同じ発行経路から更新されます。すべての系列に定数ラベル issuer が付くので、複数の provider が 1 つの registry を共有できます。ただし同じ issuer の provider を同じ registry に載せると op.New が失敗します。client_id ラベルは静的に登録したクライアントでのみ埋まり、動的登録のクライアントは空の値にまとまるため、カーディナリティは抑えられます。registry を渡して OP を動かし、全カウンタを一覧できる examples/52-prometheus-metrics も参照してください。

カウンタラベル数えるもの
oidc_token_issued_totalgrant_type、client_id開始された refresh chain の数(開始した grant 別)。refresh token を発行しない grant は数えません
oidc_tokens_refreshed_totalclient_id完了したリフレッシュトークンのローテーション
oidc_login_attempts_totalfactor、resultログインと MFA の試行
oidc_refresh_replay_detected_total、oidc_code_replay_detected_totalなし再利用されたリフレッシュトークンと認可コード
oidc_client_authn_failures_totalauth_method、reasonクライアント認証の失敗
oidc_back_channel_logout_total、oidc_logout_failures_totalresult、kindback-channel の配送結果と、ログアウト時の永続化失敗
oidc_dcr_events_total、oidc_device_authorization_events_total、oidc_device_code_events_total、oidc_ciba_events_total、oidc_token_exchange_events_total、oidc_custom_grant_events_totaleventフローごとの結果。ラベルは、監査イベント名からプレフィックスを除いたもの
oidc_introspection_errors_total、oidc_token_revoke_failures_total、oidc_key_retired_kid_presented_totalなし、kind、なしintrospection の障害、失効の副作用の失敗、退役した kid の提示

OP が出さないメトリクス ​

これらは OP ではなく HTTP ミドルウェアの領域です:

  • HTTP リクエスト時間ヒストグラム — OP のハンドラの周りに promhttp.InstrumentHandlerDuration をかぶせてください。
  • HTTP ステータスコードカウンタ — 同上。
  • in-flight リクエストゲージ — 同上。

組み込みパターン:

go
inFlight := prometheus.NewGauge(prometheus.GaugeOpts{
    Name: "op_http_requests_in_flight",
})
duration := prometheus.NewHistogramVec(prometheus.HistogramOpts{
    Name: "op_http_request_duration_seconds",
}, []string{"code", "method"})
reg.MustRegister(inFlight, duration)

instrumented := promhttp.InstrumentHandlerInFlight(inFlight,
    promhttp.InstrumentHandlerDuration(duration, opHandler))

http.Handle("/", instrumented)

この分離があるため、HTTP 層を差し替え(chi、gin、fiber など)ても、OP 側のメトリクスには手を入れる必要がありません。

トレース ​

OP は http.Handler を返します。OpenTelemetry の HTTP ミドルウェアで 1 度だけラップしてください:

go
import "go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp"

http.Handle("/", otelhttp.NewHandler(opHandler, "oidc-op"))

スパンを作るのは otelhttp.NewHandler などのミドルウェアであって、OP ではありません。本ライブラリは、リクエストのライフサイクルも業務処理も含め、OpenTelemetry のスパンを一切内蔵しません。/token 内の PKCE 検証にどれだけかかったかといった段階別のトレースが必要なら、組み込み側で計装してください。監査イベントカタログが提供するのはスパンではなく、離散的なイベント記録です。

リクエスト ID ​

OP は X-Request-ID や Traceparent ヘッダからリクエスト ID を抽出することはなく、自ら ID を生成することもありません。監査レコードには request_id 属性がありますが、OP 自身のハンドラはこれを設定しないため、ストリームには現れません。リクエストとレスポンスの相関付けは、トレースで HTTP 層全般について述べたのと同じく、組み込み側の責務です。

エッジでリクエスト ID を生成し、レスポンスに刻んで RP のログと相関を取れるようにし、OP の周りで組み込む自前のログでも相関キーとして使ってください:

go
http.Handle("/", requestIDMiddleware(opHandler))

func requestIDMiddleware(h http.Handler) http.Handler {
    return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        rid := r.Header.Get("X-Request-ID")
        if rid == "" {
            rid = newUUID()
            r.Header.Set("X-Request-ID", rid)
        }
        w.Header().Set("X-Request-ID", rid)
        h.ServeHTTP(w, r)
    })
}

推奨ダッシュボード ​

最低限の本番ダッシュボードは以下を出します:

パネルソースアラート閾値
grant_type 別の新規 refresh chain 数oidc_token_issued_totalベースライン比 50 % 以上の持続的な低下
/token の 5xx 率HTTP ミドルウェアのヒストグラム5 分窓で 0.5 % 超
refresh.replay_detected の発生率oidc_refresh_replay_detected_total または監査ログ0 超(非ゼロ自体が要調査)
bcl.no_sessions_for_subject の発生率監査ログ発生率の上昇を grant / client 状態と相関し、snapshot の文脈は別途確認
アクティブセッション数ストアのクエリまたは自前メトリクス30 % 超の低下
JWKS リクエスト率HTTP ミドルウェアRP キャッシュの健全性指標

最初の 3 つが本番異常の S/N が高い指標です。bcl.no_sessions_for_subject の発生率が上昇したら、運用者は grant / client 状態と突き合わせて原因を絞り込んでください。設定した posture は ログアウト要求と session スナップショットの永続性を読み解くための文脈であり、空の RP audience の原因ではありません。残り 2 つは RP 側の regression を捕まえます。

レート制限と濫用シグナル ​

本ライブラリは認可エンドポイント・/par・/token・/userinfo その他の公開エンドポイントに対して、組み込みのレート制限を 同梱していません。WithRateLimit のようなオプションも存在しません。レート制限は運用側の役割です — リバースプロキシ(NGINX、Envoy、Traefik)、エッジサービス(Cloudflare、Fastly)、あるいは *op.Provider(http.Handler を実装)の前段ミドルウェアが、IP 単位・クライアント単位のリクエスト枠を持つべき場所です。ライブラリ側にあるかのように書くのは誤った期待を生むだけです。

ライブラリが代わりに発行しているのは、実際の制限がどこに置かれていても濫用パイプラインが消費して攻撃者をスコアリングできる、構造化された監査イベント群です:

監査イベント / 定数何を示すか
pkce.violation
audit.PKCEViolation
/token で code_verifier の検証に失敗しました。
redirect_uri.mismatch
audit.RedirectURIMismatch
/authorize に未登録の redirect_uri が来たか、/token に認可リクエストと異なる値が来ました。
client_authn.failure
audit.ClientAuthnFailure
/token・/par・/device_authorization・/bc-authorize でのクライアント認証失敗。
client_authn.previous_secret
audit.ClientAuthnPreviousSecret
client_secret_basic または client_secret_post のクライアントが、無停止でシークレットをローテーションするの猶予期間内に、旧シークレットで認証した。
device_code.verification.user_code_brute_force
audit.DeviceCodeUserCodeBruteForce
デバイスコード確認画面で user_code が総当たりされている。
ciba.poll_abuse.lockout
audit.CIBAPollAbuseLockout
クライアントが CIBA の auth_req_id を間隔より速くポーリングし続け、違反回数の閾値を超えた。
rate_limit.exceeded
audit.RateLimitExceeded
組み込み側のレート制限ミドルウェアから発火させるための予約イベント。
rate_limit.bypassed
audit.RateLimitBypassed
同じ趣旨 — 組み込み側ミドルウェアが明示的な bypass(許可リスト済み IP、内部プローブ等)を記録するためのもの。
  • pkce.violation:同じクライアントから続く場合は、盗まれたコードを verifier なしで試している兆候です。
  • redirect_uri.mismatch:さまざまな値が続く場合は探索、同じ値の繰り返しは多くの場合 RP の設定ミスです。
  • client_authn.failure:/introspect は別の audit.IntrospectionError を使い、/revoke はどちらも使いません。
  • client_authn.previous_secret:warn レベルで、属性は client_id と method で、シークレットは含みません。そのクライアントについてこのイベントが届かなくなれば、切り替えが済んでいるので旧シークレットを外せます。Prometheus の counter はありません。
  • device_code.verification.user_code_brute_force:レコードに紐付く helper はレコード単位で制限し、最初の手入力画面を複数レプリカで動かす場合は共有 limiter と devicecodekit.VerifyUserCodeByAttemptKey を使います — 確認 helper は Device Code(RFC 8628) を参照。
  • ciba.poll_abuse.lockout:閾値を超えたリクエスト自体には slow_down が返り、レコードが deny されるので、次のポーリングは access_denied になります。SOC ツールが相関できるよう、OP はイベントを発行します。
  • rate_limit.exceeded:ライブラリは定数だけ定義してカタログの一貫性を保ちますが、内部経路から発火させはしません。

最後の 2 つは、ライブラリが運用側ミドルウェアと共有する語彙であって、内部イベントではありません。リバースプロキシやミドルウェアが枠を執行してリクエストを通した(あるいは拒否した)ときに、同じ監査ロガーへこれらを発行すれば、解析パイプラインが 1 本の一貫したストリームを観測できます。

推奨パターン

  1. リバースプロキシまたはエッジサービスでグローバルなレートを執行する — 例えば /token は IP 当たり 100 req/s、/par はもっと低めに。これが攻撃者にリクエストを「コスト」として支払わせる実機構です。
  2. 監査パイプラインがバーストにアラートを出す — 単一 IP・ASN・client_id から client_authn.failure が立て続けに来たとき。これは「誰かが OP を突いている」ことを示す S/N の高いイベントです。同じ送信元や client から pkce.violation と redirect_uri.mismatch が続く場合も、アラートの対象にします。
  3. クライアント単位の許可リストで攻撃面を上流で削る。 WithCORSOrigins も redirect_uris レジストリも許可リストとして働きます — 小さく保つほど、設定ミスや侵害されたクライアントが晒す攻撃面は減ります。

ライブラリが内部でロックアウトしている挙動 ​

汎用の IP 単位レート制限では塞げない 3 つの濫用経路だけは、ライブラリ側にロックアウトが組み込まれています — 攻撃者は IP を安価に切り替えられ、保護対象がエントロピーの低いコードや subject 単位の credential(任意の URL ではない)だからです:

  • ログインのブルートフォース(要素跨ぎ)。 ロックアウト用の store が組み込まれると(op.WithAuthnLockoutStore での明示、または AuthnLockouts() を持つ WithStore の値からの自動解決)、カウンタを使う組み込みの Step(PrimaryPassword、StepTOTP、StepEmailOTP、StepRecoveryCode)が同じ subject 単位カウンタを参照するので、攻撃者が要素を切り替えて推測予算を 2 倍にすることはできません。ストアは 24 時間のローリングウィンドウを持ち、累計 30 回の失敗で 1 時間、90 回で 24 時間ロックします。このカウンタは PrimaryPasskey と ExternalStep の要素には及びません。失敗した試行は、ロックを発動させた試行も含めて audit.LoginFailed または audit.MFAFailed、成功は audit.LoginSuccess または audit.MFASuccess になります。audit.LockoutEngaged は、失敗した試行によってロックが新たに成立したときに、subject を actor_id として 1 回だけ発火します。ロック中のパスワード試行は誤ったパスワードとまったく同じ応答になるため、応答からアカウントの存在は分からず、LoginAttemptObserver には op.AttemptLocked ではなく通常の失敗として見えます。ロックされたユーザと入力ミスを区別する手段は、この監査イベントです。audit.LockoutStalled は、compare-and-swap の競合で失敗試行がカウントされずに中断されたことを示します。同じ actor_id で出続ける場合、その subject は閾値に達することなく推測を続けられる状態です。
  • Device Code user_code の総当たり。 レコードに紐付く helper では op/devicecodekit が record ごとの strike カウンタを持ちます。最初の手入力画面で device_code が無い場合は、opaque で安定した key と共有 AttemptLimiter を使って VerifyUserCodeByAttemptKey を呼びます。ミスマッチごとに audit.DeviceCodeUserCodeBruteForce が発火し、レプリカごとに予算が分かれることを防げます。
  • CIBA poll abuse。 トークンエンドポイントは、単一の auth_req_id が間隔より速くポーリングされた回数を数えます。閾値に達すると、リクエストストアの Deny を reason="poll_abuse" で呼んで audit.CIBAPollAbuseLockout が発火し、以後のポーリングには access_denied が返ります。グローバルなレート制限で行儀の良い RP まで巻き添えにすることなく、病的な RP だけを止められます。

これらの防御はいずれも 専用の 監査イベントを発火します。rate_limit.exceeded / rate_limit.bypassed ではありません。

区分執行する側観測されるイベント
汎用 HTTP レート制限(IP 単位、エンドポイント単位、client_id 単位)組み込み側ミドルウェア(リバースプロキシ、ゲートウェイ、Go ハンドラチェーン)audit.RateLimitExceeded / audit.RateLimitBypassed — 組み込み側が OP の監査ロガーに発火させる
用途特化のブルートフォース防御(ログイン、user_code、ポーリング間隔)ライブラリ内部audit.LoginFailed / audit.MFAFailed / audit.LockoutEngaged、audit.DeviceCodeUserCodeBruteForce、audit.CIBAPollAbuseLockout

それ以外 — client_authn 失敗の継続や、PKCE / redirect_uri の拒否 — には組み込みの HTTP リミッタがありません。いずれも監査シグナルとして出るだけです。これは意図的な分担です。OP は所有するシグナルを発行する側、運用側はそれに対する応答(ブロック、スロットル、ページング)を決める側、という切り分けです。

ログ保持 ​

目安であり、実際の期間はコンプライアンス要件に置き換えてください。

系統典型保持期間
運用7 〜 30 日
auditコンプライアンス要件次第。典型的には 1 〜 7 年
メトリクス高解像度で 30 〜 90 日、その後はロールアップ

監査ログはロングテールでコストの掛かる系統です。保管はそれ用に分離して見積もってください。1 イベント自体は小さいですが、高負荷な OP では量が多くなります。