-/* $Log: util.c,v $
- * Revision 1.2 1996/04/14 16:34:36 sde1000
- * Added syslog support
- * mpbin/mpstring functions moved from dh.c
- *
- * Revision 1.1 1996/03/14 17:05:03 sde1000
- * Initial revision
+/*
+ * util.c
+ * - output and logging support
+ * - program lifetime support
+ * - IP address and subnet munging routines
+ * - MPI convenience functions
+ */
+/*
+ * This file is
+ * Copyright (C) 1995--2001 Stephen Early <steve@greenend.org.uk>
*
+ * It is part of secnet, which is
+ * Copyright (C) 1995--2001 Stephen Early <steve@greenend.org.uk>
+ * Copyright (C) 1998 Ross Anderson, Eli Biham, Lars Knudsen
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2, or (at your option)
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
#include "secnet.h"
#include <limits.h>
#include <assert.h>
#include <sys/wait.h>
+#include <adns.h>
#include "util.h"
#include "unaligned.h"
+#include "magic.h"
+#include "ipaddr.h"
#define MIN_BUFFER_SIZE 64
#define DEFAULT_BUFFER_SIZE 4096
#define MAX_BUFFER_SIZE 131072
-static char *hexdigits="0123456789abcdef";
+static const char *hexdigits="0123456789abcdef";
-uint32_t message_level=M_WARNING|M_ERROR|M_FATAL;
-uint32_t syslog_level=M_WARNING|M_ERROR|M_FATAL;
-static uint32_t current_phase=0;
+uint32_t current_phase=0;
struct phase_hook {
hook_fn *fn;
static struct phase_hook *hooks[NR_PHASES]={NULL,};
-static void vMessage(uint32_t class, char *message, va_list args)
-{
- FILE *dest=stdout;
- if (class & message_level) {
- if (class&M_FATAL || class&M_ERROR || class&M_WARNING) {
- dest=stderr;
- }
- vfprintf(dest,message,args);
- }
-/* XXX do something about syslog output here */
-#if 0
- /* Maybe send message to syslog */
- vsprintf(buff, message, args);
- /* XXX Send each line as a separate log entry */
- log(syslog_prio[level], buff);
-#endif /* 0 */
-}
-
-void Message(uint32_t class, char *message, ...)
-{
- va_list ap;
-
- va_start(ap,message);
-
- vMessage(class,message,ap);
-
- va_end(ap);
-}
-
-static void vfatal(int status, bool_t perror, char *message, va_list args)
-{
- int err;
-
- err=errno;
-
- enter_phase(PHASE_SHUTDOWN);
- if (perror) {
- Message(M_FATAL, "secnet fatal error: ");
- vMessage(M_FATAL, message, args);
- Message(M_FATAL, ": %s\n",strerror(err));
- }
- else {
- Message(M_FATAL, "secnet fatal error: ");
- vMessage(M_FATAL,message,args);
- }
- exit(status);
-}
-
-void fatal(char *message, ...)
-{
- va_list args;
- va_start(args,message);
- vfatal(current_phase,False,message,args);
- va_end(args);
-}
-
-void fatal_status(int status, char *message, ...)
-{
- va_list args;
- va_start(args,message);
- vfatal(status,False,message,args);
- va_end(args);
-}
-
-void fatal_perror(char *message, ...)
-{
- va_list args;
- va_start(args,message);
- vfatal(current_phase,True,message,args);
- va_end(args);
-}
-
-void fatal_perror_status(int status, char *message, ...)
-{
- va_list args;
- va_start(args,message);
- vfatal(status,True,message,args);
- va_end(args);
-}
-
-void cfgfatal(struct cloc loc, string_t facility, char *message, ...)
-{
- va_list args;
-
- va_start(args,message);
-
- enter_phase(PHASE_SHUTDOWN);
-
- if (loc.file && loc.line) {
- Message(M_FATAL, "config error (%s, %s:%d): ",facility,loc.file,
- loc.line);
- } else if (!loc.file && loc.line) {
- Message(M_FATAL, "config error (%s, line %d): ",facility,loc.line);
- } else {
- Message(M_FATAL, "config error (%s): ",facility);
- }
-
- vMessage(M_FATAL,message,args);
- va_end(args);
- exit(current_phase);
-}
-
-char *safe_strdup(char *s, char *message)
+char *safe_strdup(const char *s, const char *message)
{
char *d;
d=strdup(s);
if (!d) {
- fatal_perror(message);
+ fatal_perror("%s",message);
}
return d;
}
-void *safe_malloc(size_t size, char *message)
+void *safe_malloc(size_t size, const char *message)
{
void *r;
r=malloc(size);
if (!r) {
- fatal_perror(message);
+ fatal_perror("%s",message);
}
return r;
}
+void *safe_malloc_ary(size_t size, size_t count, const char *message) {
+ if (count >= INT_MAX/size) {
+ fatal("array allocation overflow: %s", message);
+ }
+ return safe_malloc(size*count, message);
+}
/* Convert a buffer into its MP_INT representation */
void read_mpbin(MP_INT *a, uint8_t *bin, int binsize)
}
/* Convert a MP_INT into a buffer; return length; truncate if necessary */
-uint32_t write_mpbin(MP_INT *a, uint8_t *buffer, uint32_t buflen)
+int32_t write_mpbin(MP_INT *a, uint8_t *buffer, int32_t buflen)
{
char *hb;
int i,j,l;
return i;
}
-bool_t subnet_match(struct subnet *s, uint32_t address)
-{
- return (s->prefix==(address&s->mask));
-}
-
-bool_t subnet_matches_list(struct subnet_list *list, uint32_t address)
-{
- uint32_t i;
- for (i=0; i<list->entries; i++) {
- if (list->list[i].prefix == (address&list->list[i].mask)) return True;
- }
- return False;
-}
-
-bool_t subnets_intersect(struct subnet a, struct subnet b)
-{
- uint32_t mask=a.mask&b.mask;
- return ((a.prefix&mask)==(b.prefix&mask));
-}
-
-bool_t subnet_intersects_with_list(struct subnet a, struct subnet_list *b)
-{
- uint32_t i;
-
- for (i=0; i<b->entries; i++) {
- if (subnets_intersect(a,b->list[i])) return True;
- }
- return False;
-}
-
-bool_t subnet_lists_intersect(struct subnet_list *a, struct subnet_list *b)
-{
- uint32_t i;
- for (i=0; i<a->entries; i++) {
- if (subnet_intersects_with_list(a->list[i],b)) return True;
- }
- return False;
-}
-
-/* The string buffer must be at least 16 bytes long */
-string_t ipaddr_to_string(uint32_t addr)
-{
- uint8_t a,b,c,d;
- string_t s;
-
- s=safe_malloc(16,"ipaddr_to_string");
- a=addr>>24;
- b=addr>>16;
- c=addr>>8;
- d=addr;
- snprintf(s, 16, "%d.%d.%d.%d", a, b, c, d);
- return s;
+void setcloexec(int fd) {
+ int r=fcntl(fd, F_GETFD);
+ if (r<0) fatal_perror("fcntl(,F_GETFD) failed");
+ r=fcntl(fd, F_SETFD, r|FD_CLOEXEC);
+ if (r<0) fatal_perror("fcntl(,F_SETFD,|FD_CLOEXEC) failed");
}
-string_t subnet_to_string(struct subnet *sn)
-{
- uint32_t mask=sn->mask, addr=sn->prefix;
- uint8_t a,b,c,d;
- string_t s;
- int i;
-
- s=safe_malloc(19,"subnet_to_string");
- a=addr>>24;
- b=addr>>16;
- c=addr>>8;
- d=addr;
- for (i=0; mask; i++) {
- mask=(mask<<1);
- }
- if (i!=sn->len) {
- fatal("subnet_to_string: invalid subnet structure!\n");
- }
- snprintf(s, 19, "%d.%d.%d.%d/%d", a, b, c, d, sn->len);
- return s;
+void pipe_cloexec(int fd[2]) {
+ int r=pipe(fd);
+ if (r) fatal_perror("pipe");
+ setcloexec(fd[0]);
+ setcloexec(fd[1]);
}
-int sys_cmd(const char *path, char *arg, ...)
-{
- va_list ap;
- int rv;
- pid_t c;
-
- va_start(ap,arg);
- c=fork();
- if (c) {
- /* Parent -> wait for child */
- waitpid(c,&rv,0);
- } else if (c==0) {
- char *args[100];
- int i;
- /* Child -> exec command */
- args[0]=arg;
- i=1;
- while ((args[i++]=va_arg(ap,char *)));
- execvp(path,args);
- exit(1);
- } else {
- /* Error */
- fatal_perror("sys_cmd(%s,%s,...)");
- }
-
- va_end(ap);
- return rv;
-}
-
-/* Take a list of log closures and merge them */
-struct loglist {
- struct log_if *l;
- struct loglist *next;
-};
-
-static void log_vmulti(void *state, int priority, char *message, va_list args)
-{
- struct loglist *st=state, *i;
-
- for (i=st; i; i=i->next) {
- i->l->vlog(i->l->st,priority,message,args);
- }
-}
-
-static void log_multi(void *st, int priority, char *message, ...)
-{
- va_list ap;
-
- va_start(ap,message);
-
- log_vmulti(st,priority,message,ap);
-
- va_end(ap);
-}
-
-struct log_if *init_log(list_t *ll)
-{
- int i=0;
- item_t *item;
- closure_t *cl;
- struct loglist *l=NULL, *n;
- struct log_if *r;
-
- while ((item=list_elem(ll,i++))) {
- if (item->type!=t_closure) {
- cfgfatal(item->loc,"init_log","item is not a closure");
- }
- cl=item->data.closure;
- if (cl->type!=CL_LOG) {
- cfgfatal(item->loc,"init_log","closure is not a logger");
- }
- n=safe_malloc(sizeof(*n),"init_log");
- n->l=cl->interface;
- n->next=l;
- l=n;
- }
- if (!l) {
- fatal("init_log: none of the items in the list are loggers");
- }
- r=safe_malloc(sizeof(*r), "init_log");
- r->st=l;
- r->log=log_multi;
- r->vlog=log_vmulti;
- return r;
-}
-
-struct logfile {
- closure_t cl;
- struct log_if ops;
- FILE *f;
-};
-
-static void logfile_vlog(void *state, int priority, char *message,
- va_list args)
-{
- struct logfile *st=state;
-
- vfprintf(st->f,message,args);
- fprintf(st->f,"\n");
-}
-
-static void logfile_log(void *state, int priority, char *message, ...)
-{
- va_list ap;
-
- va_start(ap,message);
- logfile_vlog(state,priority,message,ap);
- va_end(ap);
-}
-
-static list_t *logfile_apply(closure_t *self, struct cloc loc, dict_t *context,
- list_t *data)
-{
- struct logfile *st;
-
- st=safe_malloc(sizeof(*st),"logfile_apply");
- st->cl.description="logfile";
- st->cl.type=CL_LOG;
- st->cl.apply=NULL;
- st->cl.interface=&st->ops;
- st->ops.st=st;
- st->ops.log=logfile_log;
- st->ops.vlog=logfile_vlog;
- st->f=stderr; /* XXX ignore args */
-
- return new_closure(&st->cl);
-}
-
-static char *phases[NR_PHASES]={
+static const char *phases[NR_PHASES]={
"PHASE_INIT",
"PHASE_GETOPTS",
"PHASE_READCONFIG",
"PHASE_SETUP",
+ "PHASE_DAEMONIZE",
"PHASE_GETRESOURCES",
"PHASE_DROPPRIV",
"PHASE_RUN",
bool_t remove_hook(uint32_t phase, hook_fn *fn, void *state)
{
- fatal("remove_hook: not implemented\n");
+ fatal("remove_hook: not implemented");
return False;
}
-void log(struct log_if *lf, int priority, char *message, ...)
+void vslilog(struct log_if *lf, int priority, const char *message, va_list ap)
+{
+ lf->vlogfn(lf->st,priority,message,ap);
+}
+
+void slilog(struct log_if *lf, int priority, const char *message, ...)
{
va_list ap;
va_start(ap,message);
- lf->vlog(lf->st,priority,message,ap);
+ vslilog(lf,priority,message,ap);
va_end(ap);
}
struct buffer_if ops;
};
-void buffer_assert_free(struct buffer_if *buffer, string_t file, uint32_t line)
+void buffer_assert_free(struct buffer_if *buffer, cstring_t file,
+ int line)
{
if (!buffer->free) {
- fatal("BUF_ASSERT_FREE, %s line %d, owned by %s\n",
- file,line,buffer->owner);
+ fprintf(stderr,"secnet: BUF_ASSERT_FREE, %s line %d, owned by %s",
+ file,line,buffer->owner);
+ assert(!"buffer_assert_free failure");
}
}
-void buffer_assert_used(struct buffer_if *buffer, string_t file, uint32_t line)
+void buffer_assert_used(struct buffer_if *buffer, cstring_t file,
+ int line)
{
if (buffer->free) {
- fatal("BUF_ASSERT_USED, %s line %d, last owned by %s\n",
- file,line,buffer->owner);
+ fprintf(stderr,"secnet: BUF_ASSERT_USED, %s line %d, last owned by %s",
+ file,line,buffer->owner);
+ assert(!"buffer_assert_used failure");
}
}
-void buffer_init(struct buffer_if *buffer, uint32_t max_start_pad)
+void buffer_init(struct buffer_if *buffer, int32_t max_start_pad)
{
+ assert(max_start_pad<=buffer->alloclen);
buffer->start=buffer->base+max_start_pad;
buffer->size=0;
}
-void *buf_append(struct buffer_if *buf, uint32_t amount) {
+void *buf_append(struct buffer_if *buf, int32_t amount) {
void *p;
+ assert(amount <= buf_remaining_space(buf));
p=buf->start + buf->size;
buf->size+=amount;
return p;
}
-void *buf_prepend(struct buffer_if *buf, uint32_t amount) {
+void *buf_prepend(struct buffer_if *buf, int32_t amount) {
+ assert(amount <= buf->start - buf->base);
buf->size+=amount;
return buf->start-=amount;
}
-void *buf_unappend(struct buffer_if *buf, uint32_t amount) {
+void *buf_unappend(struct buffer_if *buf, int32_t amount) {
if (buf->size < amount) return 0;
return buf->start+(buf->size-=amount);
}
-void *buf_unprepend(struct buffer_if *buf, uint32_t amount) {
+void *buf_unprepend(struct buffer_if *buf, int32_t amount) {
void *p;
+ if (buf->size < amount) return 0;
p=buf->start;
buf->start+=amount;
buf->size-=amount;
/* Append a two-byte length and the string to the buffer. Length is in
network byte order. */
-void buf_append_string(struct buffer_if *buf, string_t s)
+void buf_append_string(struct buffer_if *buf, cstring_t s)
{
- uint16_t len;
+ size_t len;
len=strlen(s);
+ /* fixme: if string is longer than 65535, result is a corrupted packet */
buf_append_uint16(buf,len);
- memcpy(buf_append(buf,len),s,len);
+ BUF_ADD_BYTES(append,buf,s,len);
}
-void buffer_new(struct buffer_if *buf, uint32_t len)
+void buffer_new(struct buffer_if *buf, int32_t len)
{
buf->free=True;
buf->owner=NULL;
buf->loc.file=NULL;
buf->loc.line=0;
buf->size=0;
- buf->len=len;
+ buf->alloclen=len;
buf->start=NULL;
buf->base=safe_malloc(len,"buffer_new");
}
+void buffer_readonly_view(struct buffer_if *buf, const void *data, int32_t len)
+{
+ buf->free=False;
+ buf->owner="READONLY";
+ buf->flags=0;
+ buf->loc.file=NULL;
+ buf->loc.line=0;
+ buf->size=buf->alloclen=len;
+ buf->base=buf->start=(uint8_t*)data;
+}
+
+void buffer_readonly_clone(struct buffer_if *out, const struct buffer_if *in)
+{
+ buffer_readonly_view(out,in->start,in->size);
+}
+
+void buffer_copy(struct buffer_if *dst, const struct buffer_if *src)
+{
+ if (dst->alloclen < src->alloclen) {
+ dst->base=realloc(dst->base,src->alloclen);
+ if (!dst->base) fatal_perror("buffer_copy");
+ dst->alloclen = src->alloclen;
+ }
+ dst->start = dst->base + (src->start - src->base);
+ dst->size = src->size;
+ memcpy(dst->start, src->start, dst->size);
+}
+
static list_t *buffer_apply(closure_t *self, struct cloc loc, dict_t *context,
list_t *args)
{
return new_closure(&st->cl);
}
-init_module util_module;
+void send_nak(const struct comm_addr *dest, uint32_t our_index,
+ uint32_t their_index, uint32_t msgtype,
+ struct buffer_if *buf, const char *logwhy)
+{
+ buffer_init(buf,calculate_max_start_pad());
+ buf_append_uint32(buf,their_index);
+ buf_append_uint32(buf,our_index);
+ buf_append_uint32(buf,LABEL_NAK);
+ if (logwhy)
+ Message(M_INFO,"%s: %08"PRIx32"<-%08"PRIx32": %08"PRIx32":"
+ " %s; sending NAK\n",
+ comm_addr_to_string(dest),
+ our_index, their_index, msgtype, logwhy);
+ dest->comm->sendmsg(dest->comm->st, buf, dest);
+}
+
+int consttime_memeq(const void *s1in, const void *s2in, size_t n)
+{
+ const uint8_t *s1=s1in, *s2=s2in;
+ register volatile uint8_t accumulator=0;
+
+ while (n-- > 0) {
+ accumulator |= (*s1++ ^ *s2++);
+ }
+ accumulator |= accumulator >> 4; /* constant-time */
+ accumulator |= accumulator >> 2; /* boolean canonicalisation */
+ accumulator |= accumulator >> 1;
+ accumulator &= 1;
+ accumulator ^= 1;
+ return accumulator;
+}
+
void util_module(dict_t *dict)
{
- add_closure(dict,"logfile",logfile_apply);
add_closure(dict,"sysbuffer",buffer_apply);
}
+
+void update_max_start_pad(int32_t *our_module_global, int32_t our_instance)
+{
+ if (*our_module_global < our_instance)
+ *our_module_global=our_instance;
+}
+
+int32_t transform_max_start_pad, comm_max_start_pad;
+
+int32_t calculate_max_start_pad(void)
+{
+ return
+ site_max_start_pad +
+ transform_max_start_pad +
+ comm_max_start_pad;
+}
+
+void vslilog_part(struct log_if *lf, int priority, const char *message, va_list ap)
+{
+ char *buff=lf->buff;
+ size_t bp;
+ char *nlp;
+
+ bp=strlen(buff);
+ assert(bp < LOG_MESSAGE_BUFLEN);
+ vsnprintf(buff+bp,LOG_MESSAGE_BUFLEN-bp,message,ap);
+ buff[LOG_MESSAGE_BUFLEN-1] = '\n';
+ buff[LOG_MESSAGE_BUFLEN] = '\0';
+ /* Each line is sent separately */
+ while ((nlp=strchr(buff,'\n'))) {
+ *nlp=0;
+ slilog(lf,priority,"%s",buff);
+ memmove(buff,nlp+1,strlen(nlp+1)+1);
+ }
+}
+
+extern void slilog_part(struct log_if *lf, int priority, const char *message, ...)
+{
+ va_list ap;
+ va_start(ap,message);
+ vslilog_part(lf,priority,message,ap);
+ va_end(ap);
+}
+
+void string_item_to_iaddr(const item_t *item, uint16_t port, union iaddr *ia,
+ const char *desc)
+{
+#ifndef CONFIG_IPV6
+
+ ia->sin.sin_family=AF_INET;
+ ia->sin.sin_addr.s_addr=string_item_to_ipaddr(item,desc);
+
+#else /* CONFIG_IPV6 => we have adns_text2addr */
+
+ if (item->type!=t_string)
+ cfgfatal(item->loc,desc,"expecting a string IP (v4 or v6) address\n");
+ socklen_t salen=sizeof(*ia);
+ int r=adns_text2addr(item->data.string, port,
+ adns_qf_addrlit_ipv4_quadonly,
+ &ia->sa, &salen);
+ assert(r!=ENOSPC);
+ if (r) cfgfatal(item->loc,desc,"invalid IP (v4 or v6) address: %s\n",
+ strerror(r));
+
+#endif /* CONFIG_IPV6 */
+}
+
+#define IADDR_NBUFS_SHIFT 3
+#define IADDR_NBUFS (1 << IADDR_NBUFS_SHIFT)
+
+const char *iaddr_to_string(const union iaddr *ia)
+{
+ static int b;
+
+ b++;
+ b &= IADDR_NBUFS-1;
+
+#ifndef CONFIG_IPV6
+
+ static char bufs[IADDR_NBUFS][100];
+
+ assert(ia->sa.sa_family == AF_INET);
+
+ snprintf(bufs[b], sizeof(bufs[b]), "[%s]:%d",
+ inet_ntoa(ia->sin.sin_addr),
+ ntohs(ia->sin.sin_port));
+
+#else /* CONFIG_IPV6 => we have adns_addr2text */
+
+ static char bufs[IADDR_NBUFS][1+ADNS_ADDR2TEXT_BUFLEN+20];
+
+ int port;
+
+ char *addrbuf = bufs[b];
+ *addrbuf++ = '[';
+ int addrbuflen = ADNS_ADDR2TEXT_BUFLEN;
+
+ int r = adns_addr2text(&ia->sa, 0, addrbuf, &addrbuflen, &port);
+ if (r) {
+ const char fmt[]= "scoped IPv6 addr, error: %.*s";
+ sprintf(addrbuf, fmt,
+ ADNS_ADDR2TEXT_BUFLEN - sizeof(fmt) /* underestimate */,
+ strerror(r));
+ }
+
+ char *portbuf = addrbuf;
+ int addrl = strlen(addrbuf);
+ portbuf += addrl;
+
+ snprintf(portbuf, sizeof(bufs[b])-addrl, "]:%d", port);
+
+#endif /* CONFIG_IPV6 */
+
+ return bufs[b];
+}
+
+bool_t iaddr_equal(const union iaddr *ia, const union iaddr *ib)
+{
+ if (ia->sa.sa_family != ib->sa.sa_family)
+ return 0;
+ switch (ia->sa.sa_family) {
+ case AF_INET:
+ return ia->sin.sin_addr.s_addr == ib->sin.sin_addr.s_addr
+ && ia->sin.sin_port == ib->sin.sin_port;
+#ifdef CONFIG_IPV6
+ case AF_INET6:
+ return !memcmp(&ia->sin6.sin6_addr, &ib->sin6.sin6_addr, 16)
+ && ia->sin6.sin6_scope_id == ib->sin6.sin6_scope_id
+ && ia->sin6.sin6_port == ib->sin6.sin6_port
+ /* we ignore the flowinfo field */;
+#endif /* CONFIG_IPV6 */
+ default:
+ abort();
+ }
+}
+
+int iaddr_socklen(const union iaddr *ia)
+{
+ switch (ia->sa.sa_family) {
+ case AF_INET: return sizeof(ia->sin);
+#ifdef CONFIG_IPV6
+ case AF_INET6: return sizeof(ia->sin6);
+#endif /* CONFIG_IPV6 */
+ default: abort();
+ }
+}