util.c

   1 /* $Log: util.c,v $
   2  * Revision 1.2  1996/04/14 16:34:36  sde1000
   3  * Added syslog support
   4  * mpbin/mpstring functions moved from dh.c
   5  *
   6  * Revision 1.1  1996/03/14 17:05:03  sde1000
   7  * Initial revision
   8  *
   9  */
  10
  11 #include "secnet.h"
  12 #include <stdio.h>
  13 #include <string.h>
  14 #include <errno.h>
  15 #include <unistd.h>
  16 #include <limits.h>
  17 #include <assert.h>
  18 #include <sys/wait.h>
  19 #include "util.h"
  20 #include "unaligned.h"
  21
  22 #define MIN_BUFFER_SIZE 64
  23 #define DEFAULT_BUFFER_SIZE 4096
  24 #define MAX_BUFFER_SIZE 131072
  25
  26 static char *hexdigits="0123456789abcdef";
  27
  28 uint32_t message_level=M_WARNING|M_ERROR|M_FATAL;
  29 uint32_t syslog_level=M_WARNING|M_ERROR|M_FATAL;
  30 static uint32_t current_phase=0;
  31
  32 struct phase_hook {
  33     hook_fn *fn;
  34     void *state;
  35     struct phase_hook *next;
  36 };
  37
  38 static struct phase_hook *hooks[NR_PHASES]={NULL,};
  39
  40 static void vMessage(uint32_t class, char *message, va_list args)
  41 {
  42     FILE *dest=stdout;
  43     if (class & message_level) {
  44         if (class&M_FATAL || class&M_ERROR || class&M_WARNING) {
  45             dest=stderr;
  46         }
  47         vfprintf(dest,message,args);
  48     }
  49 /* XXX do something about syslog output here */
  50 #if 0
  51     /* Maybe send message to syslog */
  52     vsprintf(buff, message, args);
  53     /* XXX Send each line as a separate log entry */
  54     log(syslog_prio[level], buff);
  55 #endif /* 0 */
  56 }
  57
  58 void Message(uint32_t class, char *message, ...)
  59 {
  60     va_list ap;
  61
  62     va_start(ap,message);
  63
  64     vMessage(class,message,ap);
  65
  66     va_end(ap);
  67 }
  68
  69 static void vfatal(int status, bool_t perror, char *message, va_list args)
  70 {
  71     int err;
  72
  73     err=errno;
  74
  75     enter_phase(PHASE_SHUTDOWN);
  76     if (perror) {
  77         Message(M_FATAL, "secnet fatal error: ");
  78         vMessage(M_FATAL, message, args);
  79         Message(M_FATAL, ": %s\n",strerror(err));
  80     }
  81     else {
  82         Message(M_FATAL, "secnet fatal error: ");
  83         vMessage(M_FATAL,message,args);
  84     }
  85     exit(status);
  86 }
  87
  88 void fatal(char *message, ...)
  89 {
  90     va_list args;
  91     va_start(args,message);
  92     vfatal(current_phase,False,message,args);
  93     va_end(args);
  94 }
  95
  96 void fatal_status(int status, char *message, ...)
  97 {
  98     va_list args;
  99     va_start(args,message);
 100     vfatal(status,False,message,args);
 101     va_end(args);
 102 }
 103
 104 void fatal_perror(char *message, ...)
 105 {
 106     va_list args;
 107     va_start(args,message);
 108     vfatal(current_phase,True,message,args);
 109     va_end(args);
 110 }
 111
 112 void fatal_perror_status(int status, char *message, ...)
 113 {
 114     va_list args;
 115     va_start(args,message);
 116     vfatal(status,True,message,args);
 117     va_end(args);
 118 }
 119
 120 void cfgfatal(struct cloc loc, string_t facility, char *message, ...)
 121 {
 122     va_list args;
 123
 124     va_start(args,message);
 125
 126     enter_phase(PHASE_SHUTDOWN);
 127
 128     if (loc.file && loc.line) {
 129         Message(M_FATAL, "config error (%s, %s:%d): ",facility,loc.file,
 130                 loc.line);
 131     } else if (!loc.file && loc.line) {
 132         Message(M_FATAL, "config error (%s, line %d): ",facility,loc.line);
 133     } else {
 134         Message(M_FATAL, "config error (%s): ",facility);
 135     }
 136
 137     vMessage(M_FATAL,message,args);
 138     va_end(args);
 139     exit(current_phase);
 140 }
 141
 142 char *safe_strdup(char *s, char *message)
 143 {
 144     char *d;
 145     d=strdup(s);
 146     if (!d) {
 147         fatal_perror(message);
 148     }
 149     return d;
 150 }
 151
 152 void *safe_malloc(size_t size, char *message)
 153 {
 154     void *r;
 155     r=malloc(size);
 156     if (!r) {
 157         fatal_perror(message);
 158     }
 159     return r;
 160 }
 161
 162 /* Convert a buffer into its MP_INT representation */
 163 void read_mpbin(MP_INT *a, uint8_t *bin, int binsize)
 164 {
 165     char *buff;
 166     int i;
 167
 168     buff=safe_malloc(binsize*2 + 1,"read_mpbin");
 169
 170     for (i=0; i<binsize; i++) {
 171         buff[i*2]=hexdigits[(bin[i] & 0xf0) >> 4];
 172         buff[i*2+1]=hexdigits[(bin[i] & 0xf)];
 173     }
 174     buff[binsize*2]=0;
 175
 176     mpz_set_str(a, buff, 16);
 177     free(buff);
 178 }
 179
 180 /* Convert a MP_INT into a hex string */
 181 char *write_mpstring(MP_INT *a)
 182 {
 183     char *buff;
 184
 185     buff=safe_malloc(mpz_sizeinbase(a,16)+2,"write_mpstring");
 186     mpz_get_str(buff, 16, a);
 187     return buff;
 188 }
 189
 190 static uint8_t hexval(uint8_t c)
 191 {
 192     switch (c) {
 193     case '0': return 0;
 194     case '1': return 1;
 195     case '2': return 2;
 196     case '3': return 3;
 197     case '4': return 4;
 198     case '5': return 5;
 199     case '6': return 6;
 200     case '7': return 7;
 201     case '8': return 8;
 202     case '9': return 9;
 203     case 'a': return 10;
 204     case 'A': return 10;
 205     case 'b': return 11;
 206     case 'B': return 11;
 207     case 'c': return 12;
 208     case 'C': return 12;
 209     case 'd': return 13;
 210     case 'D': return 13;
 211     case 'e': return 14;
 212     case 'E': return 14;
 213     case 'f': return 15;
 214     case 'F': return 15;
 215     }
 216     return -1;
 217 }
 218
 219 /* Convert a MP_INT into a buffer; return length; truncate if necessary */
 220 uint32_t write_mpbin(MP_INT *a, uint8_t *buffer, uint32_t buflen)
 221 {
 222     char *hb;
 223     int i,j,l;
 224
 225     if (buflen==0) return 0;
 226     hb=write_mpstring(a);
 227
 228     l=strlen(hb);
 229     i=0; j=0;
 230     if (l&1) {
 231         /* The number starts with a half-byte */
 232         buffer[i++]=hexval(hb[j++]);
 233     }
 234     for (; hb[j] && i<buflen; i++) {
 235         buffer[i]=(hexval(hb[j])<<4)|hexval(hb[j+1]);
 236         j+=2;
 237     }
 238     free(hb);
 239     return i;
 240 }
 241
 242 bool_t subnet_match(struct subnet_list *list, uint32_t address)
 243 {
 244     uint32_t i;
 245     for (i=0; i<list->entries; i++) {
 246         if (list->list[i].prefix == (address&list->list[i].mask)) return True;
 247     }
 248     return False;
 249 }
 250
 251 bool_t subnets_intersect(struct subnet a, struct subnet b)
 252 {
 253     uint32_t mask=a.mask&b.mask;
 254     return ((a.prefix&mask)==(b.prefix&mask));
 255 }
 256
 257 bool_t subnet_intersects_with_list(struct subnet a, struct subnet_list *b)
 258 {
 259     uint32_t i;
 260
 261     for (i=0; i<b->entries; i++) {
 262         if (subnets_intersect(a,b->list[i])) return True;
 263     }
 264     return False;
 265 }
 266
 267 bool_t subnet_lists_intersect(struct subnet_list *a, struct subnet_list *b)
 268 {
 269     uint32_t i;
 270     for (i=0; i<a->entries; i++) {
 271         if (subnet_intersects_with_list(a->list[i],b)) return True;
 272     }
 273     return False;
 274 }
 275
 276 /* The string buffer must be at least 16 bytes long */
 277 string_t ipaddr_to_string(uint32_t addr)
 278 {
 279     uint8_t a,b,c,d;
 280     string_t s;
 281
 282     s=safe_malloc(16,"ipaddr_to_string");
 283     a=addr>>24;
 284     b=addr>>16;
 285     c=addr>>8;
 286     d=addr;
 287     snprintf(s, 16, "%d.%d.%d.%d", a, b, c, d);
 288     return s;
 289 }
 290
 291 string_t subnet_to_string(struct subnet *sn)
 292 {
 293     uint32_t mask=sn->mask, addr=sn->prefix;
 294     uint8_t a,b,c,d;
 295     string_t s;
 296     int i;
 297
 298     s=safe_malloc(19,"subnet_to_string");
 299     a=addr>>24;
 300     b=addr>>16;
 301     c=addr>>8;
 302     d=addr;
 303     for (i=0; mask; i++) {
 304         mask=(mask<<1);
 305     }
 306     snprintf(s, 19, "%d.%d.%d.%d/%d", a, b, c, d, i);
 307     return s;
 308 }
 309
 310 int sys_cmd(const char *path, char *arg, ...)
 311 {
 312     va_list ap;
 313     int rv;
 314     pid_t c;
 315
 316     va_start(ap,arg);
 317     c=fork();
 318     if (c) {
 319         /* Parent -> wait for child */
 320         waitpid(c,&rv,0);
 321     } else if (c==0) {
 322         char *args[100];
 323         int i;
 324         /* Child -> exec command */
 325         args[0]=arg;
 326         i=1;
 327         while ((args[i++]=va_arg(ap,char *)));
 328         execvp(path,args);
 329         exit(1);
 330     } else {
 331         /* Error */
 332         fatal_perror("sys_cmd(%s,%s,...)");
 333     }
 334
 335     va_end(ap);
 336     return rv;
 337 }
 338
 339 /* Take a list of log closures and merge them */
 340 struct loglist {
 341     struct log_if *l;
 342     struct loglist *next;
 343 };
 344
 345 static void log_vmulti(void *state, int priority, char *message, va_list args)
 346 {
 347     struct loglist *st=state, *i;
 348
 349     for (i=st; i; i=i->next) {
 350         i->l->vlog(i->l->st,priority,message,args);
 351     }
 352 }
 353
 354 static void log_multi(void *st, int priority, char *message, ...)
 355 {
 356     va_list ap;
 357
 358     va_start(ap,message);
 359
 360     log_vmulti(st,priority,message,ap);
 361
 362     va_end(ap);
 363 }
 364
 365 struct log_if *init_log(list_t *ll)
 366 {
 367     int i=0;
 368     item_t *item;
 369     closure_t *cl;
 370     struct loglist *l=NULL, *n;
 371     struct log_if *r;
 372
 373     while ((item=list_elem(ll,i++))) {
 374         if (item->type!=t_closure) {
 375             cfgfatal(item->loc,"init_log","item is not a closure");
 376         }
 377         cl=item->data.closure;
 378         if (cl->type!=CL_LOG) {
 379             cfgfatal(item->loc,"init_log","closure is not a logger");
 380         }
 381         n=safe_malloc(sizeof(*n),"init_log");
 382         n->l=cl->interface;
 383         n->next=l;
 384         l=n;
 385     }
 386     if (!l) {
 387         fatal("init_log: none of the items in the list are loggers");
 388     }
 389     r=safe_malloc(sizeof(*r), "init_log");
 390     r->st=l;
 391     r->log=log_multi;
 392     r->vlog=log_vmulti;
 393     return r;
 394 }
 395
 396 struct logfile {
 397     closure_t cl;
 398     struct log_if ops;
 399     FILE *f;
 400 };
 401
 402 static void logfile_vlog(void *state, int priority, char *message,
 403                          va_list args)
 404 {
 405     struct logfile *st=state;
 406
 407     vfprintf(st->f,message,args);
 408     fprintf(st->f,"\n");
 409 }
 410
 411 static void logfile_log(void *state, int priority, char *message, ...)
 412 {
 413     va_list ap;
 414
 415     va_start(ap,message);
 416     logfile_vlog(state,priority,message,ap);
 417     va_end(ap);
 418 }
 419
 420 static list_t *logfile_apply(closure_t *self, struct cloc loc, dict_t *context,
 421                              list_t *data)
 422 {
 423     struct logfile *st;
 424
 425     st=safe_malloc(sizeof(*st),"logfile_apply");
 426     st->cl.description="logfile";
 427     st->cl.type=CL_LOG;
 428     st->cl.apply=NULL;
 429     st->cl.interface=&st->ops;
 430     st->ops.st=st;
 431     st->ops.log=logfile_log;
 432     st->ops.vlog=logfile_vlog;
 433     st->f=stderr; /* XXX ignore args */
 434
 435     return new_closure(&st->cl);
 436 }
 437
 438 static char *phases[NR_PHASES]={
 439     "PHASE_INIT",
 440     "PHASE_GETOPTS",
 441     "PHASE_READCONFIG",
 442     "PHASE_SETUP",
 443     "PHASE_GETRESOURCES",
 444     "PHASE_DROPPRIV",
 445     "PHASE_RUN",
 446     "PHASE_SHUTDOWN"
 447 };
 448
 449 void enter_phase(uint32_t new_phase)
 450 {
 451     struct phase_hook *i;
 452
 453     if (hooks[new_phase])
 454         Message(M_DEBUG_PHASE,"Running hooks for %s...\n", phases[new_phase]);
 455     current_phase=new_phase;
 456
 457     for (i=hooks[new_phase]; i; i=i->next)
 458         i->fn(i->state, new_phase);
 459     Message(M_DEBUG_PHASE,"Now in %s\n",phases[new_phase]);
 460 }
 461
 462 bool_t add_hook(uint32_t phase, hook_fn *fn, void *state)
 463 {
 464     struct phase_hook *h;
 465
 466     h=safe_malloc(sizeof(*h),"add_hook");
 467     h->fn=fn;
 468     h->state=state;
 469     h->next=hooks[phase];
 470     hooks[phase]=h;
 471     return True;
 472 }
 473
 474 bool_t remove_hook(uint32_t phase, hook_fn *fn, void *state)
 475 {
 476     fatal("remove_hook: not implemented\n");
 477
 478     return False;
 479 }
 480
 481 void log(struct log_if *lf, int priority, char *message, ...)
 482 {
 483     va_list ap;
 484
 485     va_start(ap,message);
 486     lf->vlog(lf->st,priority,message,ap);
 487     va_end(ap);
 488 }
 489
 490 struct buffer {
 491     closure_t cl;
 492     struct buffer_if ops;
 493 };
 494
 495 void buffer_assert_free(struct buffer_if *buffer, string_t file, uint32_t line)
 496 {
 497     if (!buffer->free) {
 498         fatal("BUF_ASSERT_FREE, %s line %d, owned by %s\n",
 499               file,line,buffer->owner);
 500     }
 501 }
 502
 503 void buffer_assert_used(struct buffer_if *buffer, string_t file, uint32_t line)
 504 {
 505     if (buffer->free) {
 506         fatal("BUF_ASSERT_USED, %s line %d, last owned by %s\n",
 507               file,line,buffer->owner);
 508     }
 509 }
 510
 511 void buffer_init(struct buffer_if *buffer, uint32_t max_start_pad)
 512 {
 513     buffer->start=buffer->base+max_start_pad;
 514     buffer->size=0;
 515 }
 516
 517 void *buf_append(struct buffer_if *buf, uint32_t amount) {
 518     void *p;
 519     p=buf->start + buf->size;
 520     buf->size+=amount;
 521     return p;
 522 }
 523
 524 void *buf_prepend(struct buffer_if *buf, uint32_t amount) {
 525     buf->size+=amount;
 526     return buf->start-=amount;
 527 }
 528
 529 void *buf_unappend(struct buffer_if *buf, uint32_t amount) {
 530     if (buf->size < amount) return 0;
 531     return buf->start+(buf->size-=amount);
 532 }
 533
 534 void *buf_unprepend(struct buffer_if *buf, uint32_t amount) {
 535     void *p;
 536     p=buf->start;
 537     buf->start+=amount;
 538     buf->size-=amount;
 539     return p;
 540 }
 541
 542 /* Append a two-byte length and the string to the buffer. Length is in
 543    network byte order. */
 544 void buf_append_string(struct buffer_if *buf, string_t s)
 545 {
 546     uint16_t len;
 547
 548     len=strlen(s);
 549     buf_append_uint16(buf,len);
 550     memcpy(buf_append(buf,len),s,len);
 551 }
 552
 553 void buffer_new(struct buffer_if *buf, uint32_t len)
 554 {
 555     buf->free=True;
 556     buf->owner=NULL;
 557     buf->flags=0;
 558     buf->loc.file=NULL;
 559     buf->loc.line=0;
 560     buf->size=0;
 561     buf->len=len;
 562     buf->start=NULL;
 563     buf->base=safe_malloc(len,"buffer_new");
 564 }
 565
 566 static list_t *buffer_apply(closure_t *self, struct cloc loc, dict_t *context,
 567                             list_t *args)
 568 {
 569     struct buffer *st;
 570     item_t *item;
 571     dict_t *dict;
 572     bool_t lockdown=False;
 573     uint32_t len=DEFAULT_BUFFER_SIZE;
 574
 575     st=safe_malloc(sizeof(*st),"buffer_apply");
 576     st->cl.description="buffer";
 577     st->cl.type=CL_BUFFER;
 578     st->cl.apply=NULL;
 579     st->cl.interface=&st->ops;
 580
 581     /* First argument, if present, is buffer length */
 582     item=list_elem(args,0);
 583     if (item) {
 584         if (item->type!=t_number) {
 585             cfgfatal(st->ops.loc,"buffer","first parameter must be a "
 586                      "number (buffer size)\n");
 587         }
 588         len=item->data.number;
 589         if (len<MIN_BUFFER_SIZE) {
 590             cfgfatal(st->ops.loc,"buffer","ludicrously small buffer size\n");
 591         }
 592         if (len>MAX_BUFFER_SIZE) {
 593             cfgfatal(st->ops.loc,"buffer","ludicrously large buffer size\n");
 594         }
 595     }
 596     /* Second argument, if present, is a dictionary */
 597     item=list_elem(args,1);
 598     if (item) {
 599         if (item->type!=t_dict) {
 600             cfgfatal(st->ops.loc,"buffer","second parameter must be a "
 601                      "dictionary\n");
 602         }
 603         dict=item->data.dict;
 604         lockdown=dict_read_bool(dict,"lockdown",False,"buffer",st->ops.loc,
 605                                 False);
 606     }
 607
 608     buffer_new(&st->ops,len);
 609     if (lockdown) {
 610         Message(M_WARNING,"buffer: XXX lockdown\n");
 611     }
 612
 613     return new_closure(&st->cl);
 614 }
 615
 616 init_module util_module;
 617 void util_module(dict_t *dict)
 618 {
 619     add_closure(dict,"logfile",logfile_apply);
 620     add_closure(dict,"sysbuffer",buffer_apply);
 621 }