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 bool_t
add_hook(uint32_t phase
, hook_fn
*fn
, void *state
)
232 struct phase_hook
*h
;
234 h
=safe_malloc(sizeof(*h
),"add_hook");
237 LIST_INSERT_HEAD(&hooks
[phase
],h
,entry
);
241 bool_t
remove_hook(uint32_t phase
, hook_fn
*fn
, void *state
)
243 fatal("remove_hook: not implemented");
248 void vslilog(struct log_if
*lf
, int priority
, const char *message
, va_list ap
)
250 lf
->vlogfn(lf
->st
,priority
,message
,ap
);
253 void slilog(struct log_if
*lf
, int priority
, const char *message
, ...)
257 va_start(ap
,message
);
258 vslilog(lf
,priority
,message
,ap
);
264 struct buffer_if ops
;
267 void buffer_assert_free(struct buffer_if
*buffer
, cstring_t file
,
271 fprintf(stderr
,"secnet: BUF_ASSERT_FREE, %s line %d, owned by %s",
272 file
,line
,buffer
->owner
);
273 assert(!"buffer_assert_free failure");
277 void buffer_assert_used(struct buffer_if
*buffer
, cstring_t file
,
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");
287 void buffer_init(struct buffer_if
*buffer
, int32_t max_start_pad
)
289 assert(max_start_pad
<=buffer
->alloclen
);
290 buffer
->start
=buffer
->base
+max_start_pad
;
294 void buffer_destroy(struct buffer_if
*buf
)
296 BUF_ASSERT_FREE(buf
);
298 buf
->start
=buf
->base
=0;
299 buf
->size
=buf
->alloclen
=0;
302 void *buf_append(struct buffer_if
*buf
, int32_t amount
) {
304 assert(amount
<= buf_remaining_space(buf
));
305 p
=buf
->start
+ buf
->size
;
310 void *buf_prepend(struct buffer_if
*buf
, int32_t amount
) {
311 assert(amount
<= buf
->start
- buf
->base
);
313 return buf
->start
-=amount
;
316 void *buf_unappend(struct buffer_if
*buf
, int32_t amount
) {
317 if (buf
->size
< amount
) return 0;
318 return buf
->start
+(buf
->size
-=amount
);
321 void *buf_unprepend(struct buffer_if
*buf
, int32_t amount
) {
323 if (buf
->size
< amount
) return 0;
330 /* Append a two-byte length and the string to the buffer. Length is in
331 network byte order. */
332 void buf_append_string(struct buffer_if
*buf
, cstring_t s
)
337 /* fixme: if string is longer than 65535, result is a corrupted packet */
338 buf_append_uint16(buf
,len
);
339 BUF_ADD_BYTES(append
,buf
,s
,len
);
342 void buffer_new(struct buffer_if
*buf
, int32_t len
)
352 buf
->base
=safe_malloc(len
,"buffer_new");
355 void buffer_readonly_view(struct buffer_if
*buf
, const void *data
, int32_t len
)
358 buf
->owner
="READONLY";
362 buf
->size
=buf
->alloclen
=len
;
363 buf
->base
=buf
->start
=(uint8_t*)data
;
366 void buffer_readonly_clone(struct buffer_if
*out
, const struct buffer_if
*in
)
368 buffer_readonly_view(out
,in
->start
,in
->size
);
371 void buffer_copy(struct buffer_if
*dst
, const struct buffer_if
*src
)
373 if (dst
->alloclen
< src
->alloclen
) {
374 dst
->base
=realloc(dst
->base
,src
->alloclen
);
375 if (!dst
->base
) fatal_perror("buffer_copy");
376 dst
->alloclen
= src
->alloclen
;
378 dst
->start
= dst
->base
+ (src
->start
- src
->base
);
379 dst
->size
= src
->size
;
380 memcpy(dst
->start
, src
->start
, dst
->size
);
383 static list_t
*buffer_apply(closure_t
*self
, struct cloc loc
, dict_t
*context
,
389 bool_t lockdown
=False
;
390 uint32_t len
=DEFAULT_BUFFER_SIZE
;
392 st
=safe_malloc(sizeof(*st
),"buffer_apply");
393 st
->cl
.description
="buffer";
394 st
->cl
.type
=CL_BUFFER
;
396 st
->cl
.interface
=&st
->ops
;
398 /* First argument, if present, is buffer length */
399 item
=list_elem(args
,0);
401 if (item
->type
!=t_number
) {
402 cfgfatal(st
->ops
.loc
,"buffer","first parameter must be a "
403 "number (buffer size)\n");
405 len
=item
->data
.number
;
406 if (len
<MIN_BUFFER_SIZE
) {
407 cfgfatal(st
->ops
.loc
,"buffer","ludicrously small buffer size\n");
409 if (len
>MAX_BUFFER_SIZE
) {
410 cfgfatal(st
->ops
.loc
,"buffer","ludicrously large buffer size\n");
413 /* Second argument, if present, is a dictionary */
414 item
=list_elem(args
,1);
416 if (item
->type
!=t_dict
) {
417 cfgfatal(st
->ops
.loc
,"buffer","second parameter must be a "
420 dict
=item
->data
.dict
;
421 lockdown
=dict_read_bool(dict
,"lockdown",False
,"buffer",st
->ops
.loc
,
425 buffer_new(&st
->ops
,len
);
427 /* XXX mlock the buffer if possible */
430 return new_closure(&st
->cl
);
433 void send_nak(const struct comm_addr
*dest
, uint32_t our_index
,
434 uint32_t their_index
, uint32_t msgtype
,
435 struct buffer_if
*buf
, const char *logwhy
)
437 buffer_init(buf
,calculate_max_start_pad());
438 buf_append_uint32(buf
,their_index
);
439 buf_append_uint32(buf
,our_index
);
440 buf_append_uint32(buf
,LABEL_NAK
);
442 Message(M_INFO
,"%s: %08"PRIx32
"<-%08"PRIx32
": %08"PRIx32
":"
443 " %s; sending NAK\n",
444 comm_addr_to_string(dest
),
445 our_index
, their_index
, msgtype
, logwhy
);
446 dest
->comm
->sendmsg(dest
->comm
->st
, buf
, dest
);
449 int consttime_memeq(const void *s1in
, const void *s2in
, size_t n
)
451 const uint8_t *s1
=s1in
, *s2
=s2in
;
452 register volatile uint8_t accumulator
=0;
455 accumulator
|= (*s1
++ ^ *s2
++);
457 accumulator
|= accumulator
>> 4; /* constant-time */
458 accumulator
|= accumulator
>> 2; /* boolean canonicalisation */
459 accumulator
|= accumulator
>> 1;
465 void util_module(dict_t
*dict
)
467 add_closure(dict
,"sysbuffer",buffer_apply
);
470 void update_max_start_pad(int32_t *our_module_global
, int32_t our_instance
)
472 if (*our_module_global
< our_instance
)
473 *our_module_global
=our_instance
;
476 int32_t transform_max_start_pad
, comm_max_start_pad
;
478 int32_t calculate_max_start_pad(void)
482 transform_max_start_pad
+
486 void vslilog_part(struct log_if
*lf
, int priority
, const char *message
, va_list ap
)
493 assert(bp
< LOG_MESSAGE_BUFLEN
);
494 vsnprintf(buff
+bp
,LOG_MESSAGE_BUFLEN
-bp
,message
,ap
);
495 buff
[LOG_MESSAGE_BUFLEN
-1] = '\n';
496 buff
[LOG_MESSAGE_BUFLEN
] = '\0';
497 /* Each line is sent separately */
498 while ((nlp
=strchr(buff
,'\n'))) {
500 slilog(lf
,priority
,"%s",buff
);
501 memmove(buff
,nlp
+1,strlen(nlp
+1)+1);
505 extern void slilog_part(struct log_if
*lf
, int priority
, const char *message
, ...)
508 va_start(ap
,message
);
509 vslilog_part(lf
,priority
,message
,ap
);
513 void string_item_to_iaddr(const item_t
*item
, uint16_t port
, union iaddr
*ia
,
518 ia
->sin
.sin_family
=AF_INET
;
519 ia
->sin
.sin_addr
.s_addr
=string_item_to_ipaddr(item
,desc
);
521 #else /* CONFIG_IPV6 => we have adns_text2addr */
523 if (item
->type
!=t_string
)
524 cfgfatal(item
->loc
,desc
,"expecting a string IP (v4 or v6) address\n");
525 socklen_t salen
=sizeof(*ia
);
526 int r
=adns_text2addr(item
->data
.string
, port
,
527 adns_qf_addrlit_ipv4_quadonly
,
530 if (r
) cfgfatal(item
->loc
,desc
,"invalid IP (v4 or v6) address: %s\n",
533 #endif /* CONFIG_IPV6 */
536 #define IADDR_NBUFS_SHIFT 3
537 #define IADDR_NBUFS (1 << IADDR_NBUFS_SHIFT)
539 const char *iaddr_to_string(const union iaddr
*ia
)
548 static char bufs
[IADDR_NBUFS
][100];
550 assert(ia
->sa
.sa_family
== AF_INET
);
552 snprintf(bufs
[b
], sizeof(bufs
[b
]), "[%s]:%d",
553 inet_ntoa(ia
->sin
.sin_addr
),
554 ntohs(ia
->sin
.sin_port
));
556 #else /* CONFIG_IPV6 => we have adns_addr2text */
558 static char bufs
[IADDR_NBUFS
][1+ADNS_ADDR2TEXT_BUFLEN
+20];
562 char *addrbuf
= bufs
[b
];
564 int addrbuflen
= ADNS_ADDR2TEXT_BUFLEN
;
566 int r
= adns_addr2text(&ia
->sa
, 0, addrbuf
, &addrbuflen
, &port
);
568 const char fmt
[]= "scoped IPv6 addr, error: %.*s";
569 sprintf(addrbuf
, fmt
,
570 ADNS_ADDR2TEXT_BUFLEN
- sizeof(fmt
) /* underestimate */,
574 char *portbuf
= addrbuf
;
575 int addrl
= strlen(addrbuf
);
578 snprintf(portbuf
, sizeof(bufs
[b
])-addrl
, "]:%d", port
);
580 #endif /* CONFIG_IPV6 */
585 bool_t
iaddr_equal(const union iaddr
*ia
, const union iaddr
*ib
)
587 if (ia
->sa
.sa_family
!= ib
->sa
.sa_family
)
589 switch (ia
->sa
.sa_family
) {
591 return ia
->sin
.sin_addr
.s_addr
== ib
->sin
.sin_addr
.s_addr
592 && ia
->sin
.sin_port
== ib
->sin
.sin_port
;
595 return !memcmp(&ia
->sin6
.sin6_addr
, &ib
->sin6
.sin6_addr
, 16)
596 && ia
->sin6
.sin6_scope_id
== ib
->sin6
.sin6_scope_id
597 && ia
->sin6
.sin6_port
== ib
->sin6
.sin6_port
598 /* we ignore the flowinfo field */;
599 #endif /* CONFIG_IPV6 */
605 int iaddr_socklen(const union iaddr
*ia
)
607 switch (ia
->sa
.sa_family
) {
608 case AF_INET
: return sizeof(ia
->sin
);
610 case AF_INET6
: return sizeof(ia
->sin6
);
611 #endif /* CONFIG_IPV6 */
616 const char *pollbadbit(int revents
)
619 if ((revents & b)) return #b
622 /* POLLNVAL is handled by the event loop - see afterpoll_fn comment */
627 enum async_linebuf_result
628 async_linebuf_read(struct pollfd
*pfd
, struct buffer_if
*buf
,
629 const char **emsg_out
)
631 int revents
=pfd
->revents
;
633 #define BAD(m) do{ *emsg_out=(m); return async_linebuf_broken; }while(0)
635 const char *badbit
=pollbadbit(revents
);
636 if (badbit
) BAD(badbit
);
638 if (!(revents
& POLLIN
))
639 return async_linebuf_nothing
;
642 * Data structure: A line which has been returned to the user is
643 * stored in buf at base before start. But we retain the usual
644 * buffer meaning of size. So:
646 * | returned : | input read, | unused |
647 * | to user : \0 | awaiting | buffer |
648 * | : | processing | space |
650 * ^base ^start ^start+size ^base+alloclen
653 BUF_ASSERT_USED(buf
);
655 /* firstly, eat any previous */
656 if (buf
->start
!= buf
->base
) {
657 memmove(buf
->base
,buf
->start
,buf
->size
);
658 buf
->start
=buf
->base
;
661 uint8_t *searched
=buf
->base
;
664 * During the workings here we do not use start. We set start
665 * when we return some actual data. So we have this:
667 * | searched | read, might | unused |
668 * | for \n | contain \n | buffer |
669 * | none found | but not \0 | space |
671 * ^base ^searched ^base+size ^base+alloclen
676 uint8_t *dataend
=buf
->base
+buf
->size
;
677 char *newline
=memchr(searched
,'\n',dataend
-searched
);
680 buf
->start
=newline
+1;
681 buf
->size
=dataend
-buf
->start
;
682 return async_linebuf_ok
;
685 ssize_t space
=(buf
->base
+buf
->alloclen
)-dataend
;
686 if (!space
) BAD("input line too long");
687 ssize_t r
=read(pfd
->fd
,searched
,space
);
690 *emsg_out
=buf
->size?
"no newline at eof":0;
691 buf
->start
=searched
+1;
693 return async_linebuf_eof
;
698 if (iswouldblock(errno
))
699 return async_linebuf_nothing
;
700 BAD(strerror(errno
));
703 if (memchr(searched
,0,r
)) BAD("nul in input data");