NAME

pam_sm_set_mapped_username - set a username

SYNOPSIS

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

int pam_sm_set_mapped_username (
    pam_handle_t    *pamh,
    char            *target_module_username,
    char            *	arget_module_type,
    char            *	arget_authn_domain,
    int              argc,
    const char     **argv
);

DESCRIPTION

The pam_sm_set_mapped_username() function stores a username using the target_module_type and target_authn_domain parameters supplied.

The arguments for pam_sm_set_mapped_username() are:

pamh (in)

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

target_module_username (in)

The target username to be stored.

target_module_type (in)

The target authentication type; for example, UNIX.

target_authn_domain (in)

The target domain; for example, the UNIX hostname.

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.