pam_canonicalize_user(8)

pam_canonicalize_user8

Get user name and canonicalize it

Usage

pam_canonicalize_user.so

Overview

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.

Options

This module does not recognise any options.

Module types provided

Only the auth module type is provided.

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.

Examples

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

        auth required pam_canonicalize_user.so

Releases

2 releases since Debian 13 (Trixie); the text changed 1 time.

  1. 13
  2. Arch

Author

pam_canonicalize_user was written by Dmitry V. Levin <[email protected]>.

From pam 1.7.3-1 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.