Annotation of src/usr.bin/signify/signify.1, Revision 1.1
1.1 ! tedu 1: .\" $OpenBSD$
! 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.
! 17: .Dd $Mdocdate$
! 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
! 25: .Op Fl I Ar input
! 26: .Op Fl N
! 27: .Op Fl O Ar output
! 28: .Op Fl P Ar pubkey
! 29: .Op Fl S Ar seckey
! 30: .Op Fl V Ar generate|sign|verify
! 31: .Sh DESCRIPTION
! 32: The
! 33: .Nm
! 34: utility creates and verifies cryptographic signatures.
! 35: The mode of operation is selected by the verb passed to the
! 36: .Ar V
! 37: option.
! 38: Options are as follows
! 39: .Bl -tag -width iPPpubkey
! 40: .It Fl I Ar input
! 41: Input file to
! 42: .Ar sign
! 43: or
! 44: .Ar verify .
! 45: .It Fl N
! 46: Do not ask for a passphrase during key generation.
! 47: Otherwise,
! 48: .Nm
! 49: will prompt the user for a passphrase on the tty.
! 50: .It Fl O Ar output
! 51: The signature file to create or verify.
! 52: The default is
! 53: .Ar input .sig .
! 54: .It Fl P Ar pubkey
! 55: Public key produced by
! 56: .Ar generate ,
! 57: and used by
! 58: .Ar verify
! 59: to check a signature.
! 60: .It Fl S Ar seckey
! 61: Secret (private) key produced by
! 62: .Ar generate ,
! 63: and used by
! 64: .Ar sign
! 65: to sign a message.
! 66: .It Fl V generate|sign|verify
! 67: Select the desired operation.
! 68: .El
! 69: .Sh EXIT STATUS
! 70: The
! 71: .Nm
! 72: utility may fail for the following reasons:
! 73: .Bl -bullet -compact
! 74: .It
! 75: Some necessary files do not exist.
! 76: .It
! 77: Entered passphrase is incorrect.
! 78: .It
! 79: The message file was corrupted and its signature does not match.
! 80: .It
! 81: The message file is too large.
! 82: .El
! 83: .Sh EXAMPLES
! 84: Create a new keypair:
! 85: .Dl "$ signify -P newkey.pub -S newkey.sec -V generate"
! 86: Sign a file, specifying signature name:
! 87: .Dl "$ signify -S key.sec -I message.txt -O msg.sig -V sign"
! 88: Verify a signature, using the default signature name:
! 89: .Dl "$ signify -P key.pub -I generalsorders.txt -V verify"
! 90: .Sh SEE ALSO
! 91: .Xr cmp 1 ,
! 92: .Xr sha256 1 ,
! 93: .Xr ssh 1
! 94: .Sh HISTORY
! 95: The
! 96: .Nm
! 97: command first appeared in
! 98: .Ox 5.5