include/krb5/plugin.h

0001 /* -*- mode: c; c-basic-offset: 4; indent-tabs-mode: nil -*- */
0002 /*
0003  * Copyright (C) 2010 by the Massachusetts Institute of Technology.
0004  * All rights reserved.
0005  *
0006  * Export of this software from the United States of America may
0007  *   require a specific license from the United States Government.
0008  *   It is the responsibility of any person or organization contemplating
0009  *   export to obtain such a license before exporting.
0010  *
0011  * WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
0012  * distribute this software and its documentation for any purpose and
0013  * without fee is hereby granted, provided that the above copyright
0014  * notice appear in all copies and that both that copyright notice and
0015  * this permission notice appear in supporting documentation, and that
0016  * the name of M.I.T. not be used in advertising or publicity pertaining
0017  * to distribution of the software without specific, written prior
0018  * permission.  Furthermore if you modify this software you must label
0019  * your software as modified software and not distribute it in such a
0020  * fashion that it might be confused with the original M.I.T. software.
0021  * M.I.T. makes no representations about the suitability of
0022  * this software for any purpose.  It is provided "as is" without express
0023  * or implied warranty.
0024  */
0025
0026 /* Generic declarations for dynamic modules implementing krb5 plugin
0027  * modules. */
0028
0029 #ifndef KRB5_PLUGIN_H
0030 #define KRB5_PLUGIN_H
0031
0032 /* krb5_plugin_vtable is an abstract type.  Module initvt functions will cast
0033  * it to the appropriate interface-specific vtable type. */
0034 typedef struct krb5_plugin_vtable_st *krb5_plugin_vtable;
0035
0036 /*
0037  * krb5_plugin_initvt_fn is the type of all module initvt functions.  Based on
0038  * the maj_ver argument, the initvt function should cast vtable to the
0039  * appropriate type and then fill it in.  If a vtable has been expanded,
0040  * min_ver indicates which version of the vtable is being filled in.
0041  */
0042 typedef krb5_error_code
0043 (*krb5_plugin_initvt_fn)(krb5_context context, int maj_ver, int min_ver,
0044                          krb5_plugin_vtable vtable);
0045
0046 #endif /* KRB5_PLUGIN_H */