Debian Codegraph @

upstream/debian-unstable/man8/pam-auth-update.8

raw
1 .\" Copyright (C) 2008 Canonical Ltd.
2 .\"
3 .\" Author: Steve Langasek <[email protected]>
4 .\"
5 .\" This program is free software; you can redistribute it and/or modify
6 .\" it under the terms of version 3 of the GNU General Public License as
7 .\" published by the Free Software Foundation.
8 .\"
9 .\" .\" This program is distributed in the hope that it will be useful,
10 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
11 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 .\" GNU General Public License for more details.
13 .\"
14 .\" You should have received a copy of the GNU General Public License
15 .\" along with this program; if not, write to the Free Software
16 .\" Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301,
17 .\" USA.
18 .TH "PAM\-AUTH\-UPDATE" "8" "08/23/2008" "Debian"
19 .SH NAME
20 pam\-auth\-update - manage PAM configuration using packaged profiles
21 .SH SYNOPSIS
22 .B pam\-auth\-update
23 .RB [ \-\-package " [" \-\-remove
24 .IR profile " [" profile\fR... "]]]"
25 .RB [ \-\-force ]
26 .RB [ \-\-enable
27 .IR profile " [" profile\fR... "]]"
28 .RB [ \-\-disable
29 .IR profile " [" profile\fR... "]]"
30 .SH DESCRIPTION
31 .I pam\-auth\-update
32 is a utility that permits configuring the central authentication policy
33 for the system using pre-defined profiles as supplied by PAM module
34 packages.
35 Profiles shipped in the
36 .I /usr/share/pam\-configs/
37 directory specify the modules, with options, to enable; the preferred
38 ordering with respect to other profiles; and whether a profile should be
39 enabled by default.
40 Packages providing PAM modules register their profiles at install time
41 by calling
42 .BR "pam\-auth\-update \-\-package" .
43 Selection of profiles is done using the standard debconf interface.
44 The profile selection question will be asked at `medium' priority when
45 packages are added or removed, so no user interaction is required by
46 default.
47 Users may invoke
48 .B pam\-auth\-update
49 directly to change their authentication configuration.
50 .PP
51 The script makes every effort to respect local changes to
52 .IR "/etc/pam.d/common-*".
53 Local modifications to the list of module options will be preserved, and
54 additions of modules within the managed portion of the stack will cause
55 .B pam\-auth\-update
56 to treat the config files as locally modified and not make further
57 changes to the config files unless given the
58 .B \-\-force
59 option.
60 .PP
61 If the user specifies that
62 .B pam\-auth\-update
63 should override local configuration changes, the locally-modified files
64 will be saved in
65 .I /etc/pam.d/
66 with a suffix of
67 .IR "\.pam\-old" .
68 .SH OPTIONS
69 .TP
70 .B \-\-package
71 Indicate that the caller is a package maintainer script; lowers the
72 priority of debconf questions to `medium' so that the user is not
73 prompted by default.
74 .TP
75 .B \-\-disable \fIprofile \fR[\fIprofile\fR...]
76 Disable the specified profiles in system configuration. This can be used from system administration scripts to disable profiles.
77 .TP
78 .B \-\-enable \fIprofile \fR[\fIprofile\fR...]
79 Enable the specified profiles in system configuration. This is used to
80 enable profiles that are not on by default.
81 .TP
82 .B \-\-remove \fIprofile \fR[\fIprofile\fR...]
83 Remove the specified profiles from the system configuration.
84 .B pam\-auth\-update \-\-remove
85 should be used to remove profiles from the configuration before the
86 modules they reference are removed from disk, to ensure that PAM is in a
87 consistent and usable state at all times during package upgrades or
88 removals.
89 .TP
90 .B \-\-force
91 Overwrite the current PAM configuration, without prompting.
92 This option
93 .B must not
94 be used by package maintainer scripts; it is intended for use by
95 administrators only.
96 .SH FILES
97 .PP
98 .I /etc/pam.d/common\-*
99 .RS 4
100 Global configuration of PAM, affecting all installed services.
101 .RE
102 .PP
103 .I /usr/share/pam\-configs/
104 .RS 4
105 Package-supplied authentication profiles.
106 .RE
107 .SH AUTHOR
108 Steve Langasek <[email protected]>
109 .SH COPYRIGHT
110 Copyright (C) 2008 Canonical Ltd.
111 .SH "SEE ALSO"
112 PAM(7), pam.d(5), debconf(7)