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