rooty/yubico-pam
1
0
Fork 0
mirror of https://github.com/Yubico/yubico-pam.git synced 2025-02-27 06:54:15 +01:00
Code Issues Projects Releases Wiki Activity

Revise pam_yubico.8.txt man page

Browse Source 
This makes the style of the man page more consistent with terms used
through the project in terms of spelling, etc.
This commit is contained in:
Karol Babioch 2018-05-02 14:25:10 +02:00
parent 67a40dbd2d
commit 3ecd8ce267
1 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
pam_yubico.8.txt
View File

@ -18,31 +18,31 @@ The module is for authentication of YubiKeys, either with online validation of O
Turns on debugging.
*debug_file*=_file_::
File name to write debug to, the file must exist and be a regular file. Defaults to stdout.
File name to write debug to, the file must exist and be a regular file. Defaults to stdout.
*mode=*[_client_|_challenge-response_]::
Set the mode of operation, client for OTP validation and challenge-response for challenge-response validation, client is the default.
Mode of operation, client for OTP validation and challenge-response for challenge-response validation. Defaults to client.
*authfile*=_file_::
Set the location of the file that holds the mappings of Yubikey token IDs to user names. The format is username:first_public_id:second_public_id:... default location of the file is $HOME/.yubico/authorized_yubikeys.
Location of the file that holds the mappings of Yubikey token IDs to user names. The format is username:first_public_id:second_public_id:... Default location of the file is $HOME/.yubico/authorized_yubikeys.
*id*=_id_::
Set to your client identity.
Your API client identity for the validation server.
*key*=_key_::
Set to your client key in base64 format. The client key is also known as API key, and provides integrity in the communication between the client (you) and the validation server. If you want to get one for use with the default YubiCloud service, please go to https://upgrade.yubico.com/getapikey/
Your client key in base64 format. The client key is also known as API key, and provides integrity in the communication between the client (you) and the validation server. If you want to get one for use with the default YubiCloud service, please go to: https://upgrade.yubico.com/getapikey/
*alwaysok*::
Set to enable all authentication attempts to succeed (aka presentation mode).
Succeed with all authentication attempts (*dangerous*, presentation mode).
*try_first_pass*::
Before prompting the user for their password, the module first tries the previous stacked module´s password in case that satisfies this module as well.
*use_first_pass*::
The argument use_first_pass forces the module to use a previous stacked modules password and will never prompt the user - if no password is available or the password is not appropriate, the user will be denied access.
Forces the module to use a previous stacked modules password and will never prompt the user - if no password is available or the password is not appropriate, the user will be denied access.
*nullok*::
If set, don’t fail when there are no tokens declared for the user in the authorization mapping files or in LDAP. This can be used to make YubiKey authentication optional unless the user has associated tokens.
Don’t fail when there are no tokens declared for the user in the authorization mapping files or in LDAP. This can be used to make YubiKey authentication optional unless the user has associated tokens.
*urllist*=_list_::
List of URL templates to be used. This is set by calling ykclient_set_url_bases.
@ -50,38 +50,38 @@ The list should be in the format:
https://api1.example.com/wsapi/2.0/verify;https://api2.example.com/wsapi/2.0/verify
*url*=_url_::
This option should not be used, please use the urllist option instead. Set the URL template to use, this is set by calling ykclient_set_url_template. The URL should be set in the format
This option should not be used, please use the urllist option instead. Set the URL template to use, this is set by calling ykclient_set_url_template. The URL should be set in the format
https://api.example.com/wsapi/2.0/verify?id=%d&otp=%s
*capath*=_path_::
Specify the path where X509 certificates are stored. This is required if 'https' or 'ldaps' are used in 'url' and 'ldap_uri' respectively.
The path where X509 certificates are stored. This is required if 'https' or 'ldaps' are used in 'url' and 'ldap_uri', respectively.
*cainfo*=_file_::
Option to allow usage of a CA bundle instead of path.
Option to allow for usage of a CA bundle instead of path.
*proxy*=_proxy_::
Specify a proxy to connect to the validation server. Valid schemes are http://, https://, socks4://, socks4a://, socks5:// or socks5h://. Socks5h asks the proxy to do the dns resolving. If no scheme or port is specified HTTP proxy port 1080 will be used. E.g. socks5h://user:pass@10.10.0.1:1080
The proxy to connect to the validation server. Valid schemes are http://, https://, socks4://, socks4a://, socks5:// or socks5h://. Socks5h asks the proxy to do the DNS resolving. If no scheme or port is specified HTTP proxy port 1080 will be used. Example: socks5h://user:pass@10.10.0.1:1080
*verbose_otp*::
This argument is used to show the OTP (One Time Password) when it is entered, i.e. to enable terminal echo of entered characters. You are advised to not use this, if you are using two factor authentication because that will display your password on the screen. This requires the service using the PAM module to display custom fields. This option can not be used with OpenSSH.
Show the One-Time Password when it is entered, i.e. to enable terminal echo of entered characters. You are advised to not use this, if you are using two factor authentication because that will display your password on the screen. This requires the service using the PAM module to display custom fields. This option can not be used with OpenSSH.
*ldap_uri*=_uri_::
Specify the LDAP server URI (e.g. ldap://localhost).
The LDAP server URI (e.g. ldap://localhost).
*ldap_server*=_server_::
Specify the LDAP server host (default LDAP port is used). *Deprecated. Use 'ldap_uri' instead.*
The LDAP server host (default LDAP port is used). *Deprecated. Use 'ldap_uri' instead.*
*ldapdn*=_dn_::
The dn where the users are stored (eg: ou=users,dc=domain,dc=com). If 'ldap_filter' is used this is the base from which the subtree search will be performed.
The distinguished name (DN) where the users are stored (eg: ou=users,dc=domain,dc=com). If 'ldap_filter' is used this is the base from which the subtree search will be performed.
*user_attr*=_attr_::
The LDAP attribute used to store user names (eg:cn).
*yubi_attr*=_attr_::
The LDAP attribute used to store the Yubikey id.
The LDAP attribute used to store the Yubikey ID.
*yubi_attr_prefix*=_prefix_::
The prefix of the LDAP attribute's value, in case of a generic attribute, used to store several types of ids.
The prefix of the LDAP attribute's value, in case of a generic attribute, used to store several types of IDs.
*token_id_length*=_length_::
Length of ID prefixing the OTP (this is 12 if using the YubiCloud).
@ -93,13 +93,13 @@ The user to attempt a LDAP bind as.
The password to use on LDAP bind.
*ldap_filter*=_filter_::
An ldap filter to use for attempting to find the correct object in LDAP. In this string %u will be replaced with the username.
A LDAP filter to use for attempting to find the correct object in LDAP. In this string `%u` will be replaced with the username.
*ldap_cacertfile*=_cacertfile_::
Ca certfile for the LDAP connection.
CA certitificate file for the LDAP connection.
*chalresp_path*=_path_::
Path of a system wide directory where challenge-response files can be found for users. Default location is $HOME/.yubico/
Path of a system-wide directory where challenge-response files can be found for users. Default location is `$HOME/.yubico/`.
== EXAMPLES
@ -112,11 +112,11 @@ Path of a system wide directory where challenge-response files can be found for
== FILES
*$HOME/.yubico/authorized_yubikeys*::
If *authfile* is not set this file is used for the mapping between YubiKey public id and in _client_ mode.
If *authfile* is not set, this file is used for the mapping between YubiKey public ID and in _client_ mode.
*$HOME/.yubico/challenge*::
*$HOME/.yubico/challenge-_serial_number_*::
If *chalresp_path* is not set these files are used to hold next challenge and expected response for the user in _challenge-response_ mode. If *chalresp_path* is set the filename will be username instead of challenge.
If *chalresp_path* is not set, these files are used to hold next challenge and expected response for the user in _challenge-response_ mode. If *chalresp_path* is set the filename will be _username_ instead of _challenge_.
== BUGS
Report yubico-pam bugs in the issue tracker: https://github.com/Yubico/yubico-pam/issues