Browse Source

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.
Nick Mathewson 3 years ago
parent
commit
7c6a8c674b
2 changed files with 6 additions and 2 deletions
  1. 4 0
      changes/bug28979
  2. 2 2
      doc/tor.1.txt

+ 4 - 0
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".

+ 2 - 2
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