1 /* dnstap support for Unbound */
4 * Copyright (c) 2013-2014, Farsight Security, Inc.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the copyright holder nor the names of its
19 * contributors may be used to endorse or promote products derived from
20 * this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
24 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
25 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
26 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
27 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
28 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
29 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
30 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
31 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
32 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 #ifndef UNBOUND_DNSTAP_H
36 #define UNBOUND_DNSTAP_H
38 #include "dnstap/dnstap_config.h"
47 /** the io thread (made by the struct daemon) */
48 struct dt_io_thread* dtio;
50 /** valid in worker struct, not in daemon struct, the per-worker
52 struct dt_msg_queue* msgqueue;
54 /** dnstap "identity" field, NULL if disabled */
57 /** dnstap "version" field, NULL if disabled */
60 /** length of "identity" field */
61 unsigned len_identity;
63 /** length of "version" field */
66 /** whether to log Message/RESOLVER_QUERY */
67 unsigned log_resolver_query_messages : 1;
68 /** whether to log Message/RESOLVER_RESPONSE */
69 unsigned log_resolver_response_messages : 1;
70 /** whether to log Message/CLIENT_QUERY */
71 unsigned log_client_query_messages : 1;
72 /** whether to log Message/CLIENT_RESPONSE */
73 unsigned log_client_response_messages : 1;
74 /** whether to log Message/FORWARDER_QUERY */
75 unsigned log_forwarder_query_messages : 1;
76 /** whether to log Message/FORWARDER_RESPONSE */
77 unsigned log_forwarder_response_messages : 1;
81 * Create dnstap environment object. Afterwards, call dt_apply_cfg() to fill in
82 * the config variables and dt_init() to fill in the per-worker state. Each
83 * worker needs a copy of this object but with its own I/O queue (the fq field
84 * of the structure) to ensure lock-free access to its own per-worker circular
85 * queue. Duplicate the environment object if more than one worker needs to
86 * share access to the dnstap I/O socket.
87 * @param cfg: with config settings.
88 * @return dt_env object, NULL on failure.
91 dt_create(struct config_file* cfg);
94 * Apply config settings.
95 * @param env: dnstap environment object.
96 * @param cfg: new config settings.
99 dt_apply_cfg(struct dt_env *env, struct config_file *cfg);
102 * Initialize per-worker state in dnstap environment object.
103 * @param env: dnstap environment object to initialize, created with dt_create().
104 * @return: true on success, false on failure.
107 dt_init(struct dt_env *env);
110 * Deletes the per-worker state created by dt_init
112 void dt_deinit(struct dt_env *env);
115 * Delete dnstap environment object. Closes dnstap I/O socket and deletes all
116 * per-worker I/O queues.
119 dt_delete(struct dt_env *env);
122 * Create and send a new dnstap "Message" event of type CLIENT_QUERY.
123 * @param env: dnstap environment object.
124 * @param qsock: address/port of client.
125 * @param cptype: comm_udp or comm_tcp.
126 * @param qmsg: query message.
129 dt_msg_send_client_query(struct dt_env *env,
130 struct sockaddr_storage *qsock,
131 enum comm_point_type cptype,
132 struct sldns_buffer *qmsg);
135 * Create and send a new dnstap "Message" event of type CLIENT_RESPONSE.
136 * @param env: dnstap environment object.
137 * @param qsock: address/port of client.
138 * @param cptype: comm_udp or comm_tcp.
139 * @param rmsg: response message.
142 dt_msg_send_client_response(struct dt_env *env,
143 struct sockaddr_storage *qsock,
144 enum comm_point_type cptype,
145 struct sldns_buffer *rmsg);
148 * Create and send a new dnstap "Message" event of type RESOLVER_QUERY or
149 * FORWARDER_QUERY. The type used is dependent on the value of the RD bit
150 * in the query header.
151 * @param env: dnstap environment object.
152 * @param rsock: address/port of server the query is being sent to.
153 * @param cptype: comm_udp or comm_tcp.
154 * @param zone: query zone.
155 * @param zone_len: length of zone.
156 * @param qmsg: query message.
159 dt_msg_send_outside_query(struct dt_env *env,
160 struct sockaddr_storage *rsock,
161 enum comm_point_type cptype,
162 uint8_t *zone, size_t zone_len,
163 struct sldns_buffer *qmsg);
166 * Create and send a new dnstap "Message" event of type RESOLVER_RESPONSE or
167 * FORWARDER_RESPONSE. The type used is dependent on the value of the RD bit
168 * in the query header.
169 * @param env: dnstap environment object.
170 * @param rsock: address/port of server the response was received from.
171 * @param cptype: comm_udp or comm_tcp.
172 * @param zone: query zone.
173 * @param zone_len: length of zone.
174 * @param qbuf: outside_network's qbuf key.
175 * @param qbuf_len: length of outside_network's qbuf key.
176 * @param qtime: time query message was sent.
177 * @param rtime: time response message was sent.
178 * @param rmsg: response message.
181 dt_msg_send_outside_response(struct dt_env *env,
182 struct sockaddr_storage *rsock,
183 enum comm_point_type cptype,
184 uint8_t *zone, size_t zone_len,
185 uint8_t *qbuf, size_t qbuf_len,
186 const struct timeval *qtime,
187 const struct timeval *rtime,
188 struct sldns_buffer *rmsg);
190 #endif /* USE_DNSTAP */
192 #endif /* UNBOUND_DNSTAP_H */