doc: Indicate -rpcauth option password hashing alg #14741

pull dongcarl wants to merge 1 commits into bitcoin:master from dongcarl:2018-11-improve-rpcauth-help changing 1 files +1 −1
  1. dongcarl commented at 2:02 AM on November 17, 2018: member

    By indicating the password hashing algorithm, users of bitcoin distributions without the script in share/rpcauth and users who don't want to rely on said script can use alternative means to generate the password hash.

    Question for reviewers: perhaps we should also indicate that it is specifically a HMAC-SHA-256 of the UTF-8 encoding of their password?

  2. fanquake added the label Docs on Nov 17, 2018
  3. in doc/man/bitcoind.1:533 in 914ff8e148 outdated
     529 | @@ -530,7 +530,7 @@ option can be specified multiple times
     530 |  .HP
     531 |  \fB\-rpcauth=\fR<userpw>
     532 |  .IP
     533 | -Username and hashed password for JSON\-RPC connections. The field
     534 | +Username and HMAC-SHA-256 hashed password for JSON\-RPC connections. The field
    


    MarcoFalke commented at 4:49 PM on November 17, 2018:

    No need to modify these files., they are autogenerated.


    dongcarl commented at 6:15 PM on November 17, 2018:

    Oh? If they're autogenerated then why are they version controlled?


    MarcoFalke commented at 4:45 PM on November 18, 2018:
  4. dongcarl force-pushed on Nov 19, 2018
  5. dongcarl commented at 4:49 PM on November 19, 2018: member

    Fixed.

  6. laanwj commented at 3:40 PM on November 21, 2018: member

    utACK

    Question for reviewers: perhaps we should also indicate that it is specifically a HMAC-SHA-256 of the UTF-8 encoding of their password?

    Maybe in some more detailed spec document, but I don't think the option help is a place to go into such detail. It's consistent with the use of UTF-8 throughout the entire application. Mentioning it for the specific option might make people think "then where should I not use UTF-8?".

  7. DrahtBot commented at 3:42 AM on November 22, 2018: member

    <!--e57a25ab6845829454e8d69fc972939a-->

    The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

    <!--174a7506f384e20aa4161008e828411d-->

    Conflicts

    Reviewers, this pull request conflicts with the following ones:

    • #14532 (Never bind INADDR_ANY by default, and warn when doing so explicitly by luke-jr)

    If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

  8. DrahtBot added the label Needs rebase on Nov 22, 2018
  9. Indicate -rpcauth option password hashing alg dcb70b1522
  10. dongcarl force-pushed on Nov 24, 2018
  11. DrahtBot removed the label Needs rebase on Nov 24, 2018
  12. ryanofsky approved
  13. ryanofsky commented at 8:07 PM on December 4, 2018: member

    utACK dcb70b152292a8df9fe834bacdf231ea848819b1. Could add doc: or [doc] prefix to PR description to indicate this a documentation-only change.

  14. dongcarl renamed this:
    Indicate -rpcauth option password hashing alg
    doc: Indicate -rpcauth option password hashing alg
    on Dec 5, 2018
  15. fanquake commented at 7:42 AM on December 13, 2018: member

    utACK dcb70b1

  16. laanwj merged this on Dec 13, 2018
  17. laanwj closed this on Dec 13, 2018

  18. laanwj referenced this in commit 9c477c990c on Dec 13, 2018
  19. jasonbcox referenced this in commit 99dc88273f on Oct 26, 2020
  20. Munkybooty referenced this in commit 3a30140064 on Aug 8, 2021
  21. Munkybooty referenced this in commit 92aaa689c6 on Aug 11, 2021
  22. Munkybooty referenced this in commit af79e43a74 on Aug 11, 2021
  23. Munkybooty referenced this in commit 2f6b680e1d on Aug 13, 2021
  24. Munkybooty referenced this in commit 1e4234b6ab on Aug 15, 2021
  25. MarcoFalke locked this on Sep 8, 2021

github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2026-04-22 18:14 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me