2 * Copyright (C) 2016 "IoT.bzh"
3 * Author: José Bollo <jose.bollo@iot.bzh>
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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 /*****************************************************************************
23 * This files is the main file to include for writing plugins dedicated to
27 * Functions of plugins of afb-daemon are accessible by authorized clients
28 * through the apis module of afb-daemon.
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
38 * Some function of the library are exported to afb-daemon.
41 #include <afb/afb-req-itf.h>
44 * Definition of the versions of the plugin.
45 * The definition uses hashes.
47 enum AFB_plugin_version
49 AFB_PLUGIN_VERSION_1 = 123456789 /* version 1 */
53 * Enum for Session/Token/Assurance middleware.
54 * This enumeration is valid for plugins of type 1
58 AFB_SESSION_NONE = 0, /* nothing required */
59 AFB_SESSION_CREATE = 1, /* Obsolete */
60 AFB_SESSION_CLOSE = 2, /* After token authentification, closes the session at end */
61 AFB_SESSION_RENEW = 4, /* After token authentification, refreshes the token at end */
62 AFB_SESSION_CHECK = 8, /* Requires token authentification */
64 AFB_SESSION_LOA_GE = 16, /* check that the LOA is greater or equal to the given value */
65 AFB_SESSION_LOA_LE = 32, /* check that the LOA is lesser or equal to the given value */
66 AFB_SESSION_LOA_EQ = 48, /* check that the LOA is equal to the given value */
68 AFB_SESSION_LOA_SHIFT = 6, /* shift for LOA */
69 AFB_SESSION_LOA_MASK = 7, /* mask for LOA */
71 AFB_SESSION_LOA_0 = 0, /* value for LOA of 0 */
72 AFB_SESSION_LOA_1 = 64, /* value for LOA of 1 */
73 AFB_SESSION_LOA_2 = 128, /* value for LOA of 2 */
74 AFB_SESSION_LOA_3 = 192, /* value for LOA of 3 */
75 AFB_SESSION_LOA_4 = 256, /* value for LOA of 4 */
77 AFB_SESSION_LOA_LE_0 = AFB_SESSION_LOA_LE | AFB_SESSION_LOA_0, /* check LOA <= 0 */
78 AFB_SESSION_LOA_LE_1 = AFB_SESSION_LOA_LE | AFB_SESSION_LOA_1, /* check LOA <= 1 */
79 AFB_SESSION_LOA_LE_2 = AFB_SESSION_LOA_LE | AFB_SESSION_LOA_2, /* check LOA <= 2 */
80 AFB_SESSION_LOA_LE_3 = AFB_SESSION_LOA_LE | AFB_SESSION_LOA_3, /* check LOA <= 3 */
82 AFB_SESSION_LOA_GE_0 = AFB_SESSION_LOA_GE | AFB_SESSION_LOA_0, /* check LOA >= 0 */
83 AFB_SESSION_LOA_GE_1 = AFB_SESSION_LOA_GE | AFB_SESSION_LOA_1, /* check LOA >= 1 */
84 AFB_SESSION_LOA_GE_2 = AFB_SESSION_LOA_GE | AFB_SESSION_LOA_2, /* check LOA >= 2 */
85 AFB_SESSION_LOA_GE_3 = AFB_SESSION_LOA_GE | AFB_SESSION_LOA_3, /* check LOA >= 3 */
87 AFB_SESSION_LOA_EQ_0 = AFB_SESSION_LOA_EQ | AFB_SESSION_LOA_0, /* check LOA == 0 */
88 AFB_SESSION_LOA_EQ_1 = AFB_SESSION_LOA_EQ | AFB_SESSION_LOA_1, /* check LOA == 1 */
89 AFB_SESSION_LOA_EQ_2 = AFB_SESSION_LOA_EQ | AFB_SESSION_LOA_2, /* check LOA == 2 */
90 AFB_SESSION_LOA_EQ_3 = AFB_SESSION_LOA_EQ | AFB_SESSION_LOA_3 /* check LOA == 3 */
94 * Description of one verb of the API provided by the plugin
95 * This enumeration is valid for plugins of type 1
97 struct AFB_verb_desc_v1
99 const char *name; /* name of the verb */
100 enum AFB_session_v1 session; /* authorisation and session requirements of the verb */
101 void (*callback)(struct afb_req req); /* callback function implementing the verb */
102 const char *info; /* textual description of the verb */
106 * Description of the plugins of type 1
108 struct AFB_plugin_desc_v1
110 const char *info; /* textual information about the plugin */
111 const char *prefix; /* required prefix name for the plugin */
112 const struct AFB_verb_desc_v1 *verbs; /* array of descriptions of verbs terminated by a NULL name */
116 * Description of a plugin
120 enum AFB_plugin_version type; /* type of the plugin */
122 struct AFB_plugin_desc_v1 v1; /* description of the plugin of type 1 */
130 AFB_MODE_LOCAL = 0, /* run locally */
131 AFB_MODE_REMOTE, /* run remotely */
132 AFB_MODE_GLOBAL /* run either remotely or locally (DONT USE! reserved for future) */
135 /* declaration of features of libsystemd */
140 * Definition of the facilities provided by the daemon.
142 struct afb_daemon_itf {
143 void (*event_broadcast)(void *closure, const char *name, struct json_object *object); /* broadcasts evant 'name' with 'object' */
144 struct sd_event *(*get_event_loop)(void *closure); /* gets the common systemd's event loop */
145 struct sd_bus *(*get_user_bus)(void *closure); /* gets the common systemd's user d-bus */
146 struct sd_bus *(*get_system_bus)(void *closure); /* gets the common systemd's system d-bus */
147 void (*vverbose)(void*closure, int level, const char *file, int line, const char *fmt, va_list args);
151 * Structure for accessing daemon.
152 * See also: afb_daemon_get_event_sender, afb_daemon_get_event_loop, afb_daemon_get_user_bus, afb_daemon_get_system_bus
155 const struct afb_daemon_itf *itf; /* the interfacing functions */
156 void *closure; /* the closure when calling these functions */
160 * Interface between the daemon and the plugin.
164 struct afb_daemon daemon; /* access to the daemon facilies */
165 int verbosity; /* level of verbosity */
166 enum AFB_Mode mode; /* run mode (local or remote) */
170 * Function for registering the plugin
172 extern const struct AFB_plugin *pluginAfbV1Register (const struct AFB_interface *interface);
175 * Retrieves the common systemd's event loop of AFB
176 * 'daemon' MUST be the daemon given in interface when activating the plugin.
178 static inline struct sd_event *afb_daemon_get_event_loop(struct afb_daemon daemon)
180 return daemon.itf->get_event_loop(daemon.closure);
184 * Retrieves the common systemd's user/session d-bus of AFB
185 * 'daemon' MUST be the daemon given in interface when activating the plugin.
187 static inline struct sd_bus *afb_daemon_get_user_bus(struct afb_daemon daemon)
189 return daemon.itf->get_user_bus(daemon.closure);
193 * Retrieves the common systemd's system d-bus of AFB
194 * 'daemon' MUST be the daemon given in interface when activating the plugin.
196 static inline struct sd_bus *afb_daemon_get_system_bus(struct afb_daemon daemon)
198 return daemon.itf->get_system_bus(daemon.closure);
202 * Broadcasts widely the event of 'name' with the data 'object'.
203 * 'object' can be NULL.
204 * 'daemon' MUST be the daemon given in interface when activating the plugin.
206 * For conveniency, the function calls 'json_object_put' for 'object'.
207 * Thus, in the case where 'object' should remain available after
208 * the function returns, the function 'json_object_get' shall be used.
210 static inline void afb_daemon_broadcast_event(struct afb_daemon daemon, const char *name, struct json_object *object)
212 return daemon.itf->event_broadcast(daemon.closure, name, object);
216 * Send a message described by 'fmt' and following parameters
217 * to the journal for the verbosity 'level'.
218 * 'file' and 'line' are indicators of position of the code in source files.
219 * 'daemon' MUST be the daemon given in interface when activating the plugin.
221 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)));
222 static inline void afb_daemon_verbose(struct afb_daemon daemon, int level, const char *file, int line, const char *fmt, ...)
226 return daemon.itf->vverbose(daemon.closure, level, file, line, fmt, args);
231 * Macros for logging messages
233 #if !defined(NO_PLUGIN_VERBOSE_MACRO)
234 # if !defined(NO_PLUGIN_FILE_LINE_INDICATION)
235 # define ERROR(itf,...) do{if(itf->verbosity>=0)afb_daemon_verbose(itf->daemon,3,__FILE__,__LINE__,__VA_ARGS__);}while(0)
236 # define WARNING(itf,...) do{if(itf->verbosity>=1)afb_daemon_verbose(itf->daemon,4,__FILE__,__LINE__,__VA_ARGS__);}while(0)
237 # define NOTICE(itf,...) do{if(itf->verbosity>=1)afb_daemon_verbose(itf->daemon,5,__FILE__,__LINE__,__VA_ARGS__);}while(0)
238 # define INFO(itf,...) do{if(itf->verbosity>=2)afb_daemon_verbose(itf->daemon,6,__FILE__,__LINE__,__VA_ARGS__);}while(0)
239 # define DEBUG(itf,...) do{if(itf->verbosity>=3)afb_daemon_verbose(itf->daemon,7,__FILE__,__LINE__,__VA_ARGS__);}while(0)
241 # define ERROR(itf,...) do{if(itf->verbosity>=0)afb_daemon_verbose(itf->daemon,3,NULL,0,__VA_ARGS__);}while(0)
242 # define WARNING(itf,...) do{if(itf->verbosity>=1)afb_daemon_verbose(itf->daemon,4,NULL,0,__VA_ARGS__);}while(0)
243 # define NOTICE(itf,...) do{if(itf->verbosity>=1)afb_daemon_verbose(itf->daemon,5,NULL,0,__VA_ARGS__);}while(0)
244 # define INFO(itf,...) do{if(itf->verbosity>=2)afb_daemon_verbose(itf->daemon,6,NULL,0,__VA_ARGS__);}while(0)
245 # define DEBUG(itf,...) do{if(itf->verbosity>=3)afb_daemon_verbose(itf->daemon,7,NULL,0,__VA_ARGS__);}while(0)