usr/src/man/man3pam/pam_acct_mgmt.3pam

   1 '\" te
   2 .\"  Copyright (c) 1998, Sun Microsystems, Inc.   All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH PAM_ACCT_MGMT 3PAM "Oct 13, 1998"
   7 .SH NAME
   8 pam_acct_mgmt \- perform PAM account validation procedures
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lpam\fR [ \fIlibrary\fR ... ]
  13 #include <security/pam_appl.h>
  14
  15
  16
  17 \fBint\fR \fBpam_acct_mgmt\fR(\fBpam_handle_t *\fR\fIpamh\fR, \fBint\fR \fIflags\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The \fBpam_acct_mgmt()\fR function is called to determine if the current user's
  24 account is valid.  It checks for password and account expiration, and verifies
  25 access hour restrictions. This function is typically called after the user has
  26 been authenticated with \fBpam_authenticate\fR(3PAM).
  27 .sp
  28 .LP
  29 The \fIpamh\fR argument is an authentication handle obtained by a prior call to
  30 \fBpam_start()\fR. The following flags may be set in the \fIflags\fR field:
  31 .sp
  32 .ne 2
  33 .na
  34 \fB\fBPAM_SILENT\fR\fR
  35 .ad
  36 .RS 29n
  37 The account management service should not generate any messages.
  38 .RE
  39
  40 .sp
  41 .ne 2
  42 .na
  43 \fB\fBPAM_DISALLOW_NULL_AUTHTOK\fR\fR
  44 .ad
  45 .RS 29n
  46 The account management service should return \fBPAM_NEW_AUTHTOK_REQD\fR if the
  47 user has a null authentication token.
  48 .RE
  49
  50 .SH RETURN VALUES
  51 .sp
  52 .LP
  53 Upon successful completion,  \fBPAM_SUCCESS\fR is returned. In addition to the
  54 error return values described in \fBpam\fR(3PAM), the following values may be
  55 returned:
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fBPAM_USER_UNKNOWN\fR\fR
  60 .ad
  61 .RS 24n
  62 User not known to underlying account management module.
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fBPAM_AUTH_ERR\fR\fR
  69 .ad
  70 .RS 24n
  71 Authentication failure.
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fBPAM_NEW_AUTHTOK_REQD\fR\fR
  78 .ad
  79 .RS 24n
  80 New authentication token required. This is normally returned if the machine
  81 security policies require that the password should be changed because the
  82 password is  \fBNULL\fR or has aged.
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fBPAM_ACCT_EXPIRED\fR\fR
  89 .ad
  90 .RS 24n
  91 User account has expired.
  92 .RE
  93
  94 .SH ATTRIBUTES
  95 .sp
  96 .LP
  97 See \fBattributes\fR(5) for description of the following attributes:
  98 .sp
  99
 100 .sp
 101 .TS
 102 box;
 103 c | c
 104 l | l .
 105 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 106 _
 107 Interface Stability      Stable
 108 _
 109 MT-Level        MT-Safe with exceptions
 110 .TE
 111
 112 .SH SEE ALSO
 113 .sp
 114 .LP
 115 \fBpam\fR(3PAM), \fBpam_authenticate\fR(3PAM), \fBpam_start\fR(3PAM),
 116 \fBlibpam\fR(3LIB), \fBattributes\fR(5)
 117 .SH NOTES
 118 .sp
 119 .LP
 120 The interfaces in  \fBlibpam\fR are MT-Safe only if each thread within the
 121 multithreaded application uses its own \fBPAM\fR handle.