Cameron Katri's Manual Page Server

Manual Page Search Parameters
PAM_GET_ITEM(3) Library Functions Manual PAM_GET_ITEM(3)

pam_get_item — get PAM information

Pluggable Authentication Module Library (libpam, -lpam)

#include <sys/types.h>
#include <security/pam_appl.h>

int
pam_get_item(const pam_handle_t *pamh, int item_type, const void **item);

The pam_get_item function stores a pointer to the item specified by the item_type argument in the location specified by the item argument. The item is retrieved from the PAM context specified by the pamh argument. The following item types are recognized:

The name of the requesting service.
The name of the user the application is trying to authenticate.
The name of the current terminal.
The name of the applicant's host.
A struct pam_conv describing the current conversation function.
The current authentication token.
The expired authentication token.
The name of the applicant.
The prompt to use when asking the applicant for a user name to authenticate as.
The prompt to use when asking the applicant for an authentication token.
The prompt to use when asking the applicant for an expired authentication token prior to changing it.

See pam_start(3) for a description of struct pam_conv.

The pam_get_item function returns one of the following values:

[PAM_SYMBOL_ERR]
Invalid symbol.
[PAM_SYSTEM_ERR]
System error.

pam(3), pam_set_item(3), pam_start(3), pam_strerror(3)

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

The pam_get_item 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.

December 21, 2007 macOS