Skip to content

Commit ad1fd20

Browse files
authored
tls: synced the description of the client/server mutual tls auth config setup (#162)
Signed-off-by: Hofi <[email protected]>
2 parents d76380a + 1f9461c commit ad1fd20

File tree

2 files changed

+35
-33
lines changed

2 files changed

+35
-33
lines changed

doc/_admin-guide/100_TLS-encrypted_message_transfer/002_Mutual_authentication_using_TLS/000_Configuring_mutual_TLS_client.md

+17-14
Original file line numberDiff line numberDiff line change
@@ -17,28 +17,28 @@ syslog() driver):
1717
1. Create an X.509 certificate for the {{ site.product.short_name }} client.
1818

1919
2. Copy the certificate (for example, client_cert.pem) and the
20-
matching private key (for example, client.key) to the syslog-ng
20+
matching private key (for example, client.key) to the {{ site.product.short_name }}
2121
client host, for example, into the
2222
/opt/syslog-ng/etc/syslog-ng/cert.d directory. The certificate must
23-
be a valid X.509 certificate in PEM format. If you want to use a
24-
password-protected key, see
25-
Password-protected keys.
23+
be a valid X.509 certificate in PEM format. The key must be in PEM format.
24+
If you want to use a password-protected key, see Password-protected keys.
2625

27-
3. Copy the CA certificate of the Certificate Authority (for example,
28-
cacert.pem) that issued the certificate of the {{ site.product.short_name }} server (or
29-
the self-signed certificate of the {{ site.product.short_name }} server) to the
30-
{{ site.product.short_name }} client hosts, for example, into the
26+
3. Copy the CA certificate (for example, cacert.pem) of the Certificate
27+
Authority that issued the certificate of the {{ site.product.short_name }} server
28+
(or the self-signed certificate of the {{ site.product.short_name }} server) to the
29+
{{ site.product.short_name }} client host, for example, into the
3130
/opt/syslog-ng/etc/syslog-ng/ca.d directory.
3231

33-
Issue the following command on the certificate: **openssl x509
34-
-noout -hash -in cacert.pem** The result is a hash (for example,
32+
If you wish to use the ca-dir() option, instead of the ca-file(), in the
33+
{{ site.product.short_name }} configuration file (step 4.) then
34+
- issue the following command on the certificate:\
35+
`openssl x509 -noout -hash -in cacert.pem`\
36+
The result is a hash (for example,
3537
6d2962a8), a series of alphanumeric characters based on the
3638
Distinguished Name of the certificate.
37-
38-
Issue the following command to create a symbolic link to the
39+
- issue the following command to create a symbolic link to the
3940
certificate that uses the hash returned by the previous command and
40-
the **.0** suffix.
41-
41+
the **.0** suffix:\
4242
`ln -s cacert.pem 6d2962a8.0`
4343

4444
4. Add a destination statement to the {{ site.product.short_name }} configuration file that
@@ -49,6 +49,9 @@ syslog() driver):
4949
Include the client\'s certificate and private key in the tls()
5050
options.
5151

52+
For the details of the available tls() options, see
53+
TLS options.
54+
5255
Example: A destination statement using mutual authentication
5356

5457
The following destination encrypts the log messages using TLS and

doc/_admin-guide/100_TLS-encrypted_message_transfer/002_Mutual_authentication_using_TLS/001_Configuring_mutual_TLS_server.md

+18-19
Original file line numberDiff line numberDiff line change
@@ -11,38 +11,37 @@ Complete the following steps on the {{ site.product.short_name }} server:
1111

1212
## Steps
1313

14-
1. Copy the certificate (for example, syslog-ng.cert) of the syslog-ng
15-
server to the {{ site.product.short_name }} server host, for example, into the
14+
1. Create an X.509 certificate for the {{ site.product.short_name }} server.
15+
16+
2. Copy the certificate (for example, syslog-ng.cert) and the
17+
matching private key (for example, syslog-ng.key) to the {{ site.product.short_name }}
18+
server host, for example, into the
1619
/opt/syslog-ng/etc/syslog-ng/cert.d directory. The certificate must
17-
be a valid X.509 certificate in PEM format.
20+
be a valid X.509 certificate in PEM format. The key must be in PEM format.
21+
If you want to use a password-protected key, see Password-protected keys.
1822

19-
2. Copy the CA certificate (for example, cacert.pem) of the Certificate
23+
3. Copy the CA certificate (for example, cacert.pem) of the Certificate
2024
Authority that issued the certificate of the {{ site.product.short_name }} clients to
21-
the {{ site.product.short_name }} server, for example, into the
25+
the {{ site.product.short_name }} server host, for example, into the
2226
/opt/syslog-ng/etc/syslog-ng/ca.d directory.
2327

24-
Issue the following command on the certificate: **openssl x509
25-
-noout -hash -in cacert.pem** The result is a hash (for example,
28+
If you wish to use the ca-dir() option, instead of the ca-file(), in the
29+
{{ site.product.short_name }} configuration file (step 4.) then
30+
- issue the following command on the certificate:\
31+
`openssl x509 -noout -hash -in cacert.pem`\
32+
The result is a hash (for example,
2633
6d2962a8), a series of alphanumeric characters based on the
2734
Distinguished Name of the certificate.
28-
29-
Issue the following command to create a symbolic link to the
35+
- issue the following command to create a symbolic link to the
3036
certificate that uses the hash returned by the previous command and
31-
the **.0** suffix.
32-
37+
the **.0** suffix:\
3338
`ln -s cacert.pem 6d2962a8.0`
3439

35-
3. Copy the private key (for example, syslog-ng.key) matching the
36-
certificate of the {{ site.product.short_name }} server to the {{ site.product.short_name }} server host,
37-
for example, into the /opt/syslog-ng/etc/syslog-ng/key.d directory.
38-
The key must be in PEM format. If you want to use a
39-
password-protected key, see Password-protected keys.
40-
4140
4. Add a source statement to the {{ site.product.short_name }} configuration file that uses
4241
the tls( key-file(key_file_fullpathname)
4342
cert-file(cert_file_fullpathname) ) option and specify the key and
4443
certificate files. The source must use the source driver (network()
45-
or syslog()) matching the destination driver used by the syslog-ng
44+
or syslog()) matching the destination driver used by the {{ site.product.short_name }}
4645
client. Also specify the directory storing the certificate of the CA
4746
that issued the client's certificate.
4847

@@ -52,7 +51,7 @@ Complete the following steps on the {{ site.product.short_name }} server:
5251
Example: A source statement using TLS
5352

5453
The following source receives log messages encrypted using TLS,
55-
arriving to the 1999/TCP port of any interface of the syslog-ng
54+
arriving to the 1999/TCP port of any interface of the {{ site.product.short_name }}
5655
server.
5756

5857
```config

0 commit comments

Comments
 (0)