Make rpcauth help message clearer, add example in example .conf #9401

pull instagibbs wants to merge 1 commits into bitcoin:master from instagibbs:rpcauthnotes changing 2 files +23 −2

instagibbs commented at 2:57 PM on December 21, 2016: member

Some users are confused about the interplay of the three different ways of authenticating rpc requests. This is meant to give extra clarity.
Make rpcauth help message clearer, add example in example .conf 0513c707aa
jonasschnelli added the label Docs and Output on Dec 21, 2016
in contrib/debian/examples/bitcoin.conf:None in 0513c707aa
```
  66 | @@ -67,9 +67,30 @@
  67 |  # This option can be specified multiple times (default: bind to all interfaces)
  68 |  #rpcbind=<addr>
  69 |  
  70 | -# You must set rpcuser and rpcpassword to secure the JSON-RPC api
  71 | +# If no rpcpassword is set, rpc cookie auth is sought. The default `-rpccookiefile` name
```
instagibbs commented at 12:57 AM on December 22, 2016:

Note: cookie is only created if -server=1

laanwj commented at 12:25 PM on December 22, 2016:

Do you imagine any reason why it would be otherwise?

instagibbs commented at 12:30 PM on December 22, 2016:

No, but more than one user was apparently confused by this!(getting feedback offline) Maybe it's too obvious.

in src/init.cpp:None in 0513c707aa

 483 | @@ -484,7 +484,7 @@ std::string HelpMessage(HelpMessageMode mode)
 484 |      strUsage += HelpMessageOpt("-rpccookiefile=<loc>", _("Location of the auth cookie (default: data dir)"));
 485 |      strUsage += HelpMessageOpt("-rpcuser=<user>", _("Username for JSON-RPC connections"));
 486 |      strUsage += HelpMessageOpt("-rpcpassword=<pw>", _("Password for JSON-RPC connections"));
 487 | -    strUsage += HelpMessageOpt("-rpcauth=<userpw>", _("Username and hashed password for JSON-RPC connections. The field <userpw> comes in the format: <USERNAME>:<SALT>$<HASH>. A canonical python script is included in share/rpcuser. This option can be specified multiple times"));
 488 | +    strUsage += HelpMessageOpt("-rpcauth=<userpw>", _("Username and hashed password for JSON-RPC connections. The field <userpw> comes in the format: <USERNAME>:<SALT>$<HASH>. A canonical python script is included in share/rpcuser. The client then connects normally using the rpcuser=<USERNAME>/rpcpassword=<PASSWORD> pair of arguments. This option can be specified multiple times"));

MarcoFalke commented at 11:55 AM on January 4, 2017:

Could make sense to split the translation string into smaller logical chunks while touching?

MarcoFalke commented at 11:58 AM on January 4, 2017: member

ACK 0513c707aa1e356bc4da609bf0263cc684b0d6e3
MarcoFalke merged this on Jan 4, 2017
MarcoFalke closed this on Jan 4, 2017
MarcoFalke referenced this in commit c2ea1e6561 on Jan 4, 2017
codablock referenced this in commit 125adda41a on Jan 18, 2018
andvgal referenced this in commit 53703e114b on Jan 6, 2019
CryptoCentric referenced this in commit a2a9dd634d on Feb 26, 2019
MarcoFalke locked this on Sep 8, 2021

Contributors

Labels