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