Debian Codegraph @

upstream/debian-unstable/man3/pam_sm_acct_mgmt.3

raw
1 '\" t
2 .\" Title: pam_sm_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_SM_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_sm_acct_mgmt \- PAM service function for account management
32 .SH "SYNOPSIS"
33 .sp
34 .ft B
35 .nf
36 #include <security/pam_modules\&.h>
37 .fi
38 .ft
39 .HP \w'int\ pam_sm_acct_mgmt('u
40 .BI "int pam_sm_acct_mgmt(pam_handle_t\ *" "pamh" ", int\ " "flags" ", int\ " "argc" ", const\ char\ **" "argv" ");"
41 .SH "DESCRIPTION"
42 .PP
43 The
44 \fBpam_sm_acct_mgmt\fR
45 function is the service module\*(Aqs implementation of the
46 \fBpam_acct_mgmt\fR(3)
47 interface\&.
48 .PP
49 This function performs the task of establishing whether the user is permitted to gain access at this time\&. It should be understood that the user has previously been validated by an authentication module\&. This function checks for other things\&. Such things might be: the time of day or the date, the terminal line, remote hostname, etc\&. This function may also determine things like the expiration on passwords, and respond that the user change it before continuing\&.
50 .PP
51 Valid flags, which may be logically OR\*(Aqd with
52 \fIPAM_SILENT\fR, are:
53 .PP
54 PAM_SILENT
55 .RS 4
56 Do not emit any messages\&.
57 .RE
58 .PP
59 PAM_DISALLOW_NULL_AUTHTOK
60 .RS 4
61 Return
62 \fBPAM_AUTH_ERR\fR
63 if the database of authentication tokens for this authentication mechanism has a
64 \fINULL\fR
65 entry for the user\&.
66 .RE
67 .SH "RETURN VALUES"
68 .PP
69 PAM_ACCT_EXPIRED
70 .RS 4
71 User account has expired\&.
72 .RE
73 .PP
74 PAM_AUTH_ERR
75 .RS 4
76 Authentication failure\&.
77 .RE
78 .PP
79 PAM_NEW_AUTHTOK_REQD
80 .RS 4
81 The user\*(Aqs authentication token has expired\&. Before calling this function again the application will arrange for a new one to be given\&. This will likely result in a call to
82 \fBpam_sm_chauthtok()\fR\&.
83 .RE
84 .PP
85 PAM_PERM_DENIED
86 .RS 4
87 Permission denied\&.
88 .RE
89 .PP
90 PAM_SUCCESS
91 .RS 4
92 The authentication token was successfully updated\&.
93 .RE
94 .PP
95 PAM_USER_UNKNOWN
96 .RS 4
97 User unknown to password service\&.
98 .RE
99 .SH "SEE ALSO"
100 .PP
101 \fBpam\fR(3),
102 \fBpam_acct_mgmt\fR(3),
103 \fBpam_sm_chauthtok\fR(3),
104 \fBpam_strerror\fR(3),
105 \fBPAM\fR(8)