openpam.h revision 97241 
1/*-
2 * Copyright (c) 2002 Networks Associates Technology, Inc.
3 * All rights reserved.
4 *
5 * This software was developed for the FreeBSD Project by ThinkSec AS and
6 * NAI Labs, the Security Research Division of Network Associates, Inc.
7 * under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
8 * DARPA CHATS research program.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 * 3. The name of the author may not be used to endorse or promote
19 *    products derived from this software without specific prior written
20 *    permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 *
34 * $P4: //depot/projects/openpam/include/security/openpam.h#20 $
35 */
36
37#ifndef _SECURITY_OPENPAM_H_INCLUDED
38#define _SECURITY_OPENPAM_H_INCLUDED
39
40/*
41 * Annoying but necessary header pollution
42 */
43#include <stdarg.h>
44
45#ifdef __cplusplus
46extern "C" {
47#endif
48
49struct passwd;
50
51/*
52 * API extensions
53 */
54int
55openpam_borrow_cred(pam_handle_t *_pamh,
56	const struct passwd *_pwd);
57
58void
59openpam_free_data(pam_handle_t *_pamh,
60	void *_data,
61	int _status);
62
63const char *
64openpam_get_option(pam_handle_t *_pamh,
65	const char *_option);
66
67int
68openpam_restore_cred(pam_handle_t *_pamh);
69
70int
71openpam_set_option(pam_handle_t *_pamh,
72	const char *_option,
73	const char *_value);
74
75int
76pam_error(pam_handle_t *_pamh,
77	const char *_fmt,
78	...);
79
80int
81pam_get_authtok(pam_handle_t *_pamh,
82	int _item,
83	const char **_authtok,
84	const char *_prompt);
85
86int
87pam_info(pam_handle_t *_pamh,
88	const char *_fmt,
89	...);
90
91int
92pam_prompt(pam_handle_t *_pamh,
93	int _style,
94	char **_resp,
95	const char *_fmt,
96	...);
97
98int
99pam_setenv(pam_handle_t *_pamh,
100	const char *_name,
101	const char *_value,
102	int _overwrite);
103
104int
105pam_vinfo(pam_handle_t *_pamh,
106	const char *_fmt,
107	va_list _ap);
108
109int
110pam_verror(pam_handle_t *_pamh,
111	const char *_fmt,
112	va_list _ap);
113
114int
115pam_vprompt(pam_handle_t *_pamh,
116	int _style,
117	char **_resp,
118	const char *_fmt,
119	va_list _ap);
120
121/*
122 * Log levels
123 */
124enum {
125	PAM_LOG_DEBUG,
126	PAM_LOG_VERBOSE,
127	PAM_LOG_NOTICE,
128	PAM_LOG_ERROR
129};
130
131/*
132 * Log to syslog
133 */
134void
135_openpam_log(int _level,
136	const char *_func,
137	const char *_fmt,
138	...);
139
140#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
141#define openpam_log(lvl, ...) \
142	_openpam_log((lvl), __func__, __VA_ARGS__)
143#elif defined(__GNUC__) && (__GNUC__ >= 3)
144#define openpam_log(lvl, ...) \
145	_openpam_log((lvl), __func__, __VA_ARGS__)
146#elif defined(__GNUC__) && (__GNUC__ >= 2) && (__GNUC_MINOR__ >= 95)
147#define openpam_log(lvl, fmt...) \
148	_openpam_log((lvl), __func__, ##fmt)
149#elif defined(__GNUC__) && defined(__FUNCTION__)
150#define openpam_log(lvl, fmt...) \
151	_openpam_log((lvl), __FUNCTION__, ##fmt)
152#else
153void
154openpam_log(int _level,
155	const char *_format,
156	...);
157#endif
158
159/*
160 * Generic conversation function
161 */
162struct pam_message;
163struct pam_response;
164int openpam_ttyconv(int _n,
165	const struct pam_message **_msg,
166	struct pam_response **_resp,
167	void *_data);
168
169/*
170 * Null conversation function
171 */
172int openpam_nullconv(int _n,
173	const struct pam_message **_msg,
174	struct pam_response **_resp,
175	void *_data);
176
177/*
178 * PAM primitives
179 */
180enum {
181	PAM_SM_AUTHENTICATE,
182	PAM_SM_SETCRED,
183	PAM_SM_ACCT_MGMT,
184	PAM_SM_OPEN_SESSION,
185	PAM_SM_CLOSE_SESSION,
186	PAM_SM_CHAUTHTOK,
187	/* keep this last */
188	PAM_NUM_PRIMITIVES
189};
190
191/*
192 * Dummy service module function
193 */
194#define PAM_SM_DUMMY(type)						\
195PAM_EXTERN int								\
196pam_sm_##type(pam_handle_t *pamh, int flags,				\
197    int argc, const char *argv[])					\
198{									\
199	return (PAM_IGNORE);						\
200}
201
202/*
203 * PAM service module functions match this typedef
204 */
205struct pam_handle;
206typedef int (*pam_func_t)(struct pam_handle *, int, int, const char **);
207
208/*
209 * A struct that describes a module.
210 */
211typedef struct pam_module pam_module_t;
212struct pam_module {
213	char		*path;
214	pam_func_t	 func[PAM_NUM_PRIMITIVES];
215	void		*dlh;
216	int		 refcount;
217	pam_module_t	*prev;
218	pam_module_t	*next;
219};
220
221/*
222 * Source-code compatibility with Linux-PAM modules
223 */
224#if defined(PAM_SM_AUTH) || defined(PAM_SM_ACCOUNT) || \
225	defined(PAM_SM_SESSION) || defined(PAM_SM_PASSWORD)
226#define LINUX_PAM_MODULE
227#endif
228#if defined(LINUX_PAM_MODULE) && !defined(PAM_SM_AUTH)
229#define _PAM_SM_AUTHENTICATE	0
230#define _PAM_SM_SETCRED		0
231#else
232#undef PAM_SM_AUTH
233#define PAM_SM_AUTH
234#define _PAM_SM_AUTHENTICATE	pam_sm_authenticate
235#define _PAM_SM_SETCRED		pam_sm_setcred
236#endif
237#if defined(LINUX_PAM_MODULE) && !defined(PAM_SM_ACCOUNT)
238#define _PAM_SM_ACCT_MGMT	0
239#else
240#undef PAM_SM_ACCOUNT
241#define PAM_SM_ACCOUNT
242#define _PAM_SM_ACCT_MGMT	pam_sm_acct_mgmt
243#endif
244#if defined(LINUX_PAM_MODULE) && !defined(PAM_SM_SESSION)
245#define _PAM_SM_OPEN_SESSION	0
246#define _PAM_SM_CLOSE_SESSION	0
247#else
248#undef PAM_SM_SESSION
249#define PAM_SM_SESSION
250#define _PAM_SM_OPEN_SESSION	pam_sm_open_session
251#define _PAM_SM_CLOSE_SESSION	pam_sm_close_session
252#endif
253#if defined(LINUX_PAM_MODULE) && !defined(PAM_SM_PASSWORD)
254#define _PAM_SM_CHAUTHTOK	0
255#else
256#undef PAM_SM_PASSWORD
257#define PAM_SM_PASSWORD
258#define _PAM_SM_CHAUTHTOK	pam_sm_chauthtok
259#endif
260
261/*
262 * Infrastructure for static modules using GCC linker sets.
263 * You are not expected to understand this.
264 */
265#if defined(__FreeBSD__)
266#define PAM_SOEXT ".so"
267#else
268#ifndef NO_STATIC_MODULES
269#define NO_STATIC_MODULES
270#endif
271#endif
272#if defined(__GNUC__) && !defined(__PIC__) && !defined(NO_STATIC_MODULES)
273/* gcc, static linking */
274#include <sys/cdefs.h>
275#include <linker_set.h>
276#define OPENPAM_STATIC_MODULES
277#define PAM_EXTERN static
278#define PAM_MODULE_ENTRY(name)						\
279static char _pam_name[] = name PAM_SOEXT;				\
280static struct pam_module _pam_module = { _pam_name, {			\
281    _PAM_SM_AUTHENTICATE, _PAM_SM_SETCRED, _PAM_SM_ACCT_MGMT,		\
282    _PAM_SM_OPEN_SESSION, _PAM_SM_CLOSE_SESSION, _PAM_SM_CHAUTHTOK },	\
283    NULL, 0, NULL, NULL };						\
284DATA_SET(_openpam_static_modules, _pam_module)
285#else
286/* normal case */
287#define PAM_EXTERN
288#define PAM_MODULE_ENTRY(name)
289#endif
290
291#ifdef __cplusplus
292}
293#endif
294
295#endif
296