Debian Codegraph @

upstream/debian-unstable/man8/pam_rootok.8

raw
1 '\" t
2 .\" Title: pam_rootok
3 .\" Author: [see the "AUTHOR" section]
4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
5 .\" Date: 06/29/2025
6 .\" Manual: Linux-PAM Manual
7 .\" Source: Linux-PAM
8 .\" Language: English
9 .\"
10 .TH "PAM_ROOTOK" "8" "06/29/2025" "Linux\-PAM" "Linux\-PAM Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 pam_rootok \- Gain only root access
32 .SH "SYNOPSIS"
33 .HP \w'\fBpam_rootok\&.so\fR\ 'u
34 \fBpam_rootok\&.so\fR [debug]
35 .SH "DESCRIPTION"
36 .PP
37 pam_rootok is a PAM module that authenticates the user if their
38 \fIUID\fR
39 is
40 \fI0\fR\&. Applications that are created setuid\-root generally retain the
41 \fIUID\fR
42 of the user but run with the authority of an enhanced effective\-UID\&. It is the real
43 \fIUID\fR
44 that is checked\&.
45 .SH "OPTIONS"
46 .PP
47 debug
48 .RS 4
49 Print debug information\&.
50 .RE
51 .SH "MODULE TYPES PROVIDED"
52 .PP
53 The
54 \fBauth\fR,
55 \fBaccount\fR
56 and
57 \fBpassword\fR
58 module types are provided\&.
59 .SH "RETURN VALUES"
60 .PP
61 PAM_SUCCESS
62 .RS 4
63 The
64 \fIUID\fR
65 is
66 \fI0\fR\&.
67 .RE
68 .PP
69 PAM_AUTH_ERR
70 .RS 4
71 The
72 \fIUID\fR
73 is
74 \fBnot\fR
75 \fI0\fR\&.
76 .RE
77 .SH "EXAMPLES"
78 .PP
79 In the case of the
80 \fBsu\fR(1)
81 application the historical usage is to permit the superuser to adopt the identity of a lesser user without the use of a password\&. To obtain this behavior with PAM the following pair of lines are needed for the corresponding entry in the
82 /etc/pam\&.d/su
83 configuration file:
84 .sp
85 .if n \{\
86 .RS 4
87 .\}
88 .nf
89 # su authentication\&. Root is granted access by default\&.
90 auth sufficient pam_rootok\&.so
91 auth required pam_unix\&.so
92
93 .fi
94 .if n \{\
95 .RE
96 .\}
97 .sp
98 .SH "SEE ALSO"
99 .PP
100 \fBsu\fR(1),
101 \fBpam.conf\fR(5),
102 \fBpam.d\fR(5),
103 \fBpam\fR(7)
104 .SH "AUTHOR"
105 .PP
106 pam_rootok was written by Andrew G\&. Morgan, <morgan@kernel\&.org>\&.