Theodore Ts'o | 3839e65 | 1997-04-26 13:21:57 +0000 | [diff] [blame] | 1 | /* |
| 2 | * $Header$ |
| 3 | * $Source$ |
| 4 | * $Locker$ |
| 5 | * |
| 6 | * Copyright 1987 by the Student Information Processing Board |
| 7 | * of the Massachusetts Institute of Technology |
| 8 | * |
Theodore Ts'o | 06cefee | 1999-10-23 01:16:22 +0000 | [diff] [blame] | 9 | * Permission to use, copy, modify, and distribute this software and |
| 10 | * its documentation for any purpose is hereby granted, provided that |
| 11 | * the names of M.I.T. and the M.I.T. S.I.P.B. not be used in |
| 12 | * advertising or publicity pertaining to distribution of the software |
| 13 | * without specific, written prior permission. M.I.T. and the |
| 14 | * M.I.T. S.I.P.B. make no representations about the suitability of |
| 15 | * this software for any purpose. It is provided "as is" without |
| 16 | * express or implied warranty. |
Theodore Ts'o | 3839e65 | 1997-04-26 13:21:57 +0000 | [diff] [blame] | 17 | */ |
| 18 | |
Theodore Ts'o | d1154eb | 2011-09-18 17:34:37 -0400 | [diff] [blame] | 19 | #include "config.h" |
Theodore Ts'o | 1ad3174 | 2013-06-16 14:34:59 -0400 | [diff] [blame] | 20 | #if HAVE_SECURE_GETENV |
| 21 | #define _GNU_SOURCE |
| 22 | #endif |
Theodore Ts'o | 3839e65 | 1997-04-26 13:21:57 +0000 | [diff] [blame] | 23 | #include <stdio.h> |
Theodore Ts'o | 91835c1 | 2003-03-30 22:26:13 -0500 | [diff] [blame] | 24 | #include <stdlib.h> |
Theodore Ts'o | 3839e65 | 1997-04-26 13:21:57 +0000 | [diff] [blame] | 25 | #include <string.h> |
Theodore Ts'o | f3db356 | 1997-04-26 13:34:30 +0000 | [diff] [blame] | 26 | #include <errno.h> |
Theodore Ts'o | ec84b74 | 2006-12-22 13:38:38 -0500 | [diff] [blame] | 27 | #ifdef HAVE_SYS_PRCTL_H |
| 28 | #include <sys/prctl.h> |
| 29 | #else |
| 30 | #define PR_GET_DUMPABLE 3 |
| 31 | #endif |
| 32 | #if (!defined(HAVE_PRCTL) && defined(linux)) |
| 33 | #include <sys/syscall.h> |
| 34 | #endif |
Theodore Ts'o | d7f45af | 2008-09-12 10:15:26 -0400 | [diff] [blame] | 35 | #ifdef HAVE_SEMAPHORE_H |
| 36 | #include <semaphore.h> |
| 37 | #endif |
Andreas Dilger | de8f3a7 | 2007-05-25 11:18:11 -0400 | [diff] [blame] | 38 | #if HAVE_UNISTD_H |
| 39 | #include <unistd.h> |
| 40 | #endif |
Theodore Ts'o | 902be4a | 2008-10-01 20:45:26 -0400 | [diff] [blame] | 41 | #include <fcntl.h> |
Andreas Dilger | de8f3a7 | 2007-05-25 11:18:11 -0400 | [diff] [blame] | 42 | #if HAVE_SYS_TYPES_H |
| 43 | #include <sys/types.h> |
| 44 | #endif |
Theodore Ts'o | f3db356 | 1997-04-26 13:34:30 +0000 | [diff] [blame] | 45 | #include "com_err.h" |
Theodore Ts'o | 3839e65 | 1997-04-26 13:21:57 +0000 | [diff] [blame] | 46 | #include "error_table.h" |
Theodore Ts'o | 3839e65 | 1997-04-26 13:21:57 +0000 | [diff] [blame] | 47 | #include "internal.h" |
| 48 | |
Theodore Ts'o | 47526e3 | 2008-02-09 23:39:27 -0500 | [diff] [blame] | 49 | #ifdef TLS |
| 50 | #define THREAD_LOCAL static TLS |
| 51 | #else |
| 52 | #define THREAD_LOCAL static |
| 53 | #endif |
| 54 | |
| 55 | THREAD_LOCAL char buffer[25]; |
Theodore Ts'o | 3839e65 | 1997-04-26 13:21:57 +0000 | [diff] [blame] | 56 | |
| 57 | struct et_list * _et_list = (struct et_list *) NULL; |
Theodore Ts'o | d51b819 | 2005-06-20 17:59:06 -0400 | [diff] [blame] | 58 | struct et_list * _et_dynamic_list = (struct et_list *) NULL; |
Theodore Ts'o | 3839e65 | 1997-04-26 13:21:57 +0000 | [diff] [blame] | 59 | |
Theodore Ts'o | d7f45af | 2008-09-12 10:15:26 -0400 | [diff] [blame] | 60 | #ifdef __GNUC__ |
| 61 | #define COMERR_ATTR(x) __attribute__(x) |
| 62 | #else |
| 63 | #define COMERR_ATTR(x) |
| 64 | #endif |
| 65 | |
| 66 | #ifdef HAVE_SEM_INIT |
| 67 | static sem_t _et_lock; |
Theodore Ts'o | 98e9fb9 | 2008-10-02 08:51:27 -0400 | [diff] [blame] | 68 | static int _et_lock_initialized; |
Theodore Ts'o | d7f45af | 2008-09-12 10:15:26 -0400 | [diff] [blame] | 69 | |
Theodore Ts'o | 98e9fb9 | 2008-10-02 08:51:27 -0400 | [diff] [blame] | 70 | static void COMERR_ATTR((constructor)) setup_et_lock(void) |
Theodore Ts'o | d7f45af | 2008-09-12 10:15:26 -0400 | [diff] [blame] | 71 | { |
| 72 | sem_init(&_et_lock, 0, 1); |
| 73 | _et_lock_initialized = 1; |
| 74 | } |
| 75 | |
Theodore Ts'o | 98e9fb9 | 2008-10-02 08:51:27 -0400 | [diff] [blame] | 76 | static void COMERR_ATTR((destructor)) fini_et_lock(void) |
Theodore Ts'o | d7f45af | 2008-09-12 10:15:26 -0400 | [diff] [blame] | 77 | { |
| 78 | sem_destroy(&_et_lock); |
| 79 | _et_lock_initialized = 0; |
| 80 | } |
| 81 | #endif |
| 82 | |
| 83 | |
Theodore Ts'o | 98e9fb9 | 2008-10-02 08:51:27 -0400 | [diff] [blame] | 84 | int et_list_lock(void) |
Theodore Ts'o | d7f45af | 2008-09-12 10:15:26 -0400 | [diff] [blame] | 85 | { |
| 86 | #ifdef HAVE_SEM_INIT |
| 87 | if (!_et_lock_initialized) |
| 88 | setup_et_lock(); |
| 89 | return sem_wait(&_et_lock); |
| 90 | #else |
| 91 | return 0; |
| 92 | #endif |
| 93 | } |
| 94 | |
Theodore Ts'o | 98e9fb9 | 2008-10-02 08:51:27 -0400 | [diff] [blame] | 95 | int et_list_unlock(void) |
Theodore Ts'o | d7f45af | 2008-09-12 10:15:26 -0400 | [diff] [blame] | 96 | { |
| 97 | #ifdef HAVE_SEM_INIT |
| 98 | if (_et_lock_initialized) |
| 99 | return sem_post(&_et_lock); |
| 100 | #endif |
| 101 | return 0; |
| 102 | } |
Theodore Ts'o | f3db356 | 1997-04-26 13:34:30 +0000 | [diff] [blame] | 103 | |
Theodore Ts'o | 4259052 | 2011-10-05 00:58:40 -0400 | [diff] [blame] | 104 | typedef char *(*gettextf) (const char *); |
| 105 | |
Theodore Ts'o | 299a1e8 | 2011-10-05 03:03:44 -0400 | [diff] [blame] | 106 | static gettextf com_err_gettext = NULL; |
Theodore Ts'o | 4259052 | 2011-10-05 00:58:40 -0400 | [diff] [blame] | 107 | |
| 108 | gettextf set_com_err_gettext (new_proc) |
| 109 | gettextf new_proc; |
| 110 | { |
| 111 | gettextf x = com_err_gettext; |
| 112 | |
| 113 | com_err_gettext = new_proc; |
| 114 | |
| 115 | return x; |
| 116 | } |
| 117 | |
| 118 | |
Theodore Ts'o | f3db356 | 1997-04-26 13:34:30 +0000 | [diff] [blame] | 119 | const char * error_message (errcode_t code) |
Theodore Ts'o | 3839e65 | 1997-04-26 13:21:57 +0000 | [diff] [blame] | 120 | { |
| 121 | int offset; |
| 122 | struct et_list *et; |
Theodore Ts'o | a47b66e | 1997-08-10 23:02:21 +0000 | [diff] [blame] | 123 | errcode_t table_num; |
Theodore Ts'o | 3839e65 | 1997-04-26 13:21:57 +0000 | [diff] [blame] | 124 | int started = 0; |
| 125 | char *cp; |
| 126 | |
Theodore Ts'o | a47b66e | 1997-08-10 23:02:21 +0000 | [diff] [blame] | 127 | offset = (int) (code & ((1<<ERRCODE_RANGE)-1)); |
Theodore Ts'o | 3839e65 | 1997-04-26 13:21:57 +0000 | [diff] [blame] | 128 | table_num = code - offset; |
| 129 | if (!table_num) { |
Theodore Ts'o | f3db356 | 1997-04-26 13:34:30 +0000 | [diff] [blame] | 130 | #ifdef HAS_SYS_ERRLIST |
Theodore Ts'o | 3839e65 | 1997-04-26 13:21:57 +0000 | [diff] [blame] | 131 | if (offset < sys_nerr) |
| 132 | return(sys_errlist[offset]); |
| 133 | else |
| 134 | goto oops; |
Theodore Ts'o | f3db356 | 1997-04-26 13:34:30 +0000 | [diff] [blame] | 135 | #else |
| 136 | cp = strerror(offset); |
| 137 | if (cp) |
| 138 | return(cp); |
| 139 | else |
| 140 | goto oops; |
| 141 | #endif |
Theodore Ts'o | 3839e65 | 1997-04-26 13:21:57 +0000 | [diff] [blame] | 142 | } |
Theodore Ts'o | d7f45af | 2008-09-12 10:15:26 -0400 | [diff] [blame] | 143 | et_list_lock(); |
Theodore Ts'o | 3839e65 | 1997-04-26 13:21:57 +0000 | [diff] [blame] | 144 | for (et = _et_list; et; et = et->next) { |
Theodore Ts'o | 6b6c27f | 2007-12-15 22:31:03 -0500 | [diff] [blame] | 145 | if ((et->table->base & 0xffffffL) == (table_num & 0xffffffL)) { |
Theodore Ts'o | 3839e65 | 1997-04-26 13:21:57 +0000 | [diff] [blame] | 146 | /* This is the right table */ |
Theodore Ts'o | d7f45af | 2008-09-12 10:15:26 -0400 | [diff] [blame] | 147 | if (et->table->n_msgs <= offset) { |
| 148 | break; |
| 149 | } else { |
| 150 | const char *msg = et->table->msgs[offset]; |
| 151 | et_list_unlock(); |
Theodore Ts'o | 4259052 | 2011-10-05 00:58:40 -0400 | [diff] [blame] | 152 | if (com_err_gettext) |
| 153 | return (*com_err_gettext)(msg); |
| 154 | else |
| 155 | return msg; |
Theodore Ts'o | d7f45af | 2008-09-12 10:15:26 -0400 | [diff] [blame] | 156 | } |
Theodore Ts'o | 3839e65 | 1997-04-26 13:21:57 +0000 | [diff] [blame] | 157 | } |
| 158 | } |
Theodore Ts'o | d51b819 | 2005-06-20 17:59:06 -0400 | [diff] [blame] | 159 | for (et = _et_dynamic_list; et; et = et->next) { |
Theodore Ts'o | 6b6c27f | 2007-12-15 22:31:03 -0500 | [diff] [blame] | 160 | if ((et->table->base & 0xffffffL) == (table_num & 0xffffffL)) { |
Theodore Ts'o | d51b819 | 2005-06-20 17:59:06 -0400 | [diff] [blame] | 161 | /* This is the right table */ |
Theodore Ts'o | d7f45af | 2008-09-12 10:15:26 -0400 | [diff] [blame] | 162 | if (et->table->n_msgs <= offset) { |
| 163 | break; |
| 164 | } else { |
| 165 | const char *msg = et->table->msgs[offset]; |
| 166 | et_list_unlock(); |
Theodore Ts'o | 4259052 | 2011-10-05 00:58:40 -0400 | [diff] [blame] | 167 | if (com_err_gettext) |
| 168 | return (*com_err_gettext)(msg); |
| 169 | else |
| 170 | return msg; |
Theodore Ts'o | d7f45af | 2008-09-12 10:15:26 -0400 | [diff] [blame] | 171 | } |
Theodore Ts'o | d51b819 | 2005-06-20 17:59:06 -0400 | [diff] [blame] | 172 | } |
| 173 | } |
Theodore Ts'o | d7f45af | 2008-09-12 10:15:26 -0400 | [diff] [blame] | 174 | et_list_unlock(); |
Theodore Ts'o | 3839e65 | 1997-04-26 13:21:57 +0000 | [diff] [blame] | 175 | oops: |
| 176 | strcpy (buffer, "Unknown code "); |
| 177 | if (table_num) { |
| 178 | strcat (buffer, error_table_name (table_num)); |
| 179 | strcat (buffer, " "); |
| 180 | } |
| 181 | for (cp = buffer; *cp; cp++) |
| 182 | ; |
| 183 | if (offset >= 100) { |
| 184 | *cp++ = '0' + offset / 100; |
| 185 | offset %= 100; |
| 186 | started++; |
| 187 | } |
| 188 | if (started || offset >= 10) { |
| 189 | *cp++ = '0' + offset / 10; |
| 190 | offset %= 10; |
| 191 | } |
| 192 | *cp++ = '0' + offset; |
| 193 | *cp = '\0'; |
| 194 | return(buffer); |
| 195 | } |
Theodore Ts'o | 00aba96 | 2003-03-19 19:46:02 -0500 | [diff] [blame] | 196 | |
| 197 | /* |
Theodore Ts'o | ec84b74 | 2006-12-22 13:38:38 -0500 | [diff] [blame] | 198 | * This routine will only return a value if the we are not running as |
| 199 | * a privileged process. |
| 200 | */ |
| 201 | static char *safe_getenv(const char *arg) |
| 202 | { |
| 203 | if ((getuid() != geteuid()) || (getgid() != getegid())) |
| 204 | return NULL; |
| 205 | #if HAVE_PRCTL |
| 206 | if (prctl(PR_GET_DUMPABLE, 0, 0, 0, 0) == 0) |
| 207 | return NULL; |
| 208 | #else |
| 209 | #if (defined(linux) && defined(SYS_prctl)) |
| 210 | if (syscall(SYS_prctl, PR_GET_DUMPABLE, 0, 0, 0, 0) == 0) |
| 211 | return NULL; |
| 212 | #endif |
| 213 | #endif |
| 214 | |
Theodore Ts'o | 1ad3174 | 2013-06-16 14:34:59 -0400 | [diff] [blame] | 215 | #if defined(HAVE_SECURE_GETENV) |
| 216 | return secure_getenv(arg); |
| 217 | #elif defined(HAVE___SECURE_GETENV) |
Theodore Ts'o | ec84b74 | 2006-12-22 13:38:38 -0500 | [diff] [blame] | 218 | return __secure_getenv(arg); |
| 219 | #else |
| 220 | return getenv(arg); |
| 221 | #endif |
| 222 | } |
| 223 | |
| 224 | #define DEBUG_INIT 0x8000 |
| 225 | #define DEBUG_ADDREMOVE 0x0001 |
| 226 | |
| 227 | static int debug_mask = 0; |
| 228 | static FILE *debug_f = 0; |
| 229 | |
| 230 | static void init_debug(void) |
| 231 | { |
Theodore Ts'o | 902be4a | 2008-10-01 20:45:26 -0400 | [diff] [blame] | 232 | char *dstr, *fn, *tmp; |
| 233 | int fd, flags; |
Theodore Ts'o | ec84b74 | 2006-12-22 13:38:38 -0500 | [diff] [blame] | 234 | |
| 235 | if (debug_mask & DEBUG_INIT) |
| 236 | return; |
| 237 | |
| 238 | dstr = getenv("COMERR_DEBUG"); |
Theodore Ts'o | 902be4a | 2008-10-01 20:45:26 -0400 | [diff] [blame] | 239 | if (dstr) { |
| 240 | debug_mask = strtoul(dstr, &tmp, 0); |
| 241 | if (*tmp || errno) |
| 242 | debug_mask = 0; |
| 243 | } |
| 244 | |
| 245 | debug_mask |= DEBUG_INIT; |
| 246 | if (debug_mask == DEBUG_INIT) |
| 247 | return; |
Theodore Ts'o | ec84b74 | 2006-12-22 13:38:38 -0500 | [diff] [blame] | 248 | |
| 249 | fn = safe_getenv("COMERR_DEBUG_FILE"); |
| 250 | if (fn) |
| 251 | debug_f = fopen(fn, "a"); |
| 252 | if (!debug_f) |
| 253 | debug_f = fopen("/dev/tty", "a"); |
Theodore Ts'o | 902be4a | 2008-10-01 20:45:26 -0400 | [diff] [blame] | 254 | if (debug_f) { |
| 255 | fd = fileno(debug_f); |
| 256 | if (fd >= 0) { |
| 257 | flags = fcntl(fd, F_GETFD); |
| 258 | if (flags >= 0) |
| 259 | fcntl(fd, F_SETFD, flags | FD_CLOEXEC); |
| 260 | } |
| 261 | } else |
| 262 | debug_mask = DEBUG_INIT; |
Theodore Ts'o | ec84b74 | 2006-12-22 13:38:38 -0500 | [diff] [blame] | 263 | |
Theodore Ts'o | ec84b74 | 2006-12-22 13:38:38 -0500 | [diff] [blame] | 264 | } |
| 265 | |
| 266 | /* |
Theodore Ts'o | 00aba96 | 2003-03-19 19:46:02 -0500 | [diff] [blame] | 267 | * New interface provided by krb5's com_err library |
| 268 | */ |
Theodore Ts'o | 91835c1 | 2003-03-30 22:26:13 -0500 | [diff] [blame] | 269 | errcode_t add_error_table(const struct error_table * et) |
Theodore Ts'o | 00aba96 | 2003-03-19 19:46:02 -0500 | [diff] [blame] | 270 | { |
Theodore Ts'o | d51b819 | 2005-06-20 17:59:06 -0400 | [diff] [blame] | 271 | struct et_list *el; |
Theodore Ts'o | 00aba96 | 2003-03-19 19:46:02 -0500 | [diff] [blame] | 272 | |
| 273 | if (!(el = (struct et_list *) malloc(sizeof(struct et_list)))) |
| 274 | return ENOMEM; |
| 275 | |
Theodore Ts'o | d7f45af | 2008-09-12 10:15:26 -0400 | [diff] [blame] | 276 | if (et_list_lock() != 0) { |
| 277 | free(el); |
| 278 | return errno; |
| 279 | } |
| 280 | |
Theodore Ts'o | 00aba96 | 2003-03-19 19:46:02 -0500 | [diff] [blame] | 281 | el->table = et; |
Theodore Ts'o | d51b819 | 2005-06-20 17:59:06 -0400 | [diff] [blame] | 282 | el->next = _et_dynamic_list; |
| 283 | _et_dynamic_list = el; |
Theodore Ts'o | 00aba96 | 2003-03-19 19:46:02 -0500 | [diff] [blame] | 284 | |
Theodore Ts'o | ec84b74 | 2006-12-22 13:38:38 -0500 | [diff] [blame] | 285 | init_debug(); |
| 286 | if (debug_mask & DEBUG_ADDREMOVE) |
| 287 | fprintf(debug_f, "add_error_table: %s (0x%p)\n", |
| 288 | error_table_name(et->base), |
| 289 | (const void *) et); |
| 290 | |
Theodore Ts'o | d7f45af | 2008-09-12 10:15:26 -0400 | [diff] [blame] | 291 | et_list_unlock(); |
Theodore Ts'o | 00aba96 | 2003-03-19 19:46:02 -0500 | [diff] [blame] | 292 | return 0; |
| 293 | } |
| 294 | |
| 295 | /* |
| 296 | * New interface provided by krb5's com_err library |
| 297 | */ |
Theodore Ts'o | 91835c1 | 2003-03-30 22:26:13 -0500 | [diff] [blame] | 298 | errcode_t remove_error_table(const struct error_table * et) |
Theodore Ts'o | 00aba96 | 2003-03-19 19:46:02 -0500 | [diff] [blame] | 299 | { |
Theodore Ts'o | d7f45af | 2008-09-12 10:15:26 -0400 | [diff] [blame] | 300 | struct et_list *el; |
Theodore Ts'o | 00aba96 | 2003-03-19 19:46:02 -0500 | [diff] [blame] | 301 | struct et_list *el2 = 0; |
| 302 | |
Theodore Ts'o | d7f45af | 2008-09-12 10:15:26 -0400 | [diff] [blame] | 303 | if (et_list_lock() != 0) |
| 304 | return ENOENT; |
| 305 | |
| 306 | el = _et_dynamic_list; |
Theodore Ts'o | ec84b74 | 2006-12-22 13:38:38 -0500 | [diff] [blame] | 307 | init_debug(); |
Theodore Ts'o | 00aba96 | 2003-03-19 19:46:02 -0500 | [diff] [blame] | 308 | while (el) { |
| 309 | if (el->table->base == et->base) { |
| 310 | if (el2) /* Not the beginning of the list */ |
| 311 | el2->next = el->next; |
| 312 | else |
Theodore Ts'o | d51b819 | 2005-06-20 17:59:06 -0400 | [diff] [blame] | 313 | _et_dynamic_list = el->next; |
Theodore Ts'o | 00aba96 | 2003-03-19 19:46:02 -0500 | [diff] [blame] | 314 | (void) free(el); |
Theodore Ts'o | ec84b74 | 2006-12-22 13:38:38 -0500 | [diff] [blame] | 315 | if (debug_mask & DEBUG_ADDREMOVE) |
| 316 | fprintf(debug_f, |
| 317 | "remove_error_table: %s (0x%p)\n", |
| 318 | error_table_name(et->base), |
| 319 | (const void *) et); |
Theodore Ts'o | d7f45af | 2008-09-12 10:15:26 -0400 | [diff] [blame] | 320 | et_list_unlock(); |
Theodore Ts'o | 00aba96 | 2003-03-19 19:46:02 -0500 | [diff] [blame] | 321 | return 0; |
| 322 | } |
| 323 | el2 = el; |
| 324 | el = el->next; |
| 325 | } |
Theodore Ts'o | ec84b74 | 2006-12-22 13:38:38 -0500 | [diff] [blame] | 326 | if (debug_mask & DEBUG_ADDREMOVE) |
| 327 | fprintf(debug_f, "remove_error_table FAILED: %s (0x%p)\n", |
| 328 | error_table_name(et->base), |
| 329 | (const void *) et); |
Theodore Ts'o | d7f45af | 2008-09-12 10:15:26 -0400 | [diff] [blame] | 330 | et_list_unlock(); |
Theodore Ts'o | 00aba96 | 2003-03-19 19:46:02 -0500 | [diff] [blame] | 331 | return ENOENT; |
| 332 | } |
| 333 | |
| 334 | /* |
| 335 | * Variant of the interface provided by Heimdal's com_err library |
| 336 | */ |
| 337 | void |
| 338 | add_to_error_table(struct et_list *new_table) |
| 339 | { |
| 340 | add_error_table(new_table->table); |
| 341 | } |