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