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