xref: /freebsd-src/crypto/heimdal/lib/krb5/doxygen.c (revision c19800e8cd5640693f36f2040db4ab5e8d738146)
1*c19800e8SDoug Rabson /*
2*c19800e8SDoug Rabson  * Copyright (c) 2007 Kungliga Tekniska H�gskolan
3*c19800e8SDoug Rabson  * (Royal Institute of Technology, Stockholm, Sweden).
4*c19800e8SDoug Rabson  * All rights reserved.
5*c19800e8SDoug Rabson  *
6*c19800e8SDoug Rabson  * Redistribution and use in source and binary forms, with or without
7*c19800e8SDoug Rabson  * modification, are permitted provided that the following conditions
8*c19800e8SDoug Rabson  * are met:
9*c19800e8SDoug Rabson  *
10*c19800e8SDoug Rabson  * 1. Redistributions of source code must retain the above copyright
11*c19800e8SDoug Rabson  *    notice, this list of conditions and the following disclaimer.
12*c19800e8SDoug Rabson  *
13*c19800e8SDoug Rabson  * 2. Redistributions in binary form must reproduce the above copyright
14*c19800e8SDoug Rabson  *    notice, this list of conditions and the following disclaimer in the
15*c19800e8SDoug Rabson  *    documentation and/or other materials provided with the distribution.
16*c19800e8SDoug Rabson  *
17*c19800e8SDoug Rabson  * 3. Neither the name of the Institute nor the names of its contributors
18*c19800e8SDoug Rabson  *    may be used to endorse or promote products derived from this software
19*c19800e8SDoug Rabson  *    without specific prior written permission.
20*c19800e8SDoug Rabson  *
21*c19800e8SDoug Rabson  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
22*c19800e8SDoug Rabson  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23*c19800e8SDoug Rabson  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24*c19800e8SDoug Rabson  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
25*c19800e8SDoug Rabson  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26*c19800e8SDoug Rabson  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27*c19800e8SDoug Rabson  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28*c19800e8SDoug Rabson  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29*c19800e8SDoug Rabson  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30*c19800e8SDoug Rabson  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31*c19800e8SDoug Rabson  * SUCH DAMAGE.
32*c19800e8SDoug Rabson  */
33*c19800e8SDoug Rabson 
34*c19800e8SDoug Rabson #include "krb5_locl.h"
35*c19800e8SDoug Rabson RCSID("$Id$");
36*c19800e8SDoug Rabson 
37*c19800e8SDoug Rabson /**
38*c19800e8SDoug Rabson  *
39*c19800e8SDoug Rabson  */
40*c19800e8SDoug Rabson 
41*c19800e8SDoug Rabson /*! \mainpage Heimdal Kerberos 5 library
42*c19800e8SDoug Rabson  *
43*c19800e8SDoug Rabson  * \section intro Introduction
44*c19800e8SDoug Rabson  *
45*c19800e8SDoug Rabson  * Heimdal libkrb5 library is a implementation of the Kerberos
46*c19800e8SDoug Rabson  * protocol.
47*c19800e8SDoug Rabson  *
48*c19800e8SDoug Rabson  * Kerberos is a system for authenticating users and services on a
49*c19800e8SDoug Rabson  * network.  It is built upon the assumption that the network is
50*c19800e8SDoug Rabson  * ``unsafe''.  For example, data sent over the network can be
51*c19800e8SDoug Rabson  * eavesdropped and altered, and addresses can also be faked.
52*c19800e8SDoug Rabson  * Therefore they cannot be used for authentication purposes.
53*c19800e8SDoug Rabson  *
54*c19800e8SDoug Rabson  * The project web page:\n
55*c19800e8SDoug Rabson  * http://www.h5l.org/
56*c19800e8SDoug Rabson  *
57*c19800e8SDoug Rabson  */
58*c19800e8SDoug Rabson 
59*c19800e8SDoug Rabson /** @defgroup krb5 Heimdal Kerberos 5 library */
60*c19800e8SDoug Rabson /** @defgroup krb5_address Heimdal Kerberos 5 address functions */
61*c19800e8SDoug Rabson /** @defgroup krb5_ccache Heimdal Kerberos 5 credential cache functions */
62*c19800e8SDoug Rabson /** @defgroup krb5_credential Heimdal Kerberos 5 credential handing functions */
63*c19800e8SDoug Rabson /** @defgroup krb5_deprecated Heimdal Kerberos 5 deprecated functions */
64*c19800e8SDoug Rabson /** @defgroup krb5_digest Heimdal Kerberos 5 digest service */
65*c19800e8SDoug Rabson /** @defgroup krb5_error Heimdal Kerberos 5 error reporting functions */
66*c19800e8SDoug Rabson /** @defgroup krb5_v4compat Heimdal Kerberos 4 compatiblity functions */
67*c19800e8SDoug Rabson /** @defgroup krb5_support Heimdal Kerberos 5 support functions */
68