6.2. pam_canonicalize_user - get user name and canonicalize it
Prev | Chapter 6. A reference guide for available modules | Next

## 6.2. pam_canonicalize_user - get user name and canonicalize it

`pam_canonicalize_user.so`

### 6.2.1. DESCRIPTION

This PAM module uses the name of the user obtained via pam_get_user(3) as a key to query the password database, and replaces PAM_USER with the pw_name value that has been returned.

### 6.2.2. OPTIONS

This module does not recognise any options.

### 6.2.3. MODULE TYPES PROVIDED

Only the `auth` module type is provided.

### 6.2.4. RETURN VALUES

PAM_IGNORE

  The user name was set successfully.

PAM_USER_UNKNOWN

  The user was not found.

PAM_SYSTEM_ERR

  The application did not supply neither a user name nor a conversation method.

PAM_INCOMPLETE

  The conversation method supplied by the application is waiting for an event.

PAM_CONV_ERR

  The conversation method supplied by the application failed to obtain the user name.

PAM_ABORT

  Error resuming an old conversation.

PAM_BUF_ERR

  Memory buffer error.

### 6.2.5. EXAMPLES

Prepend the PAM auth stack with the following line to canonicalize the user name before the authentication:

            auth required pam_canonicalize_user.so

### 6.2.6. AUTHOR

pam_canonicalize_user was written by Dmitry V. Levin <ldv@strace.io>.

Prev | Up | Next
6.1. pam_access - logdaemon style login access control | Home | 6.3. pam_debug - debug the PAM stack