Skip to content

Commit 49d1281

Browse files
committed
docs(scripts): client_credentials is the norm; mark cookie/KeyfactorProxy as HV3-specific
The register README presented cookie auth as 'the common case' using the HV3 lab (intdev01.lab.kfpki.com) host/paths. Reframe: OAuth2 client_credentials against /KeyfactorAPI is the typical path; cookie + /KeyfactorProxy + the /certinext-0 instance path are HV3-deployment-specific, not the norm.
1 parent b760cc8 commit 49d1281

1 file changed

Lines changed: 25 additions & 12 deletions

File tree

scripts/register/README.md

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -69,22 +69,35 @@ Three ways to authenticate, resolved per side (gateway vs Command) in this order
6969
| `CONFIGURATION_TENANT` | stages 04–06 | **= the gateway instance name** (e.g. `certinext-0`), which is also the templates' `ConfigurationTenant` in Command. Not the plugin name. |
7070
| `CURL_INSECURE` | all | `1` (default) passes `-k`; set `0` to verify TLS |
7171

72-
## Quick start (cookie auth — the common case)
72+
## Quick start
73+
74+
The **typical** path is OAuth2 client_credentials against `/KeyfactorAPI`:
7375

7476
```sh
75-
# --- gateway side ---
76-
export GATEWAY_HOST=intdev01.lab.kfpki.com
77-
export GATEWAY_BASE_PATH=/certinext-0
78-
export GATEWAY_COOKIE="$(tr -d '\r\n' < ~/.certinext_gw_cookie)"
79-
make register-profiles # stage 01 (add CHECK=1 to verify, DRY_RUN=1 to preview)
80-
81-
# --- command side (after you've imported templates) ---
82-
export COMMAND_HOST=intdev01.lab.kfpki.com
83-
export CONFIGURATION_TENANT=certinext-0
84-
export COMMAND_COOKIE="$(tr -d '\r\n' < ~/.certinext_kfcportal_cookie)"
85-
make register-enrollment # stage 06: patterns + KeyRetention=Indefinite
77+
export GATEWAY_HOST=<gw-host> COMMAND_HOST=<cmd-host>
78+
export TOKEN_URL=https://<auth>/application/o/token/
79+
export OIDC_CLIENT_ID=... OIDC_CLIENT_SECRET=...
80+
make register-profiles # client_creds used automatically (no cookie/token set)
8681
```
8782

83+
> **Cookie auth (e.g. the "HV3" lab, intdev01.lab.kfpki.com)** — used when ops
84+
> can't issue client credentials. This is environment-specific, NOT the norm:
85+
> the gateway instance path is `/certinext-0` (not `/AnyGatewayREST`), and a
86+
> Command Portal cookie only works via `/KeyfactorProxy` (auto-selected when
87+
> `COMMAND_COOKIE` is set). See the deployment's own notes for its values.
88+
>
89+
> ```sh
90+
> # gateway side
91+
> export GATEWAY_HOST=intdev01.lab.kfpki.com GATEWAY_BASE_PATH=/certinext-0
92+
> export GATEWAY_COOKIE="$(tr -d '\r\n' < ~/.certinext_gw_cookie)"
93+
> make register-profiles # CHECK=1 to verify, DRY_RUN=1 to preview
94+
>
95+
> # command side (after templates imported)
96+
> export COMMAND_HOST=intdev01.lab.kfpki.com CONFIGURATION_TENANT=certinext-0
97+
> export COMMAND_COOKIE="$(tr -d '\r\n' < ~/.certinext_kfcportal_cookie)"
98+
> make register-enrollment # stage 06: patterns + KeyRetention=Indefinite
99+
> ```
100+
88101
Per-stage env knobs are documented in each script's header comment.
89102
90103
## Stage 02 — gateway CA config (verified 2026-06-09)

0 commit comments

Comments
 (0)