docs: clarify RPC credentials security boundary #32424

pull crStiv wants to merge 1 commits into bitcoin:master from crStiv:ishak changing 1 files +12 −0
  1. crStiv commented at 9:40 am on May 6, 2025: none
    Explicitly states that RPC credentials grant full administrative access to the node and filesystem resources accessible by bitcoind. Adds a new section in JSON-RPC-interface.md to address issue #32274 by documenting that providing RPC credentials to untrusted clients
  2. DrahtBot commented at 9:40 am on May 6, 2025: contributor

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

    Code Coverage & Benchmarks

    For details see: https://corecheck.dev/bitcoin/bitcoin/pulls/32424.

    Reviews

    See the guideline for information on the review process.

    Type Reviewers
    ACK janb84
    Stale ACK davidgumberg

    If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

  3. DrahtBot added the label Docs on May 6, 2025
  4. in doc/JSON-RPC-interface.md:132 in ed862012f7 outdated
    127+  node and any filesystem resources the bitcoind process can access. For example,
    128+  clients can load wallet files from arbitrary paths that the bitcoind process
    129+  has permission to access, specify custom file paths for operations, and perform
    130+  any action available through the RPC interface. For these reasons, providing RPC
    131+  credentials to untrusted clients is equivalent to giving them full control of
    132+  the node and the same system privileges as the user running bitcoind. When
    


    janb84 commented at 6:23 pm on May 6, 2025:
    0  the node and the same system privileges as the operating system user account running bitcoind. When
    

    Small NIT, but fine to ignore

  5. janb84 commented at 6:31 pm on May 6, 2025: contributor

    ACK ed86201

    The updated documentation provides greater clarity on the security consequences of sharing RPC credentials.

  6. maflcko requested review from davidgumberg on May 6, 2025
  7. davidgumberg commented at 6:41 pm on May 6, 2025: contributor

    lgtm ACK https://github.com/bitcoin/bitcoin/pull/32424/commits/ed862012f747d4e5248f08ff25183dc666c3de6e

    I opened #32274 because I wasn’t sure if this status quo is desirable or not, but I believe this documentation note reflects the present expectations for bitcoind RPC servers.

  8. janb84 commented at 8:27 pm on May 6, 2025: contributor
    Please squash your commits
  9. Update JSON-RPC-interface.md
    Update doc/JSON-RPC-interface.md
    
    Co-Authored-By: Jan B <608446+janb84@users.noreply.github.com>
    348dc97608
  10. crStiv force-pushed on May 6, 2025
  11. crStiv commented at 9:14 pm on May 6, 2025: none

    Please squash your commits @janb84 yeah sure, np

  12. janb84 commented at 7:44 am on May 7, 2025: contributor

    reACK 348dc97

    Changes since last ACK:

    • Small textual change @crStiv thnx for incorporating my nit !

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: 2025-05-08 12:13 UTC

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