include/afb/afb-plugin.h

   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 #pragma once
  19
  20 #include <stdarg.h>
  21
  22 /*****************************************************************************
  23  * This files is the main file to include for writing plugins dedicated to
  24  *
  25  *                      AFB-DAEMON
  26  *
  27  * Functions of plugins of afb-daemon are accessible by authorized clients
  28  * through the apis module of afb-daemon.
  29  *
  30  * A plugin is a shared library. This shared library must have at least one
  31  * exported symbol for being registered in afb-daemon.
  32  * For the current version of afb-daemon, the function exported MUST be named
  33  *
  34  *                  pluginAfbV1Register
  35  */
  36
  37 /*
  38  * Some function of the library are exported to afb-daemon.
  39  */
  40
  41 #include <afb/afb-req-itf.h>
  42 #include <afb/afb-event-sender-itf.h>
  43
  44 /*
  45  * Definition of the versions of the plugin.
  46  * The definition uses hashes.
  47  */
  48 enum  AFB_plugin_version
  49 {
  50        AFB_PLUGIN_VERSION_1 = 123456789        /* version 1 */
  51 };
  52
  53 /*
  54  * Enum for Session/Token/Assurance middleware.
  55  * This enumeration is valid for plugins of type 1
  56  */
  57 enum AFB_session_v1
  58 {
  59        AFB_SESSION_NONE = 0,   /* nothing required */
  60        AFB_SESSION_CREATE = 1, /* Obsolete */
  61        AFB_SESSION_CLOSE = 2,  /* After token authentification, closes the session at end */
  62        AFB_SESSION_RENEW = 4,  /* After token authentification, refreshes the token at end */
  63        AFB_SESSION_CHECK = 8,  /* Requires token authentification */
  64
  65        AFB_SESSION_LOA_GE = 16, /* check that the LOA is greater or equal to the given value */
  66        AFB_SESSION_LOA_LE = 32, /* check that the LOA is lesser or equal to the given value */
  67        AFB_SESSION_LOA_EQ = 48, /* check that the LOA is equal to the given value */
  68
  69        AFB_SESSION_LOA_SHIFT = 6, /* shift for LOA */
  70        AFB_SESSION_LOA_MASK = 7,  /* mask for LOA */
  71
  72        AFB_SESSION_LOA_0 = 0,   /* value for LOA of 0 */
  73        AFB_SESSION_LOA_1 = 64,  /* value for LOA of 1 */
  74        AFB_SESSION_LOA_2 = 128, /* value for LOA of 2 */
  75        AFB_SESSION_LOA_3 = 192, /* value for LOA of 3 */
  76        AFB_SESSION_LOA_4 = 256, /* value for LOA of 4 */
  77
  78        AFB_SESSION_LOA_LE_0 = AFB_SESSION_LOA_LE | AFB_SESSION_LOA_0, /* check LOA <= 0 */
  79        AFB_SESSION_LOA_LE_1 = AFB_SESSION_LOA_LE | AFB_SESSION_LOA_1, /* check LOA <= 1 */
  80        AFB_SESSION_LOA_LE_2 = AFB_SESSION_LOA_LE | AFB_SESSION_LOA_2, /* check LOA <= 2 */
  81        AFB_SESSION_LOA_LE_3 = AFB_SESSION_LOA_LE | AFB_SESSION_LOA_3, /* check LOA <= 3 */
  82
  83        AFB_SESSION_LOA_GE_0 = AFB_SESSION_LOA_GE | AFB_SESSION_LOA_0, /* check LOA >= 0 */
  84        AFB_SESSION_LOA_GE_1 = AFB_SESSION_LOA_GE | AFB_SESSION_LOA_1, /* check LOA >= 1 */
  85        AFB_SESSION_LOA_GE_2 = AFB_SESSION_LOA_GE | AFB_SESSION_LOA_2, /* check LOA >= 2 */
  86        AFB_SESSION_LOA_GE_3 = AFB_SESSION_LOA_GE | AFB_SESSION_LOA_3, /* check LOA >= 3 */
  87
  88        AFB_SESSION_LOA_EQ_0 = AFB_SESSION_LOA_EQ | AFB_SESSION_LOA_0, /* check LOA == 0 */
  89        AFB_SESSION_LOA_EQ_1 = AFB_SESSION_LOA_EQ | AFB_SESSION_LOA_1, /* check LOA == 1 */
  90        AFB_SESSION_LOA_EQ_2 = AFB_SESSION_LOA_EQ | AFB_SESSION_LOA_2, /* check LOA == 2 */
  91        AFB_SESSION_LOA_EQ_3 = AFB_SESSION_LOA_EQ | AFB_SESSION_LOA_3  /* check LOA == 3 */
  92 };
  93
  94 /*
  95  * Description of one verb of the API provided by the plugin
  96  * This enumeration is valid for plugins of type 1
  97  */
  98 struct AFB_verb_desc_v1
  99 {
 100        const char *name;                       /* name of the verb */
 101        enum AFB_session_v1 session;            /* authorisation and session requirements of the verb */
 102        void (*callback)(struct afb_req req);   /* callback function implementing the verb */
 103        const char *info;                       /* textual description of the verb */
 104 };
 105
 106 /*
 107  * Description of the plugins of type 1
 108  */
 109 struct AFB_plugin_desc_v1
 110 {
 111        const char *info;                       /* textual information about the plugin */
 112        const char *prefix;                     /* required prefix name for the plugin */
 113        const struct AFB_verb_desc_v1 *verbs;   /* array of descriptions of verbs terminated by a NULL name */
 114 };
 115
 116 /*
 117  * Description of a plugin
 118  */
 119 struct AFB_plugin
 120 {
 121        enum AFB_plugin_version type; /* type of the plugin */
 122        union {
 123                struct AFB_plugin_desc_v1 v1;   /* description of the plugin of type 1 */
 124        };
 125 };
 126
 127 /*
 128  * config mode
 129  */
 130 enum AFB_Mode {
 131        AFB_MODE_LOCAL = 0,     /* run locally */
 132        AFB_MODE_REMOTE,        /* run remotely */
 133        AFB_MODE_GLOBAL         /* run either remotely or locally (DONT USE! reserved for future) */
 134 };
 135
 136 /* declaration of features of libsystemd */
 137 struct sd_event;
 138 struct sd_bus;
 139
 140 /*
 141  * Definition of the facilities provided by the daemon.
 142  */
 143 struct afb_daemon_itf {
 144        struct afb_event_sender (*get_event_sender)(void *closure);           /* get the event manager */
 145        struct sd_event *(*get_event_loop)(void *closure);      /* get the common systemd's event loop */
 146        struct sd_bus *(*get_user_bus)(void *closure);          /* get the common systemd's user d-bus */
 147        struct sd_bus *(*get_system_bus)(void *closure);        /* get the common systemd's system d-bus */
 148        void (*vverbose)(void*closure, int level, const char *file, int line, const char *fmt, va_list args);
 149 };
 150
 151 /*
 152  * Structure for accessing daemon.
 153  * See also: afb_daemon_get_event_sender, afb_daemon_get_event_loop, afb_daemon_get_user_bus, afb_daemon_get_system_bus
 154  */
 155 struct afb_daemon {
 156        const struct afb_daemon_itf *itf;       /* the interfacing functions */
 157        void *closure;                          /* the closure when calling these functions */
 158 };
 159
 160 /*
 161  * Interface between the daemon and the plugin.
 162  */
 163 struct AFB_interface
 164 {
 165        struct afb_daemon daemon;       /* access to the daemon facilies */
 166        int verbosity;                  /* level of verbosity */
 167        enum AFB_Mode mode;             /* run mode (local or remote) */
 168 };
 169
 170 /*
 171  * Function for registering the plugin
 172  */
 173 extern const struct AFB_plugin *pluginAfbV1Register (const struct AFB_interface *interface);
 174
 175 /*
 176  * Retrieves the event sender of AFB
 177  * 'daemon' MUST be the daemon given in interface when activating the plugin.
 178  */
 179 static inline struct afb_event_sender afb_daemon_get_event_sender(struct afb_daemon daemon)
 180 {
 181         return daemon.itf->get_event_sender(daemon.closure);
 182 }
 183
 184 /*
 185  * Retrieves the common systemd's event loop of AFB
 186  * 'daemon' MUST be the daemon given in interface when activating the plugin.
 187  */
 188 static inline struct sd_event *afb_daemon_get_event_loop(struct afb_daemon daemon)
 189 {
 190         return daemon.itf->get_event_loop(daemon.closure);
 191 }
 192
 193 /*
 194  * Retrieves the common systemd's user/session d-bus of AFB
 195  * 'daemon' MUST be the daemon given in interface when activating the plugin.
 196  */
 197 static inline struct sd_bus *afb_daemon_get_user_bus(struct afb_daemon daemon)
 198 {
 199         return daemon.itf->get_user_bus(daemon.closure);
 200 }
 201
 202 /*
 203  * Retrieves the common systemd's system d-bus of AFB
 204  * 'daemon' MUST be the daemon given in interface when activating the plugin.
 205  */
 206 static inline struct sd_bus *afb_daemon_get_system_bus(struct afb_daemon daemon)
 207 {
 208         return daemon.itf->get_system_bus(daemon.closure);
 209 }
 210
 211 /*
 212  * Broadcasts widely the event of 'name' with the data 'object'.
 213  * 'object' can be NULL.
 214  * 'daemon' MUST be the daemon given in interface when activating the plugin.
 215  *
 216  * For conveniency, the function calls 'json_object_put' for 'object'.
 217  * Thus, in the case where 'object' should remain available after
 218  * the function returns, the function 'json_object_get' shall be used.
 219  */
 220 static inline void afb_daemon_broadcast_event(struct afb_daemon daemon, const char *name, struct json_object *object)
 221 {
 222         return afb_event_sender_push(afb_daemon_get_event_sender(daemon), name, object);
 223 }
 224
 225 /*
 226  * Send a message described by 'fmt' and following parameters
 227  * to the journal for the verbosity 'level'.
 228  * 'file' and 'line' are indicators of position of the code in source files.
 229  * 'daemon' MUST be the daemon given in interface when activating the plugin.
 230  */
 231 static inline void afb_daemon_verbose(struct afb_daemon daemon, int level, const char *file, int line, const char *fmt, ...) __attribute__((format(printf, 5, 6)));
 232 static inline void afb_daemon_verbose(struct afb_daemon daemon, int level, const char *file, int line, const char *fmt, ...)
 233 {
 234         va_list args;
 235         va_start(args, fmt);
 236         return daemon.itf->vverbose(daemon.closure, level, file, line, fmt, args);
 237         va_end(args);
 238 }
 239
 240 #if !defined(NO_PLUGIN_VERBOSE_MACRO)
 241 # if !defined(NO_PLUGIN_FILE_LINE_INDICATION)
 242 #  define ERROR(itf,...)   do{if(itf->verbosity>=0)afb_daemon_verbose(itf->daemon,3,__FILE__,__LINE__,__VA_ARGS__);}while(0)
 243 #  define WARNING(itf,...) do{if(itf->verbosity>=1)afb_daemon_verbose(itf->daemon,4,__FILE__,__LINE__,__VA_ARGS__);}while(0)
 244 #  define NOTICE(itf,...)  do{if(itf->verbosity>=1)afb_daemon_verbose(itf->daemon,5,__FILE__,__LINE__,__VA_ARGS__);}while(0)
 245 #  define INFO(itf,...)    do{if(itf->verbosity>=2)afb_daemon_verbose(itf->daemon,6,__FILE__,__LINE__,__VA_ARGS__);}while(0)
 246 #  define DEBUG(itf,...)   do{if(itf->verbosity>=3)afb_daemon_verbose(itf->daemon,7,__FILE__,__LINE__,__VA_ARGS__);}while(0)
 247 # else
 248 #  define ERROR(itf,...)   do{if(itf->verbosity>=0)afb_daemon_verbose(itf->daemon,3,NULL,0,__VA_ARGS__);}while(0)
 249 #  define WARNING(itf,...) do{if(itf->verbosity>=1)afb_daemon_verbose(itf->daemon,4,NULL,0,__VA_ARGS__);}while(0)
 250 #  define NOTICE(itf,...)  do{if(itf->verbosity>=1)afb_daemon_verbose(itf->daemon,5,NULL,0,__VA_ARGS__);}while(0)
 251 #  define INFO(itf,...)    do{if(itf->verbosity>=2)afb_daemon_verbose(itf->daemon,6,NULL,0,__VA_ARGS__);}while(0)
 252 #  define DEBUG(itf,...)   do{if(itf->verbosity>=3)afb_daemon_verbose(itf->daemon,7,NULL,0,__VA_ARGS__);}while(0)
 253 # endif
 254 #endif
 255