src/libstrongswan/library.h

   1 /**
   2  * @file library.h
   3  *
   4  * @brief Helper functions and definitions.
   5  *
   6  */
   7
   8 /*
   9  * Copyright (C) 2006 Martin Willi
  10  * Hochschule fuer Technik Rapperswil
  11  *
  12  * This program is free software; you can redistribute it and/or modify it
  13  * under the terms of the GNU General Public License as published by the
  14  * Free Software Foundation; either version 2 of the License, or (at your
  15  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
  16  *
  17  * This program is distributed in the hope that it will be useful, but
  18  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  19  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  20  * for more details.
  21  */
  22
  23 #ifndef LIBRARY_H_
  24 #define LIBRARY_H_
  25
  26 /**
  27  * @defgroup libstrongswan libstrongswan
  28  *
  29  * libstrongswan: library with various cryptographic, X.509 trust chain and
  30  * identity management functions.
  31  */
  32
  33 /**
  34  * @defgroup asn1 asn1
  35  *
  36  * ASN.1 definitions, parser and generator functions.
  37  *
  38  * @ingroup libstrongswan
  39  */
  40
  41 /**
  42  * @defgroup crypto crypto
  43  *
  44  * Various cryptographic algorithms.
  45  *
  46  * @ingroup libstrongswan
  47  */
  48
  49 /**
  50  * @defgroup crypters crypters
  51  *
  52  * Symmetric encryption algorithms, used for
  53  * encryption and decryption.
  54  *
  55  * @ingroup crypto
  56  */
  57
  58 /**
  59  * @defgroup hashers hashers
  60  *
  61  * Hashing algorithms, such as MD5 or SHA1
  62  *
  63  * @ingroup crypto
  64  */
  65
  66 /**
  67  * @defgroup prfs prfs
  68  *
  69  * Pseudo random functions, used to generate
  70  * pseude random byte sequences.
  71  *
  72  * @ingroup crypto
  73  */
  74
  75 /**
  76  * @defgroup rsa rsa
  77  *
  78  * RSA private/public key algorithm.
  79  *
  80  * @ingroup crypto
  81  */
  82
  83 /**
  84  * @defgroup signers signers
  85  *
  86  * Symmetric signing algorithms,
  87  * used to ensure message integrity.
  88  *
  89  * @ingroup crypto
  90  */
  91
  92 /**
  93  * @defgroup fips fips
  94  *
  95  * Code integrity check of libstrongswan
  96  *
  97  * @ingroup libstrongswan
  98  */
  99
 100 /**
 101  * @defgroup utils utils
 102  *
 103  * Generic helper classes.
 104  *
 105  * @ingroup libstrongswan
 106  */
 107
 108 #include <gmp.h>
 109 #include <sys/types.h>
 110 #include <stdlib.h>
 111 #include <stddef.h>
 112 #include <printf.h>
 113
 114 #include <enum.h>
 115
 116 /**
 117  * Number of bits in a byte
 118  */
 119 #define BITS_PER_BYTE 8
 120
 121 /**
 122  * Default length for various auxiliary text buffers
 123  */
 124 #define BUF_LEN 512
 125
 126 /**
 127  * Macro compares two strings for equality
 128  */
 129 #define streq(x,y) (strcmp(x, y) == 0)
 130
 131 /**
 132  * Macro compares two binary blobs for equality
 133  */
 134 #define memeq(x,y,len) (memcmp(x, y, len) == 0)
 135
 136 /**
 137  * Macro gives back larger of two values.
 138  */
 139 #define max(x,y) ((x) > (y) ? (x):(y))
 140
 141 /**
 142  * Macro gives back smaller of two values.
 143  */
 144 #define min(x,y) ((x) < (y) ? (x):(y))
 145
 146 /**
 147  * Call destructor of an object, if object != NULL
 148  */
 149 #define DESTROY_IF(obj) if (obj) obj->destroy(obj)
 150
 151 /**
 152  * Call offset destructor of an object, if object != NULL
 153  */
 154 #define DESTROY_OFFSET_IF(obj, offset) if (obj) obj->destroy_offset(obj, offset);
 155
 156 /**
 157  * Call function destructor of an object, if object != NULL
 158  */
 159 #define DESTROY_FUNCTION_IF(obj, fn) if (obj) obj->destroy_function(obj, fn);
 160
 161 /**
 162  * Debug macro to follow control flow
 163  */
 164 #define POS printf("%s, line %d\n", __FILE__, __LINE__)
 165
 166 /**
 167  * Macro to allocate a sized type.
 168  */
 169 #define malloc_thing(thing) ((thing*)malloc(sizeof(thing)))
 170
 171 /**
 172  * Assign a function as a class method
 173  */
 174 #define ASSIGN(method, function) (method = (typeof(method))function)
 175
 176 /**
 177  * time_t not defined
 178  */
 179 #define UNDEFINED_TIME 0
 180
 181 /**
 182  * General purpose boolean type.
 183  */
 184 typedef int bool;
 185 #define FALSE 0
 186 #define TRUE  1
 187
 188 typedef enum status_t status_t;
 189
 190 /**
 191  * Return values of function calls.
 192  */
 193 enum status_t {
 194         /**
 195          * Call succeeded.
 196          */
 197         SUCCESS,
 198
 199         /**
 200          * Call failed.
 201          */
 202         FAILED,
 203
 204         /**
 205          * Out of resources.
 206          */
 207         OUT_OF_RES,
 208
 209         /**
 210          * The suggested operation is already done
 211          */
 212         ALREADY_DONE,
 213
 214         /**
 215          * Not supported.
 216          */
 217         NOT_SUPPORTED,
 218
 219         /**
 220          * One of the arguments is invalid.
 221          */
 222         INVALID_ARG,
 223
 224         /**
 225          * Something could not be found.
 226          */
 227         NOT_FOUND,
 228
 229         /**
 230          * Error while parsing.
 231          */
 232         PARSE_ERROR,
 233
 234         /**
 235          * Error while verifying.
 236          */
 237         VERIFY_ERROR,
 238
 239         /**
 240          * Object in invalid state.
 241          */
 242         INVALID_STATE,
 243
 244         /**
 245          * Destroy object which called method belongs to.
 246          */
 247         DESTROY_ME,
 248
 249         /**
 250          * Another call to the method is required.
 251          */
 252         NEED_MORE,
 253 };
 254
 255 /**
 256  * used by strict_crl_policy
 257  */
 258 typedef enum {
 259         STRICT_NO,
 260         STRICT_YES,
 261         STRICT_IFURI
 262 } strict_t;
 263
 264 /**
 265  * enum_names for type status_t.
 266  */
 267 extern enum_name_t *status_names;
 268
 269 /**
 270  * deprecated pluto style return value:
 271  * error message, NULL for success
 272  */
 273 typedef const char *err_t;
 274
 275 /**
 276  * Handle struct timeval like an own type.
 277  */
 278 typedef struct timeval timeval_t;
 279
 280 /**
 281  * Handle struct timespec like an own type.
 282  */
 283 typedef struct timespec timespec_t;
 284
 285 /**
 286  * Handle struct chunk_t like an own type.
 287  */
 288 typedef struct sockaddr sockaddr_t;
 289
 290 /**
 291  * Clone a data to a newly allocated buffer
 292  */
 293 void *clalloc(void *pointer, size_t size);
 294
 295 /**
 296  * Same as memcpy, but XORs src into dst instead of copy
 297  */
 298 void memxor(u_int8_t dest[], u_int8_t src[], size_t n);
 299
 300 /**
 301  * Special type to count references
 302  */
 303 typedef volatile u_int refcount_t;
 304
 305 /**
 306  * @brief Get a new reference.
 307  *
 308  * Increments the reference counter atomic.
 309  *
 310  * @param ref   pointer to ref counter
 311  */
 312 void ref_get(refcount_t *ref);
 313
 314 /**
 315  * @brief Put back a unused reference.
 316  *
 317  * Decrements the reference counter atomic and
 318  * says if more references available.
 319  *
 320  * @param ref   pointer to ref counter
 321  * @return              TRUE if no more references counted
 322  */
 323 bool ref_put(refcount_t *ref);
 324
 325
 326 #include <chunk.h>
 327 #include <printf_hook.h>
 328
 329 #endif /* LIBRARY_H_ */