util.c

   1 /*
   2  * util.c
   3  * - output and logging support
   4  * - program lifetime support
   5  * - IP address and subnet munging routines
   6  * - MPI convenience functions
   7  */
   8 /*
   9  *  This file is
  10  *    Copyright (C) 1995--2001 Stephen Early <steve@greenend.org.uk>
  11  *
  12  *  It is part of secnet, which is
  13  *    Copyright (C) 1995--2001 Stephen Early <steve@greenend.org.uk>
  14  *    Copyright (C) 1998 Ross Anderson, Eli Biham, Lars Knudsen
  15  *
  16  *  This program is free software; you can redistribute it and/or modify
  17  *  it under the terms of the GNU General Public License as published by
  18  *  the Free Software Foundation; either version 2, or (at your option)
  19  *  any later version.
  20  *
  21  *  This program is distributed in the hope that it will be useful,
  22  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24  *  GNU General Public License for more details.
  25  *
  26  *  You should have received a copy of the GNU General Public License
  27  *  along with this program; if not, write to the Free Software Foundation,
  28  *  Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  29  */
  30
  31 #include "secnet.h"
  32 #include <stdio.h>
  33 #include <string.h>
  34 #include <errno.h>
  35 #include <unistd.h>
  36 #include <limits.h>
  37 #include <assert.h>
  38 #include <sys/wait.h>
  39 #include <adns.h>
  40 #include "util.h"
  41 #include "unaligned.h"
  42 #include "magic.h"
  43 #include "ipaddr.h"
  44
  45 #define MIN_BUFFER_SIZE 64
  46 #define DEFAULT_BUFFER_SIZE 4096
  47 #define MAX_BUFFER_SIZE 131072
  48
  49 static const char *hexdigits="0123456789abcdef";
  50
  51 uint32_t current_phase=0;
  52
  53 struct phase_hook {
  54     hook_fn *fn;
  55     void *state;
  56     struct phase_hook *next;
  57 };
  58
  59 static struct phase_hook *hooks[NR_PHASES]={NULL,};
  60
  61 char *safe_strdup(const char *s, const char *message)
  62 {
  63     char *d;
  64     d=strdup(s);
  65     if (!d) {
  66         fatal_perror("%s",message);
  67     }
  68     return d;
  69 }
  70
  71 void *safe_malloc(size_t size, const char *message)
  72 {
  73     void *r;
  74     r=malloc(size);
  75     if (!r) {
  76         fatal_perror("%s",message);
  77     }
  78     return r;
  79 }
  80 void *safe_realloc_ary(void *p, size_t size, size_t count,
  81                        const char *message) {
  82     if (count >= INT_MAX/size) {
  83         fatal("array allocation overflow: %s", message);
  84     }
  85     assert(size && count);
  86     p = realloc(p, size*count);
  87     if (!p)
  88         fatal_perror("%s", message);
  89     return p;
  90 }
  91
  92 void *safe_malloc_ary(size_t size, size_t count, const char *message) {
  93     if (!size && !count)
  94         return 0;
  95     return safe_realloc_ary(0,size,count,message);
  96 }
  97
  98 /* Convert a buffer into its MP_INT representation */
  99 void read_mpbin(MP_INT *a, uint8_t *bin, int binsize)
 100 {
 101     char *buff;
 102     int i;
 103
 104     buff=safe_malloc(binsize*2 + 1,"read_mpbin");
 105
 106     for (i=0; i<binsize; i++) {
 107         buff[i*2]=hexdigits[(bin[i] & 0xf0) >> 4];
 108         buff[i*2+1]=hexdigits[(bin[i] & 0xf)];
 109     }
 110     buff[binsize*2]=0;
 111
 112     mpz_set_str(a, buff, 16);
 113     free(buff);
 114 }
 115
 116 /* Convert a MP_INT into a hex string */
 117 char *write_mpstring(MP_INT *a)
 118 {
 119     char *buff;
 120
 121     buff=safe_malloc(mpz_sizeinbase(a,16)+2,"write_mpstring");
 122     mpz_get_str(buff, 16, a);
 123     return buff;
 124 }
 125
 126 static uint8_t hexval(uint8_t c)
 127 {
 128     switch (c) {
 129     case '0': return 0;
 130     case '1': return 1;
 131     case '2': return 2;
 132     case '3': return 3;
 133     case '4': return 4;
 134     case '5': return 5;
 135     case '6': return 6;
 136     case '7': return 7;
 137     case '8': return 8;
 138     case '9': return 9;
 139     case 'a': return 10;
 140     case 'A': return 10;
 141     case 'b': return 11;
 142     case 'B': return 11;
 143     case 'c': return 12;
 144     case 'C': return 12;
 145     case 'd': return 13;
 146     case 'D': return 13;
 147     case 'e': return 14;
 148     case 'E': return 14;
 149     case 'f': return 15;
 150     case 'F': return 15;
 151     }
 152     return -1;
 153 }
 154
 155 /* Convert a MP_INT into a buffer; return length; truncate if necessary */
 156 int32_t write_mpbin(MP_INT *a, uint8_t *buffer, int32_t buflen)
 157 {
 158     char *hb;
 159     int i,j,l;
 160
 161     if (buflen==0) return 0;
 162     hb=write_mpstring(a);
 163
 164     l=strlen(hb);
 165     i=0; j=0;
 166     if (l&1) {
 167         /* The number starts with a half-byte */
 168         buffer[i++]=hexval(hb[j++]);
 169     }
 170     for (; hb[j] && i<buflen; i++) {
 171         buffer[i]=(hexval(hb[j])<<4)|hexval(hb[j+1]);
 172         j+=2;
 173     }
 174     free(hb);
 175     return i;
 176 }
 177
 178 #define DEFINE_SETFDFLAG(fn,FL,FLAG)                                    \
 179 void fn(int fd) {                                                       \
 180     int r=fcntl(fd, F_GET##FL);                                         \
 181     if (r<0) fatal_perror("fcntl(,F_GET" #FL ") failed");               \
 182     r=fcntl(fd, F_SET##FL, r|FLAG);                                     \
 183     if (r<0) fatal_perror("fcntl(,F_SET" #FL ",|" #FLAG ") failed");    \
 184 }
 185
 186 DEFINE_SETFDFLAG(setcloexec,FD,FD_CLOEXEC);
 187 DEFINE_SETFDFLAG(setnonblock,FL,O_NONBLOCK);
 188
 189 void pipe_cloexec(int fd[2]) {
 190     int r=pipe(fd);
 191     if (r) fatal_perror("pipe");
 192     setcloexec(fd[0]);
 193     setcloexec(fd[1]);
 194 }
 195
 196 static const char *phases[NR_PHASES]={
 197     "PHASE_INIT",
 198     "PHASE_GETOPTS",
 199     "PHASE_READCONFIG",
 200     "PHASE_SETUP",
 201     "PHASE_DAEMONIZE",
 202     "PHASE_GETRESOURCES",
 203     "PHASE_DROPPRIV",
 204     "PHASE_RUN",
 205     "PHASE_SHUTDOWN"
 206 };
 207
 208 void enter_phase(uint32_t new_phase)
 209 {
 210     struct phase_hook *i;
 211
 212     if (hooks[new_phase])
 213         Message(M_DEBUG_PHASE,"Running hooks for %s...\n", phases[new_phase]);
 214     current_phase=new_phase;
 215
 216     for (i=hooks[new_phase]; i; i=i->next)
 217         i->fn(i->state, new_phase);
 218     Message(M_DEBUG_PHASE,"Now in %s\n",phases[new_phase]);
 219 }
 220
 221 bool_t add_hook(uint32_t phase, hook_fn *fn, void *state)
 222 {
 223     struct phase_hook *h;
 224
 225     h=safe_malloc(sizeof(*h),"add_hook");
 226     h->fn=fn;
 227     h->state=state;
 228     h->next=hooks[phase];
 229     hooks[phase]=h;
 230     return True;
 231 }
 232
 233 bool_t remove_hook(uint32_t phase, hook_fn *fn, void *state)
 234 {
 235     fatal("remove_hook: not implemented");
 236
 237     return False;
 238 }
 239
 240 void vslilog(struct log_if *lf, int priority, const char *message, va_list ap)
 241 {
 242     lf->vlogfn(lf->st,priority,message,ap);
 243 }
 244
 245 void slilog(struct log_if *lf, int priority, const char *message, ...)
 246 {
 247     va_list ap;
 248
 249     va_start(ap,message);
 250     vslilog(lf,priority,message,ap);
 251     va_end(ap);
 252 }
 253
 254 struct buffer {
 255     closure_t cl;
 256     struct buffer_if ops;
 257 };
 258
 259 void buffer_assert_free(struct buffer_if *buffer, cstring_t file,
 260                         int line)
 261 {
 262     if (!buffer->free) {
 263         fprintf(stderr,"secnet: BUF_ASSERT_FREE, %s line %d, owned by %s",
 264                 file,line,buffer->owner);
 265         assert(!"buffer_assert_free failure");
 266     }
 267 }
 268
 269 void buffer_assert_used(struct buffer_if *buffer, cstring_t file,
 270                         int line)
 271 {
 272     if (buffer->free) {
 273         fprintf(stderr,"secnet: BUF_ASSERT_USED, %s line %d, last owned by %s",
 274                 file,line,buffer->owner);
 275         assert(!"buffer_assert_used failure");
 276     }
 277 }
 278
 279 void buffer_init(struct buffer_if *buffer, int32_t max_start_pad)
 280 {
 281     assert(max_start_pad<=buffer->alloclen);
 282     buffer->start=buffer->base+max_start_pad;
 283     buffer->size=0;
 284 }
 285
 286 void *buf_append(struct buffer_if *buf, int32_t amount) {
 287     void *p;
 288     assert(amount <= buf_remaining_space(buf));
 289     p=buf->start + buf->size;
 290     buf->size+=amount;
 291     return p;
 292 }
 293
 294 void *buf_prepend(struct buffer_if *buf, int32_t amount) {
 295     assert(amount <= buf->start - buf->base);
 296     buf->size+=amount;
 297     return buf->start-=amount;
 298 }
 299
 300 void *buf_unappend(struct buffer_if *buf, int32_t amount) {
 301     if (buf->size < amount) return 0;
 302     return buf->start+(buf->size-=amount);
 303 }
 304
 305 void *buf_unprepend(struct buffer_if *buf, int32_t amount) {
 306     void *p;
 307     if (buf->size < amount) return 0;
 308     p=buf->start;
 309     buf->start+=amount;
 310     buf->size-=amount;
 311     return p;
 312 }
 313
 314 /* Append a two-byte length and the string to the buffer. Length is in
 315    network byte order. */
 316 void buf_append_string(struct buffer_if *buf, cstring_t s)
 317 {
 318     size_t len;
 319
 320     len=strlen(s);
 321     /* fixme: if string is longer than 65535, result is a corrupted packet */
 322     buf_append_uint16(buf,len);
 323     BUF_ADD_BYTES(append,buf,s,len);
 324 }
 325
 326 void buffer_new(struct buffer_if *buf, int32_t len)
 327 {
 328     buf->free=True;
 329     buf->owner=NULL;
 330     buf->flags=0;
 331     buf->loc.file=NULL;
 332     buf->loc.line=0;
 333     buf->size=0;
 334     buf->alloclen=len;
 335     buf->start=NULL;
 336     buf->base=safe_malloc(len,"buffer_new");
 337 }
 338
 339 void buffer_readonly_view(struct buffer_if *buf, const void *data, int32_t len)
 340 {
 341     buf->free=False;
 342     buf->owner="READONLY";
 343     buf->flags=0;
 344     buf->loc.file=NULL;
 345     buf->loc.line=0;
 346     buf->size=buf->alloclen=len;
 347     buf->base=buf->start=(uint8_t*)data;
 348 }
 349
 350 void buffer_readonly_clone(struct buffer_if *out, const struct buffer_if *in)
 351 {
 352     buffer_readonly_view(out,in->start,in->size);
 353 }
 354
 355 void buffer_copy(struct buffer_if *dst, const struct buffer_if *src)
 356 {
 357     if (dst->alloclen < src->alloclen) {
 358         dst->base=realloc(dst->base,src->alloclen);
 359         if (!dst->base) fatal_perror("buffer_copy");
 360         dst->alloclen = src->alloclen;
 361     }
 362     dst->start = dst->base + (src->start - src->base);
 363     dst->size = src->size;
 364     memcpy(dst->start, src->start, dst->size);
 365 }
 366
 367 static list_t *buffer_apply(closure_t *self, struct cloc loc, dict_t *context,
 368                             list_t *args)
 369 {
 370     struct buffer *st;
 371     item_t *item;
 372     dict_t *dict;
 373     bool_t lockdown=False;
 374     uint32_t len=DEFAULT_BUFFER_SIZE;
 375
 376     st=safe_malloc(sizeof(*st),"buffer_apply");
 377     st->cl.description="buffer";
 378     st->cl.type=CL_BUFFER;
 379     st->cl.apply=NULL;
 380     st->cl.interface=&st->ops;
 381
 382     /* First argument, if present, is buffer length */
 383     item=list_elem(args,0);
 384     if (item) {
 385         if (item->type!=t_number) {
 386             cfgfatal(st->ops.loc,"buffer","first parameter must be a "
 387                      "number (buffer size)\n");
 388         }
 389         len=item->data.number;
 390         if (len<MIN_BUFFER_SIZE) {
 391             cfgfatal(st->ops.loc,"buffer","ludicrously small buffer size\n");
 392         }
 393         if (len>MAX_BUFFER_SIZE) {
 394             cfgfatal(st->ops.loc,"buffer","ludicrously large buffer size\n");
 395         }
 396     }
 397     /* Second argument, if present, is a dictionary */
 398     item=list_elem(args,1);
 399     if (item) {
 400         if (item->type!=t_dict) {
 401             cfgfatal(st->ops.loc,"buffer","second parameter must be a "
 402                      "dictionary\n");
 403         }
 404         dict=item->data.dict;
 405         lockdown=dict_read_bool(dict,"lockdown",False,"buffer",st->ops.loc,
 406                                 False);
 407     }
 408
 409     buffer_new(&st->ops,len);
 410     if (lockdown) {
 411         /* XXX mlock the buffer if possible */
 412     }
 413
 414     return new_closure(&st->cl);
 415 }
 416
 417 void send_nak(const struct comm_addr *dest, uint32_t our_index,
 418               uint32_t their_index, uint32_t msgtype,
 419               struct buffer_if *buf, const char *logwhy)
 420 {
 421     buffer_init(buf,calculate_max_start_pad());
 422     buf_append_uint32(buf,their_index);
 423     buf_append_uint32(buf,our_index);
 424     buf_append_uint32(buf,LABEL_NAK);
 425     if (logwhy)
 426         Message(M_INFO,"%s: %08"PRIx32"<-%08"PRIx32": %08"PRIx32":"
 427                 " %s; sending NAK\n",
 428                 comm_addr_to_string(dest),
 429                 our_index, their_index, msgtype, logwhy);
 430     dest->comm->sendmsg(dest->comm->st, buf, dest);
 431 }
 432
 433 int consttime_memeq(const void *s1in, const void *s2in, size_t n)
 434 {
 435     const uint8_t *s1=s1in, *s2=s2in;
 436     register volatile uint8_t accumulator=0;
 437
 438     while (n-- > 0) {
 439         accumulator |= (*s1++ ^ *s2++);
 440     }
 441     accumulator |= accumulator >> 4; /* constant-time             */
 442     accumulator |= accumulator >> 2; /*  boolean canonicalisation */
 443     accumulator |= accumulator >> 1;
 444     accumulator &= 1;
 445     accumulator ^= 1;
 446     return accumulator;
 447 }
 448
 449 void util_module(dict_t *dict)
 450 {
 451     add_closure(dict,"sysbuffer",buffer_apply);
 452 }
 453
 454 void update_max_start_pad(int32_t *our_module_global, int32_t our_instance)
 455 {
 456     if (*our_module_global < our_instance)
 457         *our_module_global=our_instance;
 458 }
 459
 460 int32_t transform_max_start_pad, comm_max_start_pad;
 461
 462 int32_t calculate_max_start_pad(void)
 463 {
 464     return
 465         site_max_start_pad +
 466         transform_max_start_pad +
 467         comm_max_start_pad;
 468 }
 469
 470 void vslilog_part(struct log_if *lf, int priority, const char *message, va_list ap)
 471 {
 472     char *buff=lf->buff;
 473     size_t bp;
 474     char *nlp;
 475
 476     bp=strlen(buff);
 477     assert(bp < LOG_MESSAGE_BUFLEN);
 478     vsnprintf(buff+bp,LOG_MESSAGE_BUFLEN-bp,message,ap);
 479     buff[LOG_MESSAGE_BUFLEN-1] = '\n';
 480     buff[LOG_MESSAGE_BUFLEN] = '\0';
 481     /* Each line is sent separately */
 482     while ((nlp=strchr(buff,'\n'))) {
 483         *nlp=0;
 484         slilog(lf,priority,"%s",buff);
 485         memmove(buff,nlp+1,strlen(nlp+1)+1);
 486     }
 487 }
 488
 489 extern void slilog_part(struct log_if *lf, int priority, const char *message, ...)
 490 {
 491     va_list ap;
 492     va_start(ap,message);
 493     vslilog_part(lf,priority,message,ap);
 494     va_end(ap);
 495 }
 496
 497 void text2iaddr(const item_t *item, uint16_t port, union iaddr *ia,
 498                 const char *desc)
 499 {
 500 #ifndef CONFIG_IPV6
 501
 502     ia->sin.sin_family=AF_INET;
 503     ia->sin.sin_addr.s_addr=string_item_to_ipaddr(item,desc);
 504
 505 #else /* CONFIG_IPV6 => we have adns_text2addr */
 506
 507     if (item->type!=t_string)
 508         cfgfatal(item->loc,desc,"expecting a string IP (v4 or v6) address\n");
 509     socklen_t salen=sizeof(*ia);
 510     int r=adns_text2addr(item->data.string, port,
 511                          adns_qf_addrlit_ipv4_quadonly,
 512                          &ia->sa, &salen);
 513     assert(r!=ENOSPC);
 514     if (r) cfgfatal(item->loc,desc,"invalid IP (v4 or v6) address: %s\n",
 515                     strerror(r));
 516
 517 #endif /* CONFIG_IPV6 */
 518 }
 519
 520 #define IADDR_NBUFS_SHIFT 3
 521 #define IADDR_NBUFS (1 << IADDR_NBUFS_SHIFT)
 522
 523 const char *iaddr_to_string(const union iaddr *ia)
 524 {
 525     static int b;
 526
 527     b++;
 528     b &= IADDR_NBUFS-1;
 529
 530 #ifndef CONFIG_IPV6
 531
 532     static char bufs[IADDR_NBUFS][100];
 533
 534     assert(ia->sa.sa_family == AF_INET);
 535
 536     snprintf(bufs[b], sizeof(bufs[b]), "[%s]:%d",
 537              inet_ntoa(ia->sin.sin_addr),
 538              ntohs(ia->sin.sin_port));
 539
 540 #else /* CONFIG_IPV6 => we have adns_addr2text */
 541
 542     static char bufs[IADDR_NBUFS][1+ADNS_ADDR2TEXT_BUFLEN+20];
 543
 544     int port;
 545
 546     char *addrbuf = bufs[b];
 547     *addrbuf++ = '[';
 548     int addrbuflen = ADNS_ADDR2TEXT_BUFLEN;
 549
 550     int r = adns_addr2text(&ia->sa, 0, addrbuf, &addrbuflen, &port);
 551     if (r) {
 552         const char fmt[]= "scoped IPv6 addr, error: %.*s";
 553         sprintf(addrbuf, fmt,
 554                 ADNS_ADDR2TEXT_BUFLEN - sizeof(fmt) /* underestimate */,
 555                 strerror(r));
 556     }
 557
 558     char *portbuf = addrbuf;
 559     int addrl = strlen(addrbuf);
 560     portbuf += addrl;
 561
 562     snprintf(portbuf, sizeof(bufs[b])-addrl, "]:%d", port);
 563
 564 #endif /* CONFIG_IPV6 */
 565
 566     return bufs[b];
 567 }
 568
 569 bool_t iaddr_equal(const union iaddr *ia, const union iaddr *ib)
 570 {
 571     if (ia->sa.sa_family != ib->sa.sa_family)
 572         return 0;
 573     switch (ia->sa.sa_family) {
 574     case AF_INET:
 575         return ia->sin.sin_addr.s_addr == ib->sin.sin_addr.s_addr
 576             && ia->sin.sin_port        == ib->sin.sin_port;
 577 #ifdef CONFIG_IPV6
 578     case AF_INET6:
 579         return !memcmp(&ia->sin6.sin6_addr, &ib->sin6.sin6_addr, 16)
 580             && ia->sin6.sin6_scope_id  == ib->sin6.sin6_scope_id
 581             && ia->sin6.sin6_port      == ib->sin6.sin6_port
 582             /* we ignore the flowinfo field */;
 583 #endif /* CONFIG_IPV6 */
 584     default:
 585         abort();
 586     }
 587 }
 588
 589 int iaddr_socklen(const union iaddr *ia)
 590 {
 591     switch (ia->sa.sa_family) {
 592     case AF_INET:  return sizeof(ia->sin);
 593 #ifdef CONFIG_IPV6
 594     case AF_INET6: return sizeof(ia->sin6);
 595 #endif /* CONFIG_IPV6 */
 596     default:       abort();
 597     }
 598 }
 599
 600 enum async_linebuf_result
 601 async_linebuf_read(struct pollfd *pfd, struct buffer_if *buf,
 602                    const char **emsg_out)
 603 {
 604     int revents=pfd->revents;
 605
 606 #define BAD(m) do{ *emsg_out=(m); return async_linebuf_broken; }while(0)
 607 #define BADBIT(b) \
 608     if (!(revents & b)) ; else BAD(#b)
 609     BADBIT(POLLERR);
 610     BADBIT(POLLHUP);
 611     BADBIT(POLLNVAL);
 612 #undef BADBIT
 613
 614     if (!(revents & POLLIN))
 615         return async_linebuf_nothing;
 616
 617     /* Data structure: A line which has been returned to the user is
 618      * stored in buf at base before start.  But we retain the usual
 619      * buffer meaning of len.  So the buffer has valid but used data
 620      * from base to start, and valid but waiting data from start to
 621      * start+len. */
 622
 623     BUF_ASSERT_USED(buf);
 624
 625     /* firstly, eat any previous */
 626     if (buf->start != buf->base) {
 627         memmove(buf->base,buf->start,buf->size);
 628         buf->start=buf->base;
 629     }
 630
 631     uint8_t *searched=buf->base;
 632     uint8_t *dataend=buf->base+buf->size;
 633     for (;;) {
 634         char *newline=memchr(searched,'\n',dataend-searched);
 635         if (newline) {
 636             *newline=0;
 637             buf->start=newline+1;
 638             buf->size=dataend-buf->start;
 639             return async_linebuf_ok;
 640         }
 641         searched=dataend;
 642         ssize_t space=(buf->start+buf->alloclen)-searched;
 643         if (!space) BAD("input line too long");
 644         ssize_t r=read(pfd->fd,searched,space);
 645         if (r==0) {
 646             *searched=0;
 647             *emsg_out=buf->size?"no newline at eof":0;
 648             buf->start=searched+1;
 649             buf->size=0;
 650             return async_linebuf_eof;
 651         }
 652         if (r<0) {
 653             if (errno==EINTR)
 654                 continue;
 655             if (iswouldblock(errno))
 656                 return async_linebuf_nothing;
 657             BAD(strerror(errno));
 658         }
 659         if (memchr(searched,0,r)) BAD("nul in input data");
 660         assert(r<=space);
 661         dataend+=r;
 662         buf->size+=r;
 663     }
 664
 665 #undef BAD
 666 }