dist/openpam/doc/man/pam_acct_mgmt.3

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