2 This file is part of GNUnet
3 (C) 2012 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file include/gnunet_gns_service.h
23 * @brief API to the GNS service
24 * @author Martin Schanzenbach
27 * - decide what goes into storage API and what into GNS-service API
28 * - decide where to pass/expose/check keys / signatures
29 * - are GNS private keys per peer or per user?
33 #ifndef GNUNET_GNS_SERVICE_H
34 #define GNUNET_GNS_SERVICE_H
36 #include "gnunet_util_lib.h"
37 #include "gnunet_dnsparser_lib.h"
38 #include "gnunet_namestore_service.h"
43 #if 0 /* keep Emacsens' auto-indent happy */
50 * Connection to the GNS service.
52 struct GNUNET_GNS_Handle;
55 * Handle to control a lookup operation.
57 struct GNUNET_GNS_LookupRequest;
60 * Handle to control a shorten operation.
62 struct GNUNET_GNS_ShortenRequest;
65 * Handle to control a get authority operation
67 struct GNUNET_GNS_GetAuthRequest;
71 * Based on GNUNET_DNSPARSER_TYPEs (standard DNS)
73 enum GNUNET_GNS_RecordType
77 GNUNET_GNS_RECORD_A = GNUNET_DNSPARSER_TYPE_A,
80 GNUNET_GNS_RECORD_NS = GNUNET_DNSPARSER_TYPE_NS,
83 GNUNET_GNS_RECORD_CNAME = GNUNET_DNSPARSER_TYPE_CNAME,
86 GNUNET_GNS_RECORD_SOA = GNUNET_DNSPARSER_TYPE_SOA,
89 GNUNET_GNS_RECORD_SRV = GNUNET_DNSPARSER_TYPE_SRV,
92 GNUNET_GNS_RECORD_PTR = GNUNET_DNSPARSER_TYPE_PTR,
95 GNUNET_GNS_RECORD_MX = GNUNET_DNSPARSER_TYPE_MX,
98 GNUNET_GNS_RECORD_TXT = GNUNET_DNSPARSER_TYPE_TXT,
100 /* struct in6_addr */
101 GNUNET_GNS_RECORD_AAAA = GNUNET_DNSPARSER_TYPE_AAAA,
104 /* struct GNUNET_CRYPTO_ShortHashCode */
105 GNUNET_GNS_RECORD_PKEY = GNUNET_NAMESTORE_TYPE_PKEY,
108 GNUNET_GNS_RECORD_PSEU = GNUNET_NAMESTORE_TYPE_PSEU,
109 GNUNET_GNS_RECORD_ANY = GNUNET_NAMESTORE_TYPE_ANY,
112 GNUNET_GNS_RECORD_LEHO = GNUNET_NAMESTORE_TYPE_LEHO,
114 /* struct vpn_data */
115 GNUNET_GNS_RECORD_VPN = GNUNET_NAMESTORE_TYPE_VPN,
116 GNUNET_GNS_RECORD_REV = GNUNET_NAMESTORE_TYPE_REV
121 * Initialize the connection with the GNS service.
123 * @param cfg configuration to use
125 * @return handle to the GNS service, or NULL on error
127 struct GNUNET_GNS_Handle *
128 GNUNET_GNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
132 * Shutdown connection with the GNS service.
134 * @param handle connection to shut down
137 GNUNET_GNS_disconnect (struct GNUNET_GNS_Handle *handle);
140 /* *************** Standard API: lookup ******************* */
143 * Iterator called on obtained result for a GNS
147 * @param rd_count number of records
148 * @param rd the records in reply
150 typedef void (*GNUNET_GNS_LookupResultProcessor) (void *cls,
152 const struct GNUNET_NAMESTORE_RecordData *rd);
157 * Perform an asynchronous lookup operation on the GNS
158 * in the default zone.
160 * @param handle handle to the GNS service
161 * @param name the name to look up
162 * @param type the GNUNET_GNS_RecordType to look for
163 * @param only_cached GNUNET_NO to only check locally not DHT for performance
164 * @param shorten_key the private key of the shorten zone (can be NULL)
165 * @param proc function to call on result
166 * @param proc_cls closure for processor
168 * @return handle to the queued request
170 struct GNUNET_GNS_LookupRequest*
171 GNUNET_GNS_lookup (struct GNUNET_GNS_Handle *handle,
173 enum GNUNET_GNS_RecordType type,
175 struct GNUNET_CRYPTO_RsaPrivateKey *shorten_key,
176 GNUNET_GNS_LookupResultProcessor proc,
181 * Perform an asynchronous lookup operation on the GNS
182 * in the zone specified by 'zone'.
184 * @param handle handle to the GNS service
185 * @param name the name to look up
186 * @param zone the zone to start the resolution in
187 * @param type the GNUNET_GNS_RecordType to look for
188 * @param only_cached GNUNET_YES to only check locally not DHT for performance
189 * @param shorten_key the private key of the shorten zone (can be NULL)
190 * @param proc function to call on result
191 * @param proc_cls closure for processor
193 * @return handle to the queued request
195 struct GNUNET_GNS_LookupRequest*
196 GNUNET_GNS_lookup_zone (struct GNUNET_GNS_Handle *handle,
198 struct GNUNET_CRYPTO_ShortHashCode *zone,
199 enum GNUNET_GNS_RecordType type,
201 struct GNUNET_CRYPTO_RsaPrivateKey *shorten_key,
202 GNUNET_GNS_LookupResultProcessor proc,
207 * Cancel pending lookup request
209 * @param lr the lookup request to cancel
212 GNUNET_GNS_cancel_lookup_request (struct GNUNET_GNS_LookupRequest *lr);
214 /* *************** Standard API: shorten ******************* */
218 * Processor called on for a name shortening result
222 * @param short_name the shortened name or NULL if no result
224 typedef void (*GNUNET_GNS_ShortenResultProcessor) (void *cls,
225 const char* short_name);
229 * Perform a name shortening operation on the GNS.
231 * @param handle handle to the GNS service
232 * @param name the name to look up
233 * @param private_zone the public zone of the private zone
234 * @param shorten_zone the public zone of the shorten zone
235 * @param proc function to call on result
236 * @param proc_cls closure for processor
237 * @return handle to the operation
239 struct GNUNET_GNS_ShortenRequest*
240 GNUNET_GNS_shorten (struct GNUNET_GNS_Handle *handle,
242 struct GNUNET_CRYPTO_ShortHashCode *private_zone,
243 struct GNUNET_CRYPTO_ShortHashCode *shorten_zone,
244 GNUNET_GNS_ShortenResultProcessor proc,
249 * Perform a name shortening operation on the GNS.
251 * @param handle handle to the GNS service
252 * @param name the name to look up
253 * @param private_zone the public zone of the private zone
254 * @param shorten_zone the public zone of the shorten zone
255 * @param zone the zone to start the resolution in
256 * @param proc function to call on result
257 * @param proc_cls closure for processor
258 * @return handle to the operation
260 struct GNUNET_GNS_ShortenRequest*
261 GNUNET_GNS_shorten_zone (struct GNUNET_GNS_Handle *handle,
263 struct GNUNET_CRYPTO_ShortHashCode *private_zone,
264 struct GNUNET_CRYPTO_ShortHashCode *shorten_zone,
265 struct GNUNET_CRYPTO_ShortHashCode *zone,
266 GNUNET_GNS_ShortenResultProcessor proc,
271 * Cancel pending shorten request
273 * @param sr the lookup request to cancel
276 GNUNET_GNS_cancel_shorten_request (struct GNUNET_GNS_ShortenRequest *sr);
279 /* *************** Standard API: get authority ******************* */
283 * Processor called on for a name shortening result
287 * @param auth_name the name of the auhtority or NULL
289 typedef void (*GNUNET_GNS_GetAuthResultProcessor) (void *cls,
290 const char* short_name);
294 * Perform an authority lookup for a given name.
296 * @param handle handle to the GNS service
297 * @param name the name to look up authority for
298 * @param proc function to call on result
299 * @param proc_cls closure for processor
300 * @return handle to the operation
302 struct GNUNET_GNS_GetAuthRequest*
303 GNUNET_GNS_get_authority (struct GNUNET_GNS_Handle *handle,
305 GNUNET_GNS_GetAuthResultProcessor proc,
310 * Cancel pending get auth request
312 * @param gar the lookup request to cancel
315 GNUNET_GNS_cancel_get_auth_request (struct GNUNET_GNS_GetAuthRequest *gar);
317 #if 0 /* keep Emacsens' auto-indent happy */
326 /* gnunet_gns_service.h */