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
70 GNUNET_GNS_RECORD_TYPE_A = GNUNET_DNSPARSER_TYPE_A,
71 GNUNET_GNS_RECORD_TYPE_NS = GNUNET_DNSPARSER_TYPE_NS,
72 GNUNET_GNS_RECORD_TYPE_CNAME = GNUNET_DNSPARSER_TYPE_CNAME,
73 GNUNET_GNS_RECORD_TYPE_SOA = GNUNET_DNSPARSER_TYPE_SOA,
74 GNUNET_GNS_RECORD_TYPE_SRV = GNUNET_DNSPARSER_TYPE_SRV,
75 GNUNET_GNS_RECORD_TYPE_PTR = GNUNET_DNSPARSER_TYPE_PTR,
76 GNUNET_GNS_RECORD_MX = GNUNET_DNSPARSER_TYPE_MX,
77 GNUNET_GNS_RECORD_TXT = GNUNET_DNSPARSER_TYPE_TXT,
78 GNUNET_GNS_RECORD_AAAA = GNUNET_DNSPARSER_TYPE_AAAA,
81 GNUNET_GNS_RECORD_PKEY = GNUNET_NAMESTORE_TYPE_PKEY,
82 GNUNET_GNS_RECORD_PSEU = GNUNET_NAMESTORE_TYPE_PSEU,
83 GNUNET_GNS_RECORD_ANY = GNUNET_NAMESTORE_TYPE_ANY,
84 GNUNET_GNS_RECORD_LEHO = GNUNET_NAMESTORE_TYPE_LEHO,
85 GNUNET_GNS_RECORD_VPN = GNUNET_NAMESTORE_TYPE_VPN,
86 GNUNET_GNS_RECORD_REV = GNUNET_NAMESTORE_TYPE_REV
90 * Initialize the connection with the GNS service.
92 * @param cfg configuration to use
94 * @return handle to the GNS service, or NULL on error
96 struct GNUNET_GNS_Handle *
97 GNUNET_GNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
101 * Shutdown connection with the GNS service.
103 * @param handle connection to shut down
106 GNUNET_GNS_disconnect (struct GNUNET_GNS_Handle *handle);
109 /* *************** Standard API: lookup ******************* */
112 * Iterator called on obtained result for a GNS
116 * @param name "name" of the original lookup
117 * @param rd_count number of records
118 * @param rd the records in reply
120 typedef void (*GNUNET_GNS_LookupResultProcessor) (void *cls,
122 const struct GNUNET_NAMESTORE_RecordData *rd);
127 * Perform an asynchronous lookup operation on the GNS
128 * in the default zone.
130 * @param handle handle to the GNS service
131 * @param name the name to look up
132 * @param type the GNUNET_GNS_RecordType to look for
133 * @param only_cached GNUNET_NO to only check locally not DHT for performance
134 * @param shorten_key the private key of the shorten zone (can be NULL)
135 * @param proc function to call on result
136 * @param proc_cls closure for processor
138 * @return handle to the queued request
140 struct GNUNET_GNS_QueueEntry *
141 GNUNET_GNS_lookup (struct GNUNET_GNS_Handle *handle,
143 enum GNUNET_GNS_RecordType type,
145 struct GNUNET_CRYPTO_RsaPrivateKey *shorten_key,
146 GNUNET_GNS_LookupResultProcessor proc,
150 * Perform an asynchronous lookup operation on the GNS
151 * in the zone specified by 'zone'.
153 * @param handle handle to the GNS service
154 * @param name the name to look up
155 * @param zone the zone to start the resolution in
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_zone (struct GNUNET_GNS_Handle *handle,
167 struct GNUNET_CRYPTO_ShortHashCode *zone,
168 enum GNUNET_GNS_RecordType type,
170 struct GNUNET_CRYPTO_RsaPrivateKey *shorten_key,
171 GNUNET_GNS_LookupResultProcessor proc,
174 /* *************** Standard API: shorten ******************* */
178 * Processor called on for a name shortening result
182 * @param short_name the shortened name or NULL if no result
184 typedef void (*GNUNET_GNS_ShortenResultProcessor) (void *cls,
185 const char* short_name);
189 * Perform a name shortening operation on the GNS.
191 * @param handle handle to the GNS service
192 * @param name the name to look up
193 * @param proc function to call on result
194 * @param proc_cls closure for processor
195 * @return handle to the operation
197 struct GNUNET_GNS_QueueEntry *
198 GNUNET_GNS_shorten (struct GNUNET_GNS_Handle *handle,
200 GNUNET_GNS_ShortenResultProcessor proc,
205 * Perform a name shortening operation on the GNS.
207 * @param handle handle to the GNS service
208 * @param name the name to look up
209 * @param zone the zone to start the resolution in
210 * @param proc function to call on result
211 * @param proc_cls closure for processor
212 * @return handle to the operation
214 struct GNUNET_GNS_QueueEntry *
215 GNUNET_GNS_shorten_zone (struct GNUNET_GNS_Handle *handle,
217 struct GNUNET_CRYPTO_ShortHashCode *zone,
218 GNUNET_GNS_ShortenResultProcessor proc,
221 /* *************** Standard API: get authority ******************* */
225 * Processor called on for a name shortening result
229 * @param auth_name the name of the auhtority or NULL
231 typedef void (*GNUNET_GNS_GetAuthResultProcessor) (void *cls,
232 const char* short_name);
236 * Perform an authority lookup for a given name.
238 * @param handle handle to the GNS service
239 * @param name the name to look up authority for
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_get_authority (struct GNUNET_GNS_Handle *handle,
247 GNUNET_GNS_GetAuthResultProcessor proc,
250 #if 0 /* keep Emacsens' auto-indent happy */
259 /* gnunet_gns_service.h */