dist/openpam/doc/man/pam_authenticate.3

   1 .\"     $NetBSD: pam_authenticate.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_AUTHENTICATE 3
  41 .Os
  42 .Sh NAME
  43 .Nm pam_authenticate
  44 .Nd perform authentication within the PAM framework
  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_authenticate "pam_handle_t *pamh" "int flags"
  52 .Sh DESCRIPTION
  53 The
  54 .Nm
  55 function attempts to authenticate the user
  56 associated with the pam context specified by the
  57 .Fa pamh
  58 argument.
  59 .Pp
  60 The application is free to call
  61 .Nm
  62 as many times as it
  63 wishes, but some modules may maintain an internal retry counter and
  64 return
  65 .Dv PAM_MAXTRIES
  66 when it exceeds some preset or hardcoded limit.
  67 .Pp
  68 The
  69 .Fa flags
  70 argument is the binary or of zero or more of the following
  71 values:
  72 .Bl -tag -width 18n
  73 .It Dv PAM_SILENT
  74 Do not emit any messages.
  75 .It Dv PAM_DISALLOW_NULL_AUTHTOK
  76 Fail if the user's authentication token is null.
  77 .El
  78 .Pp
  79 If any other bits are set,
  80 .Nm
  81 will return
  82 .Dv PAM_SYMBOL_ERR .
  83 .Sh RETURN VALUES
  84 The
  85 .Nm
  86 function returns one of the following values:
  87 .Bl -tag -width 18n
  88 .It Bq Er PAM_ABORT
  89 General failure.
  90 .It Bq Er PAM_AUTHINFO_UNAVAIL
  91 Authentication information is unavailable.
  92 .It Bq Er PAM_AUTH_ERR
  93 Authentication error.
  94 .It Bq Er PAM_BUF_ERR
  95 Memory buffer error.
  96 .It Bq Er PAM_CONV_ERR
  97 Conversation failure.
  98 .It Bq Er PAM_CRED_INSUFFICIENT
  99 Insufficient credentials.
 100 .It Bq Er PAM_MAXTRIES
 101 Maximum number of tries exceeded.
 102 .It Bq Er PAM_PERM_DENIED
 103 Permission denied.
 104 .It Bq Er PAM_SERVICE_ERR
 105 Error in service module.
 106 .It Bq Er PAM_SYMBOL_ERR
 107 Invalid symbol.
 108 .It Bq Er PAM_SYSTEM_ERR
 109 System error.
 110 .It Bq Er PAM_USER_UNKNOWN
 111 Unknown user.
 112 .El
 113 .Sh SEE ALSO
 114 .Xr pam 3 ,
 115 .Xr pam_strerror 3
 116 .Sh STANDARDS
 117 .Rs
 118 .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
 119 .%D "June 1997"
 120 .Re
 121 .Sh AUTHORS
 122 The
 123 .Nm
 124 function and this manual page were developed for the
 125 .Fx
 126 Project by ThinkSec AS and Network Associates Laboratories, the
 127 Security Research Division of Network Associates, Inc.\& under
 128 DARPA/SPAWAR contract N66001-01-C-8035
 129 .Pq Dq CBOSS ,
 130 as part of the DARPA CHATS research program.