1 /* $NetBSD: an2ln_plugin.h,v 1.2 2017/01/28 21:31:49 christos Exp $ */ 2 3 /* 4 * Copyright (c) 2006 Kungliga Tekniska Högskolan 5 * (Royal Institute of Technology, Stockholm, Sweden). 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 19 * 3. Neither the name of the Institute nor the names of its contributors 20 * may be used to endorse or promote products derived from this software 21 * without specific prior written permission. 22 * 23 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND 24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 26 * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE 27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33 * SUCH DAMAGE. 34 */ 35 36 /* Id */ 37 38 #ifndef HEIMDAL_KRB5_AN2LN_PLUGIN_H 39 #define HEIMDAL_KRB5_AN2LN_PLUGIN_H 1 40 41 #define KRB5_PLUGIN_AN2LN "an2ln" 42 #define KRB5_PLUGIN_AN2LN_VERSION_0 0 43 44 typedef krb5_error_code (KRB5_LIB_CALL *set_result_f)(void *, const char *); 45 46 /** @struct krb5plugin_an2ln_ftable_desc 47 * 48 * @brief Description of the krb5_aname_to_lname(3) plugin facility. 49 * 50 * The krb5_aname_to_lname(3) function is pluggable. The plugin is 51 * named KRB5_PLUGIN_AN2LN ("an2ln"), with a single minor version, 52 * KRB5_PLUGIN_AN2LN_VERSION_0 (0). 53 * 54 * The plugin for krb5_aname_to_lname(3) consists of a data symbol 55 * referencing a structure of type krb5plugin_an2ln_ftable, with four 56 * fields: 57 * 58 * @param init Plugin initialization function (see krb5-plugin(7)) 59 * 60 * @param minor_version The plugin minor version number (0) 61 * 62 * @param fini Plugin finalization function 63 * 64 * @param an2ln Plugin aname_to_lname function 65 * 66 * The an2ln field is the plugin entry point that performs the 67 * traditional aname_to_lname operation however the plugin desires. It 68 * is invoked in no particular order relative to other an2ln plugins, 69 * but it has a 'rule' argument that indicates which plugin is intended 70 * to act on the rule. The plugin an2ln function must return 71 * KRB5_PLUGIN_NO_HANDLE if the rule is not applicable to it. 72 * 73 * The plugin an2ln function has the following arguments, in this order: 74 * 75 * -# plug_ctx, the context value output by the plugin's init function 76 * -# context, a krb5_context 77 * -# rule, the aname_to_lname rule being evaluated (from krb5.conf(5)) 78 * -# aname, the krb5_principal to be mapped to an lname 79 * -# set_res_f, a function the plugin must call to set its result 80 * -# set_res_ctx, the first argument to set_res_f (the second is the result lname string) 81 * 82 * @ingroup krb5_support 83 */ 84 typedef struct krb5plugin_an2ln_ftable_desc { 85 int minor_version; 86 krb5_error_code (KRB5_LIB_CALL *init)(krb5_context, void **); 87 void (KRB5_LIB_CALL *fini)(void *); 88 krb5_error_code (KRB5_LIB_CALL *an2ln)(void *, krb5_context, const char *, 89 krb5_const_principal, set_result_f, void *); 90 } krb5plugin_an2ln_ftable; 91 92 #endif /* HEIMDAL_KRB5_AN2LN_PLUGIN_H */ 93 94