supercop

Basic CLI for supercop
git clone git://git.finwo.net/app/supercop
Log | Files | Refs | README | LICENSE

README.md (1840B)

      1 # NAME
      2 
      3 supercop - Simplified CLI for supercop-ref10
      4 
      5 # SYNOPSIS
      6 
      7 **supercop** \[*global options*\] *command* \[*command options*\]\
      8 **supercop** **list-commands**\
      9 **supercop** **\--version**
     10 
     11 # DESCRIPTION
     12 
     13 This program allows easy signing and signature verification for the
     14 supercop-ref10 implementation of the ed25519 signature scheme.
     15 
     16 Global options must appear before the command name. Run **supercop**
     17 *command* **\--help** for the details on a single command.
     18 
     19 # GLOBAL OPTIONS
     20 
     21 **-h, \--help**
     22 
     23 :   Show usage and exit
     24 
     25 **-V, \--version**
     26 
     27 :   Show version number and exit (same as **supercop version**)
     28 
     29 # COMMANDS
     30 
     31 **generate \[**-k** *keyfile*\]**
     32 
     33 :   Generate a new key, writing to keyfile or stdout
     34 
     35 **printkey **-k** *keyfile***
     36 
     37 :   Print contents of key file
     38 
     39 **sign **-k** *keyfile* \[**-m** *message* \| **-M** *message-file*\]**
     40 
     41 :   Sign a message
     42 
     43 **verify **-k** *keyfile* **-s** *signature* \[**-m** *message* \| **-M** *message-file*\]**
     44 
     45 :   Verify a message signature
     46 
     47 **version**
     48 
     49 :   Show version number and exit (same as **supercop \--version**)
     50 
     51 **list-commands**
     52 
     53 :   List available commands
     54 
     55 # COMMAND OPTIONS
     56 
     57 **-k, \--key-file *path***
     58 
     59 :   Select key file to use for the operation
     60 
     61 **-m, \--message *message_string***
     62 
     63 :   Message to sign or verify (defaults to stdin)
     64 
     65 **-M, \--message-file *path***
     66 
     67 :   Message file to sign or verify (defaults to stdin)
     68 
     69 **-s, \--signature *signature_string***
     70 
     71 :   Signature to verify the message against
     72 
     73 # RETURN VALUE
     74 
     75 Here are the possible return values:
     76 
     77 > -   **0 Everything went fine or the signature was valid**
     78 >
     79 > -   **1 Signature was invalid or an error occurred, see stderr for an
     80 >     explanation**
     81 
     82 # ENVIRONMENT
     83 
     84 supercop doesn\'t follow any environment variables
     85 
     86 # FILES
     87 
     88 supercop uses no configuration files
     89 
     90 # AUTHOR
     91 
     92 finwo (https://finwo.nl)