1/* dnstap support for Unbound */
2
3/*
4 * Copyright (c) 2013-2014, Farsight Security, 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 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 *
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.
17 *
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.
21 *
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.
33 */
34
35#ifndef UNBOUND_DNSTAP_H
36#define UNBOUND_DNSTAP_H
37
38#include "dnstap/dnstap_config.h"
39
40#ifdef USE_DNSTAP
41
42struct config_file;
43struct sldns_buffer;
44struct dt_msg_queue;
45
46struct dt_env {
47	/** the io thread (made by the struct daemon) */
48	struct dt_io_thread* dtio;
49
50	/** valid in worker struct, not in daemon struct, the per-worker
51	 * message list */
52	struct dt_msg_queue* msgqueue;
53
54	/** dnstap "identity" field, NULL if disabled */
55	char *identity;
56
57	/** dnstap "version" field, NULL if disabled */
58	char *version;
59
60	/** length of "identity" field */
61	unsigned len_identity;
62
63	/** length of "version" field */
64	unsigned len_version;
65
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;
78};
79
80/**
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.
89 */
90struct dt_env *
91dt_create(struct config_file* cfg);
92
93/**
94 * Apply config settings.
95 * @param env: dnstap environment object.
96 * @param cfg: new config settings.
97 */
98void
99dt_apply_cfg(struct dt_env *env, struct config_file *cfg);
100
101/**
102 * Initialize per-worker state in dnstap environment object.
103 * @param env: dnstap environment object to initialize, created with dt_create().
104 * @param base: event base for wakeup timer.
105 * @return: true on success, false on failure.
106 */
107int
108dt_init(struct dt_env *env, struct comm_base* base);
109
110/**
111 * Deletes the per-worker state created by dt_init
112 */
113void dt_deinit(struct dt_env *env);
114
115/**
116 * Delete dnstap environment object. Closes dnstap I/O socket and deletes all
117 * per-worker I/O queues.
118 */
119void
120dt_delete(struct dt_env *env);
121
122/**
123 * Create and send a new dnstap "Message" event of type CLIENT_QUERY.
124 * @param env: dnstap environment object.
125 * @param qsock: address/port of client.
126 * @param cptype: comm_udp or comm_tcp.
127 * @param qmsg: query message.
128 */
129void
130dt_msg_send_client_query(struct dt_env *env,
131			 struct sockaddr_storage *qsock,
132			 enum comm_point_type cptype,
133			 struct sldns_buffer *qmsg);
134
135/**
136 * Create and send a new dnstap "Message" event of type CLIENT_RESPONSE.
137 * @param env: dnstap environment object.
138 * @param qsock: address/port of client.
139 * @param cptype: comm_udp or comm_tcp.
140 * @param rmsg: response message.
141 */
142void
143dt_msg_send_client_response(struct dt_env *env,
144			    struct sockaddr_storage *qsock,
145			    enum comm_point_type cptype,
146			    struct sldns_buffer *rmsg);
147
148/**
149 * Create and send a new dnstap "Message" event of type RESOLVER_QUERY or
150 * FORWARDER_QUERY. The type used is dependent on the value of the RD bit
151 * in the query header.
152 * @param env: dnstap environment object.
153 * @param rsock: address/port of server the query is being sent to.
154 * @param cptype: comm_udp or comm_tcp.
155 * @param zone: query zone.
156 * @param zone_len: length of zone.
157 * @param qmsg: query message.
158 */
159void
160dt_msg_send_outside_query(struct dt_env *env,
161			  struct sockaddr_storage *rsock,
162			  enum comm_point_type cptype,
163			  uint8_t *zone, size_t zone_len,
164			  struct sldns_buffer *qmsg);
165
166/**
167 * Create and send a new dnstap "Message" event of type RESOLVER_RESPONSE or
168 * FORWARDER_RESPONSE. The type used is dependent on the value of the RD bit
169 * in the query header.
170 * @param env: dnstap environment object.
171 * @param rsock: address/port of server the response was received from.
172 * @param cptype: comm_udp or comm_tcp.
173 * @param zone: query zone.
174 * @param zone_len: length of zone.
175 * @param qbuf: outside_network's qbuf key.
176 * @param qbuf_len: length of outside_network's qbuf key.
177 * @param qtime: time query message was sent.
178 * @param rtime: time response message was sent.
179 * @param rmsg: response message.
180 */
181void
182dt_msg_send_outside_response(struct dt_env *env,
183			     struct sockaddr_storage *rsock,
184			     enum comm_point_type cptype,
185			     uint8_t *zone, size_t zone_len,
186			     uint8_t *qbuf, size_t qbuf_len,
187			     const struct timeval *qtime,
188			     const struct timeval *rtime,
189			     struct sldns_buffer *rmsg);
190
191#endif /* USE_DNSTAP */
192
193#endif /* UNBOUND_DNSTAP_H */
194