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