Skip to content

Commit 6ddee41

Browse files
committed
updates signign key settings
1 parent 0863691 commit 6ddee41

File tree

4 files changed

+22
-63
lines changed

4 files changed

+22
-63
lines changed

content/docs/reference/reference.json

+4-4
Original file line numberDiff line numberDiff line change
@@ -532,7 +532,7 @@
532532
"shared-secret": {
533533
"id": "shared-secret",
534534
"title": "Shared Secret",
535-
"path": "/shared-secret-settings#shared-secret",
535+
"path": "/shared-secret",
536536
"description": "Shared Secret is the base64-encoded, 256-bit key used to mutually authenticate requests between services.",
537537
"services": [],
538538
"type": "string",
@@ -541,7 +541,7 @@
541541
"shared-secret-file": {
542542
"id": "shared-secret-file",
543543
"title": "Shared Secret File",
544-
"path": "/shared-secret-settings#shared-secret-file",
544+
"path": "/shared-secret#shared-secret-file",
545545
"description": "File path containing base64-encoded shared secret.",
546546
"services": [],
547547
"type": "string",
@@ -1476,7 +1476,7 @@
14761476
"signing-key": {
14771477
"id": "signing-key",
14781478
"title": "Signing Key",
1479-
"path": "/signing-key-settings#signing-key",
1479+
"path": "/signing-key",
14801480
"description": "Signing Key is the key used to sign a user's attestation JWT which can be consumed by upstream applications to pass along identifying user information like username, id, and groups.",
14811481
"services": [],
14821482
"type": "string",
@@ -1485,7 +1485,7 @@
14851485
"signing-key-file": {
14861486
"id": "signing-key-file",
14871487
"title": "Signing Key File",
1488-
"path": "/signing-key-settings#signing-key-file",
1488+
"path": "/signing-key",
14891489
"description": "File path to a secret containing the signing key, used to sign a user's attestation JWT which can be consumed by upstream applications to pass along identifying user information like username, id, and groups.",
14901490
"services": [],
14911491
"type": "string",

content/docs/reference/shared-secret.mdx

+1-3
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,7 @@ toc_max_heading_level: 2
1313
import Tabs from '@theme/Tabs';
1414
import TabItem from '@theme/TabItem';
1515

16-
# Shared Secret Settings
17-
18-
## Shared Secret
16+
# Shared Secret
1917

2018
**Shared Secret** is the base64-encoded, 256-bit key used to mutually authenticate requests between Pomerium services. It's critical that secret keys are random, and stored safely.
2119

content/docs/reference/signing-key.mdx

+15-54
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
# cSpell:ignore ecparam genkey noout QCN7adG2AmIK3UdHJvVJkldsUc6XeBRz83Z4rXX8Va4 ary66nrvA55TpaiWADq8b3O1CYIbvjqIHpXCY
33

4-
id: signing-key-settings
5-
title: Signing Key Settings
4+
id: signing-key
5+
title: Signing Key
66
sidebar_label: Signing Key Settings
77
description: |
88
This page discusses the signing key settings Pomerium uses to sign the Pomerium JWT that's sent to upstream services to verify a user's identity.
@@ -17,20 +17,19 @@ toc_max_heading_level: 2
1717
import Tabs from '@theme/Tabs';
1818
import TabItem from '@theme/TabItem';
1919

20-
# Signing Key Settings
21-
22-
## Signing Key
20+
# Signing Key
2321

2422
**Signing Key** is one or more PEM-encoded private keys used to sign a user's attestation JWT, which can be consumed by upstream applications to pass along identifying user information like username, id, and groups.
2523

26-
### How to configure
24+
## How to configure
2725

2826
<Tabs>
2927
<TabItem value="Core" label="Core">
3028

3129
| **Config file keys** | **Environment variables** | **Type** | **Usage** |
3230
| :------------------- | :------------------------ | :------- | :----------- |
3331
| `signing_key` | `SIGNING_KEY` | `string` | **optional** |
32+
| `signing_key_file` | `SIGNING_KEY_FILE` | `string` | **optional** |
3433

3534
</TabItem>
3635
<TabItem value="Enterprise" label="Enterprise">
@@ -49,6 +48,16 @@ See Kubernetes [bootstrap secrets](/docs/k8s/reference#spec) for more informatio
4948
</TabItem>
5049
</Tabs>
5150

51+
## Examples
52+
53+
```yaml
54+
signing_key: LS0tLS1CRUdJTiBFQyBQUklWQVRFIEtFWS0tLS0tCk1IY0NBUUVFSUNUWHlVQ0phYmlHTW1wd3VqYlBmWHhNS2MzWjNFM0tEcmlEbmQwZktiTmtvQW9HQ0NxR1NNNDkKQXdFSG9VUURRZ0FFM1FYQmZ1eEV1UEhJT0ZDb3RaaXBOMUFqM3UrOUtFRWd4RFVURW9CcjYxYXpaYWFvYlRGbwo0cGY3WFRSbzVhM2U2aDdKUW9wckp4QSszd0dwTUpSYWl3PT0KLS0tLS1FTkQgRUMgUFJJVkFURSBLRVktLS0tLQo=
55+
```
56+
57+
```bash
58+
SIGNING_KEY_FILE='/run/secrets/POMERIUM_SIGNING_KEY'
59+
```
60+
5261
### How to use signing key
5362

5463
If set, the signing key's public key(s) can be retrieved by hitting Pomerium's well-known JWKS endpoint:
@@ -105,51 +114,3 @@ To implement key rotation, follow a 3-step process:
105114
3. Remove the old key from the list.
106115

107116
With sufficient time between the steps, this process should be resilient to caching of the JWKS endpoint by applications.
108-
109-
## Signing Key File
110-
111-
**Signing Key File** is the path to a file containing a [Signing Key](#signing-key).
112-
113-
The signing key is the private key used to sign a user's attestation JWT, which can be consumed by upstream applications to pass along identifying user session information such as username, id, and groups.
114-
115-
See [Signing Key](#signing-key) for more information.
116-
117-
### How to configure
118-
119-
<Tabs>
120-
<TabItem value="Core" label="Core">
121-
122-
| **Config file keys** | **Environment variables** | **Type** | **Usage** |
123-
| :------------------- | :------------------------ | :------- | :----------- |
124-
| `signing_key_file` | `SIGNING_KEY_FILE` | `string` | **optional** |
125-
126-
### Examples
127-
128-
Signing Key File is useful when deploying in environments that provide secret management like [Docker Swarm](https://docs.docker.com/engine/swarm/secrets/).
129-
130-
For example:
131-
132-
```yaml
133-
signing_key_file: '/run/secrets/POMERIUM_SIGNING_KEY'
134-
```
135-
136-
```bash
137-
SIGNING_KEY_FILE='/run/secrets/POMERIUM_SIGNING_KEY'
138-
```
139-
140-
</TabItem>
141-
<TabItem value="Enterprise" label="Enterprise">
142-
143-
`signing_key_file` is a bootstrap configuration setting and is not configurable in the Console.
144-
145-
</TabItem>
146-
<TabItem value="Kubernetes" label="Kubernetes">
147-
148-
| **Name** | **Type** | **Usage** |
149-
| :-------------------- | :------- | :----------- |
150-
| `secrets.signing_key` | `string` | **optional** |
151-
152-
See Kubernetes [bootstrap secrets](/docs/k8s/reference#spec) for more information.
153-
154-
</TabItem>
155-
</Tabs>

static/_redirects

+2-2
Original file line numberDiff line numberDiff line change
@@ -463,8 +463,8 @@ https://0-20-0.docs.pomerium.com/category/guides https://0-20-0.docs.pomerium.co
463463
/docs/reference/the-number-of-trusted-hops /docs/reference/x-forwarded-for-settings#xff-number-of-trusted-hops
464464

465465
# Signing Key settings
466-
/docs/reference/signing-key /docs/reference/signing-key-settings#signing-key
467-
/docs/reference/signing-key-file /docs/reference/signing-key-settings#signing-key-file
466+
/docs/reference/signing-key /docs/reference/signing-key
467+
/docs/reference/signing-key-file /docs/reference/signing-key
468468

469469
# Shared Secret settings
470470
/docs/reference/shared-secret /docs/reference/shared-secret-settings#shared-secret

0 commit comments

Comments
 (0)