lib/krb5/db_plugin.h

   1 /*
   2  * Copyright (c) 2011, Secure Endpoints Inc.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * - Redistributions of source code must retain the above copyright
  10  *   notice, this list of conditions and the following disclaimer.
  11  *
  12  * - Redistributions in binary form must reproduce the above copyright
  13  *   notice, this list of conditions and the following disclaimer in
  14  *   the documentation and/or other materials provided with the
  15  *   distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  20  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  21  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  22  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  24  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  26  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  28  * OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 /* $Id$ */
  32
  33 #ifndef HEIMDAL_KRB5_DB_PLUGIN_H
  34 #define HEIMDAL_KRB5_DB_PLUGIN_H 1
  35
  36 #define KRB5_PLUGIN_DB "krb5_db_plug"
  37 #define KRB5_PLUGIN_DB_VERSION_0 0
  38
  39 /** @struct krb5plugin_db_ftable_desc
  40  *
  41  * @brief Description of the krb5 DB plugin facility.
  42  *
  43  * The krb5_aname_to_lname(3) function's DB rule is pluggable.  The
  44  * plugin is named KRB5_PLUGIN_DB ("krb5_db_plug"), with a single minor
  45  * version, KRB5_PLUGIN_DB_VERSION_0 (0).
  46  *
  47  * The plugin consists of a data symbol referencing a structure of type
  48  * krb5plugin_db_ftable_desc, with three fields:
  49  *
  50  * @param init          Plugin initialization function (see krb5-plugin(7))
  51  *
  52  * @param minor_version The plugin minor version number (0)
  53  *
  54  * @param fini          Plugin finalization function
  55  *
  56  * The init entry point is expected to call heim_db_register().  The
  57  * fini entry point is expected to do nothing.
  58  *
  59  * @ingroup krb5_support
  60  */
  61 typedef struct krb5plugin_db_ftable_desc {
  62     int                 minor_version;
  63     krb5_error_code     (KRB5_LIB_CALL *init)(krb5_context, void **);
  64     void                (KRB5_LIB_CALL *fini)(void *);
  65 } krb5plugin_db_ftable;
  66
  67 #endif /* HEIMDAL_KRB5_DB_PLUGIN_H */
  68