xref: /freebsd/contrib/openpam/doc/man/pam_acct_mgmt.3 (revision db612abe8df3355d1eb23bb3b50fdd97bc21e979)
1.\"-
2.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
3.\" Copyright (c) 2004-2007 Dag-Erling Smørgrav
4.\" All rights reserved.
5.\"
6.\" This software was developed for the FreeBSD Project by ThinkSec AS and
7.\" Network Associates Laboratories, the Security Research Division of
8.\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
9.\" ("CBOSS"), as part of the DARPA CHATS research program.
10.\"
11.\" Redistribution and use in source and binary forms, with or without
12.\" modification, are permitted provided that the following conditions
13.\" are met:
14.\" 1. Redistributions of source code must retain the above copyright
15.\"    notice, this list of conditions and the following disclaimer.
16.\" 2. Redistributions in binary form must reproduce the above copyright
17.\"    notice, this list of conditions and the following disclaimer in the
18.\"    documentation and/or other materials provided with the distribution.
19.\" 3. The name of the author may not be used to endorse or promote
20.\"    products derived from this software without specific prior written
21.\"    permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33.\" SUCH DAMAGE.
34.\"
35.\" $P4$
36.\"
37.Dd December 21, 2007
38.Dt PAM_ACCT_MGMT 3
39.Os
40.Sh NAME
41.Nm pam_acct_mgmt
42.Nd perform PAM account validation procedures
43.Sh LIBRARY
44.Lb libpam
45.Sh SYNOPSIS
46.In sys/types.h
47.In security/pam_appl.h
48.Ft "int"
49.Fn pam_acct_mgmt "pam_handle_t *pamh" "int flags"
50.Sh DESCRIPTION
51The
52.Nm
53function verifies and enforces account restrictions
54after the user has been authenticated.
55.Pp
56The
57.Fa flags
58argument is the binary or of zero or more of the following
59values:
60.Bl -tag -width 18n
61.It Dv PAM_SILENT
62Do not emit any messages.
63.It Dv PAM_DISALLOW_NULL_AUTHTOK
64Fail if the user's authentication token is null.
65.El
66.Pp
67If any other bits are set,
68.Nm
69will return
70.Dv PAM_SYMBOL_ERR .
71.Sh RETURN VALUES
72The
73.Nm
74function returns one of the following values:
75.Bl -tag -width 18n
76.It Bq Er PAM_ABORT
77General failure.
78.It Bq Er PAM_ACCT_EXPIRED
79User account has expired.
80.It Bq Er PAM_AUTH_ERR
81Authentication error.
82.It Bq Er PAM_BUF_ERR
83Memory buffer error.
84.It Bq Er PAM_CONV_ERR
85Conversation failure.
86.It Bq Er PAM_NEW_AUTHTOK_REQD
87New authentication token required.
88.It Bq Er PAM_PERM_DENIED
89Permission denied.
90.It Bq Er PAM_SERVICE_ERR
91Error in service module.
92.It Bq Er PAM_SYSTEM_ERR
93System error.
94.It Bq Er PAM_USER_UNKNOWN
95Unknown user.
96.El
97.Sh SEE ALSO
98.Xr pam 3 ,
99.Xr pam_strerror 3
100.Sh STANDARDS
101.Rs
102.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
103.%D "June 1997"
104.Re
105.Sh AUTHORS
106The
107.Nm
108function and this manual page were developed for the
109.Fx
110Project by ThinkSec AS and Network Associates Laboratories, the
111Security Research Division of Network Associates, Inc.\& under
112DARPA/SPAWAR contract N66001-01-C-8035
113.Pq Dq CBOSS ,
114as part of the DARPA CHATS research program.
115