src/include/gnunet_gns_service.h

   1 /*
   2       This file is part of GNUnet
   3       (C) 2012 Christian Grothoff (and other contributing authors)
   4
   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.
   9
  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.
  14
  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.
  19  */
  20
  21 /**
  22  * @file include/gnunet_gns_service.h
  23  * @brief API to the GNS service
  24  * @author Martin Schanzenbach
  25  *
  26  * TODO:
  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?
  30  */
  31
  32
  33 #ifndef GNUNET_GNS_SERVICE_H
  34 #define GNUNET_GNS_SERVICE_H
  35
  36 #include "gnunet_util_lib.h"
  37 #include "gnunet_dnsparser_lib.h"
  38 #include "gnunet_namestore_service.h"
  39
  40 #ifdef __cplusplus
  41 extern "C"
  42 {
  43 #if 0                           /* keep Emacsens' auto-indent happy */
  44 }
  45 #endif
  46 #endif
  47
  48
  49 /**
  50  * Connection to the GNS service.
  51  */
  52 struct GNUNET_GNS_Handle;
  53
  54 /**
  55  * Handle to control a lookup operation.
  56  */
  57 struct GNUNET_GNS_LookupRequest;
  58
  59 /**
  60  * Handle to control a shorten operation.
  61  */
  62 struct GNUNET_GNS_ShortenRequest;
  63
  64 /**
  65  * Handle to control a get authority operation
  66  */
  67 struct GNUNET_GNS_GetAuthRequest;
  68
  69 /**
  70  * Record types
  71  * Based on GNUNET_DNSPARSER_TYPEs (standard DNS)
  72  */
  73 enum GNUNET_GNS_RecordType
  74 {
  75   /* Standard DNS */
  76   /* struct in_addr */
  77   GNUNET_GNS_RECORD_A          = GNUNET_DNSPARSER_TYPE_A,
  78
  79   /* char */
  80   GNUNET_GNS_RECORD_NS         = GNUNET_DNSPARSER_TYPE_NS,
  81
  82   /* char */
  83   GNUNET_GNS_RECORD_CNAME      = GNUNET_DNSPARSER_TYPE_CNAME,
  84
  85   /* struct soa_data */
  86   GNUNET_GNS_RECORD_SOA        = GNUNET_DNSPARSER_TYPE_SOA,
  87
  88   /* struct srv_data */
  89   GNUNET_GNS_RECORD_SRV        = GNUNET_DNSPARSER_TYPE_SRV,
  90
  91   /* char */
  92   GNUNET_GNS_RECORD_PTR        = GNUNET_DNSPARSER_TYPE_PTR,
  93
  94   /* uint16_t, char */
  95   GNUNET_GNS_RECORD_MX         = GNUNET_DNSPARSER_TYPE_MX,
  96
  97   /* char */
  98   GNUNET_GNS_RECORD_TXT        = GNUNET_DNSPARSER_TYPE_TXT,
  99
 100   /* struct in6_addr */
 101   GNUNET_GNS_RECORD_AAAA       = GNUNET_DNSPARSER_TYPE_AAAA,
 102
 103   /* GNS specific */
 104   /* struct GNUNET_CRYPTO_ShortHashCode */
 105   GNUNET_GNS_RECORD_PKEY = GNUNET_NAMESTORE_TYPE_PKEY,
 106
 107   /* char */
 108   GNUNET_GNS_RECORD_PSEU = GNUNET_NAMESTORE_TYPE_PSEU,
 109   GNUNET_GNS_RECORD_ANY  = GNUNET_NAMESTORE_TYPE_ANY,
 110
 111   /* char */
 112   GNUNET_GNS_RECORD_LEHO = GNUNET_NAMESTORE_TYPE_LEHO,
 113
 114   /* struct vpn_data */
 115   GNUNET_GNS_RECORD_VPN  = GNUNET_NAMESTORE_TYPE_VPN,
 116   GNUNET_GNS_RECORD_REV  = GNUNET_NAMESTORE_TYPE_REV
 117 };
 118
 119 /**
 120  * Initialize the connection with the GNS service.
 121  *
 122  * @param cfg configuration to use
 123  *
 124  * @return handle to the GNS service, or NULL on error
 125  */
 126 struct GNUNET_GNS_Handle *
 127 GNUNET_GNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
 128
 129
 130 /**
 131  * Shutdown connection with the GNS service.
 132  *
 133  * @param handle connection to shut down
 134  */
 135 void
 136 GNUNET_GNS_disconnect (struct GNUNET_GNS_Handle *handle);
 137
 138
 139 /* *************** Standard API: lookup ******************* */
 140
 141 /**
 142  * Iterator called on obtained result for a GNS
 143  * lookup
 144  *
 145  * @param cls closure
 146  * @param name "name" of the original lookup
 147  * @param rd_count number of records
 148  * @param rd the records in reply
 149  */
 150 typedef void (*GNUNET_GNS_LookupResultProcessor) (void *cls,
 151                                  uint32_t rd_count,
 152                                  const struct GNUNET_NAMESTORE_RecordData *rd);
 153
 154
 155
 156 /**
 157  * Perform an asynchronous lookup operation on the GNS
 158  * in the default zone.
 159  *
 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
 167  *
 168  * @return handle to the queued request
 169  */
 170 struct GNUNET_GNS_LookupRequest*
 171 GNUNET_GNS_lookup (struct GNUNET_GNS_Handle *handle,
 172                          const char * name,
 173                          enum GNUNET_GNS_RecordType type,
 174                          int only_cached,
 175                          struct GNUNET_CRYPTO_RsaPrivateKey *shorten_key,
 176                          GNUNET_GNS_LookupResultProcessor proc,
 177                          void *proc_cls);
 178
 179 /**
 180  * Perform an asynchronous lookup operation on the GNS
 181  * in the zone specified by 'zone'.
 182  *
 183  * @param handle handle to the GNS service
 184  * @param name the name to look up
 185  * @param zone the zone to start the resolution in
 186  * @param type the GNUNET_GNS_RecordType to look for
 187  * @param only_cached GNUNET_YES to only check locally not DHT for performance
 188  * @param shorten_key the private key of the shorten zone (can be NULL)
 189  * @param proc function to call on result
 190  * @param proc_cls closure for processor
 191  *
 192  * @return handle to the queued request
 193  */
 194 struct GNUNET_GNS_LookupRequest*
 195 GNUNET_GNS_lookup_zone (struct GNUNET_GNS_Handle *handle,
 196                          const char * name,
 197                          struct GNUNET_CRYPTO_ShortHashCode *zone,
 198                          enum GNUNET_GNS_RecordType type,
 199                          int only_cached,
 200                          struct GNUNET_CRYPTO_RsaPrivateKey *shorten_key,
 201                          GNUNET_GNS_LookupResultProcessor proc,
 202                          void *proc_cls);
 203
 204
 205 /**
 206  * Cancel pending lookup request
 207  *
 208  * @param lr the lookup request to cancel
 209  */
 210 void
 211 GNUNET_GNS_cancel_lookup_request (struct GNUNET_GNS_LookupRequest *lr);
 212
 213 /* *************** Standard API: shorten ******************* */
 214
 215
 216 /**
 217  * Processor called on for a name shortening result
 218  * called only once
 219  *
 220  * @param cls closure
 221  * @param short_name the shortened name or NULL if no result
 222  */
 223 typedef void (*GNUNET_GNS_ShortenResultProcessor) (void *cls,
 224                                         const char* short_name);
 225
 226
 227 /**
 228  * Perform a name shortening operation on the GNS.
 229  *
 230  * @param handle handle to the GNS service
 231  * @param name the name to look up
 232  * @param private_zone the public zone of the private zone
 233  * @param shorten_zone the public zone of the shorten zone
 234  * @param proc function to call on result
 235  * @param proc_cls closure for processor
 236  * @return handle to the operation
 237  */
 238 struct GNUNET_GNS_ShortenRequest*
 239 GNUNET_GNS_shorten (struct GNUNET_GNS_Handle *handle,
 240                     const char * name,
 241                     struct GNUNET_CRYPTO_ShortHashCode *private_zone,
 242                     struct GNUNET_CRYPTO_ShortHashCode *shorten_zone,
 243                     GNUNET_GNS_ShortenResultProcessor proc,
 244                     void *proc_cls);
 245
 246
 247 /**
 248  * Perform a name shortening operation on the GNS.
 249  *
 250  * @param handle handle to the GNS service
 251  * @param name the name to look up
 252  * @param private_zone the public zone of the private zone
 253  * @param shorten_zone the public zone of the shorten zone
 254  * @param zone the zone to start the resolution in
 255  * @param proc function to call on result
 256  * @param proc_cls closure for processor
 257  * @return handle to the operation
 258  */
 259 struct GNUNET_GNS_ShortenRequest*
 260 GNUNET_GNS_shorten_zone (struct GNUNET_GNS_Handle *handle,
 261                          const char * name,
 262                          struct GNUNET_CRYPTO_ShortHashCode *private_zone,
 263                          struct GNUNET_CRYPTO_ShortHashCode *shorten_zone,
 264                          struct GNUNET_CRYPTO_ShortHashCode *zone,
 265                          GNUNET_GNS_ShortenResultProcessor proc,
 266                          void *proc_cls);
 267
 268
 269 /**
 270  * Cancel pending shorten request
 271  *
 272  * @param sr the lookup request to cancel
 273  */
 274 void
 275 GNUNET_GNS_cancel_shorten_request (struct GNUNET_GNS_ShortenRequest *sr);
 276
 277 /* *************** Standard API: get authority ******************* */
 278
 279
 280 /**
 281  * Processor called on for a name shortening result
 282  * called only once
 283  *
 284  * @param cls closure
 285  * @param auth_name the name of the auhtority or NULL
 286  */
 287 typedef void (*GNUNET_GNS_GetAuthResultProcessor) (void *cls,
 288                                         const char* short_name);
 289
 290
 291 /**
 292  * Perform an authority lookup for a given name.
 293  *
 294  * @param handle handle to the GNS service
 295  * @param name the name to look up authority for
 296  * @param proc function to call on result
 297  * @param proc_cls closure for processor
 298  * @return handle to the operation
 299  */
 300 struct GNUNET_GNS_GetAuthRequest*
 301 GNUNET_GNS_get_authority (struct GNUNET_GNS_Handle *handle,
 302                     const char * name,
 303                     GNUNET_GNS_GetAuthResultProcessor proc,
 304                     void *proc_cls);
 305
 306
 307 /**
 308  * Cancel pending get auth request
 309  *
 310  * @param gar the lookup request to cancel
 311  */
 312 void
 313 GNUNET_GNS_cancel_get_auth_request (struct GNUNET_GNS_GetAuthRequest *gar);
 314
 315 #if 0                           /* keep Emacsens' auto-indent happy */
 316 {
 317 #endif
 318 #ifdef __cplusplus
 319 }
 320 #endif
 321
 322
 323 #endif
 324 /* gnunet_gns_service.h */