Import OpenPAM Resedacea.
[dragonfly.git] / contrib / openpam / lib / libpam / pam_start.c
1 /*-
2  * Copyright (c) 2002-2003 Networks Associates Technology, Inc.
3  * Copyright (c) 2004-2011 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  * $OpenPAM: pam_start.c 938 2017-04-30 21:34:42Z des $
36  */
37
38 #ifdef HAVE_CONFIG_H
39 # include "config.h"
40 #endif
41
42 #include <stdlib.h>
43 #include <string.h>
44 #include <unistd.h>
45
46 #include <security/pam_appl.h>
47
48 #include "openpam_impl.h"
49 #include "openpam_strlcpy.h"
50
51 #ifdef _SC_HOST_NAME_MAX
52 #define HOST_NAME_MAX sysconf(_SC_HOST_NAME_MAX)
53 #else
54 #define HOST_NAME_MAX 1024
55 #endif
56
57 /*
58  * XSSO 4.2.1
59  * XSSO 6 page 89
60  *
61  * Initiate a PAM transaction
62  */
63
64 int
65 pam_start(const char *service,
66         const char *user,
67         const struct pam_conv *pam_conv,
68         pam_handle_t **pamh)
69 {
70         char hostname[HOST_NAME_MAX + 1];
71         struct pam_handle *ph;
72         int r;
73
74         ENTER();
75         if ((ph = calloc(1, sizeof *ph)) == NULL)
76                 RETURNC(PAM_BUF_ERR);
77         if ((r = pam_set_item(ph, PAM_SERVICE, service)) != PAM_SUCCESS)
78                 goto fail;
79         if (gethostname(hostname, sizeof hostname) != 0)
80                 strlcpy(hostname, "localhost", sizeof hostname);
81         if ((r = pam_set_item(ph, PAM_HOST, hostname)) != PAM_SUCCESS)
82                 goto fail;
83         if ((r = pam_set_item(ph, PAM_USER, user)) != PAM_SUCCESS)
84                 goto fail;
85         if ((r = pam_set_item(ph, PAM_CONV, pam_conv)) != PAM_SUCCESS)
86                 goto fail;
87         if ((r = openpam_configure(ph, service)) != PAM_SUCCESS)
88                 goto fail;
89         *pamh = ph;
90         openpam_log(PAM_LOG_DEBUG, "pam_start(\"%s\") succeeded", service);
91         RETURNC(PAM_SUCCESS);
92 fail:
93         pam_end(ph, r);
94         RETURNC(r);
95 }
96
97 /*
98  * Error codes:
99  *
100  *      =openpam_configure
101  *      =pam_set_item
102  *      !PAM_SYMBOL_ERR
103  *      PAM_BUF_ERR
104  */
105
106 /**
107  * The =pam_start function creates and initializes a PAM context.
108  *
109  * The =service argument specifies the name of the policy to apply, and is
110  * stored in the =PAM_SERVICE item in the created context.
111  *
112  * The =user argument specifies the name of the target user - the user the
113  * created context will serve to authenticate.
114  * It is stored in the =PAM_USER item in the created context.
115  *
116  * The =pam_conv argument points to a =struct pam_conv describing the
117  * conversation function to use; see =pam_conv for details.
118  *
119  * >pam_get_item
120  * >pam_set_item
121  * >pam_end
122  */