Debian Codegraph @

upstream/debian-unstable/man3/pam_acct_mgmt.3

raw
1 '\" t
2 .\" Title: pam_acct_mgmt
3 .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
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_ACCT_MGMT" "3" "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_acct_mgmt \- PAM account validation management
32 .SH "SYNOPSIS"
33 .sp
34 .ft B
35 .nf
36 #include <security/pam_appl\&.h>
37 .fi
38 .ft
39 .HP \w'int\ pam_acct_mgmt('u
40 .BI "int pam_acct_mgmt(pam_handle_t\ *" "pamh" ", int\ " "flags" ");"
41 .SH "DESCRIPTION"
42 .PP
43 The
44 \fBpam_acct_mgmt\fR
45 function is used to determine if the user\*(Aqs account is valid\&. It checks for authentication token and account expiration and verifies access restrictions\&. It is typically called after the user has been authenticated\&.
46 .PP
47 The
48 \fIpamh\fR
49 argument is an authentication handle obtained by a prior call to pam_start()\&. The flags argument is the binary or of zero or more of the following values:
50 .PP
51 PAM_SILENT
52 .RS 4
53 Do not emit any messages\&.
54 .RE
55 .PP
56 PAM_DISALLOW_NULL_AUTHTOK
57 .RS 4
58 The PAM module service should return PAM_NEW_AUTHTOK_REQD if the user has a null authentication token\&.
59 .RE
60 .SH "RETURN VALUES"
61 .PP
62 PAM_ACCT_EXPIRED
63 .RS 4
64 User account has expired\&.
65 .RE
66 .PP
67 PAM_AUTH_ERR
68 .RS 4
69 Authentication failure\&.
70 .RE
71 .PP
72 PAM_NEW_AUTHTOK_REQD
73 .RS 4
74 The user account is valid but their authentication token is
75 \fIexpired\fR\&. The correct response to this return\-value is to require that the user satisfies the
76 \fBpam_chauthtok()\fR
77 function before obtaining service\&. It may not be possible for some applications to do this\&. In such cases, the user should be denied access until such time as they can update their password\&.
78 .RE
79 .PP
80 PAM_PERM_DENIED
81 .RS 4
82 Permission denied\&.
83 .RE
84 .PP
85 PAM_SUCCESS
86 .RS 4
87 The authentication token was successfully updated\&.
88 .RE
89 .PP
90 PAM_USER_UNKNOWN
91 .RS 4
92 User unknown to password service\&.
93 .RE
94 .SH "SEE ALSO"
95 .PP
96 \fBpam_start\fR(3),
97 \fBpam_authenticate\fR(3),
98 \fBpam_chauthtok\fR(3),
99 \fBpam_strerror\fR(3),
100 \fBpam\fR(7)