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