xref: /freebsd/contrib/openpam/doc/man/pam_start.3 (revision 1e413cf93298b5b97441a21d9a50fdcd0ee9945e)
1.\"-
2.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
3.\" Copyright (c) 2004-2007 Dag-Erling Smørgrav
4.\" All rights reserved.
5.\"
6.\" This software was developed for the FreeBSD Project by ThinkSec AS and
7.\" Network Associates Laboratories, the Security Research Division of
8.\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
9.\" ("CBOSS"), as part of the DARPA CHATS research program.
10.\"
11.\" Redistribution and use in source and binary forms, with or without
12.\" modification, are permitted provided that the following conditions
13.\" are met:
14.\" 1. Redistributions of source code must retain the above copyright
15.\"    notice, this list of conditions and the following disclaimer.
16.\" 2. Redistributions in binary form must reproduce the above copyright
17.\"    notice, this list of conditions and the following disclaimer in the
18.\"    documentation and/or other materials provided with the distribution.
19.\" 3. The name of the author may not be used to endorse or promote
20.\"    products derived from this software without specific prior written
21.\"    permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33.\" SUCH DAMAGE.
34.\"
35.\" $P4$
36.\"
37.Dd December 21, 2007
38.Dt PAM_START 3
39.Os
40.Sh NAME
41.Nm pam_start
42.Nd initiate a PAM transaction
43.Sh LIBRARY
44.Lb libpam
45.Sh SYNOPSIS
46.In sys/types.h
47.In security/pam_appl.h
48.Ft "int"
49.Fn pam_start "const char *service" "const char *user" "const struct pam_conv *pam_conv" "pam_handle_t **pamh"
50.Sh DESCRIPTION
51The
52.Nm
53function creates and initializes a PAM context.
54.Pp
55The
56.Fa service
57argument specifies the name of the policy to apply, and is
58stored in the
59.Dv PAM_SERVICE
60item in the created context.
61.Pp
62The
63.Fa user
64argument specifies the name of the target user - the user the
65created context will serve to authenticate.
66It is stored in the
67.Dv PAM_USER
68item in the created context.
69.Pp
70The
71.Fa pam_conv
72argument points to a
73.Vt struct pam_conv
74describing the
75conversation function to use; see
76.Fa pam_conv
77for details.
78.Pp
79.Sh RETURN VALUES
80The
81.Nm
82function returns one of the following values:
83.Bl -tag -width 18n
84.It Bq Er PAM_BUF_ERR
85Memory buffer error.
86.It Bq Er PAM_SYSTEM_ERR
87System error.
88.El
89.Sh SEE ALSO
90.Xr pam 3 ,
91.Xr pam_end 3 ,
92.Xr pam_get_item 3 ,
93.Xr pam_set_item 3 ,
94.Xr pam_strerror 3
95.Sh STANDARDS
96.Rs
97.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
98.%D "June 1997"
99.Re
100.Sh AUTHORS
101The
102.Nm
103function and this manual page were developed for the
104.Fx
105Project by ThinkSec AS and Network Associates Laboratories, the
106Security Research Division of Network Associates, Inc.\& under
107DARPA/SPAWAR contract N66001-01-C-8035
108.Pq Dq CBOSS ,
109as part of the DARPA CHATS research program.
110