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 get operation.
57 struct GNUNET_GNS_LookupHandle;
60 * Handle to control a shorten operation
65 * Based on GNUNET_DNSPARSER_TYPEs (standard DNS)
67 enum GNUNET_GNS_RecordType
71 GNUNET_GNS_RECORD_A = GNUNET_DNSPARSER_TYPE_A,
74 GNUNET_GNS_RECORD_NS = GNUNET_DNSPARSER_TYPE_NS,
77 GNUNET_GNS_RECORD_CNAME = GNUNET_DNSPARSER_TYPE_CNAME,
80 GNUNET_GNS_RECORD_SOA = GNUNET_DNSPARSER_TYPE_SOA,
83 GNUNET_GNS_RECORD_SRV = GNUNET_DNSPARSER_TYPE_SRV,
86 GNUNET_GNS_RECORD_PTR = GNUNET_DNSPARSER_TYPE_PTR,
89 GNUNET_GNS_RECORD_MX = GNUNET_DNSPARSER_TYPE_MX,
92 GNUNET_GNS_RECORD_TXT = GNUNET_DNSPARSER_TYPE_TXT,
95 GNUNET_GNS_RECORD_AAAA = GNUNET_DNSPARSER_TYPE_AAAA,
98 /* struct GNUNET_CRYPTO_ShortHashCode */
99 GNUNET_GNS_RECORD_PKEY = GNUNET_NAMESTORE_TYPE_PKEY,
102 GNUNET_GNS_RECORD_PSEU = GNUNET_NAMESTORE_TYPE_PSEU,
103 GNUNET_GNS_RECORD_ANY = GNUNET_NAMESTORE_TYPE_ANY,
106 GNUNET_GNS_RECORD_LEHO = GNUNET_NAMESTORE_TYPE_LEHO,
108 /* struct vpn_data */
109 GNUNET_GNS_RECORD_VPN = GNUNET_NAMESTORE_TYPE_VPN,
110 GNUNET_GNS_RECORD_REV = GNUNET_NAMESTORE_TYPE_REV
114 * Initialize the connection with the GNS service.
116 * @param cfg configuration to use
118 * @return handle to the GNS service, or NULL on error
120 struct GNUNET_GNS_Handle *
121 GNUNET_GNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
125 * Shutdown connection with the GNS service.
127 * @param handle connection to shut down
130 GNUNET_GNS_disconnect (struct GNUNET_GNS_Handle *handle);
133 /* *************** Standard API: lookup ******************* */
136 * Iterator called on obtained result for a GNS
140 * @param name "name" of the original lookup
141 * @param rd_count number of records
142 * @param rd the records in reply
144 typedef void (*GNUNET_GNS_LookupResultProcessor) (void *cls,
146 const struct GNUNET_NAMESTORE_RecordData *rd);
151 * Perform an asynchronous lookup operation on the GNS
152 * in the default zone.
154 * @param handle handle to the GNS service
155 * @param name the name to look up
156 * @param type the GNUNET_GNS_RecordType to look for
157 * @param only_cached GNUNET_NO to only check locally not DHT for performance
158 * @param shorten_key the private key of the shorten zone (can be NULL)
159 * @param proc function to call on result
160 * @param proc_cls closure for processor
162 * @return handle to the queued request
164 struct GNUNET_GNS_QueueEntry *
165 GNUNET_GNS_lookup (struct GNUNET_GNS_Handle *handle,
167 enum GNUNET_GNS_RecordType type,
169 struct GNUNET_CRYPTO_RsaPrivateKey *shorten_key,
170 GNUNET_GNS_LookupResultProcessor proc,
174 * Perform an asynchronous lookup operation on the GNS
175 * in the zone specified by 'zone'.
177 * @param handle handle to the GNS service
178 * @param name the name to look up
179 * @param zone the zone to start the resolution in
180 * @param type the GNUNET_GNS_RecordType to look for
181 * @param only_cached GNUNET_YES to only check locally not DHT for performance
182 * @param shorten_key the private key of the shorten zone (can be NULL)
183 * @param proc function to call on result
184 * @param proc_cls closure for processor
186 * @return handle to the queued request
188 struct GNUNET_GNS_QueueEntry *
189 GNUNET_GNS_lookup_zone (struct GNUNET_GNS_Handle *handle,
191 struct GNUNET_CRYPTO_ShortHashCode *zone,
192 enum GNUNET_GNS_RecordType type,
194 struct GNUNET_CRYPTO_RsaPrivateKey *shorten_key,
195 GNUNET_GNS_LookupResultProcessor proc,
198 /* *************** Standard API: shorten ******************* */
202 * Processor called on for a name shortening result
206 * @param short_name the shortened name or NULL if no result
208 typedef void (*GNUNET_GNS_ShortenResultProcessor) (void *cls,
209 const char* short_name);
213 * Perform a name shortening operation on the GNS.
215 * @param handle handle to the GNS service
216 * @param name the name to look up
217 * @param private_zone the public zone of the private zone
218 * @param shorten_zone the public zone of the shorten zone
219 * @param proc function to call on result
220 * @param proc_cls closure for processor
221 * @return handle to the operation
223 struct GNUNET_GNS_QueueEntry *
224 GNUNET_GNS_shorten (struct GNUNET_GNS_Handle *handle,
226 struct GNUNET_CRYPTO_ShortHashCode *private_zone,
227 struct GNUNET_CRYPTO_ShortHashCode *shorten_zone,
228 GNUNET_GNS_ShortenResultProcessor proc,
233 * Perform a name shortening operation on the GNS.
235 * @param handle handle to the GNS service
236 * @param name the name to look up
237 * @param private_zone the public zone of the private zone
238 * @param shorten_zone the public zone of the shorten zone
239 * @param zone the zone to start the resolution in
240 * @param proc function to call on result
241 * @param proc_cls closure for processor
242 * @return handle to the operation
244 struct GNUNET_GNS_QueueEntry *
245 GNUNET_GNS_shorten_zone (struct GNUNET_GNS_Handle *handle,
247 struct GNUNET_CRYPTO_ShortHashCode *private_zone,
248 struct GNUNET_CRYPTO_ShortHashCode *shorten_zone,
249 struct GNUNET_CRYPTO_ShortHashCode *zone,
250 GNUNET_GNS_ShortenResultProcessor proc,
253 /* *************** Standard API: get authority ******************* */
257 * Processor called on for a name shortening result
261 * @param auth_name the name of the auhtority or NULL
263 typedef void (*GNUNET_GNS_GetAuthResultProcessor) (void *cls,
264 const char* short_name);
268 * Perform an authority lookup for a given name.
270 * @param handle handle to the GNS service
271 * @param name the name to look up authority for
272 * @param proc function to call on result
273 * @param proc_cls closure for processor
274 * @return handle to the operation
276 struct GNUNET_GNS_QueueEntry *
277 GNUNET_GNS_get_authority (struct GNUNET_GNS_Handle *handle,
279 GNUNET_GNS_GetAuthResultProcessor proc,
282 #if 0 /* keep Emacsens' auto-indent happy */
291 /* gnunet_gns_service.h */