[tor-commits] [tor/maint-0.3.5] Fix documentation for ClientAuth on HSv3.

[nickm at torproject.org]

commit 7c6a8c674bd563bf4b33e05a7267a5ec74b79170
Author: Nick Mathewson <nickm at torproject.org>
Date:   Wed Jan 16 16:05:54 2019 -0500

    Fix documentation for ClientAuth on HSv3.
    
    The manpage erroneously said "privkey" when "public-key" would have
    been correct.  Reported by "Felixix" as ticket 28979. Bugfix on
    0.3.5.1-alpha.
---
 changes/bug28979 | 4 ++++
 doc/tor.1.txt    | 4 ++--
 2 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/changes/bug28979 b/changes/bug28979
new file mode 100644
index 000000000..0625fd5d2
--- /dev/null
+++ b/changes/bug28979
@@ -0,0 +1,4 @@
+  o Minor bugfixes (documentation):
+    - Describe the contents of the v3 onion service client authorization
+      files correctly: They hold public keys, not private keys. Fixes bug
+      28979; bugfix on 0.3.5.1-alpha. Spotted by "Felixix".
diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index 581783dd6..573fdf221 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -2950,8 +2950,8 @@ file name is irrelevant) and its content format MUST be:
         <auth-type>:<key-type>:<base32-encoded-public-key>
 
 The supported <auth-type> are: "descriptor". The supported <key-type> are:
-"x25519". The <base32-encoded-privkey> is the base32 representation of the raw
-key bytes only (32 bytes for x25519).
+"x25519". The <base32-encoded-public-key> is the base32 representation of
+the raw key bytes only (32 bytes for x25519).
 
 Each file MUST contain one line only. Any malformed file will be
 ignored. Client authorization will only be enabled for the service if tor