openpam.h revision 95908
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#19 $ 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__) && (__STDC_VERSION__ >= 199901L) 141#define openpam_log(lvl, fmt, ...) \ 142 _openpam_log((lvl), __func__, fmt, __VA_ARGS__) 143#elif defined(__GNUC__) && (__GNUC__ >= 2) && (__GNUC_MINOR__ >= 95) 144#define openpam_log(lvl, fmt...) \ 145 _openpam_log((lvl), __func__, ##fmt) 146#elif defined(__GNUC__) && defined(__FUNCTION__) 147#define openpam_log(lvl, fmt...) \ 148 _openpam_log((lvl), __FUNCTION__, ##fmt) 149#else 150void 151openpam_log(int _level, 152 const char *_format, 153 ...); 154#endif 155 156/* 157 * Generic conversation function 158 */ 159struct pam_message; 160struct pam_response; 161int openpam_ttyconv(int _n, 162 const struct pam_message **_msg, 163 struct pam_response **_resp, 164 void *_data); 165 166/* 167 * Null conversation function 168 */ 169int openpam_nullconv(int _n, 170 const struct pam_message **_msg, 171 struct pam_response **_resp, 172 void *_data); 173 174/* 175 * PAM primitives 176 */ 177enum { 178 PAM_SM_AUTHENTICATE, 179 PAM_SM_SETCRED, 180 PAM_SM_ACCT_MGMT, 181 PAM_SM_OPEN_SESSION, 182 PAM_SM_CLOSE_SESSION, 183 PAM_SM_CHAUTHTOK, 184 /* keep this last */ 185 PAM_NUM_PRIMITIVES 186}; 187 188/* 189 * Dummy service module function 190 */ 191#define PAM_SM_DUMMY(type) \ 192PAM_EXTERN int \ 193pam_sm_##type(pam_handle_t *pamh, int flags, \ 194 int argc, const char *argv[]) \ 195{ \ 196 return (PAM_IGNORE); \ 197} 198 199/* 200 * PAM service module functions match this typedef 201 */ 202struct pam_handle; 203typedef int (*pam_func_t)(struct pam_handle *, int, int, const char **); 204 205/* 206 * A struct that describes a module. 207 */ 208typedef struct pam_module pam_module_t; 209struct pam_module { 210 char *path; 211 pam_func_t func[PAM_NUM_PRIMITIVES]; 212 void *dlh; 213 int refcount; 214 pam_module_t *prev; 215 pam_module_t *next; 216}; 217 218/* 219 * Source-code compatibility with Linux-PAM modules 220 */ 221#if defined(PAM_SM_AUTH) || defined(PAM_SM_ACCOUNT) || \ 222 defined(PAM_SM_SESSION) || defined(PAM_SM_PASSWORD) 223#define LINUX_PAM_MODULE 224#endif 225#if defined(LINUX_PAM_MODULE) && !defined(PAM_SM_AUTH) 226#define _PAM_SM_AUTHENTICATE 0 227#define _PAM_SM_SETCRED 0 228#else 229#undef PAM_SM_AUTH 230#define PAM_SM_AUTH 231#define _PAM_SM_AUTHENTICATE pam_sm_authenticate 232#define _PAM_SM_SETCRED pam_sm_setcred 233#endif 234#if defined(LINUX_PAM_MODULE) && !defined(PAM_SM_ACCOUNT) 235#define _PAM_SM_ACCT_MGMT 0 236#else 237#undef PAM_SM_ACCOUNT 238#define PAM_SM_ACCOUNT 239#define _PAM_SM_ACCT_MGMT pam_sm_acct_mgmt 240#endif 241#if defined(LINUX_PAM_MODULE) && !defined(PAM_SM_SESSION) 242#define _PAM_SM_OPEN_SESSION 0 243#define _PAM_SM_CLOSE_SESSION 0 244#else 245#undef PAM_SM_SESSION 246#define PAM_SM_SESSION 247#define _PAM_SM_OPEN_SESSION pam_sm_open_session 248#define _PAM_SM_CLOSE_SESSION pam_sm_close_session 249#endif 250#if defined(LINUX_PAM_MODULE) && !defined(PAM_SM_PASSWORD) 251#define _PAM_SM_CHAUTHTOK 0 252#else 253#undef PAM_SM_PASSWORD 254#define PAM_SM_PASSWORD 255#define _PAM_SM_CHAUTHTOK pam_sm_chauthtok 256#endif 257 258/* 259 * Infrastructure for static modules using GCC linker sets. 260 * You are not expected to understand this. 261 */ 262#if defined(__FreeBSD__) 263#define PAM_SOEXT ".so" 264#else 265#ifndef NO_STATIC_MODULES 266#define NO_STATIC_MODULES 267#endif 268#endif 269#if defined(__GNUC__) && !defined(__PIC__) && !defined(NO_STATIC_MODULES) 270/* gcc, static linking */ 271#include <sys/cdefs.h> 272#include <linker_set.h> 273#define OPENPAM_STATIC_MODULES 274#define PAM_EXTERN static 275#define PAM_MODULE_ENTRY(name) \ 276static char _pam_name[] = name PAM_SOEXT; \ 277static struct pam_module _pam_module = { _pam_name, { \ 278 _PAM_SM_AUTHENTICATE, _PAM_SM_SETCRED, _PAM_SM_ACCT_MGMT, \ 279 _PAM_SM_OPEN_SESSION, _PAM_SM_CLOSE_SESSION, _PAM_SM_CHAUTHTOK }, \ 280 NULL, 0, NULL, NULL }; \ 281DATA_SET(_openpam_static_modules, _pam_module) 282#else 283/* normal case */ 284#define PAM_EXTERN 285#define PAM_MODULE_ENTRY(name) 286#endif 287 288#ifdef __cplusplus 289} 290#endif 291 292#endif 293