Skip to content

Commit 34de580

Browse files
mohammed90francislavoie
authored andcommitted
verifiers: document leaf verifier and loaders
Signed-off-by: Mohammed Al Sahaf <[email protected]>
1 parent 2b58d64 commit 34de580

File tree

1 file changed

+36
-0
lines changed
  • src/docs/markdown/caddyfile/directives

1 file changed

+36
-0
lines changed

src/docs/markdown/caddyfile/directives/tls.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -266,6 +266,42 @@ The `http` module obtains the trusted certificates from HTTP endpoints. The `end
266266
- `once` allows a remote server to request renegotiation once per connection.
267267
- `freely` allows a remote server to repeatedly request renegotiation.
268268

269+
### Verifiers
270+
271+
Client certificate verifier modules are executed after validating they are issued from a trusted certificate authority, if the `trust_pool` is configured. The one verifier, currently, shipped in standard Caddy is `leaf`.
272+
273+
#### Leaf
274+
275+
The `leaf` verifier checks if the client certificate is one of a defined set of permitted certificates. The certificate set is loaded using [loader](https://caddyserver.com/docs/modules/tls.client_auth.verifier.leaf#leaf_certs_loaders) modules.
276+
277+
##### Loaders
278+
279+
Standard Caddy distribution bundles 4 loaders, 3 of them are available in Caddyfile.
280+
281+
###### File
282+
283+
The `file` loader loads the set of certificates from specified PEM files.
284+
285+
```caddy-d
286+
... file <pem_files...>
287+
```
288+
289+
###### Folder
290+
291+
The `folder` loader recursively traverses the named directories searching for PEM files to be loaded as accepted client certificates.
292+
293+
```caddy-d
294+
... folder <folders...>
295+
```
296+
297+
###### PEM
298+
299+
The `pem` loader accepts certificates inlined in the Caddyfile in PEM format.
300+
301+
```caddy-d
302+
... pem <pem_strings...>
303+
```
304+
269305
### Issuers
270306

271307
These issuers come standard with the `tls` directive:

0 commit comments

Comments
 (0)