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