xref: /freebsd/crypto/krb5/doc/html/plugindev/index.html (revision 7f2fe78b9dd5f51c821d771b63d2e096f6fd49e9)
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>For plugin module developers &#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="General plugin concepts" href="general.html" />
22    <link rel="prev" title="krb524_init_ets" href="../appdev/refs/macros/krb524_init_ets.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="../appdev/refs/macros/krb524_init_ets.html" title="krb524_init_ets"
35            accesskey="P">previous</a> |
36        <a href="general.html" title="General plugin concepts"
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__For plugin module developers">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="for-plugin-module-developers">
56<h1>For plugin module developers<a class="headerlink" href="#for-plugin-module-developers" title="Permalink to this headline">¶</a></h1>
57<p>Kerberos plugin modules allow increased control over MIT krb5 library
58and server behavior.  This guide describes how to create dynamic
59plugin modules and the currently available pluggable interfaces.</p>
60<p>See <a class="reference internal" href="../admin/host_config.html#plugin-config"><span class="std std-ref">Plugin module configuration</span></a> for information on how to register dynamic
61plugin modules and how to enable and disable modules via
62<a class="reference internal" href="../admin/conf_files/krb5_conf.html#krb5-conf-5"><span class="std std-ref">krb5.conf</span></a>.</p>
63<section id="contents">
64<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h2>
65<div class="toctree-wrapper compound">
66<ul>
67<li class="toctree-l1"><a class="reference internal" href="general.html">General plugin concepts</a><ul>
68<li class="toctree-l2"><a class="reference internal" href="general.html#logging-from-kdc-and-kadmind-plugin-modules">Logging from KDC and kadmind plugin modules</a></li>
69</ul>
70</li>
71<li class="toctree-l1"><a class="reference internal" href="clpreauth.html">Client preauthentication interface (clpreauth)</a></li>
72<li class="toctree-l1"><a class="reference internal" href="kdcpreauth.html">KDC preauthentication interface (kdcpreauth)</a></li>
73<li class="toctree-l1"><a class="reference internal" href="ccselect.html">Credential cache selection interface (ccselect)</a></li>
74<li class="toctree-l1"><a class="reference internal" href="pwqual.html">Password quality interface (pwqual)</a></li>
75<li class="toctree-l1"><a class="reference internal" href="kadm5_hook.html">KADM5 hook interface (kadm5_hook)</a></li>
76<li class="toctree-l1"><a class="reference internal" href="kadm5_auth.html">kadmin authorization interface (kadm5_auth)</a></li>
77<li class="toctree-l1"><a class="reference internal" href="hostrealm.html">Host-to-realm interface (hostrealm)</a></li>
78<li class="toctree-l1"><a class="reference internal" href="localauth.html">Local authorization interface (localauth)</a></li>
79<li class="toctree-l1"><a class="reference internal" href="locate.html">Server location interface (locate)</a></li>
80<li class="toctree-l1"><a class="reference internal" href="profile.html">Configuration interface (profile)</a></li>
81<li class="toctree-l1"><a class="reference internal" href="gssapi.html">GSSAPI mechanism interface</a><ul>
82<li class="toctree-l2"><a class="reference internal" href="gssapi.html#negoex-modules">NegoEx modules</a></li>
83<li class="toctree-l2"><a class="reference internal" href="gssapi.html#interposer-modules">Interposer modules</a></li>
84</ul>
85</li>
86<li class="toctree-l1"><a class="reference internal" href="internal.html">Internal pluggable interfaces</a><ul>
87<li class="toctree-l2"><a class="reference internal" href="internal.html#kerberos-database-interface-kdb">Kerberos database interface (KDB)</a></li>
88<li class="toctree-l2"><a class="reference internal" href="internal.html#authorization-data-interface-authdata">Authorization data interface (authdata)</a></li>
89</ul>
90</li>
91<li class="toctree-l1"><a class="reference internal" href="certauth.html">PKINIT certificate authorization interface (certauth)</a></li>
92<li class="toctree-l1"><a class="reference internal" href="kdcpolicy.html">KDC policy interface (kdcpolicy)</a></li>
93</ul>
94</div>
95</section>
96</section>
97
98
99            <div class="clearer"></div>
100          </div>
101        </div>
102      </div>
103        </div>
104        <div class="sidebar">
105
106    <h2>On this page</h2>
107    <ul>
108<li><a class="reference internal" href="#">For plugin module developers</a><ul>
109<li><a class="reference internal" href="#contents">Contents</a></li>
110</ul>
111</li>
112</ul>
113
114    <br/>
115    <h2>Table of contents</h2>
116    <ul class="current">
117<li class="toctree-l1"><a class="reference internal" href="../user/index.html">For users</a></li>
118<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">For administrators</a></li>
119<li class="toctree-l1"><a class="reference internal" href="../appdev/index.html">For application developers</a></li>
120<li class="toctree-l1 current"><a class="current reference internal" href="#">For plugin module developers</a><ul>
121<li class="toctree-l2"><a class="reference internal" href="general.html">General plugin concepts</a></li>
122<li class="toctree-l2"><a class="reference internal" href="clpreauth.html">Client preauthentication interface (clpreauth)</a></li>
123<li class="toctree-l2"><a class="reference internal" href="kdcpreauth.html">KDC preauthentication interface (kdcpreauth)</a></li>
124<li class="toctree-l2"><a class="reference internal" href="ccselect.html">Credential cache selection interface (ccselect)</a></li>
125<li class="toctree-l2"><a class="reference internal" href="pwqual.html">Password quality interface (pwqual)</a></li>
126<li class="toctree-l2"><a class="reference internal" href="kadm5_hook.html">KADM5 hook interface (kadm5_hook)</a></li>
127<li class="toctree-l2"><a class="reference internal" href="kadm5_auth.html">kadmin authorization interface (kadm5_auth)</a></li>
128<li class="toctree-l2"><a class="reference internal" href="hostrealm.html">Host-to-realm interface (hostrealm)</a></li>
129<li class="toctree-l2"><a class="reference internal" href="localauth.html">Local authorization interface (localauth)</a></li>
130<li class="toctree-l2"><a class="reference internal" href="locate.html">Server location interface (locate)</a></li>
131<li class="toctree-l2"><a class="reference internal" href="profile.html">Configuration interface (profile)</a></li>
132<li class="toctree-l2"><a class="reference internal" href="gssapi.html">GSSAPI mechanism interface</a></li>
133<li class="toctree-l2"><a class="reference internal" href="internal.html">Internal pluggable interfaces</a></li>
134<li class="toctree-l2"><a class="reference internal" href="certauth.html">PKINIT certificate authorization interface (certauth)</a></li>
135<li class="toctree-l2"><a class="reference internal" href="kdcpolicy.html">KDC policy interface (kdcpolicy)</a></li>
136</ul>
137</li>
138<li class="toctree-l1"><a class="reference internal" href="../build/index.html">Building Kerberos V5</a></li>
139<li class="toctree-l1"><a class="reference internal" href="../basic/index.html">Kerberos V5 concepts</a></li>
140<li class="toctree-l1"><a class="reference internal" href="../formats/index.html">Protocols and file formats</a></li>
141<li class="toctree-l1"><a class="reference internal" href="../mitK5features.html">MIT Kerberos features</a></li>
142<li class="toctree-l1"><a class="reference internal" href="../build_this.html">How to build this documentation from the source</a></li>
143<li class="toctree-l1"><a class="reference internal" href="../about.html">Contributing to the MIT Kerberos Documentation</a></li>
144<li class="toctree-l1"><a class="reference internal" href="../resources.html">Resources</a></li>
145</ul>
146
147    <br/>
148    <h4><a href="../index.html">Full Table of Contents</a></h4>
149    <h4>Search</h4>
150    <form class="search" action="../search.html" method="get">
151      <input type="text" name="q" size="18" />
152      <input type="submit" value="Go" />
153      <input type="hidden" name="check_keywords" value="yes" />
154      <input type="hidden" name="area" value="default" />
155    </form>
156
157        </div>
158        <div class="clearer"></div>
159      </div>
160    </div>
161
162    <div class="footer-wrapper">
163        <div class="footer" >
164            <div class="right" ><i>Release: 1.21.3</i><br />
165                &copy; <a href="../copyright.html">Copyright</a> 1985-2024, MIT.
166            </div>
167            <div class="left">
168
169        <a href="../index.html" title="Full Table of Contents"
170            >Contents</a> |
171        <a href="../appdev/refs/macros/krb524_init_ets.html" title="krb524_init_ets"
172            >previous</a> |
173        <a href="general.html" title="General plugin concepts"
174            >next</a> |
175        <a href="../genindex.html" title="General Index"
176            >index</a> |
177        <a href="../search.html" title="Enter search criteria"
178            >Search</a> |
179    <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__For plugin module developers">feedback</a>
180            </div>
181        </div>
182    </div>
183
184  </body>
185</html>