xref: /dflybsd-src/contrib/openpam/doc/man/pam_start.3 (revision 4c84ab30f7dd59ef873b5a6d4e27bcea89d9f848)
110b5fe87SSascha Wildner.\" Generated from pam_start.c by gendoc.pl
210b5fe87SSascha Wildner.\" $OpenPAM: pam_start.c 938 2017-04-30 21:34:42Z des $
3*4c84ab30SSascha Wildner.Dd February 24, 2019
4ade90846SJoerg Sonnenberger.Dt PAM_START 3
5ade90846SJoerg Sonnenberger.Os
6ade90846SJoerg Sonnenberger.Sh NAME
7ade90846SJoerg Sonnenberger.Nm pam_start
8ade90846SJoerg Sonnenberger.Nd initiate a PAM transaction
9ade90846SJoerg Sonnenberger.Sh SYNOPSIS
10ade90846SJoerg Sonnenberger.In sys/types.h
11ade90846SJoerg Sonnenberger.In security/pam_appl.h
12ade90846SJoerg Sonnenberger.Ft "int"
13ade90846SJoerg Sonnenberger.Fn pam_start "const char *service" "const char *user" "const struct pam_conv *pam_conv" "pam_handle_t **pamh"
14ade90846SJoerg Sonnenberger.Sh DESCRIPTION
15ade90846SJoerg SonnenbergerThe
16577efdeeSPeter Avalos.Fn pam_start
17ade90846SJoerg Sonnenbergerfunction creates and initializes a PAM context.
18ade90846SJoerg Sonnenberger.Pp
19ade90846SJoerg SonnenbergerThe
20ade90846SJoerg Sonnenberger.Fa service
21ade90846SJoerg Sonnenbergerargument specifies the name of the policy to apply, and is
22ade90846SJoerg Sonnenbergerstored in the
23ade90846SJoerg Sonnenberger.Dv PAM_SERVICE
24ade90846SJoerg Sonnenbergeritem in the created context.
25ade90846SJoerg Sonnenberger.Pp
26ade90846SJoerg SonnenbergerThe
27ade90846SJoerg Sonnenberger.Fa user
28ade90846SJoerg Sonnenbergerargument specifies the name of the target user - the user the
29ade90846SJoerg Sonnenbergercreated context will serve to authenticate.
30ade90846SJoerg SonnenbergerIt is stored in the
31ade90846SJoerg Sonnenberger.Dv PAM_USER
32ade90846SJoerg Sonnenbergeritem in the created context.
33ade90846SJoerg Sonnenberger.Pp
34ade90846SJoerg SonnenbergerThe
35ade90846SJoerg Sonnenberger.Fa pam_conv
36ade90846SJoerg Sonnenbergerargument points to a
37ade90846SJoerg Sonnenberger.Vt struct pam_conv
38ade90846SJoerg Sonnenbergerdescribing the
39ade90846SJoerg Sonnenbergerconversation function to use; see
40ade90846SJoerg Sonnenberger.Fa pam_conv
41ade90846SJoerg Sonnenbergerfor details.
42ade90846SJoerg Sonnenberger.Pp
43ade90846SJoerg Sonnenberger.Sh RETURN VALUES
44ade90846SJoerg SonnenbergerThe
45577efdeeSPeter Avalos.Fn pam_start
46ade90846SJoerg Sonnenbergerfunction returns one of the following values:
47ade90846SJoerg Sonnenberger.Bl -tag -width 18n
4810b5fe87SSascha Wildner.It Bq Er PAM_SUCCESS
4910b5fe87SSascha WildnerSuccess.
5010b5fe87SSascha Wildner.It Bq Er PAM_BAD_ITEM
5110b5fe87SSascha WildnerUnrecognized or restricted item.
52ade90846SJoerg Sonnenberger.It Bq Er PAM_BUF_ERR
53ade90846SJoerg SonnenbergerMemory buffer error.
54ade90846SJoerg Sonnenberger.It Bq Er PAM_SYSTEM_ERR
55ade90846SJoerg SonnenbergerSystem error.
56ade90846SJoerg Sonnenberger.El
57ade90846SJoerg Sonnenberger.Sh SEE ALSO
58ade90846SJoerg Sonnenberger.Xr pam 3 ,
59ade90846SJoerg Sonnenberger.Xr pam_end 3 ,
60ade90846SJoerg Sonnenberger.Xr pam_get_item 3 ,
61ade90846SJoerg Sonnenberger.Xr pam_set_item 3 ,
62ade90846SJoerg Sonnenberger.Xr pam_strerror 3
63ade90846SJoerg Sonnenberger.Sh STANDARDS
64ade90846SJoerg Sonnenberger.Rs
65ade90846SJoerg Sonnenberger.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
66ade90846SJoerg Sonnenberger.%D "June 1997"
67ade90846SJoerg Sonnenberger.Re
68ade90846SJoerg Sonnenberger.Sh AUTHORS
69ade90846SJoerg SonnenbergerThe
70577efdeeSPeter Avalos.Fn pam_start
71577efdeeSPeter Avalosfunction and this manual page were
72577efdeeSPeter Avalosdeveloped for the
73ade90846SJoerg Sonnenberger.Fx
74577efdeeSPeter AvalosProject by ThinkSec AS and Network Associates Laboratories, the
75f23594ceSHasso TepperSecurity Research Division of Network Associates, Inc.\& under
76ade90846SJoerg SonnenbergerDARPA/SPAWAR contract N66001-01-C-8035
77ade90846SJoerg Sonnenberger.Pq Dq CBOSS ,
78ade90846SJoerg Sonnenbergeras part of the DARPA CHATS research program.
7910b5fe87SSascha Wildner.Pp
8010b5fe87SSascha WildnerThe OpenPAM library is maintained by
8110b5fe87SSascha Wildner.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
82