doc: explain what the wallet password does #28974

pull BrandonOdiwuor wants to merge 1 commits into bitcoin:master from BrandonOdiwuor:wallet_passphrase changing 1 files +16 −0
  1. BrandonOdiwuor commented at 4:54 pm on November 30, 2023: contributor

    Fixes #18085

    Add a document explaining what the wallet passphrase does

  2. DrahtBot commented at 4:54 pm on November 30, 2023: contributor

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

    Code Coverage

    For detailed information about the code coverage, see the test coverage report.

    Reviews

    See the guideline for information on the review process.

    Type Reviewers
    ACK fjahr, achow101

    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 Nov 30, 2023
  4. fanquake requested review from achow101 on Nov 30, 2023
  5. in doc/wallet-passphrase.md:6 in f40d359677 outdated 
    0@@ -0,0 +1,21 @@
1+## Wallet Passphrase
2+
3+Understanding the nuances of wallet security is essential to storing your Bitcoin safely. One crucial aspect of safeguarding funds is the utilization of a wallet passphrase or password, implemented through wallet encryption introduced in Bitcoin Core [v0.4.0](https://github.com/bitcoin/bitcoin/blob/master/doc/release-notes/release-notes-0.4.0.md). Let's explore key points to demystify the nature of a wallet passphrase and the encryption process, emphasizing what they do and what they don't do:
4+
5+  - **Not the Seed:**
6+The wallet passphrase is distinct from the seed phrase (recovery phrase). The seed phrase is a crucial backup that can be used to restore access to your wallet and recover your funds. The passphrase, on the other hand, is an additional layer of security specific to secure the private keys in the wallet. Anybody who discovers a wallet's seed phrase can steal all the bitcoins if the seed isn't also protected by a secret passphrase.
    MarnixCroes commented at 8:04 pm on November 30, 2023:
    What do you mean with seed phrase/recovery phrase? I think you’re confused with BIP39, which is not in Bitcoin Core
    luke-jr commented at 3:04 am on December 5, 2023:
    There is no seed phrase.
    BrandonOdiwuor commented at 3:39 pm on December 5, 2023:
    fixed
    BrandonOdiwuor commented at 3:39 pm on December 5, 2023:
    fixed
  6. in doc/wallet-passphrase.md:3 in f40d359677 outdated 
    0@@ -0,0 +1,21 @@
1+## Wallet Passphrase
2+
3+Understanding the nuances of wallet security is essential to storing your Bitcoin safely. One crucial aspect of safeguarding funds is the utilization of a wallet passphrase or password, implemented through wallet encryption introduced in Bitcoin Core [v0.4.0](https://github.com/bitcoin/bitcoin/blob/master/doc/release-notes/release-notes-0.4.0.md). Let's explore key points to demystify the nature of a wallet passphrase and the encryption process, emphasizing what they do and what they don't do:
    luke-jr commented at 3:02 am on December 5, 2023:
    No need to say “introduced in” especially since v0.4.0 was not Bitcoin Core in any meaningful way
    BrandonOdiwuor commented at 3:39 pm on December 5, 2023:
    fixed
  7. in doc/wallet-passphrase.md:12 in f40d359677 outdated 
     7+
 8+- **Limited Protection Against Physical Threats:**
 9+While the wallet passphrase provides security in the digital realm, it doesn't safeguard against physical threats (like someone using a $5 wrench to force you to reveal your passphrase). Physical security measures are also equally important, and users should be cautious about where and how they access their wallets.
10+
11+- **Protection Against Unauthorized Access:**
12+The passphrase helps protect your funds in scenarios where a stranger gains access to your unlocked computer or device while your wallet application is running. Without the passphrase, an unauthorized user would be unable to access the wallet's funds or perform transactions.
    luke-jr commented at 3:05 am on December 5, 2023:
    Someone with such access can just install a keylogger.
    BrandonOdiwuor commented at 3:39 pm on December 5, 2023:
    fixed
  8. luke-jr changes_requested
  9. BrandonOdiwuor force-pushed on Dec 5, 2023
  10. BrandonOdiwuor marked this as ready for review on Dec 5, 2023
  11. BrandonOdiwuor requested review from MarnixCroes on Dec 5, 2023
  12. BrandonOdiwuor requested review from luke-jr on Dec 5, 2023
  13. in doc/wallet-passphrase.md:6 in 43464b1625 outdated 
    0@@ -0,0 +1,21 @@
1+## Wallet Passphrase
2+
3+Understanding the nuances of wallet security is essential to storing your Bitcoin safely. One crucial aspect of safeguarding funds is the utilization of a wallet passphrase or password, implemented through wallet encryption. Let's explore key points to demystify the nature of a wallet passphrase and the encryption process, emphasizing what they do and what they don't do:
4+
5+  - **Not the Seed:**
6+The wallet passphrase is distinct from the seed. The seed, also known as the HD seed, functions as a master key for deriving key pairs in a hierarchical deterministic (HD) wallet. The passphrase, on the other hand, serves as an additional layer of security, specifically designed to secure the private keys within the wallet. While the HD seed is essential for wallet restoration and fund recovery, the passphrase serves as a safeguard, demanding an additional layer of authentication even if the seed is compromised. This dual-layered approach enhances overall wallet security, effectively mitigating risks associated with unauthorized access and potential theft.
    achow101 commented at 6:33 pm on December 5, 2023:
    We should avoid portraying the seed as something that is recommended for restoring a wallet. The seed is not easily exported and doing so is not a recommended method of backing up a wallet. Also not all encrypted wallets will have a seed, and not all private keys in a wallet are necessarily derived from the same seed, if derived at all.
    BrandonOdiwuor commented at 3:22 pm on December 12, 2023:
    Fixed
  14. BrandonOdiwuor force-pushed on Dec 12, 2023
  15. BrandonOdiwuor requested review from achow101 on Dec 12, 2023
  16. DrahtBot added the label CI failed on Dec 12, 2023
  17. maflcko commented at 11:19 am on December 14, 2023: member

    I wonder if this should instead be put in the GUI window and RPC help for the encrypt action, otherwise it seems easy to miss?

    The GUI spreads the information over three pop-up windows, which doesn’t seem great, when it can be put into just one Window.

  18. in doc/wallet-passphrase.md:8 in 3bc8041aa2 outdated 
    0@@ -0,0 +1,21 @@
1+## Wallet Passphrase
2+
3+Understanding the nuances of wallet security is essential to storing your Bitcoin safely. One crucial aspect of safeguarding funds is the utilization of a wallet passphrase or password, implemented through wallet encryption. Let's explore key points to demystify the nature of a wallet passphrase and the encryption process, emphasizing what they do and what they don't do:
4+
5+  - **Not the Seed:**
6+The wallet passphrase is distinct from the seed. The seed, also known as the HD seed, functions as a master key for deriving key pairs in a hierarchical deterministic (HD) wallet. The passphrase on the other hand, serves as an additional layer of security specifically designed to secure the private keys within the wallet. While the HD seed is essential for deriving private and public keys in the wallet, the passphrase serves as a safeguard, demanding an additional layer of authentication to access funds on the wallet. This dual-layered approach enhances overall wallet security, effectively mitigating risks associated with unauthorized access and potential theft.
7+
8+- **Limited Protection Against Physical Threats:**
    fjahr commented at 5:19 pm on February 18, 2024:
    I don’t think this is very relevant, even though it was suggested in the original issue.
    BrandonOdiwuor commented at 9:38 am on April 22, 2024:
    removed
  19. in doc/wallet-passphrase.md:5 in 3bc8041aa2 outdated 
    0@@ -0,0 +1,21 @@
1+## Wallet Passphrase
2+
3+Understanding the nuances of wallet security is essential to storing your Bitcoin safely. One crucial aspect of safeguarding funds is the utilization of a wallet passphrase or password, implemented through wallet encryption. Let's explore key points to demystify the nature of a wallet passphrase and the encryption process, emphasizing what they do and what they don't do:
4+
5+  - **Not the Seed:**
    fjahr commented at 5:19 pm on February 18, 2024:
    I think this part can be shortened a lot.
    BrandonOdiwuor commented at 9:39 am on April 22, 2024:
    fixed
  20. fjahr commented at 5:26 pm on February 18, 2024: contributor
    I would integrate this into the managing wallets doc rather than creating a new file. I also agree with @maflcko that putting this information into the users’ path makes sense but I think this can still be added in the docs. It may not be enough to close the issue or maybe there should be a follow-up issue giving more detail.
  21. maflcko commented at 5:33 pm on April 17, 2024: member
    Are you still working on this?
  22. BrandonOdiwuor force-pushed on Apr 22, 2024
  23. BrandonOdiwuor commented at 9:46 am on April 22, 2024: contributor
    @fjahr I have integrated wallet-passphrase doc into managing-wallets doc. Regarding #28974#pullrequestreview-1887288612, I had created a follow up PR #29245 (which was closed) @maflcko is #29245 close to your suggestion on #28974 (comment)
  24. BrandonOdiwuor requested review from fjahr on Apr 22, 2024
  25. DrahtBot removed the label CI failed on Apr 22, 2024
  26. BrandonOdiwuor force-pushed on Apr 22, 2024
  27. in doc/managing-wallets.md:133 in d07557d003 outdated 
    128+
129+- **Not the Seed:**
130+The wallet passphrase and the seed are two separate components in wallet security. The seed, or HD seed, functions as a master key for deriving private and public keys in a hierarchical deterministic (HD) wallet. In contrast, the passphrase serves as an additional layer of security specifically designed to secure the private keys within the wallet. The passphrase serves as a safeguard, demanding an additional layer of authentication to access funds in the wallet.
131+
132+- **Protection Against Unauthorized Access:**
133+The passphrase serves as a protective measure, securing your funds in situations where an unauthorized user gains access to your unlocked computer or device while your wallet application is active. Without the passphrase, they would be unable to access your wallet's funds or execute transactions. However, it's essential to be aware that someone with access can potentially compromise the security of your passphrase by installing a keylogger. To enhance security, prioritize good practices such as running up-to-date antivirus software, and inputting your wallet passphrase exclusively into the Bitcoin client
    fjahr commented at 12:33 pm on April 22, 2024:
    nit: I’m not sure if we need to give general IT security advice. I would probably remove that part.
    BrandonOdiwuor commented at 3:08 pm on April 22, 2024:
    removed
  28. in doc/managing-wallets.md:127 in d07557d003 outdated 
    121@@ -122,6 +122,22 @@ $ bitcoin-cli -rpcwallet="restored-wallet" getwalletinfo
122 
123 The restored wallet can also be loaded in the GUI via `File` ->`Open wallet`.
124 
125+## Wallet Passphrase
126+
127+Understanding the nuances of wallet security is essential to storing your Bitcoin safely. One crucial aspect of safeguarding funds is the utilization of a wallet passphrase or password implemented through wallet encryption. Let's explore key points to demystify the nature of a wallet passphrase and the encryption process, emphasizing what they do and what they don't do:
    fjahr commented at 12:33 pm on April 22, 2024:
    nit: This is extremely wordy, could be shortened to one sentence since this is just an intro.
    BrandonOdiwuor commented at 3:08 pm on April 22, 2024:
    fixed: summarised further
  29. fjahr approved
  30. fjahr commented at 12:37 pm on April 22, 2024: contributor

    ACK d07557d0038521f78baf3f1c94e1f282f51b8c1b

    Could still be condensed a bit more but this is alright.

  31. DrahtBot added the label CI failed on Apr 22, 2024
  32. doc: explain what the wallet password does 55b13ecd2e
  33. BrandonOdiwuor force-pushed on Apr 22, 2024
  34. BrandonOdiwuor requested review from fjahr on Apr 22, 2024
  35. fjahr commented at 3:29 pm on April 22, 2024: contributor
    ACK 55b13ecd2e00ad2dbfd44c34d7de6f616590adf8
  36. DrahtBot removed the label CI failed on Apr 23, 2024
  37. achow101 commented at 7:34 pm on April 23, 2024: member
    ACK 55b13ecd2e00ad2dbfd44c34d7de6f616590adf8
  38. achow101 merged this on Apr 23, 2024
  39. achow101 closed this on Apr 23, 2024


BrandonOdiwuor DrahtBot MarnixCroes luke-jr achow101 maflcko fjahr


luke-jr fjahr achow101 MarnixCroes

Labels
Docs

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: 2024-12-22 00:12 UTC
This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me