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