grim/josetool

Update the docs
draft
2017-02-08, Gary Kramlich
987cf4ed2d05
Parents b34b5deb7edd
Children 873b3c223b66
Update the docs
1 files changed, 57 insertions(+), 10 deletions(-)
  • +57 -10
    README.md
    • --- a/README.md Wed Feb 08 01:33:48 2017 +0000
    +++ b/README.md Wed Feb 08 01:39:31 2017 +0000
    @@ -1,24 +1,71 @@
    -# jwkgen
    +# josetool
    -A simple tool to generate JWK's.
    +A simple tool to for working with JWK's.
    ## Usage
    - usage: jwkgen [<flags>] <command> [<args> ...]
    + usage: josetool [<flags>] <command> [<args> ...]
    - generates jwk's
    + jwk utilities
    Flags:
    - --help Show context-sensitive help (also try --help-long and --help-man).
    - -i, --key-id=KEY-ID the key id to use
    - -u, --use=sig how this key will be used
    -
    + --help Show context-sensitive help (also try --help-long and --help-man).
    +
    Commands:
    help [<command>...]
    Show help.
    + ecdsa [<flags>] [<curve>]
    + generate an ecdsa key
    +
    rsa [<flags>] [<bits>]
    generate an rsa key
    - ecdsa [<flags>] [<curve>]
    - generate an ecdsa key
    + sign [<flags>] <key>
    + creates a jwt for the given inputs
    +
    +## RSA
    +
    + usage: josetool rsa [<flags>] [<bits>]
    +
    + generate an rsa key
    +
    + Flags:
    + --help Show context-sensitive help (also try --help-long and --help-man).
    + -a, --algorithm=RS256 the algorithm to use
    + -i, --key-id=KEY-ID the key id to use
    + -u, --use=sig how this key will be used
    + -f, --filename="-" the base filename to output the key to
    +
    + Args:
    + [<bits>] the number of bits for the key
    +
    +## ECDSA
    +
    + usage: josetool ecdsa [<flags>] [<curve>]
    +
    + generate an ecdsa key
    +
    + Flags:
    + --help Show context-sensitive help (also try --help-long and --help-man).
    + -a, --algorithm=ES256 the algorithm to use
    + -i, --key-id=KEY-ID the key id to use
    + -u, --use=sig how this key will be used
    + -f, --filename="-" the base filename to output the key to
    +
    + Args:
    + [<curve>] the curve to use
    +
    +## Sign
    +
    + usage: josetool sign [<flags>] <key>
    +
    + creates a jwt for the given inputs
    +
    + Flags:
    + --help Show context-sensitive help (also try --help-long and --help-man).
    + -H, --header=HEADER ... header to include in the jwt in key=val format
    + -c, --claim=CLAIM ... claims to include in the jwt in key=val format
    +
    + Args:
    + <key> the name of the file that contains the private jwk