NAME

pam_sm_get_mapped_authtok - get password for username

SYNOPSIS

#include <security/pam_appl.h>
#include <security/pam_modules.h>

int pam_sm_get_mapped_authtok (
    pam_handle_t    *pamh,
    char            *target_module_username,
    char            *	arget_module_type,
    char            *	arget_authn_domain,
    size_t          *target_authtok_len,
    unsigned char  **	arget_module_authtok,
    int              argc,
    const char **    argv
);

DESCRIPTION

The pam_sm_get_mapped_authtok() function is used to obtain a password for the username supplied. Any authorization data required by the implementation of this interface must be present in the PAM handle. The function checks the authorization data provided in the PAM handle to ensure that the caller is authorized to retrieve the password for the target_module_username.

The caller should clear memory containing the returned password immediately after using the password.

The arguments for pam_sm_get_mapped_authtok() are:

pamh (in)

The PAM authentication handle, returned from a previous call to pam_start().

target_module_username (in)

The target username used for the mapping.

target_module_type (in)

The target authentication type; for example, UNIX.

target_authn_domain (in)

The target domain; for example, the UNIX hostname.

target_authtok_len (out)

The length of the target password.

target_module_authtok (out)

The target password.

argc (in)

The argc argument represents the number of module options defined in the PAM configuration.

argv (in)

Specifies the module options, which are interpreted and processed by the mapping module. If an unknown option is passed in, an error should be logged and the option ignored.

RETURN VALUE

The following PAM status codes shall be returned:

[PAM_SUCCESS]

Successful completion.

[PAM_USER_UNKNOWN]

The username supplied is not recognized.

[PAM_MODULE_UNKNOWN]

The mapping service does not support this module type.

[PAM_DOMAIN_UNKNOWN]

The mapping service does not support this module's domain.

[PAM_SERVICE_ERR]

The mapping service failed in reading/writing data.

[PAM_IGNORE]

Ignore underlying session module regardless of whether the control flag is required, optional or sufficient.

[PAM_PERM_DENIED]

The caller does not possess the required authority.

[PAM_SYSTEM_ERR]

[??]"">
System error.

[PAM_BUF_ERR]

[??]"">
Memory buffer error.

[PAM_CONV_ERR]

[??]"">
Conversation error.

[??] Some characters or strings that appear in the printed document are not easily representable using HTML.