xref: /freebsd/crypto/heimdal/lib/krb5/doxygen.c (revision 8fc257994d0ce2396196d7a06d50d20c8015f4b7)
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 #include "krb5_locl.h"
35 RCSID("$Id$");
36 
37 /**
38  *
39  */
40 
41 /*! \mainpage Heimdal Kerberos 5 library
42  *
43  * \section intro Introduction
44  *
45  * Heimdal libkrb5 library is a implementation of the Kerberos
46  * protocol.
47  *
48  * Kerberos is a system for authenticating users and services on a
49  * network.  It is built upon the assumption that the network is
50  * ``unsafe''.  For example, data sent over the network can be
51  * eavesdropped and altered, and addresses can also be faked.
52  * Therefore they cannot be used for authentication purposes.
53  *
54  * The project web page:\n
55  * http://www.h5l.org/
56  *
57  */
58 
59 /** @defgroup krb5 Heimdal Kerberos 5 library */
60 /** @defgroup krb5_address Heimdal Kerberos 5 address functions */
61 /** @defgroup krb5_ccache Heimdal Kerberos 5 credential cache functions */
62 /** @defgroup krb5_credential Heimdal Kerberos 5 credential handing functions */
63 /** @defgroup krb5_deprecated Heimdal Kerberos 5 deprecated functions */
64 /** @defgroup krb5_digest Heimdal Kerberos 5 digest service */
65 /** @defgroup krb5_error Heimdal Kerberos 5 error reporting functions */
66 /** @defgroup krb5_v4compat Heimdal Kerberos 4 compatiblity functions */
67 /** @defgroup krb5_support Heimdal Kerberos 5 support functions */
68