xref: /freebsd/crypto/krb5/doc/html/plugindev/internal.html (revision b670c9bafc0e31c7609969bf374b2e80bdc00211)
1
2<!DOCTYPE html>
3
4<html>
5  <head>
6    <meta charset="utf-8" />
7    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
8
9    <title>Internal pluggable interfaces &#8212; MIT Kerberos Documentation</title>
10    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
11    <link rel="stylesheet" type="text/css" href="../_static/agogo.css" />
12    <link rel="stylesheet" type="text/css" href="../_static/kerb.css" />
13    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
14    <script src="../_static/jquery.js"></script>
15    <script src="../_static/underscore.js"></script>
16    <script src="../_static/doctools.js"></script>
17    <link rel="author" title="About these documents" href="../about.html" />
18    <link rel="index" title="Index" href="../genindex.html" />
19    <link rel="search" title="Search" href="../search.html" />
20    <link rel="copyright" title="Copyright" href="../copyright.html" />
21    <link rel="next" title="PKINIT certificate authorization interface (certauth)" href="certauth.html" />
22    <link rel="prev" title="GSSAPI mechanism interface" href="gssapi.html" />
23  </head><body>
24    <div class="header-wrapper">
25        <div class="header">
26
27
28            <h1><a href="../index.html">MIT Kerberos Documentation</a></h1>
29
30            <div class="rel">
31
32        <a href="../index.html" title="Full Table of Contents"
33            accesskey="C">Contents</a> |
34        <a href="gssapi.html" title="GSSAPI mechanism interface"
35            accesskey="P">previous</a> |
36        <a href="certauth.html" title="PKINIT certificate authorization interface (certauth)"
37            accesskey="N">next</a> |
38        <a href="../genindex.html" title="General Index"
39            accesskey="I">index</a> |
40        <a href="../search.html" title="Enter search criteria"
41            accesskey="S">Search</a> |
42    <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__Internal pluggable interfaces">feedback</a>
43            </div>
44        </div>
45    </div>
46
47    <div class="content-wrapper">
48      <div class="content">
49        <div class="document">
50
51      <div class="documentwrapper">
52        <div class="bodywrapper">
53          <div class="body" role="main">
54
55  <section id="internal-pluggable-interfaces">
56<h1>Internal pluggable interfaces<a class="headerlink" href="#internal-pluggable-interfaces" title="Permalink to this headline">¶</a></h1>
57<p>Following are brief discussions of pluggable interfaces which have not
58yet been made public.  These interfaces are functional, but the
59interfaces are likely to change in incompatible ways from release to
60release.  In some cases, it may be necessary to copy header files from
61the krb5 source tree to use an internal interface.  Use these with
62care, and expect to need to update your modules for each new release
63of MIT krb5.</p>
64<section id="kerberos-database-interface-kdb">
65<h2>Kerberos database interface (KDB)<a class="headerlink" href="#kerberos-database-interface-kdb" title="Permalink to this headline">¶</a></h2>
66<p>A KDB module implements a database back end for KDC principal and
67policy information, and can also control many aspects of KDC behavior.
68For a full description of the interface, see the header file
69<code class="docutils literal notranslate"><span class="pre">&lt;kdb.h&gt;</span></code>.</p>
70<p>The KDB pluggable interface is often referred to as the DAL (Database
71Access Layer).</p>
72</section>
73<section id="authorization-data-interface-authdata">
74<h2>Authorization data interface (authdata)<a class="headerlink" href="#authorization-data-interface-authdata" title="Permalink to this headline">¶</a></h2>
75<p>The authdata interface allows a module to provide (from the KDC) or
76consume (in application servers) authorization data of types beyond
77those handled by the core MIT krb5 code base.  The interface is
78defined in the header file <code class="docutils literal notranslate"><span class="pre">&lt;krb5/authdata_plugin.h&gt;</span></code>, which is not
79installed by the build.</p>
80</section>
81</section>
82
83
84            <div class="clearer"></div>
85          </div>
86        </div>
87      </div>
88        </div>
89        <div class="sidebar">
90
91    <h2>On this page</h2>
92    <ul>
93<li><a class="reference internal" href="#">Internal pluggable interfaces</a><ul>
94<li><a class="reference internal" href="#kerberos-database-interface-kdb">Kerberos database interface (KDB)</a></li>
95<li><a class="reference internal" href="#authorization-data-interface-authdata">Authorization data interface (authdata)</a></li>
96</ul>
97</li>
98</ul>
99
100    <br/>
101    <h2>Table of contents</h2>
102    <ul class="current">
103<li class="toctree-l1"><a class="reference internal" href="../user/index.html">For users</a></li>
104<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">For administrators</a></li>
105<li class="toctree-l1"><a class="reference internal" href="../appdev/index.html">For application developers</a></li>
106<li class="toctree-l1 current"><a class="reference internal" href="index.html">For plugin module developers</a><ul class="current">
107<li class="toctree-l2"><a class="reference internal" href="general.html">General plugin concepts</a></li>
108<li class="toctree-l2"><a class="reference internal" href="clpreauth.html">Client preauthentication interface (clpreauth)</a></li>
109<li class="toctree-l2"><a class="reference internal" href="kdcpreauth.html">KDC preauthentication interface (kdcpreauth)</a></li>
110<li class="toctree-l2"><a class="reference internal" href="ccselect.html">Credential cache selection interface (ccselect)</a></li>
111<li class="toctree-l2"><a class="reference internal" href="pwqual.html">Password quality interface (pwqual)</a></li>
112<li class="toctree-l2"><a class="reference internal" href="kadm5_hook.html">KADM5 hook interface (kadm5_hook)</a></li>
113<li class="toctree-l2"><a class="reference internal" href="kadm5_auth.html">kadmin authorization interface (kadm5_auth)</a></li>
114<li class="toctree-l2"><a class="reference internal" href="hostrealm.html">Host-to-realm interface (hostrealm)</a></li>
115<li class="toctree-l2"><a class="reference internal" href="localauth.html">Local authorization interface (localauth)</a></li>
116<li class="toctree-l2"><a class="reference internal" href="locate.html">Server location interface (locate)</a></li>
117<li class="toctree-l2"><a class="reference internal" href="profile.html">Configuration interface (profile)</a></li>
118<li class="toctree-l2"><a class="reference internal" href="gssapi.html">GSSAPI mechanism interface</a></li>
119<li class="toctree-l2 current"><a class="current reference internal" href="#">Internal pluggable interfaces</a></li>
120<li class="toctree-l2"><a class="reference internal" href="certauth.html">PKINIT certificate authorization interface (certauth)</a></li>
121<li class="toctree-l2"><a class="reference internal" href="kdcpolicy.html">KDC policy interface (kdcpolicy)</a></li>
122</ul>
123</li>
124<li class="toctree-l1"><a class="reference internal" href="../build/index.html">Building Kerberos V5</a></li>
125<li class="toctree-l1"><a class="reference internal" href="../basic/index.html">Kerberos V5 concepts</a></li>
126<li class="toctree-l1"><a class="reference internal" href="../formats/index.html">Protocols and file formats</a></li>
127<li class="toctree-l1"><a class="reference internal" href="../mitK5features.html">MIT Kerberos features</a></li>
128<li class="toctree-l1"><a class="reference internal" href="../build_this.html">How to build this documentation from the source</a></li>
129<li class="toctree-l1"><a class="reference internal" href="../about.html">Contributing to the MIT Kerberos Documentation</a></li>
130<li class="toctree-l1"><a class="reference internal" href="../resources.html">Resources</a></li>
131</ul>
132
133    <br/>
134    <h4><a href="../index.html">Full Table of Contents</a></h4>
135    <h4>Search</h4>
136    <form class="search" action="../search.html" method="get">
137      <input type="text" name="q" size="18" />
138      <input type="submit" value="Go" />
139      <input type="hidden" name="check_keywords" value="yes" />
140      <input type="hidden" name="area" value="default" />
141    </form>
142
143        </div>
144        <div class="clearer"></div>
145      </div>
146    </div>
147
148    <div class="footer-wrapper">
149        <div class="footer" >
150            <div class="right" ><i>Release: 1.21.3</i><br />
151                &copy; <a href="../copyright.html">Copyright</a> 1985-2024, MIT.
152            </div>
153            <div class="left">
154
155        <a href="../index.html" title="Full Table of Contents"
156            >Contents</a> |
157        <a href="gssapi.html" title="GSSAPI mechanism interface"
158            >previous</a> |
159        <a href="certauth.html" title="PKINIT certificate authorization interface (certauth)"
160            >next</a> |
161        <a href="../genindex.html" title="General Index"
162            >index</a> |
163        <a href="../search.html" title="Enter search criteria"
164            >Search</a> |
165    <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__Internal pluggable interfaces">feedback</a>
166            </div>
167        </div>
168    </div>
169
170  </body>
171</html>