2 * Copyright (C) 2015 "IoT.bzh"
3 * Author "Fulup Ar Foll"
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 * Contain all generic part to handle REST/API
20 * https://www.gnu.org/software/libmicrohttpd/tutorial.html [search 'largepost.c']
23 #include "../include/local-def.h"
30 #define AFB_MSG_JTYPE "AJB_reply"
34 static json_object *afbJsonType;
37 // Because of POST call multiple time requestApi we need to free POST handle here
38 // Note this method is called from http-svc just before closing session
39 PUBLIC void endPostRequest(AFB_PostHandle *postHandle) {
41 if (postHandle->type == AFB_POST_JSON) {
42 // if (verbose) fprintf(stderr, "End PostJson Request UID=%d\n", postHandle->uid);
45 if (postHandle->type == AFB_POST_FORM) {
46 if (verbose) fprintf(stderr, "End PostForm Request UID=%d\n", postHandle->uid);
48 free(postHandle->private);
52 // Check of apiurl is declare in this plugin and call it
53 STATIC AFB_error callPluginApi(AFB_plugin *plugin, AFB_request *request, void *context) {
54 json_object *jresp, *jcall;
56 int signals[]= {SIGALRM, SIGSEGV, SIGFPE, 0};
58 /*---------------------------------------------------------------
59 | Signal handler defined inside CallPluginApi to access Request
60 +---------------------------------------------------------------- */
61 void pluginError (int signum) {
63 AFB_clientCtx *context;
65 // unlock signal to allow a new signal to come
66 sigemptyset (&sigset);
67 sigaddset (&sigset, signum);
68 sigprocmask (SIG_UNBLOCK, &sigset, 0);
70 fprintf (stderr, "Oops:%s Plugin Api Timeout timeout\n", configTime());
71 longjmp (request->checkPluginCall, signum);
75 // If a plugin hold this urlpath call its callback
76 for (idx = 0; plugin->apis[idx].callback != NULL; idx++) {
77 if (!strcmp(plugin->apis[idx].name, request->api)) {
79 // Request was found and at least partially executed
80 request->jresp = json_object_new_object();
81 json_object_get (afbJsonType); // increate jsontype reference count
82 json_object_object_add (request->jresp, "jtype", afbJsonType);
84 // prepare an object to store calling values
85 jcall=json_object_new_object();
86 json_object_object_add(jcall, "prefix", json_object_new_string (plugin->prefix));
87 json_object_object_add(jcall, "api" , json_object_new_string (plugin->apis[idx].name));
89 // save context before calling the API
90 status = setjmp (request->checkPluginCall);
93 // Plugin aborted somewhere during its execution
94 json_object_object_add(jcall, "status", json_object_new_string ("abort"));
95 json_object_object_add(jcall, "info" , json_object_new_string ("Plugin broke during execution"));
96 json_object_object_add(request->jresp, "request", jcall);
100 // If timeout protection==0 we are in debug and we do not apply signal protection
101 if (request->config->apiTimeout > 0) {
102 for (sig=0; signals[sig] != 0; sig++) {
103 if (signal (signals[sig], pluginError) == SIG_ERR) {
104 request->errcode = MHD_HTTP_UNPROCESSABLE_ENTITY;
105 json_object_object_add(jcall, "status", json_object_new_string ("fail"));
106 json_object_object_add(jcall, "info", json_object_new_string ("Setting Timeout Handler Failed"));
107 json_object_object_add(request->jresp, "request", jcall);
111 // Trigger a timer to protect from unacceptable long time execution
112 alarm (request->config->apiTimeout);
115 // Out of SessionNone every call get a client context session
116 if (AFB_SESSION_NONE != plugin->apis[idx].session) {
118 // add client context to request
119 if (ctxClientGet(request, plugin) != AFB_SUCCESS) {
120 request->errcode=MHD_HTTP_INSUFFICIENT_STORAGE;
121 json_object_object_add(jcall, "status", json_object_new_string ("fail"));
122 json_object_object_add(jcall, "info", json_object_new_string ("Client Session Context Full !!!"));
123 json_object_object_add(request->jresp, "request", jcall);
127 if (verbose) fprintf(stderr, "Plugin=[%s] Api=[%s] Middleware=[%d] Client=[0x%x] Uuid=[%s] Token=[%s]\n"
128 , request->plugin, request->api, plugin->apis[idx].session, request->client, request->client->uuid, request->client->token);
130 switch(plugin->apis[idx].session) {
132 case AFB_SESSION_CREATE:
133 if (request->client->token[0] != '\0') {
134 request->errcode=MHD_HTTP_UNAUTHORIZED;
135 json_object_object_add(jcall, "status", json_object_new_string ("exist"));
136 json_object_object_add(jcall, "info", json_object_new_string ("AFB_SESSION_CREATE Session already exist"));
137 json_object_object_add(request->jresp, "request", jcall);
141 if (AFB_SUCCESS != ctxTokenCreate (request)) {
142 request->errcode=MHD_HTTP_UNAUTHORIZED;
143 json_object_object_add(jcall, "status", json_object_new_string ("fail"));
144 json_object_object_add(jcall, "info", json_object_new_string ("AFB_SESSION_CREATE Invalid Initial Token"));
145 json_object_object_add(request->jresp, "request", jcall);
148 json_object_object_add(jcall, "uuid", json_object_new_string (request->client->uuid));
149 json_object_object_add(jcall, "token", json_object_new_string (request->client->token));
150 json_object_object_add(jcall, "timeout", json_object_new_int (request->config->cntxTimeout));
155 case AFB_SESSION_RENEW:
156 if (AFB_SUCCESS != ctxTokenRefresh (request)) {
157 request->errcode=MHD_HTTP_UNAUTHORIZED;
158 json_object_object_add(jcall, "status", json_object_new_string ("fail"));
159 json_object_object_add(jcall, "info", json_object_new_string ("AFB_SESSION_REFRESH Broken Exchange Token Chain"));
160 json_object_object_add(request->jresp, "request", jcall);
163 json_object_object_add(jcall, "uuid", json_object_new_string (request->client->uuid));
164 json_object_object_add(jcall, "token", json_object_new_string (request->client->token));
165 json_object_object_add(jcall, "timeout", json_object_new_int (request->config->cntxTimeout));
169 case AFB_SESSION_CLOSE:
170 if (AFB_SUCCESS != ctxTokenCheck (request)) {
171 request->errcode=MHD_HTTP_UNAUTHORIZED;
172 json_object_object_add(jcall, "status", json_object_new_string ("empty"));
173 json_object_object_add(jcall, "info", json_object_new_string ("AFB_SESSION_CLOSE Not a Valid Access Token"));
174 json_object_object_add(request->jresp, "request", jcall);
177 json_object_object_add(jcall, "uuid", json_object_new_string (request->client->uuid));
181 case AFB_SESSION_CHECK:
183 // default action is check
184 if (AFB_SUCCESS != ctxTokenCheck (request)) {
185 request->errcode=MHD_HTTP_UNAUTHORIZED;
186 json_object_object_add(jcall, "status", json_object_new_string ("fail"));
187 json_object_object_add(jcall, "info", json_object_new_string ("AFB_SESSION_CHECK Invalid Active Token"));
188 json_object_object_add(request->jresp, "request", jcall);
195 // Effectively call the API with a subset of the context
196 jresp = plugin->apis[idx].callback(request, context);
198 // handle intemediatry Post Iterates out of band
199 if ((jresp == NULL) && (request->errcode == MHD_HTTP_OK)) return (AFB_SUCCESS);
201 // Session close is done after the API call so API can still use session in closing API
202 if (AFB_SESSION_CLOSE == plugin->apis[idx].session) ctxTokenReset (request);
204 // API should return NULL of a valid Json Object
206 json_object_object_add(jcall, "status", json_object_new_string ("null"));
207 json_object_object_add(request->jresp, "request", jcall);
208 request->errcode = MHD_HTTP_NO_RESPONSE;
211 json_object_object_add(jcall, "status", json_object_new_string ("processed"));
212 json_object_object_add(request->jresp, "request", jcall);
213 json_object_object_add(request->jresp, "response", jresp);
215 // cancel timeout and plugin signal handle before next call
216 if (request->config->apiTimeout > 0) {
218 for (sig=0; signals[sig] != 0; sig++) {
219 signal (signals[sig], SIG_DFL);
229 STATIC AFB_error findAndCallApi (AFB_request *request, void *context) {
234 // Search for a plugin with this urlpath
235 for (idx = 0; request->plugins[idx] != NULL; idx++) {
236 if (!strcmp(request->plugins[idx]->prefix, request->plugin)) {
237 status =callPluginApi(request->plugins[idx], request, context);
241 // No plugin was found
242 if (request->plugins[idx] == NULL) {
243 request->jresp = jsonNewMessage(AFB_FATAL, "No Plugin=[%s]", request->plugin);
247 // plugin callback did not return a valid Json Object
248 if (status == AFB_FAIL) {
249 request->jresp = jsonNewMessage(AFB_FATAL, "No API=[%s] for Plugin=[%s]", request->api, request->plugin);
253 // Everything look OK
257 request->errcode = MHD_HTTP_UNPROCESSABLE_ENTITY;
261 // This CB is call for every item with a form post it reformat iterator values
262 // and callback Plugin API for each Item within PostForm.
263 doPostIterate (void *cls, enum MHD_ValueKind kind, const char *key,
264 const char *filename, const char *mimetype,
265 const char *encoding, const char *data, uint64_t offset,
271 // retrieve API request from Post iterator handle
272 AFB_PostHandle *postHandle = (AFB_PostHandle*)cls;
273 AFB_request *request = (AFB_request*)postHandle->private;
274 AFB_PostRequest postRequest;
276 fprintf (stderr, "postHandle key=%s filename=%s len=%d mime=%s\n", key, filename, size, mimetype);
278 // Create and Item value for Plugin API
281 item.filename = filename;
282 item.mimetype = mimetype;
283 item.encoding = encoding;
286 item.offset = offset;
288 // Reformat Request to make it somehow similar to GET/PostJson case
289 postRequest.data= (char*) postHandle;
290 postRequest.len = size;
291 postRequest.type= AFB_POST_FORM;;
292 request->post = &postRequest;
294 // effectively call plugin API
295 status = findAndCallApi (request, &item);
296 // when returning no processing of postform stop
297 if (status != AFB_SUCCESS) return MHD_NO;
299 // let's allow iterator to move to next item
303 STATIC void freeRequest (AFB_request *request) {
305 free (request->plugin);
310 STATIC AFB_request *createRequest (struct MHD_Connection *connection, AFB_session *session, const char* url) {
312 AFB_request *request;
314 // Start with a clean request
315 request = calloc (1, sizeof (AFB_request));
316 char *urlcpy1, *urlcpy2;
317 char *baseapi, *baseurl;
319 // Extract plugin urlpath from request and make two copy because strsep overload copy
320 urlcpy1 = urlcpy2 = strdup(url);
321 baseurl = strsep(&urlcpy2, "/");
322 if (baseurl == NULL) {
323 request->jresp = jsonNewMessage(AFB_FATAL, "Invalid API call url=[%s]", url);
326 // let's compute URL and call API
327 baseapi = strsep(&urlcpy2, "/");
328 if (baseapi == NULL) {
329 request->jresp = jsonNewMessage(AFB_FATAL, "Invalid API call url=[%s]", url);
332 // build request structure
333 request->connection = connection;
334 request->config = session->config;
336 request->plugin = strdup (baseurl);
337 request->api = strdup (baseapi);
338 request->plugins= session->plugins;
344 // process rest API query
345 PUBLIC int doRestApi(struct MHD_Connection *connection, AFB_session *session, const char* url, const char *method
346 , const char *upload_data, size_t *upload_data_size, void **con_cls) {
348 static int postcount = 0; // static counter to debug POST protocol
349 json_object *errMessage;
351 struct MHD_Response *webResponse;
352 const char *serialized;
353 AFB_request *request;
354 AFB_PostHandle *postHandle;
355 AFB_PostRequest postRequest;
358 // if post data may come in multiple calls
359 if (0 == strcmp(method, MHD_HTTP_METHOD_POST)) {
360 const char *encoding, *param;
362 postHandle = *con_cls;
364 // This is the initial post event let's create form post structure POST datas come in multiple events
365 if (postHandle == NULL) {
367 // allocate application POST processor handle to zero
368 postHandle = calloc(1, sizeof (AFB_PostHandle));
369 postHandle->uid = postcount++; // build a UID for DEBUG
370 *con_cls = postHandle; // update context with posthandle
372 // Let make sure we have the right encoding and a valid length
373 encoding = MHD_lookup_connection_value(connection, MHD_HEADER_KIND, MHD_HTTP_HEADER_CONTENT_TYPE);
375 // We are facing an empty post let's process it as a get
376 if (encoding == NULL) {
377 request= createRequest (connection, session, url);
381 // Form post is handle through a PostProcessor and call API once per form key
382 if (strcasestr(encoding, FORM_CONTENT) != NULL) {
383 if (verbose) fprintf(stderr, "Create PostForm[uid=%d]\n", postHandle->uid);
385 request = createRequest (connection, session, url);
386 if (request->jresp != NULL) {
387 errMessage = request->jresp;
390 postHandle = malloc(sizeof (AFB_PostHandle)); // allocate application POST processor handle
391 postHandle->type = AFB_POST_FORM;
392 postHandle->pp = MHD_create_post_processor (connection, MAX_POST_SIZE, doPostIterate, postHandle);
393 postHandle->private= (void*)request;
395 if (NULL == postHandle->pp) {
396 fprintf(stderr,"OOPS: Internal error fail to allocate MHD_create_post_processor\n");
403 // POST json is store into a buffer and present in one piece to API
404 if (strcasestr(encoding, JSON_CONTENT) != NULL) {
406 param = MHD_lookup_connection_value(connection, MHD_HEADER_KIND, MHD_HTTP_HEADER_CONTENT_LENGTH);
407 if (param) sscanf(param, "%i", &contentlen);
409 // Because PostJson are build in RAM size is constrained
410 if (contentlen > MAX_POST_SIZE) {
411 errMessage = jsonNewMessage(AFB_FATAL, "Post Date to big %d > %d", contentlen, MAX_POST_SIZE);
415 // Size is OK, let's allocate a buffer to hold post data
416 postHandle->type = AFB_POST_JSON;
417 postHandle->private = malloc(contentlen + 1); // allocate memory for full POST data + 1 for '\0' enf of string
419 // if (verbose) fprintf(stderr, "Create PostJson[uid=%d] Size=%d\n", postHandle->uid, contentlen);
423 // We only support Json and Form Post format
424 errMessage = jsonNewMessage(AFB_FATAL, "Post Date wrong type encoding=%s != %s", encoding, JSON_CONTENT);
429 // This time we receive partial/all Post data. Note that even if we get all POST data. We should nevertheless
430 // return MHD_YES and not process the request directly. Otherwise Libmicrohttpd is unhappy and fails with
431 // 'Internal application error, closing connection'.
432 if (*upload_data_size) {
434 if (postHandle->type == AFB_POST_FORM) {
435 // if (verbose) fprintf(stderr, "Processing PostForm[uid=%d]\n", postHandle->uid);
436 MHD_post_process (postHandle->pp, upload_data, *upload_data_size);
439 // Process JsonPost request when buffer is completed let's call API
440 if (postHandle->type == AFB_POST_JSON) {
441 // if (verbose) fprintf(stderr, "Updating PostJson[uid=%d]\n", postHandle->uid);
442 memcpy(&postHandle->private[postHandle->len], upload_data, *upload_data_size);
443 postHandle->len = postHandle->len + *upload_data_size;
446 *upload_data_size = 0;
449 } else { // we have finish with Post reception let's finish the work
451 // Create a request structure to finalise the request
452 request= createRequest (connection, session, url);
453 if (request->jresp != NULL) {
454 errMessage = request->jresp;
458 // Postform add application context handle to request
459 if (postHandle->type == AFB_POST_FORM) {
460 postRequest.data = (char*) postHandle;
461 postRequest.type = postHandle->type;
462 request->post = &postRequest;
465 if (postHandle->type == AFB_POST_JSON) {
466 // if (verbose) fprintf(stderr, "Processing PostJson[uid=%d]\n", postHandle->uid);
468 param = MHD_lookup_connection_value(connection, MHD_HEADER_KIND, MHD_HTTP_HEADER_CONTENT_LENGTH);
469 if (param) sscanf(param, "%i", &contentlen);
471 // At this level we're may verify that we got everything and process DATA
472 if (postHandle->len != contentlen) {
473 errMessage = jsonNewMessage(AFB_FATAL, "Post Data Incomplete UID=%d Len %d != %d", postHandle->uid, contentlen, postHandle->len);
477 // Before processing data, make sure buffer string is properly ended
478 postHandle->private[postHandle->len] = '\0';
479 postRequest.data = postHandle->private;
480 postRequest.type = postHandle->type;
481 request->post = &postRequest;
483 // if (verbose) fprintf(stderr, "Close Post[%d] Buffer=%s\n", postHandle->uid, request->post->data);
487 // this is a get we only need a request
488 request= createRequest (connection, session, url);
492 // Request is ready let's call API without any extra handle
493 status = findAndCallApi (request, NULL);
495 serialized = json_object_to_json_string(request->jresp);
496 webResponse = MHD_create_response_from_buffer(strlen(serialized), (void*) serialized, MHD_RESPMEM_MUST_COPY);
498 // client did not pass token on URI let's use cookies
499 if ((!request->restfull) && (request->client != NULL)) {
501 snprintf (cookie, sizeof (cookie), "%s=%s", COOKIE_NAME, request->client->uuid);
502 MHD_add_response_header (webResponse, MHD_HTTP_HEADER_SET_COOKIE, cookie);
505 // if requested add an error status
506 if (request->errcode != 0) ret=MHD_queue_response (connection, request->errcode, webResponse);
507 else MHD_queue_response(connection, MHD_HTTP_OK, webResponse);
509 MHD_destroy_response(webResponse);
510 json_object_put(request->jresp); // decrease reference rqtcount to free the json object
511 freeRequest (request);
515 freeRequest (request);
516 serialized = json_object_to_json_string(errMessage);
517 webResponse = MHD_create_response_from_buffer(strlen(serialized), (void*) serialized, MHD_RESPMEM_MUST_COPY);
518 MHD_queue_response(connection, MHD_HTTP_BAD_REQUEST, webResponse);
519 MHD_destroy_response(webResponse);
520 json_object_put(errMessage); // decrease reference rqtcount to free the json object
525 // Loop on plugins. Check that they have the right type, prepare a JSON object with prefix
526 STATIC AFB_plugin ** RegisterJsonPlugins(AFB_plugin **plugins) {
529 for (idx = 0; plugins[idx] != NULL; idx++) {
530 if (plugins[idx]->type != AFB_PLUGIN_JSON) {
531 fprintf(stderr, "ERROR: AFSV plugin[%d] invalid type=%d != %d\n", idx, AFB_PLUGIN_JSON, plugins[idx]->type);
533 // some sanity controls
534 if ((plugins[idx]->prefix == NULL) || (plugins[idx]->info == NULL) || (plugins[idx]->apis == NULL)) {
535 if (plugins[idx]->prefix == NULL) plugins[idx]->prefix = "No URL prefix for APIs";
536 if (plugins[idx]->info == NULL) plugins[idx]->info = "No Info describing plugin APIs";
537 fprintf(stderr, "ERROR: plugin[%d] invalid prefix=%s info=%s", idx, plugins[idx]->prefix, plugins[idx]->info);
541 if (verbose) fprintf(stderr, "Loading plugin[%d] prefix=[%s] info=%s\n", idx, plugins[idx]->prefix, plugins[idx]->info);
543 // Prebuild plugin jtype to boost API response
544 plugins[idx]->jtype = json_object_new_string(plugins[idx]->prefix);
545 json_object_get(plugins[idx]->jtype); // increase reference count to make it permanent
546 plugins[idx]->prefixlen = strlen(plugins[idx]->prefix);
549 // Prebuild each API jtype to boost API json response
550 for (jdx = 0; plugins[idx]->apis[jdx].name != NULL; jdx++) {
551 AFB_privateApi *private = malloc (sizeof (AFB_privateApi));
552 if (plugins[idx]->apis[jdx].private != NULL) {
553 fprintf (stderr, "WARNING: plugin=%s api=%s private handle should be NULL=0x%x\n"
554 ,plugins[idx]->prefix,plugins[idx]->apis[jdx].name, plugins[idx]->apis[jdx].private);
556 private->len = strlen (plugins[idx]->apis[jdx].name);
557 private->jtype=json_object_new_string(plugins[idx]->apis[jdx].name);
558 json_object_get(private->jtype); // increase reference count to make it permanent
559 plugins[idx]->apis[jdx].private = private;
566 void initPlugins(AFB_session *session) {
567 static AFB_plugin **plugins;
568 AFB_plugin* (*pluginRegisterFct)(void);
571 struct dirent *pluginDir;
573 afbJsonType = json_object_new_string (AFB_MSG_JTYPE);
576 /* pre-allocate for 20 plugins, we will downsize if necessary */
577 plugins = (AFB_plugin **) malloc (20*sizeof(AFB_plugin));
579 if ((dir = opendir(session->config->plugins)) == NULL) {
580 fprintf(stderr, "Could not open plugin directory [%s], exiting...\n", session->config->plugins);
584 while ((pluginDir = readdir(dir)) != NULL) {
586 if (!strstr (pluginDir->d_name, ".so"))
589 asprintf (&pluginPath, "%s/%s", session->config->plugins, pluginDir->d_name);
590 plugin = dlopen (pluginPath, RTLD_NOW | RTLD_LOCAL);
591 pluginRegisterFct = dlsym (plugin, "pluginRegister");
594 if (verbose) fprintf(stderr, "[%s] is not loadable, continuing...\n", pluginDir->d_name);
596 } else if (!pluginRegisterFct) {
597 if (verbose) fprintf(stderr, "[%s] is not an AFB plugin, continuing...\n", pluginDir->d_name);
601 if (verbose) fprintf(stderr, "[%s] is a valid AFB plugin, loading it\n", pluginDir->d_name);
602 plugins[num] = (AFB_plugin *) malloc (sizeof(AFB_plugin));
603 plugins[num] = (**pluginRegisterFct)();
605 /* only 20 plugins are supported at that time */
606 if (num == 20) break;
608 plugins = (AFB_plugin **) realloc (plugins, (num+1)*sizeof(AFB_plugin));
613 if (plugins[0] == NULL) {
614 fprintf(stderr, "No plugins found, afb-daemon is unlikely to work in this configuration, exiting...\n");
618 // complete plugins and save them within current sessions
619 session->plugins = RegisterJsonPlugins(plugins);
620 session->pluginCount = num;