programs/charon/lib/library.h

   1 /**
   2  * @file library.h
   3  *
   4  * @brief Global library header.
   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 lib lib
  28  *
  29  * libstrongswan: library with various crypto related things.
  30  */
  31
  32 /**
  33  * @defgroup asn1 asn1
  34  *
  35  * ASN1 definitions, parser and generator functions.
  36  *
  37  * @ingroup lib
  38  */
  39
  40 /**
  41  * @defgroup crypto crypto
  42  *
  43  * Crypto algorithms of different kind.
  44  *
  45  * @ingroup lib
  46  */
  47
  48 /**
  49  * @defgroup crypters crypters
  50  *
  51  * Symmetric encryption algorithms, used for
  52  * encryption and decryption.
  53  *
  54  * @ingroup crypto
  55  */
  56
  57 /**
  58  * @defgroup hashers hashers
  59  *
  60  * Hashing algorithms, such as MD5 or SHA1
  61  *
  62  * @ingroup crypto
  63  */
  64
  65 /**
  66  * @defgroup prfs prfs
  67  *
  68  * Pseudo random functions, used to generate
  69  * pseude random byte sequences.
  70  *
  71  * @ingroup crypto
  72  */
  73
  74 /**
  75  * @defgroup rsa rsa
  76  *
  77  * RSA private/public key algorithm.
  78  *
  79  * @ingroup crypto
  80  */
  81
  82 /**
  83  * @defgroup signers signers
  84  *
  85  * Symmetric signing algorithms,
  86  * used to ensure message integrity.
  87  *
  88  * @ingroup crypto
  89  */
  90
  91 /**
  92  * @defgroup utils utils
  93  *
  94  * Generic helper classes.
  95  *
  96  * @ingroup lib
  97  */
  98
  99
 100 #endif /* LIBRARY_H_ */