Return to signify.1 CVS log

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

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

1.9     ! tedu        1: .\" $OpenBSD: signify.1,v 1.8 2014/01/09 15:36:40 tedu 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.9     ! tedu       17: .Dd $Mdocdate: January 9 2014 $
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.6       tedu       25: .Op Fl n
1.7       espie      26: .Fl p Ar pubkey
                     27: .Fl s Ar seckey
                     28: .Fl G
                     29: .Nm signify
1.9     ! tedu       30: .Op Fl o Ar signature
        !            31: .Op Fl p Ar pubkey
        !            32: .Op Fl s Ar seckey
        !            33: .Fl I
        !            34: .Nm signify
1.8       tedu       35: .Op Fl e
1.7       espie      36: .Op Fl o Ar output
                     37: .Fl s Ar seckey
                     38: .Fl S
1.8       tedu       39: .Ar message
1.7       espie      40: .Nm signify
1.8       tedu       41: .Op Fl e
1.6       tedu       42: .Op Fl o Ar output
1.7       espie      43: .Fl p Ar pubkey
                     44: .Fl V
1.8       tedu       45: .Ar message
1.1       tedu       46: .Sh DESCRIPTION
                     47: The
                     48: .Nm
1.7       espie      49: utility creates and verifies cryptographic signatures for
                     50: an input file
1.8       tedu       51: .Ar message .
1.4       jmc        52: The mode of operation is selected by the
1.6       tedu       53: .Fl G ,
                     54: .Fl S ,
                     55: or
1.4       jmc        56: .Fl V
1.6       tedu       57: options.
1.4       jmc        58: .Pp
                     59: The options are as follows:
1.7       espie      60: .Bl -tag -width Dssoutput
1.8       tedu       61: .It Fl e
                     62: Embed the message after the signature when signing.
                     63: For verification, extract the message from the signature.
1.6       tedu       64: .It Fl G
                     65: Generate a new keypair.
1.9     ! tedu       66: .It Fl I
        !            67: Inspect the specified keys or signature and print their fingerprint.
1.6       tedu       68: .It Fl n
1.1       tedu       69: Do not ask for a passphrase during key generation.
                     70: Otherwise,
                     71: .Nm
1.4       jmc        72: will prompt the user for a passphrase on the terminal.
1.8       tedu       73: .It Fl o Ar sigfile
1.1       tedu       74: The signature file to create or verify.
                     75: The default is
1.5       jmc        76: .Ar input Ns .sig .
1.6       tedu       77: .It Fl p Ar pubkey
1.1       tedu       78: Public key produced by
1.7       espie      79: .Fl G ,
1.1       tedu       80: and used by
1.7       espie      81: .Fl V
1.1       tedu       82: to check a signature.
1.6       tedu       83: .It Fl S
                     84: Sign the input file.
                     85: .It Fl s Ar seckey
1.1       tedu       86: Secret (private) key produced by
1.7       espie      87: .Fl G ,
1.1       tedu       88: and used by
1.7       espie      89: .Fl S
1.1       tedu       90: to sign a message.
1.6       tedu       91: .It Fl V
                     92: Verify the input file and signature match.
1.1       tedu       93: .El
1.4       jmc        94: .Pp
                     95: The key and signature files created by
                     96: .Nm
                     97: have the same format.
                     98: The first line of the file is a free form text comment that may be edited,
                     99: so long as it does not exceed a single line.
                    100: The second line of the file is the actual key or signature base64 encoded.
1.1       tedu      101: .Sh EXIT STATUS
1.4       jmc       102: .Ex -std signify
                    103: It may fail because of one of the following reasons:
                    104: .Pp
1.1       tedu      105: .Bl -bullet -compact
1.4       jmc       106: .It
1.1       tedu      107: Some necessary files do not exist.
                    108: .It
                    109: Entered passphrase is incorrect.
                    110: .It
                    111: The message file was corrupted and its signature does not match.
                    112: .It
                    113: The message file is too large.
                    114: .El
                    115: .Sh EXAMPLES
                    116: Create a new keypair:
1.7       espie     117: .Dl $ signify -G -p newkey.pub -s newkey.sec
1.4       jmc       118: .Pp
                    119: Sign a file, specifying a signature name:
1.7       espie     120: .Dl $ signify -S -s key.sec -o msg.sig message.txt
1.4       jmc       121: .Pp
1.1       tedu      122: Verify a signature, using the default signature name:
1.7       espie     123: .Dl $ signify -V -p key.pub generalsorders.txt
1.1       tedu      124: .Sh SEE ALSO
                    125: .Xr cmp 1 ,
                    126: .Xr sha256 1 ,
                    127: .Xr ssh 1
                    128: .Sh HISTORY
                    129: The
                    130: .Nm
                    131: command first appeared in
1.7       espie     132: .Ox 5.5 .