Skip to content

Commit 0bc7cf9

Browse files
committed
adds redirects and merges settings
1 parent fad7f69 commit 0bc7cf9

File tree

4 files changed

+61
-73
lines changed

4 files changed

+61
-73
lines changed

content/docs/reference/reference.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1476,7 +1476,7 @@
14761476
"signing-key": {
14771477
"id": "signing-key",
14781478
"title": "Signing Key",
1479-
"path": "/signing-key",
1479+
"path": "/signing-key-settings#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-file",
1488+
"path": "/signing-key-settings#signing-key-file",
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/signing-key-file.mdx

-65
This file was deleted.

content/docs/reference/signing-key.mdx

+55-6
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
22
# cSpell:ignore ecparam genkey noout QCN7adG2AmIK3UdHJvVJkldsUc6XeBRz83Z4rXX8Va4 ary66nrvA55TpaiWADq8b3O1CYIbvjqIHpXCY
33

4-
id: signing-key
5-
title: Signing Key
4+
id: signing-key-settings
5+
title: Signing Key Settings
6+
sidebar_label: Signing Key Settings
67
description: |
7-
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. If multiple keys are provided only the first will be used for signing.
8+
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.
89
keywords:
910
- reference
1011
- Signing Key
@@ -16,13 +17,13 @@ toc_max_heading_level: 2
1617
import Tabs from '@theme/Tabs';
1718
import TabItem from '@theme/TabItem';
1819

19-
# Signing Key
20+
# Signing Key Settings
2021

21-
## Summary
22+
## Signing Key
2223

2324
**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.
2425

25-
## How to configure
26+
### How to configure
2627

2728
<Tabs>
2829
<TabItem value="Core" label="Core">
@@ -104,3 +105,51 @@ To implement key rotation, follow a 3-step process:
104105
3. Remove the old key from the list.
105106

106107
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

+4
Original file line numberDiff line numberDiff line change
@@ -462,6 +462,10 @@ https://0-20-0.docs.pomerium.com/category/guides https://0-20-0.docs.pomerium.co
462462
/docs/reference/x-forwarded-for-http-header /docs/reference/x-forwarded-for-settings#skip-xff-append
463463
/docs/reference/the-number-of-trusted-hops /docs/reference/x-forwarded-for-settings#xff-number-of-trusted-hops
464464

465+
# 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
468+
465469
# Topics links - now concepts
466470
/docs/topics/auth-logs /docs/capabilities/audit-logs
467471
/docs/topics/single-sign-out.html /docs/capabilities/single-sign-out

0 commit comments

Comments
 (0)