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

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

Change pam_get_authtok()'s prototype so the caller can specify
what token it wants. Also introduce PAM_OLDAUTHTOK_PROMPT.

Sponsored by: DARPA, NAI Labs

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