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