/* * Copyright (C) 2016, 2017 "IoT.bzh" * Author José Bollo * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #define _GNU_SOURCE #define NO_BINDING_VERBOSE_MACRO #include #include #include #include #include #include #include #include #include #include #include #include #include #include "afb-session.h" #include "afb-common.h" #include "afb-context.h" #include "afb-apis.h" #include "afb-api-so.h" #include "afb-thread.h" #include "afb-evt.h" #include "afb-svc.h" #include "verbose.h" /* * Description of a binding */ struct api_so_desc { struct afb_binding *binding; /* descriptor */ size_t apilength; /* length of the API name */ void *handle; /* context of dlopen */ struct afb_svc *service; /* handler for service started */ struct afb_binding_interface interface; /* interface for the binding */ }; static const char binding_register_function_v1[] = "afbBindingV1Register"; static const char binding_service_init_function_v1[] = "afbBindingV1ServiceInit"; static const char binding_service_event_function_v1[] = "afbBindingV1ServiceEvent"; static int api_timeout = 15; static struct afb_event afb_api_so_event_make_cb(void *closure, const char *name); static int afb_api_so_event_broadcast_cb(void *closure, const char *name, struct json_object *object); static void afb_api_so_vverbose_cb(void *closure, int level, const char *file, int line, const char *fmt, va_list args); static int afb_api_so_rootdir_get_fd(void *closure); static int afb_api_so_rootdir_open_locale(void *closure, const char *filename, int flags, const char *locale); static const struct afb_daemon_itf daemon_itf = { .event_broadcast = afb_api_so_event_broadcast_cb, .get_event_loop = afb_common_get_event_loop, .get_user_bus = afb_common_get_user_bus, .get_system_bus = afb_common_get_system_bus, .vverbose = afb_api_so_vverbose_cb, .event_make = afb_api_so_event_make_cb, .rootdir_get_fd = afb_api_so_rootdir_get_fd, .rootdir_open_locale = afb_api_so_rootdir_open_locale }; static struct afb_event afb_api_so_event_make_cb(void *closure, const char *name) { size_t length; char *event; struct api_so_desc *desc = closure; /* makes the event name */ assert(desc->binding != NULL); length = strlen(name); event = alloca(length + 2 + desc->apilength); memcpy(event, desc->binding->v1.prefix, desc->apilength); event[desc->apilength] = '/'; memcpy(event + desc->apilength + 1, name, length + 1); /* crate the event */ return afb_evt_create_event(event); } static int afb_api_so_event_broadcast_cb(void *closure, const char *name, struct json_object *object) { size_t length; char *event; struct api_so_desc *desc = closure; /* makes the event name */ assert(desc->binding != NULL); length = strlen(name); event = alloca(length + 2 + desc->apilength); memcpy(event, desc->binding->v1.prefix, desc->apilength); event[desc->apilength] = '/'; memcpy(event + desc->apilength + 1, name, length + 1); return afb_evt_broadcast(event, object); } static void afb_api_so_vverbose_cb(void *closure, int level, const char *file, int line, const char *fmt, va_list args) { char *p; struct api_so_desc *desc = closure; if (vasprintf(&p, fmt, args) < 0) vverbose(level, file, line, fmt, args); else { verbose(level, file, line, "%s {binding %s}", p, desc->binding->v1.prefix); free(p); } } static int afb_api_so_rootdir_get_fd(void *closure) { return afb_common_rootdir_get_fd(); } static int afb_api_so_rootdir_open_locale(void *closure, const char *filename, int flags, const char *locale) { return afb_common_rootdir_open_locale(filename, flags, locale); } static int call_check(struct afb_req req, struct afb_context *context, const struct afb_verb_desc_v1 *verb) { int stag = (int)verb->session; if ((stag & (AFB_SESSION_CREATE|AFB_SESSION_CLOSE|AFB_SESSION_RENEW|AFB_SESSION_CHECK|AFB_SESSION_LOA_EQ)) != 0) { if (!afb_context_check(context)) { afb_context_close(context); afb_req_fail(req, "failed", "invalid token's identity"); return 0; } } if ((stag & AFB_SESSION_CREATE) != 0) { if (afb_context_check_loa(context, 1)) { afb_req_fail(req, "failed", "invalid creation state"); return 0; } afb_context_change_loa(context, 1); afb_context_refresh(context); } if ((stag & (AFB_SESSION_CREATE | AFB_SESSION_RENEW)) != 0) afb_context_refresh(context); if ((stag & AFB_SESSION_CLOSE) != 0) { afb_context_change_loa(context, 0); afb_context_close(context); } if ((stag & AFB_SESSION_LOA_GE) != 0) { int loa = (stag >> AFB_SESSION_LOA_SHIFT) & AFB_SESSION_LOA_MASK; if (!afb_context_check_loa(context, loa)) { afb_req_fail(req, "failed", "invalid LOA"); return 0; } } if ((stag & AFB_SESSION_LOA_LE) != 0) { int loa = (stag >> AFB_SESSION_LOA_SHIFT) & AFB_SESSION_LOA_MASK; if (afb_context_check_loa(context, loa + 1)) { afb_req_fail(req, "failed", "invalid LOA"); return 0; } } return 1; } static void call_cb(void *closure, struct afb_req req, struct afb_context *context, const char *strverb, size_t lenverb) { const struct afb_verb_desc_v1 *verb; struct api_so_desc *desc = closure; verb = desc->binding->v1.verbs; while (verb->name && (strncasecmp(verb->name, strverb, lenverb) || verb->name[lenverb])) verb++; if (!verb->name) afb_req_fail_f(req, "unknown-verb", "verb %.*s unknown within api %s", (int)lenverb, strverb, desc->binding->v1.prefix); else if (call_check(req, context, verb)) { afb_thread_req_call(req, verb->callback, api_timeout, desc); } } static int service_start_cb(void *closure, int share_session, int onneed) { int (*init)(struct afb_service service); void (*onevent)(const char *event, struct json_object *object); struct api_so_desc *desc = closure; /* check state */ if (desc->service != NULL) { /* not an error when onneed */ if (onneed != 0) return 0; /* already started: it is an error */ ERROR("Service %s already started", desc->binding->v1.prefix); return -1; } /* get the initialisation */ init = dlsym(desc->handle, binding_service_init_function_v1); if (init == NULL) { /* not an error when onneed */ if (onneed != 0) return 0; /* no initialisation method */ ERROR("Binding %s is not a service", desc->binding->v1.prefix); return -1; } /* get the event handler if any */ onevent = dlsym(desc->handle, binding_service_event_function_v1); desc->service = afb_svc_create(share_session, init, onevent); if (desc->service == NULL) { /* starting error */ ERROR("Starting service %s failed", desc->binding->v1.prefix); return -1; } return 0; } void afb_api_so_set_timeout(int to) { api_timeout = to; } int afb_api_so_add_binding(const char *path) { int rc; void *handle; struct api_so_desc *desc; struct afb_binding *(*register_function) (const struct afb_binding_interface *interface); struct afb_verb_desc_v1 fake_verb; struct afb_binding fake_binding; // This is a loadable library let's check if it's a binding rc = 0; handle = dlopen(path, RTLD_NOW | RTLD_LOCAL); if (handle == NULL) { ERROR("binding [%s] not loadable: %s", path, dlerror()); goto error; } /* retrieves the register function */ register_function = dlsym(handle, binding_register_function_v1); if (!register_function) { ERROR("binding [%s] is not an AFB binding", path); goto error2; } INFO("binding [%s] is a valid AFB binding", path); rc = -1; /* allocates the description */ desc = calloc(1, sizeof *desc); if (desc == NULL) { ERROR("out of memory"); goto error2; } desc->handle = handle; /* init the interface */ desc->interface.verbosity = verbosity; desc->interface.mode = AFB_MODE_LOCAL; desc->interface.daemon.itf = &daemon_itf; desc->interface.daemon.closure = desc; /* for log purpose, a fake binding is needed here */ desc->binding = &fake_binding; fake_binding.type = AFB_BINDING_VERSION_1; fake_binding.v1.info = path; fake_binding.v1.prefix = path; fake_binding.v1.verbs = &fake_verb; fake_verb.name = NULL; /* init the binding */ NOTICE("binding [%s] calling registering function %s", path, binding_register_function_v1); desc->binding = register_function(&desc->interface); if (desc->binding == NULL) { ERROR("binding [%s] register function failed. continuing...", path); goto error3; } /* check the returned structure */ if (desc->binding->type != AFB_BINDING_VERSION_1) { ERROR("binding [%s] invalid type %d...", path, desc->binding->type); goto error3; } if (desc->binding->v1.prefix == NULL || *desc->binding->v1.prefix == 0) { ERROR("binding [%s] bad prefix...", path); goto error3; } if (!afb_apis_is_valid_api_name(desc->binding->v1.prefix)) { ERROR("binding [%s] invalid prefix...", path); goto error3; } if (desc->binding->v1.info == NULL || *desc->binding->v1.info == 0) { ERROR("binding [%s] bad description...", path); goto error3; } if (desc->binding->v1.verbs == NULL) { ERROR("binding [%s] no APIs...", path); goto error3; } /* records the binding */ desc->apilength = strlen(desc->binding->v1.prefix); if (afb_apis_add(desc->binding->v1.prefix, (struct afb_api){ .closure = desc, .call = call_cb, .service_start = service_start_cb }) < 0) { ERROR("binding [%s] can't be registered...", path); goto error3; } NOTICE("binding %s loaded with API prefix %s", path, desc->binding->v1.prefix); return 0; error3: free(desc); error2: dlclose(handle); error: return rc; } static int adddirs(char path[PATH_MAX], size_t end) { DIR *dir; struct dirent *dent; size_t len; /* open the DIR now */ dir = opendir(path); if (dir == NULL) { ERROR("can't scan binding directory %s, %m", path); return -1; } INFO("Scanning dir=[%s] for bindings", path); /* scan each entry */ if (end) path[end++] = '/'; for (;;) { errno = 0; dent = readdir(dir); if (dent == NULL) { if (errno != 0) ERROR("read error while scanning directory %.*s: %m", (int)(end - 1), path); break; } len = strlen(dent->d_name); if (len + end >= PATH_MAX) { ERROR("path too long while scanning bindings for %s", dent->d_name); continue; } if (dent->d_type == DT_DIR) { /* case of directories */ if (dent->d_name[0] == '.') { if (len == 1) continue; if (dent->d_name[1] == '.' && len == 2) continue; } memcpy(&path[end], dent->d_name, len+1); adddirs(path, end+len);; } else if (dent->d_type == DT_REG) { /* case of files */ if (memcmp(&dent->d_name[len - 3], ".so", 4)) continue; memcpy(&path[end], dent->d_name, len+1); if (afb_api_so_add_binding(path) < 0) return -1; } } closedir(dir); return 0; } int afb_api_so_add_directory(const char *path) { size_t length; char buffer[PATH_MAX]; length = strlen(path); if (length >= sizeof(buffer)) { ERROR("path too long %lu [%.99s...]", (unsigned long)length, path); return -1; } memcpy(buffer, path, length + 1); return adddirs(buffer, length); } int afb_api_so_add_path(const char *path) { struct stat st; int rc; rc = stat(path, &st); if (rc < 0) ERROR("Invalid binding path [%s]: %m", path); else if (S_ISDIR(st.st_mode)) rc = afb_api_so_add_directory(path); else if (strstr(path, ".so")) rc = afb_api_so_add_binding(path); else INFO("not a binding [%s], skipped", path); return rc; } int afb_api_so_add_pathset(const char *pathset) { static char sep[] = ":"; char *ps, *p; ps = strdupa(pathset); for (;;) { p = strsep(&ps, sep); if (!p) return 0; if (afb_api_so_add_path(p) < 0) return -1; } }