src/afb-api-so.c

   1 /*
   2  * Copyright (C) 2016 "IoT.bzh"
   3  * Author José Bollo <jose.bollo@iot.bzh>
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *   http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #define _GNU_SOURCE
  19
  20 #include <stdio.h>
  21 #include <assert.h>
  22 #include <string.h>
  23 #include <dirent.h>
  24 #include <dlfcn.h>
  25 #include <unistd.h>
  26 #include <limits.h>
  27 #include <sys/types.h>
  28 #include <sys/stat.h>
  29
  30 #include <afb/afb-plugin.h>
  31 #include <afb/afb-req-itf.h>
  32 #include <afb/afb-event-sender-itf.h>
  33
  34 #include "session.h"
  35 #include "afb-common.h"
  36 #include "afb-context.h"
  37 #include "afb-apis.h"
  38 #include "afb-api-so.h"
  39 #include "afb-sig-handler.h"
  40 #include "verbose.h"
  41
  42 struct api_so_desc {
  43         struct AFB_plugin *plugin;      /* descriptor */
  44         size_t apilength;
  45         void *handle;                   /* context of dlopen */
  46         struct AFB_interface interface; /* interface */
  47 };
  48
  49 static int api_timeout = 15;
  50
  51 static const char plugin_register_function[] = "pluginAfbV1Register";
  52
  53 static void afb_api_so_event_sender_push(struct api_so_desc *desc, const char *name, struct json_object *object)
  54 {
  55         size_t length;
  56         char *event;
  57
  58         assert(desc->plugin != NULL);
  59         length = strlen(name);
  60         event = alloca(length + 2 + desc->apilength);
  61         memcpy(event, desc->plugin->v1.prefix, desc->apilength);
  62         event[desc->apilength] = '/';
  63         memcpy(event + desc->apilength + 1, name, length + 1);
  64         ctxClientEventSend(NULL, event, object);
  65 }
  66
  67 static const struct afb_event_sender_itf event_sender_itf = {
  68         .push = (void*)afb_api_so_event_sender_push
  69 };
  70
  71 static struct afb_event_sender afb_api_so_get_event_sender(struct api_so_desc *desc)
  72 {
  73         return (struct afb_event_sender){ .itf = &event_sender_itf, .closure = desc };
  74 }
  75
  76 static const struct afb_daemon_itf daemon_itf = {
  77         .get_event_sender = (void*)afb_api_so_get_event_sender,
  78         .get_event_loop = (void*)afb_common_get_event_loop,
  79         .get_user_bus = (void*)afb_common_get_user_bus,
  80         .get_system_bus = (void*)afb_common_get_system_bus
  81 };
  82
  83 struct monitoring {
  84         struct afb_req req;
  85         void (*action)(struct afb_req);
  86 };
  87
  88 static void monitored_call(int signum, struct monitoring *data)
  89 {
  90         if (signum != 0)
  91                 afb_req_fail_f(data->req, "aborted", "signal %s(%d) caught", strsignal(signum), signum);
  92         else
  93                 data->action(data->req);
  94 }
  95
  96 static void call_check(struct afb_req req, struct afb_context *context, const struct AFB_verb_desc_v1 *verb)
  97 {
  98         struct monitoring data;
  99
 100         int stag = (int)(verb->session & AFB_SESSION_MASK);
 101
 102         if (stag != AFB_SESSION_NONE) {
 103                 if (!afb_context_check(context)) {
 104                         afb_context_close(context);
 105                         afb_req_fail(req, "failed", "invalid token's identity");
 106                         return;
 107                 }
 108         }
 109
 110         if ((stag & AFB_SESSION_CREATE) != 0) {
 111                 if (afb_context_check_loa(context, 1)) {
 112                         afb_req_fail(req, "failed", "invalid creation state");
 113                         return;
 114                 }
 115                 afb_context_change_loa(context, 1);
 116                 afb_context_refresh(context);
 117         }
 118
 119         if ((stag & (AFB_SESSION_CREATE | AFB_SESSION_RENEW)) != 0)
 120                 afb_context_refresh(context);
 121
 122         if ((stag & AFB_SESSION_CLOSE) != 0) {
 123                 afb_context_change_loa(context, 0);
 124                 afb_context_close(context);
 125         }
 126
 127         data.req = req;
 128         data.action = verb->callback;
 129         afb_sig_monitor((void*)monitored_call, &data, api_timeout);
 130 }
 131
 132 static void call(struct api_so_desc *desc, struct afb_req req, struct afb_context *context, const char *verb, size_t lenverb)
 133 {
 134         const struct AFB_verb_desc_v1 *v;
 135
 136         v = desc->plugin->v1.verbs;
 137         while (v->name && (strncasecmp(v->name, verb, lenverb) || v->name[lenverb]))
 138                 v++;
 139         if (v->name)
 140                 call_check(req, context, v);
 141         else
 142                 afb_req_fail_f(req, "unknown-verb", "verb %.*s unknown within api %s", (int)lenverb, verb, desc->plugin->v1.prefix);
 143 }
 144
 145 int afb_api_so_add_plugin(const char *path)
 146 {
 147         int rc;
 148         void *handle;
 149         struct api_so_desc *desc;
 150         struct AFB_plugin *(*pluginAfbV1RegisterFct) (const struct AFB_interface *interface);
 151
 152         // This is a loadable library let's check if it's a plugin
 153         rc = 0;
 154         handle = dlopen(path, RTLD_NOW | RTLD_LOCAL);
 155         if (handle == NULL) {
 156                 ERROR("plugin [%s] not loadable", path);
 157                 goto error;
 158         }
 159
 160         /* retrieves the register function */
 161         pluginAfbV1RegisterFct = dlsym(handle, plugin_register_function);
 162         if (!pluginAfbV1RegisterFct) {
 163                 ERROR("plugin [%s] is not an AFB plugin", path);
 164                 goto error2;
 165         }
 166         INFO("plugin [%s] is a valid AFB plugin", path);
 167         rc = -1;
 168
 169         /* allocates the description */
 170         desc = calloc(1, sizeof *desc);
 171         if (desc == NULL) {
 172                 ERROR("out of memory");
 173                 goto error2;
 174         }
 175         desc->handle = handle;
 176
 177         /* init the interface */
 178         desc->interface.verbosity = 0;
 179         desc->interface.mode = AFB_MODE_LOCAL;
 180         desc->interface.daemon.itf = &daemon_itf;
 181         desc->interface.daemon.closure = desc;
 182
 183         /* init the plugin */
 184         desc->plugin = pluginAfbV1RegisterFct(&desc->interface);
 185         if (desc->plugin == NULL) {
 186                 ERROR("plugin [%s] register function failed. continuing...", path);
 187                 goto error3;
 188         }
 189
 190         /* check the returned structure */
 191         if (desc->plugin->type != AFB_PLUGIN_VERSION_1) {
 192                 ERROR("plugin [%s] invalid type %d...", path, desc->plugin->type);
 193                 goto error3;
 194         }
 195         if (desc->plugin->v1.prefix == NULL || *desc->plugin->v1.prefix == 0) {
 196                 ERROR("plugin [%s] bad prefix...", path);
 197                 goto error3;
 198         }
 199         if (!afb_apis_is_valid_api_name(desc->plugin->v1.prefix)) {
 200                 ERROR("plugin [%s] invalid prefix...", path);
 201                 goto error3;
 202         }
 203         if (desc->plugin->v1.info == NULL || *desc->plugin->v1.info == 0) {
 204                 ERROR("plugin [%s] bad description...", path);
 205                 goto error3;
 206         }
 207         if (desc->plugin->v1.verbs == NULL) {
 208                 ERROR("plugin [%s] no APIs...", path);
 209                 goto error3;
 210         }
 211
 212         /* records the plugin */
 213         desc->apilength = strlen(desc->plugin->v1.prefix);
 214         if (afb_apis_add(desc->plugin->v1.prefix, (struct afb_api){
 215                         .closure = desc,
 216                         .call = (void*)call}) < 0) {
 217                 ERROR("plugin [%s] can't be registered...", path);
 218                 goto error3;
 219         }
 220         NOTICE("plugin %s loaded with API prefix %s", path, desc->plugin->v1.prefix);
 221         return 0;
 222
 223 error3:
 224         free(desc);
 225 error2:
 226         dlclose(handle);
 227 error:
 228         return rc;
 229 }
 230
 231 static int adddirs(char path[PATH_MAX], size_t end)
 232 {
 233         DIR *dir;
 234         struct dirent ent, *result;
 235         size_t len;
 236
 237         /* open the DIR now */
 238         dir = opendir(path);
 239         if (dir == NULL) {
 240                 ERROR("can't scan plugin directory %s, %m", path);
 241                 return -1;
 242         }
 243         INFO("Scanning dir=[%s] for plugins", path);
 244
 245         /* scan each entry */
 246         if (end)
 247                 path[end++] = '/';
 248         for (;;) {
 249                 readdir_r(dir, &ent, &result);
 250                 if (result == NULL)
 251                         break;
 252
 253                 len = strlen(ent.d_name);
 254                 if (len + end >= PATH_MAX) {
 255                         ERROR("path too long while scanning plugins for %s", ent.d_name);
 256                         continue;
 257                 }
 258                 memcpy(&path[end], ent.d_name, len+1);
 259                 if (ent.d_type == DT_DIR) {
 260                         /* case of directories */
 261                         if (ent.d_name[0] == '.') {
 262                                 if (len == 1)
 263                                         continue;
 264                                 if (ent.d_name[1] == '.' && len == 2)
 265                                         continue;
 266                         }
 267                         adddirs(path, end+len);;
 268                 } else if (ent.d_type == DT_REG) {
 269                         /* case of files */
 270                         if (!strstr(ent.d_name, ".so"))
 271                                 continue;
 272                         if (afb_api_so_add_plugin(path) < 0)
 273                                 return -1;
 274                 }
 275         }
 276         closedir(dir);
 277         return 0;
 278 }
 279
 280 int afb_api_so_add_directory(const char *path)
 281 {
 282         size_t length;
 283         char buffer[PATH_MAX];
 284
 285         length = strlen(path);
 286         if (length >= sizeof(buffer)) {
 287                 ERROR("path too long %lu [%.99s...]", (unsigned long)length, path);
 288                 return -1;
 289         }
 290
 291         memcpy(buffer, path, length + 1);
 292         return adddirs(buffer, length);
 293 }
 294
 295 int afb_api_so_add_path(const char *path)
 296 {
 297         struct stat st;
 298         int rc;
 299
 300         rc = stat(path, &st);
 301         if (rc < 0)
 302                 ERROR("Invalid plugin path [%s]: %m", path);
 303         else if (S_ISDIR(st.st_mode))
 304                 rc = afb_api_so_add_directory(path);
 305         else if (strstr(path, ".so"))
 306                 rc = afb_api_so_add_plugin(path);
 307         else
 308                 INFO("not a plugin [%s], skipped", path);
 309         return rc;
 310 }
 311
 312 int afb_api_so_add_pathset(const char *pathset)
 313 {
 314         static char sep[] = ":";
 315         char *ps, *p;
 316
 317         ps = strdupa(pathset);
 318         for (;;) {
 319                 p = strsep(&ps, sep);
 320                 if (!p)
 321                         return 0;
 322                 if (afb_api_so_add_path(p) < 0)
 323                         return -1;
 324         }
 325 }
 326