src/afb-api-so-v1.c

   1 /*
   2  * Copyright (C) 2016, 2017 "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 #define AFB_BINDING_PRAGMA_NO_VERBOSE_MACRO
  20
  21 #include <stdio.h>
  22 #include <string.h>
  23 #include <dlfcn.h>
  24 #include <assert.h>
  25
  26 #include <json-c/json.h>
  27
  28 #include <afb/afb-binding-v1.h>
  29
  30 #include "afb-api.h"
  31 #include "afb-api-so-v1.h"
  32 #include "afb-apiset.h"
  33 #include "afb-svc.h"
  34 #include "afb-evt.h"
  35 #include "afb-common.h"
  36 #include "afb-context.h"
  37 #include "afb-api-so.h"
  38 #include "afb-xreq.h"
  39 #include "afb-ditf.h"
  40 #include "verbose.h"
  41
  42 /*
  43  * names of symbols
  44  */
  45 static const char afb_api_so_v1_register[] = "afbBindingV1Register";
  46 static const char afb_api_so_v1_service_init[] = "afbBindingV1ServiceInit";
  47 static const char afb_api_so_v1_service_event[] = "afbBindingV1ServiceEvent";
  48
  49 /*
  50  * Description of a binding
  51  */
  52 struct api_so_v1 {
  53         struct afb_binding_v1 *binding; /* descriptor */
  54         void *handle;                   /* context of dlopen */
  55         struct afb_svc *service;        /* handler for service started */
  56         struct afb_binding_interface_v1 interface;
  57         struct afb_ditf ditf;           /* daemon interface */
  58 };
  59
  60 static const struct afb_verb_desc_v1 *search(struct api_so_v1 *desc, const char *name)
  61 {
  62         const struct afb_verb_desc_v1 *verb;
  63
  64         verb = desc->binding->v1.verbs;
  65         while (verb->name && strcasecmp(verb->name, name))
  66                 verb++;
  67         return verb->name ? verb : NULL;
  68 }
  69
  70 static void call_cb(void *closure, struct afb_xreq *xreq)
  71 {
  72         const struct afb_verb_desc_v1 *verb;
  73         struct api_so_v1 *desc = closure;
  74
  75         verb = search(desc, xreq->verb);
  76         afb_xreq_call_verb_v1(xreq, verb);
  77 }
  78
  79 static int service_start_cb(void *closure, int share_session, int onneed, struct afb_apiset *apiset)
  80 {
  81         int (*init)(struct afb_service service);
  82         void (*onevent)(const char *event, struct json_object *object);
  83
  84         struct api_so_v1 *desc = closure;
  85
  86         /* check state */
  87         if (desc->service != NULL) {
  88                 /* not an error when onneed */
  89                 if (onneed != 0)
  90                         return 0;
  91
  92                 /* already started: it is an error */
  93                 ERROR("Service %s already started", desc->binding->v1.prefix);
  94                 return -1;
  95         }
  96
  97         /* get the initialisation */
  98         init = dlsym(desc->handle, afb_api_so_v1_service_init);
  99         onevent = dlsym(desc->handle, afb_api_so_v1_service_event);
 100         if (init == NULL && onevent == NULL) {
 101                 /* not an error when onneed */
 102                 if (onneed != 0)
 103                         return 0;
 104
 105                 /* no initialisation method */
 106                 ERROR("Binding %s is not a service", desc->binding->v1.prefix);
 107                 return -1;
 108         }
 109
 110         /* get the event handler if any */
 111         desc->service = afb_svc_create_v1(desc->binding->v1.prefix, apiset, share_session, init, onevent);
 112         if (desc->service == NULL) {
 113                 /* starting error */
 114                 ERROR("Starting service %s failed", desc->binding->v1.prefix);
 115                 return -1;
 116         }
 117
 118         return 0;
 119 }
 120
 121 static void update_hooks_cb(void *closure)
 122 {
 123         struct api_so_v1 *desc = closure;
 124         afb_ditf_update_hook(&desc->ditf);
 125         if (desc->service)
 126                 afb_svc_update_hook(desc->service);
 127 }
 128
 129 static int get_verbosity_cb(void *closure)
 130 {
 131         struct api_so_v1 *desc = closure;
 132         return desc->interface.verbosity;
 133 }
 134
 135 static void set_verbosity_cb(void *closure, int level)
 136 {
 137         struct api_so_v1 *desc = closure;
 138         desc->interface.verbosity = level;
 139 }
 140
 141 static struct json_object *addperm(struct json_object *o, struct json_object *x)
 142 {
 143         struct json_object *a;
 144
 145         if (!o)
 146                 return x;
 147
 148         if (!json_object_object_get_ex(o, "allOf", &a)) {
 149                 a = json_object_new_array();
 150                 json_object_array_add(a, o);
 151                 o = json_object_new_object();
 152                 json_object_object_add(o, "allOf", a);
 153         }
 154         json_object_array_add(a, x);
 155         return o;
 156 }
 157
 158 static struct json_object *addperm_key_val(struct json_object *o, const char *key, struct json_object *val)
 159 {
 160         struct json_object *x = json_object_new_object();
 161         json_object_object_add(x, key, val);
 162         return addperm(o, x);
 163 }
 164
 165 static struct json_object *addperm_key_valstr(struct json_object *o, const char *key, const char *val)
 166 {
 167         return addperm_key_val(o, key, json_object_new_string(val));
 168 }
 169
 170 static struct json_object *addperm_key_valint(struct json_object *o, const char *key, int val)
 171 {
 172         return addperm_key_val(o, key, json_object_new_int(val));
 173 }
 174
 175 static struct json_object *make_description_openAPIv3(struct api_so_v1 *desc)
 176 {
 177         char buffer[256];
 178         const struct afb_verb_desc_v1 *verb;
 179         struct json_object *r, *f, *a, *i, *p, *g;
 180
 181         r = json_object_new_object();
 182         json_object_object_add(r, "openapi", json_object_new_string("3.0.0"));
 183
 184         i = json_object_new_object();
 185         json_object_object_add(r, "info", i);
 186         json_object_object_add(i, "title", json_object_new_string(desc->binding->v1.prefix));
 187         json_object_object_add(i, "version", json_object_new_string("0.0.0"));
 188         json_object_object_add(i, "description", json_object_new_string(desc->binding->v1.info ?: desc->binding->v1.prefix));
 189
 190         p = json_object_new_object();
 191         json_object_object_add(r, "paths", p);
 192         verb = desc->binding->v1.verbs;
 193         while (verb->name) {
 194                 buffer[0] = '/';
 195                 strncpy(buffer + 1, verb->name, sizeof buffer - 1);
 196                 buffer[sizeof buffer - 1] = 0;
 197                 f = json_object_new_object();
 198                 json_object_object_add(p, buffer, f);
 199                 g = json_object_new_object();
 200                 json_object_object_add(f, "get", g);
 201
 202                 a = NULL;
 203                 if (verb->session & AFB_SESSION_CLOSE_V1)
 204                         a = addperm_key_valstr(a, "session", "close");
 205                 if (verb->session & AFB_SESSION_CHECK_V1)
 206                         a = addperm_key_valstr(a, "session", "check");
 207                 if (verb->session & AFB_SESSION_RENEW_V1)
 208                         a = addperm_key_valstr(a, "token", "refresh");
 209                 if (verb->session & AFB_SESSION_LOA_MASK_V1)
 210                         a = addperm_key_valint(a, "LOA", (verb->session >> AFB_SESSION_LOA_SHIFT_V1) & AFB_SESSION_LOA_MASK_V1);
 211                 if (a)
 212                         json_object_object_add(g, "x-permissions", a);
 213
 214                 a = json_object_new_object();
 215                 json_object_object_add(g, "responses", a);
 216                 f = json_object_new_object();
 217                 json_object_object_add(a, "200", f);
 218                 json_object_object_add(f, "description", json_object_new_string(verb->info));
 219                 verb++;
 220         }
 221         return r;
 222 }
 223
 224 static struct json_object *describe_cb(void *closure)
 225 {
 226         struct api_so_v1 *desc = closure;
 227
 228         return make_description_openAPIv3(desc);
 229 }
 230
 231 static struct afb_api_itf so_v1_api_itf = {
 232         .call = call_cb,
 233         .service_start = service_start_cb,
 234         .update_hooks = update_hooks_cb,
 235         .get_verbosity = get_verbosity_cb,
 236         .set_verbosity = set_verbosity_cb,
 237         .describe = describe_cb
 238 };
 239
 240 int afb_api_so_v1_add(const char *path, void *handle, struct afb_apiset *apiset)
 241 {
 242         struct api_so_v1 *desc;
 243         struct afb_binding_v1 *(*register_function) (const struct afb_binding_interface_v1 *interface);
 244         struct afb_api afb_api;
 245
 246         /* retrieves the register function */
 247         register_function = dlsym(handle, afb_api_so_v1_register);
 248         if (!register_function)
 249                 return 0;
 250         INFO("binding [%s] is a valid AFB binding V1", path);
 251
 252         /* allocates the description */
 253         desc = calloc(1, sizeof *desc);
 254         if (desc == NULL) {
 255                 ERROR("out of memory");
 256                 goto error;
 257         }
 258         desc->handle = handle;
 259
 260         /* init the interface */
 261         afb_ditf_init_v1(&desc->ditf, path, &desc->interface);
 262
 263         /* init the binding */
 264         INFO("binding [%s] calling registering function %s", path, afb_api_so_v1_register);
 265         desc->binding = register_function(&desc->interface);
 266         if (desc->binding == NULL) {
 267                 ERROR("binding [%s] register function failed. continuing...", path);
 268                 goto error2;
 269         }
 270
 271         /* check the returned structure */
 272         if (desc->binding->type != AFB_BINDING_VERSION_1) {
 273                 ERROR("binding [%s] invalid type %d...", path, desc->binding->type);
 274                 goto error2;
 275         }
 276         if (desc->binding->v1.prefix == NULL || *desc->binding->v1.prefix == 0) {
 277                 ERROR("binding [%s] bad prefix...", path);
 278                 goto error2;
 279         }
 280         if (!afb_api_is_valid_name(desc->binding->v1.prefix)) {
 281                 ERROR("binding [%s] invalid prefix...", path);
 282                 goto error2;
 283         }
 284         if (desc->binding->v1.info == NULL || *desc->binding->v1.info == 0) {
 285                 ERROR("binding [%s] bad description...", path);
 286                 goto error2;
 287         }
 288         if (desc->binding->v1.verbs == NULL) {
 289                 ERROR("binding [%s] no APIs...", path);
 290                 goto error2;
 291         }
 292
 293         /* records the binding */
 294         afb_ditf_rename(&desc->ditf, desc->binding->v1.prefix);
 295         afb_api.closure = desc;
 296         afb_api.itf = &so_v1_api_itf;
 297         if (afb_apiset_add(apiset, desc->binding->v1.prefix, afb_api) < 0) {
 298                 ERROR("binding [%s] can't be registered...", path);
 299                 goto error2;
 300         }
 301         INFO("binding %s loaded with API prefix %s", path, desc->binding->v1.prefix);
 302         return 1;
 303
 304 error2:
 305         free(desc);
 306 error:
 307         return -1;
 308 }
 309