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 #include "dnstap/dnstap_config.h"
42 #include "sldns/sbuffer.h"
43 #include "util/config_file.h"
44 #include "util/net_help.h"
45 #include "util/netevent.h"
49 #include <protobuf-c/protobuf-c.h>
51 #include "dnstap/dnstap.h"
52 #include "dnstap/dnstap.pb-c.h"
54 #define DNSTAP_CONTENT_TYPE "protobuf:dnstap.Dnstap"
55 #define DNSTAP_INITIAL_BUF_SIZE 256
65 dt_pack(const Dnstap__Dnstap *d, void **buf, size_t *sz)
67 ProtobufCBufferSimple sbuf;
69 memset(&sbuf, 0, sizeof(sbuf));
70 sbuf.base.append = protobuf_c_buffer_simple_append;
72 sbuf.alloced = DNSTAP_INITIAL_BUF_SIZE;
73 sbuf.data = malloc(sbuf.alloced);
74 if (sbuf.data == NULL)
76 sbuf.must_free_data = 1;
78 *sz = dnstap__dnstap__pack_to_buffer(d, (ProtobufCBuffer *) &sbuf);
79 if (sbuf.data == NULL)
87 dt_send(const struct dt_env *env, void *buf, size_t len_buf)
92 res = fstrm_iothr_submit(env->iothr, env->ioq, buf, len_buf,
93 fstrm_free_wrapper, NULL);
94 if (res != fstrm_res_success)
99 dt_msg_init(const struct dt_env *env,
101 Dnstap__Message__Type mtype)
103 memset(dm, 0, sizeof(*dm));
104 dm->d.base.descriptor = &dnstap__dnstap__descriptor;
105 dm->m.base.descriptor = &dnstap__message__descriptor;
106 dm->d.type = DNSTAP__DNSTAP__TYPE__MESSAGE;
107 dm->d.message = &dm->m;
109 if (env->identity != NULL) {
110 dm->d.identity.data = (uint8_t *) env->identity;
111 dm->d.identity.len = (size_t) env->len_identity;
112 dm->d.has_identity = 1;
114 if (env->version != NULL) {
115 dm->d.version.data = (uint8_t *) env->version;
116 dm->d.version.len = (size_t) env->len_version;
117 dm->d.has_version = 1;
122 dt_create(const char *socket_path, unsigned num_workers)
128 struct fstrm_iothr_options *fopt;
129 struct fstrm_unix_writer_options *fuwopt;
130 struct fstrm_writer *fw;
131 struct fstrm_writer_options *fwopt;
133 verbose(VERB_OPS, "attempting to connect to dnstap socket %s",
135 log_assert(socket_path != NULL);
136 log_assert(num_workers > 0);
138 env = (struct dt_env *) calloc(1, sizeof(struct dt_env));
142 fwopt = fstrm_writer_options_init();
148 fstrm_writer_options_add_content_type(fwopt,
149 DNSTAP_CONTENT_TYPE, sizeof(DNSTAP_CONTENT_TYPE) - 1);
150 log_assert(res == fstrm_res_success);
152 fuwopt = fstrm_unix_writer_options_init();
153 fstrm_unix_writer_options_set_socket_path(fuwopt, socket_path);
155 fw = fstrm_unix_writer_init(fuwopt, fwopt);
156 log_assert(fw != NULL);
158 fopt = fstrm_iothr_options_init();
159 fstrm_iothr_options_set_num_input_queues(fopt, num_workers);
160 env->iothr = fstrm_iothr_init(fopt, &fw);
161 if (env->iothr == NULL) {
162 verbose(VERB_DETAIL, "dt_create: fstrm_iothr_init() failed");
163 fstrm_writer_destroy(&fw);
167 fstrm_iothr_options_destroy(&fopt);
168 fstrm_unix_writer_options_destroy(&fuwopt);
169 fstrm_writer_options_destroy(&fwopt);
175 dt_apply_identity(struct dt_env *env, struct config_file *cfg)
177 char buf[MAXHOSTNAMELEN+1];
178 if (!cfg->dnstap_send_identity)
181 if (cfg->dnstap_identity == NULL || cfg->dnstap_identity[0] == 0) {
182 if (gethostname(buf, MAXHOSTNAMELEN) == 0) {
183 buf[MAXHOSTNAMELEN] = 0;
184 env->identity = strdup(buf);
186 fatal_exit("dt_apply_identity: gethostname() failed");
189 env->identity = strdup(cfg->dnstap_identity);
191 if (env->identity == NULL)
192 fatal_exit("dt_apply_identity: strdup() failed");
193 env->len_identity = (unsigned int)strlen(env->identity);
194 verbose(VERB_OPS, "dnstap identity field set to \"%s\"",
199 dt_apply_version(struct dt_env *env, struct config_file *cfg)
201 if (!cfg->dnstap_send_version)
204 if (cfg->dnstap_version == NULL || cfg->dnstap_version[0] == 0)
205 env->version = strdup(PACKAGE_STRING);
207 env->version = strdup(cfg->dnstap_version);
208 if (env->version == NULL)
209 fatal_exit("dt_apply_version: strdup() failed");
210 env->len_version = (unsigned int)strlen(env->version);
211 verbose(VERB_OPS, "dnstap version field set to \"%s\"",
216 dt_apply_cfg(struct dt_env *env, struct config_file *cfg)
221 dt_apply_identity(env, cfg);
222 dt_apply_version(env, cfg);
223 if ((env->log_resolver_query_messages = (unsigned int)
224 cfg->dnstap_log_resolver_query_messages))
226 verbose(VERB_OPS, "dnstap Message/RESOLVER_QUERY enabled");
228 if ((env->log_resolver_response_messages = (unsigned int)
229 cfg->dnstap_log_resolver_response_messages))
231 verbose(VERB_OPS, "dnstap Message/RESOLVER_RESPONSE enabled");
233 if ((env->log_client_query_messages = (unsigned int)
234 cfg->dnstap_log_client_query_messages))
236 verbose(VERB_OPS, "dnstap Message/CLIENT_QUERY enabled");
238 if ((env->log_client_response_messages = (unsigned int)
239 cfg->dnstap_log_client_response_messages))
241 verbose(VERB_OPS, "dnstap Message/CLIENT_RESPONSE enabled");
243 if ((env->log_forwarder_query_messages = (unsigned int)
244 cfg->dnstap_log_forwarder_query_messages))
246 verbose(VERB_OPS, "dnstap Message/FORWARDER_QUERY enabled");
248 if ((env->log_forwarder_response_messages = (unsigned int)
249 cfg->dnstap_log_forwarder_response_messages))
251 verbose(VERB_OPS, "dnstap Message/FORWARDER_RESPONSE enabled");
256 dt_init(struct dt_env *env)
258 env->ioq = fstrm_iothr_get_input_queue(env->iothr);
259 if (env->ioq == NULL)
265 dt_delete(struct dt_env *env)
269 verbose(VERB_OPS, "closing dnstap socket");
270 fstrm_iothr_destroy(&env->iothr);
277 dt_fill_timeval(const struct timeval *tv,
278 uint64_t *time_sec, protobuf_c_boolean *has_time_sec,
279 uint32_t *time_nsec, protobuf_c_boolean *has_time_nsec)
282 *time_sec = tv->tv_sec;
283 *time_nsec = tv->tv_usec * 1000;
290 dt_fill_buffer(sldns_buffer *b, ProtobufCBinaryData *p, protobuf_c_boolean *has)
292 log_assert(b != NULL);
293 p->len = sldns_buffer_limit(b);
294 p->data = sldns_buffer_begin(b);
299 dt_msg_fill_net(struct dt_msg *dm,
300 struct sockaddr_storage *ss,
301 enum comm_point_type cptype,
302 ProtobufCBinaryData *addr, protobuf_c_boolean *has_addr,
303 uint32_t *port, protobuf_c_boolean *has_port)
305 log_assert(ss->ss_family == AF_INET6 || ss->ss_family == AF_INET);
306 if (ss->ss_family == AF_INET6) {
307 struct sockaddr_in6 *s = (struct sockaddr_in6 *) ss;
310 dm->m.socket_family = DNSTAP__SOCKET_FAMILY__INET6;
311 dm->m.has_socket_family = 1;
313 /* addr: query_address or response_address */
314 addr->data = s->sin6_addr.s6_addr;
315 addr->len = 16; /* IPv6 */
318 /* port: query_port or response_port */
319 *port = ntohs(s->sin6_port);
321 } else if (ss->ss_family == AF_INET) {
322 struct sockaddr_in *s = (struct sockaddr_in *) ss;
325 dm->m.socket_family = DNSTAP__SOCKET_FAMILY__INET;
326 dm->m.has_socket_family = 1;
328 /* addr: query_address or response_address */
329 addr->data = (uint8_t *) &s->sin_addr.s_addr;
330 addr->len = 4; /* IPv4 */
333 /* port: query_port or response_port */
334 *port = ntohs(s->sin_port);
338 log_assert(cptype == comm_udp || cptype == comm_tcp);
339 if (cptype == comm_udp) {
340 /* socket_protocol */
341 dm->m.socket_protocol = DNSTAP__SOCKET_PROTOCOL__UDP;
342 dm->m.has_socket_protocol = 1;
343 } else if (cptype == comm_tcp) {
344 /* socket_protocol */
345 dm->m.socket_protocol = DNSTAP__SOCKET_PROTOCOL__TCP;
346 dm->m.has_socket_protocol = 1;
351 dt_msg_send_client_query(struct dt_env *env,
352 struct sockaddr_storage *qsock,
353 enum comm_point_type cptype,
357 struct timeval qtime;
359 gettimeofday(&qtime, NULL);
362 dt_msg_init(env, &dm, DNSTAP__MESSAGE__TYPE__CLIENT_QUERY);
365 dt_fill_timeval(&qtime,
366 &dm.m.query_time_sec, &dm.m.has_query_time_sec,
367 &dm.m.query_time_nsec, &dm.m.has_query_time_nsec);
370 dt_fill_buffer(qmsg, &dm.m.query_message, &dm.m.has_query_message);
372 /* socket_family, socket_protocol, query_address, query_port */
373 log_assert(cptype == comm_udp || cptype == comm_tcp);
374 dt_msg_fill_net(&dm, qsock, cptype,
375 &dm.m.query_address, &dm.m.has_query_address,
376 &dm.m.query_port, &dm.m.has_query_port);
378 if (dt_pack(&dm.d, &dm.buf, &dm.len_buf))
379 dt_send(env, dm.buf, dm.len_buf);
383 dt_msg_send_client_response(struct dt_env *env,
384 struct sockaddr_storage *qsock,
385 enum comm_point_type cptype,
389 struct timeval rtime;
391 gettimeofday(&rtime, NULL);
394 dt_msg_init(env, &dm, DNSTAP__MESSAGE__TYPE__CLIENT_RESPONSE);
397 dt_fill_timeval(&rtime,
398 &dm.m.response_time_sec, &dm.m.has_response_time_sec,
399 &dm.m.response_time_nsec, &dm.m.has_response_time_nsec);
401 /* response_message */
402 dt_fill_buffer(rmsg, &dm.m.response_message, &dm.m.has_response_message);
404 /* socket_family, socket_protocol, query_address, query_port */
405 log_assert(cptype == comm_udp || cptype == comm_tcp);
406 dt_msg_fill_net(&dm, qsock, cptype,
407 &dm.m.query_address, &dm.m.has_query_address,
408 &dm.m.query_port, &dm.m.has_query_port);
410 if (dt_pack(&dm.d, &dm.buf, &dm.len_buf))
411 dt_send(env, dm.buf, dm.len_buf);
415 dt_msg_send_outside_query(struct dt_env *env,
416 struct sockaddr_storage *rsock,
417 enum comm_point_type cptype,
418 uint8_t *zone, size_t zone_len,
422 struct timeval qtime;
425 gettimeofday(&qtime, NULL);
426 qflags = sldns_buffer_read_u16_at(qmsg, 2);
429 if (qflags & BIT_RD) {
430 if (!env->log_forwarder_query_messages)
432 dt_msg_init(env, &dm, DNSTAP__MESSAGE__TYPE__FORWARDER_QUERY);
434 if (!env->log_resolver_query_messages)
436 dt_msg_init(env, &dm, DNSTAP__MESSAGE__TYPE__RESOLVER_QUERY);
440 dm.m.query_zone.data = zone;
441 dm.m.query_zone.len = zone_len;
442 dm.m.has_query_zone = 1;
444 /* query_time_sec, query_time_nsec */
445 dt_fill_timeval(&qtime,
446 &dm.m.query_time_sec, &dm.m.has_query_time_sec,
447 &dm.m.query_time_nsec, &dm.m.has_query_time_nsec);
450 dt_fill_buffer(qmsg, &dm.m.query_message, &dm.m.has_query_message);
452 /* socket_family, socket_protocol, response_address, response_port */
453 log_assert(cptype == comm_udp || cptype == comm_tcp);
454 dt_msg_fill_net(&dm, rsock, cptype,
455 &dm.m.response_address, &dm.m.has_response_address,
456 &dm.m.response_port, &dm.m.has_response_port);
458 if (dt_pack(&dm.d, &dm.buf, &dm.len_buf))
459 dt_send(env, dm.buf, dm.len_buf);
463 dt_msg_send_outside_response(struct dt_env *env,
464 struct sockaddr_storage *rsock,
465 enum comm_point_type cptype,
466 uint8_t *zone, size_t zone_len,
467 uint8_t *qbuf, size_t qbuf_len,
468 const struct timeval *qtime,
469 const struct timeval *rtime,
475 log_assert(qbuf_len >= sizeof(qflags));
476 memcpy(&qflags, qbuf, sizeof(qflags));
477 qflags = ntohs(qflags);
480 if (qflags & BIT_RD) {
481 if (!env->log_forwarder_response_messages)
483 dt_msg_init(env, &dm, DNSTAP__MESSAGE__TYPE__FORWARDER_RESPONSE);
485 if (!env->log_resolver_response_messages)
487 dt_msg_init(env, &dm, DNSTAP__MESSAGE__TYPE__RESOLVER_RESPONSE);
491 dm.m.query_zone.data = zone;
492 dm.m.query_zone.len = zone_len;
493 dm.m.has_query_zone = 1;
495 /* query_time_sec, query_time_nsec */
496 dt_fill_timeval(qtime,
497 &dm.m.query_time_sec, &dm.m.has_query_time_sec,
498 &dm.m.query_time_nsec, &dm.m.has_query_time_nsec);
500 /* response_time_sec, response_time_nsec */
501 dt_fill_timeval(rtime,
502 &dm.m.response_time_sec, &dm.m.has_response_time_sec,
503 &dm.m.response_time_nsec, &dm.m.has_response_time_nsec);
505 /* response_message */
506 dt_fill_buffer(rmsg, &dm.m.response_message, &dm.m.has_response_message);
508 /* socket_family, socket_protocol, response_address, response_port */
509 log_assert(cptype == comm_udp || cptype == comm_tcp);
510 dt_msg_fill_net(&dm, rsock, cptype,
511 &dm.m.response_address, &dm.m.has_response_address,
512 &dm.m.response_port, &dm.m.has_response_port);
514 if (dt_pack(&dm.d, &dm.buf, &dm.len_buf))
515 dt_send(env, dm.buf, dm.len_buf);
518 #endif /* USE_DNSTAP */