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