xref: /netbsd-src/share/man/man8/pam.8 (revision 9521ae7bfd00c3f092c788390dc90fd047c3935e)
1*9521ae7bSprlw1.\"	$NetBSD: pam.8,v 1.5 2015/04/28 09:48:31 prlw1 Exp $
2d9710898Sthorpej.\"
3d9710898Sthorpej.\" Copyright (c) 2005 The NetBSD Foundation, Inc.
4d9710898Sthorpej.\" All rights reserved.
5d9710898Sthorpej.\"
6d9710898Sthorpej.\" This code is derived from software contributed to The NetBSD Foundation
7d9710898Sthorpej.\" by Jason R. Thorpe.
8d9710898Sthorpej.\"
9d9710898Sthorpej.\" Redistribution and use in source and binary forms, with or without
10d9710898Sthorpej.\" modification, are permitted provided that the following conditions
11d9710898Sthorpej.\" are met:
12d9710898Sthorpej.\" 1. Redistributions of source code must retain the above copyright
13d9710898Sthorpej.\"    notice, this list of conditions and the following disclaimer.
14d9710898Sthorpej.\" 2. Redistributions in binary form must reproduce the above copyright
15d9710898Sthorpej.\"    notice, this list of conditions and the following disclaimer in the
16d9710898Sthorpej.\"    documentation and/or other materials provided with the distribution.
17d9710898Sthorpej.\"
18d9710898Sthorpej.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19d9710898Sthorpej.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20d9710898Sthorpej.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21d9710898Sthorpej.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22d9710898Sthorpej.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23d9710898Sthorpej.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24d9710898Sthorpej.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25d9710898Sthorpej.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26d9710898Sthorpej.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27d9710898Sthorpej.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28d9710898Sthorpej.\" POSSIBILITY OF SUCH DAMAGE.
29d9710898Sthorpej.\"
30d9710898Sthorpej.Dd February 28, 2005
31d9710898Sthorpej.Dt PAM 8
32d9710898Sthorpej.Os
33d9710898Sthorpej.Sh NAME
34d9710898Sthorpej.Nm pam
35d9710898Sthorpej.Nd Pluggable Authentication Modules framework
36d9710898Sthorpej.Sh DESCRIPTION
37d9710898SthorpejThe Pluggable Authentication Modules
38d9710898Sthorpej.Pq PAM
39d9710898Sthorpejframework is a system of libraries that perform authentication tasks for
40d9710898Sthorpejservices and applications.
41d9710898SthorpejApplications that use the PAM API may have their authentication behavior
42*9521ae7bSprlw1configured by the system administrator through the use of the service's
43d9710898SthorpejPAM configuration file.
44d9710898Sthorpej.Pp
45d9710898SthorpejPAM modules provide four classes of functionality:
46d9710898Sthorpej.Bl -tag -width password
47d9710898Sthorpej.It account
48d9710898SthorpejAccount verification services such as password expiration and access control.
49d9710898Sthorpej.It auth
50d9710898SthorpejAuthentication services.
51d9710898SthorpejThis usually takes the form of a challenge-response conversation.
52d9710898SthorpejHowever, PAM can also support, with appropriate hardware support, biometric
53d9710898Sthorpejdevices, smart-cards, and so forth.
54d9710898Sthorpej.It password
55d9710898SthorpejPassword
56d9710898Sthorpej.Pq or, more generally, authentication token
57d9710898Sthorpejchange and update services.
58d9710898Sthorpej.It session
59d9710898SthorpejSession management services.
60d9710898SthorpejThese are tasks that are performed before access to a service is granted
61d9710898Sthorpejand after access to a service is withdrawn.
62d9710898SthorpejThese may include updating activity logs or setting up and tearing down
63d9710898Sthorpejcredential forwarding agents.
64d9710898Sthorpej.El
65d9710898Sthorpej.Pp
66d9710898SthorpejA primary feature of PAM is the notion of
67d9710898Sthorpej.Dq stacking
68d9710898Sthorpejdifferent modules together to form a processing chain for the task.
69d9710898SthorpejThis allows fairly precise control over how a particular authentication
70d9710898Sthorpejtask is performed, and under what conditions.
711f64b720SdanPAM module configurations may also inherit stacks from other module
72d9710898Sthorpejconfigurations, providing some degree of centralized administration.
73d9710898Sthorpej.Sh SEE ALSO
74d9710898Sthorpej.Xr login 1 ,
75d9710898Sthorpej.Xr passwd 1 ,
76d9710898Sthorpej.Xr su 1 ,
77d9710898Sthorpej.Xr pam 3 ,
78d9710898Sthorpej.Xr pam.conf 5 ,
79d9710898Sthorpej.Xr pam_chroot 8 ,
80d9710898Sthorpej.Xr pam_deny 8 ,
81d9710898Sthorpej.Xr pam_echo 8 ,
82d9710898Sthorpej.Xr pam_exec 8 ,
83d9710898Sthorpej.Xr pam_ftpusers 8 ,
84d9710898Sthorpej.Xr pam_group 8 ,
85d9710898Sthorpej.Xr pam_guest 8 ,
86d9710898Sthorpej.Xr pam_krb5 8 ,
87d9710898Sthorpej.Xr pam_ksu 8 ,
88d9710898Sthorpej.Xr pam_lastlog 8 ,
89d9710898Sthorpej.Xr pam_login_access 8 ,
90d9710898Sthorpej.Xr pam_nologin 8 ,
91d9710898Sthorpej.Xr pam_permit 8 ,
92d9710898Sthorpej.Xr pam_radius 8 ,
93d9710898Sthorpej.Xr pam_rhosts 8 ,
94d9710898Sthorpej.Xr pam_rootok 8 ,
95d9710898Sthorpej.Xr pam_securetty 8 ,
96d9710898Sthorpej.Xr pam_self 8 ,
97d9710898Sthorpej.Xr pam_skey 8 ,
98d9710898Sthorpej.Xr pam_ssh 8 ,
99d9710898Sthorpej.Xr pam_unix 8
100d9710898Sthorpej.Sh HISTORY
101d9710898SthorpejThe Pluggable Authentication Module framework was originally developed
102d9710898Sthorpejby SunSoft, described in DCE/OSF-RFC 86.0, and first deployed in Solaris 2.6.
103d9710898SthorpejIt was later incorporated into the X/Open Single Sign-On Service
104d9710898Sthorpej.Pq XSSO
105*9521ae7bSprlw1Pluggable Authentication Modules specification.
106d9710898Sthorpej.Pp
107d9710898SthorpejThe Pluggable Authentication Module framework first appeared in
108d9710898Sthorpej.Nx 3.0 .
109