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