tsick.1 - sick - sign and check files using ed25519
 (HTM) git clone git://z3bra.org/sick
 (DIR) Log
 (DIR) Files
 (DIR) Refs
 (DIR) README
 (DIR) LICENSE
       ---
       tsick.1 (2457B)
       ---
            1 .Dd 2016-05-03
            2 .Dt SICK 1
            3 .Os POSIX.1-2008
            4 .Sh NAME
            5 .Nm sick
            6 .Nd sign/check files using ed25519 signatures
            7 .Sh SYNOPSIS
            8 .Nm sick
            9 .Op Fl astv
           10 .Op Fl g Ar ALIAS
           11 .Op Fl f Ar KEY
           12 .Sh DESCRIPTION
           13 .Nm
           14 generates key pairs, signs, checks and remove signatures for a file or stream.
           15 .Sh OPTIONS
           16 .Bl -tag -width "-g ALIAS"
           17 The default action is to check the signature appended to the message given on
           18 stdin. If the signature can be verified, the message will be written to stdout
           19 without the signature. If the
           20 .Fl f
           21 flag is not specified on the command line, all files in the
           22 .Ev KEYRING
           23 directory will be tried to verify the message.
           24 .It Fl a
           25 Deal with armored signature. The signature are base64 encoded, wrapped
           26 at 76 characters and surrounded with two context lines. See
           27 .Sx SIGNATURE FORMAT
           28 For more information on the signature format.
           29 .It Fl s
           30 Make
           31 .Nm
           32 perform a signing operation on the current stream. This will append the base64
           33 encoded signature to the stream and dump them both to stdout. See
           34 .Sx SIGNATURE FORMAT
           35 for information on what will be appended to the stream.
           36 .It Fl t
           37 Make
           38 .Nm
           39 trim the signature at the end of the stream if there is one, and write the
           40 message to stdout. If there is no signature, the whole stream gets written.
           41 .It Fl v
           42 Enable verbose mode.
           43 .Nm
           44 will log informative messages to stderr.
           45 .It Fl g Ar ALIAS
           46 Generates an ed25519 key pairs: `ALIAS.key` and `ALIAS.pub`
           47 .It Fl f Ar KEY
           48 Specifies the key file to be used for the current operation (sign or check).
           49 .Sh SIGNATURE FORMAT
           50 ed25519 signatures are 64 bytes long. For easier reading in text/plain format,
           51 .Nm
           52 can base64 encode them (see
           53 .Fl a
           54 flag) prior to appending them to stdout. The base64 signature is wrapped
           55 at 76 bytes as specified by POSIX uuencode. In order to make it easier
           56 to detect the signature, it will be wrapped between two lines, as follows:
           57 .Bd -literal
           58         -----BEGIN ED25519 SIGNATURE-----
           59         base64 encoded signature
           60         -----END ED25519 SIGNATURE-----
           61 .Ed
           62 .El
           63 .Sh ENVIRONMENT
           64 .Bl -tag -width "KEYRING"
           65 .It Ev KEYRING
           66 Location of the keyring directory
           67 .El
           68 .Sh EXAMPLES
           69 .Bd -literal
           70 Generating a key pair:
           71   sick -g $USER
           72 .Ed
           73 .Pp
           74 Signing a stream:
           75 .Bd -literal
           76   sick -f ${USER}.key < FILE > SIGNED
           77 .Ed
           78 .Pp
           79 Checking a signed file (FILE will be empty if the signature doesn't match the
           80 public key):
           81 .Bd -literal
           82   sick -f ${USER}.pub SIGNED > FILE
           83 .Ed
           84 .Sh SEE ALSO
           85 .Xr ed25519 7 ,
           86 .Xr base64 1 ,
           87 .Xr uuencode 1
           88 .Sh AUTHORS
           89 .An Willy Goiffon Aq Mt dev@z3bra.org