
# OpenID Connect

登録のスコープに `openid` があると、ログインは OpenID Connect のログインになります。プロバイダーはユーザーが誰かを示す ID トークンを返し、クライアントがそれをチェックします。ユーザーサービスは、ID トークンとユーザー情報エンドポイントからユーザー (`OAuth2User`、OpenID Connect では `OidcUser`) を読み込みます。

## 使う理由

アクセストークンはクライアントに何が許されるかを示しますが、ユーザーが誰かは示しません。ID トークンはそれを示しますが、厳格なチェックの後に限ります。別のアプリケーションに発行されたトークン、古いトークン、別のプロバイダーからのトークンで、ユーザーをログインさせてはいけません。バリデーターは、すべての ID トークンでそれらのチェックを行います。

## 例

```properties
spring.security.oauth2.client.registration.keycloak.client-id=neon-web
spring.security.oauth2.client.registration.keycloak.client-secret=${KEYCLOAK_SECRET}
spring.security.oauth2.client.registration.keycloak.scope=openid,profile,email
spring.security.oauth2.client.provider.keycloak.issuer-uri=https://login.example.com/realms/neon
```

```dart
// oauth2Login() を使うサーバーで: ログイン中のユーザー。
@GetMapping('/api/me')
Map<String, Object?> me(@AuthenticationPrincipal() OidcUser user) => {
      'sub': user.subject,
      'name': user.fullName,
      'email': user.emailVerified == true ? user.email : null,
    };
```

## ユーザー

| 型 | 内容 |
|---|---|
| `OAuth2User` | OAuth 2.0 のログインのユーザー: `attributes` (ユーザー情報の応答)、`authorities`、`name` (`user-name-attribute`)。 |
| `OidcUser` | OpenID Connect のユーザー: さらに `idToken`、`userInfo`、標準のクレーム。 |
| `DefaultOAuth2UserService` | ユーザー情報エンドポイントから `OAuth2User` を読み込む。 |
| `OidcUserService` | `OidcUser` を読み込む: ID トークン、次にユーザー情報。その `sub` は ID トークンのものと一致しなければならない。 |

`OidcUser` (と `OidcIdToken`) の標準のクレーム: `subject`、`fullName`、`givenName`、`familyName`、`middleName`、`nickName`、`preferredUsername`、`profile`、`picture`、`website`、`email`、`emailVerified`、`gender`、`birthdate`、`zoneInfo`、`locale`、`phoneNumber`、`phoneNumberVerified`、`address`、`updatedAt`。そして ID トークンのもの: `issuer`、`audience`、`expiresAt`、`issuedAt`、`authenticatedAt`、`nonce`、`authorizedParty`。

ユーザーは `subject` で保持し、メールアドレスでは決して保持しないでください。アドレスは持ち主が変わることがあり、別のプロバイダーは検証していないアドレスを送ることがあります。

## ID トークンのチェック

`OidcIdTokenValidator` は、OpenID Connect Core §3.1.3.7 のとおりに次をチェックします。

- `iss`、`sub`、`aud`、`exp`、`iat` が存在する。
- `iss` が登録の発行者と等しい (登録が発行者を持つ場合)。
- `aud` がクライアント ID を含む。
- オーディエンスが複数ある場合、`azp` が存在する。存在する場合、それはクライアント ID である。
- `exp` が過ぎておらず、`iat` が未来でない。それぞれ 60 秒のずれを許す。
- `nonce` が、ログインが送った値の SHA-256 ハッシュである。そのため、トークンを別のログインにリプレイすることはできない。

リフレッシュされた ID トークンは古いものと照合されます。同じ発行者と subject です (§12.2)。

## ID トークンのデコーダー

| デコーダー | チェック |
|---|---|
| `TokenEndpointOidcIdTokenDecoder` (スターターの Bean) | クレームはチェックするが、署名はチェックしない。トークンは TLS 越しにトークンエンドポイントから直接来るためで、これは OpenID Connect Core §3.1.3.7 が許している。それでも `alg: none` のトークンは拒否される。 |
| セキュリティスターターの `OidcIdTokenDecoderFactory` | サーバーではこれに置き換わる。Spring と同じく、プロバイダーの JWK Set で署名をチェックし、次にクレームをチェックする。 |
| `JwkSetOidcIdTokenDecoder` | トークンエンドポイントから来たのではない ID トークン、例えばデバイスのシートからの Apple のアイデンティティトークンのためのもの。 |

それ以外のルールには、独自の `OidcIdTokenDecoder` Bean を宣言してください。

### JwkSetOidcIdTokenDecoder

登録の JWK Set で署名をチェックします。デフォルトは RS256 で、求めに応じて ES256 も使います。`alg: none`、HS*、トークン内の鍵、弱い RSA 鍵は拒否されます。未知の `kid` は鍵を再取得させますが、1 分に一回までです (単調増加の時計で)。`typ` ヘッダーは `JWT` (大文字小文字を問わない)、空、またはないことが必要です。同じ鍵で署名された `logout+jwt`、`at+jwt`、`secevent+jwt` のトークンは拒否されます。その後、上記と同じくクレームをチェックします。

## 権限

ログインの権限は、`OIDC_USER` (または `OAUTH2_USER`) と、付与されたスコープの `SCOPE_*` です。`GrantedAuthoritiesMapper` Bean で独自のロールを追加できます ([シングルサインオン](../spring-boot-starter-security/oauth2-login.md) を参照)。

## Spring (Java) との対応

型は Spring Security のもので、ユーザーサービスは `Future` を返します。Spring の `OidcIdTokenDecoderFactory` は常に署名をチェックします。このパッケージのデフォルトは TLS を信頼し、サーバーではセキュリティスターターの Bean が署名をチェックします。ここで JWT の署名をチェックするのは `JwkSetOidcIdTokenDecoder` だけです。JOSE のコード全体はセキュリティスターターのものです。

## 関連項目

- [登録](registrations.md)
- [シングルサインオン](../spring-boot-starter-security/oauth2-login.md)
- [JWT リソースサーバー](../spring-boot-starter-security/jwt.md)
