Skip to content

Commit 448bd14

Browse files
committed
Update web-configuration docs
Signed-off-by: fayzal-g <[email protected]>
1 parent 953f8e3 commit 448bd14

File tree

2 files changed

+24
-6
lines changed

2 files changed

+24
-6
lines changed

docs/web-configuration.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,24 @@ Generic placeholders are defined as follows:
2323

2424
```
2525
tls_server_config:
26+
# Certificate for server to use to authenticate to client.
27+
# Expected to be passed as a PEM encoded sequence of bytes as a string.
28+
#
29+
# NOTE: When passing the cert inline, cert_file should not be specified below.
30+
cert: <string>
31+
32+
# Key for server to use to authenticate to client.
33+
# Expected to be passed as a PEM encoded sequence of bytes as a string.
34+
#
35+
# NOTE: When passing the key inline, key_file should not be specified below.
36+
key: <secret>
37+
38+
# CA certificate for client certificate authentication to the server.
39+
# Expected to be passed as a PEM encoded sequence of bytes as a string.
40+
#
41+
# NOTE: When passing the client_ca inline, client_ca_file should not be specified below.
42+
[ client_ca: <string> ]
43+
2644
# Certificate and key files for server to use to authenticate to client.
2745
cert_file: <filename>
2846
key_file: <filename>
@@ -37,14 +55,14 @@ tls_server_config:
3755
3856
# CA certificate for client certificate authentication to the server.
3957
[ client_ca_file: <filename> ]
40-
41-
# Verify that the client certificate has a Subject Alternate Name (SAN)
42-
# which is an exact match to an entry in this list, else terminate the
43-
# connection. SAN match can be one or multiple of the following: DNS,
58+
59+
# Verify that the client certificate has a Subject Alternate Name (SAN)
60+
# which is an exact match to an entry in this list, else terminate the
61+
# connection. SAN match can be one or multiple of the following: DNS,
4462
# IP, e-mail, or URI address from https://pkg.go.dev/crypto/x509#Certificate.
4563
[ client_allowed_sans:
4664
[ - <string> ] ]
47-
65+
4866
# Minimum TLS version that is acceptable.
4967
[ min_version: <string> | default = "TLS12" ]
5068

web/testdata/web_config_noAuth_tlsInline.good.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,4 +86,4 @@ tls_server_config:
8686
SmOyiSdaAyXHr/6+3KgO5pX8YUn9WiTF2hxo4SG3NQuuva0SBZT9B8iFXt1uFUtP
8787
Rri7hsjysanKPyaPM1oofbRyWApMyRo=
8888
-----END PRIVATE KEY-----
89-
client_auth_type: "VerifyClientCertIfGiven"
89+
client_auth_type: "VerifyClientCertIfGiven"

0 commit comments

Comments
 (0)