1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>krb5plugin_an2ln_ftable_desc Struct Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<p>
8<a href="http://www.h5l.org/"><img src="http://www.h5l.org/keyhole-heimdal.png" alt="keyhole logo"/></a>
9</p>
10<!-- end of header marker -->
11<!-- Generated by Doxygen 1.9.1 -->
12<script type="text/javascript" src="menudata.js"></script>
13<script type="text/javascript" src="menu.js"></script>
14<script type="text/javascript">
15/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
16$(function() {
17  initMenu('',false,false,'search.php','Search');
18});
19/* @license-end */</script>
20<div id="main-nav"></div>
21</div><!-- top -->
22<div class="header">
23  <div class="headertitle">
24<div class="title">krb5plugin_an2ln_ftable_desc Struct Reference<div class="ingroups"><a class="el" href="group__krb5__support.html">Heimdal Kerberos 5 support functions</a></div></div>  </div>
25</div><!--header-->
26<div class="contents">
27
28<p>Description of the krb5_aname_to_lname(3) plugin facility.
29 <a href="structkrb5plugin__an2ln__ftable__desc.html#details">More...</a></p>
30
31<p><code>#include &lt;an2ln_plugin.h&gt;</code></p>
32<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
33<div class="textblock"><p>Description of the krb5_aname_to_lname(3) plugin facility. </p>
34<p>The krb5_aname_to_lname(3) function is pluggable. The plugin is named KRB5_PLUGIN_AN2LN ("an2ln"), with a single minor version, KRB5_PLUGIN_AN2LN_VERSION_0 (0).</p>
35<p>The plugin for krb5_aname_to_lname(3) consists of a data symbol referencing a structure of type krb5plugin_an2ln_ftable, with four fields:</p>
36<dl class="params"><dt>Parameters</dt><dd>
37  <table class="params">
38    <tr><td class="paramname">init</td><td>Plugin initialization function (see krb5-plugin(7))</td></tr>
39    <tr><td class="paramname">minor_version</td><td>The plugin minor version number (0)</td></tr>
40    <tr><td class="paramname">fini</td><td>Plugin finalization function</td></tr>
41    <tr><td class="paramname">an2ln</td><td>Plugin aname_to_lname function</td></tr>
42  </table>
43  </dd>
44</dl>
45<p>The an2ln field is the plugin entry point that performs the traditional aname_to_lname operation however the plugin desires. It is invoked in no particular order relative to other an2ln plugins, but it has a 'rule' argument that indicates which plugin is intended to act on the rule. The plugin an2ln function must return KRB5_PLUGIN_NO_HANDLE if the rule is not applicable to it.</p>
46<p>The plugin an2ln function has the following arguments, in this order:</p>
47<ol type="1">
48<li>plug_ctx, the context value output by the plugin's init function</li>
49<li>context, a krb5_context</li>
50<li>rule, the aname_to_lname rule being evaluated (from krb5.conf(5))</li>
51<li>aname, the krb5_principal to be mapped to an lname</li>
52<li>set_res_f, a function the plugin must call to set its result</li>
53<li>set_res_ctx, the first argument to set_res_f (the second is the result lname string) </li>
54</ol>
55</div><hr/>The documentation for this struct was generated from the following file:<ul>
56<li>/home/jaltman/src/sourdough-waffles/lib/krb5/an2ln_plugin.h</li>
57</ul>
58</div><!-- contents -->
59<hr size="1"><address style="text-align: right;"><small>
60Generated on Tue Nov 15 2022 14:04:26 for Heimdal Kerberos 5 library by&nbsp;<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.9.1</small></address>
61</body>
62</html>
63