This is an automated email from the ASF dual-hosted git repository.
symat pushed a commit to branch branch-3.5
in repository https://gitbox.apache.org/repos/asf/zookeeper.git
The following commit(s) were added to refs/heads/branch-3.5 by this push:
new 67bf0b1 ZOOKEEPER-3893: Enhance documentation for property
ssl.clientAuth
67bf0b1 is described below
commit 67bf0b1c918956b409105e813d133cea8d609576
Author: Sankalp Bhatia <[email protected]>
AuthorDate: Mon Aug 24 07:47:38 2020 +0000
ZOOKEEPER-3893: Enhance documentation for property ssl.clientAuth
Currently, the documentation for this property just mentions TBD (check
https://zookeeper.apache.org/doc/r3.5.7/zookeeperAdmin.html). I believe this
was ignored until versions 3.5.7
(https://issues.apache.org/jira/browse/ZOOKEEPER-3674) and a fix was made. It
will be good to add some documentation around it.
Author: Sankalp Bhatia <[email protected]>
Author: Sankalp <[email protected]>
Reviewers: Christopher Tubbs <[email protected]>, Enrico Olivelli
<[email protected]>, Mate Szalay-Beko <[email protected]>
Closes #1405 from sankalpbhatia/master
(cherry picked from commit fa846cbb70c031bdc126977d453dae1812b0012a)
Signed-off-by: Mate Szalay-Beko <[email protected]>
---
.../src/main/resources/markdown/zookeeperAdmin.md | 14 ++++++++++----
1 file changed, 10 insertions(+), 4 deletions(-)
diff --git a/zookeeper-docs/src/main/resources/markdown/zookeeperAdmin.md
b/zookeeper-docs/src/main/resources/markdown/zookeeperAdmin.md
index 6451933..96310ba 100644
--- a/zookeeper-docs/src/main/resources/markdown/zookeeperAdmin.md
+++ b/zookeeper-docs/src/main/resources/markdown/zookeeperAdmin.md
@@ -1046,12 +1046,18 @@ and [SASL authentication for
ZooKeeper](https://cwiki.apache.org/confluence/disp
**New in 3.5.5:**
Specifies whether Online Certificate Status Protocol is enabled in client
and quorum TLS protocols.
Default: false
-
+
* *ssl.clientAuth* and *ssl.quorum.clientAuth* :
(Java system properties: **zookeeper.ssl.clientAuth** and
**zookeeper.ssl.quorum.clientAuth**)
- **New in 3.5.5:**
- TBD
-
+ **Added in 3.5.5, but broken until 3.5.7:**
+ Specifies options to authenticate ssl connections from clients. Valid
values are
+
+ * "none": server will not request client authentication
+ * "want": server will "request" client authentication
+ * "need": server will "require" client authentication
+
+ Default: "need"
+
* *ssl.handshakeDetectionTimeoutMillis* and
*ssl.quorum.handshakeDetectionTimeoutMillis* :
(Java system properties: **zookeeper.ssl.handshakeDetectionTimeoutMillis**
and **zookeeper.ssl.quorum.handshakeDetectionTimeoutMillis**)
**New in 3.5.5:**
