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