3 * - output and logging support
4 * - program lifetime support
5 * - IP address and subnet munging routines
6 * - MPI convenience functions
10 * Copyright (C) 1995--2001 Stephen Early <steve@greenend.org.uk>
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
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)
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.
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.
41 #include "unaligned.h"
45 #define MIN_BUFFER_SIZE 64
46 #define DEFAULT_BUFFER_SIZE 4096
47 #define MAX_BUFFER_SIZE 131072
49 static const char *hexdigits="0123456789abcdef";
51 uint32_t current_phase=0;
56 LIST_ENTRY(phase_hook) entry;
59 static LIST_HEAD(, phase_hook) hooks[NR_PHASES];
61 char *safe_strdup(const char *s, const char *message)
66 fatal_perror("%s",message);
71 void *safe_malloc(size_t size, const char *message)
78 fatal_perror("%s",message);
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);
87 assert(size && count);
88 p = realloc(p, size*count);
90 fatal_perror("%s", message);
94 void *safe_malloc_ary(size_t size, size_t count, const char *message) {
97 return safe_realloc_ary(0,size,count,message);
100 /* Convert a buffer into its MP_INT representation */
101 void read_mpbin(MP_INT *a, uint8_t *bin, int binsize)
106 buff=safe_malloc(binsize*2 + 1,"read_mpbin");
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)];
114 mpz_set_str(a, buff, 16);
118 /* Convert a MP_INT into a hex string */
119 char *write_mpstring(MP_INT *a)
123 buff=safe_malloc(mpz_sizeinbase(a,16)+2,"write_mpstring");
124 mpz_get_str(buff, 16, a);
128 static uint8_t hexval(uint8_t c)
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)
163 if (buflen==0) return 0;
164 hb=write_mpstring(a);
169 /* The number starts with a half-byte */
170 buffer[i++]=hexval(hb[j++]);
172 for (; hb[j] && i<buflen; i++) {
173 buffer[i]=(hexval(hb[j])<<4)|hexval(hb[j+1]);
180 #define DEFINE_SETFDFLAG(fn,FL,FLAG) \
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"); \
188 DEFINE_SETFDFLAG(setcloexec,FD,FD_CLOEXEC);
189 DEFINE_SETFDFLAG(setnonblock,FL,O_NONBLOCK);
191 void pipe_cloexec(int fd[2]) {
193 if (r) fatal_perror("pipe");
198 static const char *phases[NR_PHASES]={
204 "PHASE_GETRESOURCES",
210 void enter_phase(uint32_t new_phase)
212 struct phase_hook *i;
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;
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]);
223 void phase_hooks_init(void)
226 for (i=0; i<NR_PHASES; i++)
227 LIST_INIT(&hooks[i]);
230 void clear_phase_hooks(uint32_t phase)
232 struct phase_hook *h, *htmp;
233 LIST_FOREACH_SAFE(h, &hooks[phase], entry, htmp)
235 LIST_INIT(&hooks[phase]);
238 bool_t add_hook(uint32_t phase, hook_fn *fn, void *state)
240 struct phase_hook *h;
242 h=safe_malloc(sizeof(*h),"add_hook");
245 LIST_INSERT_HEAD(&hooks[phase],h,entry);
249 bool_t remove_hook(uint32_t phase, hook_fn *fn, void *state)
251 fatal("remove_hook: not implemented");
256 void vslilog(struct log_if *lf, int priority, const char *message, va_list ap)
258 lf->vlogfn(lf->st,priority,message,ap);
261 void slilog(struct log_if *lf, int priority, const char *message, ...)
265 va_start(ap,message);
266 vslilog(lf,priority,message,ap);
272 struct buffer_if ops;
275 void buffer_assert_free(struct buffer_if *buffer, cstring_t file,
279 fprintf(stderr,"secnet: BUF_ASSERT_FREE, %s line %d, owned by %s",
280 file,line,buffer->owner);
281 assert(!"buffer_assert_free failure");
285 void buffer_assert_used(struct buffer_if *buffer, cstring_t file,
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");
295 void buffer_init(struct buffer_if *buffer, int32_t max_start_pad)
297 assert(max_start_pad<=buffer->alloclen);
298 buffer->start=buffer->base+max_start_pad;
302 void buffer_destroy(struct buffer_if *buf)
304 BUF_ASSERT_FREE(buf);
306 buf->start=buf->base=0;
307 buf->size=buf->alloclen=0;
310 void *buf_append(struct buffer_if *buf, int32_t amount) {
312 assert(amount <= buf_remaining_space(buf));
313 p=buf->start + buf->size;
318 void *buf_prepend(struct buffer_if *buf, int32_t amount) {
319 assert(amount <= buf->start - buf->base);
321 return buf->start-=amount;
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);
329 void *buf_unprepend(struct buffer_if *buf, int32_t amount) {
331 if (buf->size < amount) return 0;
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)
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);
350 void buffer_new(struct buffer_if *buf, int32_t len)
360 buf->base=safe_malloc(len,"buffer_new");
363 void buffer_readonly_view(struct buffer_if *buf, const void *data, int32_t len)
366 buf->owner="READONLY";
370 buf->size=buf->alloclen=len;
371 buf->base=buf->start=(uint8_t*)data;
374 void buffer_readonly_clone(struct buffer_if *out, const struct buffer_if *in)
376 buffer_readonly_view(out,in->start,in->size);
379 void buffer_copy(struct buffer_if *dst, const struct buffer_if *src)
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;
386 dst->start = dst->base + (src->start - src->base);
387 dst->size = src->size;
388 memcpy(dst->start, src->start, dst->size);
391 static list_t *buffer_apply(closure_t *self, struct cloc loc, dict_t *context,
397 bool_t lockdown=False;
398 uint32_t len=DEFAULT_BUFFER_SIZE;
400 st=safe_malloc(sizeof(*st),"buffer_apply");
401 st->cl.description="buffer";
402 st->cl.type=CL_BUFFER;
404 st->cl.interface=&st->ops;
406 /* First argument, if present, is buffer length */
407 item=list_elem(args,0);
409 if (item->type!=t_number) {
410 cfgfatal(st->ops.loc,"buffer","first parameter must be a "
411 "number (buffer size)\n");
413 len=item->data.number;
414 if (len<MIN_BUFFER_SIZE) {
415 cfgfatal(st->ops.loc,"buffer","ludicrously small buffer size\n");
417 if (len>MAX_BUFFER_SIZE) {
418 cfgfatal(st->ops.loc,"buffer","ludicrously large buffer size\n");
421 /* Second argument, if present, is a dictionary */
422 item=list_elem(args,1);
424 if (item->type!=t_dict) {
425 cfgfatal(st->ops.loc,"buffer","second parameter must be a "
428 dict=item->data.dict;
429 lockdown=dict_read_bool(dict,"lockdown",False,"buffer",st->ops.loc,
433 buffer_new(&st->ops,len);
435 /* XXX mlock the buffer if possible */
438 return new_closure(&st->cl);
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)
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);
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);
457 int consttime_memeq(const void *s1in, const void *s2in, size_t n)
459 const uint8_t *s1=s1in, *s2=s2in;
460 register volatile uint8_t accumulator=0;
463 accumulator |= (*s1++ ^ *s2++);
465 accumulator |= accumulator >> 4; /* constant-time */
466 accumulator |= accumulator >> 2; /* boolean canonicalisation */
467 accumulator |= accumulator >> 1;
473 void util_module(dict_t *dict)
475 add_closure(dict,"sysbuffer",buffer_apply);
478 void update_max_start_pad(int32_t *our_module_global, int32_t our_instance)
480 if (*our_module_global < our_instance)
481 *our_module_global=our_instance;
484 int32_t transform_max_start_pad, comm_max_start_pad;
486 int32_t calculate_max_start_pad(void)
490 transform_max_start_pad +
494 void vslilog_part(struct log_if *lf, int priority, const char *message, va_list ap)
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'))) {
508 slilog(lf,priority,"%s",buff);
509 memmove(buff,nlp+1,strlen(nlp+1)+1);
513 extern void slilog_part(struct log_if *lf, int priority, const char *message, ...)
516 va_start(ap,message);
517 vslilog_part(lf,priority,message,ap);
521 void string_item_to_iaddr(const item_t *item, uint16_t port, union iaddr *ia,
526 ia->sin.sin_family=AF_INET;
527 ia->sin.sin_addr.s_addr=string_item_to_ipaddr(item,desc);
529 #else /* CONFIG_IPV6 => we have adns_text2addr */
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,
538 if (r) cfgfatal(item->loc,desc,"invalid IP (v4 or v6) address: %s\n",
541 #endif /* CONFIG_IPV6 */
544 #define IADDR_NBUFS_SHIFT 3
545 #define IADDR_NBUFS (1 << IADDR_NBUFS_SHIFT)
547 const char *iaddr_to_string(const union iaddr *ia)
556 static char bufs[IADDR_NBUFS][100];
558 assert(ia->sa.sa_family == AF_INET);
560 snprintf(bufs[b], sizeof(bufs[b]), "[%s]:%d",
561 inet_ntoa(ia->sin.sin_addr),
562 ntohs(ia->sin.sin_port));
564 #else /* CONFIG_IPV6 => we have adns_addr2text */
566 static char bufs[IADDR_NBUFS][1+ADNS_ADDR2TEXT_BUFLEN+20];
570 char *addrbuf = bufs[b];
572 int addrbuflen = ADNS_ADDR2TEXT_BUFLEN;
574 int r = adns_addr2text(&ia->sa, 0, addrbuf, &addrbuflen, &port);
576 const char fmt[]= "scoped IPv6 addr, error: %.*s";
577 sprintf(addrbuf, fmt,
578 ADNS_ADDR2TEXT_BUFLEN - sizeof(fmt) /* underestimate */,
582 char *portbuf = addrbuf;
583 int addrl = strlen(addrbuf);
586 snprintf(portbuf, sizeof(bufs[b])-addrl, "]:%d", port);
588 #endif /* CONFIG_IPV6 */
593 bool_t iaddr_equal(const union iaddr *ia, const union iaddr *ib)
595 if (ia->sa.sa_family != ib->sa.sa_family)
597 switch (ia->sa.sa_family) {
599 return ia->sin.sin_addr.s_addr == ib->sin.sin_addr.s_addr
600 && ia->sin.sin_port == ib->sin.sin_port;
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 */
613 int iaddr_socklen(const union iaddr *ia)
615 switch (ia->sa.sa_family) {
616 case AF_INET: return sizeof(ia->sin);
618 case AF_INET6: return sizeof(ia->sin6);
619 #endif /* CONFIG_IPV6 */
624 const char *pollbadbit(int revents)
627 if ((revents & b)) return #b
630 /* POLLNVAL is handled by the event loop - see afterpoll_fn comment */
635 enum async_linebuf_result
636 async_linebuf_read(struct pollfd *pfd, struct buffer_if *buf,
637 const char **emsg_out)
639 int revents=pfd->revents;
641 #define BAD(m) do{ *emsg_out=(m); return async_linebuf_broken; }while(0)
643 const char *badbit=pollbadbit(revents);
644 if (badbit) BAD(badbit);
646 if (!(revents & POLLIN))
647 return async_linebuf_nothing;
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:
654 * | returned : | input read, | unused |
655 * | to user : \0 | awaiting | buffer |
656 * | : | processing | space |
658 * ^base ^start ^start+size ^base+alloclen
661 BUF_ASSERT_USED(buf);
663 /* firstly, eat any previous */
664 if (buf->start != buf->base) {
665 memmove(buf->base,buf->start,buf->size);
666 buf->start=buf->base;
669 uint8_t *searched=buf->base;
672 * During the workings here we do not use start. We set start
673 * when we return some actual data. So we have this:
675 * | searched | read, might | unused |
676 * | for \n | contain \n | buffer |
677 * | none found | but not \0 | space |
679 * ^base ^searched ^base+size ^base+alloclen
684 uint8_t *dataend=buf->base+buf->size;
685 char *newline=memchr(searched,'\n',dataend-searched);
688 buf->start=newline+1;
689 buf->size=dataend-buf->start;
690 return async_linebuf_ok;
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);
698 *emsg_out=buf->size?"no newline at eof":0;
699 buf->start=searched+1;
701 return async_linebuf_eof;
706 if (iswouldblock(errno))
707 return async_linebuf_nothing;
708 BAD(strerror(errno));
711 if (memchr(searched,0,r)) BAD("nul in input data");