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