src/gns/gnunet-service-gns_resolver.h

   1 #ifndef GNS_RESOLVER_H
   2 #define GNS_RESOLVER_H
   3
   4 #include "gns.h"
   5 #include "gnunet_dht_service.h"
   6
   7 #define DHT_OPERATION_TIMEOUT  GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 60)
   8 #define GNUNET_GNS_DEFAULT_LOOKUP_TIMEOUT \
   9   GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
  10 #define DHT_LOOKUP_TIMEOUT DHT_OPERATION_TIMEOUT
  11 #define DHT_GNS_REPLICATION_LEVEL 5
  12
  13 #define GNUNET_GNS_MAX_PARALLEL_LOOKUPS 500
  14
  15 /*
  16  * DLL to hold the authority chain
  17  * we had to pass in the resolution process
  18  */
  19 struct AuthorityChain
  20 {
  21   struct AuthorityChain *prev;
  22
  23   struct AuthorityChain *next;
  24
  25   /* the zone hash of the authority */
  26   struct GNUNET_CRYPTO_ShortHashCode zone;
  27
  28   /* (local) name of the authority */
  29   char name[MAX_DNS_LABEL_LENGTH];
  30
  31   /* was the ns entry fresh */
  32   int fresh;
  33 };
  34
  35 /* handle to a resolution process */
  36 struct ResolverHandle;
  37
  38 /**
  39  * continuation called when cleanup of resolver finishes
  40  */
  41 typedef void (*ResolverCleanupContinuation) (void);
  42
  43 /**
  44  * processor for a record lookup result
  45  *
  46  * @param cls the closure
  47  * @param rd_count number of results
  48  * @param rd result data
  49  */
  50 typedef void (*RecordLookupProcessor) (void *cls,
  51                                   uint32_t rd_count,
  52                                   const struct GNUNET_NAMESTORE_RecordData *rd);
  53
  54
  55 /**
  56  * processor for a shorten result
  57  *
  58  * @param cls the closure
  59  * @param name shortened name
  60  */
  61 typedef void (*ShortenResultProcessor) (void *cls, const char* name);
  62
  63
  64 /**
  65  * processor for an authority result
  66  *
  67  * @param cls the closure
  68  * @param name name
  69  */
  70 typedef void (*GetAuthorityResultProcessor) (void *cls, const char* name);
  71
  72 /**
  73  * processor for a resolution result
  74  *
  75  * @param cls the closure
  76  * @param rh the resolution handle
  77  * @param rd_count number of results
  78  * @param rd result data
  79  */
  80 typedef void (*ResolutionResultProcessor) (void *cls,
  81                                   struct ResolverHandle *rh,
  82                                   uint32_t rd_count,
  83                                   const struct GNUNET_NAMESTORE_RecordData *rd);
  84
  85
  86 /**
  87  * Resolution status indicator
  88  * RSL_RECORD_EXISTS: the name to lookup exists
  89  * RSL_RECORD_EXPIRED: the name in the record expired
  90  * RSL_TIMED_OUT: resolution timed out
  91  */
  92 enum ResolutionStatus
  93 {
  94   RSL_RECORD_EXISTS = 1,
  95   RSL_RECORD_EXPIRED = 2,
  96   RSL_TIMED_OUT = 4
  97 };
  98
  99 /**
 100  * Handle to a currenty pending resolution
 101  * a ResolverHandle is passed to, for example
 102  * resolve_record_ns to resolve a record in the namestore.
 103  * On result (positive or negative) the ResolutionResultProcessor
 104  * is called.
 105  * If a timeout is set timeout_cont will be called.
 106  * If no timeout is set (ie timeout forever) then background resolutions
 107  * might be triggered.
 108  */
 109 struct ResolverHandle
 110 {
 111   /* The name to resolve */
 112   char name[MAX_DNS_NAME_LENGTH];
 113
 114   /* has this query been answered? how many matches */
 115   int answered;
 116
 117   /* Use only cache */
 118   int only_cached;
 119
 120   /* the authoritative zone to query */
 121   struct GNUNET_CRYPTO_ShortHashCode authority;
 122
 123   /* the name of the authoritative zone to query */
 124   char authority_name[MAX_DNS_LABEL_LENGTH];
 125
 126   /* a handle for dht lookups. should be NULL if no lookups are in progress */
 127   struct GNUNET_DHT_GetHandle *get_handle;
 128
 129   /* timeout set for this lookup task */
 130   struct GNUNET_TIME_Relative timeout;
 131
 132   /* timeout task for the lookup */
 133   GNUNET_SCHEDULER_TaskIdentifier timeout_task;
 134
 135   /* continuation to call on timeout */
 136   GNUNET_SCHEDULER_Task timeout_cont;
 137
 138   /* closure for timeout cont */
 139   void* timeout_cont_cls;
 140
 141   /* called when resolution phase finishes */
 142   ResolutionResultProcessor proc;
 143
 144   /* closure passed to proc */
 145   void* proc_cls;
 146
 147   /* DLL to store the authority chain */
 148   struct AuthorityChain *authority_chain_head;
 149
 150   /* DLL to store the authority chain */
 151   struct AuthorityChain *authority_chain_tail;
 152
 153   /* status of the resolution result */
 154   enum ResolutionStatus status;
 155
 156   /* The provate local zone of this request */
 157   struct GNUNET_CRYPTO_ShortHashCode private_local_zone;
 158
 159   /**
 160    * private key of an/our authoritative zone
 161    * can be NULL but automatical PKEY import will not work
 162    */
 163   struct GNUNET_CRYPTO_RsaPrivateKey *priv_key;
 164
 165   /**
 166    * the heap node associated with this lookup, null if timeout is set
 167    * used for DHT background lookups.
 168    */
 169   struct GNUNET_CONTAINER_HeapNode *dht_heap_node;
 170
 171   /**
 172    * Id for resolution process
 173    */
 174   unsigned long long id;
 175
 176 };
 177
 178
 179 /**
 180  * Handle to a record lookup
 181  */
 182 struct RecordLookupHandle
 183 {
 184   /* the record type to look up */
 185   enum GNUNET_GNS_RecordType record_type;
 186
 187   /* the name to look up */
 188   char name[MAX_DNS_NAME_LENGTH];
 189
 190   /* Method to call on record resolution result */
 191   RecordLookupProcessor proc;
 192
 193   /* closure to pass to proc */
 194   void* proc_cls;
 195
 196 };
 197
 198
 199 /**
 200  * Handle to a shorten context
 201  */
 202 struct NameShortenHandle
 203 {
 204   /* Method to call on shorten result */
 205   ShortenResultProcessor proc;
 206
 207   /* closure to pass to proc */
 208   void* proc_cls;
 209 };
 210
 211 /**
 212  * Handle to a get authority context
 213  */
 214 struct GetNameAuthorityHandle
 215 {
 216   /* the name to look up authority for */
 217   char name[MAX_DNS_NAME_LENGTH];
 218
 219   /* Method to call on result */
 220   GetAuthorityResultProcessor proc;
 221
 222   /* closure to pass to proc */
 223   void* proc_cls;
 224 };
 225
 226 /**
 227  * Handle to a pseu lookup
 228  */
 229 struct GetPseuAuthorityHandle
 230 {
 231   /* the name given from delegation */
 232   char name[MAX_DNS_LABEL_LENGTH];
 233
 234   /* name to store the pseu under */
 235   char new_name[MAX_DNS_LABEL_LENGTH];
 236
 237   /* the zone of discovered authority */
 238   struct GNUNET_CRYPTO_ShortHashCode new_zone;
 239
 240   /* the zone of our authority */
 241   struct GNUNET_CRYPTO_ShortHashCode zone;
 242
 243   /* the private key of the zone to store the pseu in */
 244   struct GNUNET_CRYPTO_RsaPrivateKey *key;
 245
 246   /* a handle for dht lookups. should be NULL if no lookups are in progress */
 247   struct GNUNET_DHT_GetHandle *get_handle;
 248
 249   /* timeout task for lookup */
 250   GNUNET_SCHEDULER_TaskIdentifier timeout;
 251 };
 252
 253 /**
 254  * Initialize the resolver
 255  * MUST be called before other gns_resolver_* methods
 256  *
 257  * @param nh handle to the namestore
 258  * @param dh handle to the dht
 259  * @param lz the local zone
 260  * @param max_bg_queries maximum amount of background queries
 261  * @param ignore_pending ignore records that still require user confirmation
 262  *        on lookup
 263  * @returns GNUNET_OK on success
 264  */
 265 int
 266 gns_resolver_init(struct GNUNET_NAMESTORE_Handle *nh,
 267                   struct GNUNET_DHT_Handle *dh,
 268                   struct GNUNET_CRYPTO_ShortHashCode lz,
 269                   unsigned long long max_bg_queries,
 270                   int ignore_pending);
 271
 272 /**
 273  * Cleanup resolver: Terminate pending lookups
 274  *
 275  * @param cont continuation to call when finished
 276  */
 277 void
 278 gns_resolver_cleanup(ResolverCleanupContinuation cont);
 279
 280 /**
 281  * Lookup of a record in a specific zone
 282  * calls RecordLookupProcessor on result or timeout
 283  *
 284  * @param zone the root zone
 285  * @param pzone the private local zone
 286  * @param record_type the record type to look up
 287  * @param name the name to look up
 288  * @param key optional private key for authority caching
 289  * @param timeout timeout for the resolution
 290  * @param only_cached GNUNET_NO to only check locally not DHT for performance
 291  * @param proc the processor to call
 292  * @param cls the closure to pass to proc
 293  */
 294 void
 295 gns_resolver_lookup_record(struct GNUNET_CRYPTO_ShortHashCode zone,
 296                            struct GNUNET_CRYPTO_ShortHashCode pzone,
 297                            uint32_t record_type,
 298                            const char* name,
 299                            struct GNUNET_CRYPTO_RsaPrivateKey *key,
 300                            struct GNUNET_TIME_Relative timeout,
 301                            int only_cached,
 302                            RecordLookupProcessor proc,
 303                            void* cls);
 304
 305 /**
 306  * Shortens a name if possible. If the shortening fails
 307  * name will be returned as shortened string. Else
 308  * a shorter version of the name will be returned.
 309  * There is no guarantee that the shortened name will
 310  * actually be canonical/short etc.
 311  *
 312  * @param zone the zone to perform the operation in
 313  * @param pzone the private local zone
 314  * @param name name to shorten
 315  * @param key optional private key for background lookups and PSEU import
 316  * @param proc the processor to call on shorten result
 317  * @param proc_cls the closure to pass to proc
 318  */
 319 void
 320 gns_resolver_shorten_name(struct GNUNET_CRYPTO_ShortHashCode zone,
 321                           struct GNUNET_CRYPTO_ShortHashCode pzone,
 322                           const char* name,
 323                           struct GNUNET_CRYPTO_RsaPrivateKey *key,
 324                           ShortenResultProcessor proc,
 325                           void* proc_cls);
 326
 327 /**
 328  * Tries to resolve the authority for name
 329  * in our namestore
 330  *
 331  * @param zone the root zone to look up for
 332  * @param pzone the private local zone
 333  * @param name the name to lookup up
 334  * @param proc the processor to call when finished
 335  * @param proc_cls the closure to pass to the processor
 336  */
 337 void
 338 gns_resolver_get_authority(struct GNUNET_CRYPTO_ShortHashCode zone,
 339                            struct GNUNET_CRYPTO_ShortHashCode pzone,
 340                            const char* name,
 341                            GetAuthorityResultProcessor proc,
 342                            void* proc_cls);
 343
 344 /**
 345  * Generic function to check for TLDs
 346  *
 347  * @param name the name to check
 348  * @param tld the tld to check
 349  * @return GNUNET_YES or GNUNET_NO
 350  */
 351 int
 352 is_tld(const char* name, const char* tld);
 353
 354 /**
 355  * Checks for gnunet/zkey
 356  */
 357 #define is_gnunet_tld(name) is_tld(name, GNUNET_GNS_TLD)
 358 #define is_zkey_tld(name) is_tld(name, GNUNET_GNS_TLD_ZKEY)
 359
 360
 361 #endif