keybase / keybase-issues

A single repo for managing publicly recognized issues with the keybase client, installer, and website.
900 stars 37 forks source link

Inconsistent assertion documentation vs command line client #449

Open francois opened 10 years ago

francois commented 10 years ago

The docs at https://keybase.io/__/command_line/keybase don't match what the command line client offers:

$ cat HandDrawnWeb_icon_set.zip | keybase encrypt chris -o HandDrawnWeb_icon_set.zip.asc --assert fingerprint:FBC07D6A97016CB4
info: ...checking identity proofs
error: unknown assertion type: fingerprint

$ cat HandDrawnWeb_icon_set.zip | keybase encrypt chris -o HandDrawnWeb_icon_set.zip.asc --assert keybase:chris
info: ...checking identity proofs
error: unknown assertion type: keybase
Projects ruby-1.9.3-p327$ keybase encrypt --help
usage: keybase encrypt [-h] [-r] [-l] [-a ASSERT] [--batch] [--prompt-remote]
                       [-s] [-m MESSAGE] [-b] [-o OUTPUT]
                       them [file]

Positional arguments:
  them                  the username of the receiver
  file                  the file to be encrypted

Optional arguments:
  -h, --help            Show this help message and exit.
  -r, --track-remote    remotely track by default
  -l, --track-local     don't prompt for remote tracking
  -a ASSERT, --assert ASSERT
                        provide a key assertion
  --batch               batch-mode without interactivity
  --prompt-remote       prompt for remote tracking
  -s, --sign            sign in addition to encrypting
  -m MESSAGE, --message MESSAGE
                        provide the message on the command line
  -b, --binary          output in binary (rather than ASCII/armored)
  -o OUTPUT, --output OUTPUT
                        the output file to write the encryption to

The assertions keybase and fingerprint return an error message. The help message does not mention the actual assertions that are available. After reading the source code, I see fingerprint was renamed to key. I can't find the keybase assertion anymore.

gene1wood commented 8 years ago

The web documentation has been updated to reflect how the keybase client now handles assertions

website

# Here we encrypt a copy of a backup for
# maria, asserting that she's proven her key on both
# twitter and github. Both must pass.
#
# This is unnecessary if we've tracked maria, as the command
# will fail if anything about her identity breaks.
cat some_backup.sql | keybase pgp encrypt -o enc_backup.asc \
  maria_2354@twitter+maria_booyeah@github+maria@keybase'

cli help

)$ keybase encrypt --help
NAME:
   keybase encrypt - Encrypt messages or files for keybase users

USAGE:
   keybase encrypt [command options] <usernames...>

OPTIONS:
   -b, --binary     Output in binary (rather than ASCII/armored).
   -i, --infile     Specify an input file.
   -m, --message    Provide the message on the command line.
   -o, --outfile    Specify an outfile (stdout by default).
   --hide-recipients    Don't include recipients in metadata
   --no-self        Don't encrypt for yourself