123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469 |
- /*
- This file is part of GNUnet.
- Copyright (C) 2012-2015 GNUnet e.V.
- GNUnet is free software: you can redistribute it and/or modify it
- under the terms of the GNU Affero General Public License as published
- by the Free Software Foundation, either version 3 of the License,
- or (at your option) any later version.
- GNUnet is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Affero General Public License for more details.
- You should have received a copy of the GNU Affero General Public License
- along with this program. If not, see <http://www.gnu.org/licenses/>.
- SPDX-License-Identifier: AGPL3.0-or-later
- */
- /**
- * @author Philippe Buschmann
- * @file gns/plugin_rest_gns.c
- * @brief GNUnet Gns REST plugin
- */
- #include "platform.h"
- #include "gnunet_rest_plugin.h"
- #include "gnunet_rest_lib.h"
- #include "gnunet_json_lib.h"
- #include "gnunet_gnsrecord_lib.h"
- #include "gnunet_gns_service.h"
- #include "microhttpd.h"
- #include <jansson.h>
- /**
- * Rest API GNS Namespace
- */
- #define GNUNET_REST_API_NS_GNS "/gns"
- /**
- * Rest API GNS Parameter record_type
- */
- #define GNUNET_REST_GNS_PARAM_RECORD_TYPE "record_type"
- /**
- * Rest API GNS ERROR Unknown Error
- */
- #define GNUNET_REST_GNS_ERROR_UNKNOWN "Unknown Error"
- /**
- * Rest API GNS ERROR Record not found
- */
- #define GNUNET_REST_GNS_NOT_FOUND "Record not found"
- /**
- * The configuration handle
- */
- const struct GNUNET_CONFIGURATION_Handle *cfg;
- /**
- * HTTP methods allows for this plugin
- */
- static char *allow_methods;
- /**
- * @brief struct returned by the initialization function of the plugin
- */
- struct Plugin
- {
- const struct GNUNET_CONFIGURATION_Handle *cfg;
- };
- /**
- * The request handle
- */
- struct RequestHandle
- {
- /**
- * Connection to GNS
- */
- struct GNUNET_GNS_Handle *gns;
- /**
- * Active GNS lookup
- */
- struct GNUNET_GNS_LookupWithTldRequest *gns_lookup;
- /**
- * Name to look up
- */
- char *name;
- /**
- * Record type to look up
- */
- int record_type;
- /**
- * Rest connection
- */
- struct GNUNET_REST_RequestHandle *rest_handle;
- /**
- * Desired timeout for the lookup (default is no timeout).
- */
- struct GNUNET_TIME_Relative timeout;
- /**
- * ID of a task associated with the resolution process.
- */
- struct GNUNET_SCHEDULER_Task *timeout_task;
- /**
- * The plugin result processor
- */
- GNUNET_REST_ResultProcessor proc;
- /**
- * The closure of the result processor
- */
- void *proc_cls;
- /**
- * The url
- */
- char *url;
- /**
- * Error response message
- */
- char *emsg;
- /**
- * Response code
- */
- int response_code;
- };
- /**
- * Cleanup lookup handle
- * @param handle Handle to clean up
- */
- static void
- cleanup_handle (void *cls)
- {
- struct RequestHandle *handle = cls;
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Cleaning up\n");
- if (NULL != handle->gns_lookup)
- {
- GNUNET_GNS_lookup_with_tld_cancel (handle->gns_lookup);
- handle->gns_lookup = NULL;
- }
- if (NULL != handle->gns)
- {
- GNUNET_GNS_disconnect (handle->gns);
- handle->gns = NULL;
- }
- if (NULL != handle->timeout_task)
- {
- GNUNET_SCHEDULER_cancel (handle->timeout_task);
- handle->timeout_task = NULL;
- }
- if (NULL != handle->url)
- GNUNET_free (handle->url);
- if (NULL != handle->name)
- GNUNET_free (handle->name);
- if (NULL != handle->emsg)
- GNUNET_free (handle->emsg);
- GNUNET_free (handle);
- }
- /**
- * Task run on errors. Reports an error and cleans up everything.
- *
- * @param cls the `struct RequestHandle`
- */
- static void
- do_error (void *cls)
- {
- struct RequestHandle *handle = cls;
- struct MHD_Response *resp;
- json_t *json_error = json_object ();
- char *response;
- if (NULL != handle->timeout_task)
- GNUNET_SCHEDULER_cancel (handle->timeout_task);
- handle->timeout_task = NULL;
- if (NULL == handle->emsg)
- handle->emsg = GNUNET_strdup (GNUNET_REST_GNS_ERROR_UNKNOWN);
- json_object_set_new (json_error, "error", json_string (handle->emsg));
- if (0 == handle->response_code)
- handle->response_code = MHD_HTTP_INTERNAL_SERVER_ERROR;
- response = json_dumps (json_error, 0);
- resp = GNUNET_REST_create_response (response);
- handle->proc (handle->proc_cls, resp, handle->response_code);
- json_decref (json_error);
- GNUNET_free (response);
- GNUNET_SCHEDULER_add_now (&cleanup_handle, handle);
- }
- static void
- do_timeout (void *cls)
- {
- struct RequestHandle *handle = cls;
- handle->timeout_task = NULL;
- handle->response_code = MHD_HTTP_REQUEST_TIMEOUT;
- do_error (handle);
- }
- /**
- * Iterator called on obtained result for a GNS lookup.
- *
- * @param cls closure with the object
- * @param was_gns #GNUNET_NO if name was not a GNS name
- * @param rd_count number of records in @a rd
- * @param rd the records in reply
- */
- static void
- handle_gns_response (void *cls,
- int was_gns,
- uint32_t rd_count,
- const struct GNUNET_GNSRECORD_Data *rd)
- {
- struct RequestHandle *handle = cls;
- struct MHD_Response *resp;
- json_t *result_obj;
- char *result;
- handle->gns_lookup = NULL;
- if (GNUNET_NO == was_gns)
- {
- handle->response_code = MHD_HTTP_NOT_FOUND;
- handle->emsg = GNUNET_strdup (GNUNET_REST_GNS_NOT_FOUND);
- GNUNET_SCHEDULER_add_now (&do_error, handle);
- return;
- }
- result_obj = GNUNET_JSON_from_gnsrecord (handle->name, rd, rd_count);
- result = json_dumps (result_obj, 0);
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Result %s\n", result);
- resp = GNUNET_REST_create_response (result);
- handle->proc (handle->proc_cls, resp, MHD_HTTP_OK);
- GNUNET_free (result);
- json_decref (result_obj);
- GNUNET_SCHEDULER_add_now (&cleanup_handle, handle);
- }
- /**
- * Handle gns GET request
- *
- * @param con_handle the connection handle
- * @param url the url
- * @param cls the RequestHandle
- */
- void
- get_gns_cont (struct GNUNET_REST_RequestHandle *con_handle,
- const char *url,
- void *cls)
- {
- struct RequestHandle *handle = cls;
- struct GNUNET_HashCode key;
- char *record_type;
- char *name;
- name = NULL;
- handle->name = NULL;
- if (strlen (GNUNET_REST_API_NS_GNS) < strlen (handle->url))
- {
- name = &handle->url[strlen (GNUNET_REST_API_NS_GNS) + 1];
- }
- if (NULL == name)
- {
- handle->response_code = MHD_HTTP_NOT_FOUND;
- handle->emsg = GNUNET_strdup (GNUNET_REST_GNS_NOT_FOUND);
- GNUNET_SCHEDULER_add_now (&do_error, handle);
- return;
- }
- if (0 >= strlen (name))
- {
- handle->response_code = MHD_HTTP_NOT_FOUND;
- handle->emsg = GNUNET_strdup (GNUNET_REST_GNS_NOT_FOUND);
- GNUNET_SCHEDULER_add_now (&do_error, handle);
- return;
- }
- handle->name = GNUNET_strdup (name);
- handle->record_type = UINT32_MAX;
- GNUNET_CRYPTO_hash (GNUNET_REST_GNS_PARAM_RECORD_TYPE,
- strlen (GNUNET_REST_GNS_PARAM_RECORD_TYPE),
- &key);
- if (GNUNET_YES ==
- GNUNET_CONTAINER_multihashmap_contains (con_handle->url_param_map, &key))
- {
- record_type =
- GNUNET_CONTAINER_multihashmap_get (con_handle->url_param_map, &key);
- handle->record_type = GNUNET_GNSRECORD_typename_to_number (record_type);
- }
- if (UINT32_MAX == handle->record_type)
- {
- handle->record_type = GNUNET_GNSRECORD_TYPE_ANY;
- }
- handle->gns_lookup = GNUNET_GNS_lookup_with_tld (handle->gns,
- handle->name,
- handle->record_type,
- GNUNET_NO,
- &handle_gns_response,
- handle);
- }
- /**
- * Respond to OPTIONS request
- *
- * @param con_handle the connection handle
- * @param url the url
- * @param cls the RequestHandle
- */
- static void
- options_cont (struct GNUNET_REST_RequestHandle *con_handle,
- const char *url,
- void *cls)
- {
- struct MHD_Response *resp;
- struct RequestHandle *handle = cls;
- // independent of path return all options
- resp = GNUNET_REST_create_response (NULL);
- MHD_add_response_header (resp, "Access-Control-Allow-Methods", allow_methods);
- handle->proc (handle->proc_cls, resp, MHD_HTTP_OK);
- GNUNET_SCHEDULER_add_now (&cleanup_handle, handle);
- return;
- }
- /**
- * Handle rest request
- *
- * @param handle the request handle
- */
- static void
- init_cont (struct RequestHandle *handle)
- {
- struct GNUNET_REST_RequestHandlerError err;
- static const struct GNUNET_REST_RequestHandler handlers[] =
- { { MHD_HTTP_METHOD_GET, GNUNET_REST_API_NS_GNS, &get_gns_cont },
- { MHD_HTTP_METHOD_OPTIONS, GNUNET_REST_API_NS_GNS, &options_cont },
- GNUNET_REST_HANDLER_END };
- if (GNUNET_NO ==
- GNUNET_REST_handle_request (handle->rest_handle, handlers, &err, handle))
- {
- handle->response_code = err.error_code;
- GNUNET_SCHEDULER_add_now (&do_error, handle);
- }
- }
- /**
- * Function processing the REST call
- *
- * @param method HTTP method
- * @param url URL of the HTTP request
- * @param data body of the HTTP request (optional)
- * @param data_size length of the body
- * @param proc callback function for the result
- * @param proc_cls closure for callback function
- * @return GNUNET_OK if request accepted
- */
- static void
- rest_process_request (struct GNUNET_REST_RequestHandle *rest_handle,
- GNUNET_REST_ResultProcessor proc,
- void *proc_cls)
- {
- struct RequestHandle *handle = GNUNET_new (struct RequestHandle);
- handle->response_code = 0;
- handle->timeout =
- GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 60);
- handle->proc_cls = proc_cls;
- handle->proc = proc;
- handle->rest_handle = rest_handle;
- handle->url = GNUNET_strdup (rest_handle->url);
- if (handle->url[strlen (handle->url) - 1] == '/')
- handle->url[strlen (handle->url) - 1] = '\0';
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Connecting...\n");
- handle->gns = GNUNET_GNS_connect (cfg);
- init_cont (handle);
- handle->timeout_task =
- GNUNET_SCHEDULER_add_delayed (handle->timeout, &do_timeout, handle);
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Connected\n");
- }
- /**
- * Entry point for the plugin.
- *
- * @param cls Config info
- * @return NULL on error, otherwise the plugin context
- */
- void *
- libgnunet_plugin_rest_gns_init (void *cls)
- {
- static struct Plugin plugin;
- struct GNUNET_REST_Plugin *api;
- cfg = cls;
- if (NULL != plugin.cfg)
- return NULL; /* can only initialize once! */
- memset (&plugin, 0, sizeof(struct Plugin));
- plugin.cfg = cfg;
- api = GNUNET_new (struct GNUNET_REST_Plugin);
- api->cls = &plugin;
- api->name = GNUNET_REST_API_NS_GNS;
- api->process_request = &rest_process_request;
- GNUNET_asprintf (&allow_methods,
- "%s, %s, %s, %s, %s",
- MHD_HTTP_METHOD_GET,
- MHD_HTTP_METHOD_POST,
- MHD_HTTP_METHOD_PUT,
- MHD_HTTP_METHOD_DELETE,
- MHD_HTTP_METHOD_OPTIONS);
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, _ ("Gns REST API initialized\n"));
- return api;
- }
- /**
- * Exit point from the plugin.
- *
- * @param cls the plugin context (as returned by "init")
- * @return always NULL
- */
- void *
- libgnunet_plugin_rest_gns_done (void *cls)
- {
- struct GNUNET_REST_Plugin *api = cls;
- struct Plugin *plugin = api->cls;
- plugin->cfg = NULL;
- GNUNET_free_non_null (allow_methods);
- GNUNET_free (api);
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Gns REST plugin is finished\n");
- return NULL;
- }
- /* end of plugin_rest_gns.c */
|