pam_get_authtok3Linux-PAM Manualpam_get_authtokpam_get_authtok_verifypam_get_authtok_noverifyget authentication token#include <security/pam_ext.h>int pam_get_authtokpam_handle_t *pamhint itemconst char **authtokconst char *promptint pam_get_authtok_noverifypam_handle_t *pamhconst char **authtokconst char *promptint pam_get_authtok_verifypam_handle_t *pamhconst char **authtokconst char *promptDESCRIPTION
The pam_get_authtok function returns the
cached authentication token, or prompts the user if no token is
currently cached. It is intended for internal use by Linux-PAM and
PAM service modules. Upon successful return,
authtok contains a pointer to the value of the
authentication token. Note, this is a pointer to the
actual data and should
not be free()'ed or
over-written!
The prompt argument specifies a prompt to use
if no token is cached. If a NULL pointer
is given, pam_get_authtok uses pre-defined prompts.
The following values are supported for item:
PAM_AUTHTOK
Returns the current authentication token. Called from
pam_sm_chauthtok3pam_get_authtok will
ask the user to confirm the new token by retyping it. If
a prompt was specified, "Retype" will be used as prefix.
PAM_OLDAUTHTOK
Returns the previous authentication token when changing
authentication tokens.
The pam_get_authtok_noverify function can
only be used for changing the password
(from pam_sm_chauthtok3). It returns the cached
authentication token, or prompts the user if no token is
currently cached. The difference to pam_get_authtok
is, that this function does not ask a second time for the password
to verify it. Upon successful return, authtok
contains a pointer to the value of the authentication token. Note,
this is a pointer to the
actual data and should
not be free()'ed or
over-written!
The pam_get_authtok_verify function can
only be used to verify a password for mistypes gotten by
pam_get_authtok_noverify3. This function asks a second time for the password
and verify it with the password provided by authtok
argument. In case of an error, the value of authtok
is undefined. Else this argument will point to the
actual data and should
not be free()'ed or
over-written!
OPTIONSpam_get_authtok honours the following module
options:
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.
The argument 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.
When password changing enforce the module to set the new
token to the one provided by a previously stacked
module. If no token is available
token changing will fail.
The default action is for the module to use the
following prompts when requesting passwords:
"New UNIX password: " and "Retype UNIX password: ".
The example word UNIX can
be replaced with this option, by default it is empty.
RETURN VALUESPAM_AUTH_ERR
Authentication token could not be retrieved.
PAM_AUTHTOK_ERR
New authentication could not be retrieved.
PAM_SUCCESS
Authentication token was successfully retrieved.
PAM_SYSTEM_ERR
No space for an authentication token was provided.
PAM_TRY_AGAIN
New authentication tokens mismatch.
SEE ALSOpam8STANDARDS
The pam_get_authtok function is a Linux-PAM
extensions.