X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_gns_service.h;h=73f5db5ac0a81d3252968a478affbbd2e0d1bbb0;hb=211fd52268a5ae7856273dd8d8b3b3ed427beadb;hp=ba634df1d25f9cfa929d72330e9d81a2ab402bca;hpb=9b187e018ab2565f4ce119eda94f916ec053cc7e;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_gns_service.h b/src/include/gnunet_gns_service.h index ba634df1d..73f5db5ac 100644 --- a/src/include/gnunet_gns_service.h +++ b/src/include/gnunet_gns_service.h @@ -22,14 +22,7 @@ * @file include/gnunet_gns_service.h * @brief API to the GNS service * @author Martin Schanzenbach - * - * TODO: - * - decide what goes into storage API and what into GNS-service API - * - decide where to pass/expose/check keys / signatures - * - are GNS private keys per peer or per user? */ - - #ifndef GNUNET_GNS_SERVICE_H #define GNUNET_GNS_SERVICE_H @@ -52,13 +45,19 @@ extern "C" struct GNUNET_GNS_Handle; /** - * Handle to control a get operation. + * Handle to control a lookup operation. */ -struct GNUNET_GNS_LookupHandle; +struct GNUNET_GNS_LookupRequest; /** - * Handle to control a shorten operation + * Handle to control a shorten operation. */ +struct GNUNET_GNS_ShortenRequest; + +/** + * Handle to control a get authority operation + */ +struct GNUNET_GNS_GetAuthRequest; /** * Record types @@ -67,31 +66,61 @@ struct GNUNET_GNS_LookupHandle; enum GNUNET_GNS_RecordType { /* Standard DNS */ - GNUNET_GNS_RECORD_TYPE_A = GNUNET_DNSPARSER_TYPE_A, - GNUNET_GNS_RECORD_TYPE_NS = GNUNET_DNSPARSER_TYPE_NS, - GNUNET_GNS_RECORD_TYPE_CNAME = GNUNET_DNSPARSER_TYPE_CNAME, - GNUNET_GNS_RECORD_TYPE_SOA = GNUNET_DNSPARSER_TYPE_SOA, - GNUNET_GNS_RECORD_TYPE_PTR = GNUNET_DNSPARSER_TYPE_PTR, - GNUNET_GNS_RECORD_MX = GNUNET_DNSPARSER_TYPE_MX, - GNUNET_GNS_RECORD_TXT = GNUNET_DNSPARSER_TYPE_TXT, - GNUNET_GNS_RECORD_AAAA = GNUNET_DNSPARSER_TYPE_AAAA, + /* struct in_addr */ + GNUNET_GNS_RECORD_A = GNUNET_DNSPARSER_TYPE_A, + + /* char */ + GNUNET_GNS_RECORD_NS = GNUNET_DNSPARSER_TYPE_NS, + + /* char */ + GNUNET_GNS_RECORD_CNAME = GNUNET_DNSPARSER_TYPE_CNAME, + + /* struct soa_data */ + GNUNET_GNS_RECORD_SOA = GNUNET_DNSPARSER_TYPE_SOA, + + /* struct srv_data */ + GNUNET_GNS_RECORD_SRV = GNUNET_DNSPARSER_TYPE_SRV, + + /* char */ + GNUNET_GNS_RECORD_PTR = GNUNET_DNSPARSER_TYPE_PTR, + + /* uint16_t, char */ + GNUNET_GNS_RECORD_MX = GNUNET_DNSPARSER_TYPE_MX, + + /* char */ + GNUNET_GNS_RECORD_TXT = GNUNET_DNSPARSER_TYPE_TXT, + + /* struct in6_addr */ + GNUNET_GNS_RECORD_AAAA = GNUNET_DNSPARSER_TYPE_AAAA, /* GNS specific */ + /* struct GNUNET_CRYPTO_ShortHashCode */ GNUNET_GNS_RECORD_PKEY = GNUNET_NAMESTORE_TYPE_PKEY, - GNUNET_GNS_RECORD_PSEU = GNUNET_NAMESTORE_TYPE_PSEU + + /* char */ + GNUNET_GNS_RECORD_PSEU = GNUNET_NAMESTORE_TYPE_PSEU, + GNUNET_GNS_RECORD_ANY = GNUNET_NAMESTORE_TYPE_ANY, + + /* char */ + GNUNET_GNS_RECORD_LEHO = GNUNET_NAMESTORE_TYPE_LEHO, + + /* struct vpn_data */ + GNUNET_GNS_RECORD_VPN = GNUNET_NAMESTORE_TYPE_VPN, + + /* revocation */ + GNUNET_GNS_RECORD_REV = GNUNET_NAMESTORE_TYPE_REV }; + /** * Initialize the connection with the GNS service. - * FIXME: Do we need the ht_len? * * @param cfg configuration to use - * @param ht_len size of the internal hash table to use for parallel lookups - * @return NULL on error + * + * @return handle to the GNS service, or NULL on error */ struct GNUNET_GNS_Handle * -GNUNET_GNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, - unsigned int ht_len); +GNUNET_GNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg); /** @@ -106,50 +135,76 @@ GNUNET_GNS_disconnect (struct GNUNET_GNS_Handle *handle); /* *************** Standard API: lookup ******************* */ /** - * Iterator called on each result obtained for a GNS + * Iterator called on obtained result for a GNS * lookup * * @param cls closure - * @param name "name" of the original lookup * @param rd_count number of records * @param rd the records in reply */ -typedef void (*GNUNET_GNS_LookupIterator) (void *cls, - const char * name, - uint32_t rd_count, - const struct GNUNET_NAMESTORE_RecordData *rd); +typedef void (*GNUNET_GNS_LookupResultProcessor) (void *cls, + uint32_t rd_count, + const struct GNUNET_NAMESTORE_RecordData *rd); /** - * Perform an asynchronous lookup operation on the GNS. + * Perform an asynchronous lookup operation on the GNS + * in the default zone. * * @param handle handle to the GNS service * @param name the name to look up * @param type the GNUNET_GNS_RecordType to look for - * @param iter function to call on each result - * @param iter_cls closure for iter + * @param only_cached GNUNET_NO to only check locally not DHT for performance + * @param shorten_key the private key of the shorten zone (can be NULL) + * @param proc function to call on result + * @param proc_cls closure for processor * - * @return handle to stop the async lookup + * @return handle to the queued request */ -struct GNUNET_GNS_LookupHandle * -GNUNET_GNS_lookup_start (struct GNUNET_GNS_Handle *handle, - const char * name, - enum GNUNET_GNS_RecordType type, - GNUNET_GNS_LookupIterator iter, - void *iter_cls); +struct GNUNET_GNS_LookupRequest* +GNUNET_GNS_lookup (struct GNUNET_GNS_Handle *handle, + const char * name, + enum GNUNET_GNS_RecordType type, + int only_cached, + struct GNUNET_CRYPTO_RsaPrivateKey *shorten_key, + GNUNET_GNS_LookupResultProcessor proc, + void *proc_cls); /** - * Stop async GNS lookup. Frees associated resources. + * Perform an asynchronous lookup operation on the GNS + * in the zone specified by 'zone'. * - * @param lookup_handle lookup operation to stop. + * @param handle handle to the GNS service + * @param name the name to look up + * @param zone the zone to start the resolution in + * @param type the GNUNET_GNS_RecordType to look for + * @param only_cached GNUNET_YES to only check locally not DHT for performance + * @param shorten_key the private key of the shorten zone (can be NULL) + * @param proc function to call on result + * @param proc_cls closure for processor * - * On return lookup_handle will no longer be valid, caller - * must not use again!!! + * @return handle to the queued request + */ +struct GNUNET_GNS_LookupRequest* +GNUNET_GNS_lookup_zone (struct GNUNET_GNS_Handle *handle, + const char * name, + struct GNUNET_CRYPTO_ShortHashCode *zone, + enum GNUNET_GNS_RecordType type, + int only_cached, + struct GNUNET_CRYPTO_RsaPrivateKey *shorten_key, + GNUNET_GNS_LookupResultProcessor proc, + void *proc_cls); + + +/** + * Cancel pending lookup request + * + * @param lr the lookup request to cancel */ void -GNUNET_GNS_lookup_stop (struct GNUNET_GNS_LookupHandle *lookup_handle); +GNUNET_GNS_cancel_lookup_request (struct GNUNET_GNS_LookupRequest *lr); /* *************** Standard API: shorten ******************* */ @@ -159,29 +214,101 @@ GNUNET_GNS_lookup_stop (struct GNUNET_GNS_LookupHandle *lookup_handle); * called only once * * @param cls closure - * @param name "name" of the original lookup - * @param short_name the shortened name or NULL if no result + * @param short_name the shortened name or NULL if no result / error */ typedef void (*GNUNET_GNS_ShortenResultProcessor) (void *cls, - const char * name, - const char* short_name); + const char* short_name); /** - * Perform a shorten operation on name using the GNS. + * Perform a name shortening operation on the GNS. * * @param handle handle to the GNS service - * @param name the name to shorten - * @param proc processor to call on result - * @param iter_cls closure for processor - * - * @return handle to the shorten operation + * @param name the name to look up + * @param private_zone the public zone of the private zone + * @param shorten_zone the public zone of the shorten zone + * @param proc function to call on result + * @param proc_cls closure for processor + * @return handle to the operation */ -struct GNUNET_GNS_ShortenHandle * +struct GNUNET_GNS_ShortenRequest* GNUNET_GNS_shorten (struct GNUNET_GNS_Handle *handle, + const char * name, + struct GNUNET_CRYPTO_ShortHashCode *private_zone, + struct GNUNET_CRYPTO_ShortHashCode *shorten_zone, + GNUNET_GNS_ShortenResultProcessor proc, + void *proc_cls); + + +/** + * Perform a name shortening operation on the GNS. + * + * @param handle handle to the GNS service + * @param name the name to look up + * @param private_zone the public zone of the private zone + * @param shorten_zone the public zone of the shorten zone + * @param zone the zone to start the resolution in + * @param proc function to call on result + * @param proc_cls closure for processor + * @return handle to the operation + */ +struct GNUNET_GNS_ShortenRequest* +GNUNET_GNS_shorten_zone (struct GNUNET_GNS_Handle *handle, const char * name, + struct GNUNET_CRYPTO_ShortHashCode *private_zone, + struct GNUNET_CRYPTO_ShortHashCode *shorten_zone, + struct GNUNET_CRYPTO_ShortHashCode *zone, GNUNET_GNS_ShortenResultProcessor proc, - void *iter_cls); + void *proc_cls); + + +/** + * Cancel pending shorten request + * + * @param sr the lookup request to cancel + */ +void +GNUNET_GNS_cancel_shorten_request (struct GNUNET_GNS_ShortenRequest *sr); + + +/* *************** Standard API: get authority ******************* */ + + +/** + * Processor called on for a name shortening result + * called only once + * + * @param cls closure + * @param auth_name the name of the auhtority or NULL + */ +typedef void (*GNUNET_GNS_GetAuthResultProcessor) (void *cls, + const char* short_name); + + +/** + * Perform an authority lookup for a given name. + * + * @param handle handle to the GNS service + * @param name the name to look up authority for + * @param proc function to call on result + * @param proc_cls closure for processor + * @return handle to the operation + */ +struct GNUNET_GNS_GetAuthRequest* +GNUNET_GNS_get_authority (struct GNUNET_GNS_Handle *handle, + const char * name, + GNUNET_GNS_GetAuthResultProcessor proc, + void *proc_cls); + + +/** + * Cancel pending get auth request + * + * @param gar the lookup request to cancel + */ +void +GNUNET_GNS_cancel_get_auth_request (struct GNUNET_GNS_GetAuthRequest *gar); + #if 0 /* keep Emacsens' auto-indent happy */ { #endif