Section 3: library functions
pam_sm_close_session – PAM service function to terminate session management Synopsis #define PAM_SM_SESSION #include <security/pam_modules.h> PAM_EXTERN int pam_sm_close_session(pam_handle_t *pamh, int flags, int argc, const char **argv); Description The pam_sm_close_session function is the service module’s implementation of the pam_close_session(3) interface. This function is called to terminate a session. The only valid value for flags is zero or:…
pam_sm_chauthtok – PAM service function for authentication token management Synopsis #define PAM_SM_PASSWORD #include <security/pam_modules.h> PAM_EXTERN int pam_sm_chauthtok(pam_handle_t *pamh, int flags, int argc, const char **argv); Description The pam_sm_chauthtok function is the service module’s implementation of the pam_chauthtok(3) interface. This function is used to (re-)set the authentication token of the user. Valid flags, which may be…
pam_sm_authenticate – PAM service function for user authentication Synopsis #define PAM_SM_AUTH #include <security/pam_modules.h> PAM_EXTERN int pam_sm_authenticate(pam_handle_t *pamh, int flags, int argc, const char **argv); Description The pam_sm_authenticate function is the service module’s implementation of the pam_authenticate(3) interface. This function performs the task of authenticating the user. Valid flags, which may be logically OR’d with PAM_SILENT,…
pam_sm_acct_mgmt – PAM service function for account management Synopsis #define PAM_SM_ACCOUNT #include <security/pam_modules.h> PAM_EXTERN int pam_sm_acct_mgmt(pam_handle_t *pamh, int flags, int argc, const char **argv); Description The pam_sm_acct_mgmt function is the service module’s implementation of the pam_acct_mgmt(3) interface. This function performs the task of establishing whether the user is permitted to gain access at this time….
pam_setcred – establish / delete user credentials Synopsis #include <security/pam_appl.h> int pam_setcred(pam_handle_t *pamh, int flags); Description The pam_setcred function is used to establish, maintain and delete the credentials of a user. It should be called to set the credentials after a user has been authenticated and before a session is opened for the user (with…
pam_set_item – set and update PAM informations Synopsis #include <security/pam_modules.h> int pam_set_item(pam_handle_t *pamh, int item_type, const void *item); Description The pam_set_item function allows applications and PAM service modules to access and to update PAM informations of item_type. For this a copy of the object pointed to by the item argument is created. The following item_types…
pam_set_data – set module internal data Synopsis #include <security/pam_modules.h> int pam_set_data(pam_handle_t *pamh, const char *module_data_name, void *data, void (*cleanup)(pam_handle_t *pamh, void *data, int error_status)); Description The pam_set_data function associates a pointer to an object with the (hopefully) unique string module_data_name in the PAM context specified by the pamh argument. PAM modules may be dynamically loadable…
pam_putenv – set or change PAM environment variable Synopsis #include <security/pam_appl.h> int pam_putenv(pam_handle_t *pamh, const char *name_value); Description The pam_putenv function is used to add or change the value of PAM environment variables as associated with the pamh handle. The pamh argument is an authentication handle obtained by a prior call to pam_start(). The name_value…
pam_prompt, pam_vprompt – interface to conversation function Synopsis #include <security/pam_ext.h> void pam_prompt(pam_handle_t *pamh, int style, char **response, const char *fmt, …); void pam_vprompt(pam_handle_t *pamh, int style, char **response, const char *fmt, va_list args); Description The pam_prompt function constructs a message from the specified format string and arguments and passes it to the conversation function as…
pam_open_session – start PAM session management Synopsis #include <security/pam_appl.h> int pam_open_session(pam_handle_t *pamh, int flags); Description The pam_open_session function sets up a user session for a previously successful authenticated user. The session should later be terminated with a call to pam_close_session(3). It should be noted that the effective uid, geteuid(2). of the application should be of…
pam_misc_setenv – BSD like PAM environment variable setting Synopsis #include <security/pam_misc.h> int pam_misc_setenv(pam_handle_t *pamh, const char *name, const char *value, intreadonly); Description This function performs a task equivalent to pam_putenv(3), its syntax is, however, more like the BSD style function; setenv(). The name and value are concatenated with an ‘=’ to form a name=value and…
pam_misc_paste_env – transcribing an environment to that of PAM Synopsis #include <security/pam_misc.h> int pam_misc_paste_env(pam_handle_t *pamh, const char *const *user); Description This function takes the supplied list of environment pointers and uploads its contents to the PAM environment. Success is indicated by PAM_SUCCESS. See Also pam_putenv(3), pam(8) Standards The pam_misc_paste_env function is part of the libpam_misc…
pam_misc_drop_env – liberating a locally saved environment Synopsis #include <security/pam_misc.h> int pam_misc_drop_env(char **env); Description This function is defined to complement the pam_getenvlist(3) function. It liberates the memory associated with env, overwriting with 0 all memory before free()ing it. See Also pam_getenvlist(3), pam(8) Standards The pam_misc_drop_env function is part of the libpam_misc Library and not defined…
pam_info, pam_vinfo – display messages to the user Synopsis #include <security/pam_ext.h> int pam_info(pam_handle_t *pamh, const char *fmt, …); int pam_vinfo(pam_handle_t *pamh, const char *fmt, va_list args); Description The pam_info function prints messages through the conversation function to the user. The pam_vinfo function performs the same task as pam_info() with the difference that it takes a…
pam_getenvlist – getting the PAM environment Synopsis #include <security/pam_appl.h> char **pam_getenvlist(pam_handle_t *pamh); Description The pam_getenvlist function returns a complete copy of the PAM environment as associated with the handle pamh. The PAM environment variables represent the contents of the regular environment variables of the authenticated user when service is granted. The format of the memory…
pam_getenv – get a PAM environment variable Synopsis #include <security/pam_appl.h> const char *pam_getenv(pam_handle_t *pamh, const char *name); Description The pam_getenv function searches the PAM environment list as associated with the handle pamh for an item that matches the string pointed to by name and returns a pointer to the value of the environment variable. The…
pam_get_user – get user name Synopsis #include <security/pam_modules.h> int pam_get_user(const pam_handle_t *pamh, const char **user, const char *prompt); Description The pam_get_user function returns the name of the user specified by pam_start(3). If no user was specified it what pam_get_item (pamh, PAM_USER, … ); would have returned. If this is NULL it obtains the username via…
pam_get_item – getting PAM informations Synopsis #include <security/pam_modules.h> int pam_get_item(const pam_handle_t *pamh, int item_type, const void **item); Description The pam_get_item function allows applications and PAM service modules to access and retrieve PAM informations of item_type. Upon successful return, item contains a pointer to the value of the corresponding item. Note, this is a pointer to…
pam_get_data – get module internal data Synopsis #include <security/pam_modules.h> int pam_get_data(const pam_handle_t *pamh, const char *module_data_name, const void **data); Description This function together with the pam_set_data(3) function is useful to manage module-specific data meaningful only to the calling PAM module. The pam_get_data function looks up the object associated with the (hopefully) unique string module_data_name in…
pam_get_authtok, pam_get_authtok_verify, pam_get_authtok_noverify – get authentication token Synopsis #include <security/pam_ext.h> int pam_get_authtok(pam_handle_t *pamh, int item, const char **authtok, const char *prompt); int pam_get_authtok_noverify(pam_handle_t *pamh, const char **authtok, const char *prompt); int pam_get_authtok_verify(pam_handle_t *pamh, const char **authtok, const char *prompt); Description The pam_get_authtok function returns the cached authentication token, or prompts the user if no token…