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 struct phase_hook *next;
59 static struct phase_hook *hooks[NR_PHASES]={NULL,};
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)
76 fatal_perror("%s",message);
80 void *safe_malloc_ary(size_t size, size_t count, const char *message) {
81 if (count >= INT_MAX/size) {
82 fatal("array allocation overflow: %s", message);
84 return safe_malloc(size*count, message);
87 /* Convert a buffer into its MP_INT representation */
88 void read_mpbin(MP_INT *a, uint8_t *bin, int binsize)
93 buff=safe_malloc(binsize*2 + 1,"read_mpbin");
95 for (i=0; i<binsize; i++) {
96 buff[i*2]=hexdigits[(bin[i] & 0xf0) >> 4];
97 buff[i*2+1]=hexdigits[(bin[i] & 0xf)];
101 mpz_set_str(a, buff, 16);
105 /* Convert a MP_INT into a hex string */
106 char *write_mpstring(MP_INT *a)
110 buff=safe_malloc(mpz_sizeinbase(a,16)+2,"write_mpstring");
111 mpz_get_str(buff, 16, a);
115 static uint8_t hexval(uint8_t c)
144 /* Convert a MP_INT into a buffer; return length; truncate if necessary */
145 int32_t write_mpbin(MP_INT *a, uint8_t *buffer, int32_t buflen)
150 if (buflen==0) return 0;
151 hb=write_mpstring(a);
156 /* The number starts with a half-byte */
157 buffer[i++]=hexval(hb[j++]);
159 for (; hb[j] && i<buflen; i++) {
160 buffer[i]=(hexval(hb[j])<<4)|hexval(hb[j+1]);
167 void setcloexec(int fd) {
168 int r=fcntl(fd, F_GETFD);
169 if (r<0) fatal_perror("fcntl(,F_GETFD) failed");
171 r=fcntl(fd, F_SETFD, r|FD_CLOEXEC);
172 if (r<0) fatal_perror("fcntl(,F_SETFD,|FD_CLOEXEC) failed");
175 void pipe_cloexec(int fd[2]) {
177 if (r) fatal_perror("pipe");
182 static const char *phases[NR_PHASES]={
188 "PHASE_GETRESOURCES",
194 void enter_phase(uint32_t new_phase)
196 struct phase_hook *i;
198 if (hooks[new_phase])
199 Message(M_DEBUG_PHASE,"Running hooks for %s...\n", phases[new_phase]);
200 current_phase=new_phase;
202 for (i=hooks[new_phase]; i; i=i->next)
203 i->fn(i->state, new_phase);
204 Message(M_DEBUG_PHASE,"Now in %s\n",phases[new_phase]);
207 bool_t add_hook(uint32_t phase, hook_fn *fn, void *state)
209 struct phase_hook *h;
211 h=safe_malloc(sizeof(*h),"add_hook");
214 h->next=hooks[phase];
219 bool_t remove_hook(uint32_t phase, hook_fn *fn, void *state)
221 fatal("remove_hook: not implemented");
226 void vslilog(struct log_if *lf, int priority, const char *message, va_list ap)
228 lf->vlogfn(lf->st,priority,message,ap);
231 void slilog(struct log_if *lf, int priority, const char *message, ...)
235 va_start(ap,message);
236 vslilog(lf,priority,message,ap);
242 struct buffer_if ops;
245 void buffer_assert_free(struct buffer_if *buffer, cstring_t file,
249 fprintf(stderr,"secnet: BUF_ASSERT_FREE, %s line %d, owned by %s",
250 file,line,buffer->owner);
251 assert(!"buffer_assert_free failure");
255 void buffer_assert_used(struct buffer_if *buffer, cstring_t file,
259 fprintf(stderr,"secnet: BUF_ASSERT_USED, %s line %d, last owned by %s",
260 file,line,buffer->owner);
261 assert(!"buffer_assert_used failure");
265 void buffer_init(struct buffer_if *buffer, int32_t max_start_pad)
267 assert(max_start_pad<=buffer->alloclen);
268 buffer->start=buffer->base+max_start_pad;
272 void *buf_append(struct buffer_if *buf, int32_t amount) {
274 assert(amount <= buf_remaining_space(buf));
275 p=buf->start + buf->size;
280 void *buf_prepend(struct buffer_if *buf, int32_t amount) {
281 assert(amount <= buf->start - buf->base);
283 return buf->start-=amount;
286 void *buf_unappend(struct buffer_if *buf, int32_t amount) {
287 if (buf->size < amount) return 0;
288 return buf->start+(buf->size-=amount);
291 void *buf_unprepend(struct buffer_if *buf, int32_t amount) {
293 if (buf->size < amount) return 0;
300 /* Append a two-byte length and the string to the buffer. Length is in
301 network byte order. */
302 void buf_append_string(struct buffer_if *buf, cstring_t s)
307 /* fixme: if string is longer than 65535, result is a corrupted packet */
308 buf_append_uint16(buf,len);
309 memcpy(buf_append(buf,len),s,len);
312 void buffer_new(struct buffer_if *buf, int32_t len)
322 buf->base=safe_malloc(len,"buffer_new");
325 void buffer_readonly_view(struct buffer_if *buf, const void *data, int32_t len)
328 buf->owner="READONLY";
332 buf->size=buf->alloclen=len;
333 buf->base=buf->start=(uint8_t*)data;
336 void buffer_readonly_clone(struct buffer_if *out, const struct buffer_if *in)
338 buffer_readonly_view(out,in->start,in->size);
341 void buffer_copy(struct buffer_if *dst, const struct buffer_if *src)
343 if (dst->alloclen < src->alloclen) {
344 dst->base=realloc(dst->base,src->alloclen);
345 if (!dst->base) fatal_perror("buffer_copy");
346 dst->alloclen = src->alloclen;
348 dst->start = dst->base + (src->start - src->base);
349 dst->size = src->size;
350 memcpy(dst->start, src->start, dst->size);
353 static list_t *buffer_apply(closure_t *self, struct cloc loc, dict_t *context,
359 bool_t lockdown=False;
360 uint32_t len=DEFAULT_BUFFER_SIZE;
362 st=safe_malloc(sizeof(*st),"buffer_apply");
363 st->cl.description="buffer";
364 st->cl.type=CL_BUFFER;
366 st->cl.interface=&st->ops;
368 /* First argument, if present, is buffer length */
369 item=list_elem(args,0);
371 if (item->type!=t_number) {
372 cfgfatal(st->ops.loc,"buffer","first parameter must be a "
373 "number (buffer size)\n");
375 len=item->data.number;
376 if (len<MIN_BUFFER_SIZE) {
377 cfgfatal(st->ops.loc,"buffer","ludicrously small buffer size\n");
379 if (len>MAX_BUFFER_SIZE) {
380 cfgfatal(st->ops.loc,"buffer","ludicrously large buffer size\n");
383 /* Second argument, if present, is a dictionary */
384 item=list_elem(args,1);
386 if (item->type!=t_dict) {
387 cfgfatal(st->ops.loc,"buffer","second parameter must be a "
390 dict=item->data.dict;
391 lockdown=dict_read_bool(dict,"lockdown",False,"buffer",st->ops.loc,
395 buffer_new(&st->ops,len);
397 /* XXX mlock the buffer if possible */
400 return new_closure(&st->cl);
403 void send_nak(const struct comm_addr *dest, uint32_t our_index,
404 uint32_t their_index, uint32_t msgtype,
405 struct buffer_if *buf, const char *logwhy)
407 buffer_init(buf,calculate_max_start_pad());
408 buf_append_uint32(buf,their_index);
409 buf_append_uint32(buf,our_index);
410 buf_append_uint32(buf,LABEL_NAK);
412 Message(M_INFO,"%s: %08"PRIx32"<-%08"PRIx32": %08"PRIx32":"
413 " %s; sending NAK\n",
414 comm_addr_to_string(dest),
415 our_index, their_index, msgtype, logwhy);
416 dest->comm->sendmsg(dest->comm->st, buf, dest);
419 int consttime_memeq(const void *s1in, const void *s2in, size_t n)
421 const uint8_t *s1=s1in, *s2=s2in;
422 register volatile uint8_t accumulator=0;
425 accumulator |= (*s1++ ^ *s2++);
427 accumulator |= accumulator >> 4; /* constant-time */
428 accumulator |= accumulator >> 2; /* boolean canonicalisation */
429 accumulator |= accumulator >> 1;
435 void util_module(dict_t *dict)
437 add_closure(dict,"sysbuffer",buffer_apply);
440 void update_max_start_pad(int32_t *our_module_global, int32_t our_instance)
442 if (*our_module_global < our_instance)
443 *our_module_global=our_instance;
446 int32_t transform_max_start_pad, comm_max_start_pad;
448 int32_t calculate_max_start_pad(void)
452 transform_max_start_pad +
456 void vslilog_part(struct log_if *lf, int priority, const char *message, va_list ap)
463 assert(bp < LOG_MESSAGE_BUFLEN);
464 vsnprintf(buff+bp,LOG_MESSAGE_BUFLEN-bp,message,ap);
465 buff[LOG_MESSAGE_BUFLEN-1] = '\n';
466 buff[LOG_MESSAGE_BUFLEN] = '\0';
467 /* Each line is sent separately */
468 while ((nlp=strchr(buff,'\n'))) {
470 slilog(lf,priority,"%s",buff);
471 memmove(buff,nlp+1,strlen(nlp+1)+1);
475 extern void slilog_part(struct log_if *lf, int priority, const char *message, ...)
478 va_start(ap,message);
479 vslilog_part(lf,priority,message,ap);
483 void text2iaddr(const item_t *item, uint16_t port, union iaddr *ia,
488 ia->sin.sin_family=AF_INET;
489 ia->sin.sin_addr.s_addr=string_item_to_ipaddr(item,desc);
491 #else /* CONFIG_IPV6 => we have adns_text2addr */
493 if (item->type!=t_string)
494 cfgfatal(item->loc,desc,"expecting a string IP (v4 or v6) address\n");
495 socklen_t salen=sizeof(*ia);
496 int r=adns_text2addr(item->data.string, port,
497 adns_qf_addrlit_ipv4_quadonly,
500 if (r) cfgfatal(item->loc,desc,"invalid IP (v4 or v6) address: %s\n",
503 #endif /* CONFIG_IPV6 */
506 #define IADDR_NBUFS_SHIFT 3
507 #define IADDR_NBUFS (1 << IADDR_NBUFS_SHIFT)
509 const char *iaddr_to_string(const union iaddr *ia)
518 static char bufs[IADDR_NBUFS][100];
520 assert(ia->sa.sa_family == AF_INET);
522 snprintf(bufs[b], sizeof(bufs[b]), "[%s]:%d",
523 inet_ntoa(ia->sin.sin_addr),
524 ntohs(ia->sin.sin_port));
526 #else /* CONFIG_IPV6 => we have adns_addr2text */
528 static char bufs[IADDR_NBUFS][1+ADNS_ADDR2TEXT_BUFLEN+20];
532 char *addrbuf = bufs[b];
534 int addrbuflen = ADNS_ADDR2TEXT_BUFLEN;
536 int r = adns_addr2text(&ia->sa, 0, addrbuf, &addrbuflen, &port);
538 const char fmt[]= "scoped IPv6 addr, error: %.*s";
539 sprintf(addrbuf, fmt,
540 ADNS_ADDR2TEXT_BUFLEN - sizeof(fmt) /* underestimate */,
544 char *portbuf = addrbuf;
545 int addrl = strlen(addrbuf);
548 snprintf(portbuf, sizeof(bufs[b])-addrl, "]:%d", port);
550 #endif /* CONFIG_IPV6 */
555 bool_t iaddr_equal(const union iaddr *ia, const union iaddr *ib)
557 if (ia->sa.sa_family != ib->sa.sa_family)
559 switch (ia->sa.sa_family) {
561 return ia->sin.sin_addr.s_addr == ib->sin.sin_addr.s_addr
562 && ia->sin.sin_port == ib->sin.sin_port;
565 return !memcmp(&ia->sin6.sin6_addr, &ib->sin6.sin6_addr, 16)
566 && ia->sin6.sin6_scope_id == ib->sin6.sin6_scope_id
567 && ia->sin6.sin6_port == ib->sin6.sin6_port
568 /* we ignore the flowinfo field */;
569 #endif /* CONFIG_IPV6 */
575 int iaddr_socklen(const union iaddr *ia)
577 switch (ia->sa.sa_family) {
578 case AF_INET: return sizeof(ia->sin);
580 case AF_INET6: return sizeof(ia->sin6);
581 #endif /* CONFIG_IPV6 */