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.
40 #include "unaligned.h"
43 #define MIN_BUFFER_SIZE 64
44 #define DEFAULT_BUFFER_SIZE 4096
45 #define MAX_BUFFER_SIZE 131072
47 static const char *hexdigits="0123456789abcdef";
49 uint32_t current_phase=0;
54 struct phase_hook *next;
57 static struct phase_hook *hooks[NR_PHASES]={NULL,};
59 char *safe_strdup(const char *s, const char *message)
64 fatal_perror("%s",message);
69 void *safe_malloc(size_t size, const char *message)
74 fatal_perror("%s",message);
78 void *safe_malloc_ary(size_t size, size_t count, const char *message) {
79 if (count >= INT_MAX/size) {
80 fatal("array allocation overflow: %s", message);
82 return safe_malloc(size*count, message);
85 /* Convert a buffer into its MP_INT representation */
86 void read_mpbin(MP_INT *a, uint8_t *bin, int binsize)
91 buff=safe_malloc(binsize*2 + 1,"read_mpbin");
93 for (i=0; i<binsize; i++) {
94 buff[i*2]=hexdigits[(bin[i] & 0xf0) >> 4];
95 buff[i*2+1]=hexdigits[(bin[i] & 0xf)];
99 mpz_set_str(a, buff, 16);
103 /* Convert a MP_INT into a hex string */
104 char *write_mpstring(MP_INT *a)
108 buff=safe_malloc(mpz_sizeinbase(a,16)+2,"write_mpstring");
109 mpz_get_str(buff, 16, a);
113 static uint8_t hexval(uint8_t c)
142 /* Convert a MP_INT into a buffer; return length; truncate if necessary */
143 int32_t write_mpbin(MP_INT *a, uint8_t *buffer, int32_t buflen)
148 if (buflen==0) return 0;
149 hb=write_mpstring(a);
154 /* The number starts with a half-byte */
155 buffer[i++]=hexval(hb[j++]);
157 for (; hb[j] && i<buflen; i++) {
158 buffer[i]=(hexval(hb[j])<<4)|hexval(hb[j+1]);
165 void setcloexec(int fd) {
166 int r=fcntl(fd, F_GETFD);
167 if (r<0) fatal_perror("fcntl(,F_GETFD) failed");
169 r=fcntl(fd, F_SETFD, r|FD_CLOEXEC);
170 if (r<0) fatal_perror("fcntl(,F_SETFD,|FD_CLOEXEC) failed");
173 void pipe_cloexec(int fd[2]) {
175 if (r) fatal_perror("pipe");
180 static const char *phases[NR_PHASES]={
186 "PHASE_GETRESOURCES",
192 void enter_phase(uint32_t new_phase)
194 struct phase_hook *i;
196 if (hooks[new_phase])
197 Message(M_DEBUG_PHASE,"Running hooks for %s...\n", phases[new_phase]);
198 current_phase=new_phase;
200 for (i=hooks[new_phase]; i; i=i->next)
201 i->fn(i->state, new_phase);
202 Message(M_DEBUG_PHASE,"Now in %s\n",phases[new_phase]);
205 bool_t add_hook(uint32_t phase, hook_fn *fn, void *state)
207 struct phase_hook *h;
209 h=safe_malloc(sizeof(*h),"add_hook");
212 h->next=hooks[phase];
217 bool_t remove_hook(uint32_t phase, hook_fn *fn, void *state)
219 fatal("remove_hook: not implemented");
224 void vslilog(struct log_if *lf, int priority, const char *message, va_list ap)
226 lf->vlogfn(lf->st,priority,message,ap);
229 void slilog(struct log_if *lf, int priority, const char *message, ...)
233 va_start(ap,message);
234 vslilog(lf,priority,message,ap);
240 struct buffer_if ops;
243 void buffer_assert_free(struct buffer_if *buffer, cstring_t file,
247 fprintf(stderr,"secnet: BUF_ASSERT_FREE, %s line %d, owned by %s",
248 file,line,buffer->owner);
249 assert(!"buffer_assert_free failure");
253 void buffer_assert_used(struct buffer_if *buffer, cstring_t file,
257 fprintf(stderr,"secnet: BUF_ASSERT_USED, %s line %d, last owned by %s",
258 file,line,buffer->owner);
259 assert(!"buffer_assert_used failure");
263 void buffer_init(struct buffer_if *buffer, int32_t max_start_pad)
265 assert(max_start_pad<=buffer->alloclen);
266 buffer->start=buffer->base+max_start_pad;
270 void *buf_append(struct buffer_if *buf, int32_t amount) {
272 assert(amount <= buf_remaining_space(buf));
273 p=buf->start + buf->size;
278 void *buf_prepend(struct buffer_if *buf, int32_t amount) {
279 assert(amount <= buf->start - buf->base);
281 return buf->start-=amount;
284 void *buf_unappend(struct buffer_if *buf, int32_t amount) {
285 if (buf->size < amount) return 0;
286 return buf->start+(buf->size-=amount);
289 void *buf_unprepend(struct buffer_if *buf, int32_t amount) {
291 if (buf->size < amount) return 0;
298 /* Append a two-byte length and the string to the buffer. Length is in
299 network byte order. */
300 void buf_append_string(struct buffer_if *buf, cstring_t s)
305 /* fixme: if string is longer than 65535, result is a corrupted packet */
306 buf_append_uint16(buf,len);
307 memcpy(buf_append(buf,len),s,len);
310 void buffer_new(struct buffer_if *buf, int32_t len)
320 buf->base=safe_malloc(len,"buffer_new");
323 void buffer_readonly_view(struct buffer_if *buf, const void *data, int32_t len)
326 buf->owner="READONLY";
330 buf->size=buf->alloclen=len;
331 buf->base=buf->start=(uint8_t*)data;
334 void buffer_readonly_clone(struct buffer_if *out, const struct buffer_if *in)
336 buffer_readonly_view(out,in->start,in->size);
339 void buffer_copy(struct buffer_if *dst, const struct buffer_if *src)
341 if (dst->alloclen < src->alloclen) {
342 dst->base=realloc(dst->base,src->alloclen);
343 if (!dst->base) fatal_perror("buffer_copy");
344 dst->alloclen = src->alloclen;
346 dst->start = dst->base + (src->start - src->base);
347 dst->size = src->size;
348 memcpy(dst->start, src->start, dst->size);
351 static list_t *buffer_apply(closure_t *self, struct cloc loc, dict_t *context,
357 bool_t lockdown=False;
358 uint32_t len=DEFAULT_BUFFER_SIZE;
360 st=safe_malloc(sizeof(*st),"buffer_apply");
361 st->cl.description="buffer";
362 st->cl.type=CL_BUFFER;
364 st->cl.interface=&st->ops;
366 /* First argument, if present, is buffer length */
367 item=list_elem(args,0);
369 if (item->type!=t_number) {
370 cfgfatal(st->ops.loc,"buffer","first parameter must be a "
371 "number (buffer size)\n");
373 len=item->data.number;
374 if (len<MIN_BUFFER_SIZE) {
375 cfgfatal(st->ops.loc,"buffer","ludicrously small buffer size\n");
377 if (len>MAX_BUFFER_SIZE) {
378 cfgfatal(st->ops.loc,"buffer","ludicrously large buffer size\n");
381 /* Second argument, if present, is a dictionary */
382 item=list_elem(args,1);
384 if (item->type!=t_dict) {
385 cfgfatal(st->ops.loc,"buffer","second parameter must be a "
388 dict=item->data.dict;
389 lockdown=dict_read_bool(dict,"lockdown",False,"buffer",st->ops.loc,
393 buffer_new(&st->ops,len);
395 /* XXX mlock the buffer if possible */
398 return new_closure(&st->cl);
401 void send_nak(const struct comm_addr *dest, uint32_t our_index,
402 uint32_t their_index, uint32_t msgtype,
403 struct buffer_if *buf, const char *logwhy)
405 buffer_init(buf,calculate_max_start_pad());
406 buf_append_uint32(buf,their_index);
407 buf_append_uint32(buf,our_index);
408 buf_append_uint32(buf,LABEL_NAK);
410 Message(M_INFO,"%s: %08"PRIx32"<-%08"PRIx32": %08"PRIx32":"
411 " %s; sending NAK\n",
412 comm_addr_to_string(dest),
413 our_index, their_index, msgtype, logwhy);
414 dest->comm->sendmsg(dest->comm->st, buf, dest);
417 int consttime_memeq(const void *s1in, const void *s2in, size_t n)
419 const uint8_t *s1=s1in, *s2=s2in;
420 register volatile uint8_t accumulator=0;
423 accumulator |= (*s1++ ^ *s2++);
425 accumulator |= accumulator >> 4; /* constant-time */
426 accumulator |= accumulator >> 2; /* boolean canonicalisation */
427 accumulator |= accumulator >> 1;
433 void util_module(dict_t *dict)
435 add_closure(dict,"sysbuffer",buffer_apply);
438 void update_max_start_pad(int32_t *our_module_global, int32_t our_instance)
440 if (*our_module_global < our_instance)
441 *our_module_global=our_instance;
444 int32_t transform_max_start_pad, comm_max_start_pad;
446 int32_t calculate_max_start_pad(void)
450 transform_max_start_pad +
454 void vslilog_part(struct log_if *lf, int priority, const char *message, va_list ap)
461 assert(bp < LOG_MESSAGE_BUFLEN);
462 vsnprintf(buff+bp,LOG_MESSAGE_BUFLEN-bp,message,ap);
463 buff[LOG_MESSAGE_BUFLEN-1] = '\n';
464 buff[LOG_MESSAGE_BUFLEN] = '\0';
465 /* Each line is sent separately */
466 while ((nlp=strchr(buff,'\n'))) {
468 slilog(lf,priority,"%s",buff);
469 memmove(buff,nlp+1,strlen(nlp+1)+1);
473 extern void slilog_part(struct log_if *lf, int priority, const char *message, ...)
476 va_start(ap,message);
477 vslilog_part(lf,priority,message,ap);