aboutsummaryrefslogtreecommitdiff
path: root/src/include/gnunet_dns_service.h
blob: 329a083ff7668afb61c0e2d3220aabbe230a356d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
/*
      This file is part of GNUnet
      (C) 2010, 2011, 2012 Christian Grothoff (and other contributing authors)

      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
      by the Free Software Foundation; either version 2, or (at your
      option) any later version.

      GNUnet is distributed in the hope that it will be useful, but
      WITHOUT ANY WARRANTY; without even the implied warranty of
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
      General Public License for more details.

      You should have received a copy of the GNU General Public License
      along with GNUnet; see the file COPYING.  If not, write to the
      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
      Boston, MA 02111-1307, USA.
 */

/**
 * @file include/gnunet_dns_service.h
 * @brief API to access the DNS service.  Not finished at all,
 *        currently only contains the structs for the IPC, which
 *        don't even belong here (legacy code in transition)
 * @author Philipp Toelke
 * 
 * TODO:
 * - replace (most?) structs with nice function (prototypes) that take
 *   the appropriate arguments to pass the data
 * - clean up API implementation itself (nicer reconnect, etc.)
 */
#ifndef GNUNET_DNS_SERVICE_H
#define GNUNET_DNS_SERVICE_H

#include "gnunet_common.h"
#include "gnunet_util_lib.h"


/**
 * Subtypes of DNS answers.
 */
enum GNUNET_DNS_ANSWER_Subtype
{
  /**
   * Answers of this type contain a dns-packet that just has to be transmitted
   */
  GNUNET_DNS_ANSWER_TYPE_IP,

  /**
   * Answers of this type contain an incomplete dns-packet. The IP-Address
   * is all 0s. The addroffset points to it.
   */
  GNUNET_DNS_ANSWER_TYPE_SERVICE,

  /**
   * Answers of this type contain an incomplete dns-packet as answer to a
   * PTR-Query. The resolved name is not allocated. The addroffset points to it.
   */
  GNUNET_DNS_ANSWER_TYPE_REV,
  
  /**
   * Answers of this type contains an IP6-Address but traffic to this IP should
   * be routed through the GNUNet.
   */
  GNUNET_DNS_ANSWER_TYPE_REMOTE_AAAA,
  
  /**
   * Answers of this type contains an IP4-Address but traffic to this IP should
   * be routed through the GNUNet.
   */
  GNUNET_DNS_ANSWER_TYPE_REMOTE_A

};


GNUNET_NETWORK_STRUCT_BEGIN
struct GNUNET_vpn_service_descriptor
{
  GNUNET_HashCode peer GNUNET_PACKED;
  GNUNET_HashCode service_descriptor GNUNET_PACKED;
  uint64_t ports GNUNET_PACKED;
  uint32_t service_type GNUNET_PACKED;
};


struct answer_packet
{
  /* General data */
  struct GNUNET_MessageHeader hdr;
  enum GNUNET_DNS_ANSWER_Subtype subtype GNUNET_PACKED;

  char from[16];
  char to[16];
  char addrlen;
  unsigned dst_port:16 GNUNET_PACKED;
  /* -- */

  /* Data for GNUNET_DNS_ANSWER_TYPE_SERVICE */
  struct GNUNET_vpn_service_descriptor service_descr;
  /* -- */

  /* Data for GNUNET_DNS_ANSWER_TYPE_REV */
  /* The offsett in octets from the beginning of the struct to the field
   * in data where the IP-Address has to go. */
  uint16_t addroffset GNUNET_PACKED;
  /* -- */

  /* Data for GNUNET_DNS_ANSWER_TYPE_REMOTE */
  /* either 4 or 16 */
  char addrsize;
  unsigned char addr[16];
  /* -- */

  unsigned char data[1];
};
GNUNET_NETWORK_STRUCT_END



/**
 * Type of a function to be called by the DNS API whenever
 * a DNS reply is obtained.
 *
 * @param cls closure
 * @param pkt reply that we got
 */
typedef void (*GNUNET_DNS_ResponseCallback)(void *cls,
					    const struct answer_packet *pkt);


/**
 * Opaque DNS handle
 */
struct GNUNET_DNS_Handle;


/**
 * Connect to the service-dns
 *
 * @param cfg configuration to use
 * @param cb function to call with DNS replies
 * @param cb_cls closure to pass to cb
 * @return DNS handle 
 */
struct GNUNET_DNS_Handle *
GNUNET_DNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
		    GNUNET_DNS_ResponseCallback cb,
		    void *cb_cls);


/**
 * Signal the DNS service that it needs to re-initialize the DNS
 * hijacking (the network setup has changed significantly).
 *
 * @param h DNS handle
 */
void
GNUNET_DNS_restart_hijack (struct GNUNET_DNS_Handle *h);


/**
 * Process a DNS request sent to an IPv4 resolver.  Pass it
 * to the DNS service for resolution.
 *
 * @param h DNS handle
 * @param dst_ip destination IPv4 address
 * @param src_ip source IPv4 address (usually local machine)
 * @param src_port source port (to be used for reply)
 * @param udp_packet_len length of the UDP payload in bytes
 * @param udp_packet UDP payload
 */
void
GNUNET_DNS_queue_request_v4 (struct GNUNET_DNS_Handle *h,
			     const struct in_addr *dst_ip,
			     const struct in_addr *src_ip,
			     uint16_t src_port,
			     size_t udp_packet_len,
			     const char *udp_packet);

/**
 * Process a DNS request sent to an IPv6 resolver.  Pass it
 * to the DNS service for resolution.
 *
 * @param h DNS handle
 * @param dst_ip destination IPv6 address
 * @param src_ip source IPv6 address (usually local machine)
 * @param src_port source port (to be used for reply)
 * @param udp_packet_len length of the UDP payload in bytes
 * @param udp_packet UDP payload
 */
void
GNUNET_DNS_queue_request_v6 (struct GNUNET_DNS_Handle *h,
			     const struct in6_addr *dst_ip,
			     const struct in6_addr *src_ip,
			     uint16_t src_port,
			     size_t udp_packet_len,
			     const char *udp_packet);

/**
 * Disconnect from the DNS service.
 *
 * @param h DNS handle
 */
void
GNUNET_DNS_disconnect (struct GNUNET_DNS_Handle *h);

#endif