supercop

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

supercop.1 (2273B)


      1 .TH supercop 1 "" "" "FINWO"
      2 
      3 .SH NAME
      4 supercop - Simplified CLI for supercop-ref10
      5 
      6 .SH SYNOPSIS
      7 \fBsupercop\fR [\fIglobal options\fR] \fIcommand\fR [\fIcommand options\fR]
      8 .br
      9 \fBsupercop\fR \fBlist-commands\fR
     10 .br
     11 \fBsupercop\fR \fB--version\fR
     12 
     13 .SH DESCRIPTION
     14 This program allows easy signing and signature verification for the supercop-ref10 implementation of the ed25519 signature scheme.
     15 
     16 Global options must appear before the command name. Run \fBsupercop\fR \fIcommand\fR \fB--help\fR for the details on a single command.
     17 
     18 .SH GLOBAL OPTIONS
     19 .TP
     20 .B \-h, \-\-help
     21 Show usage and exit
     22 .TP
     23 .B \-V, \-\-version
     24 Show version number and exit (same as \fBsupercop version\fR)
     25 
     26 .SH COMMANDS
     27 .TP
     28 .B generate\fR [\fIoptions\fR]
     29 Generate a new key, writing to keyfile or stdout
     30 .TP
     31 .B printkey\fR [\fIoptions\fR]
     32 Print contents of key file, optionally converting formats
     33 .TP
     34 .B sign\fR \fB-k\fR \fIkeyfile\fR [\fB-m\fR \fImessage\fR | \fB-M\fR \fImessage-file\fR]
     35 Sign a message
     36 .TP
     37 .B verify\fR \fB-k\fR \fIkeyfile\fR \fB-s\fR \fIsignature\fR [\fB-m\fR \fImessage\fR | \fB-M\fR \fImessage-file\fR]
     38 Verify a message signature
     39 .TP
     40 .B version
     41 Show version number and exit (same as \fBsupercop --version\fR)
     42 .TP
     43 .B list-commands
     44 List available commands
     45 
     46 .SH COMMAND OPTIONS
     47 .TP
     48 .B \-k, \-\-key\-file\fR \fIpath\fR
     49 Select key file to use for the operation
     50 .TP
     51 .B \-m, \-\-message\fR \fImessage_string\fR
     52 Message to sign or verify (defaults to stdin)
     53 .TP
     54 .B \-M, \-\-message\-file\fR \fIpath\fR
     55 Message file to sign or verify (defaults to stdin)
     56 .TP
     57 .B \-s, \-\-signature\fR \fIsignature_string\fR
     58 Signature to verify the message against
     59 .TP
     60 .B \-f, \-\-format\fR \fIname\fR
     61 Key format for generate output or printkey conversion: 0x00, asc, hdr
     62 .TP
     63 .B \-o, \-\-out\fR \fIpath\fR
     64 Write printkey output to file instead of stdout
     65 .TP
     66 .B \-\-public\-only
     67 Output only the public half of the key (printkey)
     68 
     69 .SH RETURN VALUE
     70 Here are the possible return values:
     71 .RS
     72 .IP \(bu 2
     73 .B 0 \fR Everything went fine or the signature was valid
     74 .IP \(bu 2
     75 .B 1 \fR Signature was invalid or an error occurred, see stderr for an explanation
     76 .RE
     77 
     78 .SH ENVIRONMENT
     79 supercop doesn't follow any environment variables
     80 
     81 .SH FILES
     82 supercop uses no configuration files
     83 
     84 .SH AUTHOR
     85 finwo  (https://finwo.nl)