diff options
Diffstat (limited to 'man/man8')
| -rw-r--r-- | man/man8/monkeysphere-authentication.8 | 113 | ||||
| -rw-r--r-- | man/man8/monkeysphere-host.8 | 117 |
2 files changed, 125 insertions, 105 deletions
diff --git a/man/man8/monkeysphere-authentication.8 b/man/man8/monkeysphere-authentication.8 index 361822d..a28922c 100644 --- a/man/man8/monkeysphere-authentication.8 +++ b/man/man8/monkeysphere-authentication.8 @@ -1,29 +1,29 @@ -.TH MONKEYSPHERE-SERVER "8" "June 2008" "monkeysphere" "User Commands" +.TH MONKEYSPHERE-SERVER "8" "March 2009" "monkeysphere" "User Commands" .SH NAME -monkeysphere-authentication \- Monkeysphere authentication admin tool. +monkeysphere\-authentication - Monkeysphere authentication admin tool. .SH SYNOPSIS -.B monkeysphere-authentication \fIsubcommand\fP [\fIargs\fP] -.br -.B monkeysphere-authentication expert \fIexpert-subcommand\fP [\fIargs\fP] +.B monkeysphere\-authentication \fIsubcommand\fP [\fIargs\fP] .SH DESCRIPTION -\fBMonkeysphere\fP is a framework to leverage the OpenPGP web of trust for -OpenSSH authentication. OpenPGP keys are tracked via GnuPG, and added to the -authorized_keys and known_hosts files used by OpenSSH for connection -authentication. +\fBMonkeysphere\fP is a framework to leverage the OpenPGP Web of Trust +(WoT) for OpenSSH authentication. OpenPGP keys are tracked via GnuPG, +and added to the authorized_keys and known_hosts files used by OpenSSH +for connection authentication. -\fBmonkeysphere-authentication\fP is a Monkeysphere server admin utility. +\fBmonkeysphere\-authentication\fP is a Monkeysphere server admin +utility for configuring and managing SSH user authentication through +the WoT. .SH SUBCOMMANDS -\fBmonkeysphere-authentication\fP takes various subcommands: +\fBmonkeysphere\-authentication\fP takes various subcommands: .TP -.B update-users [ACCOUNT]... +.B update\-users [ACCOUNT]... Rebuild the monkeysphere-controlled authorized_keys files. For each specified account, the user ID's listed in the account's authorized_user_ids file are processed. For each user ID, gpg will be @@ -35,29 +35,29 @@ RAW_AUTHORIZED_KEYS variable is set, then a separate authorized_keys file (usually ~USER/.ssh/authorized_keys) is appended to the monkeysphere-controlled authorized_keys file. If no accounts are specified, then all accounts on the system are processed. `u' may be -used in place of `update-users'. +used in place of `update\-users'. .TP -.B add-id-certifier KEYID|FILE +.B add\-id\-certifier KEYID|FILE Instruct system to trust user identity certifications made by KEYID. The key ID will be loaded from the keyserver. A file may be loaded instead of pulling the key from the keyserver by specifying the path -to the file as the argument, or by specifying `-` to load from stdin. -Using the `-n' or `--domain' option allows you to indicate that you +to the file as the argument, or by specifying `\-' to load from stdin. +Using the `\-n' or `\-\-domain' option allows you to indicate that you only trust the given KEYID to make identifications within a specific domain (e.g. "trust KEYID to certify user identities within the @example.org domain"). A certifier trust level can be specified with -the `-t' or `--trust' option (possible values are `marginal' and +the `\-t' or `\-\-trust' option (possible values are `marginal' and `full' (default is `full')). A certifier trust depth can be specified -with the `-d' or `--depth' option (default is 1). `c+' may be used in -place of `add-id-certifier'. +with the `\-d' or `\-\-depth' option (default is 1). `c+' may be used in +place of `add\-id\-certifier'. .TP -.B remove-id-certifier KEYID +.B remove\-id\-certifier KEYID Instruct system to ignore user identity certifications made by KEYID. -`c-' may be used in place of `remove-id-certifier'. +`c\-' may be used in place of `remove\-id\-certifier'. .TP -.B list-id-certifiers +.B list\-id\-certifiers List key IDs trusted by the system to certify user identities. `c' -may be used in place of `list-id-certifiers'. +may be used in place of `list\-id\-certifiers'. .TP .B help Output a brief usage summary. `h' or `?' may be used in place of @@ -69,30 +69,30 @@ show version number Other commands: .TP .B setup -Setup the server for Monkeysphere user authentication. This command -is idempotent and run automatically by the other commands, and should -therefore not usually need to be run manually. `s' may be used in -place of `setup'. +Setup the server in preparation for Monkeysphere user authentication. +This command is idempotent and run automatically by the other +commands, and should therefore not usually need to be run manually. +`s' may be used in place of `setup'. .TP .B diagnostics Review the state of the server with respect to authentication. `d' may be used in place of `diagnostics'. .TP -.B gpg-cmd +.B gpg\-cmd Execute a gpg command, as the monkeysphere user, on the monkeysphere -authentication "sphere" keyring. This takes a single argument -(multiple gpg arguments need to be quoted). Use this command with -caution, as modifying the authentication sphere keyring can affect ssh -user authentication. +authentication `sphere' keyring. This takes a single argument +(i.e. multiple gpg arguments need to be quoted all together). Use +this command with caution, as modifying the authentication sphere +keyring can affect ssh user authentication. .SH SETUP USER AUTHENTICATION If the server will handle user authentication through monkeysphere-generated authorized_keys files, the server must be told which keys will act as identity certifiers. This is done with the -\fBadd-id-certifier\fP command: +\fBadd\-id\-certifier\fP command: -$ monkeysphere-authentication add-id-certifier KEYID +# monkeysphere\-authentication add\-id\-certifier KEYID where KEYID is the key ID of the server admin, or whoever's certifications should be acceptable to the system for the purposes of @@ -100,32 +100,34 @@ authenticating remote users. You can run this command multiple times to indicate that multiple certifiers are trusted. You may also specify a filename instead of a key ID, as long as the file contains a single OpenPGP public key. Certifiers can be removed with the -\fBremove-id-certifier\fP command, and listed with the -\fBlist-id-certifiers\fP command. +\fBremove\-id\-certifier\fP command, and listed with the +\fBlist\-id\-certifiers\fP command. -Remote users will then be granted access to a local account based on -the appropriately-signed and valid keys associated with user IDs -listed in that account's authorized_user_ids file. By default, the +A remote user will be granted access to a local account based on the +appropriately-signed and valid keys associated with user IDs listed in +that account's authorized_user_ids file. By default, the authorized_user_ids file for an account is ~/.monkeysphere/authorized_user_ids. This can be changed in the -monkeysphere-authentication.conf file. +monkeysphere\-authentication.conf file. -The \fBupdate-users\fP command can then be used to generate -authorized_keys file for local accounts based on the authorized user -IDs listed in the account's authorized_user_ids file: +The \fBupdate\-users\fP command is used to generate authorized_keys +files for a local account based on the user IDs listed in the +account's authorized_user_ids file: -$ monkeysphere-authentication update-users USER +# monkeysphere\-authentication update\-users USER Not specifying USER will cause all accounts on the system to updated. -sshd can then use these monkeysphere generated authorized_keys files -to grant access to user accounts for remote users. You must also tell +The ssh server can use these monkeysphere-generated authorized_keys +files to grant access to user accounts for remote users. In order for sshd to look at the monkeysphere-generated authorized_keys file for -user authentication by setting the following in the sshd_config: +user authentication, the AuthorizedKeysFile parameter must be set in +the sshd_config to point to the monkeysphere\-generated +authorized_keys files: AuthorizedKeysFile /var/lib/monkeysphere/authentication/authorized_keys/%u -It is recommended to add "monkeysphere-authentication update-users" to a -system crontab, so that user keys are kept up-to-date, and key +It is recommended to add "monkeysphere\-authentication update\-users" +to a system crontab, so that user keys are kept up-to-date, and key revocations and expirations can be processed in a timely manner. .SH ENVIRONMENT @@ -141,7 +143,7 @@ Set the log level. Can be SILENT, ERROR, INFO, VERBOSE, DEBUG, in increasing order of verbosity. (INFO) .TP MONKEYSPHERE_KEYSERVER -OpenPGP keyserver to use. (pool.sks-keyservers.net) +OpenPGP keyserver to use. (pool.sks\-keyservers.net) .TP MONKEYSPHERE_AUTHORIZED_USER_IDS Path to user's authorized_user_ids file. %h gets replaced with the @@ -157,11 +159,10 @@ raw authorized_keys file. %h gets replaced with the user's homedir, MONKEYSPHERE_PROMPT If set to `false', never prompt the user for confirmation. (true) - .SH FILES .TP -/etc/monkeysphere/monkeysphere-authentication.conf +/etc/monkeysphere/monkeysphere\-authentication.conf System monkeysphere-authentication config file. .TP /var/lib/monkeysphere/authorized_keys/USER @@ -169,7 +170,7 @@ Monkeysphere-generated user authorized_keys files. .SH AUTHOR -Written by: +This man page was written by: Jameson Rollins <jrollins@fifthhorseman.net>, Daniel Kahn Gillmor <dkg@fifthhorseman.net>, Matthew Goins <mjgoins@openflows.com> @@ -177,7 +178,9 @@ Matthew Goins <mjgoins@openflows.com> .SH SEE ALSO .BR monkeysphere (1), -.BR monkeysphere-host (8), +.BR monkeysphere\-host (8), .BR monkeysphere (7), .BR gpg (1), -.BR ssh (1) +.BR ssh (1), +.BR sshd (8), +.BR sshd_config (5) diff --git a/man/man8/monkeysphere-host.8 b/man/man8/monkeysphere-host.8 index 7909b62..3e01105 100644 --- a/man/man8/monkeysphere-host.8 +++ b/man/man8/monkeysphere-host.8 @@ -1,14 +1,12 @@ -.TH MONKEYSPHERE-SERVER "8" "June 2008" "monkeysphere" "User Commands" +.TH MONKEYSPHERE-SERVER "8" "March 2009" "monkeysphere" "User Commands" .SH NAME -monkeysphere-host \- Monkeysphere host admin tool. +monkeysphere\-host - Monkeysphere host admin tool. .SH SYNOPSIS -.B monkeysphere-host \fIsubcommand\fP [\fIargs\fP] -.br -.B monkeysphere-host expert \fIexpert-subcommand\fP [\fIargs\fP] +.B monkeysphere\-host \fIsubcommand\fP [\fIargs\fP] .SH DESCRIPTION @@ -17,29 +15,31 @@ for OpenSSH authentication. OpenPGP keys are tracked via GnuPG, and added to the authorized_keys and known_hosts files used by OpenSSH for connection authentication. -\fBmonkeysphere-host\fP is a Monkeysphere server admin utility. +\fBmonkeysphere\-host\fP is a Monkeysphere server admin utility for +managing the host's OpenPGP host key. .SH SUBCOMMANDS -\fBmonkeysphere-host\fP takes various subcommands: +\fBmonkeysphere\-host\fP takes various subcommands: .TP -.B import-key FILE NAME[:PORT] -Import a pem-encoded ssh secret host key from file FILE. If FILE -is '-', then the key will be imported from stdin. NAME[:PORT] is used -to specify the fully-qualified hostname (and port) used in the user ID -of the new OpenPGP key. If PORT is not specified, the no port is -added to the user ID, which means port 22 is assumed. `i' may be used -in place of `import-key'. +.B import\-key FILE NAME[:PORT] +Import a pem-encoded ssh secret host key from file FILE. If FILE is +`\-', then the key will be imported from stdin. Only RSA keys are +supported at the moment. NAME[:PORT] is used to specify the +fully-qualified hostname (and port) used in the user ID of the new +OpenPGP key. If PORT is not specified, the no port is added to the +user ID, which means port 22 is assumed. `i' may be used in place of +`import\-key'. .TP -.B show-key +.B show\-key Output information about host's OpenPGP and SSH keys. `s' may be used -in place of `show-key'. +in place of `show\-key'. .TP -.B extend-key [EXPIRE] +.B set\-expire [EXPIRE] Extend the validity of the OpenPGP key for the host until EXPIRE from the present. If EXPIRE is not specified, then the user will be prompted for the extension term. Expiration is specified as with -GnuPG: +GnuPG (measured from today's date): .nf 0 = key does not expire <n> = key expires in n days @@ -47,24 +47,24 @@ GnuPG: <n>m = key expires in n months <n>y = key expires in n years .fi -`e' may be used in place of `extend-key'. +`e' may be used in place of `set\-expire'. .TP -.B add-hostname HOSTNAME +.B add\-hostname HOSTNAME Add a hostname user ID to the server host key. `n+' may be used in -place of `add-hostname'. +place of `add\-hostname'. .TP -.B revoke-hostname HOSTNAME -Revoke a hostname user ID from the server host key. `n-' may be used -in place of `revoke-hostname'. +.B revoke\-hostname HOSTNAME +Revoke a hostname user ID from the server host key. `n\-' may be used +in place of `revoke\-hostname'. .TP -.B add-revoker KEYID|FILE +.B add\-revoker KEYID|FILE Add a revoker to the host's OpenPGP key. The key ID will be loaded from the keyserver. A file may be loaded instead of pulling the key from the keyserver by specifying the path to the file as the argument, -or by specifying `-` to load from stdin. `r+' may be be used in place +or by specifying `\-' to load from stdin. `r+' may be be used in place of `add-revoker'. .TP -.B revoke-key +.B revoke\-key Generate (with the option to publish) a revocation certificate for the host's OpenPGP key. If such a certificate is published, your host key will be permanently revoked. This subcommand will ask you a series of @@ -73,9 +73,10 @@ to stdout. If you explicitly tell it to publish the revocation certificate immediately, it will send it to the public keyservers. USE WITH CAUTION! .TP -.B publish-key -Publish the host's OpenPGP key to the keyserver. `p' may be used in -place of `publish-key'. +.B publish\-key +Publish the host's OpenPGP key to the public keyservers. `p' may be +used in place of `publish-key'. Note that there is no way to remove a +key from the public keyservers once it is published! .TP .B help Output a brief usage summary. `h' or `?' may be used in place of @@ -90,25 +91,41 @@ Other commands: .B diagnostics Review the state of the monkeysphere server host key and report on suggested changes. Among other checks, this includes making sure -there is a valid host key, that the key is published, that the sshd +there is a valid host key, that the key is not expired, that the sshd configuration points to the right place, etc. `d' may be used in place of `diagnostics'. .SH SETUP HOST AUTHENTICATION -To enable host verification via the monkeysphere, the host's key must -be published to the Web of Trust. This is not done by default. To -publish the host key to the keyservers, run the following command: +To enable host verification via the monkeysphere, an OpenPGP key must +be made out of the host's ssh key, and the key must be published to +the Web of Trust. This is not done by default. The first step is to +import the host's ssh key into a monkeysphere-style OpenPGP key. This +is done with the import\-key command. When importing a key, you must +specify the path to the host's ssh RSA key to import, and a hostname +to use as the key's user ID: -$ monkeysphere-host publish-key +# monkeysphere\-host import\-key /etc/ssh/ssh_host_rsa_key host.example.org + +On most systems, the ssh host RSA key is stored at +/etc/ssh/ssh_host_rsa_key. + +Once the host key has been imported, it must be published to the Web +of Trust so that users can retrieve the key when sshing to the host. +The host key is published to the keyserver with the publish\-key +command: + +$ monkeysphere\-host publish\-key In order for users logging into the system to be able to identify the host via the monkeysphere, at least one person (e.g. a server admin) will need to sign the host's key. This is done using standard OpenPGP keysigning techniques, usually: pull the key from the keyserver, -verify and sign the key, and then re-publish the signature. Once an -admin's signature is published, users logging into the host can use it -to validate the host's key. +verify and sign the key, and then re-publish the signature. Please +see http://web.monkeysphere.info/signing-host-keys/ for more +information. Once an admin's signature is published, users logging +into the host can use it to validate the host's key without having to +manually check the host key's fingerprint. .SH ENVIRONMENT @@ -116,29 +133,28 @@ The following environment variables will override those specified in the config file (defaults in parentheses): .TP MONKEYSPHERE_LOG_LEVEL -Set the log level (INFO). Can be SILENT, ERROR, INFO, VERBOSE, DEBUG, in -increasing order of verbosity. +Set the log level. Can be SILENT, ERROR, INFO, VERBOSE, DEBUG, in +increasing order of verbosity. (INFO) .TP MONKEYSPHERE_KEYSERVER -OpenPGP keyserver to use (pool.sks-keyservers.net). +OpenPGP keyserver to use. (pool.sks\-keyservers.net) .TP MONKEYSPHERE_PROMPT If set to `false', never prompt the user for confirmation. (true) - .SH FILES .TP -/etc/monkeysphere/monkeysphere-host.conf -System monkeysphere-host config file. +/etc/monkeysphere/monkeysphere\-host.conf +System monkeysphere\-host config file. .TP -/var/lib/monkeysphere/host/ssh_host_rsa_key -Copy of the host's private key in ssh format, suitable for use by -sshd. +/var/lib/monkeysphere/host/ssh_host_rsa_key.pub.gpg +A world-readable copy of the host's public key in OpenPGP format, +including all relevant self-signatures. .SH AUTHOR -Written by: +This man page was written by: Jameson Rollins <jrollins@fifthhorseman.net>, Daniel Kahn Gillmor <dkg@fifthhorseman.net>, Matthew Goins <mjgoins@openflows.com> @@ -146,7 +162,8 @@ Matthew Goins <mjgoins@openflows.com> .SH SEE ALSO .BR monkeysphere (1), -.BR monkeysphere-authentication (8), +.BR monkeysphere\-authentication (8), .BR monkeysphere (7), .BR gpg (1), -.BR ssh (1) +.BR ssh (1), +.BR sshd (8) |