contrib/openpam/doc/man/pam_start.3

   1 .\" Generated from pam_start.c by gendoc.pl
   2 .\" $OpenPAM: pam_start.c 938 2017-04-30 21:34:42Z des $
   3 .Dd February 24, 2019
   4 .Dt PAM_START 3
   5 .Os
   6 .Sh NAME
   7 .Nm pam_start
   8 .Nd initiate a PAM transaction
   9 .Sh SYNOPSIS
  10 .In sys/types.h
  11 .In security/pam_appl.h
  12 .Ft "int"
  13 .Fn pam_start "const char *service" "const char *user" "const struct pam_conv *pam_conv" "pam_handle_t **pamh"
  14 .Sh DESCRIPTION
  15 The
  16 .Fn pam_start
  17 function creates and initializes a PAM context.
  18 .Pp
  19 The
  20 .Fa service
  21 argument specifies the name of the policy to apply, and is
  22 stored in the
  23 .Dv PAM_SERVICE
  24 item in the created context.
  25 .Pp
  26 The
  27 .Fa user
  28 argument specifies the name of the target user - the user the
  29 created context will serve to authenticate.
  30 It is stored in the
  31 .Dv PAM_USER
  32 item in the created context.
  33 .Pp
  34 The
  35 .Fa pam_conv
  36 argument points to a
  37 .Vt struct pam_conv
  38 describing the
  39 conversation function to use; see
  40 .Fa pam_conv
  41 for details.
  42 .Pp
  43 .Sh RETURN VALUES
  44 The
  45 .Fn pam_start
  46 function returns one of the following values:
  47 .Bl -tag -width 18n
  48 .It Bq Er PAM_SUCCESS
  49 Success.
  50 .It Bq Er PAM_BAD_ITEM
  51 Unrecognized or restricted item.
  52 .It Bq Er PAM_BUF_ERR
  53 Memory buffer error.
  54 .It Bq Er PAM_SYSTEM_ERR
  55 System error.
  56 .El
  57 .Sh SEE ALSO
  58 .Xr pam 3 ,
  59 .Xr pam_end 3 ,
  60 .Xr pam_get_item 3 ,
  61 .Xr pam_set_item 3 ,
  62 .Xr pam_strerror 3
  63 .Sh STANDARDS
  64 .Rs
  65 .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
  66 .%D "June 1997"
  67 .Re
  68 .Sh AUTHORS
  69 The
  70 .Fn pam_start
  71 function and this manual page were
  72 developed for the
  73 .Fx
  74 Project by ThinkSec AS and Network Associates Laboratories, the
  75 Security Research Division of Network Associates, Inc.\& under
  76 DARPA/SPAWAR contract N66001-01-C-8035
  77 .Pq Dq CBOSS ,
  78 as part of the DARPA CHATS research program.
  79 .Pp
  80 The OpenPAM library is maintained by
  81 .An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .