xref: /freebsd/contrib/openpam/doc/man/pam_start.3 (revision 3ba4c8c81a28de3e00ccf6d7f92c6f8e58bef456)
1.\" Generated from pam_start.c by gendoc.pl
2.Dd June 27, 2023
3.Dt PAM_START 3
4.Os
5.Sh NAME
6.Nm pam_start
7.Nd initiate a PAM transaction
8.Sh SYNOPSIS
9.In sys/types.h
10.In security/pam_appl.h
11.Ft "int"
12.Fn pam_start "const char *service" "const char *user" "const struct pam_conv *pam_conv" "pam_handle_t **pamh"
13.Sh DESCRIPTION
14The
15.Fn pam_start
16function creates and initializes a PAM context.
17.Pp
18The
19.Fa service
20argument specifies the name of the policy to apply, and is
21stored in the
22.Dv PAM_SERVICE
23item in the created context.
24.Pp
25The
26.Fa user
27argument specifies the name of the target user - the user the
28created context will serve to authenticate.
29It is stored in the
30.Dv PAM_USER
31item in the created context.
32.Pp
33The
34.Fa pam_conv
35argument points to a
36.Vt struct pam_conv
37describing the
38conversation function to use; see
39.Fa pam_conv
40for details.
41.Pp
42.Sh RETURN VALUES
43The
44.Fn pam_start
45function returns one of the following values:
46.Bl -tag -width 18n
47.It Bq Er PAM_SUCCESS
48Success.
49.It Bq Er PAM_BAD_ITEM
50Unrecognized or restricted item.
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 Mt des@des.no .
81