Skip to content

Commit 621a8ef

Browse files
committed
document pomerium-cli client cert functionality
1 parent f2e639e commit 621a8ef

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

content/docs/capabilities/tcp.mdx

+18
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,24 @@ pomerium-cli tcp tcp+https://proxy.corp.example.com:8443/redis.internal.example.
113113

114114
The command above connects to `https://pomerium.corp.example.com:8443` and then requests the TCP route for `redis.internal.example.com:6379`.
115115

116+
### Client Certificates
117+
118+
If Pomerium is configured to require client certificates, you will also need to provide a client certificate and private key when invoking the `pomerium-cli` command.
119+
120+
You can specify these either by using PEM files, or (starting in v0.23) by searching for a certificate in the system trust store (on macOS and Windows only).
121+
122+
To specify a client certificate and key using PEM files:
123+
124+
```bash
125+
pomerium-cli tcp --client-cert cert.pem --client-key key.pem redis.corp.example.com:6379
126+
```
127+
128+
To search for a client certificate in the system trust store you will need to specify the Common Name of the client certificate's issuer:
129+
130+
```bash
131+
pomerium-cli tcp --client-cert-issuer-cn "intermediate CA T1" redis.corp.example.com:6379
132+
```
133+
116134
## Service-Specific Documentation
117135

118136
We've outlined how to use a TCP tunnel through Pomerium for several popular services that use TCP connections:

content/docs/capabilities/tcp/reference.md

+1
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ pomerium-cli tcp [destination] [flags]
2525
| <a className="entRef-anchor" id="--ca-cert">#</a><a href='#--ca-cert'>--ca-cert</a> | Path to CA certificate to use for HTTP requests. | string |
2626
| <a className="entRef-anchor" id="--client-cert">#</a><a href='#--client-cert'>--client-cert</a> | (optional) PEM-encoded client certificate. | string |
2727
| <a className="entRef-anchor" id=" --client-key">#</a><a href='# --client-key'> --client-key</a> | (optional) PEM-encoded client certificate key. | string |
28+
| <a className="entRef-anchor" id="--client-cert-issuer-cn">#</a><a href='#--client-cert-issuer-cn'> --client-cert-issuer-cn</a> | (optional) If provided, pomerium-cli will attempt to use a client certificate from the system trust store (macOS and Windows only), searching for a certificate whose Issuer matches the provided Common Name. | string |
2829
| <a className="entRef-anchor" id=" --disable-tls-verification">#</a><a href='# --disable-tls-verification'>--disable-tls-verification</a> | Disables TLS verification. | none |
2930
| <a className="entRef-anchor" id="--help">#</a><a href='#--help'>-h, --help</a> | Help for tcp. | none |
3031
| <a className="entRef-anchor" id="--listen">#</a><a href='#--listen'>--listen</a> | Local address to start a listener on (default "127.0.0.1:0"). | string |

0 commit comments

Comments
 (0)