source: openpam/trunk/include/security/openpam.h @ 42

Last change on this file since 42 was 42, checked in by Dag-Erling Smørgrav, 18 years ago

Make C++-safe.

Sponsored by: DARPA, NAI Labs

  • Property svn:keywords set to Id LastChangedRevision HeadURL LastChangedDate LastChangedBy
File size: 4.9 KB
Line 
1/*-
2 * Copyright (c) 2002 Networks Associates Technologies, 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 * $Id: openpam.h 42 2002-02-09 15:43:36Z des $
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
49/*
50 * API extensions
51 */
52int
53pam_error(pam_handle_t *_pamh,
54        const char *_fmt,
55        ...);
56
57int
58pam_get_authtok(pam_handle_t *_pamh,
59        const char **_authtok,
60        const char *_prompt);
61
62int
63pam_info(pam_handle_t *_pamh,
64        const char *_fmt,
65        ...);
66
67int
68pam_prompt(pam_handle_t *_pamh,
69        int _style,
70        char **_resp,
71        const char *_fmt,
72        ...);
73
74int
75pam_setenv(pam_handle_t *_pamh,
76        const char *_name,
77        const char *_value,
78        int _overwrite);
79
80int
81pam_vinfo(pam_handle_t *_pamh,
82        const char *_fmt,
83        va_list _ap);
84
85int
86pam_verror(pam_handle_t *_pamh,
87        const char *_fmt,
88        va_list _ap);
89
90int
91pam_vprompt(pam_handle_t *_pamh,
92        int _style,
93        char **_resp,
94        const char *_fmt,
95        va_list _ap);
96
97/*
98 * Log levels
99 */
100enum {
101        PAM_LOG_DEBUG,
102        PAM_LOG_VERBOSE,
103        PAM_LOG_NOTICE,
104        PAM_LOG_ERROR
105};
106
107/*
108 * Log to syslog
109 */
110void _openpam_log(int _level,
111        const char *_func,
112        const char *_fmt,
113        ...);
114
115#if defined(__STDC__) && (__STDC_VERSION__ > 199901L)
116#define openpam_log(lvl, fmt, ...) \
117        _openpam_log((lvl), __func__, fmt, __VA_ARGS__)
118#elif defined(__GNUC__)
119#define openpam_log(lvl, fmt...) \
120        _openpam_log((lvl), __func__, ##fmt)
121#else
122extern openpam_log(int _level, const char *_format, ...);
123#endif
124
125/*
126 * Generic conversation function
127 */
128struct pam_message;
129struct pam_response;
130int openpam_ttyconv(int _n,
131        const struct pam_message **_msg,
132        struct pam_response **_resp,
133        void *_data);
134
135/*
136 * PAM primitives
137 */
138enum {
139        PAM_SM_AUTHENTICATE,
140        PAM_SM_SETCRED,
141        PAM_SM_ACCT_MGMT,
142        PAM_SM_OPEN_SESSION,
143        PAM_SM_CLOSE_SESSION,
144        PAM_SM_CHAUTHTOK,
145        /* keep this last */
146        PAM_NUM_PRIMITIVES
147};
148
149/*
150 * Dummy service module function
151 */
152#define PAM_SM_DUMMY(type)                                              \
153PAM_EXTERN int                                                          \
154pam_sm_##type(pam_handle_t *pamh, int flags,                            \
155    int argc, const char *argv[])                                       \
156{                                                                       \
157        return (PAM_IGNORE);                                            \
158}
159
160/*
161 * PAM service module functions match this typedef
162 */
163struct pam_handle;
164typedef int (*pam_func_t)(struct pam_handle *, int, int, const char **);
165
166/*
167 * A struct that describes a module.
168 */
169typedef struct pam_module pam_module_t;
170struct pam_module {
171        const char      *path;
172        pam_func_t       func[PAM_NUM_PRIMITIVES];
173        void            *dlh;
174        int              refcount;
175        pam_module_t    *prev;
176        pam_module_t    *next;
177};
178
179/*
180 * Infrastructure for static modules using GCC linker sets.
181 * You are not expected to understand this.
182 */
183#if defined(__GNUC__) && !defined(__PIC__)
184#if defined(__FreeBSD__)
185#define PAM_SOEXT ".so"
186#else
187#error Static linking is not supported on your platform
188#endif
189/* gcc, static linking */
190#include <sys/cdefs.h>
191#include <linker_set.h>
192#define OPENPAM_STATIC_MODULES
193#define PAM_EXTERN static
194#define PAM_MODULE_ENTRY(name)                                          \
195static struct pam_module _pam_module = { name PAM_SOEXT, {              \
196    pam_sm_authenticate, pam_sm_setcred, pam_sm_acct_mgmt,              \
197    pam_sm_open_session, pam_sm_close_session, pam_sm_chauthtok },      \
198    NULL, 0, NULL, NULL };                                              \
199DATA_SET(_openpam_modules, _pam_module)
200#else
201/* normal case */
202#define PAM_EXTERN
203#define PAM_MODULE_ENTRY(name)
204#endif
205
206#ifdef __cplusplus
207}
208#endif
209
210#endif
Note: See TracBrowser for help on using the repository browser.