Debian Codegraph @

upstream/debian-unstable/man8/pam_canonicalize_user.8

raw
1 '\" t
2 .\" Title: pam_canonicalize_user
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_CANONICALIZE_USE" "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_canonicalize_user \- Get user name and canonicalize it
32 .SH "SYNOPSIS"
33 .HP \w'\fBpam_canonicalize_user\&.so\fR\ 'u
34 \fBpam_canonicalize_user\&.so\fR
35 .SH "DESCRIPTION"
36 .PP
37 This PAM module uses the name of the user obtained via
38 \fBpam_get_user\fR(3)
39 as a key to query the password database, and replaces
40 \fIPAM_USER\fR
41 with the
42 \fIpw_name\fR
43 value that has been returned\&.
44 .SH "OPTIONS"
45 .PP
46 This module does not recognise any options\&.
47 .SH "MODULE TYPES PROVIDED"
48 .PP
49 Only the
50 \fBauth\fR
51 module type is provided\&.
52 .SH "RETURN VALUES"
53 .PP
54 PAM_IGNORE
55 .RS 4
56 The user name was set successfully\&.
57 .RE
58 .PP
59 PAM_USER_UNKNOWN
60 .RS 4
61 The user was not found\&.
62 .RE
63 .PP
64 PAM_SYSTEM_ERR
65 .RS 4
66 The application did not supply neither a user name nor a conversation method\&.
67 .RE
68 .PP
69 PAM_INCOMPLETE
70 .RS 4
71 The conversation method supplied by the application is waiting for an event\&.
72 .RE
73 .PP
74 PAM_CONV_ERR
75 .RS 4
76 The conversation method supplied by the application failed to obtain the user name\&.
77 .RE
78 .PP
79 PAM_ABORT
80 .RS 4
81 Error resuming an old conversation\&.
82 .RE
83 .PP
84 PAM_BUF_ERR
85 .RS 4
86 Memory buffer error\&.
87 .RE
88 .SH "EXAMPLES"
89 .PP
90 Prepend the PAM auth stack with the following line to canonicalize the user name before the authentication:
91 .sp
92 .if n \{\
93 .RS 4
94 .\}
95 .nf
96 auth required pam_canonicalize_user\&.so
97
98 .fi
99 .if n \{\
100 .RE
101 .\}
102 .sp
103 .SH "SEE ALSO"
104 .PP
105 \fBpam_get_user\fR(3),
106 \fBpam_get_item\fR(3),
107 \fBpam_set_item\fR(3),
108 \fBgetpwnam\fR(3),
109 \fBpam.conf\fR(5),
110 \fBpam.d\fR(5),
111 \fBpam\fR(8)
112 .SH "AUTHOR"
113 .PP
114 pam_canonicalize_user was written by Dmitry V\&. Levin <ldv@strace\&.io>\&.