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_PTR = GNUNET_DNSPARSER_TYPE_PTR,
75 GNUNET_GNS_RECORD_MX = GNUNET_DNSPARSER_TYPE_MX,
76 GNUNET_GNS_RECORD_TXT = GNUNET_DNSPARSER_TYPE_TXT,
77 GNUNET_GNS_RECORD_AAAA = GNUNET_DNSPARSER_TYPE_AAAA,
80 GNUNET_GNS_RECORD_PKEY = GNUNET_NAMESTORE_TYPE_PKEY,
81 GNUNET_GNS_RECORD_PSEU = GNUNET_NAMESTORE_TYPE_PSEU,
82 GNUNET_GNS_RECORD_ANY = GNUNET_NAMESTORE_TYPE_ANY,
83 GNUNET_GNS_RECORD_LEHO = GNUNET_NAMESTORE_TYPE_LEHO
87 * Initialize the connection with the GNS service.
89 * @param cfg configuration to use
91 * @return handle to the GNS service, or NULL on error
93 struct GNUNET_GNS_Handle *
94 GNUNET_GNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
98 * Shutdown connection with the GNS service.
100 * @param handle connection to shut down
103 GNUNET_GNS_disconnect (struct GNUNET_GNS_Handle *handle);
106 /* *************** Standard API: lookup ******************* */
109 * Iterator called on obtained result for a GNS
113 * @param name "name" of the original lookup
114 * @param rd_count number of records
115 * @param rd the records in reply
117 typedef void (*GNUNET_GNS_LookupResultProcessor) (void *cls,
119 const struct GNUNET_NAMESTORE_RecordData *rd);
124 * Perform an asynchronous lookup operation on the GNS
125 * in the default zone.
127 * @param handle handle to the GNS service
128 * @param name the name to look up
129 * @param type the GNUNET_GNS_RecordType to look for
130 * @param proc function to call on result
131 * @param proc_cls closure for processor
133 * @return handle to the queued request
135 struct GNUNET_GNS_QueueEntry *
136 GNUNET_GNS_lookup (struct GNUNET_GNS_Handle *handle,
138 enum GNUNET_GNS_RecordType type,
139 GNUNET_GNS_LookupResultProcessor proc,
143 * Perform an asynchronous lookup operation on the GNS
144 * in the zone specified by 'zone'.
146 * @param handle handle to the GNS service
147 * @param name the name to look up
148 * @param zone the zone to start the resolution in
149 * @param type the GNUNET_GNS_RecordType to look for
150 * @param proc function to call on result
151 * @param proc_cls closure for processor
153 * @return handle to the queued request
155 struct GNUNET_GNS_QueueEntry *
156 GNUNET_GNS_lookup_zone (struct GNUNET_GNS_Handle *handle,
158 struct GNUNET_CRYPTO_ShortHashCode *zone,
159 enum GNUNET_GNS_RecordType type,
160 GNUNET_GNS_LookupResultProcessor proc,
163 /* *************** Standard API: shorten ******************* */
167 * Processor called on for a name shortening result
171 * @param short_name the shortened name or NULL if no result
173 typedef void (*GNUNET_GNS_ShortenResultProcessor) (void *cls,
174 const char* short_name);
178 * Perform a name shortening operation on the GNS.
180 * @param handle handle to the GNS service
181 * @param name the name to look up
182 * @param proc function to call on result
183 * @param proc_cls closure for processor
184 * @return handle to the operation
186 struct GNUNET_GNS_QueueEntry *
187 GNUNET_GNS_shorten (struct GNUNET_GNS_Handle *handle,
189 GNUNET_GNS_ShortenResultProcessor proc,
194 * Perform a name shortening operation on the GNS.
196 * @param handle handle to the GNS service
197 * @param name the name to look up
198 * @param zone the zone to start the resolution in
199 * @param proc function to call on result
200 * @param proc_cls closure for processor
201 * @return handle to the operation
203 struct GNUNET_GNS_QueueEntry *
204 GNUNET_GNS_shorten_zone (struct GNUNET_GNS_Handle *handle,
206 struct GNUNET_CRYPTO_ShortHashCode *zone,
207 GNUNET_GNS_ShortenResultProcessor proc,
210 /* *************** Standard API: get authority ******************* */
214 * Processor called on for a name shortening result
218 * @param auth_name the name of the auhtority or NULL
220 typedef void (*GNUNET_GNS_GetAuthResultProcessor) (void *cls,
221 const char* short_name);
225 * Perform an authority lookup for a given name.
227 * @param handle handle to the GNS service
228 * @param name the name to look up authority for
229 * @param proc function to call on result
230 * @param proc_cls closure for processor
231 * @return handle to the operation
233 struct GNUNET_GNS_QueueEntry *
234 GNUNET_GNS_get_authority (struct GNUNET_GNS_Handle *handle,
236 GNUNET_GNS_GetAuthResultProcessor proc,
239 #if 0 /* keep Emacsens' auto-indent happy */
248 /* gnunet_gns_service.h */