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     if (!size)
  75         return 0;
  76     r=malloc(size);
  77     if (!r) {
  78         fatal_perror("%s",message);
  79     }
  80     return r;
  81 }
  82 void *safe_realloc_ary(void *p, size_t size, size_t count,
  83                        const char *message) {
  84     if (count >= INT_MAX/size) {
  85         fatal("array allocation overflow: %s", message);
  86     }
  87     assert(size && count);
  88     p = realloc(p, size*count);
  89     if (!p)
  90         fatal_perror("%s", message);
  91     return p;
  92 }
  93
  94 void *safe_malloc_ary(size_t size, size_t count, const char *message) {
  95     if (!size || !count)
  96         return 0;
  97     return safe_realloc_ary(0,size,count,message);
  98 }
  99
 100 /* Convert a buffer into its MP_INT representation */
 101 void read_mpbin(MP_INT *a, uint8_t *bin, int binsize)
 102 {
 103     char *buff;
 104     int i;
 105
 106     buff=safe_malloc(binsize*2 + 1,"read_mpbin");
 107
 108     for (i=0; i<binsize; i++) {
 109         buff[i*2]=hexdigits[(bin[i] & 0xf0) >> 4];
 110         buff[i*2+1]=hexdigits[(bin[i] & 0xf)];
 111     }
 112     buff[binsize*2]=0;
 113
 114     mpz_set_str(a, buff, 16);
 115     free(buff);
 116 }
 117
 118 /* Convert a MP_INT into a hex string */
 119 char *write_mpstring(MP_INT *a)
 120 {
 121     char *buff;
 122
 123     buff=safe_malloc(mpz_sizeinbase(a,16)+2,"write_mpstring");
 124     mpz_get_str(buff, 16, a);
 125     return buff;
 126 }
 127
 128 static uint8_t hexval(uint8_t c)
 129 {
 130     switch (c) {
 131     case '0': return 0;
 132     case '1': return 1;
 133     case '2': return 2;
 134     case '3': return 3;
 135     case '4': return 4;
 136     case '5': return 5;
 137     case '6': return 6;
 138     case '7': return 7;
 139     case '8': return 8;
 140     case '9': return 9;
 141     case 'a': return 10;
 142     case 'A': return 10;
 143     case 'b': return 11;
 144     case 'B': return 11;
 145     case 'c': return 12;
 146     case 'C': return 12;
 147     case 'd': return 13;
 148     case 'D': return 13;
 149     case 'e': return 14;
 150     case 'E': return 14;
 151     case 'f': return 15;
 152     case 'F': return 15;
 153     }
 154     return -1;
 155 }
 156
 157 /* Convert a MP_INT into a buffer; return length; truncate if necessary */
 158 int32_t write_mpbin(MP_INT *a, uint8_t *buffer, int32_t buflen)
 159 {
 160     char *hb;
 161     int i,j,l;
 162
 163     if (buflen==0) return 0;
 164     hb=write_mpstring(a);
 165
 166     l=strlen(hb);
 167     i=0; j=0;
 168     if (l&1) {
 169         /* The number starts with a half-byte */
 170         buffer[i++]=hexval(hb[j++]);
 171     }
 172     for (; hb[j] && i<buflen; i++) {
 173         buffer[i]=(hexval(hb[j])<<4)|hexval(hb[j+1]);
 174         j+=2;
 175     }
 176     free(hb);
 177     return i;
 178 }
 179
 180 #define DEFINE_SETFDFLAG(fn,FL,FLAG)                                    \
 181 void fn(int fd) {                                                       \
 182     int r=fcntl(fd, F_GET##FL);                                         \
 183     if (r<0) fatal_perror("fcntl(,F_GET" #FL ") failed");               \
 184     r=fcntl(fd, F_SET##FL, r|FLAG);                                     \
 185     if (r<0) fatal_perror("fcntl(,F_SET" #FL ",|" #FLAG ") failed");    \
 186 }
 187
 188 DEFINE_SETFDFLAG(setcloexec,FD,FD_CLOEXEC);
 189 DEFINE_SETFDFLAG(setnonblock,FL,O_NONBLOCK);
 190
 191 void pipe_cloexec(int fd[2]) {
 192     int r=pipe(fd);
 193     if (r) fatal_perror("pipe");
 194     setcloexec(fd[0]);
 195     setcloexec(fd[1]);
 196 }
 197
 198 static const char *phases[NR_PHASES]={
 199     "PHASE_INIT",
 200     "PHASE_GETOPTS",
 201     "PHASE_READCONFIG",
 202     "PHASE_SETUP",
 203     "PHASE_DAEMONIZE",
 204     "PHASE_GETRESOURCES",
 205     "PHASE_DROPPRIV",
 206     "PHASE_RUN",
 207     "PHASE_SHUTDOWN"
 208 };
 209
 210 void enter_phase(uint32_t new_phase)
 211 {
 212     struct phase_hook *i;
 213
 214     if (hooks[new_phase])
 215         Message(M_DEBUG_PHASE,"Running hooks for %s...\n", phases[new_phase]);
 216     current_phase=new_phase;
 217
 218     for (i=hooks[new_phase]; i; i=i->next)
 219         i->fn(i->state, new_phase);
 220     Message(M_DEBUG_PHASE,"Now in %s\n",phases[new_phase]);
 221 }
 222
 223 bool_t add_hook(uint32_t phase, hook_fn *fn, void *state)
 224 {
 225     struct phase_hook *h;
 226
 227     h=safe_malloc(sizeof(*h),"add_hook");
 228     h->fn=fn;
 229     h->state=state;
 230     h->next=hooks[phase];
 231     hooks[phase]=h;
 232     return True;
 233 }
 234
 235 bool_t remove_hook(uint32_t phase, hook_fn *fn, void *state)
 236 {
 237     fatal("remove_hook: not implemented");
 238
 239     return False;
 240 }
 241
 242 void vslilog(struct log_if *lf, int priority, const char *message, va_list ap)
 243 {
 244     lf->vlogfn(lf->st,priority,message,ap);
 245 }
 246
 247 void slilog(struct log_if *lf, int priority, const char *message, ...)
 248 {
 249     va_list ap;
 250
 251     va_start(ap,message);
 252     vslilog(lf,priority,message,ap);
 253     va_end(ap);
 254 }
 255
 256 struct buffer {
 257     closure_t cl;
 258     struct buffer_if ops;
 259 };
 260
 261 void buffer_assert_free(struct buffer_if *buffer, cstring_t file,
 262                         int line)
 263 {
 264     if (!buffer->free) {
 265         fprintf(stderr,"secnet: BUF_ASSERT_FREE, %s line %d, owned by %s",
 266                 file,line,buffer->owner);
 267         assert(!"buffer_assert_free failure");
 268     }
 269 }
 270
 271 void buffer_assert_used(struct buffer_if *buffer, cstring_t file,
 272                         int line)
 273 {
 274     if (buffer->free) {
 275         fprintf(stderr,"secnet: BUF_ASSERT_USED, %s line %d, last owned by %s",
 276                 file,line,buffer->owner);
 277         assert(!"buffer_assert_used failure");
 278     }
 279 }
 280
 281 void buffer_init(struct buffer_if *buffer, int32_t max_start_pad)
 282 {
 283     assert(max_start_pad<=buffer->alloclen);
 284     buffer->start=buffer->base+max_start_pad;
 285     buffer->size=0;
 286 }
 287
 288 void *buf_append(struct buffer_if *buf, int32_t amount) {
 289     void *p;
 290     assert(amount <= buf_remaining_space(buf));
 291     p=buf->start + buf->size;
 292     buf->size+=amount;
 293     return p;
 294 }
 295
 296 void *buf_prepend(struct buffer_if *buf, int32_t amount) {
 297     assert(amount <= buf->start - buf->base);
 298     buf->size+=amount;
 299     return buf->start-=amount;
 300 }
 301
 302 void *buf_unappend(struct buffer_if *buf, int32_t amount) {
 303     if (buf->size < amount) return 0;
 304     return buf->start+(buf->size-=amount);
 305 }
 306
 307 void *buf_unprepend(struct buffer_if *buf, int32_t amount) {
 308     void *p;
 309     if (buf->size < amount) return 0;
 310     p=buf->start;
 311     buf->start+=amount;
 312     buf->size-=amount;
 313     return p;
 314 }
 315
 316 /* Append a two-byte length and the string to the buffer. Length is in
 317    network byte order. */
 318 void buf_append_string(struct buffer_if *buf, cstring_t s)
 319 {
 320     size_t len;
 321
 322     len=strlen(s);
 323     /* fixme: if string is longer than 65535, result is a corrupted packet */
 324     buf_append_uint16(buf,len);
 325     BUF_ADD_BYTES(append,buf,s,len);
 326 }
 327
 328 void buffer_new(struct buffer_if *buf, int32_t len)
 329 {
 330     buf->free=True;
 331     buf->owner=NULL;
 332     buf->flags=0;
 333     buf->loc.file=NULL;
 334     buf->loc.line=0;
 335     buf->size=0;
 336     buf->alloclen=len;
 337     buf->start=NULL;
 338     buf->base=safe_malloc(len,"buffer_new");
 339 }
 340
 341 void buffer_readonly_view(struct buffer_if *buf, const void *data, int32_t len)
 342 {
 343     buf->free=False;
 344     buf->owner="READONLY";
 345     buf->flags=0;
 346     buf->loc.file=NULL;
 347     buf->loc.line=0;
 348     buf->size=buf->alloclen=len;
 349     buf->base=buf->start=(uint8_t*)data;
 350 }
 351
 352 void buffer_readonly_clone(struct buffer_if *out, const struct buffer_if *in)
 353 {
 354     buffer_readonly_view(out,in->start,in->size);
 355 }
 356
 357 void buffer_copy(struct buffer_if *dst, const struct buffer_if *src)
 358 {
 359     if (dst->alloclen < src->alloclen) {
 360         dst->base=realloc(dst->base,src->alloclen);
 361         if (!dst->base) fatal_perror("buffer_copy");
 362         dst->alloclen = src->alloclen;
 363     }
 364     dst->start = dst->base + (src->start - src->base);
 365     dst->size = src->size;
 366     memcpy(dst->start, src->start, dst->size);
 367 }
 368
 369 static list_t *buffer_apply(closure_t *self, struct cloc loc, dict_t *context,
 370                             list_t *args)
 371 {
 372     struct buffer *st;
 373     item_t *item;
 374     dict_t *dict;
 375     bool_t lockdown=False;
 376     uint32_t len=DEFAULT_BUFFER_SIZE;
 377
 378     st=safe_malloc(sizeof(*st),"buffer_apply");
 379     st->cl.description="buffer";
 380     st->cl.type=CL_BUFFER;
 381     st->cl.apply=NULL;
 382     st->cl.interface=&st->ops;
 383
 384     /* First argument, if present, is buffer length */
 385     item=list_elem(args,0);
 386     if (item) {
 387         if (item->type!=t_number) {
 388             cfgfatal(st->ops.loc,"buffer","first parameter must be a "
 389                      "number (buffer size)\n");
 390         }
 391         len=item->data.number;
 392         if (len<MIN_BUFFER_SIZE) {
 393             cfgfatal(st->ops.loc,"buffer","ludicrously small buffer size\n");
 394         }
 395         if (len>MAX_BUFFER_SIZE) {
 396             cfgfatal(st->ops.loc,"buffer","ludicrously large buffer size\n");
 397         }
 398     }
 399     /* Second argument, if present, is a dictionary */
 400     item=list_elem(args,1);
 401     if (item) {
 402         if (item->type!=t_dict) {
 403             cfgfatal(st->ops.loc,"buffer","second parameter must be a "
 404                      "dictionary\n");
 405         }
 406         dict=item->data.dict;
 407         lockdown=dict_read_bool(dict,"lockdown",False,"buffer",st->ops.loc,
 408                                 False);
 409     }
 410
 411     buffer_new(&st->ops,len);
 412     if (lockdown) {
 413         /* XXX mlock the buffer if possible */
 414     }
 415
 416     return new_closure(&st->cl);
 417 }
 418
 419 void send_nak(const struct comm_addr *dest, uint32_t our_index,
 420               uint32_t their_index, uint32_t msgtype,
 421               struct buffer_if *buf, const char *logwhy)
 422 {
 423     buffer_init(buf,calculate_max_start_pad());
 424     buf_append_uint32(buf,their_index);
 425     buf_append_uint32(buf,our_index);
 426     buf_append_uint32(buf,LABEL_NAK);
 427     if (logwhy)
 428         Message(M_INFO,"%s: %08"PRIx32"<-%08"PRIx32": %08"PRIx32":"
 429                 " %s; sending NAK\n",
 430                 comm_addr_to_string(dest),
 431                 our_index, their_index, msgtype, logwhy);
 432     dest->comm->sendmsg(dest->comm->st, buf, dest);
 433 }
 434
 435 int consttime_memeq(const void *s1in, const void *s2in, size_t n)
 436 {
 437     const uint8_t *s1=s1in, *s2=s2in;
 438     register volatile uint8_t accumulator=0;
 439
 440     while (n-- > 0) {
 441         accumulator |= (*s1++ ^ *s2++);
 442     }
 443     accumulator |= accumulator >> 4; /* constant-time             */
 444     accumulator |= accumulator >> 2; /*  boolean canonicalisation */
 445     accumulator |= accumulator >> 1;
 446     accumulator &= 1;
 447     accumulator ^= 1;
 448     return accumulator;
 449 }
 450
 451 void util_module(dict_t *dict)
 452 {
 453     add_closure(dict,"sysbuffer",buffer_apply);
 454 }
 455
 456 void update_max_start_pad(int32_t *our_module_global, int32_t our_instance)
 457 {
 458     if (*our_module_global < our_instance)
 459         *our_module_global=our_instance;
 460 }
 461
 462 int32_t transform_max_start_pad, comm_max_start_pad;
 463
 464 int32_t calculate_max_start_pad(void)
 465 {
 466     return
 467         site_max_start_pad +
 468         transform_max_start_pad +
 469         comm_max_start_pad;
 470 }
 471
 472 void vslilog_part(struct log_if *lf, int priority, const char *message, va_list ap)
 473 {
 474     char *buff=lf->buff;
 475     size_t bp;
 476     char *nlp;
 477
 478     bp=strlen(buff);
 479     assert(bp < LOG_MESSAGE_BUFLEN);
 480     vsnprintf(buff+bp,LOG_MESSAGE_BUFLEN-bp,message,ap);
 481     buff[LOG_MESSAGE_BUFLEN-1] = '\n';
 482     buff[LOG_MESSAGE_BUFLEN] = '\0';
 483     /* Each line is sent separately */
 484     while ((nlp=strchr(buff,'\n'))) {
 485         *nlp=0;
 486         slilog(lf,priority,"%s",buff);
 487         memmove(buff,nlp+1,strlen(nlp+1)+1);
 488     }
 489 }
 490
 491 extern void slilog_part(struct log_if *lf, int priority, const char *message, ...)
 492 {
 493     va_list ap;
 494     va_start(ap,message);
 495     vslilog_part(lf,priority,message,ap);
 496     va_end(ap);
 497 }
 498
 499 void string_item_to_iaddr(const item_t *item, uint16_t port, union iaddr *ia,
 500                           const char *desc)
 501 {
 502 #ifndef CONFIG_IPV6
 503
 504     ia->sin.sin_family=AF_INET;
 505     ia->sin.sin_addr.s_addr=string_item_to_ipaddr(item,desc);
 506
 507 #else /* CONFIG_IPV6 => we have adns_text2addr */
 508
 509     if (item->type!=t_string)
 510         cfgfatal(item->loc,desc,"expecting a string IP (v4 or v6) address\n");
 511     socklen_t salen=sizeof(*ia);
 512     int r=adns_text2addr(item->data.string, port,
 513                          adns_qf_addrlit_ipv4_quadonly,
 514                          &ia->sa, &salen);
 515     assert(r!=ENOSPC);
 516     if (r) cfgfatal(item->loc,desc,"invalid IP (v4 or v6) address: %s\n",
 517                     strerror(r));
 518
 519 #endif /* CONFIG_IPV6 */
 520 }
 521
 522 #define IADDR_NBUFS_SHIFT 3
 523 #define IADDR_NBUFS (1 << IADDR_NBUFS_SHIFT)
 524
 525 const char *iaddr_to_string(const union iaddr *ia)
 526 {
 527     static int b;
 528
 529     b++;
 530     b &= IADDR_NBUFS-1;
 531
 532 #ifndef CONFIG_IPV6
 533
 534     static char bufs[IADDR_NBUFS][100];
 535
 536     assert(ia->sa.sa_family == AF_INET);
 537
 538     snprintf(bufs[b], sizeof(bufs[b]), "[%s]:%d",
 539              inet_ntoa(ia->sin.sin_addr),
 540              ntohs(ia->sin.sin_port));
 541
 542 #else /* CONFIG_IPV6 => we have adns_addr2text */
 543
 544     static char bufs[IADDR_NBUFS][1+ADNS_ADDR2TEXT_BUFLEN+20];
 545
 546     int port;
 547
 548     char *addrbuf = bufs[b];
 549     *addrbuf++ = '[';
 550     int addrbuflen = ADNS_ADDR2TEXT_BUFLEN;
 551
 552     int r = adns_addr2text(&ia->sa, 0, addrbuf, &addrbuflen, &port);
 553     if (r) {
 554         const char fmt[]= "scoped IPv6 addr, error: %.*s";
 555         sprintf(addrbuf, fmt,
 556                 ADNS_ADDR2TEXT_BUFLEN - sizeof(fmt) /* underestimate */,
 557                 strerror(r));
 558     }
 559
 560     char *portbuf = addrbuf;
 561     int addrl = strlen(addrbuf);
 562     portbuf += addrl;
 563
 564     snprintf(portbuf, sizeof(bufs[b])-addrl, "]:%d", port);
 565
 566 #endif /* CONFIG_IPV6 */
 567
 568     return bufs[b];
 569 }
 570
 571 bool_t iaddr_equal(const union iaddr *ia, const union iaddr *ib)
 572 {
 573     if (ia->sa.sa_family != ib->sa.sa_family)
 574         return 0;
 575     switch (ia->sa.sa_family) {
 576     case AF_INET:
 577         return ia->sin.sin_addr.s_addr == ib->sin.sin_addr.s_addr
 578             && ia->sin.sin_port        == ib->sin.sin_port;
 579 #ifdef CONFIG_IPV6
 580     case AF_INET6:
 581         return !memcmp(&ia->sin6.sin6_addr, &ib->sin6.sin6_addr, 16)
 582             && ia->sin6.sin6_scope_id  == ib->sin6.sin6_scope_id
 583             && ia->sin6.sin6_port      == ib->sin6.sin6_port
 584             /* we ignore the flowinfo field */;
 585 #endif /* CONFIG_IPV6 */
 586     default:
 587         abort();
 588     }
 589 }
 590
 591 int iaddr_socklen(const union iaddr *ia)
 592 {
 593     switch (ia->sa.sa_family) {
 594     case AF_INET:  return sizeof(ia->sin);
 595 #ifdef CONFIG_IPV6
 596     case AF_INET6: return sizeof(ia->sin6);
 597 #endif /* CONFIG_IPV6 */
 598     default:       abort();
 599     }
 600 }