Return to signify.1 CVS log

Up to [local] / src / usr.bin / signify

Annotation of src/usr.bin/signify/signify.1, Revision 1.5

1.5     ! jmc         1: .\" $OpenBSD: signify.1,v 1.4 2013/12/31 17:33:17 jmc Exp $
1.1       tedu        2: .\"
                      3: .\"Copyright (c) 2013 Marc Espie <espie@openbsd.org>
                      4: .\"Copyright (c) 2013 Ted Unangst <tedu@openbsd.org>
                      5: .\"
                      6: .\"Permission to use, copy, modify, and distribute this software for any
                      7: .\"purpose with or without fee is hereby granted, provided that the above
                      8: .\"copyright notice and this permission notice appear in all copies.
                      9: .\"
                     10: .\"THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     11: .\"WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     12: .\"MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     13: .\"ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     14: .\"WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     15: .\"ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     16: .\"OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.2       tedu       17: .Dd $Mdocdate: December 31 2013 $
1.1       tedu       18: .Dt SIGNIFY 1
                     19: .Os
                     20: .Sh NAME
                     21: .Nm signify
                     22: .Nd cryptographically sign and verify files
                     23: .Sh SYNOPSIS
                     24: .Nm signify
1.4       jmc        25: .Op Fl N
1.1       tedu       26: .Op Fl I Ar input
                     27: .Op Fl O Ar output
                     28: .Op Fl P Ar pubkey
                     29: .Op Fl S Ar seckey
1.4       jmc        30: .Fl V Ar generate | sign | verify
1.1       tedu       31: .Sh DESCRIPTION
                     32: The
                     33: .Nm
                     34: utility creates and verifies cryptographic signatures.
1.4       jmc        35: The mode of operation is selected by the
                     36: .Fl V
1.1       tedu       37: option.
1.4       jmc        38: .Pp
                     39: The options are as follows:
                     40: .Bl -tag -width Ds
1.1       tedu       41: .It Fl I Ar input
1.4       jmc        42: Input file to sign or verify.
1.1       tedu       43: .It Fl N
                     44: Do not ask for a passphrase during key generation.
                     45: Otherwise,
                     46: .Nm
1.4       jmc        47: will prompt the user for a passphrase on the terminal.
1.1       tedu       48: .It Fl O Ar output
                     49: The signature file to create or verify.
                     50: The default is
1.5     ! jmc        51: .Ar input Ns .sig .
1.1       tedu       52: .It Fl P Ar pubkey
                     53: Public key produced by
                     54: .Ar generate ,
                     55: and used by
                     56: .Ar verify
                     57: to check a signature.
                     58: .It Fl S Ar seckey
                     59: Secret (private) key produced by
                     60: .Ar generate ,
                     61: and used by
                     62: .Ar sign
                     63: to sign a message.
1.4       jmc        64: .It Fl V Ar generate | sign | verify
1.1       tedu       65: Select the desired operation.
                     66: .El
1.4       jmc        67: .Pp
                     68: The key and signature files created by
                     69: .Nm
                     70: have the same format.
                     71: The first line of the file is a free form text comment that may be edited,
                     72: so long as it does not exceed a single line.
                     73: The second line of the file is the actual key or signature base64 encoded.
1.1       tedu       74: .Sh EXIT STATUS
1.4       jmc        75: .Ex -std signify
                     76: It may fail because of one of the following reasons:
                     77: .Pp
1.1       tedu       78: .Bl -bullet -compact
1.4       jmc        79: .It
1.1       tedu       80: Some necessary files do not exist.
                     81: .It
                     82: Entered passphrase is incorrect.
                     83: .It
                     84: The message file was corrupted and its signature does not match.
                     85: .It
                     86: The message file is too large.
                     87: .El
                     88: .Sh EXAMPLES
                     89: Create a new keypair:
1.4       jmc        90: .Dl $ signify -P newkey.pub -S newkey.sec -V generate
                     91: .Pp
                     92: Sign a file, specifying a signature name:
                     93: .Dl $ signify -S key.sec -I message.txt -O msg.sig -V sign
                     94: .Pp
1.1       tedu       95: Verify a signature, using the default signature name:
1.4       jmc        96: .Dl $ signify -P key.pub -I generalsorders.txt -V verify
1.1       tedu       97: .Sh SEE ALSO
                     98: .Xr cmp 1 ,
                     99: .Xr sha256 1 ,
                    100: .Xr ssh 1
                    101: .Sh HISTORY
                    102: The
                    103: .Nm
                    104: command first appeared in
                    105: .Ox 5.5