From 5de3fdc4fc82f56175f52f6e46065f56e858d97c Mon Sep 17 00:00:00 2001 From: Daniel Kahn Gillmor Date: Sun, 1 Mar 2009 13:54:25 -0500 Subject: fix openpgp2ssh man page to reflect new implementation. --- man/man1/openpgp2ssh.1 | 40 +++++++++++++++++----------------------- 1 file changed, 17 insertions(+), 23 deletions(-) (limited to 'man/man1/openpgp2ssh.1') diff --git a/man/man1/openpgp2ssh.1 b/man/man1/openpgp2ssh.1 index 8374a9f..9b0d1a4 100644 --- a/man/man1/openpgp2ssh.1 +++ b/man/man1/openpgp2ssh.1 @@ -28,13 +28,13 @@ fingerprint of the key or subkey desired, but will accept as few as the last 8 digits of the fingerprint as a key ID. .Pp -If the input contains an OpenPGP RSA or DSA public key, it will be -converted to the OpenSSH-style single-line keystring, prefixed with -the key type. This format is suitable (with minor alterations) for +If the input contains an OpenPGP RSA public key, it will be converted +to the OpenSSH-style single-line keystring, prefixed with the key type +(ssh-rsa). This format is suitable (with minor alterations) for insertion into known_hosts files and authorized_keys files. .Pp -If the input contains an OpenPGP RSA or DSA secret key, it will be -converted to the equivalent PEM-encoded private key. +If the input contains an OpenPGP RSA secret key, it will be converted +to the equivalent PEM-encoded private key. .Pp .Nm is part of the @@ -47,15 +47,10 @@ intentional, since ssh attaches no inherent significance to these features. .Pp .Nm -only works with RSA or DSA keys, because those are the -only ones which work with ssh. -.Pp -Assuming a valid key type, though, -.Nm -will produce output for -any requested key. This means, among other things, that it will -happily export revoked keys, unverifiable keys, expired keys, etc. -Make sure you do your own key validation before using this tool! +will produce output for any requested RSA key. This means, among +other things, that it will happily export revoked keys, unverifiable +keys, expired keys, etc. Make sure you do your own key validation +before using this tool! .Sh EXAMPLES .Nm gpg --export-secret-key $KEYID | openpgp2ssh $KEYID | ssh-add -c /dev/stdin .Pp @@ -72,6 +67,14 @@ and this man page were written by Daniel Kahn Gillmor . .Sh BUGS .Nm +only works with RSA keys. DSA keys are the only other key type +available in both OpenPGP and SSH, but they are currently unsupported +by this utility. +.Pp +.Nm +only accepts raw OpenPGP packets on standard input. It does not +accept ASCII-armored input. +.Nm Currently only exports into formats used by the OpenSSH. It should support other key output formats, such as those used by lsh(1) and putty(1). @@ -80,15 +83,6 @@ Secret key output is currently not passphrase-protected. .Pp .Nm currently cannot handle passphrase-protected secret keys on input. -.Pp -Key identifiers consisting of an odd number of hex digits are not -accepted. Users who use a key ID with a standard length of 8, 16, or -40 hex digits should not be affected by this. -.Pp -.Nm -only acts on keys associated with the first primary key -passed in. If you send it more than one primary key, it will silently -ignore later ones. .Sh SEE ALSO .Xr pem2openpgp 1 , .Xr monkeysphere 1 , -- cgit v1.2.3 From aa03928a5317996d9d87ba733048b2c010641a3b Mon Sep 17 00:00:00 2001 From: Daniel Kahn Gillmor Date: Sun, 1 Mar 2009 22:23:40 -0500 Subject: syntactic cleanup of keytrans-related man pages. --- man/man1/openpgp2ssh.1 | 21 ++++++++++++--------- man/man1/pem2openpgp.1 | 10 +++++----- 2 files changed, 17 insertions(+), 14 deletions(-) (limited to 'man/man1/openpgp2ssh.1') diff --git a/man/man1/openpgp2ssh.1 b/man/man1/openpgp2ssh.1 index 9b0d1a4..304a442 100644 --- a/man/man1/openpgp2ssh.1 +++ b/man/man1/openpgp2ssh.1 @@ -1,5 +1,5 @@ .\" -*- nroff -*- -.Dd $Mdocdate: June 11, 2008 $ +.Dd $Mdocdate: March 1, 2009 $ .Dt OPENPGP2SSH 1 .Os .Sh NAME @@ -8,9 +8,9 @@ openpgp2ssh .Sh SYNOPSIS .Nm openpgp2ssh < mykey.gpg .Pp -.Nm gpg --export $KEYID | openpgp2ssh $KEYID +.Nm gpg \-\-export $KEYID | openpgp2ssh $KEYID .Pp -.Nm gpg --export-secret-key $KEYID | openpgp2ssh $KEYID +.Nm gpg \-\-export\-secret\-key $KEYID | openpgp2ssh $KEYID .Sh DESCRIPTION .Nm takes an OpenPGP-formatted primary key and associated @@ -30,7 +30,7 @@ ID. .Pp If the input contains an OpenPGP RSA public key, it will be converted to the OpenSSH-style single-line keystring, prefixed with the key type -(ssh-rsa). This format is suitable (with minor alterations) for +(`ssh\-rsa'). This format is suitable (with minor alterations) for insertion into known_hosts files and authorized_keys files. .Pp If the input contains an OpenPGP RSA secret key, it will be converted @@ -52,14 +52,14 @@ other things, that it will happily export revoked keys, unverifiable keys, expired keys, etc. Make sure you do your own key validation before using this tool! .Sh EXAMPLES -.Nm gpg --export-secret-key $KEYID | openpgp2ssh $KEYID | ssh-add -c /dev/stdin +.Nm gpg \-\-export\-secret\-key $KEYID | openpgp2ssh $KEYID | ssh\-add \-c /dev/stdin .Pp This pushes the secret key into the active -.Xr ssh-agent 1 . +.Xr ssh\-agent 1 . Tools such as .Xr ssh 1 which know how to talk to the -.Xr ssh-agent 1 +.Xr ssh\-agent 1 can now rely on the key. .Sh AUTHOR .Nm @@ -77,7 +77,9 @@ accept ASCII-armored input. .Nm Currently only exports into formats used by the OpenSSH. It should support other key output formats, such as those used by -lsh(1) and putty(1). +.Xr lsh 1 +and +.Xr putty 1 . .Pp Secret key output is currently not passphrase-protected. .Pp @@ -88,4 +90,5 @@ currently cannot handle passphrase-protected secret keys on input. .Xr monkeysphere 1 , .Xr monkeysphere 7 , .Xr ssh 1 , -.Xr monkeysphere-server 8 +.Xr monkeysphere-authentication 8 , +.Xr monkeysphere-host 8 diff --git a/man/man1/pem2openpgp.1 b/man/man1/pem2openpgp.1 index ae75b11..45fd1ee 100644 --- a/man/man1/pem2openpgp.1 +++ b/man/man1/pem2openpgp.1 @@ -1,12 +1,12 @@ .\" -*- nroff -*- -.Dd $Mdocdate: January 25, 2009 $ +.Dd $Mdocdate: March 1, 2009 $ .Dt PEM2OPENPGP 1 .Os .Sh NAME pem2openpgp .Nd translate PEM-encoded RSA keys to OpenPGP certificates .Sh SYNOPSIS -.Nm pem2openpgp "$USERID" < mykey.pem | gpg --import +.Nm pem2openpgp "$USERID" < mykey.pem | gpg \-\-import .Pp .Nm PEM2OPENPGP_EXPIRATION=$((86400 * $DAYS)) PEM2OPENPGP_USAGE_FLAGS=authentication,certify pem2openpgp "$USERID" . .Sh BUGS -Only handles RSA keys at the moment. It would be nice to handle DSA +Only handles RSA keys at the moment. It might be nice to handle DSA keys as well. .Pp Currently only creates certificates with a single User ID. Should be @@ -81,5 +81,5 @@ https://labs.riseup.net/code/projects/show/monkeysphere .Xr monkeysphere 1 , .Xr monkeysphere 7 , .Xr ssh 1 , -.Xr monkeysphere-host 8 , -.Xr monkeysphere-authentication 8 +.Xr monkeysphere\-host 8 , +.Xr monkeysphere\-authentication 8 -- cgit v1.2.3