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  * RCSID $Id$
  16  */
  17
  18 #ifndef _DEFS_H
  19 #define _DEFS_H
  20
  21 #include <string.h>
  22 #include <sys/types.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
  56 /* chunk is a simple pointer-and-size abstraction */
  57
  58 struct chunk {
  59     u_char *ptr;
  60     size_t len;
  61     };
  62 typedef struct chunk chunk_t;
  63
  64 extern const chunk_t chunk_empty;
  65
  66 static inline chunk_t chunk_create(u_char *ptr, size_t len)
  67 {
  68     chunk_t chunk = {ptr, len};
  69     return chunk;
  70 }
  71
  72 static inline void chunk_free(chunk_t *chunk)
  73 {
  74     free(chunk->ptr);
  75     *chunk = chunk_empty;
  76 }
  77
  78 static inline void chunk_clear(chunk_t *chunk)
  79 {
  80     if (chunk->ptr)
  81     {
  82         memset(chunk->ptr, 0, chunk->len);
  83         chunk_free(chunk);
  84     }
  85 }
  86
  87 static inline bool chunk_equals(chunk_t a, chunk_t b)
  88 {
  89     return a.ptr != NULL  && b.ptr != NULL &&
  90            a.len == b.len && memeq(a.ptr, b.ptr, a.len);
  91 }
  92
  93 extern chunk_t chunk_create_clone(u_char *ptr, chunk_t chunk);
  94
  95 #define chunk_clone(chunk) \
  96     chunk_create_clone((chunk).len ? malloc((chunk).len) : NULL, chunk)
  97
  98 #define chunk_from_buf(str) { str, sizeof(str) }
  99
 100 #define chunkcpy(dst, chunk) \
 101     { memcpy(dst, chunk.ptr, chunk.len); dst += chunk.len;}
 102
 103 extern char* temporary_cyclic_buffer(void);
 104 extern const char* concatenate_paths(const char *a, const char *b);
 105
 106 /* compare two chunks */
 107 extern int chunk_compare(chunk_t a, chunk_t b);
 108
 109 /* move a chunk to a memory position and free it after insertion */
 110 extern void mv_chunk(u_char **pos, chunk_t content);
 111
 112 /* write the binary contents of a chunk_t to a file */
 113 extern bool write_chunk(const char *filename, const char *label, chunk_t ch
 114     ,mode_t mask, bool force);
 115
 116 /* display a date either in local or UTC time */
 117 extern char* timetoa(const time_t *time, bool utc);
 118
 119 /* warns a predefined interval before expiry */
 120 extern const char* check_expiry(time_t expiration_date,
 121     int warning_interval, bool strict);
 122
 123 #define MAX_PROMPT_PASS_TRIALS  5
 124 #define PROMPT_PASS_LEN         64
 125
 126 /* struct used to prompt for a secret passphrase
 127  * from a console with file descriptor fd
 128  */
 129 typedef struct {
 130     char secret[PROMPT_PASS_LEN+1];
 131     bool prompt;
 132     int fd;
 133 } prompt_pass_t;
 134
 135 /* size of timetoa string buffer */
 136 #define TIMETOA_BUF     30
 137
 138 /* filter eliminating the directory entries '.' and '..' */
 139 typedef struct dirent dirent_t;
 140 extern int file_select(const dirent_t *entry);
 141
 142 /* cleanly exit Pluto */
 143
 144 extern void exit_pluto(int /*status*/) NEVER_RETURNS;
 145
 146
 147 /* zero all bytes */
 148 #define zero(x) memset((x), '\0', sizeof(*(x)))
 149
 150 /* are all bytes 0? */
 151 extern bool all_zero(const unsigned char *m, size_t len);
 152
 153 /* pad_up(n, m) is the amount to add to n to make it a multiple of m */
 154 #define pad_up(n, m) (((m) - 1) - (((n) + (m) - 1) % (m)))
 155
 156 #endif /* _DEFS_H */