Commit | Line | Data |
---|---|---|
b2a56f7c SE |
1 | /* |
2 | * util.c | |
3 | * - output and logging support | |
4 | * - program lifetime support | |
5 | * - IP address and subnet munging routines | |
6 | * - MPI convenience functions | |
7 | */ | |
8 | /* | |
9 | * This file is | |
10 | * Copyright (C) 1995--2001 Stephen Early <steve@greenend.org.uk> | |
2fe58dfd | 11 | * |
b2a56f7c SE |
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 | |
15 | * | |
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) | |
19 | * any later version. | |
20 | * | |
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. | |
25 | * | |
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. | |
2fe58dfd SE |
29 | */ |
30 | ||
8689b3a9 | 31 | #include "secnet.h" |
2fe58dfd | 32 | #include <stdio.h> |
2fe58dfd SE |
33 | #include <string.h> |
34 | #include <errno.h> | |
2fe58dfd | 35 | #include <unistd.h> |
59635212 | 36 | #include <limits.h> |
2fe58dfd | 37 | #include <assert.h> |
4efd681a | 38 | #include <sys/wait.h> |
2fe58dfd | 39 | #include "util.h" |
59635212 | 40 | #include "unaligned.h" |
8534d602 | 41 | #include "magic.h" |
2fe58dfd SE |
42 | |
43 | #define MIN_BUFFER_SIZE 64 | |
44 | #define DEFAULT_BUFFER_SIZE 4096 | |
45 | #define MAX_BUFFER_SIZE 131072 | |
46 | ||
fe5e9cc4 | 47 | static const char *hexdigits="0123456789abcdef"; |
2fe58dfd | 48 | |
7138d0c5 | 49 | uint32_t current_phase=0; |
2fe58dfd SE |
50 | |
51 | struct phase_hook { | |
52 | hook_fn *fn; | |
53 | void *state; | |
54 | struct phase_hook *next; | |
55 | }; | |
56 | ||
57 | static struct phase_hook *hooks[NR_PHASES]={NULL,}; | |
58 | ||
fe5e9cc4 | 59 | char *safe_strdup(const char *s, const char *message) |
2fe58dfd SE |
60 | { |
61 | char *d; | |
62 | d=strdup(s); | |
63 | if (!d) { | |
779837e1 | 64 | fatal_perror("%s",message); |
2fe58dfd SE |
65 | } |
66 | return d; | |
67 | } | |
68 | ||
fe5e9cc4 | 69 | void *safe_malloc(size_t size, const char *message) |
2fe58dfd SE |
70 | { |
71 | void *r; | |
72 | r=malloc(size); | |
73 | if (!r) { | |
779837e1 | 74 | fatal_perror("%s",message); |
2fe58dfd SE |
75 | } |
76 | return r; | |
77 | } | |
bb9d0561 IJ |
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); | |
81 | } | |
82 | return safe_malloc(size*count, message); | |
83 | } | |
2fe58dfd SE |
84 | |
85 | /* Convert a buffer into its MP_INT representation */ | |
86 | void read_mpbin(MP_INT *a, uint8_t *bin, int binsize) | |
87 | { | |
88 | char *buff; | |
89 | int i; | |
90 | ||
91 | buff=safe_malloc(binsize*2 + 1,"read_mpbin"); | |
92 | ||
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)]; | |
96 | } | |
97 | buff[binsize*2]=0; | |
98 | ||
99 | mpz_set_str(a, buff, 16); | |
100 | free(buff); | |
101 | } | |
102 | ||
103 | /* Convert a MP_INT into a hex string */ | |
104 | char *write_mpstring(MP_INT *a) | |
105 | { | |
106 | char *buff; | |
107 | ||
108 | buff=safe_malloc(mpz_sizeinbase(a,16)+2,"write_mpstring"); | |
109 | mpz_get_str(buff, 16, a); | |
110 | return buff; | |
111 | } | |
112 | ||
113 | static uint8_t hexval(uint8_t c) | |
114 | { | |
115 | switch (c) { | |
116 | case '0': return 0; | |
117 | case '1': return 1; | |
118 | case '2': return 2; | |
119 | case '3': return 3; | |
120 | case '4': return 4; | |
121 | case '5': return 5; | |
122 | case '6': return 6; | |
123 | case '7': return 7; | |
124 | case '8': return 8; | |
125 | case '9': return 9; | |
126 | case 'a': return 10; | |
127 | case 'A': return 10; | |
128 | case 'b': return 11; | |
129 | case 'B': return 11; | |
130 | case 'c': return 12; | |
131 | case 'C': return 12; | |
132 | case 'd': return 13; | |
133 | case 'D': return 13; | |
134 | case 'e': return 14; | |
135 | case 'E': return 14; | |
136 | case 'f': return 15; | |
137 | case 'F': return 15; | |
138 | } | |
139 | return -1; | |
140 | } | |
141 | ||
142 | /* Convert a MP_INT into a buffer; return length; truncate if necessary */ | |
1caa23ff | 143 | int32_t write_mpbin(MP_INT *a, uint8_t *buffer, int32_t buflen) |
2fe58dfd SE |
144 | { |
145 | char *hb; | |
146 | int i,j,l; | |
147 | ||
148 | if (buflen==0) return 0; | |
149 | hb=write_mpstring(a); | |
150 | ||
151 | l=strlen(hb); | |
152 | i=0; j=0; | |
153 | if (l&1) { | |
154 | /* The number starts with a half-byte */ | |
155 | buffer[i++]=hexval(hb[j++]); | |
156 | } | |
157 | for (; hb[j] && i<buflen; i++) { | |
158 | buffer[i]=(hexval(hb[j])<<4)|hexval(hb[j+1]); | |
159 | j+=2; | |
160 | } | |
161 | free(hb); | |
162 | return i; | |
163 | } | |
164 | ||
4fb0f88d IJ |
165 | void setcloexec(int fd) { |
166 | int r=fcntl(fd, F_GETFD); | |
167 | if (r<0) fatal_perror("fcntl(,F_GETFD) failed"); | |
168 | r=fcntl(fd, F_SETFD, r|FD_CLOEXEC); | |
169 | if (r<0) fatal_perror("fcntl(,F_SETFD,|FD_CLOEXEC) failed"); | |
170 | } | |
171 | ||
fe5e9cc4 | 172 | static const char *phases[NR_PHASES]={ |
2fe58dfd SE |
173 | "PHASE_INIT", |
174 | "PHASE_GETOPTS", | |
175 | "PHASE_READCONFIG", | |
176 | "PHASE_SETUP", | |
7b1a9fb7 | 177 | "PHASE_DAEMONIZE", |
baa06aeb | 178 | "PHASE_GETRESOURCES", |
2fe58dfd SE |
179 | "PHASE_DROPPRIV", |
180 | "PHASE_RUN", | |
181 | "PHASE_SHUTDOWN" | |
182 | }; | |
183 | ||
184 | void enter_phase(uint32_t new_phase) | |
185 | { | |
186 | struct phase_hook *i; | |
187 | ||
baa06aeb SE |
188 | if (hooks[new_phase]) |
189 | Message(M_DEBUG_PHASE,"Running hooks for %s...\n", phases[new_phase]); | |
2fe58dfd SE |
190 | current_phase=new_phase; |
191 | ||
192 | for (i=hooks[new_phase]; i; i=i->next) | |
193 | i->fn(i->state, new_phase); | |
baa06aeb | 194 | Message(M_DEBUG_PHASE,"Now in %s\n",phases[new_phase]); |
2fe58dfd SE |
195 | } |
196 | ||
197 | bool_t add_hook(uint32_t phase, hook_fn *fn, void *state) | |
198 | { | |
199 | struct phase_hook *h; | |
200 | ||
201 | h=safe_malloc(sizeof(*h),"add_hook"); | |
202 | h->fn=fn; | |
203 | h->state=state; | |
204 | h->next=hooks[phase]; | |
205 | hooks[phase]=h; | |
206 | return True; | |
207 | } | |
208 | ||
209 | bool_t remove_hook(uint32_t phase, hook_fn *fn, void *state) | |
210 | { | |
4f5e39ec | 211 | fatal("remove_hook: not implemented"); |
2fe58dfd SE |
212 | |
213 | return False; | |
214 | } | |
215 | ||
59938e0e IJ |
216 | void vslilog(struct log_if *lf, int priority, const char *message, va_list ap) |
217 | { | |
779837e1 | 218 | lf->vlogfn(lf->st,priority,message,ap); |
59938e0e IJ |
219 | } |
220 | ||
040ee979 | 221 | void slilog(struct log_if *lf, int priority, const char *message, ...) |
2fe58dfd SE |
222 | { |
223 | va_list ap; | |
224 | ||
225 | va_start(ap,message); | |
59938e0e | 226 | vslilog(lf,priority,message,ap); |
2fe58dfd SE |
227 | va_end(ap); |
228 | } | |
229 | ||
230 | struct buffer { | |
231 | closure_t cl; | |
232 | struct buffer_if ops; | |
233 | }; | |
234 | ||
fe5e9cc4 | 235 | void buffer_assert_free(struct buffer_if *buffer, cstring_t file, |
1caa23ff | 236 | int line) |
2fe58dfd SE |
237 | { |
238 | if (!buffer->free) { | |
28db900b IJ |
239 | fprintf(stderr,"secnet: BUF_ASSERT_FREE, %s line %d, owned by %s", |
240 | file,line,buffer->owner); | |
241 | assert(!"buffer_assert_free failure"); | |
2fe58dfd SE |
242 | } |
243 | } | |
244 | ||
fe5e9cc4 | 245 | void buffer_assert_used(struct buffer_if *buffer, cstring_t file, |
1caa23ff | 246 | int line) |
2fe58dfd SE |
247 | { |
248 | if (buffer->free) { | |
28db900b IJ |
249 | fprintf(stderr,"secnet: BUF_ASSERT_USED, %s line %d, last owned by %s", |
250 | file,line,buffer->owner); | |
251 | assert(!"buffer_assert_used failure"); | |
2fe58dfd SE |
252 | } |
253 | } | |
254 | ||
1caa23ff | 255 | void buffer_init(struct buffer_if *buffer, int32_t max_start_pad) |
2fe58dfd | 256 | { |
10068344 | 257 | assert(max_start_pad<=buffer->alloclen); |
2fe58dfd SE |
258 | buffer->start=buffer->base+max_start_pad; |
259 | buffer->size=0; | |
260 | } | |
261 | ||
1caa23ff | 262 | void *buf_append(struct buffer_if *buf, int32_t amount) { |
2fe58dfd | 263 | void *p; |
92795040 | 264 | assert(amount <= buf_remaining_space(buf)); |
2fe58dfd SE |
265 | p=buf->start + buf->size; |
266 | buf->size+=amount; | |
267 | return p; | |
268 | } | |
269 | ||
1caa23ff | 270 | void *buf_prepend(struct buffer_if *buf, int32_t amount) { |
59230b9b | 271 | assert(amount <= buf->start - buf->base); |
2fe58dfd SE |
272 | buf->size+=amount; |
273 | return buf->start-=amount; | |
274 | } | |
275 | ||
1caa23ff | 276 | void *buf_unappend(struct buffer_if *buf, int32_t amount) { |
2fe58dfd SE |
277 | if (buf->size < amount) return 0; |
278 | return buf->start+(buf->size-=amount); | |
279 | } | |
280 | ||
1caa23ff | 281 | void *buf_unprepend(struct buffer_if *buf, int32_t amount) { |
2fe58dfd | 282 | void *p; |
20138876 | 283 | if (buf->size < amount) return 0; |
2fe58dfd SE |
284 | p=buf->start; |
285 | buf->start+=amount; | |
286 | buf->size-=amount; | |
287 | return p; | |
288 | } | |
289 | ||
290 | /* Append a two-byte length and the string to the buffer. Length is in | |
291 | network byte order. */ | |
fe5e9cc4 | 292 | void buf_append_string(struct buffer_if *buf, cstring_t s) |
2fe58dfd | 293 | { |
1caa23ff | 294 | size_t len; |
2fe58dfd SE |
295 | |
296 | len=strlen(s); | |
59230b9b | 297 | /* fixme: if string is longer than 65535, result is a corrupted packet */ |
59635212 | 298 | buf_append_uint16(buf,len); |
2fe58dfd SE |
299 | memcpy(buf_append(buf,len),s,len); |
300 | } | |
301 | ||
1caa23ff | 302 | void buffer_new(struct buffer_if *buf, int32_t len) |
2fe58dfd SE |
303 | { |
304 | buf->free=True; | |
305 | buf->owner=NULL; | |
306 | buf->flags=0; | |
307 | buf->loc.file=NULL; | |
308 | buf->loc.line=0; | |
309 | buf->size=0; | |
10068344 | 310 | buf->alloclen=len; |
2fe58dfd SE |
311 | buf->start=NULL; |
312 | buf->base=safe_malloc(len,"buffer_new"); | |
313 | } | |
314 | ||
28db900b IJ |
315 | void buffer_readonly_view(struct buffer_if *buf, const void *data, int32_t len) |
316 | { | |
317 | buf->free=False; | |
318 | buf->owner="READONLY"; | |
319 | buf->flags=0; | |
320 | buf->loc.file=NULL; | |
321 | buf->loc.line=0; | |
10068344 | 322 | buf->size=buf->alloclen=len; |
28db900b IJ |
323 | buf->base=buf->start=(uint8_t*)data; |
324 | } | |
325 | ||
326 | void buffer_readonly_clone(struct buffer_if *out, const struct buffer_if *in) | |
327 | { | |
328 | buffer_readonly_view(out,in->start,in->size); | |
329 | } | |
330 | ||
05f39b4d IJ |
331 | void buffer_copy(struct buffer_if *dst, const struct buffer_if *src) |
332 | { | |
10068344 IJ |
333 | if (dst->alloclen < src->alloclen) { |
334 | dst->base=realloc(dst->base,src->alloclen); | |
05f39b4d | 335 | if (!dst->base) fatal_perror("buffer_copy"); |
10068344 | 336 | dst->alloclen = src->alloclen; |
05f39b4d IJ |
337 | } |
338 | dst->start = dst->base + (src->start - src->base); | |
339 | dst->size = src->size; | |
340 | memcpy(dst->start, src->start, dst->size); | |
341 | } | |
342 | ||
2fe58dfd SE |
343 | static list_t *buffer_apply(closure_t *self, struct cloc loc, dict_t *context, |
344 | list_t *args) | |
345 | { | |
346 | struct buffer *st; | |
347 | item_t *item; | |
348 | dict_t *dict; | |
349 | bool_t lockdown=False; | |
4efd681a | 350 | uint32_t len=DEFAULT_BUFFER_SIZE; |
2fe58dfd SE |
351 | |
352 | st=safe_malloc(sizeof(*st),"buffer_apply"); | |
353 | st->cl.description="buffer"; | |
354 | st->cl.type=CL_BUFFER; | |
355 | st->cl.apply=NULL; | |
356 | st->cl.interface=&st->ops; | |
2fe58dfd SE |
357 | |
358 | /* First argument, if present, is buffer length */ | |
359 | item=list_elem(args,0); | |
360 | if (item) { | |
361 | if (item->type!=t_number) { | |
362 | cfgfatal(st->ops.loc,"buffer","first parameter must be a " | |
363 | "number (buffer size)\n"); | |
364 | } | |
4efd681a SE |
365 | len=item->data.number; |
366 | if (len<MIN_BUFFER_SIZE) { | |
2fe58dfd SE |
367 | cfgfatal(st->ops.loc,"buffer","ludicrously small buffer size\n"); |
368 | } | |
4efd681a | 369 | if (len>MAX_BUFFER_SIZE) { |
2fe58dfd SE |
370 | cfgfatal(st->ops.loc,"buffer","ludicrously large buffer size\n"); |
371 | } | |
372 | } | |
373 | /* Second argument, if present, is a dictionary */ | |
374 | item=list_elem(args,1); | |
375 | if (item) { | |
376 | if (item->type!=t_dict) { | |
377 | cfgfatal(st->ops.loc,"buffer","second parameter must be a " | |
378 | "dictionary\n"); | |
379 | } | |
380 | dict=item->data.dict; | |
381 | lockdown=dict_read_bool(dict,"lockdown",False,"buffer",st->ops.loc, | |
382 | False); | |
383 | } | |
384 | ||
4efd681a | 385 | buffer_new(&st->ops,len); |
2fe58dfd | 386 | if (lockdown) { |
70dc107b | 387 | /* XXX mlock the buffer if possible */ |
2fe58dfd SE |
388 | } |
389 | ||
390 | return new_closure(&st->cl); | |
391 | } | |
392 | ||
8534d602 IJ |
393 | void send_nak(const struct comm_addr *dest, uint32_t our_index, |
394 | uint32_t their_index, uint32_t msgtype, | |
395 | struct buffer_if *buf, const char *logwhy) | |
396 | { | |
3abd18e8 | 397 | buffer_init(buf,calculate_max_start_pad()); |
8534d602 IJ |
398 | buf_append_uint32(buf,their_index); |
399 | buf_append_uint32(buf,our_index); | |
400 | buf_append_uint32(buf,LABEL_NAK); | |
401 | if (logwhy) | |
402 | Message(M_INFO,"%s: %08"PRIx32"<-%08"PRIx32": %08"PRIx32":" | |
403 | " %s; sending NAK\n", | |
1a448682 | 404 | comm_addr_to_string(dest), |
8534d602 IJ |
405 | our_index, their_index, msgtype, logwhy); |
406 | dest->comm->sendmsg(dest->comm->st, buf, dest); | |
407 | } | |
408 | ||
5ad34db2 IJ |
409 | int consttime_memeq(const void *s1in, const void *s2in, size_t n) |
410 | { | |
411 | const uint8_t *s1=s1in, *s2=s2in; | |
412 | register volatile uint8_t accumulator=0; | |
413 | ||
414 | while (n-- > 0) { | |
415 | accumulator |= (*s1++ ^ *s2++); | |
416 | } | |
417 | accumulator |= accumulator >> 4; /* constant-time */ | |
418 | accumulator |= accumulator >> 2; /* boolean canonicalisation */ | |
419 | accumulator |= accumulator >> 1; | |
420 | accumulator &= 1; | |
421 | accumulator ^= 1; | |
422 | return accumulator; | |
423 | } | |
424 | ||
2fe58dfd SE |
425 | void util_module(dict_t *dict) |
426 | { | |
2fe58dfd SE |
427 | add_closure(dict,"sysbuffer",buffer_apply); |
428 | } | |
3abd18e8 IJ |
429 | |
430 | void update_max_start_pad(int32_t *our_module_global, int32_t our_instance) | |
431 | { | |
432 | if (*our_module_global < our_instance) | |
433 | *our_module_global=our_instance; | |
434 | } | |
435 | ||
436 | int32_t transform_max_start_pad, comm_max_start_pad; | |
437 | ||
438 | int32_t calculate_max_start_pad(void) | |
439 | { | |
440 | return | |
441 | site_max_start_pad + | |
442 | transform_max_start_pad + | |
443 | comm_max_start_pad; | |
444 | } | |
ff1dcd86 IJ |
445 | |
446 | void vslilog_part(struct log_if *lf, int priority, const char *message, va_list ap) | |
447 | { | |
448 | char *buff=lf->buff; | |
449 | size_t bp; | |
450 | char *nlp; | |
451 | ||
452 | bp=strlen(buff); | |
453 | assert(bp < LOG_MESSAGE_BUFLEN); | |
454 | vsnprintf(buff+bp,LOG_MESSAGE_BUFLEN-bp,message,ap); | |
455 | buff[LOG_MESSAGE_BUFLEN-1] = '\n'; | |
456 | buff[LOG_MESSAGE_BUFLEN] = '\0'; | |
457 | /* Each line is sent separately */ | |
458 | while ((nlp=strchr(buff,'\n'))) { | |
459 | *nlp=0; | |
460 | slilog(lf,priority,"%s",buff); | |
461 | memmove(buff,nlp+1,strlen(nlp+1)+1); | |
462 | } | |
463 | } | |
464 | ||
465 | extern void slilog_part(struct log_if *lf, int priority, const char *message, ...) | |
466 | { | |
467 | va_list ap; | |
468 | va_start(ap,message); | |
469 | vslilog_part(lf,priority,message,ap); | |
470 | va_end(ap); | |
471 | } |