Browse Source

fix #1798

Improve documentation for use of certificate fingerprints
tags/v2.8.0
Shivaram Lingamneni 2 years ago
parent
commit
050e27b31b
2 changed files with 7 additions and 4 deletions
  1. 2
    0
      docs/USERGUIDE.md
  2. 5
    4
      irc/nickserv.go

+ 2
- 0
docs/USERGUIDE.md View File

@@ -75,6 +75,8 @@ Once you have registered your account, you must configure SASL in your client, s
75 75
 
76 76
 If your client doesn't support SASL, you can typically use the "server password" (`PASS`) field in your client to log into your account automatically when connecting. Set the server password to `accountname:accountpassword`, where `accountname` is your account name and `accountpassword` is your account password.
77 77
 
78
+For information on how to use a client certificate for authentication, see the [operator manual](https://github.com/ergochat/ergo/blob/stable/docs/MANUAL.md#client-certificates).
79
+
78 80
 # Channel registration
79 81
 
80 82
 Once you've registered your nickname, you can use it to register channels. By default, channels are ephemeral; they go away when there are no longer any users in the channel, or when the server is restarted. Registering a channel gives you permanent control over it, and ensures that its settings will persist. To register a channel, send a message to `ChanServ`:

+ 5
- 4
irc/nickserv.go View File

@@ -354,12 +354,13 @@ the result of a previous $bSENDPASS$b command.`,
354 354
 			handler: nsCertHandler,
355 355
 			help: `Syntax: $bCERT <LIST | ADD | DEL> [account] [certfp]$b
356 356
 
357
-CERT examines or modifies the TLS certificate fingerprints that can be used to
358
-log into an account. Specifically, $bCERT LIST$b lists the authorized
359
-fingerprints, $bCERT ADD <fingerprint>$b adds a new fingerprint, and
357
+CERT examines or modifies the SHA-256 TLS certificate fingerprints that can
358
+be used to log into an account. Specifically, $bCERT LIST$b lists the
359
+authorized fingerprints, $bCERT ADD <fingerprint>$b adds a new fingerprint, and
360 360
 $bCERT DEL <fingerprint>$b removes a fingerprint. If you're an IRC operator
361 361
 with the correct permissions, you can act on another user's account, for
362
-example with $bCERT ADD <account> <fingerprint>$b.`,
362
+example with $bCERT ADD <account> <fingerprint>$b. See the operator manual
363
+for instructions on how to compute the fingerprint.`,
363 364
 			helpShort: `$bCERT$b controls a user account's certificate fingerprints`,
364 365
 			enabled:   servCmdRequiresAuthEnabled,
365 366
 			minParams: 1,

Loading…
Cancel
Save