openpam(3) [netbsd man page]

OPENPAM(3)						   BSD Library Functions Manual 						OPENPAM(3)

NAME

     openpam_borrow_cred, openpam_free_data, openpam_free_envlist, openpam_get_option, openpam_log, openpam_nullconv, openpam_readline,
     openpam_restore_cred, openpam_set_option, openpam_subst, openpam_ttyconv, pam_error, pam_get_authtok, pam_info, pam_prompt, pam_setenv,
     pam_verror, pam_vinfo, pam_vprompt -- Pluggable Authentication Modules Library

LIBRARY

     Pluggable Authentication Module Library (libpam, -lpam)

SYNOPSIS

     #include <security/openpam.h>

     int
     openpam_borrow_cred(pam_handle_t *pamh, const struct passwd *pwd);

     void
     openpam_free_data(pam_handle_t *pamh, void *data, int status);

     void
     openpam_free_envlist(char **envlist);

     const char *
     openpam_get_option(pam_handle_t *pamh, const char *option);

     void
     openpam_log(int level, const char *fmt, ...);

     int
     openpam_nullconv(int n, const struct pam_message **msg, struct pam_response **resp, void *data);

     char *
     openpam_readline(FILE *f, int *lineno, size_t *lenp);

     int
     openpam_restore_cred(pam_handle_t *pamh);

     int
     openpam_set_option(pam_handle_t *pamh, const char *option, const char *value);

     int
     openpam_subst(const pam_handle_t *pamh, char *buf, size_t *bufsize, const char *template);

     int
     openpam_ttyconv(int n, const struct pam_message **msg, struct pam_response **resp, void *data);

     int
     pam_error(const pam_handle_t *pamh, const char *fmt, ...);

     int
     pam_get_authtok(pam_handle_t *pamh, int item, const char **authtok, const char *prompt);

     int
     pam_info(const pam_handle_t *pamh, const char *fmt, ...);

     int
     pam_prompt(const pam_handle_t *pamh, int style, char **resp, const char *fmt, ...);

     int
     pam_setenv(pam_handle_t *pamh, const char *name, const char *value, int overwrite);

     int
     pam_verror(const pam_handle_t *pamh, const char *fmt, va_list ap);

     int
     pam_vinfo(const pam_handle_t *pamh, const char *fmt, va_list ap);

     int
     pam_vprompt(const pam_handle_t *pamh, int style, char **resp, const char *fmt, va_list ap);

DESCRIPTION

     These functions are OpenPAM extensions to the PAM API.  Those named pam_*() are, in the author's opinion, logical and necessary extensions to
     the standard API, while those named openpam_*() are either simple convenience functions, or functions intimately tied to OpenPAM implementa-
     tion details, and therefore not well suited to standardization.

SEE ALSO

     openpam_borrow_cred(3), openpam_free_data(3), openpam_free_envlist(3), openpam_get_option(3), openpam_log(3), openpam_nullconv(3),
     openpam_readline(3), openpam_restore_cred(3), openpam_set_option(3), openpam_subst(3), openpam_ttyconv(3), pam_error(3), pam_get_authtok(3),
     pam_info(3), pam_prompt(3), pam_setenv(3), pam_verror(3), pam_vinfo(3), pam_vprompt(3)

STANDARDS

     X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules, June 1997.

AUTHORS

     The OpenPAM library and this manual page were developed for the FreeBSD Project by ThinkSec AS and Network Associates Laboratories, the Secu-
     rity Research Division of Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 (``CBOSS''), as part of the DARPA CHATS
     research program.

BSD
								 December 18, 2011							       BSD

Check Out this Related Man Page

PAM_GET_AUTHTOK(3)					   BSD Library Functions Manual 					PAM_GET_AUTHTOK(3)

NAME

     pam_get_authtok -- retrieve authentication token

LIBRARY

     Pluggable Authentication Module Library (libpam, -lpam)

SYNOPSIS

     #include <sys/types.h>
     #include <security/pam_appl.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.  Either way, a
     pointer to the authentication token is stored in the location pointed to by the authtok argument.

     The item argument must have one of the following values:

     PAM_AUTHTOK	 Returns the current authentication token, or the new token when changing authentication tokens.

     PAM_OLDAUTHTOK	 Returns the previous authentication token when changing authentication tokens.

     The prompt argument specifies a prompt to use if no token is cached.  If it is NULL, the PAM_AUTHTOK_PROMPT or PAM_OLDAUTHTOK_PROMPT item, as
     appropriate, will be used.  If that item is also NULL, a hardcoded default prompt will be used.  Either way, the prompt is expanded using
     openpam_subst(3) before it is passed to the conversation function.

     If pam_get_authtok is called from a module and the authtok_prompt / oldauthtok_prompt option is set in the policy file, the value of that
     option takes precedence over both the prompt argument and the PAM_AUTHTOK_PROMPT / PAM_OLDAUTHTOK_PROMPT item.

     If item is set to PAM_AUTHTOK and there is a non-null PAM_OLDAUTHTOK item, pam_get_authtok will ask the user to confirm the new token by
     retyping it.  If there is a mismatch, pam_get_authtok will return PAM_TRY_AGAIN.

RETURN VALUES

     The pam_get_authtok function returns one of the following values:

     [PAM_BUF_ERR]	 Memory buffer error.

     [PAM_CONV_ERR]	 Conversation failure.

     [PAM_SYSTEM_ERR]	 System error.

     [PAM_TRY_AGAIN]	 Try again.

SEE ALSO

     openpam_subst(3), pam(3), pam_get_item(3), pam_get_user(3), pam_strerror(3)

STANDARDS

     The pam_get_authtok function is an OpenPAM extension.

AUTHORS

     The pam_get_authtok function and this manual page were developed for the FreeBSD Project by ThinkSec AS and Network Associates Laboratories,
     the Security Research Division of Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 (``CBOSS''), as part of the DARPA
     CHATS research program.

BSD
								 December 18, 2011							       BSD

Linux and UNIX Man Pages

openpam(3) [netbsd man page]

Check Out this Related Man Page