3 * - output and logging support
4 * - program lifetime support
5 * - IP address and subnet munging routines
6 * - MPI convenience functions
9 * This file is part of secnet.
10 * See README for full list of copyright holders.
12 * secnet is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 3 of the License, or
15 * (at your option) any later version.
17 * secnet is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * version 3 along with secnet; if not, see
24 * https://www.gnu.org/licenses/gpl.html.
37 #include "unaligned.h"
41 #define MIN_BUFFER_SIZE 64
42 #define DEFAULT_BUFFER_SIZE 4096
43 #define MAX_BUFFER_SIZE 131072
45 static const char *hexdigits="0123456789abcdef";
47 uint32_t current_phase=0;
52 LIST_ENTRY(phase_hook) entry;
55 static LIST_HEAD(, phase_hook) hooks[NR_PHASES];
57 char *safe_strdup(const char *s, const char *message)
62 fatal_perror("%s",message);
67 void *safe_malloc(size_t size, const char *message)
74 fatal_perror("%s",message);
78 void *safe_realloc_ary(void *p, size_t size, size_t count,
79 const char *message) {
80 if (count >= INT_MAX/size) {
81 fatal("array allocation overflow: %s", message);
83 assert(size && count);
84 p = realloc(p, size*count);
86 fatal_perror("%s", message);
90 void *safe_malloc_ary(size_t size, size_t count, const char *message) {
93 return safe_realloc_ary(0,size,count,message);
96 /* Hex-encode a buffer, and return the hex in a freshly allocated string. */
97 string_t hex_encode(const uint8_t *bin, int binsize)
102 buff=safe_malloc(binsize*2 + 1,"hex_encode");
104 for (i=0; i<binsize; i++) {
105 buff[i*2]=hexdigits[(bin[i] & 0xf0) >> 4];
106 buff[i*2+1]=hexdigits[(bin[i] & 0xf)];
112 static uint8_t hexval(uint8_t c)
141 bool_t hex_decode(uint8_t *buffer, int32_t buflen, int32_t *outlen,
142 cstring_t hb, bool_t allow_odd_nibble)
144 int i = 0, j = 0, l = strlen(hb), hi, lo;
147 if (!l || !buflen) { ok = !l; goto done; }
149 /* The number starts with a half-byte */
150 if (!allow_odd_nibble) goto done;
151 lo = hexval(hb[j++]); if (lo < 0) goto done;
154 for (; hb[j] && i < buflen; i++) {
155 hi = hexval(hb[j++]);
156 lo = hexval(hb[j++]);
157 if (hi < 0 || lo < 0) goto done;
158 buffer[i] = (hi << 4) | lo;
166 /* Convert a buffer into its MP_INT representation */
167 void read_mpbin(MP_INT *a, uint8_t *bin, int binsize)
169 char *buff = hex_encode(bin, binsize);
170 mpz_set_str(a, buff, 16);
174 /* Convert a MP_INT into a hex string */
175 char *write_mpstring(MP_INT *a)
179 buff=safe_malloc(mpz_sizeinbase(a,16)+2,"write_mpstring");
180 mpz_get_str(buff, 16, a);
184 /* Convert a MP_INT into a buffer; return length; truncate if necessary */
185 int32_t write_mpbin(MP_INT *a, uint8_t *buffer, int32_t buflen)
187 char *hb = write_mpstring(a);
189 hex_decode(buffer, buflen, &len, hb, True);
194 #define DEFINE_SETFDFLAG(fn,FL,FLAG) \
196 int r=fcntl(fd, F_GET##FL); \
197 if (r<0) fatal_perror("fcntl(,F_GET" #FL ") failed"); \
198 r=fcntl(fd, F_SET##FL, r|FLAG); \
199 if (r<0) fatal_perror("fcntl(,F_SET" #FL ",|" #FLAG ") failed"); \
202 DEFINE_SETFDFLAG(setcloexec,FD,FD_CLOEXEC);
203 DEFINE_SETFDFLAG(setnonblock,FL,O_NONBLOCK);
205 void pipe_cloexec(int fd[2]) {
207 if (r) fatal_perror("pipe");
212 static const char *phases[NR_PHASES]={
218 "PHASE_GETRESOURCES",
225 void enter_phase(uint32_t new_phase)
227 struct phase_hook *i;
229 if (!LIST_EMPTY(&hooks[new_phase]))
230 Message(M_DEBUG_PHASE,"Running hooks for %s...\n", phases[new_phase]);
231 current_phase=new_phase;
233 LIST_FOREACH(i, &hooks[new_phase], entry)
234 i->fn(i->state, new_phase);
235 Message(M_DEBUG_PHASE,"Now in %s\n",phases[new_phase]);
238 void phase_hooks_init(void)
241 for (i=0; i<NR_PHASES; i++)
242 LIST_INIT(&hooks[i]);
245 void clear_phase_hooks(uint32_t phase)
247 struct phase_hook *h, *htmp;
248 LIST_FOREACH_SAFE(h, &hooks[phase], entry, htmp)
250 LIST_INIT(&hooks[phase]);
253 bool_t add_hook(uint32_t phase, hook_fn *fn, void *state)
255 struct phase_hook *h;
260 LIST_INSERT_HEAD(&hooks[phase],h,entry);
264 bool_t remove_hook(uint32_t phase, hook_fn *fn, void *state)
266 fatal("remove_hook: not implemented");
271 void vslilog(struct log_if *lf, int priority, const char *message, va_list ap)
273 lf->vlogfn(lf->st,priority,message,ap);
276 void slilog(struct log_if *lf, int priority, const char *message, ...)
280 va_start(ap,message);
281 vslilog(lf,priority,message,ap);
287 struct buffer_if ops;
290 void buffer_assert_free(struct buffer_if *buffer, cstring_t file,
294 fprintf(stderr,"secnet: BUF_ASSERT_FREE, %s line %d, owned by %s",
295 file,line,buffer->owner);
296 assert(!"buffer_assert_free failure");
300 void buffer_assert_used(struct buffer_if *buffer, cstring_t file,
304 fprintf(stderr,"secnet: BUF_ASSERT_USED, %s line %d, last owned by %s",
305 file,line,buffer->owner);
306 assert(!"buffer_assert_used failure");
310 void buffer_init(struct buffer_if *buffer, int32_t max_start_pad)
312 assert(max_start_pad<=buffer->alloclen);
313 buffer->start=buffer->base+max_start_pad;
317 void buffer_destroy(struct buffer_if *buf)
319 BUF_ASSERT_FREE(buf);
321 buf->start=buf->base=0;
322 buf->size=buf->alloclen=0;
325 void *buf_append(struct buffer_if *buf, int32_t amount) {
327 assert(amount <= buf_remaining_space(buf));
328 p=buf->start + buf->size;
333 void *buf_prepend(struct buffer_if *buf, int32_t amount) {
334 assert(amount <= buf->start - buf->base);
336 return buf->start-=amount;
339 void *buf_unappend(struct buffer_if *buf, int32_t amount) {
340 if (buf->size < amount) return 0;
341 return buf->start+(buf->size-=amount);
344 void *buf_unprepend(struct buffer_if *buf, int32_t amount) {
346 if (buf->size < amount) return 0;
353 /* Append a two-byte length and the string to the buffer. Length is in
354 network byte order. */
355 void buf_append_string(struct buffer_if *buf, cstring_t s)
360 /* fixme: if string is longer than 65535, result is a corrupted packet */
361 buf_append_uint16(buf,len);
362 BUF_ADD_BYTES(append,buf,s,len);
365 void buffer_new(struct buffer_if *buf, int32_t len)
375 buf->base=safe_malloc(len,"buffer_new");
378 void buffer_readonly_view(struct buffer_if *buf, const void *data, int32_t len)
381 buf->owner="READONLY";
385 buf->size=buf->alloclen=len;
386 buf->base=buf->start=(uint8_t*)data;
389 void buffer_readonly_clone(struct buffer_if *out, const struct buffer_if *in)
391 buffer_readonly_view(out,in->start,in->size);
394 void buffer_copy(struct buffer_if *dst, const struct buffer_if *src)
396 if (dst->alloclen < src->alloclen) {
397 dst->base=realloc(dst->base,src->alloclen);
398 if (!dst->base) fatal_perror("buffer_copy");
399 dst->alloclen = src->alloclen;
401 dst->start = dst->base + (src->start - src->base);
402 dst->size = src->size;
403 memcpy(dst->start, src->start, dst->size);
406 static list_t *buffer_apply(closure_t *self, struct cloc loc, dict_t *context,
412 bool_t lockdown=False;
413 uint32_t len=DEFAULT_BUFFER_SIZE;
416 st->cl.description="buffer";
417 st->cl.type=CL_BUFFER;
419 st->cl.interface=&st->ops;
421 /* First argument, if present, is buffer length */
422 item=list_elem(args,0);
424 if (item->type!=t_number) {
425 cfgfatal(st->ops.loc,"buffer","first parameter must be a "
426 "number (buffer size)\n");
428 len=item->data.number;
429 if (len<MIN_BUFFER_SIZE) {
430 cfgfatal(st->ops.loc,"buffer","ludicrously small buffer size\n");
432 if (len>MAX_BUFFER_SIZE) {
433 cfgfatal(st->ops.loc,"buffer","ludicrously large buffer size\n");
436 /* Second argument, if present, is a dictionary */
437 item=list_elem(args,1);
439 if (item->type!=t_dict) {
440 cfgfatal(st->ops.loc,"buffer","second parameter must be a "
443 dict=item->data.dict;
444 lockdown=dict_read_bool(dict,"lockdown",False,"buffer",st->ops.loc,
448 buffer_new(&st->ops,len);
450 /* XXX mlock the buffer if possible */
453 return new_closure(&st->cl);
456 void send_nak(const struct comm_addr *dest, uint32_t our_index,
457 uint32_t their_index, uint32_t msgtype,
458 struct buffer_if *buf, const char *logwhy)
460 buffer_init(buf,calculate_max_start_pad());
461 buf_append_uint32(buf,their_index);
462 buf_append_uint32(buf,our_index);
463 buf_append_uint32(buf,LABEL_NAK);
465 Message(M_INFO,"%s: %08"PRIx32"<-%08"PRIx32": %08"PRIx32":"
466 " %s; sending NAK\n",
467 comm_addr_to_string(dest),
468 our_index, their_index, msgtype, logwhy);
469 dest->comm->sendmsg(dest->comm->st, buf, dest, 0);
472 int consttime_memeq(const void *s1in, const void *s2in, size_t n)
474 const uint8_t *s1=s1in, *s2=s2in;
475 register volatile uint8_t accumulator=0;
478 accumulator |= (*s1++ ^ *s2++);
480 accumulator |= accumulator >> 4; /* constant-time */
481 accumulator |= accumulator >> 2; /* boolean canonicalisation */
482 accumulator |= accumulator >> 1;
488 void util_module(dict_t *dict)
490 add_closure(dict,"sysbuffer",buffer_apply);
493 void update_max_start_pad(int32_t *our_module_global, int32_t our_instance)
495 if (*our_module_global < our_instance)
496 *our_module_global=our_instance;
499 int32_t transform_max_start_pad, comm_max_start_pad;
501 int32_t calculate_max_start_pad(void)
505 transform_max_start_pad +
509 void vslilog_part(struct log_if *lf, int priority, const char *message, va_list ap)
516 assert(bp < LOG_MESSAGE_BUFLEN);
517 vsnprintf(buff+bp,LOG_MESSAGE_BUFLEN-bp,message,ap);
518 buff[LOG_MESSAGE_BUFLEN-1] = '\n';
519 buff[LOG_MESSAGE_BUFLEN] = '\0';
520 /* Each line is sent separately */
521 while ((nlp=strchr(buff,'\n'))) {
523 slilog(lf,priority,"%s",buff);
524 memmove(buff,nlp+1,strlen(nlp+1)+1);
528 extern void slilog_part(struct log_if *lf, int priority, const char *message, ...)
531 va_start(ap,message);
532 vslilog_part(lf,priority,message,ap);
536 void string_item_to_iaddr(const item_t *item, uint16_t port, union iaddr *ia,
541 ia->sin.sin_family=AF_INET;
542 ia->sin.sin_addr.s_addr=htonl(string_item_to_ipaddr(item,desc));
543 ia->sin.sin_port=htons(port);
545 #else /* CONFIG_IPV6 => we have adns_text2addr */
547 if (item->type!=t_string)
548 cfgfatal(item->loc,desc,"expecting a string IP (v4 or v6) address\n");
549 socklen_t salen=sizeof(*ia);
550 int r=adns_text2addr(item->data.string, port,
551 adns_qf_addrlit_ipv4_quadonly,
554 if (r) cfgfatal(item->loc,desc,"invalid IP (v4 or v6) address: %s\n",
557 #endif /* CONFIG_IPV6 */
560 #define IADDR_NBUFS 8
562 const char *iaddr_to_string(const union iaddr *ia)
566 SBUF_DEFINE(IADDR_NBUFS, 100);
568 assert(ia->sa.sa_family == AF_INET);
570 snprintf(SBUF, sizeof(SBUF), "[%s]:%d",
571 inet_ntoa(ia->sin.sin_addr),
572 ntohs(ia->sin.sin_port));
574 #else /* CONFIG_IPV6 => we have adns_addr2text */
576 SBUF_DEFINE(IADDR_NBUFS, 1+ADNS_ADDR2TEXT_BUFLEN+20);
580 char *addrbuf = SBUF;
582 int addrbuflen = ADNS_ADDR2TEXT_BUFLEN;
584 int r = adns_addr2text(&ia->sa, 0, addrbuf, &addrbuflen, &port);
586 const char fmt[]= "scoped IPv6 addr, error: %.*s";
587 sprintf(addrbuf, fmt,
588 (int)(ADNS_ADDR2TEXT_BUFLEN - sizeof(fmt)) /* underestimate */,
592 char *portbuf = addrbuf;
593 int addrl = strlen(addrbuf);
596 snprintf(portbuf, sizeof(SBUF)-addrl, "]:%d", port);
598 #endif /* CONFIG_IPV6 */
603 bool_t iaddr_equal(const union iaddr *ia, const union iaddr *ib,
606 if (ia->sa.sa_family != ib->sa.sa_family)
608 switch (ia->sa.sa_family) {
610 return ia->sin.sin_addr.s_addr == ib->sin.sin_addr.s_addr
612 ia->sin.sin_port == ib->sin.sin_port);
615 return !memcmp(&ia->sin6.sin6_addr, &ib->sin6.sin6_addr, 16)
616 && ia->sin6.sin6_scope_id == ib->sin6.sin6_scope_id
618 ia->sin6.sin6_port == ib->sin6.sin6_port)
619 /* we ignore the flowinfo field */;
620 #endif /* CONFIG_IPV6 */
626 int iaddr_socklen(const union iaddr *ia)
628 switch (ia->sa.sa_family) {
629 case AF_INET: return sizeof(ia->sin);
631 case AF_INET6: return sizeof(ia->sin6);
632 #endif /* CONFIG_IPV6 */
637 const char *pollbadbit(int revents)
640 if ((revents & b)) return #b
643 /* POLLNVAL is handled by the event loop - see afterpoll_fn comment */
648 enum async_linebuf_result
649 async_linebuf_read(struct pollfd *pfd, struct buffer_if *buf,
650 const char **emsg_out)
652 int revents=pfd->revents;
654 #define BAD(m) do{ *emsg_out=(m); return async_linebuf_broken; }while(0)
656 const char *badbit=pollbadbit(revents);
657 if (badbit) BAD(badbit);
659 if (!(revents & POLLIN))
660 return async_linebuf_nothing;
663 * Data structure: A line which has been returned to the user is
664 * stored in buf at base before start. But we retain the usual
665 * buffer meaning of size. So:
667 * | returned : | input read, | unused |
668 * | to user : \0 | awaiting | buffer |
669 * | : | processing | space |
671 * ^base ^start ^start+size ^base+alloclen
674 BUF_ASSERT_USED(buf);
676 /* firstly, eat any previous */
677 if (buf->start != buf->base) {
678 memmove(buf->base,buf->start,buf->size);
679 buf->start=buf->base;
682 uint8_t *searched=buf->base;
685 * During the workings here we do not use start. We set start
686 * when we return some actual data. So we have this:
688 * | searched | read, might | unused |
689 * | for \n | contain \n | buffer |
690 * | none found | but not \0 | space |
692 * ^base ^searched ^base+size ^base+alloclen
697 uint8_t *dataend=buf->base+buf->size;
698 char *newline=memchr(searched,'\n',dataend-searched);
701 buf->start=newline+1;
702 buf->size=dataend-buf->start;
703 return async_linebuf_ok;
706 ssize_t space=(buf->base+buf->alloclen)-dataend;
707 if (!space) BAD("input line too long");
708 ssize_t r=read(pfd->fd,searched,space);
711 *emsg_out=buf->size?"no newline at eof":0;
712 buf->start=searched+1;
714 return async_linebuf_eof;
719 if (iswouldblock(errno))
720 return async_linebuf_nothing;
721 BAD(strerror(errno));
724 if (memchr(searched,0,r)) BAD("nul in input data");