doc: Rewrite shell example to not leave secrets in the history file #8441

pull paveljanik wants to merge 1 commits into bitcoin:0.13 from paveljanik:patch-17 changing 1 files +5 −1

paveljanik commented at 8:28 AM on August 1, 2016: contributor

Variant to #8436.
paveljanik cross-referenced this on Aug 1, 2016 from issue Add warning about shell history file by paveljanik
paveljanik commented at 8:30 AM on August 1, 2016: contributor

... will squash in a minute ...

in doc/release-notes.md:None in 5661847920 outdated

  62 | @@ -63,6 +63,10 @@ For example:
  63 |  
  64 |      $ echo -e "mysecretcode\n120" | src/bitcoin-cli -stdin walletpassphrase
  65 |  
  66 | +Warning: when used as described, the command line (including your secret
  67 | +walletpassphrase) will be stored in your shell history file. Modify your
  68 | +command line or your shell settings to prevent it.
  69 | +
  70 |  It is recommended to use this for sensitive information such as wallet

laanwj commented at 8:31 AM on August 1, 2016:

I don't think this quite connects with the next paragraph anymore..

paveljanik force-pushed on Aug 1, 2016
laanwj commented at 8:38 AM on August 1, 2016: member

I think this warning should be separate, at the end of the section. It might be worthwhile to add it, as a reminder, but commands possibly ending up in shell history is nothing new. It has nothing to do with this functionality change.

paveljanik commented at 8:47 AM on August 1, 2016: contributor

What about dropping echo instead?

    $ src/bitcoin-cli -stdin walletpassphrase
    mysecretcode
    120
    Ctrl+D
    $

laanwj commented at 6:01 AM on August 2, 2016: member

That's fine with me. Make sure that the Ctrl-D stands out as a key action, not as literally typing Ctrl-D.
Rewrite shell example to not leave secrets in the history file 719208c66f
paveljanik force-pushed on Aug 2, 2016
paveljanik commented at 7:09 AM on August 2, 2016: contributor

Done. I'm open for better "stand out" for Ctrl-D :-)
laanwj renamed this:
~~Add warning about shell history file~~
doc: Rewrite shell example to not leave secrets in the history file
on Aug 2, 2016
laanwj cross-referenced this on Aug 2, 2016 from issue Update release-notes.md by jwilkins
laanwj added the label Docs and Output on Aug 2, 2016
sipa commented at 11:06 PM on August 2, 2016: member

utACK 719208c66f2df124cdf542ae80c2f99563fa7851
MarcoFalke commented at 7:14 AM on August 3, 2016: member

utACK 719208c
laanwj merged this on Aug 3, 2016
laanwj closed this on Aug 3, 2016
laanwj referenced this in commit 6c083ac95c on Aug 3, 2016
bitcoin locked this on Sep 8, 2021

Contributors

Labels

Linked (view graph)

#8436 Update release-notes.md #8440 Add warning about shell history file