xref: /freebsd/contrib/openpam/doc/man/pam_acct_mgmt.3 (revision 0fca6ea1d4eea4c934cfff25ac9ee8ad6fe95583)
1.\" Generated from pam_acct_mgmt.c by gendoc.pl
2.Dd June 27, 2023
3.Dt PAM_ACCT_MGMT 3
4.Os
5.Sh NAME
6.Nm pam_acct_mgmt
7.Nd perform PAM account validation procedures
8.Sh SYNOPSIS
9.In sys/types.h
10.In security/pam_appl.h
11.Ft "int"
12.Fn pam_acct_mgmt "pam_handle_t *pamh" "int flags"
13.Sh DESCRIPTION
14The
15.Fn pam_acct_mgmt
16function verifies and enforces account restrictions
17after the user has been authenticated.
18.Pp
19The
20.Fa flags
21argument is the binary or of zero or more of the following
22values:
23.Bl -tag -width 18n
24.It Dv PAM_SILENT
25Do not emit any messages.
26.It Dv PAM_DISALLOW_NULL_AUTHTOK
27Fail if the user's authentication token is null.
28.El
29.Pp
30If any other bits are set,
31.Fn pam_acct_mgmt
32will return
33.Dv PAM_SYMBOL_ERR .
34.Sh RETURN VALUES
35The
36.Fn pam_acct_mgmt
37function returns one of the following values:
38.Bl -tag -width 18n
39.It Bq Er PAM_SUCCESS
40Success.
41.It Bq Er PAM_ABORT
42General failure.
43.It Bq Er PAM_ACCT_EXPIRED
44User account has expired.
45.It Bq Er PAM_AUTH_ERR
46Authentication error.
47.It Bq Er PAM_BUF_ERR
48Memory buffer error.
49.It Bq Er PAM_CONV_ERR
50Conversation failure.
51.It Bq Er PAM_NEW_AUTHTOK_REQD
52New authentication token required.
53.It Bq Er PAM_PERM_DENIED
54Permission denied.
55.It Bq Er PAM_SERVICE_ERR
56Error in service module.
57.It Bq Er PAM_SYSTEM_ERR
58System error.
59.It Bq Er PAM_USER_UNKNOWN
60Unknown user.
61.El
62.Sh SEE ALSO
63.Xr pam 3 ,
64.Xr pam_strerror 3
65.Sh STANDARDS
66.Rs
67.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
68.%D "June 1997"
69.Re
70.Sh AUTHORS
71The
72.Fn pam_acct_mgmt
73function and this manual page were
74developed for the
75.Fx
76Project by ThinkSec AS and Network Associates Laboratories, the
77Security Research Division of Network Associates, Inc.\& under
78DARPA/SPAWAR contract N66001-01-C-8035
79.Pq Dq CBOSS ,
80as part of the DARPA CHATS research program.
81.Pp
82The OpenPAM library is maintained by
83.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
84