.\"	$NetBSD: krb5plugin_an2ln_ftable_desc.3,v 1.3 2023/06/19 21:41:40 christos Exp $
.\"
.TH "krb5plugin_an2ln_ftable_desc" 3 "Tue Nov 15 2022" "Version 7.8.0" "Heimdal Kerberos 5 library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
krb5plugin_an2ln_ftable_desc \- Description of the krb5_aname_to_lname(3) plugin facility\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <an2ln_plugin\&.h>\fP
.SH "Detailed Description"
.PP 
Description of the krb5_aname_to_lname(3) plugin facility\&. 

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)\&.
.PP
The plugin for krb5_aname_to_lname(3) consists of a data symbol referencing a structure of type krb5plugin_an2ln_ftable, with four fields:
.PP
\fBParameters\fP
.RS 4
\fIinit\fP Plugin initialization function (see krb5-plugin(7))
.br
\fIminor_version\fP The plugin minor version number (0)
.br
\fIfini\fP Plugin finalization function
.br
\fIan2ln\fP Plugin aname_to_lname function
.RE
.PP
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\&.
.PP
The plugin an2ln function has the following arguments, in this order:
.PP
.IP "1." 4
plug_ctx, the context value output by the plugin's init function
.IP "2." 4
context, a krb5_context
.IP "3." 4
rule, the aname_to_lname rule being evaluated (from krb5\&.conf(5))
.IP "4." 4
aname, the krb5_principal to be mapped to an lname
.IP "5." 4
set_res_f, a function the plugin must call to set its result
.IP "6." 4
set_res_ctx, the first argument to set_res_f (the second is the result lname string) 
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for Heimdal Kerberos 5 library from the source code\&.