src/include/gnunet_gns_service.h

   1 /*
   2       This file is part of GNUnet
   3       Copyright (C) 2012-2014, 2017 GNUnet e.V.
   4
   5       GNUnet is free software: you can redistribute it and/or modify it
   6       under the terms of the GNU Affero General Public License as published
   7       by the Free Software Foundation, either version 3 of the License,
   8       or (at your 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       Affero General Public License for more details.
  14
  15       You should have received a copy of the GNU Affero General Public License
  16       along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18      SPDX-License-Identifier: AGPL3.0-or-later
  19  */
  20
  21 /**
  22  * @author Martin Schanzenbach
  23  *
  24  * @file
  25  * API to the GNS service
  26  *
  27  * @defgroup gns  GNS service
  28  * GNU Name System
  29  *
  30  * @see [Documentation](https://gnunet.org/gns-implementation)
  31  *
  32  * @{
  33  */
  34 #ifndef GNUNET_GNS_SERVICE_H
  35 #define GNUNET_GNS_SERVICE_H
  36
  37 #include "gnunet_util_lib.h"
  38 #include "gnunet_dnsparser_lib.h"
  39 #include "gnunet_namestore_service.h"
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #if 0 /* keep Emacsens' auto-indent happy */
  44 }
  45 #endif
  46 #endif
  47
  48
  49 /**
  50  * String we use to indicate an empty label (top-level
  51  * entry in the zone).  DNS uses "@", so do we.
  52  */
  53 #define GNUNET_GNS_EMPTY_LABEL_AT "@"
  54
  55 /**
  56  * Connection to the GNS service.
  57  */
  58 struct GNUNET_GNS_Handle;
  59
  60 /**
  61  * Handle to control a lookup operation.
  62  */
  63 struct GNUNET_GNS_LookupRequest;
  64
  65 /**
  66  * Handle to control a lookup operation where the
  67  * TLD is resolved to a zone as part of the lookup operation.
  68  */
  69 struct GNUNET_GNS_LookupWithTldRequest;
  70
  71
  72 /**
  73  * Initialize the connection with the GNS service.
  74  *
  75  * @param cfg configuration to use
  76  * @return handle to the GNS service, or NULL on error
  77  */
  78 struct GNUNET_GNS_Handle *
  79 GNUNET_GNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
  80
  81
  82 /**
  83  * Shutdown connection with the GNS service.
  84  *
  85  * @param handle connection to shut down
  86  */
  87 void
  88 GNUNET_GNS_disconnect (struct GNUNET_GNS_Handle *handle);
  89
  90
  91 /**
  92  * Iterator called on obtained result for a GNS lookup.
  93  *
  94  * @param cls closure
  95  * @param rd_count number of records in @a rd
  96  * @param rd the records in reply
  97  */
  98 typedef void (*GNUNET_GNS_LookupResultProcessor) (
  99   void *cls,
 100   uint32_t rd_count,
 101   const struct GNUNET_GNSRECORD_Data *rd);
 102
 103
 104 /**
 105  * Options for the GNS lookup.
 106  */
 107 enum GNUNET_GNS_LocalOptions
 108 {
 109   /**
 110    * Defaults, look in cache, then in DHT.
 111    */
 112   GNUNET_GNS_LO_DEFAULT = 0,
 113
 114   /**
 115    * Never look in the DHT, keep request to local cache.
 116    */
 117   GNUNET_GNS_LO_NO_DHT = 1,
 118
 119   /**
 120    * For the rightmost label, only look in the cache (it
 121    * is our local namestore), for the others, the DHT is OK.
 122    */
 123   GNUNET_GNS_LO_LOCAL_MASTER = 2
 124 };
 125
 126
 127 /**
 128  * Perform an asynchronous lookup operation on the GNS.
 129  *
 130  * @param handle handle to the GNS service
 131  * @param name the name to look up (in UTF-8 encoding)
 132  * @param zone zone to look in
 133  * @param type the GNS record type to look for
 134  * @param options local options for the lookup
 135  * @param proc function to call on result
 136  * @param proc_cls closure for @a proc
 137  * @return handle to the queued request
 138  */
 139 struct GNUNET_GNS_LookupRequest *
 140 GNUNET_GNS_lookup (struct GNUNET_GNS_Handle *handle,
 141                    const char *name,
 142                    const struct GNUNET_CRYPTO_EcdsaPublicKey *zone,
 143                    uint32_t type,
 144                    enum GNUNET_GNS_LocalOptions options,
 145                    GNUNET_GNS_LookupResultProcessor proc,
 146                    void *proc_cls);
 147
 148
 149 /**
 150  * Perform an asynchronous lookup operation on the GNS.
 151  *
 152  * @param handle handle to the GNS service
 153  * @param name the name to look up (in UTF-8 encoding)
 154  * @param zone zone to look in
 155  * @param type the GNS record type to look for
 156  * @param options local options for the lookup
 157  * @param recursion_depth_limit maximum number of zones
 158  *        that the lookup may (still) traverse
 159  * @param proc function to call on result
 160  * @param proc_cls closure for @a proc
 161  * @return handle to the queued request
 162  */
 163 struct GNUNET_GNS_LookupRequest *
 164 GNUNET_GNS_lookup_limited (struct GNUNET_GNS_Handle *handle,
 165                            const char *name,
 166                            const struct GNUNET_CRYPTO_EcdsaPublicKey *zone,
 167                            uint32_t type,
 168                            enum GNUNET_GNS_LocalOptions options,
 169                            uint16_t recursion_depth_limit,
 170                            GNUNET_GNS_LookupResultProcessor proc,
 171                            void *proc_cls);
 172
 173
 174 /**
 175  * Cancel pending lookup request
 176  *
 177  * @param lr the lookup request to cancel
 178  * @return closure from the lookup result processor
 179  */
 180 void *
 181 GNUNET_GNS_lookup_cancel (struct GNUNET_GNS_LookupRequest *lr);
 182
 183
 184 /**
 185  * Iterator called on obtained result for a GNS lookup
 186  * where "not GNS" is a valid answer.
 187  *
 188  * @param cls closure
 189  * @param gns_tld #GNUNET_YES if a GNS lookup was attempted,
 190  *                #GNUNET_NO if the TLD is not configured for GNS
 191  * @param rd_count number of records in @a rd
 192  * @param rd the records in the reply
 193  */
 194 typedef void (*GNUNET_GNS_LookupResultProcessor2) (
 195   void *cls,
 196   int gns_tld,
 197   uint32_t rd_count,
 198   const struct GNUNET_GNSRECORD_Data *rd);
 199
 200
 201 /**
 202  * Perform an asynchronous lookup operation on the GNS,
 203  * determining the zone using the TLD of the given name
 204  * and the current configuration to resolve TLDs to zones.
 205  *
 206  * @param handle handle to the GNS service
 207  * @param name the name to look up, including TLD (in UTF-8 encoding)
 208  * @param type the record type to look up
 209  * @param options local options for the lookup
 210  * @param proc processor to call on result
 211  * @param proc_cls closure for @a proc
 212  * @return handle to the get request
 213  */
 214 struct GNUNET_GNS_LookupWithTldRequest *
 215 GNUNET_GNS_lookup_with_tld (struct GNUNET_GNS_Handle *handle,
 216                             const char *name,
 217                             uint32_t type,
 218                             enum GNUNET_GNS_LocalOptions options,
 219                             GNUNET_GNS_LookupResultProcessor2 proc,
 220                             void *proc_cls);
 221
 222
 223 /**
 224  * Cancel pending lookup request
 225  *
 226  * @param ltr the lookup request to cancel
 227  * @return closure from the lookup result processor
 228  */
 229 void *
 230 GNUNET_GNS_lookup_with_tld_cancel (struct GNUNET_GNS_LookupWithTldRequest *ltr);
 231
 232
 233 #if 0 /* keep Emacsens' auto-indent happy */
 234 {
 235 #endif
 236 #ifdef __cplusplus
 237 }
 238 #endif
 239
 240 #endif
 241
 242 /** @} */ /* end of group */