1/*-
2 * Copyright (c) 2002-2003 Networks Associates Technology, Inc.
3 * Copyright (c) 2004-2017 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_appl.h 938 2017-04-30 21:34:42Z des $
36 */
37
38#ifndef SECURITY_PAM_APPL_H_INCLUDED
39#define SECURITY_PAM_APPL_H_INCLUDED
40
41#include <security/pam_types.h>
42#include <security/pam_constants.h>
43#include <security/openpam_attr.h>
44
45#ifdef __cplusplus
46extern "C" {
47#endif
48
49/*
50 * XSSO 4.2.1, 6
51 */
52
53int
54pam_acct_mgmt(pam_handle_t *_pamh,
55	int _flags)
56	OPENPAM_NONNULL((1));
57
58int
59pam_authenticate(pam_handle_t *_pamh,
60	int _flags)
61	OPENPAM_NONNULL((1));
62
63int
64pam_chauthtok(pam_handle_t *_pamh,
65	int _flags)
66	OPENPAM_NONNULL((1));
67
68int
69pam_close_session(pam_handle_t *_pamh,
70	int _flags)
71	OPENPAM_NONNULL((1));
72
73int
74pam_end(pam_handle_t *_pamh,
75	int _status);
76
77int
78pam_get_data(const pam_handle_t *_pamh,
79	const char *_module_data_name,
80	const void **_data)
81	OPENPAM_NONNULL((1,2,3));
82
83int
84pam_get_item(const pam_handle_t *_pamh,
85	int _item_type,
86	const void **_item)
87	OPENPAM_NONNULL((1,3));
88
89int
90pam_get_user(pam_handle_t *_pamh,
91	const char **_user,
92	const char *_prompt)
93	OPENPAM_NONNULL((1,2));
94
95const char *
96pam_getenv(pam_handle_t *_pamh,
97	const char *_name)
98	OPENPAM_NONNULL((1,2));
99
100char **
101pam_getenvlist(pam_handle_t *_pamh)
102	OPENPAM_NONNULL((1));
103
104int
105pam_open_session(pam_handle_t *_pamh,
106	int _flags)
107	OPENPAM_NONNULL((1));
108
109int
110pam_putenv(pam_handle_t *_pamh,
111	const char *_namevalue)
112	OPENPAM_NONNULL((1,2));
113
114int
115pam_set_data(pam_handle_t *_pamh,
116	const char *_module_data_name,
117	void *_data,
118	void (*_cleanup)(pam_handle_t *_pamh,
119		void *_data,
120		int _pam_end_status))
121	OPENPAM_NONNULL((1,2));
122
123int
124pam_set_item(pam_handle_t *_pamh,
125	int _item_type,
126	const void *_item)
127	OPENPAM_NONNULL((1));
128
129int
130pam_setcred(pam_handle_t *_pamh,
131	int _flags)
132	OPENPAM_NONNULL((1));
133
134int
135pam_start(const char *_service,
136	const char *_user,
137	const struct pam_conv *_pam_conv,
138	pam_handle_t **_pamh)
139	OPENPAM_NONNULL((4));
140
141const char *
142pam_strerror(const pam_handle_t *_pamh,
143	int _error_number);
144
145/*
146 * Single Sign-On extensions
147 */
148#if 0
149int
150pam_authenticate_secondary(pam_handle_t *_pamh,
151	char *_target_username,
152	char *_target_module_type,
153	char *_target_authn_domain,
154	char *_target_supp_data,
155	char *_target_module_authtok,
156	int _flags);
157
158int
159pam_get_mapped_authtok(pam_handle_t *_pamh,
160	const char *_target_module_username,
161	const char *_target_module_type,
162	const char *_target_authn_domain,
163	size_t *_target_authtok_len,
164	unsigned char **_target_module_authtok);
165
166int
167pam_get_mapped_username(pam_handle_t *_pamh,
168	const char *_src_username,
169	const char *_src_module_type,
170	const char *_src_authn_domain,
171	const char *_target_module_type,
172	const char *_target_authn_domain,
173	char **_target_module_username);
174
175int
176pam_set_mapped_authtok(pam_handle_t *_pamh,
177	const char *_target_module_username,
178	size_t _target_authtok_len,
179	unsigned char *_target_module_authtok,
180	const char *_target_module_type,
181	const char *_target_authn_domain);
182
183int
184pam_set_mapped_username(pam_handle_t *_pamh,
185	char *_src_username,
186	char *_src_module_type,
187	char *_src_authn_domain,
188	char *_target_module_username,
189	char *_target_module_type,
190	char *_target_authn_domain);
191#endif /* 0 */
192
193#ifdef __cplusplus
194}
195#endif
196
197#endif /* !SECURITY_PAM_APPL_H_INCLUDED */
198