clarifying defaults for CHECK_KEYSERVER in monkeysphere.conf
[monkeysphere.git] / man / man1 / pem2openpgp.1
1 .\"  -*- nroff -*-
2 .Dd $Mdocdate: March 1, 2009 $
3 .Dt PEM2OPENPGP 1
4 .Os
5 .Sh NAME
6 pem2openpgp
7 .Nd translate PEM-encoded RSA keys to OpenPGP certificates
8 .Sh SYNOPSIS
9 .Nm pem2openpgp "$USERID" < mykey.pem | gpg \-\-import
10 .Pp
11 .Nm PEM2OPENPGP_EXPIRATION=$((86400 * $DAYS)) PEM2OPENPGP_USAGE_FLAGS=authenticate,certify pem2openpgp "$USERID" <mykey.pem
12 .Sh DESCRIPTION
13 .Nm
14 is a low-level utility for transforming raw, PEM-encoded RSA secret
15 keys into OpenPGP-formatted certificates.  The generated certificates
16 include the secret key material, so they should be handled carefully.
17 .Pp
18 It works as an element within a pipeline: feed it the raw key on
19 stdin, supply the desired User ID as a command line argument.  Note
20 that you may need to quote the string to ensure that it is entirely in
21 a single argument.
22 .Pp
23 Other choices about how to generate the new OpenPGP certificate are
24 governed by environment variables.
25 .Sh ENVIRONMENT
26 The following environment variables influence the behavior of
27 .Nm :
28 .Pp
29 .ti 3
30 \fBPEM2OPENPGP_TIMESTAMP\fP controls the timestamp (measured in
31 seconds since the UNIX epoch) indicated as the creation time (a.k.a
32 "not valid before") of the generated certificate (self-signature) and
33 the key itself.  By default,
34 .Nm
35 uses the current time.
36 .Pp
37 .ti 3
38 \fBPEM2OPENPGP_KEY_TIMESTAMP\fP controls the timestamp (measured in
39 seconds since the UNIX epoch) indicated as the creation time of just
40 the key itself (not the self-signature).  By default,
41 .Nm
42 uses the value from PEM2OPENPGP_TIMESTAMP.
43 .Pp
44 .ti 3
45 \fBPEM2OPENPGP_USAGE_FLAGS\fP should contain a comma-separated list of
46 valid OpenPGP usage flags (see section 5.2.3.21 of RFC 4880 for what
47 these mean).  The available choices are: certify, sign, encrypt_comms,
48 encrypt_storage, encrypt (this means both encrypt_comms and
49 encrypt_storage), authenticate, split, shared.  By default, 
50 .Nm
51 only sets the certify flag.
52 .Pp
53 .ti 3
54 \fBPEM2OPENPGP_EXPIRATION\fP sets an expiration (measured in seconds
55 after the creation time of the key) in each self-signature packet.  By
56 default, no expiration subpacket is included.
57 .Pp
58 .ti 3
59 \fBPEM2OPENPGP_NEWKEY\fP indicates that
60 .Nm
61 should ignore stdin, and instead generate a new key internally and
62 build the certificate based on this new key.  Set this variable to the
63 number of bits for the new key (e.g. 2048).  By default (when this is
64 unset), 
65 .Nm
66 will read the key from stdin.
67 .Sh AUTHOR
68 .Nm
69 and this man page were written by Daniel Kahn Gillmor
70 <dkg@fifthhorseman.net>.
71 .Sh BUGS
72 Only handles RSA keys at the moment.  It might be nice to handle DSA
73 keys as well.
74 .Pp
75 Currently only creates certificates with a single User ID.  Should be
76 able to create certificates with multiple User IDs.
77 .Pp
78 Currently only accepts unencrypted RSA keys.  It should be able to
79 deal with passphrase-locked key material.
80 .Pp
81 Currently outputs OpenPGP certificates with cleartext secret key
82 material.  It would be good to be able to lock the output with a
83 passphrase.
84 .Pp
85 If you find other bugs, please report them at
86 https://labs.riseup.net/code/projects/show/monkeysphere
87 .Sh SEE ALSO
88 .Xr openpgp2ssh 1,
89 .Xr monkeysphere 1 ,
90 .Xr monkeysphere 7 ,
91 .Xr ssh 1 ,
92 .Xr monkeysphere\-host 8 ,
93 .Xr monkeysphere\-authentication 8