Migrated psk/pubkey_authenticators to INIT/METHOD macros
[strongswan.git] / src / libstrongswan / utils.c
1 /*
2 * Copyright (C) 2008-2010 Tobias Brunner
3 * Copyright (C) 2005-2008 Martin Willi
4 * Hochschule fuer Technik Rapperswil
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2 of the License, or (at your
9 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * for more details.
15 */
16
17 #include "utils.h"
18
19 #include <sys/stat.h>
20 #include <string.h>
21 #include <stdio.h>
22 #include <unistd.h>
23 #include <stdint.h>
24 #include <limits.h>
25 #include <dirent.h>
26 #include <time.h>
27
28 #include "enum.h"
29 #include "debug.h"
30
31 ENUM(status_names, SUCCESS, NEED_MORE,
32 "SUCCESS",
33 "FAILED",
34 "OUT_OF_RES",
35 "ALREADY_DONE",
36 "NOT_SUPPORTED",
37 "INVALID_ARG",
38 "NOT_FOUND",
39 "PARSE_ERROR",
40 "VERIFY_ERROR",
41 "INVALID_STATE",
42 "DESTROY_ME",
43 "NEED_MORE",
44 );
45
46 /**
47 * Described in header.
48 */
49 void *clalloc(void * pointer, size_t size)
50 {
51 void *data;
52 data = malloc(size);
53
54 memcpy(data, pointer, size);
55
56 return (data);
57 }
58
59 /**
60 * Described in header.
61 */
62 void memxor(u_int8_t dst[], u_int8_t src[], size_t n)
63 {
64 int m, i;
65
66 /* byte wise XOR until dst aligned */
67 for (i = 0; (uintptr_t)&dst[i] % sizeof(long) && i < n; i++)
68 {
69 dst[i] ^= src[i];
70 }
71 /* try to use words if src shares an aligment with dst */
72 switch (((uintptr_t)&src[i] % sizeof(long)))
73 {
74 case 0:
75 for (m = n - sizeof(long); i <= m; i += sizeof(long))
76 {
77 *(long*)&dst[i] ^= *(long*)&src[i];
78 }
79 break;
80 case sizeof(int):
81 for (m = n - sizeof(int); i <= m; i += sizeof(int))
82 {
83 *(int*)&dst[i] ^= *(int*)&src[i];
84 }
85 break;
86 case sizeof(short):
87 for (m = n - sizeof(short); i <= m; i += sizeof(short))
88 {
89 *(short*)&dst[i] ^= *(short*)&src[i];
90 }
91 break;
92 default:
93 break;
94 }
95 /* byte wise XOR of the rest */
96 for (; i < n; i++)
97 {
98 dst[i] ^= src[i];
99 }
100 }
101
102 /**
103 * Described in header.
104 */
105 void *memstr(const void *haystack, const char *needle, size_t n)
106 {
107 unsigned const char *pos = haystack;
108 size_t l = strlen(needle);
109 for (; n >= l; ++pos, --n)
110 {
111 if (memeq(pos, needle, l))
112 {
113 return (void*)pos;
114 }
115 }
116 return NULL;
117 }
118
119 /**
120 * Described in header.
121 */
122 char* translate(char *str, const char *from, const char *to)
123 {
124 char *pos = str;
125 if (strlen(from) != strlen(to))
126 {
127 return str;
128 }
129 while (pos && *pos)
130 {
131 char *match;
132 if ((match = strchr(from, *pos)) != NULL)
133 {
134 *pos = to[match - from];
135 }
136 pos++;
137 }
138 return str;
139 }
140
141 /**
142 * Described in header.
143 */
144 bool mkdir_p(const char *path, mode_t mode)
145 {
146 int len;
147 char *pos, full[PATH_MAX];
148 pos = full;
149 if (!path || *path == '\0')
150 {
151 return TRUE;
152 }
153 len = snprintf(full, sizeof(full)-1, "%s", path);
154 if (len < 0 || len >= sizeof(full)-1)
155 {
156 DBG1(DBG_LIB, "path string %s too long", path);
157 return FALSE;
158 }
159 /* ensure that the path ends with a '/' */
160 if (full[len-1] != '/')
161 {
162 full[len++] = '/';
163 full[len] = '\0';
164 }
165 /* skip '/' at the beginning */
166 while (*pos == '/')
167 {
168 pos++;
169 }
170 while ((pos = strchr(pos, '/')))
171 {
172 *pos = '\0';
173 if (access(full, F_OK) < 0)
174 {
175 if (mkdir(full, mode) < 0)
176 {
177 DBG1(DBG_LIB, "failed to create directory %s", full);
178 return FALSE;
179 }
180 }
181 *pos = '/';
182 pos++;
183 }
184 return TRUE;
185 }
186
187 /**
188 * Return monotonic time
189 */
190 time_t time_monotonic(timeval_t *tv)
191 {
192 #if defined(HAVE_CLOCK_GETTIME) && \
193 (defined(HAVE_CONDATTR_CLOCK_MONOTONIC) || \
194 defined(HAVE_PTHREAD_COND_TIMEDWAIT_MONOTONIC))
195 /* as we use time_monotonic() for condvar operations, we use the
196 * monotonic time source only if it is also supported by pthread. */
197 timespec_t ts;
198
199 if (clock_gettime(CLOCK_MONOTONIC, &ts) == 0)
200 {
201 if (tv)
202 {
203 tv->tv_sec = ts.tv_sec;
204 tv->tv_usec = ts.tv_nsec / 1000;
205 }
206 return ts.tv_sec;
207 }
208 #endif /* HAVE_CLOCK_GETTIME && (...) */
209 /* Fallback to non-monotonic timestamps:
210 * On MAC OS X, creating monotonic timestamps is rather difficult. We
211 * could use mach_absolute_time() and catch sleep/wakeup notifications.
212 * We stick to the simpler (non-monotonic) gettimeofday() for now.
213 * But keep in mind: we need the same time source here as in condvar! */
214 if (!tv)
215 {
216 return time(NULL);
217 }
218 if (gettimeofday(tv, NULL) != 0)
219 { /* should actually never fail if passed pointers are valid */
220 return -1;
221 }
222 return tv->tv_sec;
223 }
224
225 /**
226 * return null
227 */
228 void *return_null()
229 {
230 return NULL;
231 }
232
233 /**
234 * returns TRUE
235 */
236 bool return_true()
237 {
238 return TRUE;
239 }
240
241 /**
242 * returns FALSE
243 */
244 bool return_false()
245 {
246 return FALSE;
247 }
248
249 /**
250 * returns FAILED
251 */
252 status_t return_failed()
253 {
254 return FAILED;
255 }
256
257 /**
258 * nop operation
259 */
260 void nop()
261 {
262 }
263
264 #ifndef HAVE_GCC_ATOMIC_OPERATIONS
265 #include <pthread.h>
266
267 /**
268 * We use a single mutex for all refcount variables.
269 */
270 static pthread_mutex_t ref_mutex = PTHREAD_MUTEX_INITIALIZER;
271
272 /**
273 * Increase refcount
274 */
275 void ref_get(refcount_t *ref)
276 {
277 pthread_mutex_lock(&ref_mutex);
278 (*ref)++;
279 pthread_mutex_unlock(&ref_mutex);
280 }
281
282 /**
283 * Decrease refcount
284 */
285 bool ref_put(refcount_t *ref)
286 {
287 bool more_refs;
288
289 pthread_mutex_lock(&ref_mutex);
290 more_refs = --(*ref);
291 pthread_mutex_unlock(&ref_mutex);
292 return !more_refs;
293 }
294 #endif /* HAVE_GCC_ATOMIC_OPERATIONS */
295
296 /**
297 * Described in header.
298 */
299 int time_printf_hook(char *dst, size_t len, printf_hook_spec_t *spec,
300 const void *const *args)
301 {
302 static const char* months[] = {
303 "Jan", "Feb", "Mar", "Apr", "May", "Jun",
304 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
305 };
306 time_t *time = *((time_t**)(args[0]));
307 bool utc = *((bool*)(args[1]));;
308 struct tm t;
309
310 if (time == UNDEFINED_TIME)
311 {
312 return print_in_hook(dst, len, "--- -- --:--:--%s----",
313 utc ? " UTC " : " ");
314 }
315 if (utc)
316 {
317 gmtime_r(time, &t);
318 }
319 else
320 {
321 localtime_r(time, &t);
322 }
323 return print_in_hook(dst, len, "%s %02d %02d:%02d:%02d%s%04d",
324 months[t.tm_mon], t.tm_mday, t.tm_hour, t.tm_min,
325 t.tm_sec, utc ? " UTC " : " ", t.tm_year + 1900);
326 }
327
328 /**
329 * Described in header.
330 */
331 int time_delta_printf_hook(char *dst, size_t len, printf_hook_spec_t *spec,
332 const void *const *args)
333 {
334 char* unit = "second";
335 time_t *arg1 = *((time_t**)(args[0]));
336 time_t *arg2 = *((time_t**)(args[1]));
337 time_t delta = abs(*arg1 - *arg2);
338
339 if (delta > 2 * 60 * 60 * 24)
340 {
341 delta /= 60 * 60 * 24;
342 unit = "day";
343 }
344 else if (delta > 2 * 60 * 60)
345 {
346 delta /= 60 * 60;
347 unit = "hour";
348 }
349 else if (delta > 2 * 60)
350 {
351 delta /= 60;
352 unit = "minute";
353 }
354 return print_in_hook(dst, len, "%d %s%s", delta, unit, (delta == 1)? "":"s");
355 }
356
357 /**
358 * Number of bytes per line to dump raw data
359 */
360 #define BYTES_PER_LINE 16
361
362 static char hexdig_upper[] = "0123456789ABCDEF";
363
364 /**
365 * Described in header.
366 */
367 int mem_printf_hook(char *dst, size_t dstlen,
368 printf_hook_spec_t *spec, const void *const *args)
369 {
370 char *bytes = *((void**)(args[0]));
371 int len = *((size_t*)(args[1]));
372
373 char buffer[BYTES_PER_LINE * 3];
374 char ascii_buffer[BYTES_PER_LINE + 1];
375 char *buffer_pos = buffer;
376 char *bytes_pos = bytes;
377 char *bytes_roof = bytes + len;
378 int line_start = 0;
379 int i = 0;
380 int written = 0;
381
382 written += print_in_hook(dst, dstlen, "=> %d bytes @ %p", len, bytes);
383
384 while (bytes_pos < bytes_roof)
385 {
386 *buffer_pos++ = hexdig_upper[(*bytes_pos >> 4) & 0xF];
387 *buffer_pos++ = hexdig_upper[ *bytes_pos & 0xF];
388
389 ascii_buffer[i++] =
390 (*bytes_pos > 31 && *bytes_pos < 127) ? *bytes_pos : '.';
391
392 if (++bytes_pos == bytes_roof || i == BYTES_PER_LINE)
393 {
394 int padding = 3 * (BYTES_PER_LINE - i);
395
396 while (padding--)
397 {
398 *buffer_pos++ = ' ';
399 }
400 *buffer_pos++ = '\0';
401 ascii_buffer[i] = '\0';
402
403 written += print_in_hook(dst, dstlen, "\n%4d: %s %s",
404 line_start, buffer, ascii_buffer);
405
406 buffer_pos = buffer;
407 line_start += BYTES_PER_LINE;
408 i = 0;
409 }
410 else
411 {
412 *buffer_pos++ = ' ';
413 }
414 }
415 return written;
416 }