enable use of hkps (closes: MS #1749)

[monkeysphere.git] / man / man8 / monkeysphere-authentication.8

diff --git a/man/man8/monkeysphere-authentication.8 b/man/man8/monkeysphere-authentication.8
index 68a7a1b60533fc9753ef9d119a5a5caa1319cc35..ea9debd33d99618ea785c9a1336e3c3545c6abb5 100644 (file)
--- a/man/man8/monkeysphere-authentication.8
+++ b/man/man8/monkeysphere-authentication.8
@@ -1,92 +1,105 @@
-.TH MONKEYSPHERE-SERVER "8" "June 2008" "monkeysphere" "User Commands"
+.TH MONKEYSPHERE-AUTHENTICATION "8" "January 2010" "monkeysphere" "System Commands"

 
 .SH NAME
 
 
 .SH NAME
 

-monkeysphere-authentication \- Monkeysphere authentication admin tool.
+monkeysphere\-authentication - Monkeysphere authentication admin tool.

 
 .SH SYNOPSIS
 
 
 .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
 
 
 .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 key-based authentication.  OpenPGP keys are tracked via
+GnuPG, and added to the authorized_keys 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
 
 .SH SUBCOMMANDS

-\fBmonkeysphere-authentication\fP takes various subcommands.(Users may use the
-abbreviated subcommand in parentheses):

 
 

+\fBmonkeysphere\-authentication\fP takes various subcommands:

 .TP
 .TP

-.B update-users (u) [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 queried for keys associated with that
-user ID, optionally querying a keyserver.  If an acceptable key is found (see
-KEY ACCEPTABILITY in monkeysphere(7)), the key is added to the account's
-monkeysphere-controlled authorized_keys file.  If the 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'.
-
-\" XXX
-
+.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
+queried for keys associated with that user ID, optionally querying a
+keyserver.  If an acceptable key is found (see KEY ACCEPTABILITY in
+monkeysphere(7)), the key is added to the account's
+monkeysphere-controlled authorized_keys file.  If the
+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'.

 .TP
 .TP

-.B add-id-certifier (c+) KEYID
+.B refresh\-keys
+Refresh all keys in the monkeysphere-authentication keyring.  If no
+accounts are specified, then all accounts on the system are processed.
+`r' may be used in place of `refresh\-keys'.
+.TP
+.B add\-id\-certifier KEYID|FILE

 Instruct system to trust user identity certifications made by KEYID.
 Instruct system to trust user identity certifications made by KEYID.

-Using the `-n' or `--domain' option allows you to indicate that you
+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

 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
 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
 `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
 .TP

-.B remove-id-certifier (c-) KEYID
+.B remove\-id\-certifier KEYID

 Instruct system to ignore user identity certifications made by 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
 .TP

-.B list-id-certifiers (c)
+.B list\-id\-certifiers

 List key IDs trusted by the system to certify user identities.  `c'
 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 version
+Show the monkeysphere version number.  `v' may be used in place of
+`version'.

 .TP
 .B help
 Output a brief usage summary.  `h' or `?' may be used in place of
 `help'.
 .TP
 .B help
 Output a brief usage summary.  `h' or `?' may be used in place of
 `help'.

-.TP
-.B version
-show version number

 
 

-.SH "EXPERT" SUBCOMMANDS
-Some commands are very unlikely to be needed by most administrators.
-These commands must follow the word `expert'.
+
+Other commands:
+.TP
+.B 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
 .TP

-.B diagnostics (d)
-Review the state of the server with respect to authentication.
+.B diagnostics
+Review the state of the server with respect to authentication.  `d'
+may be used in place of `diagnostics'.

 .TP
 .TP

-.B gpg-cmd
-Execute a gpg command on the gnupg-authentication keyring as the
-monkeysphere user.  This takes a single command (multiple gpg
-arguments need to be quoted).  Use this command with caution, as
-modifying the gnupg-authentication keyring can affect ssh user
-authentication.
+.B gpg\-cmd
+Execute a gpg command, as the monkeysphere user, on the monkeysphere
+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
+.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
 
 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
 
 where KEYID is the key ID of the server admin, or whoever's
 certifications should be acceptable to the system for the purposes of


@@ -94,75 +107,103 @@ 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
 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
 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.
 
 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
 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/authorized_keys/%u
 
 
 AuthorizedKeysFile /var/lib/monkeysphere/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
 
 The following environment variables will override those specified in
 revocations and expirations can be processed in a timely manner.
 
 .SH ENVIRONMENT
 
 The following environment variables will override those specified in

-(defaults in parentheses):
+the config file (defaults in parentheses):

 .TP
 MONKEYSPHERE_MONKEYSPHERE_USER
 .TP
 MONKEYSPHERE_MONKEYSPHERE_USER

-User to control authentication keychain (monkeysphere).
+User to control authentication keychain. (monkeysphere)

 .TP
 MONKEYSPHERE_LOG_LEVEL
 .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
 .TP
 MONKEYSPHERE_KEYSERVER

-OpenPGP keyserver to use (subkeys.pgp.net).
+OpenPGP keyserver to use. (pool.sks\-keyservers.net)

 .TP
 MONKEYSPHERE_AUTHORIZED_USER_IDS
 .TP
 MONKEYSPHERE_AUTHORIZED_USER_IDS

-Path to user authorized_user_ids file
-(%h/.monkeysphere/authorized_user_ids).
+Path to user's authorized_user_ids file. %h gets replaced with the
+user's homedir, %u with the username.
+(%h/.monkeysphere/authorized_user_ids)

 .TP
 MONKEYSPHERE_RAW_AUTHORIZED_KEYS
 .TP
 MONKEYSPHERE_RAW_AUTHORIZED_KEYS

-Path to user-controlled authorized_keys file.  `-' means not to add
-user-controlled file (%h/.ssh/authorized_keys).
+Path to regular ssh-style authorized_keys file to append to
+monkeysphere-generated authorized_keys.  `none' means not to add any
+raw authorized_keys file.  %h gets replaced with the user's homedir,
+%u with the username. (%h/.ssh/authorized_keys)
+.TP
+MONKEYSPHERE_PROMPT
+If set to `false', never prompt the user for confirmation. (true)
+.TP
+MONKEYSPHERE_STRICT_MODES
+If set to `false', ignore too-loose permissions on known_hosts,
+authorized_keys, and authorized_user_ids files.  NOTE: setting this to
+false may expose users to abuse by other users on the system. (true)

 
 .SH FILES
 
 .TP
 
 .SH FILES
 
 .TP

-/etc/monkeysphere/monkeysphere-authentication.conf
+/etc/monkeysphere/monkeysphere\-authentication.conf

 System monkeysphere-authentication config file.
 .TP
 System monkeysphere-authentication config file.
 .TP

-/var/lib/monkeysphere/authentication/authorized_keys/USER
+/etc/monkeysphere/monkeysphere\-authentication\-x509\-anchors.crt
+If monkeysphere-authentication is configured to query an hkps
+keyserver, it will use X.509 Certificate Authority certificates in
+this file to validate any X.509 certificates used by the keyserver.
+.TP
+/var/lib/monkeysphere/authorized_keys/USER

 Monkeysphere-generated user authorized_keys files.
 Monkeysphere-generated user authorized_keys files.

+.TP
+~/.monkeysphere/authorized_user_ids
+A list of OpenPGP user IDs, one per line.  OpenPGP keys with an
+exactly-matching User ID (calculated valid by the designated identity
+certifiers), will have any valid authorization-capable keys or subkeys
+added to the given user's authorized_keys file.

 
 .SH AUTHOR
 
 
 .SH AUTHOR
 

-Written by Jameson Rollins <jrollins@fifthhorseman.net>, Daniel Kahn
-Gillmor <dkg@fifthhorseman.net>
+This man page was written by:
+Jameson Rollins <jrollins@finestructure.net>,
+Daniel Kahn Gillmor <dkg@fifthhorseman.net>,
+Matthew Goins <mjgoins@openflows.com>

 
 .SH SEE ALSO
 
 .BR monkeysphere (1),
 
 .SH SEE ALSO
 
 .BR monkeysphere (1),

-.BR monkeysphere-host (8),
+.BR monkeysphere\-host (8),

 .BR monkeysphere (7),
 .BR gpg (1),
 .BR monkeysphere (7),
 .BR gpg (1),

-.BR ssh (1)
+.BR ssh (1),
+.BR sshd (8),
+.BR sshd_config (5)