chiark / gitweb /
polypath: Reorganise to break up ifaddr handling
[secnet.git] / 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     LIST_ENTRY(phase_hook) entry;
57 };
58
59 static LIST_HEAD(, phase_hook) hooks[NR_PHASES];
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 (!LIST_EMPTY(&hooks[new_phase]))
215         Message(M_DEBUG_PHASE,"Running hooks for %s...\n", phases[new_phase]);
216     current_phase=new_phase;
217
218     LIST_FOREACH(i, &hooks[new_phase], entry)
219         i->fn(i->state, new_phase);
220     Message(M_DEBUG_PHASE,"Now in %s\n",phases[new_phase]);
221 }
222
223 void phase_hooks_init(void)
224 {
225     int i;
226     for (i=0; i<NR_PHASES; i++)
227         LIST_INIT(&hooks[i]);
228 }
229
230 void clear_phase_hooks(uint32_t phase)
231 {
232     struct phase_hook *h, *htmp;
233     LIST_FOREACH_SAFE(h, &hooks[phase], entry, htmp)
234         free(h);
235     LIST_INIT(&hooks[phase]);
236 }
237
238 bool_t add_hook(uint32_t phase, hook_fn *fn, void *state)
239 {
240     struct phase_hook *h;
241
242     h=safe_malloc(sizeof(*h),"add_hook");
243     h->fn=fn;
244     h->state=state;
245     LIST_INSERT_HEAD(&hooks[phase],h,entry);
246     return True;
247 }
248
249 bool_t remove_hook(uint32_t phase, hook_fn *fn, void *state)
250 {
251     fatal("remove_hook: not implemented");
252
253     return False;
254 }
255
256 void vslilog(struct log_if *lf, int priority, const char *message, va_list ap)
257 {
258     lf->vlogfn(lf->st,priority,message,ap);
259 }
260
261 void slilog(struct log_if *lf, int priority, const char *message, ...)
262 {
263     va_list ap;
264     
265     va_start(ap,message);
266     vslilog(lf,priority,message,ap);
267     va_end(ap);
268 }
269
270 struct buffer {
271     closure_t cl;
272     struct buffer_if ops;
273 };
274
275 void buffer_assert_free(struct buffer_if *buffer, cstring_t file,
276                         int line)
277 {
278     if (!buffer->free) {
279         fprintf(stderr,"secnet: BUF_ASSERT_FREE, %s line %d, owned by %s",
280                 file,line,buffer->owner);
281         assert(!"buffer_assert_free failure");
282     }
283 }
284
285 void buffer_assert_used(struct buffer_if *buffer, cstring_t file,
286                         int line)
287 {
288     if (buffer->free) {
289         fprintf(stderr,"secnet: BUF_ASSERT_USED, %s line %d, last owned by %s",
290                 file,line,buffer->owner);
291         assert(!"buffer_assert_used failure");
292     }
293 }
294
295 void buffer_init(struct buffer_if *buffer, int32_t max_start_pad)
296 {
297     assert(max_start_pad<=buffer->alloclen);
298     buffer->start=buffer->base+max_start_pad;
299     buffer->size=0;
300 }
301
302 void buffer_destroy(struct buffer_if *buf)
303 {
304     BUF_ASSERT_FREE(buf);
305     free(buf->base);
306     buf->start=buf->base=0;
307     buf->size=buf->alloclen=0;
308 }
309
310 void *buf_append(struct buffer_if *buf, int32_t amount) {
311     void *p;
312     assert(amount <= buf_remaining_space(buf));
313     p=buf->start + buf->size;
314     buf->size+=amount;
315     return p;
316 }
317
318 void *buf_prepend(struct buffer_if *buf, int32_t amount) {
319     assert(amount <= buf->start - buf->base);
320     buf->size+=amount;
321     return buf->start-=amount;
322 }
323
324 void *buf_unappend(struct buffer_if *buf, int32_t amount) {
325     if (buf->size < amount) return 0;
326     return buf->start+(buf->size-=amount);
327 }
328
329 void *buf_unprepend(struct buffer_if *buf, int32_t amount) {
330     void *p;
331     if (buf->size < amount) return 0;
332     p=buf->start;
333     buf->start+=amount;
334     buf->size-=amount;
335     return p;
336 }
337
338 /* Append a two-byte length and the string to the buffer. Length is in
339    network byte order. */
340 void buf_append_string(struct buffer_if *buf, cstring_t s)
341 {
342     size_t len;
343
344     len=strlen(s);
345     /* fixme: if string is longer than 65535, result is a corrupted packet */
346     buf_append_uint16(buf,len);
347     BUF_ADD_BYTES(append,buf,s,len);
348 }
349
350 void buffer_new(struct buffer_if *buf, int32_t len)
351 {
352     buf->free=True;
353     buf->owner=NULL;
354     buf->flags=0;
355     buf->loc.file=NULL;
356     buf->loc.line=0;
357     buf->size=0;
358     buf->alloclen=len;
359     buf->start=NULL;
360     buf->base=safe_malloc(len,"buffer_new");
361 }
362
363 void buffer_readonly_view(struct buffer_if *buf, const void *data, int32_t len)
364 {
365     buf->free=False;
366     buf->owner="READONLY";
367     buf->flags=0;
368     buf->loc.file=NULL;
369     buf->loc.line=0;
370     buf->size=buf->alloclen=len;
371     buf->base=buf->start=(uint8_t*)data;
372 }
373
374 void buffer_readonly_clone(struct buffer_if *out, const struct buffer_if *in)
375 {
376     buffer_readonly_view(out,in->start,in->size);
377 }
378
379 void buffer_copy(struct buffer_if *dst, const struct buffer_if *src)
380 {
381     if (dst->alloclen < src->alloclen) {
382         dst->base=realloc(dst->base,src->alloclen);
383         if (!dst->base) fatal_perror("buffer_copy");
384         dst->alloclen = src->alloclen;
385     }
386     dst->start = dst->base + (src->start - src->base);
387     dst->size = src->size;
388     memcpy(dst->start, src->start, dst->size);
389 }
390
391 static list_t *buffer_apply(closure_t *self, struct cloc loc, dict_t *context,
392                             list_t *args)
393 {
394     struct buffer *st;
395     item_t *item;
396     dict_t *dict;
397     bool_t lockdown=False;
398     uint32_t len=DEFAULT_BUFFER_SIZE;
399     
400     st=safe_malloc(sizeof(*st),"buffer_apply");
401     st->cl.description="buffer";
402     st->cl.type=CL_BUFFER;
403     st->cl.apply=NULL;
404     st->cl.interface=&st->ops;
405
406     /* First argument, if present, is buffer length */
407     item=list_elem(args,0);
408     if (item) {
409         if (item->type!=t_number) {
410             cfgfatal(st->ops.loc,"buffer","first parameter must be a "
411                      "number (buffer size)\n");
412         }
413         len=item->data.number;
414         if (len<MIN_BUFFER_SIZE) {
415             cfgfatal(st->ops.loc,"buffer","ludicrously small buffer size\n");
416         }
417         if (len>MAX_BUFFER_SIZE) {
418             cfgfatal(st->ops.loc,"buffer","ludicrously large buffer size\n");
419         }
420     }
421     /* Second argument, if present, is a dictionary */
422     item=list_elem(args,1);
423     if (item) {
424         if (item->type!=t_dict) {
425             cfgfatal(st->ops.loc,"buffer","second parameter must be a "
426                      "dictionary\n");
427         }
428         dict=item->data.dict;
429         lockdown=dict_read_bool(dict,"lockdown",False,"buffer",st->ops.loc,
430                                 False);
431     }
432
433     buffer_new(&st->ops,len);
434     if (lockdown) {
435         /* XXX mlock the buffer if possible */
436     }
437     
438     return new_closure(&st->cl);
439 }
440
441 void send_nak(const struct comm_addr *dest, uint32_t our_index,
442               uint32_t their_index, uint32_t msgtype,
443               struct buffer_if *buf, const char *logwhy)
444 {
445     buffer_init(buf,calculate_max_start_pad());
446     buf_append_uint32(buf,their_index);
447     buf_append_uint32(buf,our_index);
448     buf_append_uint32(buf,LABEL_NAK);
449     if (logwhy)
450         Message(M_INFO,"%s: %08"PRIx32"<-%08"PRIx32": %08"PRIx32":"
451                 " %s; sending NAK\n",
452                 comm_addr_to_string(dest),
453                 our_index, their_index, msgtype, logwhy);
454     dest->comm->sendmsg(dest->comm->st, buf, dest);
455 }
456
457 int consttime_memeq(const void *s1in, const void *s2in, size_t n)
458 {
459     const uint8_t *s1=s1in, *s2=s2in;
460     register volatile uint8_t accumulator=0;
461
462     while (n-- > 0) {
463         accumulator |= (*s1++ ^ *s2++);
464     }
465     accumulator |= accumulator >> 4; /* constant-time             */
466     accumulator |= accumulator >> 2; /*  boolean canonicalisation */
467     accumulator |= accumulator >> 1;
468     accumulator &= 1;
469     accumulator ^= 1;
470     return accumulator;
471 }
472
473 void util_module(dict_t *dict)
474 {
475     add_closure(dict,"sysbuffer",buffer_apply);
476 }
477
478 void update_max_start_pad(int32_t *our_module_global, int32_t our_instance)
479 {
480     if (*our_module_global < our_instance)
481         *our_module_global=our_instance;
482 }
483
484 int32_t transform_max_start_pad, comm_max_start_pad;
485
486 int32_t calculate_max_start_pad(void)
487 {
488     return
489         site_max_start_pad +
490         transform_max_start_pad +
491         comm_max_start_pad;
492 }
493
494 void vslilog_part(struct log_if *lf, int priority, const char *message, va_list ap)
495 {
496     char *buff=lf->buff;
497     size_t bp;
498     char *nlp;
499
500     bp=strlen(buff);
501     assert(bp < LOG_MESSAGE_BUFLEN);
502     vsnprintf(buff+bp,LOG_MESSAGE_BUFLEN-bp,message,ap);
503     buff[LOG_MESSAGE_BUFLEN-1] = '\n';
504     buff[LOG_MESSAGE_BUFLEN] = '\0';
505     /* Each line is sent separately */
506     while ((nlp=strchr(buff,'\n'))) {
507         *nlp=0;
508         slilog(lf,priority,"%s",buff);
509         memmove(buff,nlp+1,strlen(nlp+1)+1);
510     }
511 }
512
513 extern void slilog_part(struct log_if *lf, int priority, const char *message, ...)
514 {
515     va_list ap;
516     va_start(ap,message);
517     vslilog_part(lf,priority,message,ap);
518     va_end(ap);
519 }
520
521 void string_item_to_iaddr(const item_t *item, uint16_t port, union iaddr *ia,
522                           const char *desc)
523 {
524 #ifndef CONFIG_IPV6
525
526     ia->sin.sin_family=AF_INET;
527     ia->sin.sin_addr.s_addr=string_item_to_ipaddr(item,desc);
528
529 #else /* CONFIG_IPV6 => we have adns_text2addr */
530
531     if (item->type!=t_string)
532         cfgfatal(item->loc,desc,"expecting a string IP (v4 or v6) address\n");
533     socklen_t salen=sizeof(*ia);
534     int r=adns_text2addr(item->data.string, port,
535                          adns_qf_addrlit_ipv4_quadonly,
536                          &ia->sa, &salen);
537     assert(r!=ENOSPC);
538     if (r) cfgfatal(item->loc,desc,"invalid IP (v4 or v6) address: %s\n",
539                     strerror(r));
540
541 #endif /* CONFIG_IPV6 */
542 }
543
544 #define IADDR_NBUFS_SHIFT 3
545 #define IADDR_NBUFS (1 << IADDR_NBUFS_SHIFT)
546
547 const char *iaddr_to_string(const union iaddr *ia)
548 {
549     static int b;
550
551     b++;
552     b &= IADDR_NBUFS-1;
553
554 #ifndef CONFIG_IPV6
555
556     static char bufs[IADDR_NBUFS][100];
557
558     assert(ia->sa.sa_family == AF_INET);
559
560     snprintf(bufs[b], sizeof(bufs[b]), "[%s]:%d",
561              inet_ntoa(ia->sin.sin_addr),
562              ntohs(ia->sin.sin_port));
563
564 #else /* CONFIG_IPV6 => we have adns_addr2text */
565
566     static char bufs[IADDR_NBUFS][1+ADNS_ADDR2TEXT_BUFLEN+20];
567
568     int port;
569
570     char *addrbuf = bufs[b];
571     *addrbuf++ = '[';
572     int addrbuflen = ADNS_ADDR2TEXT_BUFLEN;
573
574     int r = adns_addr2text(&ia->sa, 0, addrbuf, &addrbuflen, &port);
575     if (r) {
576         const char fmt[]= "scoped IPv6 addr, error: %.*s";
577         sprintf(addrbuf, fmt,
578                 ADNS_ADDR2TEXT_BUFLEN - sizeof(fmt) /* underestimate */,
579                 strerror(r));
580     }
581
582     char *portbuf = addrbuf;
583     int addrl = strlen(addrbuf);
584     portbuf += addrl;
585
586     snprintf(portbuf, sizeof(bufs[b])-addrl, "]:%d", port);
587
588 #endif /* CONFIG_IPV6 */
589
590     return bufs[b];
591 }
592
593 bool_t iaddr_equal(const union iaddr *ia, const union iaddr *ib)
594 {
595     if (ia->sa.sa_family != ib->sa.sa_family)
596         return 0;
597     switch (ia->sa.sa_family) {
598     case AF_INET:
599         return ia->sin.sin_addr.s_addr == ib->sin.sin_addr.s_addr
600             && ia->sin.sin_port        == ib->sin.sin_port;
601 #ifdef CONFIG_IPV6
602     case AF_INET6:
603         return !memcmp(&ia->sin6.sin6_addr, &ib->sin6.sin6_addr, 16)
604             && ia->sin6.sin6_scope_id  == ib->sin6.sin6_scope_id
605             && ia->sin6.sin6_port      == ib->sin6.sin6_port
606             /* we ignore the flowinfo field */;
607 #endif /* CONFIG_IPV6 */
608     default:
609         abort();
610     }
611 }
612
613 int iaddr_socklen(const union iaddr *ia)
614 {
615     switch (ia->sa.sa_family) {
616     case AF_INET:  return sizeof(ia->sin);
617 #ifdef CONFIG_IPV6
618     case AF_INET6: return sizeof(ia->sin6);
619 #endif /* CONFIG_IPV6 */
620     default:       abort();
621     }
622 }
623
624 const char *pollbadbit(int revents)
625 {
626 #define BADBIT(b) \
627     if ((revents & b)) return #b
628     BADBIT(POLLERR);
629     BADBIT(POLLHUP);
630     /* POLLNVAL is handled by the event loop - see afterpoll_fn comment */
631 #undef BADBIT
632     return 0;
633 }
634
635 enum async_linebuf_result
636 async_linebuf_read(struct pollfd *pfd, struct buffer_if *buf,
637                    const char **emsg_out)
638 {
639     int revents=pfd->revents;
640
641 #define BAD(m) do{ *emsg_out=(m); return async_linebuf_broken; }while(0)
642
643     const char *badbit=pollbadbit(revents);
644     if (badbit) BAD(badbit);
645
646     if (!(revents & POLLIN))
647         return async_linebuf_nothing;
648
649     /*
650      * Data structure: A line which has been returned to the user is
651      * stored in buf at base before start.  But we retain the usual
652      * buffer meaning of size.  So:
653      *
654      *   | returned :    | input read,   |    unused    |
655      *   |  to user : \0 |  awaiting     |     buffer   |
656      *   |          :    |  processing   |      space   |
657      *   |          :    |               |              |
658      *   ^base           ^start          ^start+size    ^base+alloclen
659      */
660
661     BUF_ASSERT_USED(buf);
662
663     /* firstly, eat any previous */
664     if (buf->start != buf->base) {
665         memmove(buf->base,buf->start,buf->size);
666         buf->start=buf->base;
667     }
668
669     uint8_t *searched=buf->base;
670
671     /*
672      * During the workings here we do not use start.  We set start
673      * when we return some actual data.  So we have this:
674      *
675      *   | searched     | read, might   |  unused      |
676      *   |  for \n      |  contain \n   |   buffer     |
677      *   |  none found  |  but not \0   |    space     |
678      *   |              |               |              |
679      *   ^base          ^searched       ^base+size     ^base+alloclen
680      *  [^start]                        ^dataend
681      *
682      */
683     for (;;) {
684         uint8_t *dataend=buf->base+buf->size;
685         char *newline=memchr(searched,'\n',dataend-searched);
686         if (newline) {
687             *newline=0;
688             buf->start=newline+1;
689             buf->size=dataend-buf->start;
690             return async_linebuf_ok;
691         }
692         searched=dataend;
693         ssize_t space=(buf->base+buf->alloclen)-dataend;
694         if (!space) BAD("input line too long");
695         ssize_t r=read(pfd->fd,searched,space);
696         if (r==0) {
697             *searched=0;
698             *emsg_out=buf->size?"no newline at eof":0;
699             buf->start=searched+1;
700             buf->size=0;
701             return async_linebuf_eof;
702         }
703         if (r<0) {
704             if (errno==EINTR)
705                 continue;
706             if (iswouldblock(errno))
707                 return async_linebuf_nothing;
708             BAD(strerror(errno));
709         }
710         assert(r<=space);
711         if (memchr(searched,0,r)) BAD("nul in input data");
712         buf->size+=r;
713     }
714
715 #undef BAD
716 }