contrib/openpam/doc/man/pam_sm_authenticate.3

   1 .\"-
   2 .\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
   3 .\" Copyright (c) 2004-2011 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 .\" $Id$
  36 .\"
  37 .Dd May 26, 2012
  38 .Dt PAM_SM_AUTHENTICATE 3
  39 .Os
  40 .Sh NAME
  41 .Nm pam_sm_authenticate
  42 .Nd service module implementation for pam_authenticate
  43 .Sh LIBRARY
  44 .Lb libpam
  45 .Sh SYNOPSIS
  46 .In sys/types.h
  47 .In security/pam_appl.h
  48 .In security/pam_modules.h
  49 .Ft "int"
  50 .Fn pam_sm_authenticate "pam_handle_t *pamh" "int flags" "int argc" "const char **argv"
  51 .Sh DESCRIPTION
  52 The
  53 .Fn pam_sm_authenticate
  54 function is the service module's
  55 implementation of the
  56 .Xr pam_authenticate 3
  57 API function.
  58 .Sh RETURN VALUES
  59 The
  60 .Fn pam_sm_authenticate
  61 function returns one of the following values:
  62 .Bl -tag -width 18n
  63 .It Bq Er PAM_ABORT
  64 General failure.
  65 .It Bq Er PAM_AUTHINFO_UNAVAIL
  66 Authentication information is unavailable.
  67 .It Bq Er PAM_AUTH_ERR
  68 Authentication error.
  69 .It Bq Er PAM_BUF_ERR
  70 Memory buffer error.
  71 .It Bq Er PAM_CONV_ERR
  72 Conversation failure.
  73 .It Bq Er PAM_CRED_INSUFFICIENT
  74 Insufficient credentials.
  75 .It Bq Er PAM_IGNORE
  76 Ignore this module.
  77 .It Bq Er PAM_MAXTRIES
  78 Maximum number of tries exceeded.
  79 .It Bq Er PAM_PERM_DENIED
  80 Permission denied.
  81 .It Bq Er PAM_SERVICE_ERR
  82 Error in service module.
  83 .It Bq Er PAM_SYSTEM_ERR
  84 System error.
  85 .It Bq Er PAM_USER_UNKNOWN
  86 Unknown user.
  87 .El
  88 .Sh SEE ALSO
  89 .Xr pam 3 ,
  90 .Xr pam_authenticate 3 ,
  91 .Xr pam_strerror 3
  92 .Sh STANDARDS
  93 .Rs
  94 .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
  95 .%D "June 1997"
  96 .Re
  97 .Sh AUTHORS
  98 The
  99 .Fn pam_sm_authenticate
 100 function and this manual page were
 101 developed for the
 102 .Fx
 103 Project by ThinkSec AS and Network Associates Laboratories, the
 104 Security Research Division of Network Associates, Inc.\& under
 105 DARPA/SPAWAR contract N66001-01-C-8035
 106 .Pq Dq CBOSS ,
 107 as part of the DARPA CHATS research program.