xref: /freebsd/crypto/krb5/doc/build/directory_org.rst (revision 7f2fe78b9dd5f51c821d771b63d2e096f6fd49e9)
1Organization of the source directory
2====================================
3
4Below is a brief overview of the organization of the complete source
5directory.  More detailed descriptions follow.
6
7=============== ==============================================
8appl             Kerberos application client and server programs
9ccapi            Credential cache services
10clients          Kerberos V5 user programs (See :ref:`user_commands`)
11config           Configure scripts
12config-files     Sample Kerberos configuration files
13include          include files needed to build the Kerberos system
14kadmin           Administrative interface to the Kerberos database: :ref:`kadmin(1)`, :ref:`kdb5_util(8)`, :ref:`ktutil(1)`.
15kdc              Kerberos V5 Authentication Service and Key Distribution Center
16lib_             Libraries for use with/by Kerberos V5
17plugins          Kerberos plugins directory
18po               Localization infrastructure
19prototype        Templates files containing the MIT copyright message and a placeholder for the title and description of the file.
20kprop            Utilities for propagating the database to replica KDCs :ref:`kprop(8)` and :ref:`kpropd(8)`
21tests            Test suite
22util_            Various utilities for building/configuring the code, sending bug reports, etc.
23windows          Source code for building Kerberos V5 on Windows (see windows/README)
24=============== ==============================================
25
26
27.. _lib:
28
29lib
30---
31
32The lib directory contain several subdirectories as well as some
33definition and glue files.
34
35  - The apputils directory contains the code for the generic network
36    servicing.
37  - The crypto subdirectory contains the Kerberos V5 encryption
38    library.
39  - The gssapi library contains the Generic Security Services API,
40    which is a library of commands to be used in secure client-server
41    communication.
42  - The kadm5 directory contains the libraries for the KADM5
43    administration utilities.
44  - The Kerberos 5 database libraries are contained in kdb.
45  - The krb5 directory contains Kerberos 5 API.
46  - The rpc directory contains the API for the Kerberos Remote
47    Procedure Call protocol.
48
49
50.. _util:
51
52util
53----
54
55The util directory contains several utility programs and libraries.
56  - the programs used to configure and build the code, such as
57    autoconf, lndir, kbuild, reconf, and makedepend, are in this
58    directory.
59  - the profile directory contains most of the functions which parse
60    the Kerberos configuration files (krb5.conf and kdc.conf).
61  - the Kerberos error table library and utilities (et);
62  - the Sub-system library and utilities (ss);
63  - database utilities (db2);
64  - pseudo-terminal utilities (pty);
65  - bug-reporting program send-pr;
66  - a generic support library support used by several of our other
67    libraries;
68  - the build infrastructure for building lightweight Kerberos client
69    (collected-client-lib)
70  - the tool for validating Kerberos configuration files
71    (confvalidator);
72  - the toolkit for kernel integrators for building krb5 code subsets
73    (gss-kernel-lib);
74  - source code for building Kerberos V5 on MacOS (mac)
75  - Windows getopt operations (windows)
76