lib/hcrypto/doxygen.c

   1 /*
   2  * Copyright (c) 2007 Kungliga Tekniska Högskolan
   3  * (Royal Institute of Technology, Stockholm, Sweden).
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  *
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * 3. Neither the name of the Institute nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  */
  33
  34 /**
  35  *
  36  */
  37
  38 /*! @mainpage Heimdal crypto library
  39  *
  40  * @section intro Introduction
  41  *
  42  * Heimdal libhcrypto library is a implementation many crypto
  43  * algorithms, among others: AES, SHA, DES, RSA, Camellia and many
  44  * help function.
  45  *
  46  * hcrypto provies a OpenSSL compatible interface libcrypto interface
  47  * and is licensed under a 3 clause BSD license (GPL compatible).
  48  *
  49  * The project web page: http://www.h5l.org/
  50  *
  51  * Sections of this manual:
  52  *
  53  * - @subpage page_evp, @ref hcrypto_evp
  54  * - @subpage page_rand, @ref hcrypto_rand
  55  * - @subpage page_dh, @ref hcrypto_dh
  56  * - @subpage page_rsa, @ref hcrypto_rsa
  57  *
  58  * Older interfaces that you should not use:
  59  *
  60  * - @subpage page_des, @ref hcrypto_des
  61  *
  62  * @subsection control_functions Control functions
  63  *
  64  * Functions controlling general behavior, like adding algorithms, are
  65  * documented in this module: @ref hcrypto_core .
  66  *
  67  * @subsection return_values Return values
  68  *
  69  * Return values are diffrent in this module to be compatible with
  70  * OpenSSL interface. The diffrence is that on success 1 is returned
  71  * instead of the customary 0.
  72  */
  73
  74 /** @defgroup hcrypto_dh Diffie-Hellman functions
  75  * See the @ref page_dh for description and examples.
  76  */
  77 /** @defgroup hcrypto_rsa RSA functions
  78  * See the @ref page_rsa for description and examples.
  79  */
  80 /** @defgroup hcrypto_evp EVP generic crypto functions
  81  * See the @ref page_evp for description and examples.
  82  */
  83 /** @defgroup hcrypto_rand RAND crypto functions
  84  * See the @ref page_rand for description and examples.
  85  */
  86 /** @defgroup hcrypto_des DES crypto functions
  87  * See the @ref page_des for description and examples.
  88  */
  89 /** @defgroup hcrypto_core hcrypto function controlling behavior */