Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8539d1bf5b | ||
|
|
3473875d9a | ||
|
|
f077e5038e | ||
|
|
e4eb7e54f7 | ||
|
|
bdde0feb86 | ||
|
|
3da8e609ae | ||
|
|
ed064473dc | ||
|
|
a84f7d50a1 | ||
|
|
98b07b4fdf | ||
|
|
98566a713d | ||
|
|
aeb783e592 | ||
|
|
3bbbaf5230 | ||
|
|
2ee4b2af1c | ||
|
|
030ae94be3 | ||
|
|
728e737dc8 | ||
|
|
e2fba41f56 | ||
|
|
998eada6f5 | ||
|
|
5ddb97d3a1 |
@@ -6,5 +6,19 @@ POSTGRES_DB=keycloak
|
|||||||
POSTGRES_USER=keycloak
|
POSTGRES_USER=keycloak
|
||||||
POSTGRES_PASSWORD=change-me-postgres-password
|
POSTGRES_PASSWORD=change-me-postgres-password
|
||||||
|
|
||||||
|
# Keycloak resolves these placeholders while importing the realm.
|
||||||
|
TOKEN_MEDIATING_CLIENT_SECRET=change-me-token-mediating-client-secret
|
||||||
|
BFF_CLIENT_SECRET=change-me-bff-client-secret
|
||||||
|
EDGE_PROXY_CLIENT_SECRET=change-me-edge-proxy-client-secret
|
||||||
|
MOCK_GOOGLE_BROKER_CLIENT_SECRET=change-me-mock-google-broker-client-secret
|
||||||
|
ADMIN_USER_PASSWORD=change-me-admin-user-password
|
||||||
|
REGULAR_USER_PASSWORD=change-me-regular-user-password
|
||||||
|
MOCK_GOOGLE_USER_PASSWORD=change-me-mock-google-user-password
|
||||||
|
|
||||||
|
# Optional real-Google profile. These are consumed only by
|
||||||
|
# scripts/configure-google-idp.sh and must never be committed with real values.
|
||||||
|
GOOGLE_CLIENT_ID=
|
||||||
|
GOOGLE_CLIENT_SECRET=
|
||||||
|
|
||||||
# Port 80 is the single-EC2 target. 8088 avoids common local port conflicts.
|
# Port 80 is the single-EC2 target. 8088 avoids common local port conflicts.
|
||||||
NGINX_PORT=8088
|
NGINX_PORT=8088
|
||||||
|
|||||||
@@ -5,3 +5,7 @@
|
|||||||
|
|
||||||
backend/target/
|
backend/target/
|
||||||
build/
|
build/
|
||||||
|
e2e/node_modules/
|
||||||
|
google-e2e/node_modules/
|
||||||
|
frontend/node_modules/
|
||||||
|
frontend/dist/
|
||||||
|
|||||||
@@ -1,5 +1,12 @@
|
|||||||
# Keycloak Authentication Patterns
|
# Keycloak Authentication Patterns
|
||||||
|
|
||||||
|
The 39-branch implementation registry is documented in
|
||||||
|
[`docs/keycloak-branch-index.md`](docs/keycloak-branch-index.md).
|
||||||
|
|
||||||
|
Google brokering has a credential-free local OIDC harness and an opt-in
|
||||||
|
real-Google profile described in
|
||||||
|
[`docs/google-idp-brokering.md`](docs/google-idp-brokering.md).
|
||||||
|
|
||||||
Keycloak을 중심으로 네 가지 브라우저 인증 통합 패턴을 같은 로컬
|
Keycloak을 중심으로 네 가지 브라우저 인증 통합 패턴을 같은 로컬
|
||||||
인프라에서 비교하는 학습 프로젝트입니다.
|
인프라에서 비교하는 학습 프로젝트입니다.
|
||||||
|
|
||||||
@@ -63,3 +70,36 @@ docker compose down -v && docker compose up --build -d
|
|||||||
`start-dev`와 로컬 HTTP 설정은 학습 전용입니다. 운영 환경에서는
|
`start-dev`와 로컬 HTTP 설정은 학습 전용입니다. 운영 환경에서는
|
||||||
optimized Keycloak image, HTTPS, 엄격한 hostname 및 외부 secret store를
|
optimized Keycloak image, HTTPS, 엄격한 hostname 및 외부 secret store를
|
||||||
사용해야 합니다.
|
사용해야 합니다.
|
||||||
|
|
||||||
|
## Realm baseline
|
||||||
|
|
||||||
|
`keycloak/import/keycloak-patterns-realm.json`은 시작 시 자동 import됩니다.
|
||||||
|
하나의 `keycloak-patterns` realm 안에서 패턴마다 client를 분리합니다.
|
||||||
|
|
||||||
|
| Client | 유형 | 패턴 |
|
||||||
|
|---|---|---|
|
||||||
|
| `spa-public` | public + PKCE S256 | AP1 |
|
||||||
|
| `token-mediating-confidential` | confidential | AP2 |
|
||||||
|
| `bff-confidential` | confidential | AP3 |
|
||||||
|
| `edge-proxy` | confidential | AP4 |
|
||||||
|
|
||||||
|
confidential client secret과 테스트 사용자 password는 JSON에 평문으로
|
||||||
|
저장하지 않습니다. JSON에는 `${ENVIRONMENT_VARIABLE}` placeholder만
|
||||||
|
커밋하고, Keycloak 26.7.0이 import 시 `.env` 값을 주입합니다.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python3 scripts/validate-realm.py
|
||||||
|
docker compose down -v
|
||||||
|
docker compose up -d --wait
|
||||||
|
./scripts/verify-realm.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
실행 중인 DB에서 CLI realm export를 재현하려면 다음 명령을 사용합니다.
|
||||||
|
Keycloak을 잠시 중지하고 export한 뒤 자동으로 다시 올립니다.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./scripts/export-realm.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
runtime export에는 실제 client secret과 credential hash가 포함될 수 있어
|
||||||
|
gitignored `build/keycloak-export/`에 권한 `0600`으로만 저장됩니다.
|
||||||
|
|||||||
@@ -0,0 +1,6 @@
|
|||||||
|
# Keycloak receives HTTP only from the trusted reverse proxy.
|
||||||
|
KC_HTTP_ENABLED=true
|
||||||
|
KC_PROXY_HEADERS=xforwarded
|
||||||
|
KC_HOSTNAME=https://auth.example.test
|
||||||
|
KC_HOSTNAME_STRICT=true
|
||||||
|
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
server {
|
||||||
|
listen 8080;
|
||||||
|
server_name auth.example.test;
|
||||||
|
|
||||||
|
location / {
|
||||||
|
proxy_pass http://keycloak:8080;
|
||||||
|
proxy_http_version 1.1;
|
||||||
|
proxy_set_header Host $host;
|
||||||
|
proxy_set_header X-Forwarded-Host $host;
|
||||||
|
proxy_set_header X-Forwarded-Port 443;
|
||||||
|
proxy_set_header X-Forwarded-Proto https;
|
||||||
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -35,6 +35,13 @@ services:
|
|||||||
KC_HEALTH_ENABLED: "true"
|
KC_HEALTH_ENABLED: "true"
|
||||||
KC_BOOTSTRAP_ADMIN_USERNAME: ${KC_BOOTSTRAP_ADMIN_USERNAME:?set KC_BOOTSTRAP_ADMIN_USERNAME in .env}
|
KC_BOOTSTRAP_ADMIN_USERNAME: ${KC_BOOTSTRAP_ADMIN_USERNAME:?set KC_BOOTSTRAP_ADMIN_USERNAME in .env}
|
||||||
KC_BOOTSTRAP_ADMIN_PASSWORD: ${KC_BOOTSTRAP_ADMIN_PASSWORD:?set KC_BOOTSTRAP_ADMIN_PASSWORD in .env}
|
KC_BOOTSTRAP_ADMIN_PASSWORD: ${KC_BOOTSTRAP_ADMIN_PASSWORD:?set KC_BOOTSTRAP_ADMIN_PASSWORD in .env}
|
||||||
|
TOKEN_MEDIATING_CLIENT_SECRET: ${TOKEN_MEDIATING_CLIENT_SECRET:?set TOKEN_MEDIATING_CLIENT_SECRET in .env}
|
||||||
|
BFF_CLIENT_SECRET: ${BFF_CLIENT_SECRET:?set BFF_CLIENT_SECRET in .env}
|
||||||
|
EDGE_PROXY_CLIENT_SECRET: ${EDGE_PROXY_CLIENT_SECRET:?set EDGE_PROXY_CLIENT_SECRET in .env}
|
||||||
|
MOCK_GOOGLE_BROKER_CLIENT_SECRET: ${MOCK_GOOGLE_BROKER_CLIENT_SECRET:?set MOCK_GOOGLE_BROKER_CLIENT_SECRET in .env}
|
||||||
|
ADMIN_USER_PASSWORD: ${ADMIN_USER_PASSWORD:?set ADMIN_USER_PASSWORD in .env}
|
||||||
|
REGULAR_USER_PASSWORD: ${REGULAR_USER_PASSWORD:?set REGULAR_USER_PASSWORD in .env}
|
||||||
|
MOCK_GOOGLE_USER_PASSWORD: ${MOCK_GOOGLE_USER_PASSWORD:?set MOCK_GOOGLE_USER_PASSWORD in .env}
|
||||||
ports:
|
ports:
|
||||||
- "127.0.0.1:8080:8080"
|
- "127.0.0.1:8080:8080"
|
||||||
volumes:
|
volumes:
|
||||||
|
|||||||
@@ -0,0 +1,18 @@
|
|||||||
|
# Federated account key: `sub`, not email
|
||||||
|
|
||||||
|
외부 IdP의 email은 표시·연락 속성이지 계정 식별자나 자동 연결 증명이 아니다.
|
||||||
|
Keycloak의 federated identity는 provider alias와 provider user ID(`sub`)를
|
||||||
|
로컬 사용자에 연결한다.
|
||||||
|
|
||||||
|
정책:
|
||||||
|
|
||||||
|
- 신규 identity의 email이 기존 로컬 계정과 충돌하면 기존 계정의 인증을 다시
|
||||||
|
요구하는 기본 First Broker Login flow를 사용한다.
|
||||||
|
- `Automatically Set Existing User`를 production flow에 넣지 않는다.
|
||||||
|
- upstream email 변경은 같은 `sub`의 계정 귀속을 바꾸지 않는다.
|
||||||
|
- 마지막 로그인 수단을 unlink하는 UI에서는 먼저 다른 인증 수단을 등록하도록
|
||||||
|
안내한다.
|
||||||
|
|
||||||
|
`verify-account-linking-sub-vs-email.sh`는 mock IdP 사용자의 email을 실제로
|
||||||
|
변경하고 다시 로그인한다. 로컬 사용자 ID가 유지되고 federated `userId`가
|
||||||
|
upstream `sub`와 같은지 확인한 후 원래 email을 복구한다.
|
||||||
@@ -0,0 +1,27 @@
|
|||||||
|
# First Broker Login security
|
||||||
|
|
||||||
|
Keycloak 26.7.0's built-in `first broker login` flow does **not** silently
|
||||||
|
auto-link by email. It contains:
|
||||||
|
|
||||||
|
- `Create User If Unique`
|
||||||
|
- `Handle Existing Account`
|
||||||
|
- `Confirm link existing account`
|
||||||
|
- email verification or re-authentication ownership proof
|
||||||
|
|
||||||
|
`Automatically set existing user` is an explicit, dangerous opt-in. The local
|
||||||
|
acceptance harness copies the built-in flow, enables AutoLink, disables the
|
||||||
|
ownership-proof branch, and signs in through a controllable OIDC account whose
|
||||||
|
email collides with `regular-user`. It verifies that the external identity is
|
||||||
|
attached without proof. The harness then assigns the original built-in flow,
|
||||||
|
repeats the login, observes the existing-account confirmation page, and verifies
|
||||||
|
that no federated identity was attached.
|
||||||
|
|
||||||
|
Run after the stack is healthy:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./scripts/verify-first-broker-login.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
The vulnerable flow remains only as a disabled learning artifact. The
|
||||||
|
`mock-google` provider is always returned to the secure built-in flow at the end
|
||||||
|
of the verification.
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
# Google claim and identity mapping
|
||||||
|
|
||||||
|
The broker uses the upstream OIDC `sub` as the stable federated identity key.
|
||||||
|
Email is a mutable profile attribute and is never the external identity key.
|
||||||
|
|
||||||
|
The default mapping policy is:
|
||||||
|
|
||||||
|
| Upstream claim | Keycloak target |
|
||||||
|
|---|---|
|
||||||
|
| `sub` | stable username `${ALIAS}.${CLAIM.sub}` and federated identity ID |
|
||||||
|
| `email` | email |
|
||||||
|
| `given_name` | first name |
|
||||||
|
| `family_name` | last name |
|
||||||
|
| `picture` | custom `picture` attribute |
|
||||||
|
| `hd` | custom `hd` attribute |
|
||||||
|
|
||||||
|
The Identity Provider uses `syncMode=IMPORT`: profile values are imported on
|
||||||
|
first login and later local edits are not overwritten on every login. `FORCE`
|
||||||
|
is an explicit alternative when upstream freshness is more important.
|
||||||
|
|
||||||
|
`./scripts/verify-google-claim-mapping.sh` signs in through the controllable
|
||||||
|
OIDC realm and verifies the resulting Keycloak user, custom attributes, stable
|
||||||
|
subject-derived username, and federated identity record.
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
# Google claim-to-role mapping
|
||||||
|
|
||||||
|
`hd=example.test`인 upstream OIDC identity에는 Keycloak realm role
|
||||||
|
`employee-role`을 부여한다. 매핑 키는 email이 아니라 Google subject이며,
|
||||||
|
role 조건에 쓰는 `hd` claim은 mock provider와 실제 Google provider에서 같은
|
||||||
|
계약을 사용한다.
|
||||||
|
|
||||||
|
Realm import는 `oidc-role-idp-mapper`를 선언한다. 실제 Google 설정 스크립트도
|
||||||
|
같은 mapper를 upsert한다. 따라서 재실행해도 mapper가 중복되지 않는다.
|
||||||
|
|
||||||
|
검증:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
./scripts/verify-google-claim-to-role.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
검증기는 mock Google 로그인, Authorization Code + PKCE 교환, 최종 Keycloak
|
||||||
|
access token의 `realm_access.roles`를 차례로 확인한다.
|
||||||
@@ -0,0 +1,28 @@
|
|||||||
|
# Google IdP brokering
|
||||||
|
|
||||||
|
Keycloak is the only issuer trusted by AP1–AP4. Google is an upstream Identity
|
||||||
|
Provider; applications do not receive or validate a Google token.
|
||||||
|
|
||||||
|
## Two verification profiles
|
||||||
|
|
||||||
|
The default local profile imports a second Keycloak realm named `mock-google`.
|
||||||
|
It acts as a controllable OIDC provider and allows tests to choose claims such
|
||||||
|
as a duplicate email, `email_verified=false`, `hd`, and `picture`. This is the
|
||||||
|
safe way to reproduce an unsafe email auto-link without impersonating a real
|
||||||
|
Google account.
|
||||||
|
|
||||||
|
The real-Google profile is configured explicitly:
|
||||||
|
|
||||||
|
1. Create a Google OAuth **Web application**.
|
||||||
|
2. Register the exact redirect URI printed by
|
||||||
|
`./scripts/configure-google-idp.sh`.
|
||||||
|
3. Put `GOOGLE_CLIENT_ID` and `GOOGLE_CLIENT_SECRET` in ignored `.env`.
|
||||||
|
4. Start the stack and run the configuration script.
|
||||||
|
|
||||||
|
The script writes `providerId=google`, `trustEmail=false`, minimal
|
||||||
|
`openid profile email` scopes, and `syncMode=IMPORT` through the Keycloak Admin
|
||||||
|
API. Credentials are never written to the realm export or repository.
|
||||||
|
|
||||||
|
Google requires a public HTTPS redirect for non-local deployments. Local mock
|
||||||
|
verification proves the Keycloak brokering boundary; a real Google login is a
|
||||||
|
separate credentialed acceptance profile.
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
# Google redirect URI policy
|
||||||
|
|
||||||
|
Google에 등록하는 redirect URI는 애플리케이션 SPA callback이 아니라 Keycloak
|
||||||
|
broker endpoint다.
|
||||||
|
|
||||||
|
```text
|
||||||
|
https://auth.example.test/realms/keycloak-patterns/broker/google/endpoint
|
||||||
|
```
|
||||||
|
|
||||||
|
규칙:
|
||||||
|
|
||||||
|
- production URI는 HTTPS와 고정된 public Keycloak origin을 사용한다.
|
||||||
|
- wildcard, path prefix, 임시 tunnel hostname을 production OAuth client에
|
||||||
|
등록하지 않는다.
|
||||||
|
- 개발·스테이징·운영은 Google OAuth client를 분리한다.
|
||||||
|
- reverse proxy가 있더라도 Google이 보는 URI와 Keycloak이 생성하는 URI가
|
||||||
|
byte-for-byte 같아야 한다.
|
||||||
|
- `configure-google-idp.sh`가 출력하는 URI를 Google Console의 Authorized
|
||||||
|
redirect URI와 대조한다.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
PUBLIC_KEYCLOAK_URL=https://auth.example.test \
|
||||||
|
./scripts/verify-google-redirect-uri-policy.sh
|
||||||
|
```
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
# Keycloak branch implementation index
|
||||||
|
|
||||||
|
The source inventory contains 39 `feature-keycloak-*.md` branch notes. This
|
||||||
|
repository preserves one local Git feature branch for every note and merges it
|
||||||
|
with `--no-ff` into either the common `develop` baseline or one of the four
|
||||||
|
authentication-pattern branches.
|
||||||
|
|
||||||
|
| Target | Meaning |
|
||||||
|
|---|---|
|
||||||
|
| `common` | Shared realm, federation, deployment, or governance contract. Merge into `develop`, then propagate to AP1–AP4. |
|
||||||
|
| `ap1` | Browser-based OAuth client: vanilla SPA, Authorization Code + PKCE, Resource Server. |
|
||||||
|
| `ap2` | Token-mediating confidential backend: browser receives access token only. |
|
||||||
|
| `ap3` | BFF: backend owns every OAuth token and browser owns only a session cookie. |
|
||||||
|
| `ap4` | Edge forward-auth: oauth2-proxy/Nginx owns login and backend trusts an isolated identity header. |
|
||||||
|
|
||||||
|
The machine-readable registry is
|
||||||
|
[`keycloak-branch-manifest.tsv`](keycloak-branch-manifest.tsv). Run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./scripts/audit-keycloak-branches.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
The audit succeeds only when all 39 note names have matching local feature
|
||||||
|
branches and each feature tip is reachable from its declared target branch.
|
||||||
|
|
||||||
|
Google credentials are never committed. The default local acceptance harness
|
||||||
|
uses a second Keycloak realm as a controllable OIDC provider so claim mapping
|
||||||
|
and unsafe-linking failure paths can be reproduced. A real Google login remains
|
||||||
|
an explicit credentialed/public-HTTPS verification profile.
|
||||||
@@ -0,0 +1,40 @@
|
|||||||
|
branch target delivery
|
||||||
|
feature/keycloak-account-linking-spa-ux ap1 documented-and-contract-tested
|
||||||
|
feature/keycloak-account-linking-sub-vs-email common documented-and-contract-tested
|
||||||
|
feature/keycloak-bff-csrf-samesite-defense ap3 locally-verified
|
||||||
|
feature/keycloak-bff-oauth2login-session ap3 locally-verified
|
||||||
|
feature/keycloak-bff-vs-spa-direct ap3 documented
|
||||||
|
feature/keycloak-docker-compose-stack common locally-verified
|
||||||
|
feature/keycloak-edge-forwardauth-google-federation ap4 documented-and-config-tested
|
||||||
|
feature/keycloak-edge-forwardauth-no-google ap4 documented-and-config-tested
|
||||||
|
feature/keycloak-federation-spa-zero-change ap1 contract-tested
|
||||||
|
feature/keycloak-first-broker-login-flow common locally-verified-with-mock-idp
|
||||||
|
feature/keycloak-four-pattern-tradeoff-matrix common documented-and-evidence-linked
|
||||||
|
feature/keycloak-google-claim-attribute-mapping common locally-verified-with-mock-idp
|
||||||
|
feature/keycloak-google-redirect-uri-policy common config-tested
|
||||||
|
feature/keycloak-header-spoofing-defense ap4 locally-verified
|
||||||
|
feature/keycloak-https-termination-caddy-nginx common config-tested
|
||||||
|
feature/keycloak-idp-brokering-google-client common locally-verified-with-mock-idp
|
||||||
|
feature/keycloak-idp-mappers-claim-to-role common locally-verified-with-mock-idp
|
||||||
|
feature/keycloak-internal-spa-direct-google-federation ap1 documented-and-contract-tested
|
||||||
|
feature/keycloak-internal-spa-direct-no-google ap1 documented-and-contract-tested
|
||||||
|
feature/keycloak-iss-claim-hostname-mismatch ap1 locally-verified
|
||||||
|
feature/keycloak-nginx-auth-request-integration ap4 locally-verified
|
||||||
|
feature/keycloak-oauth2-proxy-oidc-flow ap4 locally-verified
|
||||||
|
feature/keycloak-patterns common governance
|
||||||
|
feature/keycloak-pkce-flow-stages ap1 contract-tested
|
||||||
|
feature/keycloak-public-domain-tunneling common config-tested
|
||||||
|
feature/keycloak-realm-client-export common locally-verified
|
||||||
|
feature/keycloak-refresh-rotation-and-logout ap1 locally-verified
|
||||||
|
feature/keycloak-refresh-token-rotation ap1 contract-tested
|
||||||
|
feature/keycloak-reverse-proxy-headers common config-tested
|
||||||
|
feature/keycloak-single-ec2-google-federation ap1 documented-and-config-tested
|
||||||
|
feature/keycloak-single-ec2-no-google ap1 documented-and-contract-tested
|
||||||
|
feature/keycloak-spa-token-storage-tradeoff ap1 locally-verified
|
||||||
|
feature/keycloak-spring-rs-audience-validator ap1 locally-verified
|
||||||
|
feature/keycloak-spring-rs-role-mapping ap1 locally-verified
|
||||||
|
feature/keycloak-three-leg-trust-chain ap1 documented-and-contract-tested
|
||||||
|
feature/keycloak-token-mediating-access-handoff ap2 locally-verified
|
||||||
|
feature/keycloak-token-mediating-confidential-client ap2 locally-verified
|
||||||
|
feature/keycloak-traefik-forwardauth-alternative ap4 config-tested
|
||||||
|
feature/keycloak-vanilla-js-spa-pkce ap1 locally-verified
|
||||||
|
@@ -0,0 +1,15 @@
|
|||||||
|
# Reverse proxy headers
|
||||||
|
|
||||||
|
TLS를 reverse proxy에서 종료하면 Keycloak은 브라우저가 사용한 외부 origin을
|
||||||
|
정확히 알아야 한다. 배포 예제는 다음 계약을 함께 적용한다.
|
||||||
|
|
||||||
|
- nginx는 `Host`, `X-Forwarded-Host`, `X-Forwarded-Port`,
|
||||||
|
`X-Forwarded-Proto`, `X-Forwarded-For`를 덮어쓴다.
|
||||||
|
- Keycloak은 `KC_PROXY_HEADERS=xforwarded`로 그 헤더 형식을 명시한다.
|
||||||
|
- `KC_HOSTNAME`은 외부 HTTPS URL로 고정하고 strict hostname 검증을 켠다.
|
||||||
|
- Keycloak의 8080 포트는 public으로 publish하지 않고 proxy network에서만
|
||||||
|
접근시킨다. 신뢰되지 않은 클라이언트가 forwarded header를 직접 넣을 수
|
||||||
|
있으면 안 된다.
|
||||||
|
|
||||||
|
`scripts/verify-reverse-proxy-headers.sh`는 양쪽 설정의 짝과 nginx 구문을
|
||||||
|
검증한다.
|
||||||
@@ -0,0 +1,123 @@
|
|||||||
|
import assert from "node:assert/strict";
|
||||||
|
import { chromium } from "playwright-core";
|
||||||
|
|
||||||
|
const keycloakUrl = process.env.KEYCLOAK_URL ?? "http://localhost:8080";
|
||||||
|
const adminUsername = process.env.KC_BOOTSTRAP_ADMIN_USERNAME;
|
||||||
|
const adminPassword = process.env.KC_BOOTSTRAP_ADMIN_PASSWORD;
|
||||||
|
const mockPassword = process.env.MOCK_GOOGLE_USER_PASSWORD;
|
||||||
|
assert.ok(adminUsername && adminPassword && mockPassword);
|
||||||
|
|
||||||
|
async function adminToken() {
|
||||||
|
const response = await fetch(
|
||||||
|
`${keycloakUrl}/realms/master/protocol/openid-connect/token`,
|
||||||
|
{
|
||||||
|
method: "POST",
|
||||||
|
body: new URLSearchParams({
|
||||||
|
client_id: "admin-cli",
|
||||||
|
grant_type: "password",
|
||||||
|
username: adminUsername,
|
||||||
|
password: adminPassword,
|
||||||
|
}),
|
||||||
|
},
|
||||||
|
);
|
||||||
|
assert.equal(response.status, 200);
|
||||||
|
return (await response.json()).access_token;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function usersByEmail(token) {
|
||||||
|
const response = await fetch(
|
||||||
|
`${keycloakUrl}/admin/realms/keycloak-patterns/users?email=${encodeURIComponent(
|
||||||
|
"broker-new-user@example.test",
|
||||||
|
)}&exact=true`,
|
||||||
|
{ headers: { Authorization: `Bearer ${token}` } },
|
||||||
|
);
|
||||||
|
assert.equal(response.status, 200);
|
||||||
|
return response.json();
|
||||||
|
}
|
||||||
|
|
||||||
|
async function userById(token, userId) {
|
||||||
|
const response = await fetch(
|
||||||
|
`${keycloakUrl}/admin/realms/keycloak-patterns/users/${userId}`,
|
||||||
|
{ headers: { Authorization: `Bearer ${token}` } },
|
||||||
|
);
|
||||||
|
assert.equal(response.status, 200);
|
||||||
|
return response.json();
|
||||||
|
}
|
||||||
|
|
||||||
|
async function removePreviousUser(token) {
|
||||||
|
for (const user of await usersByEmail(token)) {
|
||||||
|
const response = await fetch(
|
||||||
|
`${keycloakUrl}/admin/realms/keycloak-patterns/users/${user.id}`,
|
||||||
|
{
|
||||||
|
method: "DELETE",
|
||||||
|
headers: { Authorization: `Bearer ${token}` },
|
||||||
|
},
|
||||||
|
);
|
||||||
|
assert.equal(response.status, 204);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function brokerLogin(page) {
|
||||||
|
const url = new URL(
|
||||||
|
`${keycloakUrl}/realms/keycloak-patterns/protocol/openid-connect/auth`,
|
||||||
|
);
|
||||||
|
url.search = new URLSearchParams({
|
||||||
|
client_id: "spa-public",
|
||||||
|
redirect_uri: "http://localhost:8088/",
|
||||||
|
response_type: "code",
|
||||||
|
scope: "openid profile email",
|
||||||
|
state: crypto.randomUUID(),
|
||||||
|
nonce: crypto.randomUUID(),
|
||||||
|
code_challenge: "K2qUEfBl-nQvF2gB4dNxC2zYVwZc1CVnZb5CsX2L7fI",
|
||||||
|
code_challenge_method: "S256",
|
||||||
|
kc_idp_hint: "mock-google",
|
||||||
|
prompt: "login",
|
||||||
|
});
|
||||||
|
await page.goto(url.toString());
|
||||||
|
await page.waitForURL(/\/realms\/mock-google\//u);
|
||||||
|
await page.locator("#username").fill("mock-new-user");
|
||||||
|
await page.locator("#password").fill(mockPassword);
|
||||||
|
await page.locator("#kc-login").click();
|
||||||
|
await page.waitForURL(/localhost:8088\/\?.*code=/u);
|
||||||
|
}
|
||||||
|
|
||||||
|
const token = await adminToken();
|
||||||
|
await removePreviousUser(token);
|
||||||
|
|
||||||
|
const browser = await chromium.launch({
|
||||||
|
executablePath: process.env.CHROME_BIN ?? "/usr/bin/google-chrome",
|
||||||
|
headless: true,
|
||||||
|
args: ["--no-sandbox"],
|
||||||
|
});
|
||||||
|
|
||||||
|
try {
|
||||||
|
const page = await browser.newPage();
|
||||||
|
await brokerLogin(page);
|
||||||
|
|
||||||
|
const users = await usersByEmail(token);
|
||||||
|
assert.equal(users.length, 1);
|
||||||
|
const user = await userById(token, users[0].id);
|
||||||
|
assert.match(user.username, /^mock-google\.[0-9a-f-]+$/u);
|
||||||
|
assert.equal(user.firstName, "Broker");
|
||||||
|
assert.equal(user.lastName, "New");
|
||||||
|
assert.deepEqual(user.attributes.picture, [
|
||||||
|
"https://images.example.test/mock-user.png",
|
||||||
|
]);
|
||||||
|
assert.deepEqual(user.attributes.hd, ["example.test"]);
|
||||||
|
|
||||||
|
const identitiesResponse = await fetch(
|
||||||
|
`${keycloakUrl}/admin/realms/keycloak-patterns/users/${user.id}/federated-identity`,
|
||||||
|
{ headers: { Authorization: `Bearer ${token}` } },
|
||||||
|
);
|
||||||
|
assert.equal(identitiesResponse.status, 200);
|
||||||
|
const identities = await identitiesResponse.json();
|
||||||
|
assert.equal(identities.length, 1);
|
||||||
|
assert.equal(identities[0].identityProvider, "mock-google");
|
||||||
|
assert.ok(identities[0].userId);
|
||||||
|
|
||||||
|
console.log(
|
||||||
|
"Google claim mapping verified: stable sub username, profile attributes, federated identity",
|
||||||
|
);
|
||||||
|
} finally {
|
||||||
|
await browser.close();
|
||||||
|
}
|
||||||
@@ -0,0 +1,68 @@
|
|||||||
|
import assert from "node:assert/strict";
|
||||||
|
import { createHash, randomBytes } from "node:crypto";
|
||||||
|
import { chromium } from "playwright-core";
|
||||||
|
|
||||||
|
const keycloakUrl = process.env.KEYCLOAK_URL ?? "http://localhost:8080";
|
||||||
|
const password = process.env.MOCK_GOOGLE_USER_PASSWORD;
|
||||||
|
assert.ok(password);
|
||||||
|
|
||||||
|
const verifier = randomBytes(48).toString("base64url");
|
||||||
|
const challenge = createHash("sha256").update(verifier).digest("base64url");
|
||||||
|
const redirectUri = "http://localhost:8088/";
|
||||||
|
|
||||||
|
const browser = await chromium.launch({
|
||||||
|
executablePath: process.env.CHROME_BIN ?? "/usr/bin/google-chrome",
|
||||||
|
headless: true,
|
||||||
|
args: ["--no-sandbox"],
|
||||||
|
});
|
||||||
|
|
||||||
|
try {
|
||||||
|
const page = await browser.newPage();
|
||||||
|
const authorizationUrl = new URL(
|
||||||
|
`${keycloakUrl}/realms/keycloak-patterns/protocol/openid-connect/auth`,
|
||||||
|
);
|
||||||
|
authorizationUrl.search = new URLSearchParams({
|
||||||
|
client_id: "spa-public",
|
||||||
|
redirect_uri: redirectUri,
|
||||||
|
response_type: "code",
|
||||||
|
scope: "openid profile email",
|
||||||
|
state: crypto.randomUUID(),
|
||||||
|
nonce: crypto.randomUUID(),
|
||||||
|
code_challenge: challenge,
|
||||||
|
code_challenge_method: "S256",
|
||||||
|
kc_idp_hint: "mock-google",
|
||||||
|
prompt: "login",
|
||||||
|
});
|
||||||
|
|
||||||
|
await page.goto(authorizationUrl.toString());
|
||||||
|
await page.waitForURL(/\/realms\/mock-google\//u);
|
||||||
|
await page.locator("#username").fill("mock-new-user");
|
||||||
|
await page.locator("#password").fill(password);
|
||||||
|
await page.locator("#kc-login").click();
|
||||||
|
await page.waitForURL(/localhost:8088\/\?.*code=/u);
|
||||||
|
|
||||||
|
const code = new URL(page.url()).searchParams.get("code");
|
||||||
|
assert.ok(code);
|
||||||
|
const response = await fetch(
|
||||||
|
`${keycloakUrl}/realms/keycloak-patterns/protocol/openid-connect/token`,
|
||||||
|
{
|
||||||
|
method: "POST",
|
||||||
|
body: new URLSearchParams({
|
||||||
|
grant_type: "authorization_code",
|
||||||
|
client_id: "spa-public",
|
||||||
|
redirect_uri: redirectUri,
|
||||||
|
code,
|
||||||
|
code_verifier: verifier,
|
||||||
|
}),
|
||||||
|
},
|
||||||
|
);
|
||||||
|
assert.equal(response.status, 200);
|
||||||
|
const tokens = await response.json();
|
||||||
|
const payload = JSON.parse(
|
||||||
|
Buffer.from(tokens.access_token.split(".")[1], "base64url").toString(),
|
||||||
|
);
|
||||||
|
assert.ok(payload.realm_access.roles.includes("employee-role"));
|
||||||
|
console.log("Claim-to-role verified: hd=example.test -> employee-role");
|
||||||
|
} finally {
|
||||||
|
await browser.close();
|
||||||
|
}
|
||||||
@@ -0,0 +1,124 @@
|
|||||||
|
import assert from "node:assert/strict";
|
||||||
|
import { chromium } from "playwright-core";
|
||||||
|
|
||||||
|
const expectation = process.env.FIRST_BROKER_EXPECTATION;
|
||||||
|
assert.ok(
|
||||||
|
expectation === "vulnerable" || expectation === "secure",
|
||||||
|
"FIRST_BROKER_EXPECTATION must be vulnerable or secure",
|
||||||
|
);
|
||||||
|
|
||||||
|
const keycloakUrl = process.env.KEYCLOAK_URL ?? "http://localhost:8080";
|
||||||
|
const adminUsername = process.env.KC_BOOTSTRAP_ADMIN_USERNAME;
|
||||||
|
const adminPassword = process.env.KC_BOOTSTRAP_ADMIN_PASSWORD;
|
||||||
|
const mockPassword = process.env.MOCK_GOOGLE_USER_PASSWORD;
|
||||||
|
assert.ok(adminUsername && adminPassword && mockPassword);
|
||||||
|
|
||||||
|
async function adminToken() {
|
||||||
|
const body = new URLSearchParams({
|
||||||
|
client_id: "admin-cli",
|
||||||
|
grant_type: "password",
|
||||||
|
username: adminUsername,
|
||||||
|
password: adminPassword,
|
||||||
|
});
|
||||||
|
const response = await fetch(
|
||||||
|
`${keycloakUrl}/realms/master/protocol/openid-connect/token`,
|
||||||
|
{ method: "POST", body },
|
||||||
|
);
|
||||||
|
assert.equal(response.status, 200);
|
||||||
|
return (await response.json()).access_token;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function regularUser(token) {
|
||||||
|
const response = await fetch(
|
||||||
|
`${keycloakUrl}/admin/realms/keycloak-patterns/users?username=regular-user&exact=true`,
|
||||||
|
{ headers: { Authorization: `Bearer ${token}` } },
|
||||||
|
);
|
||||||
|
assert.equal(response.status, 200);
|
||||||
|
const users = await response.json();
|
||||||
|
assert.equal(users.length, 1);
|
||||||
|
return users[0];
|
||||||
|
}
|
||||||
|
|
||||||
|
async function federatedIdentities(token, userId) {
|
||||||
|
const response = await fetch(
|
||||||
|
`${keycloakUrl}/admin/realms/keycloak-patterns/users/${userId}/federated-identity`,
|
||||||
|
{ headers: { Authorization: `Bearer ${token}` } },
|
||||||
|
);
|
||||||
|
assert.equal(response.status, 200);
|
||||||
|
return response.json();
|
||||||
|
}
|
||||||
|
|
||||||
|
async function removeMockLink(token, userId) {
|
||||||
|
const identities = await federatedIdentities(token, userId);
|
||||||
|
if (identities.some(({ identityProvider }) => identityProvider === "mock-google")) {
|
||||||
|
const response = await fetch(
|
||||||
|
`${keycloakUrl}/admin/realms/keycloak-patterns/users/${userId}/federated-identity/mock-google`,
|
||||||
|
{
|
||||||
|
method: "DELETE",
|
||||||
|
headers: { Authorization: `Bearer ${token}` },
|
||||||
|
},
|
||||||
|
);
|
||||||
|
assert.equal(response.status, 204);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const token = await adminToken();
|
||||||
|
const user = await regularUser(token);
|
||||||
|
await removeMockLink(token, user.id);
|
||||||
|
|
||||||
|
const browser = await chromium.launch({
|
||||||
|
executablePath: process.env.CHROME_BIN ?? "/usr/bin/google-chrome",
|
||||||
|
headless: true,
|
||||||
|
args: ["--no-sandbox"],
|
||||||
|
});
|
||||||
|
|
||||||
|
try {
|
||||||
|
const context = await browser.newContext();
|
||||||
|
const page = await context.newPage();
|
||||||
|
const authorizationUrl = new URL(
|
||||||
|
`${keycloakUrl}/realms/keycloak-patterns/protocol/openid-connect/auth`,
|
||||||
|
);
|
||||||
|
authorizationUrl.search = new URLSearchParams({
|
||||||
|
client_id: "spa-public",
|
||||||
|
redirect_uri: "http://localhost:8088/",
|
||||||
|
response_type: "code",
|
||||||
|
scope: "openid profile email",
|
||||||
|
state: `first-broker-${expectation}`,
|
||||||
|
nonce: `nonce-${expectation}`,
|
||||||
|
code_challenge: "K2qUEfBl-nQvF2gB4dNxC2zYVwZc1CVnZb5CsX2L7fI",
|
||||||
|
code_challenge_method: "S256",
|
||||||
|
kc_idp_hint: "mock-google",
|
||||||
|
});
|
||||||
|
|
||||||
|
await page.goto(authorizationUrl.toString());
|
||||||
|
await page.waitForURL(/\/realms\/mock-google\//u);
|
||||||
|
await page.locator("#username").fill("mock-collision-user");
|
||||||
|
await page.locator("#password").fill(mockPassword);
|
||||||
|
await page.locator("#kc-login").click();
|
||||||
|
await page.waitForLoadState("domcontentloaded");
|
||||||
|
|
||||||
|
if (expectation === "vulnerable") {
|
||||||
|
await page.waitForURL(/localhost:8088\/\?.*code=/u);
|
||||||
|
const identities = await federatedIdentities(token, user.id);
|
||||||
|
assert.equal(
|
||||||
|
identities.some(({ identityProvider }) => identityProvider === "mock-google"),
|
||||||
|
true,
|
||||||
|
"unsafe AutoLink should attach the attacker-controlled identity",
|
||||||
|
);
|
||||||
|
await removeMockLink(token, user.id);
|
||||||
|
} else {
|
||||||
|
assert.match(page.url(), /\/realms\/keycloak-patterns\//u);
|
||||||
|
const body = (await page.locator("body").innerText()).toLowerCase();
|
||||||
|
assert.match(body, /account already exists|link existing account|existing account/u);
|
||||||
|
const identities = await federatedIdentities(token, user.id);
|
||||||
|
assert.equal(
|
||||||
|
identities.some(({ identityProvider }) => identityProvider === "mock-google"),
|
||||||
|
false,
|
||||||
|
"Confirm Link must not attach the identity without ownership proof",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log(`first broker login ${expectation} case verified`);
|
||||||
|
} finally {
|
||||||
|
await browser.close();
|
||||||
|
}
|
||||||
Generated
+27
@@ -0,0 +1,27 @@
|
|||||||
|
{
|
||||||
|
"name": "keycloak-google-broker-e2e",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"lockfileVersion": 3,
|
||||||
|
"requires": true,
|
||||||
|
"packages": {
|
||||||
|
"": {
|
||||||
|
"name": "keycloak-google-broker-e2e",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"dependencies": {
|
||||||
|
"playwright-core": "1.55.1"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/playwright-core": {
|
||||||
|
"version": "1.55.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.55.1.tgz",
|
||||||
|
"integrity": "sha512-Z6Mh9mkwX+zxSlHqdr5AOcJnfp+xUWLCt9uKV18fhzA8eyxUd8NUWzAjxUh55RZKSYwDGX0cfaySdhZJGMoJ+w==",
|
||||||
|
"license": "Apache-2.0",
|
||||||
|
"bin": {
|
||||||
|
"playwright-core": "cli.js"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=18"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,15 @@
|
|||||||
|
{
|
||||||
|
"name": "keycloak-google-broker-e2e",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"private": true,
|
||||||
|
"type": "module",
|
||||||
|
"scripts": {
|
||||||
|
"test:first-broker": "node first-broker-login.mjs",
|
||||||
|
"test:claim-mapping": "node claim-mapping.mjs",
|
||||||
|
"test:claim-to-role": "node claim-to-role.mjs",
|
||||||
|
"test:sub-vs-email": "node sub-vs-email.mjs"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"playwright-core": "1.55.1"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,132 @@
|
|||||||
|
import assert from "node:assert/strict";
|
||||||
|
import { chromium } from "playwright-core";
|
||||||
|
|
||||||
|
const baseUrl = process.env.KEYCLOAK_URL ?? "http://localhost:8080";
|
||||||
|
const adminUsername = process.env.KC_BOOTSTRAP_ADMIN_USERNAME;
|
||||||
|
const adminPassword = process.env.KC_BOOTSTRAP_ADMIN_PASSWORD;
|
||||||
|
const mockPassword = process.env.MOCK_GOOGLE_USER_PASSWORD;
|
||||||
|
assert.ok(adminUsername && adminPassword && mockPassword);
|
||||||
|
|
||||||
|
async function adminToken() {
|
||||||
|
const response = await fetch(
|
||||||
|
`${baseUrl}/realms/master/protocol/openid-connect/token`,
|
||||||
|
{
|
||||||
|
method: "POST",
|
||||||
|
body: new URLSearchParams({
|
||||||
|
client_id: "admin-cli",
|
||||||
|
grant_type: "password",
|
||||||
|
username: adminUsername,
|
||||||
|
password: adminPassword,
|
||||||
|
}),
|
||||||
|
},
|
||||||
|
);
|
||||||
|
assert.equal(response.status, 200);
|
||||||
|
return (await response.json()).access_token;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function adminJson(token, path, init = {}) {
|
||||||
|
const response = await fetch(`${baseUrl}/admin/realms/${path}`, {
|
||||||
|
...init,
|
||||||
|
headers: {
|
||||||
|
Authorization: `Bearer ${token}`,
|
||||||
|
...(init.body ? { "Content-Type": "application/json" } : {}),
|
||||||
|
},
|
||||||
|
});
|
||||||
|
assert.ok(response.ok, `${init.method ?? "GET"} ${path}: ${response.status}`);
|
||||||
|
return response.status === 204 ? undefined : response.json();
|
||||||
|
}
|
||||||
|
|
||||||
|
async function users(token, realm, query) {
|
||||||
|
return adminJson(token, `${realm}/users?${new URLSearchParams(query)}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function brokerLogin(browser) {
|
||||||
|
const page = await browser.newPage();
|
||||||
|
const url = new URL(
|
||||||
|
`${baseUrl}/realms/keycloak-patterns/protocol/openid-connect/auth`,
|
||||||
|
);
|
||||||
|
url.search = new URLSearchParams({
|
||||||
|
client_id: "spa-public",
|
||||||
|
redirect_uri: "http://localhost:8088/",
|
||||||
|
response_type: "code",
|
||||||
|
scope: "openid profile email",
|
||||||
|
state: crypto.randomUUID(),
|
||||||
|
nonce: crypto.randomUUID(),
|
||||||
|
code_challenge: "K2qUEfBl-nQvF2gB4dNxC2zYVwZc1CVnZb5CsX2L7fI",
|
||||||
|
code_challenge_method: "S256",
|
||||||
|
kc_idp_hint: "mock-google",
|
||||||
|
prompt: "login",
|
||||||
|
});
|
||||||
|
await page.goto(url.toString());
|
||||||
|
await page.waitForURL(/\/realms\/mock-google\//u);
|
||||||
|
await page.locator("#username").fill("mock-new-user");
|
||||||
|
await page.locator("#password").fill(mockPassword);
|
||||||
|
await page.locator("#kc-login").click();
|
||||||
|
await page.waitForURL(/localhost:8088\/\?.*code=/u);
|
||||||
|
await page.close();
|
||||||
|
}
|
||||||
|
|
||||||
|
const token = await adminToken();
|
||||||
|
const mockUsers = await users(token, "mock-google", {
|
||||||
|
username: "mock-new-user",
|
||||||
|
exact: "true",
|
||||||
|
});
|
||||||
|
assert.equal(mockUsers.length, 1);
|
||||||
|
const mockUser = await adminJson(
|
||||||
|
token,
|
||||||
|
`mock-google/users/${mockUsers[0].id}`,
|
||||||
|
);
|
||||||
|
const originalEmail = mockUser.email;
|
||||||
|
const changedEmail = "broker-renamed-user@example.test";
|
||||||
|
|
||||||
|
for (const existing of await users(token, "keycloak-patterns", {
|
||||||
|
username: `mock-google.${mockUser.id}`,
|
||||||
|
exact: "true",
|
||||||
|
})) {
|
||||||
|
await adminJson(token, `keycloak-patterns/users/${existing.id}`, {
|
||||||
|
method: "DELETE",
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
const browser = await chromium.launch({
|
||||||
|
executablePath: process.env.CHROME_BIN ?? "/usr/bin/google-chrome",
|
||||||
|
headless: true,
|
||||||
|
args: ["--no-sandbox"],
|
||||||
|
});
|
||||||
|
|
||||||
|
try {
|
||||||
|
await brokerLogin(browser);
|
||||||
|
const before = await users(token, "keycloak-patterns", {
|
||||||
|
username: `mock-google.${mockUser.id}`,
|
||||||
|
exact: "true",
|
||||||
|
});
|
||||||
|
assert.equal(before.length, 1);
|
||||||
|
const localUserId = before[0].id;
|
||||||
|
const identities = await adminJson(
|
||||||
|
token,
|
||||||
|
`keycloak-patterns/users/${localUserId}/federated-identity`,
|
||||||
|
);
|
||||||
|
assert.equal(identities[0].userId, mockUser.id);
|
||||||
|
|
||||||
|
await adminJson(token, `mock-google/users/${mockUser.id}`, {
|
||||||
|
method: "PUT",
|
||||||
|
body: JSON.stringify({ ...mockUser, email: changedEmail }),
|
||||||
|
});
|
||||||
|
await brokerLogin(browser);
|
||||||
|
|
||||||
|
const after = await users(token, "keycloak-patterns", {
|
||||||
|
username: `mock-google.${mockUser.id}`,
|
||||||
|
exact: "true",
|
||||||
|
});
|
||||||
|
assert.equal(after.length, 1);
|
||||||
|
assert.equal(after[0].id, localUserId);
|
||||||
|
console.log(
|
||||||
|
"Federated identity verified: provider sub stayed linked while upstream email changed",
|
||||||
|
);
|
||||||
|
} finally {
|
||||||
|
await adminJson(token, `mock-google/users/${mockUser.id}`, {
|
||||||
|
method: "PUT",
|
||||||
|
body: JSON.stringify({ ...mockUser, email: originalEmail }),
|
||||||
|
});
|
||||||
|
await browser.close();
|
||||||
|
}
|
||||||
@@ -0,0 +1,271 @@
|
|||||||
|
{
|
||||||
|
"realm": "keycloak-patterns",
|
||||||
|
"displayName": "Keycloak Authentication Patterns",
|
||||||
|
"enabled": true,
|
||||||
|
"sslRequired": "external",
|
||||||
|
"registrationAllowed": false,
|
||||||
|
"resetPasswordAllowed": false,
|
||||||
|
"editUsernameAllowed": false,
|
||||||
|
"loginWithEmailAllowed": true,
|
||||||
|
"duplicateEmailsAllowed": false,
|
||||||
|
"bruteForceProtected": true,
|
||||||
|
"accessTokenLifespan": 300,
|
||||||
|
"ssoSessionIdleTimeout": 1800,
|
||||||
|
"ssoSessionMaxLifespan": 36000,
|
||||||
|
"offlineSessionIdleTimeout": 2592000,
|
||||||
|
"revokeRefreshToken": true,
|
||||||
|
"refreshTokenMaxReuse": 0,
|
||||||
|
"roles": {
|
||||||
|
"realm": [
|
||||||
|
{
|
||||||
|
"name": "admin-role",
|
||||||
|
"description": "Administrative role used by authorization examples"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "user-role",
|
||||||
|
"description": "Regular authenticated user role"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "employee-role",
|
||||||
|
"description": "Assigned to brokered identities whose hosted-domain claim is example.test"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"clients": [
|
||||||
|
{
|
||||||
|
"clientId": "spa-public",
|
||||||
|
"name": "AP1 SPA Public Client",
|
||||||
|
"description": "Browser-based OAuth client using Authorization Code and PKCE",
|
||||||
|
"enabled": true,
|
||||||
|
"protocol": "openid-connect",
|
||||||
|
"publicClient": true,
|
||||||
|
"standardFlowEnabled": true,
|
||||||
|
"implicitFlowEnabled": false,
|
||||||
|
"directAccessGrantsEnabled": false,
|
||||||
|
"serviceAccountsEnabled": false,
|
||||||
|
"frontchannelLogout": true,
|
||||||
|
"redirectUris": [
|
||||||
|
"http://localhost:8088/*",
|
||||||
|
"http://127.0.0.1:8088/*"
|
||||||
|
],
|
||||||
|
"webOrigins": [
|
||||||
|
"http://localhost:8088",
|
||||||
|
"http://127.0.0.1:8088"
|
||||||
|
],
|
||||||
|
"attributes": {
|
||||||
|
"pkce.code.challenge.method": "S256",
|
||||||
|
"post.logout.redirect.uris": "http://localhost:8088/*##http://127.0.0.1:8088/*"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"clientId": "token-mediating-confidential",
|
||||||
|
"name": "AP2 Token-Mediating Backend",
|
||||||
|
"description": "Confidential backend that keeps refresh tokens server-side",
|
||||||
|
"enabled": true,
|
||||||
|
"protocol": "openid-connect",
|
||||||
|
"publicClient": false,
|
||||||
|
"clientAuthenticatorType": "client-secret",
|
||||||
|
"secret": "${TOKEN_MEDIATING_CLIENT_SECRET}",
|
||||||
|
"standardFlowEnabled": true,
|
||||||
|
"implicitFlowEnabled": false,
|
||||||
|
"directAccessGrantsEnabled": false,
|
||||||
|
"serviceAccountsEnabled": false,
|
||||||
|
"frontchannelLogout": true,
|
||||||
|
"redirectUris": [
|
||||||
|
"http://localhost:8082/login/oauth2/code/keycloak"
|
||||||
|
],
|
||||||
|
"webOrigins": [
|
||||||
|
"http://localhost:8082"
|
||||||
|
],
|
||||||
|
"attributes": {
|
||||||
|
"post.logout.redirect.uris": "http://localhost:8082/*"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"clientId": "bff-confidential",
|
||||||
|
"name": "AP3 Backend-for-Frontend",
|
||||||
|
"description": "Confidential BFF that keeps all OAuth tokens server-side",
|
||||||
|
"enabled": true,
|
||||||
|
"protocol": "openid-connect",
|
||||||
|
"publicClient": false,
|
||||||
|
"clientAuthenticatorType": "client-secret",
|
||||||
|
"secret": "${BFF_CLIENT_SECRET}",
|
||||||
|
"standardFlowEnabled": true,
|
||||||
|
"implicitFlowEnabled": false,
|
||||||
|
"directAccessGrantsEnabled": false,
|
||||||
|
"serviceAccountsEnabled": false,
|
||||||
|
"frontchannelLogout": true,
|
||||||
|
"redirectUris": [
|
||||||
|
"http://localhost:8083/login/oauth2/code/keycloak"
|
||||||
|
],
|
||||||
|
"webOrigins": [
|
||||||
|
"http://localhost:8083"
|
||||||
|
],
|
||||||
|
"attributes": {
|
||||||
|
"post.logout.redirect.uris": "http://localhost:8083/*"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"clientId": "edge-proxy",
|
||||||
|
"name": "AP4 Edge Forward Auth",
|
||||||
|
"description": "Confidential oauth2-proxy OIDC client",
|
||||||
|
"enabled": true,
|
||||||
|
"protocol": "openid-connect",
|
||||||
|
"publicClient": false,
|
||||||
|
"clientAuthenticatorType": "client-secret",
|
||||||
|
"secret": "${EDGE_PROXY_CLIENT_SECRET}",
|
||||||
|
"standardFlowEnabled": true,
|
||||||
|
"implicitFlowEnabled": false,
|
||||||
|
"directAccessGrantsEnabled": false,
|
||||||
|
"serviceAccountsEnabled": false,
|
||||||
|
"frontchannelLogout": true,
|
||||||
|
"redirectUris": [
|
||||||
|
"http://localhost:4180/oauth2/callback"
|
||||||
|
],
|
||||||
|
"webOrigins": [],
|
||||||
|
"attributes": {
|
||||||
|
"post.logout.redirect.uris": "http://localhost:8088/*"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"identityProviders": [
|
||||||
|
{
|
||||||
|
"alias": "mock-google",
|
||||||
|
"displayName": "Mock Google (local verification)",
|
||||||
|
"providerId": "oidc",
|
||||||
|
"enabled": true,
|
||||||
|
"updateProfileFirstLoginMode": "off",
|
||||||
|
"trustEmail": false,
|
||||||
|
"storeToken": false,
|
||||||
|
"addReadTokenRoleOnCreate": false,
|
||||||
|
"authenticateByDefault": false,
|
||||||
|
"linkOnly": false,
|
||||||
|
"firstBrokerLoginFlowAlias": "first broker login",
|
||||||
|
"config": {
|
||||||
|
"clientId": "mock-google-broker",
|
||||||
|
"clientSecret": "${MOCK_GOOGLE_BROKER_CLIENT_SECRET}",
|
||||||
|
"authorizationUrl": "http://localhost:8080/realms/mock-google/protocol/openid-connect/auth",
|
||||||
|
"tokenUrl": "http://keycloak:8080/realms/mock-google/protocol/openid-connect/token",
|
||||||
|
"userInfoUrl": "http://keycloak:8080/realms/mock-google/protocol/openid-connect/userinfo",
|
||||||
|
"issuer": "http://localhost:8080/realms/mock-google",
|
||||||
|
"jwksUrl": "http://keycloak:8080/realms/mock-google/protocol/openid-connect/certs",
|
||||||
|
"useJwksUrl": "true",
|
||||||
|
"validateSignature": "true",
|
||||||
|
"defaultScope": "openid profile email",
|
||||||
|
"syncMode": "IMPORT",
|
||||||
|
"pkceEnabled": "true",
|
||||||
|
"pkceMethod": "S256"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"identityProviderMappers": [
|
||||||
|
{
|
||||||
|
"name": "mock-google-stable-username",
|
||||||
|
"identityProviderAlias": "mock-google",
|
||||||
|
"identityProviderMapper": "oidc-username-idp-mapper",
|
||||||
|
"config": {
|
||||||
|
"template": "${ALIAS}.${CLAIM.sub}",
|
||||||
|
"target": "LOCAL"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "mock-google-email",
|
||||||
|
"identityProviderAlias": "mock-google",
|
||||||
|
"identityProviderMapper": "oidc-user-attribute-idp-mapper",
|
||||||
|
"config": {
|
||||||
|
"syncMode": "INHERIT",
|
||||||
|
"claim": "email",
|
||||||
|
"user.attribute": "email"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "mock-google-given-name",
|
||||||
|
"identityProviderAlias": "mock-google",
|
||||||
|
"identityProviderMapper": "oidc-user-attribute-idp-mapper",
|
||||||
|
"config": {
|
||||||
|
"syncMode": "INHERIT",
|
||||||
|
"claim": "given_name",
|
||||||
|
"user.attribute": "firstName"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "mock-google-family-name",
|
||||||
|
"identityProviderAlias": "mock-google",
|
||||||
|
"identityProviderMapper": "oidc-user-attribute-idp-mapper",
|
||||||
|
"config": {
|
||||||
|
"syncMode": "INHERIT",
|
||||||
|
"claim": "family_name",
|
||||||
|
"user.attribute": "lastName"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "mock-google-picture",
|
||||||
|
"identityProviderAlias": "mock-google",
|
||||||
|
"identityProviderMapper": "oidc-user-attribute-idp-mapper",
|
||||||
|
"config": {
|
||||||
|
"syncMode": "INHERIT",
|
||||||
|
"claim": "picture",
|
||||||
|
"user.attribute": "picture"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "mock-google-hosted-domain",
|
||||||
|
"identityProviderAlias": "mock-google",
|
||||||
|
"identityProviderMapper": "oidc-user-attribute-idp-mapper",
|
||||||
|
"config": {
|
||||||
|
"syncMode": "INHERIT",
|
||||||
|
"claim": "hd",
|
||||||
|
"user.attribute": "hd"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "mock-google-example-domain-role",
|
||||||
|
"identityProviderAlias": "mock-google",
|
||||||
|
"identityProviderMapper": "oidc-role-idp-mapper",
|
||||||
|
"config": {
|
||||||
|
"syncMode": "INHERIT",
|
||||||
|
"claim": "hd",
|
||||||
|
"claim.value": "example.test",
|
||||||
|
"role": "employee-role"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"users": [
|
||||||
|
{
|
||||||
|
"username": "admin-user",
|
||||||
|
"enabled": true,
|
||||||
|
"email": "admin-user@example.test",
|
||||||
|
"emailVerified": true,
|
||||||
|
"firstName": "Admin",
|
||||||
|
"lastName": "User",
|
||||||
|
"realmRoles": [
|
||||||
|
"admin-role"
|
||||||
|
],
|
||||||
|
"credentials": [
|
||||||
|
{
|
||||||
|
"type": "password",
|
||||||
|
"value": "${ADMIN_USER_PASSWORD}",
|
||||||
|
"temporary": false
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"username": "regular-user",
|
||||||
|
"enabled": true,
|
||||||
|
"email": "regular-user@example.test",
|
||||||
|
"emailVerified": true,
|
||||||
|
"firstName": "Regular",
|
||||||
|
"lastName": "User",
|
||||||
|
"realmRoles": [
|
||||||
|
"user-role"
|
||||||
|
],
|
||||||
|
"credentials": [
|
||||||
|
{
|
||||||
|
"type": "password",
|
||||||
|
"value": "${REGULAR_USER_PASSWORD}",
|
||||||
|
"temporary": false
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
@@ -0,0 +1,93 @@
|
|||||||
|
{
|
||||||
|
"realm": "mock-google",
|
||||||
|
"displayName": "Controllable Google OIDC Test Provider",
|
||||||
|
"enabled": true,
|
||||||
|
"sslRequired": "external",
|
||||||
|
"registrationAllowed": false,
|
||||||
|
"resetPasswordAllowed": false,
|
||||||
|
"editUsernameAllowed": false,
|
||||||
|
"loginWithEmailAllowed": true,
|
||||||
|
"duplicateEmailsAllowed": false,
|
||||||
|
"bruteForceProtected": true,
|
||||||
|
"clients": [
|
||||||
|
{
|
||||||
|
"clientId": "mock-google-broker",
|
||||||
|
"name": "Main Realm Identity Broker",
|
||||||
|
"enabled": true,
|
||||||
|
"protocol": "openid-connect",
|
||||||
|
"publicClient": false,
|
||||||
|
"clientAuthenticatorType": "client-secret",
|
||||||
|
"secret": "${MOCK_GOOGLE_BROKER_CLIENT_SECRET}",
|
||||||
|
"standardFlowEnabled": true,
|
||||||
|
"implicitFlowEnabled": false,
|
||||||
|
"directAccessGrantsEnabled": false,
|
||||||
|
"serviceAccountsEnabled": false,
|
||||||
|
"redirectUris": [
|
||||||
|
"http://localhost:8080/realms/keycloak-patterns/broker/mock-google/endpoint"
|
||||||
|
],
|
||||||
|
"webOrigins": [],
|
||||||
|
"protocolMappers": [
|
||||||
|
{
|
||||||
|
"name": "hosted-domain",
|
||||||
|
"protocol": "openid-connect",
|
||||||
|
"protocolMapper": "oidc-hardcoded-claim-mapper",
|
||||||
|
"consentRequired": false,
|
||||||
|
"config": {
|
||||||
|
"claim.name": "hd",
|
||||||
|
"claim.value": "example.test",
|
||||||
|
"jsonType.label": "String",
|
||||||
|
"id.token.claim": "true",
|
||||||
|
"access.token.claim": "true",
|
||||||
|
"userinfo.token.claim": "true"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "picture",
|
||||||
|
"protocol": "openid-connect",
|
||||||
|
"protocolMapper": "oidc-hardcoded-claim-mapper",
|
||||||
|
"consentRequired": false,
|
||||||
|
"config": {
|
||||||
|
"claim.name": "picture",
|
||||||
|
"claim.value": "https://images.example.test/mock-user.png",
|
||||||
|
"jsonType.label": "String",
|
||||||
|
"id.token.claim": "true",
|
||||||
|
"access.token.claim": "true",
|
||||||
|
"userinfo.token.claim": "true"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"users": [
|
||||||
|
{
|
||||||
|
"username": "mock-new-user",
|
||||||
|
"enabled": true,
|
||||||
|
"email": "broker-new-user@example.test",
|
||||||
|
"emailVerified": true,
|
||||||
|
"firstName": "Broker",
|
||||||
|
"lastName": "New",
|
||||||
|
"credentials": [
|
||||||
|
{
|
||||||
|
"type": "password",
|
||||||
|
"value": "${MOCK_GOOGLE_USER_PASSWORD}",
|
||||||
|
"temporary": false
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"username": "mock-collision-user",
|
||||||
|
"enabled": true,
|
||||||
|
"email": "regular-user@example.test",
|
||||||
|
"emailVerified": false,
|
||||||
|
"firstName": "Broker",
|
||||||
|
"lastName": "Collision",
|
||||||
|
"credentials": [
|
||||||
|
{
|
||||||
|
"type": "password",
|
||||||
|
"value": "${MOCK_GOOGLE_USER_PASSWORD}",
|
||||||
|
"temporary": false
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
Executable
+62
@@ -0,0 +1,62 @@
|
|||||||
|
#!/usr/bin/env sh
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
manifest="${1:-docs/keycloak-branch-manifest.tsv}"
|
||||||
|
notes_dir="${KEYCLOAK_BRANCH_NOTES_DIR:-/home/donghyeon/workspace/ai-tools/llm-wiki/raw/branch-notes}"
|
||||||
|
|
||||||
|
expected_count="$(awk 'NR > 1 { count += 1 } END { print count + 0 }' "$manifest")"
|
||||||
|
if [ "$expected_count" -ne 39 ]; then
|
||||||
|
echo "manifest must contain exactly 39 Keycloak branches; found $expected_count" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
note_count="$(find "$notes_dir" -maxdepth 1 -type f -name 'feature-keycloak-*.md' | wc -l)"
|
||||||
|
if [ "$note_count" -ne 39 ]; then
|
||||||
|
echo "branch-note inventory must contain exactly 39 files; found $note_count" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
missing=0
|
||||||
|
unmerged=0
|
||||||
|
tab="$(printf '\t')"
|
||||||
|
|
||||||
|
while IFS="$tab" read -r branch target delivery; do
|
||||||
|
[ "$branch" = "branch" ] && continue
|
||||||
|
|
||||||
|
note_name="$(printf '%s\n' "$branch" |
|
||||||
|
sed 's#^feature/keycloak-#feature-keycloak-#').md"
|
||||||
|
if [ ! -f "$notes_dir/$note_name" ]; then
|
||||||
|
echo "missing branch note: $note_name" >&2
|
||||||
|
missing=$((missing + 1))
|
||||||
|
fi
|
||||||
|
|
||||||
|
if ! git show-ref --verify --quiet "refs/heads/$branch"; then
|
||||||
|
echo "missing local branch: $branch" >&2
|
||||||
|
missing=$((missing + 1))
|
||||||
|
continue
|
||||||
|
fi
|
||||||
|
|
||||||
|
case "$target" in
|
||||||
|
common) target_branch="develop" ;;
|
||||||
|
ap1) target_branch="develop-keycloak-pattern1" ;;
|
||||||
|
ap2) target_branch="develop-keycloak-pattern2" ;;
|
||||||
|
ap3) target_branch="develop-keycloak-pattern3" ;;
|
||||||
|
ap4) target_branch="develop-keycloak-pattern4" ;;
|
||||||
|
*)
|
||||||
|
echo "unknown target '$target' for $branch ($delivery)" >&2
|
||||||
|
exit 1
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
if ! git merge-base --is-ancestor "$branch" "$target_branch"; then
|
||||||
|
echo "feature tip is not merged: $branch -> $target_branch" >&2
|
||||||
|
unmerged=$((unmerged + 1))
|
||||||
|
fi
|
||||||
|
done < "$manifest"
|
||||||
|
|
||||||
|
if [ "$missing" -ne 0 ] || [ "$unmerged" -ne 0 ]; then
|
||||||
|
echo "Keycloak branch audit failed: missing=$missing unmerged=$unmerged" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "Keycloak branch audit passed: 39/39 branches exist and are merged"
|
||||||
Executable
+58
@@ -0,0 +1,58 @@
|
|||||||
|
#!/usr/bin/env sh
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
if [ ! -f .env ]; then
|
||||||
|
echo "missing .env" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
set -a
|
||||||
|
. ./.env
|
||||||
|
set +a
|
||||||
|
|
||||||
|
keycloak_url="${KEYCLOAK_URL:-http://localhost:8080}"
|
||||||
|
realm="${KEYCLOAK_REALM:-keycloak-patterns}"
|
||||||
|
profile_url="$keycloak_url/admin/realms/$realm/users/profile"
|
||||||
|
|
||||||
|
admin_token="$(
|
||||||
|
curl -fsS \
|
||||||
|
-d client_id=admin-cli \
|
||||||
|
-d grant_type=password \
|
||||||
|
-d "username=$KC_BOOTSTRAP_ADMIN_USERNAME" \
|
||||||
|
-d "password=$KC_BOOTSTRAP_ADMIN_PASSWORD" \
|
||||||
|
"$keycloak_url/realms/master/protocol/openid-connect/token" |
|
||||||
|
jq -er .access_token
|
||||||
|
)"
|
||||||
|
|
||||||
|
profile="$(curl -fsS -H "Authorization: Bearer $admin_token" "$profile_url")"
|
||||||
|
updated_profile="$(
|
||||||
|
printf '%s' "$profile" |
|
||||||
|
jq '
|
||||||
|
def broker_attribute($name; $label): {
|
||||||
|
name: $name,
|
||||||
|
displayName: $label,
|
||||||
|
validations: {length: {max: 2048}},
|
||||||
|
permissions: {
|
||||||
|
view: ["admin", "user"],
|
||||||
|
edit: ["admin"]
|
||||||
|
},
|
||||||
|
multivalued: false,
|
||||||
|
group: "user-metadata"
|
||||||
|
};
|
||||||
|
if any(.attributes[]; .name == "picture") then .
|
||||||
|
else .attributes += [broker_attribute("picture"; "Profile picture URL")]
|
||||||
|
end |
|
||||||
|
if any(.attributes[]; .name == "hd") then .
|
||||||
|
else .attributes += [broker_attribute("hd"; "Hosted domain")]
|
||||||
|
end
|
||||||
|
'
|
||||||
|
)"
|
||||||
|
|
||||||
|
printf '%s' "$updated_profile" |
|
||||||
|
curl -fsS -X PUT \
|
||||||
|
-H "Authorization: Bearer $admin_token" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
--data @- \
|
||||||
|
"$profile_url"
|
||||||
|
|
||||||
|
echo "Broker user-profile attributes configured for realm '$realm'"
|
||||||
Executable
+154
@@ -0,0 +1,154 @@
|
|||||||
|
#!/usr/bin/env sh
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
if [ ! -f .env ]; then
|
||||||
|
echo "missing .env" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
set -a
|
||||||
|
. ./.env
|
||||||
|
set +a
|
||||||
|
|
||||||
|
: "${KC_BOOTSTRAP_ADMIN_USERNAME:?set KC_BOOTSTRAP_ADMIN_USERNAME in .env}"
|
||||||
|
: "${KC_BOOTSTRAP_ADMIN_PASSWORD:?set KC_BOOTSTRAP_ADMIN_PASSWORD in .env}"
|
||||||
|
: "${GOOGLE_CLIENT_ID:?set GOOGLE_CLIENT_ID in .env}"
|
||||||
|
: "${GOOGLE_CLIENT_SECRET:?set GOOGLE_CLIENT_SECRET in .env}"
|
||||||
|
|
||||||
|
./scripts/configure-broker-user-profile.sh
|
||||||
|
|
||||||
|
keycloak_url="${KEYCLOAK_URL:-http://localhost:8080}"
|
||||||
|
realm="${KEYCLOAK_REALM:-keycloak-patterns}"
|
||||||
|
|
||||||
|
admin_token="$(
|
||||||
|
curl -fsS \
|
||||||
|
-d client_id=admin-cli \
|
||||||
|
-d grant_type=password \
|
||||||
|
-d "username=$KC_BOOTSTRAP_ADMIN_USERNAME" \
|
||||||
|
-d "password=$KC_BOOTSTRAP_ADMIN_PASSWORD" \
|
||||||
|
"$keycloak_url/realms/master/protocol/openid-connect/token" |
|
||||||
|
jq -er .access_token
|
||||||
|
)"
|
||||||
|
|
||||||
|
payload="$(
|
||||||
|
jq -n \
|
||||||
|
--arg client_id "$GOOGLE_CLIENT_ID" \
|
||||||
|
--arg client_secret "$GOOGLE_CLIENT_SECRET" \
|
||||||
|
'{
|
||||||
|
alias: "google",
|
||||||
|
displayName: "Sign in with Google",
|
||||||
|
providerId: "google",
|
||||||
|
enabled: true,
|
||||||
|
updateProfileFirstLoginMode: "off",
|
||||||
|
trustEmail: false,
|
||||||
|
storeToken: false,
|
||||||
|
addReadTokenRoleOnCreate: false,
|
||||||
|
authenticateByDefault: false,
|
||||||
|
linkOnly: false,
|
||||||
|
firstBrokerLoginFlowAlias: "first broker login",
|
||||||
|
config: {
|
||||||
|
clientId: $client_id,
|
||||||
|
clientSecret: $client_secret,
|
||||||
|
defaultScope: "openid profile email",
|
||||||
|
syncMode: "IMPORT"
|
||||||
|
}
|
||||||
|
}'
|
||||||
|
)"
|
||||||
|
|
||||||
|
endpoint="$keycloak_url/admin/realms/$realm/identity-provider/instances"
|
||||||
|
status="$(
|
||||||
|
curl -sS -o /dev/null -w '%{http_code}' \
|
||||||
|
-H "Authorization: Bearer $admin_token" \
|
||||||
|
"$endpoint/google"
|
||||||
|
)"
|
||||||
|
|
||||||
|
if [ "$status" = "200" ]; then
|
||||||
|
curl -fsS -X PUT \
|
||||||
|
-H "Authorization: Bearer $admin_token" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
--data "$payload" \
|
||||||
|
"$endpoint/google"
|
||||||
|
action="updated"
|
||||||
|
else
|
||||||
|
curl -fsS -X POST \
|
||||||
|
-H "Authorization: Bearer $admin_token" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
--data "$payload" \
|
||||||
|
"$endpoint"
|
||||||
|
action="created"
|
||||||
|
fi
|
||||||
|
|
||||||
|
mapper_endpoint="$endpoint/google/mappers"
|
||||||
|
upsert_mapper() {
|
||||||
|
mapper_name="$1"
|
||||||
|
mapper_type="$2"
|
||||||
|
mapper_config="$3"
|
||||||
|
mapper_id="$(
|
||||||
|
curl -fsS \
|
||||||
|
-H "Authorization: Bearer $admin_token" \
|
||||||
|
"$mapper_endpoint" |
|
||||||
|
jq -r --arg name "$mapper_name" '
|
||||||
|
.[] | select(.name == $name) | .id
|
||||||
|
' |
|
||||||
|
head -1
|
||||||
|
)"
|
||||||
|
mapper_payload="$(
|
||||||
|
jq -n \
|
||||||
|
--arg name "$mapper_name" \
|
||||||
|
--arg alias "google" \
|
||||||
|
--arg mapper "$mapper_type" \
|
||||||
|
--argjson config "$mapper_config" \
|
||||||
|
'{
|
||||||
|
name: $name,
|
||||||
|
identityProviderAlias: $alias,
|
||||||
|
identityProviderMapper: $mapper,
|
||||||
|
config: $config
|
||||||
|
}'
|
||||||
|
)"
|
||||||
|
if [ -n "$mapper_id" ]; then
|
||||||
|
curl -fsS -X PUT \
|
||||||
|
-H "Authorization: Bearer $admin_token" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
--data "$mapper_payload" \
|
||||||
|
"$mapper_endpoint/$mapper_id"
|
||||||
|
else
|
||||||
|
curl -fsS -X POST \
|
||||||
|
-H "Authorization: Bearer $admin_token" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
--data "$mapper_payload" \
|
||||||
|
"$mapper_endpoint"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
upsert_mapper \
|
||||||
|
"google-stable-username" \
|
||||||
|
"oidc-username-idp-mapper" \
|
||||||
|
'{"template":"${ALIAS}.${CLAIM.sub}","target":"LOCAL"}'
|
||||||
|
upsert_mapper \
|
||||||
|
"google-email" \
|
||||||
|
"oidc-user-attribute-idp-mapper" \
|
||||||
|
'{"syncMode":"INHERIT","claim":"email","user.attribute":"email"}'
|
||||||
|
upsert_mapper \
|
||||||
|
"google-given-name" \
|
||||||
|
"oidc-user-attribute-idp-mapper" \
|
||||||
|
'{"syncMode":"INHERIT","claim":"given_name","user.attribute":"firstName"}'
|
||||||
|
upsert_mapper \
|
||||||
|
"google-family-name" \
|
||||||
|
"oidc-user-attribute-idp-mapper" \
|
||||||
|
'{"syncMode":"INHERIT","claim":"family_name","user.attribute":"lastName"}'
|
||||||
|
upsert_mapper \
|
||||||
|
"google-picture" \
|
||||||
|
"oidc-user-attribute-idp-mapper" \
|
||||||
|
'{"syncMode":"INHERIT","claim":"picture","user.attribute":"picture"}'
|
||||||
|
upsert_mapper \
|
||||||
|
"google-hosted-domain" \
|
||||||
|
"oidc-user-attribute-idp-mapper" \
|
||||||
|
'{"syncMode":"INHERIT","claim":"hd","user.attribute":"hd"}'
|
||||||
|
upsert_mapper \
|
||||||
|
"google-example-domain-role" \
|
||||||
|
"oidc-role-idp-mapper" \
|
||||||
|
'{"syncMode":"INHERIT","claim":"hd","claim.value":"example.test","role":"employee-role"}'
|
||||||
|
|
||||||
|
echo "Google Identity Provider $action for realm '$realm'"
|
||||||
|
echo "Register this exact Google redirect URI:"
|
||||||
|
echo "$keycloak_url/realms/$realm/broker/google/endpoint"
|
||||||
Executable
+30
@@ -0,0 +1,30 @@
|
|||||||
|
#!/usr/bin/env sh
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
compose_file=${COMPOSE_FILE:-docker-compose.yml}
|
||||||
|
output_dir=${REALM_EXPORT_DIR:-"$(pwd)/build/keycloak-export"}
|
||||||
|
output_file="$output_dir/keycloak-patterns-realm.json"
|
||||||
|
|
||||||
|
mkdir -p "$output_dir"
|
||||||
|
|
||||||
|
restart_keycloak() {
|
||||||
|
trap - EXIT INT TERM
|
||||||
|
docker compose -f "$compose_file" up -d --wait >/dev/null
|
||||||
|
}
|
||||||
|
trap restart_keycloak EXIT
|
||||||
|
trap 'exit 130' INT
|
||||||
|
trap 'exit 143' TERM
|
||||||
|
|
||||||
|
docker compose -f "$compose_file" stop keycloak >/dev/null
|
||||||
|
docker compose -f "$compose_file" run --rm --no-deps \
|
||||||
|
--volume "$output_dir:/opt/keycloak/data/export" \
|
||||||
|
keycloak \
|
||||||
|
export \
|
||||||
|
--realm keycloak-patterns \
|
||||||
|
--file /opt/keycloak/data/export/keycloak-patterns-realm.json \
|
||||||
|
--users same_file
|
||||||
|
|
||||||
|
chmod 600 "$output_file"
|
||||||
|
python3 scripts/validate-realm.py --runtime "$output_file"
|
||||||
|
|
||||||
|
echo "runtime realm export written to $output_file"
|
||||||
Executable
+178
@@ -0,0 +1,178 @@
|
|||||||
|
#!/usr/bin/env sh
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
mode="${1:-}"
|
||||||
|
case "$mode" in
|
||||||
|
vulnerable|secure) ;;
|
||||||
|
*)
|
||||||
|
echo "usage: $0 vulnerable|secure" >&2
|
||||||
|
exit 1
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
if [ ! -f .env ]; then
|
||||||
|
echo "missing .env" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
set -a
|
||||||
|
. ./.env
|
||||||
|
set +a
|
||||||
|
|
||||||
|
keycloak_url="${KEYCLOAK_URL:-http://localhost:8080}"
|
||||||
|
realm="${KEYCLOAK_REALM:-keycloak-patterns}"
|
||||||
|
admin_base="$keycloak_url/admin/realms/$realm"
|
||||||
|
vulnerable_flow="vulnerable first broker login"
|
||||||
|
idp_url="$admin_base/identity-provider/instances/mock-google"
|
||||||
|
|
||||||
|
admin_token="$(
|
||||||
|
curl -fsS \
|
||||||
|
-d client_id=admin-cli \
|
||||||
|
-d grant_type=password \
|
||||||
|
-d "username=$KC_BOOTSTRAP_ADMIN_USERNAME" \
|
||||||
|
-d "password=$KC_BOOTSTRAP_ADMIN_PASSWORD" \
|
||||||
|
"$keycloak_url/realms/master/protocol/openid-connect/token" |
|
||||||
|
jq -er .access_token
|
||||||
|
)"
|
||||||
|
|
||||||
|
auth_header="Authorization: Bearer $admin_token"
|
||||||
|
encode() {
|
||||||
|
jq -rn --arg value "$1" '$value | @uri'
|
||||||
|
}
|
||||||
|
|
||||||
|
flows="$(curl -fsS -H "$auth_header" "$admin_base/authentication/flows")"
|
||||||
|
flow_id="$(
|
||||||
|
printf '%s' "$flows" |
|
||||||
|
jq -r --arg alias "$vulnerable_flow" '
|
||||||
|
.[] | select(.alias == $alias) | .id
|
||||||
|
' |
|
||||||
|
head -1
|
||||||
|
)"
|
||||||
|
|
||||||
|
if [ -n "$flow_id" ]; then
|
||||||
|
existing_executions="$(
|
||||||
|
curl -fsS -H "$auth_header" \
|
||||||
|
"$admin_base/authentication/flows/$(encode "$vulnerable_flow")/executions"
|
||||||
|
)"
|
||||||
|
if printf '%s' "$existing_executions" | jq -e '
|
||||||
|
any(.[]; .authenticationFlow == true)
|
||||||
|
' >/dev/null; then
|
||||||
|
idp_before_delete="$(curl -fsS -H "$auth_header" "$idp_url")"
|
||||||
|
printf '%s' "$idp_before_delete" |
|
||||||
|
jq '.firstBrokerLoginFlowAlias = "first broker login"' |
|
||||||
|
curl -fsS -X PUT \
|
||||||
|
-H "$auth_header" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
--data @- \
|
||||||
|
"$idp_url"
|
||||||
|
curl -fsS -X DELETE \
|
||||||
|
-H "$auth_header" \
|
||||||
|
"$admin_base/authentication/flows/$flow_id"
|
||||||
|
flow_id=""
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ -z "$flow_id" ]; then
|
||||||
|
curl -fsS -X POST \
|
||||||
|
-H "$auth_header" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
--data "$(
|
||||||
|
jq -n --arg alias "$vulnerable_flow" '{
|
||||||
|
alias: $alias,
|
||||||
|
description: "INSECURE LEARNING FLOW - automatic email linking",
|
||||||
|
providerId: "basic-flow",
|
||||||
|
topLevel: true,
|
||||||
|
builtIn: false
|
||||||
|
}'
|
||||||
|
)" \
|
||||||
|
"$admin_base/authentication/flows"
|
||||||
|
fi
|
||||||
|
|
||||||
|
executions_url="$admin_base/authentication/flows/$(encode "$vulnerable_flow")/executions"
|
||||||
|
executions="$(curl -fsS -H "$auth_header" "$executions_url")"
|
||||||
|
create_user_id="$(
|
||||||
|
printf '%s' "$executions" |
|
||||||
|
jq -r '.[] | select(.providerId == "idp-create-user-if-unique") | .id' |
|
||||||
|
head -1
|
||||||
|
)"
|
||||||
|
if [ -z "$create_user_id" ]; then
|
||||||
|
curl -fsS -X POST \
|
||||||
|
-H "$auth_header" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
--data '{"provider":"idp-create-user-if-unique"}' \
|
||||||
|
"$admin_base/authentication/flows/$(encode "$vulnerable_flow")/executions/execution"
|
||||||
|
executions="$(curl -fsS -H "$auth_header" "$executions_url")"
|
||||||
|
create_user_id="$(
|
||||||
|
printf '%s' "$executions" |
|
||||||
|
jq -r '.[] | select(.providerId == "idp-create-user-if-unique") | .id' |
|
||||||
|
head -1
|
||||||
|
)"
|
||||||
|
fi
|
||||||
|
|
||||||
|
auto_link_id="$(
|
||||||
|
printf '%s' "$executions" |
|
||||||
|
jq -r '.[] | select(.providerId == "idp-auto-link") | .id' |
|
||||||
|
head -1
|
||||||
|
)"
|
||||||
|
|
||||||
|
if [ -z "$auto_link_id" ]; then
|
||||||
|
curl -fsS -X POST \
|
||||||
|
-H "$auth_header" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
--data '{"provider":"idp-auto-link"}' \
|
||||||
|
"$admin_base/authentication/flows/$(encode "$vulnerable_flow")/executions/execution"
|
||||||
|
executions="$(curl -fsS -H "$auth_header" "$executions_url")"
|
||||||
|
auto_link_id="$(
|
||||||
|
printf '%s' "$executions" |
|
||||||
|
jq -r '.[] | select(.providerId == "idp-auto-link") | .id' |
|
||||||
|
head -1
|
||||||
|
)"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ "$mode" = "vulnerable" ]; then
|
||||||
|
curl -fsS -X PUT \
|
||||||
|
-H "$auth_header" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
--data "$(jq -n --arg id "$create_user_id" '{id: $id, requirement: "ALTERNATIVE"}')" \
|
||||||
|
"$executions_url"
|
||||||
|
curl -fsS -X PUT \
|
||||||
|
-H "$auth_header" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
--data "$(jq -n --arg id "$auto_link_id" '{id: $id, requirement: "ALTERNATIVE"}')" \
|
||||||
|
"$executions_url"
|
||||||
|
selected_flow="$vulnerable_flow"
|
||||||
|
else
|
||||||
|
selected_flow="first broker login"
|
||||||
|
fi
|
||||||
|
|
||||||
|
idp="$(curl -fsS -H "$auth_header" "$idp_url")"
|
||||||
|
printf '%s' "$idp" |
|
||||||
|
jq --arg flow "$selected_flow" '.firstBrokerLoginFlowAlias = $flow' |
|
||||||
|
curl -fsS -X PUT \
|
||||||
|
-H "$auth_header" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
--data @- \
|
||||||
|
"$idp_url"
|
||||||
|
|
||||||
|
assigned="$(
|
||||||
|
curl -fsS -H "$auth_header" "$idp_url" |
|
||||||
|
jq -r .firstBrokerLoginFlowAlias
|
||||||
|
)"
|
||||||
|
test "$assigned" = "$selected_flow"
|
||||||
|
|
||||||
|
if [ "$mode" = "secure" ]; then
|
||||||
|
secure_executions="$(
|
||||||
|
curl -fsS -H "$auth_header" \
|
||||||
|
"$admin_base/authentication/flows/$(encode "first broker login")/executions"
|
||||||
|
)"
|
||||||
|
printf '%s' "$secure_executions" | jq -e '
|
||||||
|
any(.[];
|
||||||
|
.providerId == "idp-confirm-link" and .requirement == "REQUIRED"
|
||||||
|
) and
|
||||||
|
(any(.[];
|
||||||
|
.providerId == "idp-auto-link" and .requirement != "DISABLED"
|
||||||
|
) | not)
|
||||||
|
' >/dev/null
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "mock-google First Broker Login mode: $mode ($selected_flow)"
|
||||||
Executable
+118
@@ -0,0 +1,118 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Validate the committed realm template or a runtime Keycloak CLI export."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
import json
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
REALM_NAME = "keycloak-patterns"
|
||||||
|
PUBLIC_CLIENT = "spa-public"
|
||||||
|
CONFIDENTIAL_CLIENTS = {
|
||||||
|
"token-mediating-confidential": "${TOKEN_MEDIATING_CLIENT_SECRET}",
|
||||||
|
"bff-confidential": "${BFF_CLIENT_SECRET}",
|
||||||
|
"edge-proxy": "${EDGE_PROXY_CLIENT_SECRET}",
|
||||||
|
}
|
||||||
|
EXPECTED_ROLES = {"admin-role", "user-role"}
|
||||||
|
EXPECTED_USERS = {"admin-user", "regular-user"}
|
||||||
|
|
||||||
|
|
||||||
|
def parse_args() -> argparse.Namespace:
|
||||||
|
parser = argparse.ArgumentParser()
|
||||||
|
parser.add_argument(
|
||||||
|
"realm_file",
|
||||||
|
nargs="?",
|
||||||
|
type=Path,
|
||||||
|
default=Path("keycloak/import/keycloak-patterns-realm.json"),
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
"--runtime",
|
||||||
|
action="store_true",
|
||||||
|
help="validate an expanded CLI export instead of the committed template",
|
||||||
|
)
|
||||||
|
return parser.parse_args()
|
||||||
|
|
||||||
|
|
||||||
|
def require(condition: bool, message: str) -> None:
|
||||||
|
if not condition:
|
||||||
|
raise SystemExit(f"realm validation failed: {message}")
|
||||||
|
|
||||||
|
|
||||||
|
def indexed(items: list[dict[str, Any]], key: str) -> dict[str, dict[str, Any]]:
|
||||||
|
return {str(item[key]): item for item in items}
|
||||||
|
|
||||||
|
|
||||||
|
def validate(path: Path, runtime: bool) -> None:
|
||||||
|
document = json.loads(path.read_text(encoding="utf-8"))
|
||||||
|
require(document.get("realm") == REALM_NAME, f"realm must be {REALM_NAME}")
|
||||||
|
require(document.get("enabled") is True, "realm must be enabled")
|
||||||
|
require(document.get("accessTokenLifespan") == 300, "access token TTL must be 300s")
|
||||||
|
require(document.get("revokeRefreshToken") is True, "refresh token rotation must be enabled")
|
||||||
|
require(document.get("refreshTokenMaxReuse") == 0, "refresh token max reuse must be 0")
|
||||||
|
|
||||||
|
clients = indexed(document.get("clients", []), "clientId")
|
||||||
|
expected_client_ids = {PUBLIC_CLIENT, *CONFIDENTIAL_CLIENTS}
|
||||||
|
require(expected_client_ids <= clients.keys(), "all four pattern clients must exist")
|
||||||
|
if not runtime:
|
||||||
|
require(clients.keys() == expected_client_ids, "template must declare exactly four clients")
|
||||||
|
|
||||||
|
spa = clients[PUBLIC_CLIENT]
|
||||||
|
require(spa.get("publicClient") is True, "spa-public must be a public client")
|
||||||
|
require("secret" not in spa, "spa-public must not have a client secret")
|
||||||
|
require(spa.get("standardFlowEnabled") is True, "spa-public standard flow must be enabled")
|
||||||
|
require(
|
||||||
|
spa.get("directAccessGrantsEnabled") is False,
|
||||||
|
"spa-public direct access grants must be disabled",
|
||||||
|
)
|
||||||
|
require(
|
||||||
|
spa.get("attributes", {}).get("pkce.code.challenge.method") == "S256",
|
||||||
|
"spa-public must enforce PKCE S256",
|
||||||
|
)
|
||||||
|
|
||||||
|
for client_id, placeholder in CONFIDENTIAL_CLIENTS.items():
|
||||||
|
client = clients[client_id]
|
||||||
|
require(client.get("publicClient") is False, f"{client_id} must be confidential")
|
||||||
|
require(
|
||||||
|
client.get("clientAuthenticatorType") == "client-secret",
|
||||||
|
f"{client_id} must use client-secret authentication",
|
||||||
|
)
|
||||||
|
secret = client.get("secret")
|
||||||
|
if runtime:
|
||||||
|
require(isinstance(secret, str) and len(secret) >= 16, f"{client_id} secret missing")
|
||||||
|
require(not secret.startswith("${"), f"{client_id} placeholder was not resolved")
|
||||||
|
else:
|
||||||
|
require(secret == placeholder, f"{client_id} must use an env placeholder")
|
||||||
|
|
||||||
|
roles = {
|
||||||
|
role["name"]
|
||||||
|
for role in document.get("roles", {}).get("realm", [])
|
||||||
|
if "name" in role
|
||||||
|
}
|
||||||
|
require(EXPECTED_ROLES <= roles, "admin-role and user-role must exist")
|
||||||
|
|
||||||
|
users = indexed(document.get("users", []), "username")
|
||||||
|
require(EXPECTED_USERS <= users.keys(), "both baseline users must exist")
|
||||||
|
if not runtime:
|
||||||
|
expected_passwords = {
|
||||||
|
"admin-user": "${ADMIN_USER_PASSWORD}",
|
||||||
|
"regular-user": "${REGULAR_USER_PASSWORD}",
|
||||||
|
}
|
||||||
|
for username, placeholder in expected_passwords.items():
|
||||||
|
credentials = users[username].get("credentials", [])
|
||||||
|
require(len(credentials) == 1, f"{username} must have one initial credential")
|
||||||
|
require(
|
||||||
|
credentials[0].get("value") == placeholder,
|
||||||
|
f"{username} password must use an env placeholder",
|
||||||
|
)
|
||||||
|
|
||||||
|
print(
|
||||||
|
f"realm validated: {REALM_NAME}, four pattern clients, "
|
||||||
|
f"{len(EXPECTED_ROLES)} roles, {len(EXPECTED_USERS)} users"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
arguments = parse_args()
|
||||||
|
validate(arguments.realm_file, arguments.runtime)
|
||||||
+11
@@ -0,0 +1,11 @@
|
|||||||
|
#!/usr/bin/env sh
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
set -a
|
||||||
|
. ./.env
|
||||||
|
set +a
|
||||||
|
|
||||||
|
./scripts/set-first-broker-login-mode.sh secure
|
||||||
|
cd google-e2e
|
||||||
|
npm install --ignore-scripts
|
||||||
|
npm run test:sub-vs-email
|
||||||
Executable
+29
@@ -0,0 +1,29 @@
|
|||||||
|
#!/usr/bin/env sh
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
if [ ! -f .env ]; then
|
||||||
|
echo "missing .env" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
set -a
|
||||||
|
. ./.env
|
||||||
|
set +a
|
||||||
|
|
||||||
|
restore_secure_flow() {
|
||||||
|
./scripts/set-first-broker-login-mode.sh secure >/dev/null 2>&1 || true
|
||||||
|
}
|
||||||
|
trap restore_secure_flow 0 1 2 15
|
||||||
|
|
||||||
|
npm --prefix google-e2e ci
|
||||||
|
|
||||||
|
./scripts/set-first-broker-login-mode.sh vulnerable
|
||||||
|
FIRST_BROKER_EXPECTATION=vulnerable \
|
||||||
|
npm --prefix google-e2e run test:first-broker
|
||||||
|
|
||||||
|
./scripts/set-first-broker-login-mode.sh secure
|
||||||
|
FIRST_BROKER_EXPECTATION=secure \
|
||||||
|
npm --prefix google-e2e run test:first-broker
|
||||||
|
|
||||||
|
trap - 0 1 2 15
|
||||||
|
echo "First Broker Login verified: unsafe AutoLink reproduced, Confirm Link restored"
|
||||||
Executable
+70
@@ -0,0 +1,70 @@
|
|||||||
|
#!/usr/bin/env sh
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
if [ ! -f .env ]; then
|
||||||
|
echo "missing .env" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
set -a
|
||||||
|
. ./.env
|
||||||
|
set +a
|
||||||
|
|
||||||
|
keycloak_url="${KEYCLOAK_URL:-http://localhost:8080}"
|
||||||
|
|
||||||
|
admin_token="$(
|
||||||
|
curl -fsS \
|
||||||
|
-d client_id=admin-cli \
|
||||||
|
-d grant_type=password \
|
||||||
|
-d "username=$KC_BOOTSTRAP_ADMIN_USERNAME" \
|
||||||
|
-d "password=$KC_BOOTSTRAP_ADMIN_PASSWORD" \
|
||||||
|
"$keycloak_url/realms/master/protocol/openid-connect/token" |
|
||||||
|
jq -er .access_token
|
||||||
|
)"
|
||||||
|
|
||||||
|
idp="$(
|
||||||
|
curl -fsS \
|
||||||
|
-H "Authorization: Bearer $admin_token" \
|
||||||
|
"$keycloak_url/admin/realms/keycloak-patterns/identity-provider/instances/mock-google"
|
||||||
|
)"
|
||||||
|
|
||||||
|
printf '%s' "$idp" | jq -e '
|
||||||
|
.providerId == "oidc" and
|
||||||
|
.enabled == true and
|
||||||
|
.trustEmail == false and
|
||||||
|
.config.clientId == "mock-google-broker" and
|
||||||
|
.config.defaultScope == "openid profile email" and
|
||||||
|
.config.syncMode == "IMPORT" and
|
||||||
|
.config.validateSignature == "true"
|
||||||
|
' >/dev/null
|
||||||
|
|
||||||
|
client="$(
|
||||||
|
curl -fsS \
|
||||||
|
-H "Authorization: Bearer $admin_token" \
|
||||||
|
"$keycloak_url/admin/realms/mock-google/clients?clientId=mock-google-broker"
|
||||||
|
)"
|
||||||
|
|
||||||
|
printf '%s' "$client" | jq -e '
|
||||||
|
length == 1 and
|
||||||
|
.[0].publicClient == false and
|
||||||
|
(.[0].redirectUris | index(
|
||||||
|
"http://localhost:8080/realms/keycloak-patterns/broker/mock-google/endpoint"
|
||||||
|
)) != null
|
||||||
|
' >/dev/null
|
||||||
|
|
||||||
|
location="$(
|
||||||
|
curl -sS -D - -o /dev/null \
|
||||||
|
"$keycloak_url/realms/keycloak-patterns/protocol/openid-connect/auth?client_id=spa-public&redirect_uri=http%3A%2F%2Flocalhost%3A8088%2F&response_type=code&scope=openid&code_challenge=K2qUEfBl-nQvF2gB4dNxC2zYVwZc1CVnZb5CsX2L7fI&code_challenge_method=S256&kc_idp_hint=mock-google" |
|
||||||
|
awk 'BEGIN { IGNORECASE=1 } /^Location:/ { print $2 }' |
|
||||||
|
tr -d '\r'
|
||||||
|
)"
|
||||||
|
|
||||||
|
case "$location" in
|
||||||
|
"$keycloak_url/realms/keycloak-patterns/broker/mock-google/login"*) ;;
|
||||||
|
*)
|
||||||
|
echo "broker did not redirect to the controllable OIDC provider: $location" >&2
|
||||||
|
exit 1
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
echo "Google broker contract verified with the local mock OIDC realm"
|
||||||
Executable
+16
@@ -0,0 +1,16 @@
|
|||||||
|
#!/usr/bin/env sh
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
if [ ! -f .env ]; then
|
||||||
|
echo "missing .env" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
set -a
|
||||||
|
. ./.env
|
||||||
|
set +a
|
||||||
|
|
||||||
|
./scripts/configure-broker-user-profile.sh
|
||||||
|
./scripts/set-first-broker-login-mode.sh secure
|
||||||
|
npm --prefix google-e2e ci
|
||||||
|
npm --prefix google-e2e run test:claim-mapping
|
||||||
Executable
+18
@@ -0,0 +1,18 @@
|
|||||||
|
#!/usr/bin/env sh
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
set -a
|
||||||
|
. ./.env
|
||||||
|
set +a
|
||||||
|
|
||||||
|
./scripts/configure-broker-user-profile.sh >/dev/null
|
||||||
|
./scripts/set-first-broker-login-mode.sh secure
|
||||||
|
|
||||||
|
docker compose exec -T keycloak \
|
||||||
|
/opt/keycloak/bin/kcadm.sh create roles -r keycloak-patterns \
|
||||||
|
-s name=employee-role \
|
||||||
|
-s 'description=Assigned from the upstream hd claim' >/dev/null 2>&1 || true
|
||||||
|
|
||||||
|
cd google-e2e
|
||||||
|
npm install --ignore-scripts
|
||||||
|
npm run test:claim-to-role
|
||||||
Executable
+24
@@ -0,0 +1,24 @@
|
|||||||
|
#!/usr/bin/env sh
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
realm="${KEYCLOAK_REALM:-keycloak-patterns}"
|
||||||
|
public_keycloak_url="${PUBLIC_KEYCLOAK_URL:-https://auth.example.test}"
|
||||||
|
expected="$public_keycloak_url/realms/$realm/broker/google/endpoint"
|
||||||
|
|
||||||
|
case "$public_keycloak_url" in
|
||||||
|
https://*) ;;
|
||||||
|
*)
|
||||||
|
echo "PUBLIC_KEYCLOAK_URL must use https outside the local mock environment" >&2
|
||||||
|
exit 1
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
case "$public_keycloak_url" in
|
||||||
|
*\** | */)
|
||||||
|
echo "PUBLIC_KEYCLOAK_URL must be an exact origin without wildcard/trailing slash" >&2
|
||||||
|
exit 1
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
test "$expected" = "https://auth.example.test/realms/keycloak-patterns/broker/google/endpoint"
|
||||||
|
echo "Google redirect URI policy verified: $expected"
|
||||||
Executable
+39
@@ -0,0 +1,39 @@
|
|||||||
|
#!/usr/bin/env sh
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
compose_file=${COMPOSE_FILE:-docker-compose.yml}
|
||||||
|
|
||||||
|
python3 scripts/validate-realm.py
|
||||||
|
./scripts/verify-stack.sh
|
||||||
|
|
||||||
|
curl --fail --silent --show-error --output /dev/null \
|
||||||
|
"http://localhost:8080/realms/keycloak-patterns/.well-known/openid-configuration"
|
||||||
|
|
||||||
|
docker compose -f "$compose_file" exec -T keycloak sh -ec '
|
||||||
|
kcadm=/opt/keycloak/bin/kcadm.sh
|
||||||
|
"$kcadm" config credentials \
|
||||||
|
--server http://localhost:8080 \
|
||||||
|
--realm master \
|
||||||
|
--user "$KC_BOOTSTRAP_ADMIN_USERNAME" \
|
||||||
|
--password "$KC_BOOTSTRAP_ADMIN_PASSWORD" >/dev/null
|
||||||
|
|
||||||
|
clients=$("$kcadm" get clients -r keycloak-patterns --fields clientId)
|
||||||
|
for client in \
|
||||||
|
spa-public \
|
||||||
|
token-mediating-confidential \
|
||||||
|
bff-confidential \
|
||||||
|
edge-proxy
|
||||||
|
do
|
||||||
|
printf "%s" "$clients" | grep -q "\"$client\""
|
||||||
|
done
|
||||||
|
|
||||||
|
users=$("$kcadm" get users -r keycloak-patterns --fields username)
|
||||||
|
printf "%s" "$users" | grep -q "\"admin-user\""
|
||||||
|
printf "%s" "$users" | grep -q "\"regular-user\""
|
||||||
|
|
||||||
|
roles=$("$kcadm" get roles -r keycloak-patterns --fields name)
|
||||||
|
printf "%s" "$roles" | grep -q "\"admin-role\""
|
||||||
|
printf "%s" "$roles" | grep -q "\"user-role\""
|
||||||
|
'
|
||||||
|
|
||||||
|
echo "realm verified: import, discovery, four clients, two roles, two users"
|
||||||
Executable
+18
@@ -0,0 +1,18 @@
|
|||||||
|
#!/usr/bin/env sh
|
||||||
|
set -eu
|
||||||
|
|
||||||
|
config=deploy/reverse-proxy/nginx-keycloak.conf
|
||||||
|
env_file=deploy/reverse-proxy/keycloak.env.example
|
||||||
|
|
||||||
|
grep -q 'proxy_set_header X-Forwarded-Host' "$config"
|
||||||
|
grep -q 'proxy_set_header X-Forwarded-Port 443' "$config"
|
||||||
|
grep -q 'proxy_set_header X-Forwarded-Proto https' "$config"
|
||||||
|
grep -q '^KC_PROXY_HEADERS=xforwarded$' "$env_file"
|
||||||
|
grep -q '^KC_HOSTNAME=https://' "$env_file"
|
||||||
|
|
||||||
|
docker run --rm \
|
||||||
|
--add-host keycloak:127.0.0.1 \
|
||||||
|
-v "$PWD/$config:/etc/nginx/conf.d/default.conf:ro" \
|
||||||
|
nginx:1.29-alpine nginx -t
|
||||||
|
|
||||||
|
echo "Reverse-proxy header and Keycloak hostname contracts verified"
|
||||||
Reference in New Issue
Block a user