contrib/openpam/doc/man/pam_authenticate.3

   1 .\" Generated from pam_authenticate.c by gendoc.pl
   2 .\" $Id: pam_authenticate.c 648 2013-03-05 17:54:27Z des $
   3 .Dd February 19, 2017
   4 .Dt PAM_AUTHENTICATE 3
   5 .Os
   6 .Sh NAME
   7 .Nm pam_authenticate
   8 .Nd perform authentication within the PAM framework
   9 .Sh SYNOPSIS
  10 .In sys/types.h
  11 .In security/pam_appl.h
  12 .Ft "int"
  13 .Fn pam_authenticate "pam_handle_t *pamh" "int flags"
  14 .Sh DESCRIPTION
  15 The
  16 .Fn pam_authenticate
  17 function attempts to authenticate the user
  18 associated with the pam context specified by the
  19 .Fa pamh
  20 argument.
  21 .Pp
  22 The application is free to call
  23 .Fn pam_authenticate
  24 as many times as it
  25 wishes, but some modules may maintain an internal retry counter and
  26 return
  27 .Dv PAM_MAXTRIES
  28 when it exceeds some preset or hardcoded limit.
  29 .Pp
  30 The
  31 .Fa flags
  32 argument is the binary or of zero or more of the following
  33 values:
  34 .Bl -tag -width 18n
  35 .It Dv PAM_SILENT
  36 Do not emit any messages.
  37 .It Dv PAM_DISALLOW_NULL_AUTHTOK
  38 Fail if the user's authentication token is null.
  39 .El
  40 .Pp
  41 If any other bits are set,
  42 .Fn pam_authenticate
  43 will return
  44 .Dv PAM_SYMBOL_ERR .
  45 .Sh RETURN VALUES
  46 The
  47 .Fn pam_authenticate
  48 function returns one of the following values:
  49 .Bl -tag -width 18n
  50 .It Bq Er PAM_ABORT
  51 General failure.
  52 .It Bq Er PAM_AUTHINFO_UNAVAIL
  53 Authentication information is unavailable.
  54 .It Bq Er PAM_AUTH_ERR
  55 Authentication error.
  56 .It Bq Er PAM_BUF_ERR
  57 Memory buffer error.
  58 .It Bq Er PAM_CONV_ERR
  59 Conversation failure.
  60 .It Bq Er PAM_CRED_INSUFFICIENT
  61 Insufficient credentials.
  62 .It Bq Er PAM_MAXTRIES
  63 Maximum number of tries exceeded.
  64 .It Bq Er PAM_PERM_DENIED
  65 Permission denied.
  66 .It Bq Er PAM_SERVICE_ERR
  67 Error in service module.
  68 .It Bq Er PAM_SYMBOL_ERR
  69 Invalid symbol.
  70 .It Bq Er PAM_SYSTEM_ERR
  71 System error.
  72 .It Bq Er PAM_USER_UNKNOWN
  73 Unknown user.
  74 .El
  75 .Sh SEE ALSO
  76 .Xr pam 3 ,
  77 .Xr pam_strerror 3
  78 .Sh STANDARDS
  79 .Rs
  80 .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
  81 .%D "June 1997"
  82 .Re
  83 .Sh AUTHORS
  84 The
  85 .Fn pam_authenticate
  86 function and this manual page were
  87 developed for the
  88 .Fx
  89 Project by ThinkSec AS and Network Associates Laboratories, the
  90 Security Research Division of Network Associates, Inc.\& under
  91 DARPA/SPAWAR contract N66001-01-C-8035
  92 .Pq Dq CBOSS ,
  93 as part of the DARPA CHATS research program.
  94 .Pp
  95 The OpenPAM library is maintained by
  96 .An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .