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