contrib/openpam/doc/man/pam_start.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 December 18, 2011
  38 .Dt PAM_START 3
  39 .Os
  40 .Sh NAME
  41 .Nm pam_start
  42 .Nd initiate a PAM transaction
  43 .Sh LIBRARY
  44 .Lb libpam
  45 .Sh SYNOPSIS
  46 .In sys/types.h
  47 .In security/pam_appl.h
  48 .Ft "int"
  49 .Fn pam_start "const char *service" "const char *user" "const struct pam_conv *pam_conv" "pam_handle_t **pamh"
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 function creates and initializes a PAM context.
  54 .Pp
  55 The
  56 .Fa service
  57 argument specifies the name of the policy to apply, and is
  58 stored in the
  59 .Dv PAM_SERVICE
  60 item in the created context.
  61 .Pp
  62 The
  63 .Fa user
  64 argument specifies the name of the target user - the user the
  65 created context will serve to authenticate.
  66 It is stored in the
  67 .Dv PAM_USER
  68 item in the created context.
  69 .Pp
  70 The
  71 .Fa pam_conv
  72 argument points to a
  73 .Vt struct pam_conv
  74 describing the
  75 conversation function to use; see
  76 .Fa pam_conv
  77 for details.
  78 .Pp
  79 .Sh RETURN VALUES
  80 The
  81 .Nm
  82 function returns one of the following values:
  83 .Bl -tag -width 18n
  84 .It Bq Er PAM_BUF_ERR
  85 Memory buffer error.
  86 .It Bq Er PAM_SYSTEM_ERR
  87 System error.
  88 .El
  89 .Sh SEE ALSO
  90 .Xr pam 3 ,
  91 .Xr pam_end 3 ,
  92 .Xr pam_get_item 3 ,
  93 .Xr pam_set_item 3 ,
  94 .Xr pam_strerror 3
  95 .Sh STANDARDS
  96 .Rs
  97 .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
  98 .%D "June 1997"
  99 .Re
 100 .Sh AUTHORS
 101 The
 102 .Nm
 103 function and this manual page were developed for the
 104 .Fx
 105 Project by
 106 ThinkSec AS and Network Associates Laboratories, the
 107 Security Research Division of Network Associates, Inc.\& under
 108 DARPA/SPAWAR contract N66001-01-C-8035
 109 .Pq Dq CBOSS ,
 110 as part of the DARPA CHATS research program.