PAM_NOLOGIN

Section: Linux\-PAM Manual (8)
Updated: 03/02/2009
Index Return to Main Contents
pam_nologin - Prevent non-root users from login  

Synopsis

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

DESCRIPTION

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

OPTIONS

file=/path/nologin

Use this file instead the default FC/etc/nologinF[].

successok

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

MODULE TYPES PROVIDED

The auth and acct module types are provided.  

RETURN VALUES

PAM_AUTH_ERR

The user is not root and FC/etc/nologinF[] 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 FC/etc/nologinF[] file does not exist.

PAM_USER_UNKNOWN

User not known to the underlying authentication module.
 

EXAMPLES

The suggested usage for FC/etc/pam.d/loginF[] is: 



auth  required  pam_nologin.so

 

NOTES

In order to make this module effective, all login methods should be secured by it. It should be used as a required method listed before any sufficient methods in order to get standard Unix nologin semantics. Note, the use of successok module argument causes the module to return PAM_SUCCESS and as such would break such a configuration - failing sufficient modules would lead to a successful login because the nologin module succeeded.  

SEE ALSO

nologin(5), pam.conf(5), pam.d(5), pam(8)  

AUTHOR

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