pam_get_item3

Usage

Overview

The pam_get_item() function stores a pointer to the item specified by the item_type argument in the location pointed to by the item argument. The item is retrieved from the PAM context specified by the pamh argument. If pam_get_item() fails, the item argument is untouched.

The following item types are recognized:

PAM_SERVICE

The name of the requesting service.

PAM_USER

The name of the user the application is trying to authenticate.

PAM_TTY

The name of the current terminal.

PAM_RHOST

The name of the applicant's host.

PAM_CONV

A struct pam_conv describing the current conversation function.

PAM_AUTHTOK

The current authentication token.

PAM_OLDAUTHTOK

The expired authentication token.

PAM_RUSER

The name of the applicant.

PAM_USER_PROMPT

The prompt to use when asking the applicant for a user name to authenticate as.

PAM_AUTHTOK_PROMPT

The prompt to use when asking the applicant for an authentication token.

PAM_OLDAUTHTOK_PROMPT

The prompt to use when asking the applicant for an expired authentication token prior to changing it.

PAM_HOST

The name of the host the application runs on.

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

Return values

The pam_get_item() function returns one of the following values:

[PAM_SUCCESS]

Success.

[PAM_BAD_ITEM]

Unrecognized or restricted item.