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
)
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 (hooks
[new_phase
])
215 Message(M_DEBUG_PHASE
,"Running hooks for %s...\n", phases
[new_phase
]);
216 current_phase
=new_phase
;
218 for (i
=hooks
[new_phase
]; i
; i
=i
->next
)
219 i
->fn(i
->state
, new_phase
);
220 Message(M_DEBUG_PHASE
,"Now in %s\n",phases
[new_phase
]);
223 bool_t
add_hook(uint32_t phase
, hook_fn
*fn
, void *state
)
225 struct phase_hook
*h
;
227 h
=safe_malloc(sizeof(*h
),"add_hook");
230 h
->next
=hooks
[phase
];
235 bool_t
remove_hook(uint32_t phase
, hook_fn
*fn
, void *state
)
237 fatal("remove_hook: not implemented");
242 void vslilog(struct log_if
*lf
, int priority
, const char *message
, va_list ap
)
244 lf
->vlogfn(lf
->st
,priority
,message
,ap
);
247 void slilog(struct log_if
*lf
, int priority
, const char *message
, ...)
251 va_start(ap
,message
);
252 vslilog(lf
,priority
,message
,ap
);
258 struct buffer_if ops
;
261 void buffer_assert_free(struct buffer_if
*buffer
, cstring_t file
,
265 fprintf(stderr
,"secnet: BUF_ASSERT_FREE, %s line %d, owned by %s",
266 file
,line
,buffer
->owner
);
267 assert(!"buffer_assert_free failure");
271 void buffer_assert_used(struct buffer_if
*buffer
, cstring_t file
,
275 fprintf(stderr
,"secnet: BUF_ASSERT_USED, %s line %d, last owned by %s",
276 file
,line
,buffer
->owner
);
277 assert(!"buffer_assert_used failure");
281 void buffer_init(struct buffer_if
*buffer
, int32_t max_start_pad
)
283 assert(max_start_pad
<=buffer
->alloclen
);
284 buffer
->start
=buffer
->base
+max_start_pad
;
288 void *buf_append(struct buffer_if
*buf
, int32_t amount
) {
290 assert(amount
<= buf_remaining_space(buf
));
291 p
=buf
->start
+ buf
->size
;
296 void *buf_prepend(struct buffer_if
*buf
, int32_t amount
) {
297 assert(amount
<= buf
->start
- buf
->base
);
299 return buf
->start
-=amount
;
302 void *buf_unappend(struct buffer_if
*buf
, int32_t amount
) {
303 if (buf
->size
< amount
) return 0;
304 return buf
->start
+(buf
->size
-=amount
);
307 void *buf_unprepend(struct buffer_if
*buf
, int32_t amount
) {
309 if (buf
->size
< amount
) return 0;
316 /* Append a two-byte length and the string to the buffer. Length is in
317 network byte order. */
318 void buf_append_string(struct buffer_if
*buf
, cstring_t s
)
323 /* fixme: if string is longer than 65535, result is a corrupted packet */
324 buf_append_uint16(buf
,len
);
325 BUF_ADD_BYTES(append
,buf
,s
,len
);
328 void buffer_new(struct buffer_if
*buf
, int32_t len
)
338 buf
->base
=safe_malloc(len
,"buffer_new");
341 void buffer_readonly_view(struct buffer_if
*buf
, const void *data
, int32_t len
)
344 buf
->owner
="READONLY";
348 buf
->size
=buf
->alloclen
=len
;
349 buf
->base
=buf
->start
=(uint8_t*)data
;
352 void buffer_readonly_clone(struct buffer_if
*out
, const struct buffer_if
*in
)
354 buffer_readonly_view(out
,in
->start
,in
->size
);
357 void buffer_copy(struct buffer_if
*dst
, const struct buffer_if
*src
)
359 if (dst
->alloclen
< src
->alloclen
) {
360 dst
->base
=realloc(dst
->base
,src
->alloclen
);
361 if (!dst
->base
) fatal_perror("buffer_copy");
362 dst
->alloclen
= src
->alloclen
;
364 dst
->start
= dst
->base
+ (src
->start
- src
->base
);
365 dst
->size
= src
->size
;
366 memcpy(dst
->start
, src
->start
, dst
->size
);
369 static list_t
*buffer_apply(closure_t
*self
, struct cloc loc
, dict_t
*context
,
375 bool_t lockdown
=False
;
376 uint32_t len
=DEFAULT_BUFFER_SIZE
;
378 st
=safe_malloc(sizeof(*st
),"buffer_apply");
379 st
->cl
.description
="buffer";
380 st
->cl
.type
=CL_BUFFER
;
382 st
->cl
.interface
=&st
->ops
;
384 /* First argument, if present, is buffer length */
385 item
=list_elem(args
,0);
387 if (item
->type
!=t_number
) {
388 cfgfatal(st
->ops
.loc
,"buffer","first parameter must be a "
389 "number (buffer size)\n");
391 len
=item
->data
.number
;
392 if (len
<MIN_BUFFER_SIZE
) {
393 cfgfatal(st
->ops
.loc
,"buffer","ludicrously small buffer size\n");
395 if (len
>MAX_BUFFER_SIZE
) {
396 cfgfatal(st
->ops
.loc
,"buffer","ludicrously large buffer size\n");
399 /* Second argument, if present, is a dictionary */
400 item
=list_elem(args
,1);
402 if (item
->type
!=t_dict
) {
403 cfgfatal(st
->ops
.loc
,"buffer","second parameter must be a "
406 dict
=item
->data
.dict
;
407 lockdown
=dict_read_bool(dict
,"lockdown",False
,"buffer",st
->ops
.loc
,
411 buffer_new(&st
->ops
,len
);
413 /* XXX mlock the buffer if possible */
416 return new_closure(&st
->cl
);
419 void send_nak(const struct comm_addr
*dest
, uint32_t our_index
,
420 uint32_t their_index
, uint32_t msgtype
,
421 struct buffer_if
*buf
, const char *logwhy
)
423 buffer_init(buf
,calculate_max_start_pad());
424 buf_append_uint32(buf
,their_index
);
425 buf_append_uint32(buf
,our_index
);
426 buf_append_uint32(buf
,LABEL_NAK
);
428 Message(M_INFO
,"%s: %08"PRIx32
"<-%08"PRIx32
": %08"PRIx32
":"
429 " %s; sending NAK\n",
430 comm_addr_to_string(dest
),
431 our_index
, their_index
, msgtype
, logwhy
);
432 dest
->comm
->sendmsg(dest
->comm
->st
, buf
, dest
);
435 int consttime_memeq(const void *s1in
, const void *s2in
, size_t n
)
437 const uint8_t *s1
=s1in
, *s2
=s2in
;
438 register volatile uint8_t accumulator
=0;
441 accumulator
|= (*s1
++ ^ *s2
++);
443 accumulator
|= accumulator
>> 4; /* constant-time */
444 accumulator
|= accumulator
>> 2; /* boolean canonicalisation */
445 accumulator
|= accumulator
>> 1;
451 void util_module(dict_t
*dict
)
453 add_closure(dict
,"sysbuffer",buffer_apply
);
456 void update_max_start_pad(int32_t *our_module_global
, int32_t our_instance
)
458 if (*our_module_global
< our_instance
)
459 *our_module_global
=our_instance
;
462 int32_t transform_max_start_pad
, comm_max_start_pad
;
464 int32_t calculate_max_start_pad(void)
468 transform_max_start_pad
+
472 void vslilog_part(struct log_if
*lf
, int priority
, const char *message
, va_list ap
)
479 assert(bp
< LOG_MESSAGE_BUFLEN
);
480 vsnprintf(buff
+bp
,LOG_MESSAGE_BUFLEN
-bp
,message
,ap
);
481 buff
[LOG_MESSAGE_BUFLEN
-1] = '\n';
482 buff
[LOG_MESSAGE_BUFLEN
] = '\0';
483 /* Each line is sent separately */
484 while ((nlp
=strchr(buff
,'\n'))) {
486 slilog(lf
,priority
,"%s",buff
);
487 memmove(buff
,nlp
+1,strlen(nlp
+1)+1);
491 extern void slilog_part(struct log_if
*lf
, int priority
, const char *message
, ...)
494 va_start(ap
,message
);
495 vslilog_part(lf
,priority
,message
,ap
);
499 void string_item_to_iaddr(const item_t
*item
, uint16_t port
, union iaddr
*ia
,
504 ia
->sin
.sin_family
=AF_INET
;
505 ia
->sin
.sin_addr
.s_addr
=string_item_to_ipaddr(item
,desc
);
507 #else /* CONFIG_IPV6 => we have adns_text2addr */
509 if (item
->type
!=t_string
)
510 cfgfatal(item
->loc
,desc
,"expecting a string IP (v4 or v6) address\n");
511 socklen_t salen
=sizeof(*ia
);
512 int r
=adns_text2addr(item
->data
.string
, port
,
513 adns_qf_addrlit_ipv4_quadonly
,
516 if (r
) cfgfatal(item
->loc
,desc
,"invalid IP (v4 or v6) address: %s\n",
519 #endif /* CONFIG_IPV6 */
522 #define IADDR_NBUFS_SHIFT 3
523 #define IADDR_NBUFS (1 << IADDR_NBUFS_SHIFT)
525 const char *iaddr_to_string(const union iaddr
*ia
)
534 static char bufs
[IADDR_NBUFS
][100];
536 assert(ia
->sa
.sa_family
== AF_INET
);
538 snprintf(bufs
[b
], sizeof(bufs
[b
]), "[%s]:%d",
539 inet_ntoa(ia
->sin
.sin_addr
),
540 ntohs(ia
->sin
.sin_port
));
542 #else /* CONFIG_IPV6 => we have adns_addr2text */
544 static char bufs
[IADDR_NBUFS
][1+ADNS_ADDR2TEXT_BUFLEN
+20];
548 char *addrbuf
= bufs
[b
];
550 int addrbuflen
= ADNS_ADDR2TEXT_BUFLEN
;
552 int r
= adns_addr2text(&ia
->sa
, 0, addrbuf
, &addrbuflen
, &port
);
554 const char fmt
[]= "scoped IPv6 addr, error: %.*s";
555 sprintf(addrbuf
, fmt
,
556 ADNS_ADDR2TEXT_BUFLEN
- sizeof(fmt
) /* underestimate */,
560 char *portbuf
= addrbuf
;
561 int addrl
= strlen(addrbuf
);
564 snprintf(portbuf
, sizeof(bufs
[b
])-addrl
, "]:%d", port
);
566 #endif /* CONFIG_IPV6 */
571 bool_t
iaddr_equal(const union iaddr
*ia
, const union iaddr
*ib
)
573 if (ia
->sa
.sa_family
!= ib
->sa
.sa_family
)
575 switch (ia
->sa
.sa_family
) {
577 return ia
->sin
.sin_addr
.s_addr
== ib
->sin
.sin_addr
.s_addr
578 && ia
->sin
.sin_port
== ib
->sin
.sin_port
;
581 return !memcmp(&ia
->sin6
.sin6_addr
, &ib
->sin6
.sin6_addr
, 16)
582 && ia
->sin6
.sin6_scope_id
== ib
->sin6
.sin6_scope_id
583 && ia
->sin6
.sin6_port
== ib
->sin6
.sin6_port
584 /* we ignore the flowinfo field */;
585 #endif /* CONFIG_IPV6 */
591 int iaddr_socklen(const union iaddr
*ia
)
593 switch (ia
->sa
.sa_family
) {
594 case AF_INET
: return sizeof(ia
->sin
);
596 case AF_INET6
: return sizeof(ia
->sin6
);
597 #endif /* CONFIG_IPV6 */
602 enum async_linebuf_result
603 async_linebuf_read(struct pollfd
*pfd
, struct buffer_if
*buf
,
604 const char **emsg_out
)
606 int revents
=pfd
->revents
;
608 #define BAD(m) do{ *emsg_out=(m); return async_linebuf_broken; }while(0)
610 if (!(revents & b)) ; else BAD(#b)
613 /* POLLNVAL is handled by the event loop - see afterpoll_fn comment */
616 if (!(revents
& POLLIN
))
617 return async_linebuf_nothing
;
620 * Data structure: A line which has been returned to the user is
621 * stored in buf at base before start. But we retain the usual
622 * buffer meaning of size. So:
624 * | returned : | input read, | unused |
625 * | to user : \0 | awaiting | buffer |
626 * | : | processing | space |
628 * ^base ^start ^start+size ^base+alloclen
631 BUF_ASSERT_USED(buf
);
633 /* firstly, eat any previous */
634 if (buf
->start
!= buf
->base
) {
635 memmove(buf
->base
,buf
->start
,buf
->size
);
636 buf
->start
=buf
->base
;
639 uint8_t *searched
=buf
->base
;
642 * During the workings here we do not use start. We set start
643 * when we return some actual data. So we have this:
645 * | searched | read, might | unused |
646 * | for \n | contain \n | buffer |
647 * | none found | but not \0 | space |
649 * ^base ^searched ^base+size ^base+alloclen
654 uint8_t *dataend
=buf
->base
+buf
->size
;
655 char *newline
=memchr(searched
,'\n',dataend
-searched
);
658 buf
->start
=newline
+1;
659 buf
->size
=dataend
-buf
->start
;
660 return async_linebuf_ok
;
663 ssize_t space
=(buf
->base
+buf
->alloclen
)-dataend
;
664 if (!space
) BAD("input line too long");
665 ssize_t r
=read(pfd
->fd
,searched
,space
);
668 *emsg_out
=buf
->size?
"no newline at eof":0;
669 buf
->start
=searched
+1;
671 return async_linebuf_eof
;
676 if (iswouldblock(errno
))
677 return async_linebuf_nothing
;
678 BAD(strerror(errno
));
681 if (memchr(searched
,0,r
)) BAD("nul in input data");