From f326d04ccd16631d57134487e56bb73074f0dd0e Mon Sep 17 00:00:00 2001 From: Thorsten Kukuk Date: Wed, 3 Dec 2008 14:16:33 +0000 Subject: Relevant BUGIDs: Purpose of commit: new feature Commit summary: --------------- 2008-12-03 Thorsten Kukuk * doc/man/Makefile.am: Add pam_get_authtok.3.xml. * doc/man/pam_get_authtok.3.xml: New. * libpam/Makefile.am: Add pam_get_authtok.c. * libpam/libpam.map: Export pam_get_authtok. * libpam/pam_get_authtok.c: New. * libpam/pam_private.h: Add mod_argc and mod_argv to pam_handle. * libpam_include/security/pam_ext.h: Add pam_get_authtok prototype. * modules/pam_cracklib/pam_cracklib.c: Use pam_get_authtok. * modules/pam_pwhistory/pam_pwhistory.c: Likewise. * po/POTFILES.in: Add libpam/pam_get_authtok.c. * xtests/tst-pam_cracklib1.c: Adjust error codes. * modules/pam_timestamp/Makefile.am: Remove hmactest.c from EXTRA_DIST. * po/*.po: Regenerated. --- doc/man/.cvsignore | 1 + doc/man/Makefile.am | 8 +- doc/man/pam_get_authtok.3.xml | 191 ++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 196 insertions(+), 4 deletions(-) create mode 100644 doc/man/pam_get_authtok.3.xml (limited to 'doc') diff --git a/doc/man/.cvsignore b/doc/man/.cvsignore index d1987738..cc2afe9b 100644 --- a/doc/man/.cvsignore +++ b/doc/man/.cvsignore @@ -18,6 +18,7 @@ pam_fail_delay.3 pam_get_data.3 pam_getenv.3 pam_getenvlist.3 +pam_get_authtok.3 pam_get_item.3 pam_get_user.3 pam_info.3 diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index 52e5caab..9b229b16 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -12,8 +12,8 @@ man_MANS = pam.3 PAM.8 pam.8 pam.conf.5 pam.d.5 \ pam_chauthtok.3 pam_close_session.3 pam_conv.3 \ pam_end.3 pam_error.3 \ pam_fail_delay.3 pam_xauth_data.3 \ - pam_get_data.3 pam_get_item.3 pam_get_user.3 pam_getenv.3 \ - pam_getenvlist.3 \ + pam_get_authtok.3 pam_get_data.3 pam_get_item.3 pam_get_user.3 \ + pam_getenv.3 pam_getenvlist.3 \ pam_info.3 \ pam_open_session.3 \ pam_prompt.3 pam_putenv.3 \ @@ -29,8 +29,8 @@ XMLS = pam.3.xml pam.8.xml \ pam_chauthtok.3.xml pam_close_session.3.xml pam_conv.3.xml \ pam_end.3.xml pam_error.3.xml \ pam_fail_delay.3.xml pam_xauth_data.3 \ - pam_get_data.3.xml pam_get_item.3.xml pam_get_user.3.xml \ - pam_getenv.3.xml pam_getenvlist.3.xml \ + pam_get_authtok.3.xml pam_get_data.3.xml pam_get_item.3.xml \ + pam_get_user.3.xml pam_getenv.3.xml pam_getenvlist.3.xml \ pam_info.3.xml \ pam_open_session.3.xml \ pam_prompt.3.xml pam_putenv.3.xml \ diff --git a/doc/man/pam_get_authtok.3.xml b/doc/man/pam_get_authtok.3.xml new file mode 100644 index 00000000..bac30be9 --- /dev/null +++ b/doc/man/pam_get_authtok.3.xml @@ -0,0 +1,191 @@ + + + + + + + pam_get_authtok + 3 + Linux-PAM Manual + + + + pam_get_authtok + get authentication token + + + + + + + #include <security/pam_ext.h> + + int pam_get_authtok + pam_handle_t *pamh + int item + const char **authtok + const char *prompt + + + + + + DESCRIPTION + + 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_chauthtok3 + pam_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. + + + + + + + + OPTIONS + + pam_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. + + + + + + + + + RETURN VALUES + + + PAM_AUTH_ERR + + + Authentication token could not be retrieved. + + + + + PAM_AUTHTOK_ERR + + + New authentication could not be retrieved. + + + + + PAM_SUCCESS + + + Authentication token was successful retrieved. + + + + + PAM_SYSTEM_ERR + + + No space for an authentication token was provided. + + + + + PAM_TRY_AGAIN + + + New authentication tokens mismatch. + + + + + + + + SEE ALSO + + + pam8 + + + + + + STANDARDS + + The pam_get_authtok function is a Linux-PAM + extensions. + + + + -- cgit v1.2.3