2 This file is part of GNUnet.
3 Copyright (C) 2012-2015 GNUnet e.V.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
21 * @author Martin Schanzenbach
22 * @file gns/plugin_rest_gns.c
23 * @brief GNUnet GNS REST plugin
28 #include "gnunet_rest_plugin.h"
29 #include <gnunet_dnsparser_lib.h>
30 #include <gnunet_identity_service.h>
31 #include <gnunet_gnsrecord_lib.h>
32 #include <gnunet_namestore_service.h>
33 #include <gnunet_gns_service.h>
34 #include <gnunet_rest_lib.h>
37 #define GNUNET_REST_API_NS_GNS "/gns"
39 #define GNUNET_REST_JSONAPI_GNS_RECORD_TYPE "record_type"
41 #define GNUNET_REST_JSONAPI_GNS_TYPEINFO "gns_name"
43 #define GNUNET_REST_JSONAPI_GNS_RECORD "records"
45 #define GNUNET_REST_JSONAPI_GNS_EGO "ego"
47 #define GNUNET_REST_JSONAPI_GNS_PKEY "pkey"
49 #define GNUNET_REST_JSONAPI_GNS_OPTIONS "options"
52 * @brief struct returned by the initialization function of the plugin
56 const struct GNUNET_CONFIGURATION_Handle *cfg;
59 const struct GNUNET_CONFIGURATION_Handle *cfg;
64 * Handle to GNS service.
66 struct GNUNET_GNS_Handle *gns;
69 * Desired timeout for the lookup (default is no timeout).
71 struct GNUNET_TIME_Relative timeout;
74 * Handle to lookup request
76 struct GNUNET_GNS_LookupRequest *lookup_request;
79 * Lookup an ego with the identity service.
81 struct GNUNET_IDENTITY_EgoLookup *el;
84 * Handle for identity service.
86 struct GNUNET_IDENTITY_Handle *identity;
89 * Active operation on identity service.
91 struct GNUNET_IDENTITY_Operation *id_op;
94 * ID of a task associated with the resolution process.
96 struct GNUNET_SCHEDULER_Task * timeout_task;
99 * The root of the received JSON or NULL
104 * The plugin result processor
106 GNUNET_REST_ResultProcessor proc;
109 * The closure of the result processor
114 * The name to look up
120 * In string representation from JSON
126 * In string representation from JSON
128 const char *pkey_str;
136 * The public key of to use for lookup
138 struct GNUNET_CRYPTO_EcdsaPublicKey pkey;
141 * The public key to use for lookup
143 struct GNUNET_CRYPTO_EcdsaPublicKey pkeym;
146 * The resolver options
148 enum GNUNET_GNS_LocalOptions options;
153 struct GNUNET_CRYPTO_EcdsaPrivateKey shorten_key;
159 * Cleanup lookup handle.
161 * @param handle Handle to clean up
164 cleanup_handle (struct LookupHandle *handle)
166 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
168 if (NULL != handle->json_root)
169 json_decref (handle->json_root);
171 if (NULL != handle->name)
172 GNUNET_free (handle->name);
173 if (NULL != handle->el)
175 GNUNET_IDENTITY_ego_lookup_cancel (handle->el);
178 if (NULL != handle->id_op)
180 GNUNET_IDENTITY_cancel (handle->id_op);
181 handle->id_op = NULL;
183 if (NULL != handle->lookup_request)
185 GNUNET_GNS_lookup_cancel (handle->lookup_request);
186 handle->lookup_request = NULL;
188 if (NULL != handle->identity)
190 GNUNET_IDENTITY_disconnect (handle->identity);
191 handle->identity = NULL;
193 if (NULL != handle->gns)
195 GNUNET_GNS_disconnect (handle->gns);
199 if (NULL != handle->timeout_task)
201 GNUNET_SCHEDULER_cancel (handle->timeout_task);
203 GNUNET_free (handle);
208 * Task run on shutdown. Cleans up everything.
211 * @param tc scheduler context
216 struct LookupHandle *handle = cls;
217 struct MHD_Response *resp;
219 resp = GNUNET_REST_create_json_response (NULL);
220 handle->proc (handle->proc_cls, resp, MHD_HTTP_BAD_REQUEST);
221 cleanup_handle (handle);
226 * Create json representation of a GNSRECORD
228 * @param rd the GNSRECORD_Data
231 gnsrecord_to_json (const struct GNUNET_GNSRECORD_Data *rd)
233 const char *typename;
238 typename = GNUNET_GNSRECORD_number_to_typename (rd->record_type);
239 string_val = GNUNET_GNSRECORD_value_to_string (rd->record_type,
243 if (NULL == string_val)
245 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
246 "Record of type %d malformed, skipping\n",
247 (int) rd->record_type);
250 record_obj = json_object();
251 json_object_set_new (record_obj, "type", json_string (typename));
252 json_object_set_new (record_obj, "value", json_string (string_val));
253 GNUNET_free (string_val);
255 if (GNUNET_GNSRECORD_RF_RELATIVE_EXPIRATION & rd->flags)
257 struct GNUNET_TIME_Relative time_rel;
258 time_rel.rel_value_us = rd->expiration_time;
259 exp_str = GNUNET_STRINGS_relative_time_to_string (time_rel, 1);
263 struct GNUNET_TIME_Absolute time_abs;
264 time_abs.abs_value_us = rd->expiration_time;
265 exp_str = GNUNET_STRINGS_absolute_time_to_string (time_abs);
267 json_object_set_new (record_obj, "expiration_time", json_string (exp_str));
269 json_object_set_new (record_obj, "expired",
270 json_boolean (GNUNET_YES == GNUNET_GNSRECORD_is_expired (rd)));
275 * Function called with the result of a GNS lookup.
277 * @param cls the 'const char *' name that was resolved
278 * @param rd_count number of records returned
279 * @param rd array of @a rd_count records with the results
282 process_lookup_result (void *cls, uint32_t rd_count,
283 const struct GNUNET_GNSRECORD_Data *rd)
285 struct LookupHandle *handle = cls;
286 struct MHD_Response *resp;
287 struct JsonApiObject *json_object;
288 struct JsonApiResource *json_resource;
291 json_t *result_array;
294 result_array = json_array();
295 json_object = GNUNET_REST_jsonapi_object_new ();
296 json_resource = GNUNET_REST_jsonapi_resource_new (GNUNET_REST_JSONAPI_GNS_TYPEINFO, handle->name);
297 handle->lookup_request = NULL;
298 for (i=0; i<rd_count; i++)
300 if ( (rd[i].record_type != handle->type) &&
301 (GNUNET_GNSRECORD_TYPE_ANY != handle->type) )
303 record_obj = gnsrecord_to_json (&(rd[i]));
304 json_array_append (result_array, record_obj);
305 json_decref (record_obj);
307 GNUNET_REST_jsonapi_resource_add_attr (json_resource,
308 GNUNET_REST_JSONAPI_GNS_RECORD,
310 GNUNET_REST_jsonapi_object_resource_add (json_object, json_resource);
311 GNUNET_REST_jsonapi_data_serialize (json_object, &result);
312 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Result %s\n", result);
313 json_decref (result_array);
314 GNUNET_REST_jsonapi_object_delete (json_object);
315 resp = GNUNET_REST_create_json_response (result);
316 handle->proc (handle->proc_cls, resp, MHD_HTTP_OK);
317 GNUNET_free (result);
318 cleanup_handle (handle);
323 * Perform the actual resolution, starting with the zone
324 * identified by the given public key and the shorten zone.
326 * @param pkey public key to use for the zone, can be NULL
327 * @param shorten_key private key used for shortening, can be NULL
330 lookup_with_keys (struct LookupHandle *handle, const struct GNUNET_CRYPTO_EcdsaPrivateKey *shorten_key)
332 if (UINT32_MAX == handle->type)
334 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
335 _("Invalid typename specified, assuming `ANY'\n"));
336 handle->type = GNUNET_GNSRECORD_TYPE_ANY;
338 if (NULL != handle->name)
340 handle->lookup_request = GNUNET_GNS_lookup (handle->gns,
346 &process_lookup_result,
351 GNUNET_SCHEDULER_add_now (&do_error, handle);
357 * Method called to with the ego we are to use for shortening
360 * @param cls closure contains the public key to use
361 * @param ego ego handle, NULL if not found
362 * @param ctx context for application to store data for this ego
363 * (during the lifetime of this process, initially NULL)
364 * @param name name assigned by the user for this ego,
365 * NULL if the user just deleted the ego and it
366 * must thus no longer be used
369 identity_shorten_cb (void *cls,
370 struct GNUNET_IDENTITY_Ego *ego,
374 struct LookupHandle *handle = cls;
376 handle->id_op = NULL;
378 lookup_with_keys (handle, NULL);
380 lookup_with_keys (handle,
381 GNUNET_IDENTITY_ego_get_private_key (ego));
385 * Perform the actual resolution, starting with the zone
386 * identified by the given public key.
388 * @param pkey public key to use for the zone
391 lookup_with_public_key (struct LookupHandle *handle)
393 handle->pkeym = handle->pkey;
394 GNUNET_break (NULL == handle->id_op);
395 handle->id_op = GNUNET_IDENTITY_get (handle->identity,
397 &identity_shorten_cb,
399 if (NULL == handle->id_op)
402 lookup_with_keys (handle, NULL);
407 * Method called to with the ego we are to use for the lookup,
408 * when the ego is determined by a name.
410 * @param cls closure (NULL, unused)
411 * @param ego ego handle, NULL if not found
414 identity_zone_cb (void *cls,
415 const struct GNUNET_IDENTITY_Ego *ego)
417 struct LookupHandle *handle = cls;
422 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
423 _("Ego for not found, cannot perform lookup.\n"));
424 GNUNET_SCHEDULER_add_now (&do_error, handle);
429 GNUNET_IDENTITY_ego_get_public_key (ego, &handle->pkey);
430 lookup_with_public_key (handle);
432 json_decref(handle->json_root);
436 * Method called to with the ego we are to use for the lookup,
437 * when the ego is the one for the default master zone.
439 * @param cls closure (NULL, unused)
440 * @param ego ego handle, NULL if not found
441 * @param ctx context for application to store data for this ego
442 * (during the lifetime of this process, initially NULL)
443 * @param name name assigned by the user for this ego,
444 * NULL if the user just deleted the ego and it
445 * must thus no longer be used
448 identity_master_cb (void *cls,
449 struct GNUNET_IDENTITY_Ego *ego,
454 struct LookupHandle *handle = cls;
456 handle->id_op = NULL;
459 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
460 _("Ego for `gns-master' not found, cannot perform lookup. Did you run gnunet-gns-import.sh?\n"));
461 GNUNET_SCHEDULER_add_now (&do_error, handle);
464 GNUNET_IDENTITY_ego_get_public_key (ego, &handle->pkey);
465 /* main name is our own master zone, do no look for that in the DHT */
466 handle->options = GNUNET_GNS_LO_LOCAL_MASTER;
467 /* if the name is of the form 'label.gnu', never go to the DHT */
469 if (NULL != handle->name)
470 dot = strchr (handle->name, '.');
471 if ( (NULL != dot) &&
472 (0 == strcasecmp (dot, ".gnu")) )
473 handle->options = GNUNET_GNS_LO_NO_DHT;
474 lookup_with_public_key (handle);
478 * Parse REST uri for name and record type
480 * @param url Url to parse
481 * @param handle lookup handle to populate
482 * @return GNUNET_SYSERR on error
485 parse_url (const char *url, struct LookupHandle *handle)
488 char tmp_url[strlen(url)+1];
491 strcpy (tmp_url, url);
492 tok = strtok ((char*)tmp_url, "/");
494 return GNUNET_SYSERR;
495 name = strtok (NULL, "/");
497 return GNUNET_SYSERR;
498 GNUNET_asprintf (&handle->name,
501 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
502 "Got name: %s\n", handle->name);
507 get_gns_cont (struct RestConnectionDataHandle *conndata_handle,
511 struct LookupHandle *handle = cls;
512 struct GNUNET_HashCode key;
514 //parse name and type from url
515 if (GNUNET_OK != parse_url (url, handle))
517 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Error parsing url...\n");
518 GNUNET_SCHEDULER_add_now (&do_error, handle);
521 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
523 handle->gns = GNUNET_GNS_connect (cfg);
524 handle->identity = GNUNET_IDENTITY_connect (cfg, NULL, NULL);
525 handle->timeout_task = GNUNET_SCHEDULER_add_delayed (handle->timeout,
527 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
529 if (NULL == handle->gns)
531 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
532 "Connecting to GNS failed\n");
533 GNUNET_SCHEDULER_add_now (&do_error, handle);
536 GNUNET_CRYPTO_hash (GNUNET_REST_JSONAPI_GNS_OPTIONS,
537 strlen (GNUNET_REST_JSONAPI_GNS_OPTIONS),
539 handle->options = GNUNET_GNS_LO_DEFAULT;
541 GNUNET_CONTAINER_multihashmap_contains (conndata_handle->url_param_map,
544 handle->options = GNUNET_GNS_LO_DEFAULT;//TODO(char*) GNUNET_CONTAINER_multihashmap_get (conndata_handle->url_param_map,
547 GNUNET_CRYPTO_hash (GNUNET_REST_JSONAPI_GNS_RECORD_TYPE,
548 strlen (GNUNET_REST_JSONAPI_GNS_RECORD_TYPE),
551 GNUNET_CONTAINER_multihashmap_contains (conndata_handle->url_param_map,
554 handle->type = GNUNET_GNSRECORD_typename_to_number
555 (GNUNET_CONTAINER_multihashmap_get (conndata_handle->url_param_map,
559 handle->type = GNUNET_GNSRECORD_TYPE_ANY;
561 GNUNET_CRYPTO_hash (GNUNET_REST_JSONAPI_GNS_PKEY,
562 strlen (GNUNET_REST_JSONAPI_GNS_PKEY),
565 GNUNET_CONTAINER_multihashmap_contains (conndata_handle->url_param_map,
568 handle->pkey_str = GNUNET_CONTAINER_multihashmap_get (conndata_handle->url_param_map,
571 GNUNET_CRYPTO_ecdsa_public_key_from_string (handle->pkey_str,
572 strlen(handle->pkey_str),
575 GNUNET_SCHEDULER_add_now (&do_error, handle);
578 lookup_with_public_key (handle);
581 GNUNET_CRYPTO_hash (GNUNET_REST_JSONAPI_GNS_EGO,
582 strlen (GNUNET_REST_JSONAPI_GNS_EGO),
585 GNUNET_CONTAINER_multihashmap_contains (conndata_handle->url_param_map,
588 handle->ego_str = GNUNET_CONTAINER_multihashmap_get (conndata_handle->url_param_map,
590 handle->el = GNUNET_IDENTITY_ego_lookup (cfg,
596 if ( (NULL != handle->name) &&
597 (strlen (handle->name) > 4) &&
598 (0 == strcmp (".zkey",
599 &handle->name[strlen (handle->name) - 4])) )
601 GNUNET_CRYPTO_ecdsa_key_get_public
602 (GNUNET_CRYPTO_ecdsa_key_get_anonymous (),
604 lookup_with_public_key (handle);
608 GNUNET_break (NULL == handle->id_op);
609 handle->id_op = GNUNET_IDENTITY_get (handle->identity,
613 GNUNET_assert (NULL != handle->id_op);
618 * Handle rest request
620 * @param handle the lookup handle
623 options_cont (struct RestConnectionDataHandle *con_handle,
627 struct MHD_Response *resp;
628 struct LookupHandle *handle = cls;
630 //For GNS, independent of path return all options
631 resp = GNUNET_REST_create_json_response (NULL);
632 MHD_add_response_header (resp,
633 "Access-Control-Allow-Methods",
634 MHD_HTTP_METHOD_GET);
635 handle->proc (handle->proc_cls, resp, MHD_HTTP_OK);
636 cleanup_handle (handle);
642 * Function processing the REST call
644 * @param method HTTP method
645 * @param url URL of the HTTP request
646 * @param data body of the HTTP request (optional)
647 * @param data_size length of the body
648 * @param proc callback function for the result
649 * @param proc_cls closure for callback function
650 * @return GNUNET_OK if request accepted
653 rest_gns_process_request(struct RestConnectionDataHandle *conndata_handle,
654 GNUNET_REST_ResultProcessor proc,
657 struct LookupHandle *handle = GNUNET_new (struct LookupHandle);
659 handle->timeout = GNUNET_TIME_UNIT_FOREVER_REL;
660 handle->proc_cls = proc_cls;
663 static const struct GNUNET_REST_RestConnectionHandler handlers[] = {
664 {MHD_HTTP_METHOD_GET, GNUNET_REST_API_NS_GNS, &get_gns_cont},
665 {MHD_HTTP_METHOD_OPTIONS, GNUNET_REST_API_NS_GNS, &options_cont},
666 GNUNET_REST_HANDLER_END
669 if (GNUNET_NO == GNUNET_REST_handle_request (conndata_handle, handlers, handle))
670 GNUNET_SCHEDULER_add_now (&do_error, handle);
676 * Entry point for the plugin.
678 * @param cls the "struct GNUNET_NAMESTORE_PluginEnvironment*"
679 * @return NULL on error, otherwise the plugin context
682 libgnunet_plugin_rest_gns_init (void *cls)
684 static struct Plugin plugin;
686 struct GNUNET_REST_Plugin *api;
688 if (NULL != plugin.cfg)
689 return NULL; /* can only initialize once! */
690 memset (&plugin, 0, sizeof (struct Plugin));
692 api = GNUNET_new (struct GNUNET_REST_Plugin);
694 api->name = GNUNET_REST_API_NS_GNS;
695 api->process_request = &rest_gns_process_request;
696 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
697 _("GNS REST API initialized\n"));
703 * Exit point from the plugin.
705 * @param cls the plugin context (as returned by "init")
706 * @return always NULL
709 libgnunet_plugin_rest_gns_done (void *cls)
711 struct GNUNET_REST_Plugin *api = cls;
712 struct Plugin *plugin = api->cls;
716 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
717 "GNS REST plugin is finished\n");
721 /* end of plugin_rest_gns.c */