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