contrib/openpam/doc/man/pam_acct_mgmt.3

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