c3a1a139e0f63b7fad9376f6fd263554c016fc23
[strongswan.git] / src / pluto / defs.h
1 /* misc. universal things
2 * Copyright (C) 1997 Angelos D. Keromytis.
3 * Copyright (C) 1998-2001 D. Hugh Redelmeier.
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * for more details.
14 */
15
16 #ifndef _DEFS_H
17 #define _DEFS_H
18
19 #include <string.h>
20 #include <sys/types.h>
21
22 #include <chunk.h>
23
24 #ifdef KLIPS
25 # define USED_BY_KLIPS /* ignore */
26 #else
27 # define USED_BY_KLIPS UNUSED
28 #endif
29
30 #ifdef DEBUG
31 # define USED_BY_DEBUG /* ignore */
32 #else
33 # define USED_BY_DEBUG UNUSED
34 #endif
35
36 /* type of serial number of a state object
37 * Needed in connections.h and state.h; here to simplify dependencies.
38 */
39 typedef unsigned long so_serial_t;
40 #define SOS_NOBODY 0 /* null serial number */
41 #define SOS_FIRST 1 /* first normal serial number */
42
43 /* memory allocation */
44
45 extern void *clone_bytes(const void *orig, size_t size);
46
47 #define clone_thing(orig) clone_bytes((const void *)&(orig), sizeof(orig))
48
49 #define clone_str(str) \
50 ((str) == NULL? NULL : strdup(str))
51
52 #define replace(p, q) \
53 { free(p); (p) = (q); }
54
55 #define chunkcpy(dst, chunk) \
56 { memcpy(dst, chunk.ptr, chunk.len); dst += chunk.len;}
57
58 extern char* temporary_cyclic_buffer(void);
59 extern char* concatenate_paths(char *a, char *b);
60
61 /* move a chunk to a memory position and free it after insertion */
62 extern void mv_chunk(u_char **pos, chunk_t content);
63
64 /* warns a predefined interval before expiry */
65 extern const char* check_expiry(time_t expiration_date,
66 int warning_interval, bool strict);
67
68 #define MAX_PROMPT_PASS_TRIALS 5
69 #define PROMPT_PASS_LEN 64
70
71 /* struct used to prompt for a secret passphrase
72 * from a console with file descriptor fd
73 */
74 typedef struct {
75 char secret[PROMPT_PASS_LEN+1];
76 bool prompt;
77 int fd;
78 } prompt_pass_t;
79
80 /* filter eliminating the directory entries '.' and '..' */
81 typedef struct dirent dirent_t;
82 extern int file_select(const dirent_t *entry);
83
84 /* cleanly exit Pluto */
85 extern void exit_pluto(int /*status*/) NEVER_RETURNS;
86
87 /* zero all bytes */
88 #define zero(x) memset((x), '\0', sizeof(*(x)))
89
90 /* are all bytes 0? */
91 extern bool all_zero(const unsigned char *m, size_t len);
92
93 /* pad_up(n, m) is the amount to add to n to make it a multiple of m */
94 #define pad_up(n, m) (((m) - 1) - (((n) + (m) - 1) % (m)))
95
96 #endif /* _DEFS_H */