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