Skip to content

docs: Clarify requirements about kids in the secrets.keys config #4807

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 23, 2025
Merged

docs: Clarify requirements about kids in the secrets.keys config #4807

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5587dd3
docs: Remove requirement for arbitrary KIDs
V02460 Jul 21, 2025
2ecc502
Adapt markdown formatting
V02460 Jul 23, 2025
da94650
Fix wording
V02460 Jul 23, 2025
858b388
KIDs must be stable across restarts
V02460 Jul 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/reference/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,8 +257,11 @@ The following key types are supported:
- ECDSA with the P-384 (`secp384r1`) curve
- ECDSA with the K-256 (`secp256k1`) curve

Each entry must have a unique (and arbitrary) `kid`, plus the key itself.
The key can either be specified inline (with the `key` property), or loaded from a file (with the `key_file` property).
Each entry must have a unique `kid`, plus the key itself.
The `kid` can be any case-sensitive string value as long as it is unique to this list;
`kid` values don’t need to be stable across restarts.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is actually not true? If we issue an id_token and change the kid of the key that was used to sign it, the client won't be able to verify it

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I hope this is better now?

The key can either be specified inline (with the `key` property),
or loaded from a file (with the `key_file` property).
The following key formats are supported:

- PKCS#1 PEM or DER-encoded RSA private key
Expand Down
Loading