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