1 /*------------------------------------------------------------------------------
2  *
3  * Copyright (c) 2011-2021, EURid vzw. All rights reserved.
4  * The YADIFA TM software product is provided under the BSD 3-clause license:
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  *        * Redistributions of source code must retain the above copyright
11  *          notice, this list of conditions and the following disclaimer.
12  *        * Redistributions in binary form must reproduce the above copyright
13  *          notice, this list of conditions and the following disclaimer in the
14  *          documentation and/or other materials provided with the distribution.
15  *        * Neither the name of EURid nor the names of its contributors may be
16  *          used to endorse or promote products derived from this software
17  *          without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  *
31  *------------------------------------------------------------------------------
32  *
33  */
34 
35 /** @defgroup
36  *  @ingroup
37  *  @brief
38  *
39  *
40  *
41  * @{
42  *
43  *----------------------------------------------------------------------------*/
44 
45 #pragma once
46 
47 #include<dnscore/dnskey.h>
48 
49 #include <dynamic-module-interface.h>
50 
51 struct dynamic_module_interface_chain;
52 struct dynamic_module_dnskey_interface_chain;
53 struct dynamic_module_statistics_interface_chain;
54 struct server_statistics_t;
55 
56 #if !DYNAMIC_MODULE_HANDLER_C
57 extern struct dynamic_module_interface_chain *g_dynamic_module_interface_chain;
58 extern struct dynamic_module_dnskey_interface_chain *g_dynamic_module_dnskey_interface_chain;
59 extern struct dynamic_module_statistics_interface_chain *g_dynamic_module_statistics_interface_chain;
60 #endif
61 
62 /**
63  * Trivial.
64  */
65 
66 ya_result dynamic_module_handler_init();
67 
68 /**
69  * Trivial.
70  */
71 
72 ya_result dynamic_module_handler_finalize();
73 
74 /**
75  * Loads a module given its full path name (with luck relative may work too ... so yes: full path)
76  * Don't forget to take into account the choot.
77  *
78  * Modules should only be loaded AFTER the last fork.
79  */
80 
81 ya_result dynamic_module_handler_load(int argc, const char **argv);
82 
83 ya_result dynamic_module_handler_load_from_command(const char *command);
84 
dynamic_module_interface_chain_available()85 static inline bool dynamic_module_interface_chain_available()
86 {
87     return g_dynamic_module_interface_chain != NULL;
88 }
89 
dynamic_module_dnskey_interface_chain_available()90 static inline bool dynamic_module_dnskey_interface_chain_available()
91 {
92     return g_dynamic_module_dnskey_interface_chain != NULL;
93 }
94 
dynamic_module_statistics_interface_chain_available()95 static inline bool dynamic_module_statistics_interface_chain_available()
96 {
97     return g_dynamic_module_statistics_interface_chain != NULL;
98 }
99 
100 // interface
101 
102 void dynamic_module_startup();
103 void dynamic_module_settings();
104 void dynamic_module_shutdown();
105 
106 // dnskey_interface
107 
108 void dynamic_module_on_dnskey_created(const dnssec_key *key);
109 void dynamic_module_on_dnskey_publish(const dnssec_key *key);
110 void dynamic_module_on_dnskey_activate(const dnssec_key *key);
111 void dynamic_module_on_dnskey_revoke(const dnssec_key *key);
112 void dynamic_module_on_dnskey_inactive(const dnssec_key *key);
113 void dynamic_module_on_dnskey_delete(const dnssec_key *key);
114 
115 #define DYNAMIC_MODULE_STATISTICS_RCODE_COUNT 32
116 #define DYNAMIC_MODULE_STATISTICS_TSIG_RCODE_COUNT 4
117 
118 struct dynamic_module_statistics_args_buffers
119 {
120     uint64_t udp_rcode_buffer[DYNAMIC_MODULE_STATISTICS_RCODE_COUNT];
121     uint64_t tcp_rcode_buffer[DYNAMIC_MODULE_STATISTICS_RCODE_COUNT];
122     uint64_t udp_tsig_rcode_buffer[DYNAMIC_MODULE_STATISTICS_TSIG_RCODE_COUNT];
123     uint64_t tcp_tsig_rcode_buffer[DYNAMIC_MODULE_STATISTICS_TSIG_RCODE_COUNT];
124 };
125 
126 void dynamic_module_on_statistics_update(struct server_statistics_t *st, u64 epoch);
127 
128 /**
129  * @}
130  */
131