NAME

pam_get_mapped_authtok - get mapped password for the user

SYNOPSIS

#include <security/pam_appl.h>

int pam_get_mapped_authtok (
    pam_handle_t    *pamh,
    const char      *target_module_username,
    const char      *target_module_type,
    const char      *target_authn_domain,
    size_t          *target_authtok_len,
    unsigned char  **target_module_authtok
);

DESCRIPTION

The pam_get_mapped_authtok() function is used to obtain a password for the given user. 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_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. A NULL value may be passed to allow a default target domain to be used.

target_authtok_len (out)

The length of the target password.

target_module_authtok (out)

The target password.

RETURN VALUE

One of 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_PERM_DENIED]

The caller does not possess the required authority.

[PAM_OPEN_ERR]

Failure when dynamically loading a service module.

[PAM_SYMBOL_ERR]

Symbol not found.

[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.