Skip to content

Commit e27be61

Browse files
Update rabbitmq_auth_mechanism_ssl docs
References #12822
1 parent 5499d50 commit e27be61

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

Diff for: deps/rabbitmq_auth_mechanism_ssl/README.md

+18-3
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ present a client certificate.
1919

2020
This mechanism must also be enabled in RabbitMQ's configuration file,
2121
see [Authentication Mechanisms](https://www.rabbitmq.com/docs/access-control/) and
22-
[Configuration](https://www.rabbitmq.com/configure.html) guides for
22+
[Configuration](https://www.rabbitmq.com/docs/configure) guides for
2323
more details.
2424

2525
A couple of examples:
@@ -43,6 +43,21 @@ For safety the server must be configured with the SSL option 'verify'
4343
set to 'verify_peer', to ensure that if an SSL client presents a
4444
certificate, it gets verified.
4545

46+
### On Certificate Formats and Generation
47+
48+
RabbitMQ uses certificates and private keys in the PEM format. How they are generated
49+
is entirely up to the cluster operator. They can be obtained from a well-known and trusted
50+
commercial certificate authority or generated as "self-signed" (the CA will be project-specific
51+
and will not be widely trusted).
52+
53+
[`tls-gen`](https://github.com/rabbitmq/tls-gen) is a tool that can generate self-signed certificate chains:
54+
a CA, a CA certificate, zero or more intermediate certificates and a client or server (leaf) certificate.
55+
56+
Some of the examples below will use `openssl` CLI tools directly because of their widespread use.
57+
However, this plugin will work just fine with any x.509 standards compliant certificate in the PEM format,
58+
regardless of what tool has generated them.
59+
60+
4661
### Username Extraction from Certificate
4762

4863
#### Distinguished Name
@@ -101,12 +116,12 @@ ssl_cert_login_from = common_name
101116
```
102117

103118
Note that the authenticated user will then be looked up in the
104-
[configured authentication / authorisation backend(s)](https://www.rabbitmq.com/access-control.html). This will be
119+
[configured authentication / authorisation backend(s)](https://www.rabbitmq.com/docs/access-control). This will be
105120
the internal node database by default but could include other
106121
backends if so configured.
107122

108123
## Copyright & License
109124

110-
(c) 2007-2023 Broadcom. All Rights Reserved. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.
125+
(c) 2007-2024 Broadcom. All Rights Reserved. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.
111126

112127
Released under the same license as RabbitMQ.

0 commit comments

Comments
 (0)