.links: Drop obsolete `lib-config.in' file.
[u/mdw/catacomb] / key.1
... / ...
CommitLineData
1.\" -*-nroff-*-
2.ie t \{\
3. if \n(.g \{\
4. fam P
5. \}
6. ds ss \s8\u
7. ds se \d\s0
8. ds us \s8\d
9. ds ue \u\s0
10. ds *b \(*b
11.\}
12.el \{\
13. ds ss ^
14. ds se
15. ds us _
16. ds ue
17. ds *b \fIbeta\fP
18.\}
19.de VS
20.sp 1
21.RS
22.nf
23.ft B
24..
25.de VE
26.ft R
27.fi
28.RE
29.sp 1
30..
31.TH key 1 "5 June 1999" "Straylight/Edgeware" "Catacomb cryptographic library"
32.SH NAME
33key \- simple key management system
34.SH SYNOPSIS
35.B key
36.RB [ \-k
37.IR keyring ]
38.I command
39.PP
40where
41.I command
42is one of:
43.PP
44.B help
45.RI [ command ...]
46.br
47.B show
48.RI [ item ...]
49.br
50.B add
51.RB [ \-lqrLKS ]
52.RB [ \-a
53.IR alg ]
54.RB [ \-b | \-B
55.IR bits ]
56.RB [ \-p
57.IR param ]
58.RB [ \-R
59.IR tag ]
60.br
61\h'8n'
62.RB [ \-A
63.IR seed-alg ]
64.RB [ \-s
65.IR seed ]
66.RB [ \-n
67.IR bits ]
68.br
69\h'8n'
70.RB [ \-e
71.IR expire ]
72.RB [ \-t
73.IR tag ]
74.RB [ \-c
75.IR comment ]
76.RB [ \-C
77.IR curve ]
78.br
79\h'8n'
80.I type
81.IR attr ...
82.br
83.B expire
84.IR tag ...
85.br
86.B delete
87.IR tag ...
88.br
89.B tag
90.I tag
91.RI [ new-tag ]
92.br
93.B comment
94.I tag
95.RI [ comment ]
96.br
97.B setattr
98.I tag
99.IR attr ...
100.br
101.B getattr
102.I tag
103.I attr
104.br
105.B lock
106.I qtag
107.br
108.B unlock
109.I qtag
110.br
111.B list
112.RB [ \-uqv ]
113.RB [ \-f
114.IR filter ]
115.RI [ tag ...]
116.br
117.B fingerprint
118.RB [ \-f
119.IR filter ]
120.RB [ \-a
121.IR hash ]
122.RI [ tag ...]
123.br
124.B verify
125.RB [ \-f
126.IR filter ]
127.RB [ \-a
128.IR hash ]
129.I tag
130.I fingerprint
131.br
132.B tidy
133.br
134.B extract
135.RB [ \-f
136.IR filter ]
137.I file
138.RI [ tag ...]
139.br
140.B merge
141.I file
142.SH DESCRIPTION
143The
144.B key
145command performs useful operations on Catacomb keyring files. It
146provides a number of subcommands, by which the various operations may be
147carried out.
148.SS "Global options"
149Before the command name,
150.I "global options"
151may be given. The following global options are supported:
152.TP
153.BR "\-h, \-\-help " [ \fIcommand ...]
154Writes a brief summary of
155.BR key 's
156various options to standard output, and
157returns a successful exit status. With command names, gives help on
158those commands.
159.TP
160.B "\-v, \-\-version"
161Writes the program's version number to standard output, and returns a
162successful exit status.
163.TP
164.B "\-u, \-\-usage"
165Writes a very terse command line summary to standard output, and returns
166a successful exit status.
167.TP
168.BI "\-k, \-\-keyring " file
169Names the keyring file which
170.B key
171is to process. The default keyring, used if this option doesn't specify
172one, is the file named
173.B keyring
174in the current directory. The keyring must be stored in a regular file:
175pipes, sockets, devices etc. are not allowed.
176The
177.B key
178program attempts to lock the keyring before accessing it, using
179.BR fcntl (2)
180locking. It will however time out after a short while (10 seconds) and
181report a failure.
182.SS Concepts
183In addition to the actual key data itself, a Catacomb key has a number
184of other pieces of information attached to it:
185.TP
186.B "keyid"
187Every key has a 32-bit identifying number, written in hexadecimal.
188Keyids are not actually related to the key contents: they're generated
189randomly. Applications use keyids to refer to specific keys; users are
190probably better off with tags and types. A
191.I deleted
192key cannot be looked up by keyid.
193.TP
194.B "tag"
195A key's tag is a unique string which can be used by users and
196applications to identify the key. Tag strings may not contain spaces,
197colons or dots. A
198.I deleted
199key cannot be looked up by tag. Whenever a tag name is wanted, a hex
200keyid or key type string can be given instead.
201.TP
202.B "type"
203A key's type string describes what the key may be used for. The type
204string is arbitrary, except that it may not contain whitespace
205characters, dots or colons. Applications use key types to obtain an
206arbitrary but suitable key for some purpose. An
207.I expired
208key cannot be looked up by type, but may be looked up by keyid or tag.
209.TP
210.B "key encoding"
211There are a number of different ways in which keys can be represented,
212according to the uses to which the key will be put. Most symmetric
213algorithms use
214.I binary
215keys. Keys used with number-theoretic systems (like most common
216public-key systems) use
217.I "multiprecision integer"
218keys. Elliptic curve systems use
219.I "curve point"
220keys, which are either a pair of integers representing field elements,
221or a `point at infinity'. Algorithms which require several key
222constituents (again, like most public-key systems) use
223.I structured
224keys, which consist of a collection of named parts. It's possible to
225store an
226.I "ASCII string"
227as a key, though this is usually done as a component of a structured
228key. Finally, keys (including structured keys) can be encrypted.
229.TP
230.B "filter"
231Keys and key components may be selected by a filter expression, a
232sequence of flag names separated by commas. Flags are:
233.BR binary ,
234.BR integer ,
235.BR struct ,
236.BR ec ,
237.BR string ,
238or
239.B encrypt
240(describing the key encoding);
241.BR symmetric ,
242.BR private ,
243.BR public ,
244or
245.B shared
246(describing the category of key);
247.B burn
248and its negation
249.B \-burn
250(whether the key should be erased from memory after use); and
251.B secret
252and its negation
253.B \-secret
254(whether the key is safe to divulge).
255.TP
256.B "qualified tag"
257A key component may be identified by the key's tag (or keyid, or type).
258Subcomponents of structured keys are identified by following the tag by
259a dot and the name of the subcomponent.
260.TP
261.B "expiry time"
262Most keys expire after a certain amount of time. Once a key has
263expired, it will no longer be chosen as a result of a lookup by key
264type. However, it is not deleted until its deletion time is also
265reached.
266.TP
267.B "deletion time"
268A key's deletion time is the latest expiry time of any of the objects
269which require that key. For example, a key used for authenticating
270cryptographic cookies should have its deletion time set to the longest
271expiry time of any of the cookies it can authenticate. Once a key's
272deletion time is passed, it can no longer be referred to by
273applications, and will be removed from the keyring next time it's
274written to disk.
275.TP
276.B "comment"
277A key may be given a comment when it's created. The comment is for the
278benefit of users, and isn't interpreted by applications at all.
279(Hopefully.)
280.TP
281.B "attributes"
282A key as zero or more name/value pairs. The names and values are
283arbitrary strings, except they may not contain null bytes. Some
284attributes may have meaning for particular applications or key types;
285others may be assigned global meanings in future.
286.SH "COMMAND REFERENCE"
287.SS help
288The
289.B help
290command behaves exactly as the
291.B \-\-help
292option. With no arguments, it shows an overview of
293.BR key 's
294options; with arguments, it describes the named subcommands.
295.SS show
296The
297.B show
298command prints various lists of tokens understood by
299.BR key .
300With no arguments, it prints all of the lists; with arguments, it prints
301just the named lists, in order. The recognized lists can be enumerated
302using the
303.VS
304key show list
305.VE
306command. The lists are as follows.
307.TP
308.B list
309The lists which can be enumerated by the
310.B show
311command.
312.TP
313.B hash
314The hash functions which can be used with the
315.B fingerprint
316and
317.B verify
318commands.
319.TP
320.B ec
321The built-in elliptic curves which can be used with the
322.B add \-a ec
323command.
324.TP
325.B dh
326The built-in Diffie-Hellman groups which can be used with the
327.B add \-a dh
328command.
329.TP
330.B keygen
331The key-generation algorithms which are acceptable to the
332.B \-a
333option of the
334.B add
335command.
336.TP
337.B seed
338The pseudorandom generators which are acceptable to the
339.B \-s
340option of the
341.B add
342command.
343.SS add
344The
345.B add
346command creates a new key and adds it to the keyring. The command
347accepts the following options:
348.TP
349.BI "\-a, \-\-algorithm " alg
350Selects a key generation algorithm. The default algorithm is
351.BR binary ;
352the different algorithms are described below. The command
353.B key show keygen
354lists the recognized key-generation algorithms.
355.TP
356.BI "\-b, \-\-bits " bits
357The length of the key to generate, in bits. The default, if this option
358is not supplied, depends on the key-generation algorithm.
359.TP
360.BI "\-B, \-\-qbits " bits
361The length of the subsidiary key or parameter, in bits. Not all
362key-generation algorithms have a subsidiary key size.
363.TP
364.BI "\-p, \-\-parameters " tag
365Selects a key containing parameter values to copy. Not all
366key-generation algorithms allow the use of shared parameters. A new key
367also inherits attributes from its parameter key.
368.TP
369.BI "\-A, \-\-seedalg " seed-alg
370Use the deterministic random number generator algorithm
371.I seed-alg
372to generate the key. Use
373.I before
374the
375.B \-s
376or
377.B \-n
378options; without one of these,
379.B \-A
380has no effect. The default algorithm is
381.BR rmd160-mgf .
382The command
383.B key show seed
384shows a list of recognized seeding algorithms. The seeding algorithm
385used to generate a key is recorded as the key's
386.B seedalg
387attribute.
388.TP
389.BI "\-s, \-\-seed " seed
390Generate the key deterministically using the given
391.IR seed ,
392which should be a Base64-encoded binary string. This is mainly useful
393for parameters keys (types
394.BR dsa-param
395and
396.BR dh-param ),
397to demonstrate that a set of parameters has been generated in an honest
398fashion. The
399.B dsarand
400generation algorithm can be used to generate
401.B dsa-param
402keys as required by FIPS186. The requested seed is recorded,
403Base64-encoded, as the new key's
404.B seed
405attribute.
406.TP
407.BI "\-n, \-\-newseed " bits
408Generate a new seed, with the given length in
409.IR bits .
410The generated seed is recorded, Base64-encoded, as the new key's
411.B seed
412attribute.
413.TP
414.BI "\-e, \-\-expire " expire
415The expiry date for the generated key. This may be the string
416.RB ` forever '
417if the key should never expire automatically, or any date acceptable to
418the
419.BR getdate (3)
420library function. Briefly,
421.B getdate
422understands absolute dates such as
423.RB ` 1999-08-02 '
424or
425.RB ` "August 2nd, 1999" ',
426and (perhaps more usefully) relative dates such as
427.RB ` "+2 weeks" '.
428The default is to allow a 2 week expiry, which isn't useful.
429.TP
430.BI "\-c, \-\-comment " comment
431Sets a comment for the key. The default is not to attach a comment.
432.TP
433.BI "\-C, \-\-curve " curve-spec
434Use the elliptic curve described by
435.I curve-spec
436when generating elliptic curve parameters.
437.TP
438.BI "\-t, \-\-tag " tag
439Selects a tag string for the key. The default is not to set a tag. It
440is an error to select a tag which already exists.
441.TP
442.BI "\-r, \-\-retag"
443If a
444.B \-t
445option is given, remove this tag from any key which already has it.
446.TP
447.BI "\-R, \-\-rand-id " tag
448Selects the key to use for the random number generator. Catacomb's
449random number generator can be
450.IR keyed ,
451so that, even if the inputs to the generator are compromised, knowledge
452of the key is also necessary to be able to predict the output. By
453default, the latest-expiring key with type
454.B catacomb-rand
455is used, if present; if not, no key is used.
456.TP
457.BI "\-l, \-\-lock"
458Requests that the secret parts of the newly-generated key be encrypted
459using a passphrase.
460.TP
461.BI "\-q, \-\-quiet"
462Suppresses the progress indication which is usually generated while
463time-consuming key generation tasks are being performed.
464.TP
465.BI "\-L, \-\-lim-lee"
466When generating Diffie-Hellman parameters, generate a Lim-Lee prime
467rather than a random (or safe) prime. See the details on Diffie-Hellman
468key generation below.
469.TP
470.BI "\-K, \-\-kcdsa"
471When generating Diffie-Hellman parameters, generate a KCDSA-style
472Lim-Lee prime rather than a random (or safe) prime. See the details on
473Diffie-Hellman key generation below.
474.TP
475.BI "\-S, \-\-subgroup"
476When generating Diffie-Hellman parameters with a Lim-Lee prime, choose a
477generator of a prime-order subgroup rather than a subgroup of order
478.RI ( p "- 1)/2."
479.PP
480The key's type is given by the required
481.I type
482argument. Following the type are zero or more attributes, which are
483attached to the key in the same way as for the
484.B setattr
485command.
486.PP
487The key-generation algorithms supported are as follows:
488.TP
489.B "binary"
490Generates a plain binary key of the requested length. If the requested
491key length is not a multiple of eight, the high-order bits of the first
492octet of the key are zeroed. The default key length is 128 bits.
493.TP
494.B "des"
495Generates a DES key, with parity bits. The key length must be 56, 112
496or 168; the default is 56. The low-order bit of each octet is ignored by
497the DES algorithm; it is used to give each octet odd parity.
498.TP
499.B "rsa"
500Generates a public/private key pair for use with the RSA algorithm.
501.IP
502The key components are
503.I p
504and
505.IR q ,
506a pair of prime numbers;
507.IR n ,
508the product of
509.I p
510and
511.IR q ;
512.IR e ,
513the public exponent;
514.IR d ,
515the private exponent, chosen such that
516.IR ed \ \(==\ 1
517(mod
518.RI ( p \ \-\ 1)( q \ \-\ 1));
519and some other values useful for optimizing private-key operations:
520.IR q \*(ss\-1\*(se\ mod\ p ,
521.IR d \ mod\ p \ \-\ 1,
522and
523.IR d \ mod\ q \ \-\ 1.
524The values
525.I n
526and
527.I e
528constitute the public key; the rest must be kept secret. The key size
529requested by the
530.B \-b
531option determines the size of the modulus
532.IR n ;
533the default is 1024 bits.
534.IP
535The key generation algorithm chooses
536.I p
537and
538.I q
539to be
540.I strong
541primes: both
542.IR p \ \-\ 1
543and
544.IR p \ +\ 1
545have large prime factors \- call them
546.I r
547and
548.I s
549respectively \- and
550.IR r \ \-\ 1
551also has a large prime factor;
552.I q
553has similar properties.
554.IP
555The modulus
556.I n
557cannot be sensibly used as a shared parameter, since knowledge of
558corrssponding public and private exponents is sufficient to be able to
559factor the modulus and recover other users' private keys.
560.TP
561.B "dh-param"
562Generates parameters for use with the Diffie-Hellman key exchange
563protocol, and many related systems, such as ElGamal encryption and
564signatures, and even DSA. (The separate DSA algorithm uses the
565generator described in FIPS186-1.)
566.IP
567The Diffie-Hellman parameters are a prime modulus
568.I p
569and a generator
570.I g
571of a subgroup of
572.BR Z / \c
573.IB p Z
574of order
575.IR q .
576The
577.B \-b
578option controls the size of the modulus
579.IR p ;
580the default size is 1024 bits.
581.IP
582If no
583.I q
584size is selected using the
585.B \-B
586option and the Lim-Lee prime options are disabled, then
587.I p
588is chosen to be a `safe' prime (i.e.,
589.IR p \ =\ 2 q \ +\ 1,
590with
591.I q
592prime). Finding safe primes takes a very long time. In this case, the
593value of
594.I g
595is fixed as 4.
596.IP
597If a size is chosen for
598.I q
599and Lim-Lee primes are not selected then the prime
600.I q
601is generated and
602.I p
603is chosen so that
604.IR p \ \-\ 1
605is a multiple of
606.IR q .
607.IP
608If the
609.B \-L
610option was given, Lim-Lee primes are selected: the parameters are chosen
611such that
612.IR p \ =\ 2\ q \*(us0\*(ue\ q \*(us1\*(ue\ q \*(us2\*(ue\ ...\ +\ 1,
613where the
614.IR q \*(us i\*(ue
615are primes at least as large as the setting given by the
616.B \-B
617option (or 256 bits, if no setting was given).
618.IP
619If the
620.B \-K
621option was given, KCDSA-style Lim-Lee primes are selected: the
622parameters are chosen such that
623.IR p \ =\ 2\ q\ v \ +\ 1,
624where
625.IR p,
626.I q
627and
628.I v
629are primes.
630.IP
631If the
632.B \-S
633or
634.B \-K
635options were given, the generator
636.I g
637is chosen to generate the subgroup of order
638.IR q \*(us0\*(ue;
639otherwise,
640.I g
641will generate the group of order
642.RI ( p \ \-\ 1)/2\ =\ q \*(us0\*(ue\ q \*(us1\*(ue\ q \*(us2\*(ue\ ...
643.IP
644Finally, the
645.B \-C
646option can be given, in which case the parameters are taken directly
647from the provided group specification, which may either be the the name
648of one of the built-in groups (say
649.B "key show dh"
650for a list) or a triple
651.RI ( p ,\ q ,\ g ).
652separated by commas. No random generation is done in this case: the
653given parameters are simply stored.
654.TP
655.B "dh"
656Generates a public/private key pair for use with offline Diffie-Hellman,
657ElGamal, DSA or similar discrete-logarithm-based systems. It selects a
658private key
659.IR x \ <\ q ,
660and computes the public key
661.IR y \ =\ g\*(ssx\*(se \ mod\ p .
662.TP
663.B "dsa-param"
664Generates parameters for the DSA algorithm. DSA parameters are also
665suitable for use with Diffie-Hellman and ElGamal system.
666.IP
667The main difference between DSA and Diffie-Hellman parameter generation
668is thatthe DSA parameter generation
669algorithm creates a
670.I seed
671from which the parameters are derived, and, assuming that the SHA-1 hash
672function is strong, it's not feasible to construct a seed from which
673deliberately weak parameters are derived. The algorithm used is the one
674described in the DSA standard, FIPS\ 186, extended only to allow
675sequential search for a prime
676.I q
677and to allow arbitrary parameter sizes. The seed is stored,
678Base64-encoded, as the value of the attribute
679.BR seed .
680.IP
681The default lengths for
682.I p
683and
684.I q
685are 768 and 160 bits respectively, since the DSA standard specifies that
686.I q
687be 160 bits, and the choice of 768 bits for
688.I p
689gives commensurate security.
690.TP
691.B "dsa"
692Generates a public/private key pair for DSA. As for Diffie-Hellman
693keys, it selects a
694private key
695.IR x \ <\ q ,
696and computes the public key
697.IR y \ =\ g\*(ssx\*(se \ mod\ p .
698.TP
699.B "bbs"
700Generates a public/private key pair for the Blum-Blum-Shub random-number
701generator, and the Blum-Goldwasser semantically-secure public-key
702encryption system.
703.IP
704The key components are prime numbers
705.I p
706and
707.IR q ,
708both congruent to 3 (mod\ 4), and their product
709.IR n .
710The public key is simply the modulus
711.IR n ;
712the factors
713.I p
714and
715.I q
716are the private key.
717.IP
718The key-generation algorithm ensures that the two primes
719.I p
720and
721.I q
722are
723.I strong
724(see the discussion of strong primes above, in the section on RSA keys),
725and that
726.RI ( p \ \-\ 1)/2
727and
728.RI ( q \ \-\ 1)/2
729are relatively prime, giving a maximum possible period length.
730.IP
731The key size requested by the
732.B \-b
733option determines the length of the modulus
734.IR n ;
735the default length is 1024 bits.
736.TP
737.B "ec-param"
738Store an elliptic curve specification. If no explicit
739.I curve-spec
740is given (the
741.RB ` \-C '
742option) then a curve is chosen whose order is about the size given by the
743.RB ` \-b '
744option (default is 256 bits).
745.IP
746A
747.I curve-spec
748can be given explicitly (in which case
749.RB ` \-b '
750is ignored). It can either be the name of a built-in curve (say
751.B "key show ec"
752for a list of curve names) or a full specification. The curve is
753checked for correctness and security according to the SEC1
754specification: failed checks cause a warning to be issued to standard
755error (though the program continues anyway). The check can be
756suppressed using the
757.RB ` \-q '
758option.
759.IP
760A curve specification consists of the following elements optionally
761separated by whitespace: a
762.IR "field type" ,
763which is one of
764.BR "prime" ,
765.BR "niceprime" ,
766.BR "binpoly" ,
767.or
768.BR "binnorm" ;
769an optional
770.RB ` : ';
771the field modulus
772.IR p ;
773if the field type is
774.B binnorm
775then an optional
776.RB ` , '
777and the representation of the normal element \*(*b; an optional
778.RB ` ; ';
779a
780.IR "curve type" ,
781which is one of
782.BR "prime" ,
783.BR "primeproj" ,
784.BR "bin" ,
785and
786.BR "binproj"
787(the `proj' types currently have much better performance);
788an optional
789.RB ` : ';
790the two field-element parameters
791.I a
792and
793.IR b
794which define the elliptic curve
795.IR E ,
796separated by an optional
797.RB ` , ';
798an optional
799.RB ` ; ';
800the
801.IR x -
802and
803.IR y -coordinates
804of the generator point
805.IR G ,
806separated by an optional
807.RB ` , ';
808an optional
809.RB ` : ';
810the order
811.I r
812of the group generated by
813.IR G ;
814an optional
815.RB ` * ';
816and the
817.I cofactor
818.I h
819=
820.RI # E / r .
821.TP
822.B "ec"
823Generate a private scalar and a corresponding public point on an
824elliptic curve. See
825.B ec-param
826above for how to specify elliptic curve parameter sets. The scalar
827.I x
828is chosen unformly between 0 and the curve order
829.IR r ;
830the public point is then
831.I x
832\(mu
833.IR G .
834.SS "expire"
835Forces keys to immediately expire. An expired key is not chosen when a
836program requests a key by its type. The keys to expire are listed by
837their
838.IR tag s.
839.SS "delete"
840Deletes keys immediately. The keys to delete are listed by their
841.IR tag s.
842Be careful when deleting keys. It might be a better idea
843to expire keys rather than deleting them.
844.SS "tag"
845Sets, deletes or changes the tag attached to a key. The first tag or
846keyid names the key to be modified; the second, if present specifies the
847new tag to be set. If no second argument is given, the existing tag, if
848any, is removed and no new tag is set. It is an error to set a tag
849which already exists on another key, unless you give the
850.B \-r
851option, which removes the tag first.
852.SS "setattr"
853Attaches attributes to a key. The key to which the attributes should be
854attached is given by its
855.IR tag .
856Each attribute has the form
857.IB name = value\fR.
858An attribute can be deleted by assigning it an empty value. Although
859the keyring file format is capable of representing an attribute with an
860empty value as distinct from a nonexistant attribute, this interface
861does not allow empty attributes to be set.
862.SS "getattr"
863Fetches a single attribute of a key. The key whose attribute is to be
864read is given by its
865.IR tag .
866The attribute's value is written to standard output followed by a
867newline. If the key or attribute is absent, a message is written to
868standard error and the program exits nonzero.
869.SS "comment"
870Sets, deletes or changes the comment attached to a key. The first
871argument is a key tag or keyid which names the key to be modified; the
872second, if present, is the new comment. If no second argument is given,
873the existing comment, if any, is removed, and no new comment is set.
874.SS "lock"
875Locks a key or key component using a passphrase. If the key is already
876locked, the existing passphrase is requested, and a new passphrase is
877set.
878.SS "unlock"
879Unlocks a passphrase-locked key or key component. If the key is not
880locked, an error is reported.
881.SS "list"
882Lists the keys in the keyring. A couple of options are supported:
883.TP
884.B "\-v, \-\-verbose"
885Increases the amount of information displayed for each key. Repeat for
886a greater effect.
887.TP
888.B "\-q, \-\-quiet"
889Decreases the amount of information displayed for each key. Each use
890cancels a
891.RB ` \-v '
892option.
893.TP
894.B "\-u, \-\-utc"
895Display key expiry times as UTC rather than using the local time zone.
896.TP
897.BI "\-f, \-\-filter " filter
898Specifies a filter. Only keys and key components which match the filter
899are listed.
900.PP
901By default, a single line of output is generated for each, showing
902keyids, types, expiry and deletion dates, and comments. Additional
903.RB ` \-v '
904options show more information, such as the exact time of day for expiry
905and deletion, key attributes, and a dump of the actual key data. If the
906verbosity level is sufficiently high, passphrases are requested to
907decrypt locked keys. Make sure nobody is looking over your shoulder
908when you do this!
909.SS "fingerprint"
910Reports a fingerprint (secure hash) on components of requested keys.
911The following options are supported:
912.TP
913.BI "\-f, \-\-filter " filter
914Specifies a filter. Only keys and key components which match the filter
915are fingerprinted. The default is to only fingerprint nonsecret
916components.
917.TP
918.BI "\-a, \-\-algorithm " hash
919Names the hashing algorithm. Run
920.B key show hash
921for a list of hashing algorithms. The default is
922.BR rmd160 .
923.PP
924The keys to be fingerprinted are named by their tags or keyids given as
925command line arguments. If no key tags are given, all keys which match
926the filter are fingerprinted. See
927.BR keyring (5)
928for a description of how key fingerprints are computed.
929.SS "verify"
930Check a key's fingerprint against a reference copy. The following
931options are supported:
932.TP
933.BI "\-f, \-\-filter " filter
934Specifies a filter. Only key components which match the filter are
935hashed. The default is to only fingerprint nonsecret components. An
936error is reported if no part of the key matches.
937.TP
938.BI "\-a, \-\-algorithm " hash
939Names the hashing algorithm. Run
940.B key show hash
941for a list of hashing algorithms. The default is
942.BR rmd160 .
943.PP
944The reference fingerprint is given as hex, in upper or lower case. The
945hash may contain hyphens, colons and whitespace. Other characters are
946not permitted.
947.SS "tidy"
948Simply reads the keyring from file and writes it back again. This has
949the effect of removing any deleted keys from the file.
950.SS "extract"
951Writes a selection of keys to a file. An option is supported:
952.TP
953.BI "\-f, \-\-filter " filter
954Specifies a filter. Only keys and key components which match the filter
955are written.
956.PP
957Keys extracted are written to the file named by the first argument,
958which may be
959.RB ` \- '
960to designate standard output. The keys to extract are listed by their
961tags; if no tags are given, all keys which match the filter are
962extracted. The output is a valid keyring file.
963.SS "merge"
964Merges the keys from the named
965.IR file ,
966which may be
967.RB ` \- '
968to designate standard input, with the keyring. Keys already in the
969keyring are not overwritten: you must explicitly remove them first if
970you want them to be replaced during the merge.
971.SH "SEE ALSO"
972.BR keyring (5).
973.SH AUTHOR
974Mark Wooding, <mdw@distorted.org.uk>
975