xref: /freebsd/crypto/krb5/src/include/krb5/plugin.h (revision 7f2fe78b9dd5f51c821d771b63d2e096f6fd49e9)
1 /* -*- mode: c; c-basic-offset: 4; indent-tabs-mode: nil -*- */
2 /*
3  * Copyright (C) 2010 by the Massachusetts Institute of Technology.
4  * All rights reserved.
5  *
6  * Export of this software from the United States of America may
7  *   require a specific license from the United States Government.
8  *   It is the responsibility of any person or organization contemplating
9  *   export to obtain such a license before exporting.
10  *
11  * WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
12  * distribute this software and its documentation for any purpose and
13  * without fee is hereby granted, provided that the above copyright
14  * notice appear in all copies and that both that copyright notice and
15  * this permission notice appear in supporting documentation, and that
16  * the name of M.I.T. not be used in advertising or publicity pertaining
17  * to distribution of the software without specific, written prior
18  * permission.  Furthermore if you modify this software you must label
19  * your software as modified software and not distribute it in such a
20  * fashion that it might be confused with the original M.I.T. software.
21  * M.I.T. makes no representations about the suitability of
22  * this software for any purpose.  It is provided "as is" without express
23  * or implied warranty.
24  */
25 
26 /* Generic declarations for dynamic modules implementing krb5 plugin
27  * modules. */
28 
29 #ifndef KRB5_PLUGIN_H
30 #define KRB5_PLUGIN_H
31 
32 /* krb5_plugin_vtable is an abstract type.  Module initvt functions will cast
33  * it to the appropriate interface-specific vtable type. */
34 typedef struct krb5_plugin_vtable_st *krb5_plugin_vtable;
35 
36 /*
37  * krb5_plugin_initvt_fn is the type of all module initvt functions.  Based on
38  * the maj_ver argument, the initvt function should cast vtable to the
39  * appropriate type and then fill it in.  If a vtable has been expanded,
40  * min_ver indicates which version of the vtable is being filled in.
41  */
42 typedef krb5_error_code
43 (*krb5_plugin_initvt_fn)(krb5_context context, int maj_ver, int min_ver,
44                          krb5_plugin_vtable vtable);
45 
46 #endif /* KRB5_PLUGIN_H */
47