6.23. pam_nologin - prevent non-root users from login

pam_nologin.so [ file= /path/nologin ] [ successok ]

6.23.1. DESCRIPTION

pam_nologin is a PAM module that prevents users from logging into the system when /var/run/nologin or /etc/nologin exists. The contents of the file are displayed to the user. The pam_nologin module has no effect on the root user's ability to log in.

6.23.2. OPTIONS

  • file=/path/nologin

    • Use this file instead the default /var/run/nologin or /etc/nologin .
  • successok

    • Return PAM_SUCCESS if no file exists, the default is PAM_IGNORE.

6.23.3. MODULE TYPES PROVIDED

The auth and account module types are provided.

6.23.4. RETURN VALUES

  • PAM_AUTH_ERR

    • The user is not root and /etc/nologin exists, so the user is not permitted to log in.
  • PAM_BUF_ERR

    • Memory buffer error.
  • PAM_IGNORE

    • This is the default return value.
  • PAM_SUCCESS

    • Success: either the user is root or the nologin file does not exist.
  • PAM_USER_UNKNOWN

    • User not known to the underlying authentication module.

6.23.5. EXAMPLES

The suggested usage for /etc/pam.d/login is:

auth  required  pam_nologin.so

6.23.6. AUTHOR

pam_nologin was written by Michael K. Johnson <johnsonm@redhat.com>.