diff options
Diffstat (limited to 'include')
| -rw-r--r-- | include/afb/afb-binding-v1.h | 93 | ||||
| -rw-r--r-- | include/afb/afb-binding-v2.h | 38 | ||||
| -rw-r--r-- | include/afb/afb-binding.h | 191 | ||||
| -rw-r--r-- | include/afb/afb-daemon-itf.h | 152 | ||||
| -rw-r--r-- | include/afb/afb-session.h | 65 |
5 files changed, 319 insertions, 220 deletions
diff --git a/include/afb/afb-binding-v1.h b/include/afb/afb-binding-v1.h index 6281dd8a..dc7af6f5 100644 --- a/include/afb/afb-binding-v1.h +++ b/include/afb/afb-binding-v1.h @@ -17,9 +17,10 @@ #pragma once -struct afb_binding_interface; struct json_object; struct afb_service; +struct afb_binding_v1; +struct afb_binding_interface_v1; /* * Function for registering the binding @@ -44,7 +45,7 @@ struct afb_service; * the function 'afbBindingV1ServiceInit' is called, the 'interface' * is fully functionnal. */ -extern const struct afb_binding *afbBindingV1Register (const struct afb_binding_interface *interface); +extern const struct afb_binding_v1 *afbBindingV1Register (const struct afb_binding_interface_v1 *interface); /* * When a binding have an exported implementation of the @@ -72,54 +73,13 @@ extern void afbBindingV1ServiceEvent(const char *event, struct json_object *obje /* - * Enum for Session/Token/Assurance middleware. - * This enumeration is valid for bindings of type 1 - */ -enum afb_session_v1 -{ - AFB_SESSION_NONE = 0, /* nothing required */ - AFB_SESSION_CREATE = 1, /* Obsolete */ - AFB_SESSION_CLOSE = 2, /* After token authentification, closes the session at end */ - AFB_SESSION_RENEW = 4, /* After token authentification, refreshes the token at end */ - AFB_SESSION_CHECK = 8, /* Requires token authentification */ - - AFB_SESSION_LOA_GE = 16, /* check that the LOA is greater or equal to the given value */ - AFB_SESSION_LOA_LE = 32, /* check that the LOA is lesser or equal to the given value */ - AFB_SESSION_LOA_EQ = 48, /* check that the LOA is equal to the given value */ - - AFB_SESSION_LOA_SHIFT = 6, /* shift for LOA */ - AFB_SESSION_LOA_MASK = 7, /* mask for LOA */ - - AFB_SESSION_LOA_0 = 0, /* value for LOA of 0 */ - AFB_SESSION_LOA_1 = 64, /* value for LOA of 1 */ - AFB_SESSION_LOA_2 = 128, /* value for LOA of 2 */ - AFB_SESSION_LOA_3 = 192, /* value for LOA of 3 */ - AFB_SESSION_LOA_4 = 256, /* value for LOA of 4 */ - - AFB_SESSION_LOA_LE_0 = AFB_SESSION_LOA_LE | AFB_SESSION_LOA_0, /* check LOA <= 0 */ - AFB_SESSION_LOA_LE_1 = AFB_SESSION_LOA_LE | AFB_SESSION_LOA_1, /* check LOA <= 1 */ - AFB_SESSION_LOA_LE_2 = AFB_SESSION_LOA_LE | AFB_SESSION_LOA_2, /* check LOA <= 2 */ - AFB_SESSION_LOA_LE_3 = AFB_SESSION_LOA_LE | AFB_SESSION_LOA_3, /* check LOA <= 3 */ - - AFB_SESSION_LOA_GE_0 = AFB_SESSION_LOA_GE | AFB_SESSION_LOA_0, /* check LOA >= 0 */ - AFB_SESSION_LOA_GE_1 = AFB_SESSION_LOA_GE | AFB_SESSION_LOA_1, /* check LOA >= 1 */ - AFB_SESSION_LOA_GE_2 = AFB_SESSION_LOA_GE | AFB_SESSION_LOA_2, /* check LOA >= 2 */ - AFB_SESSION_LOA_GE_3 = AFB_SESSION_LOA_GE | AFB_SESSION_LOA_3, /* check LOA >= 3 */ - - AFB_SESSION_LOA_EQ_0 = AFB_SESSION_LOA_EQ | AFB_SESSION_LOA_0, /* check LOA == 0 */ - AFB_SESSION_LOA_EQ_1 = AFB_SESSION_LOA_EQ | AFB_SESSION_LOA_1, /* check LOA == 1 */ - AFB_SESSION_LOA_EQ_2 = AFB_SESSION_LOA_EQ | AFB_SESSION_LOA_2, /* check LOA == 2 */ - AFB_SESSION_LOA_EQ_3 = AFB_SESSION_LOA_EQ | AFB_SESSION_LOA_3 /* check LOA == 3 */ -}; - -/* * Description of one verb of the API provided by the binding * This enumeration is valid for bindings of type version 1 */ struct afb_verb_desc_v1 { const char *name; /* name of the verb */ - enum afb_session_v1 session; /* authorisation and session requirements of the verb */ + enum afb_session_flags session; /* authorisation and session requirements of the verb */ void (*callback)(struct afb_req req); /* callback function implementing the verb */ const char *info; /* textual description of the verb */ }; @@ -138,7 +98,7 @@ struct afb_binding_desc_v1 * Definition of the type+versions of the binding. * The definition uses hashes. */ -enum afb_binding_type +enum afb_binding_type_v1 { AFB_BINDING_VERSION_1 = 123456789 }; @@ -146,11 +106,50 @@ enum afb_binding_type /* * Description of a binding */ -struct afb_binding +struct afb_binding_v1 { - enum afb_binding_type type; /* type of the binding */ + enum afb_binding_type_v1 type; /* type of the binding */ union { struct afb_binding_desc_v1 v1; /* description of the binding of type 1 */ }; }; +/* + * config mode + */ +enum afb_mode_v1 { + AFB_MODE_LOCAL = 0, /* run locally */ + AFB_MODE_REMOTE, /* run remotely */ + AFB_MODE_GLOBAL /* run either remotely or locally (DONT USE! reserved for future) */ +}; + +/* + * Interface between the daemon and the binding. + */ +struct afb_binding_interface_v1 +{ + struct afb_daemon daemon; /* access to the daemon facilies */ + int verbosity; /* level of verbosity */ + enum afb_mode_v1 mode; /* run mode (local or remote) */ +}; + +/* + * Macros for logging messages + */ +#if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_MACRO) +# if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_DETAILS) +# define AFB_ERROR_V1(itf,...) do{if(itf->verbosity>=0)afb_daemon_verbose(itf->daemon,3,__FILE__,__LINE__,__VA_ARGS__);}while(0) +# define AFB_WARNING_V1(itf,...) do{if(itf->verbosity>=1)afb_daemon_verbose(itf->daemon,4,__FILE__,__LINE__,__VA_ARGS__);}while(0) +# define AFB_NOTICE_V1(itf,...) do{if(itf->verbosity>=1)afb_daemon_verbose(itf->daemon,5,__FILE__,__LINE__,__VA_ARGS__);}while(0) +# define AFB_INFO_V1(itf,...) do{if(itf->verbosity>=2)afb_daemon_verbose(itf->daemon,6,__FILE__,__LINE__,__VA_ARGS__);}while(0) +# define AFB_DEBUG_V1(itf,...) do{if(itf->verbosity>=3)afb_daemon_verbose(itf->daemon,7,__FILE__,__LINE__,__VA_ARGS__);}while(0) +# else +# define AFB_ERROR_V1(itf,...) do{if(itf->verbosity>=0)afb_daemon_verbose(itf->daemon,3,NULL,0,__VA_ARGS__);}while(0) +# define AFB_WARNING_V1(itf,...) do{if(itf->verbosity>=1)afb_daemon_verbose(itf->daemon,4,NULL,0,__VA_ARGS__);}while(0) +# define AFB_NOTICE_V1(itf,...) do{if(itf->verbosity>=1)afb_daemon_verbose(itf->daemon,5,NULL,0,__VA_ARGS__);}while(0) +# define AFB_INFO_V1(itf,...) do{if(itf->verbosity>=2)afb_daemon_verbose(itf->daemon,6,NULL,0,__VA_ARGS__);}while(0) +# define AFB_DEBUG_V1(itf,...) do{if(itf->verbosity>=3)afb_daemon_verbose(itf->daemon,7,NULL,0,__VA_ARGS__);}while(0) +# endif +#endif + + diff --git a/include/afb/afb-binding-v2.h b/include/afb/afb-binding-v2.h index 97956411..17adb02e 100644 --- a/include/afb/afb-binding-v2.h +++ b/include/afb/afb-binding-v2.h @@ -17,17 +17,23 @@ #pragma once -struct afb_binding_interface; +#include <stdint.h> + struct afb_service; +struct afb_daemon; +struct afb_binding_v2; + struct json_object; /* - * A binding V2 MUST have an exported symbol of name + * A binding V2 MUST have two exported symbols of name: * - * afbBindingV2 + * - afbBindingV2 + * - afbBindingV2verbosity * */ extern const struct afb_binding_v2 afbBindingV2; +extern int afbBindingV2verbosity; /* * Description of one verb of the API provided by the binding @@ -38,7 +44,7 @@ struct afb_verb_v2 const char *verb; /* name of the verb */ void (*callback)(struct afb_req req); /* callback function implementing the verb */ const char * permissions; /* required permissions */ - enum afb_session_v1 session; /* authorisation and session requirements of the verb */ + uint32_t session; /* authorisation and session requirements of the verb */ }; /* @@ -49,8 +55,26 @@ struct afb_binding_v2 const char *api; /* api name for the binding */ const char *specification; /* textual specification of the binding */ const struct afb_verb_v2 *verbs; /* array of descriptions of verbs terminated by a NULL name */ - int (*init)(const struct afb_binding_interface *interface); - int (*start)(const struct afb_binding_interface *interface, struct afb_service service); - void (*onevent)(const char *event, struct json_object *object); + int (*init)(struct afb_daemon daemon); + int (*start)(struct afb_service service); + void (*onevent)(struct afb_service service, const char *event, struct json_object *object); }; +/* + * Macros for logging messages + */ +#if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_MACRO) +# if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_DETAILS) +# define AFB_ERROR_V2(daemon,...) do{if(afbBindingV2verbosity>=0)afb_daemon_verbose(daemon,3,__FILE__,__LINE__,__VA_ARGS__);}while(0) +# define AFB_WARNING_V2(daemon,...) do{if(afbBindingV2verbosity>=1)afb_daemon_verbose(daemon,4,__FILE__,__LINE__,__VA_ARGS__);}while(0) +# define AFB_NOTICE_V2(daemon,...) do{if(afbBindingV2verbosity>=1)afb_daemon_verbose(daemon,5,__FILE__,__LINE__,__VA_ARGS__);}while(0) +# define AFB_INFO_V2(daemon,...) do{if(afbBindingV2verbosity>=2)afb_daemon_verbose(daemon,6,__FILE__,__LINE__,__VA_ARGS__);}while(0) +# define AFB_DEBUG_V2(daemon,...) do{if(afbBindingV2verbosity>=3)afb_daemon_verbose(daemon,7,__FILE__,__LINE__,__VA_ARGS__);}while(0) +# else +# define AFB_ERROR_V2(daemon,...) do{if(afbBindingV2verbosity>=0)afb_daemon_verbose(daemon,3,NULL,0,__VA_ARGS__);}while(0) +# define AFB_WARNING_V2(daemon,...) do{if(afbBindingV2verbosity>=1)afb_daemon_verbose(daemon,4,NULL,0,__VA_ARGS__);}while(0) +# define AFB_NOTICE_V2(daemon,...) do{if(afbBindingV2verbosity>=1)afb_daemon_verbose(daemon,5,NULL,0,__VA_ARGS__);}while(0) +# define AFB_INFO_V2(daemon,...) do{if(afbBindingV2verbosity>=2)afb_daemon_verbose(daemon,6,NULL,0,__VA_ARGS__);}while(0) +# define AFB_DEBUG_V2(daemon,...) do{if(afbBindingV2verbosity>=3)afb_daemon_verbose(daemon,7,NULL,0,__VA_ARGS__);}while(0) +# endif +#endif diff --git a/include/afb/afb-binding.h b/include/afb/afb-binding.h index 9c845153..cea1b552 100644 --- a/include/afb/afb-binding.h +++ b/include/afb/afb-binding.h @@ -32,182 +32,41 @@ * */ +#define AFB_BINDING_PRAGMA_KEEP_OBSOLETE_V1 +#define AFB_BINDING_PRAGMA_KEEP_OBSOLETE_V2 +#define AFB_BINDING_PRAGMA_DECLARE_V1 +#define AFB_BINDING_PRAGMA_DECLARE_V2 + +#define AFB_BINDING_LOWER_VERSION 1 +#define AFB_BINDING_UPPER_VERSION 2 +#define AFB_BINDING_DEFAULT_VERSION 1 + +#ifndef AFB_BINDING_CURRENT_VERSION +#define AFB_BINDING_CURRENT_VERSION AFB_BINDING_DEFAULT_VERSION +#endif + /* * Some function of the library are exported to afb-daemon. */ +#include "afb-session.h" #include "afb-event-itf.h" #include "afb-req-itf.h" #include "afb-service-itf.h" +#include "afb-daemon-itf.h" #include "afb-binding-v1.h" #include "afb-binding-v2.h" -/* - * config mode - */ -enum afb_mode { - AFB_MODE_LOCAL = 0, /* run locally */ - AFB_MODE_REMOTE, /* run remotely */ - AFB_MODE_GLOBAL /* run either remotely or locally (DONT USE! reserved for future) */ -}; - -/* declaration of features of libsystemd */ -struct sd_event; -struct sd_bus; - -/* - * Definition of the facilities provided by the daemon. - */ -struct afb_daemon_itf { - int (*event_broadcast)(void *closure, const char *name, struct json_object *object); /* broadcasts evant 'name' with 'object' */ - struct sd_event *(*get_event_loop)(void *closure); /* gets the common systemd's event loop */ - struct sd_bus *(*get_user_bus)(void *closure); /* gets the common systemd's user d-bus */ - struct sd_bus *(*get_system_bus)(void *closure); /* gets the common systemd's system d-bus */ - void (*vverbose)(void*closure, int level, const char *file, int line, const char *fmt, va_list args); - struct afb_event (*event_make)(void *closure, const char *name); /* creates an event of 'name' */ - int (*rootdir_get_fd)(void *closure); - int (*rootdir_open_locale)(void *closure, const char *filename, int flags, const char *locale); - int (*queue_job)(void *closure, void (*callback)(int signum, void *arg), void *argument, void *group, int timeout); -}; - -/* - * Structure for accessing daemon. - * See also: afb_daemon_get_event_sender, afb_daemon_get_event_loop, afb_daemon_get_user_bus, afb_daemon_get_system_bus - */ -struct afb_daemon { - const struct afb_daemon_itf *itf; /* the interfacing functions */ - void *closure; /* the closure when calling these functions */ -}; - -/* - * Interface between the daemon and the binding. - */ -struct afb_binding_interface -{ - struct afb_daemon daemon; /* access to the daemon facilies */ - int verbosity; /* level of verbosity */ - enum afb_mode mode; /* run mode (local or remote) */ -}; - -/* - * Retrieves the common systemd's event loop of AFB - * 'daemon' MUST be the daemon given in interface when activating the binding. - */ -static inline struct sd_event *afb_daemon_get_event_loop(struct afb_daemon daemon) -{ - return daemon.itf->get_event_loop(daemon.closure); -} - -/* - * Retrieves the common systemd's user/session d-bus of AFB - * 'daemon' MUST be the daemon given in interface when activating the binding. - */ -static inline struct sd_bus *afb_daemon_get_user_bus(struct afb_daemon daemon) -{ - return daemon.itf->get_user_bus(daemon.closure); -} - -/* - * Retrieves the common systemd's system d-bus of AFB - * 'daemon' MUST be the daemon given in interface when activating the binding. - */ -static inline struct sd_bus *afb_daemon_get_system_bus(struct afb_daemon daemon) -{ - return daemon.itf->get_system_bus(daemon.closure); -} - -/* - * Broadcasts widely the event of 'name' with the data 'object'. - * 'object' can be NULL. - * 'daemon' MUST be the daemon given in interface when activating the binding. - * - * For convenience, the function calls 'json_object_put' for 'object'. - * Thus, in the case where 'object' should remain available after - * the function returns, the function 'json_object_get' shall be used. - * - * Returns the count of clients that received the event. - */ -static inline int afb_daemon_broadcast_event(struct afb_daemon daemon, const char *name, struct json_object *object) -{ - return daemon.itf->event_broadcast(daemon.closure, name, object); -} - -/* - * Creates an event of 'name' and returns it. - * 'daemon' MUST be the daemon given in interface when activating the binding. - */ -static inline struct afb_event afb_daemon_make_event(struct afb_daemon daemon, const char *name) -{ - return daemon.itf->event_make(daemon.closure, name); -} - -/* - * Send a message described by 'fmt' and following parameters - * to the journal for the verbosity 'level'. - * 'file' and 'line' are indicators of position of the code in source files. - * 'daemon' MUST be the daemon given in interface when activating the binding. - */ -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))); -static inline void afb_daemon_verbose(struct afb_daemon daemon, int level, const char *file, int line, const char *fmt, ...) -{ - va_list args; - va_start(args, fmt); - daemon.itf->vverbose(daemon.closure, level, file, line, fmt, args); - va_end(args); -} - -/* - * Macros for logging messages - */ -#if !defined(NO_BINDING_VERBOSE_MACRO) -# if !defined(NO_BINDING_FILE_LINE_INDICATION) -# define ERROR(itf,...) do{if(itf->verbosity>=0)afb_daemon_verbose(itf->daemon,3,__FILE__,__LINE__,__VA_ARGS__);}while(0) -# define WARNING(itf,...) do{if(itf->verbosity>=1)afb_daemon_verbose(itf->daemon,4,__FILE__,__LINE__,__VA_ARGS__);}while(0) -# define NOTICE(itf,...) do{if(itf->verbosity>=1)afb_daemon_verbose(itf->daemon,5,__FILE__,__LINE__,__VA_ARGS__);}while(0) -# define INFO(itf,...) do{if(itf->verbosity>=2)afb_daemon_verbose(itf->daemon,6,__FILE__,__LINE__,__VA_ARGS__);}while(0) -# define DEBUG(itf,...) do{if(itf->verbosity>=3)afb_daemon_verbose(itf->daemon,7,__FILE__,__LINE__,__VA_ARGS__);}while(0) -# else -# define ERROR(itf,...) do{if(itf->verbosity>=0)afb_daemon_verbose(itf->daemon,3,NULL,0,__VA_ARGS__);}while(0) -# define WARNING(itf,...) do{if(itf->verbosity>=1)afb_daemon_verbose(itf->daemon,4,NULL,0,__VA_ARGS__);}while(0) -# define NOTICE(itf,...) do{if(itf->verbosity>=1)afb_daemon_verbose(itf->daemon,5,NULL,0,__VA_ARGS__);}while(0) -# define INFO(itf,...) do{if(itf->verbosity>=2)afb_daemon_verbose(itf->daemon,6,NULL,0,__VA_ARGS__);}while(0) -# define DEBUG(itf,...) do{if(itf->verbosity>=3)afb_daemon_verbose(itf->daemon,7,NULL,0,__VA_ARGS__);}while(0) -# endif +#if AFB_BINDING_CURRENT_VERSION == 1 +#define afb_binding afb_binding_v1 +#define afb_binding_interface afb_binding_interface_v1 +#if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_MACRO) +#define ERROR AFB_ERROR_V1 +#define WARNING AFB_WARNING_V1 +#define NOTICE AFB_NOTICE_V1 +#define INFO AFB_INFO_V1 +#define DEBUG AFB_DEBUG_V1 +#endif #endif -/* - * Get the root directory file descriptor. This file descriptor can - * be used with functions 'openat', 'fstatat', ... - */ -static inline int afb_daemon_rootdir_get_fd(struct afb_daemon daemon) -{ - return daemon.itf->rootdir_get_fd(daemon.closure); -} - -/* - * Opens 'filename' within the root directory with 'flags' (see function openat) - * using the 'locale' definition (example: "jp,en-US") that can be NULL. - * Returns the file descriptor or -1 in case of error. - */ -static inline int afb_daemon_rootdir_open_locale(struct afb_daemon daemon, const char *filename, int flags, const char *locale) -{ - return daemon.itf->rootdir_open_locale(daemon.closure, filename, flags, locale); -} -/* - * Queue the job defined by 'callback' and 'argument' for being executed asynchronously - * in this thread (later) or in an other thread. - * If 'group' is not NUL, the jobs queued with a same value (as the pointer value 'group') - * are executed in sequence in the order of there submission. - * If 'timeout' is not 0, it represent the maximum execution time for the job in seconds. - * At first, the job is called with 0 as signum and the given argument. - * The job is executed with the monitoring of its time and some signals like SIGSEGV and - * SIGFPE. When a such signal is catched, the job is terminated and reexecuted but with - * signum being the signal number (SIGALRM when timeout expired). - * - * Returns 0 in case of success or -1 in case of error. - */ -static inline int afb_daemon_queue_job(struct afb_daemon daemon, void (*callback)(int signum, void *arg), void *argument, void *group, int timeout) -{ - return daemon.itf->queue_job(daemon.closure, callback, argument, group, timeout); -} diff --git a/include/afb/afb-daemon-itf.h b/include/afb/afb-daemon-itf.h new file mode 100644 index 00000000..88ce27c9 --- /dev/null +++ b/include/afb/afb-daemon-itf.h @@ -0,0 +1,152 @@ +/* + * Copyright (C) 2016, 2017 "IoT.bzh" + * Author: José Bollo <jose.bollo@iot.bzh> + * + * 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. + */ + +#pragma once + +#include <stdarg.h> + +/* declaration of features of libsystemd */ +struct sd_event; +struct sd_bus; + +/* + * Definition of the facilities provided by the daemon. + */ +struct afb_daemon_itf { + int (*event_broadcast)(void *closure, const char *name, struct json_object *object); /* broadcasts evant 'name' with 'object' */ + struct sd_event *(*get_event_loop)(void *closure); /* gets the common systemd's event loop */ + struct sd_bus *(*get_user_bus)(void *closure); /* gets the common systemd's user d-bus */ + struct sd_bus *(*get_system_bus)(void *closure); /* gets the common systemd's system d-bus */ + void (*vverbose)(void*closure, int level, const char *file, int line, const char *fmt, va_list args); + struct afb_event (*event_make)(void *closure, const char *name); /* creates an event of 'name' */ + int (*rootdir_get_fd)(void *closure); + int (*rootdir_open_locale)(void *closure, const char *filename, int flags, const char *locale); + int (*queue_job)(void *closure, void (*callback)(int signum, void *arg), void *argument, void *group, int timeout); +}; + +/* + * Structure for accessing daemon. + * See also: afb_daemon_get_event_sender, afb_daemon_get_event_loop, afb_daemon_get_user_bus, afb_daemon_get_system_bus + */ +struct afb_daemon { + const struct afb_daemon_itf *itf; /* the interfacing functions */ + void *closure; /* the closure when calling these functions */ +}; + +/* + * Retrieves the common systemd's event loop of AFB + * 'daemon' MUST be the daemon given in interface when activating the binding. + */ +static inline struct sd_event *afb_daemon_get_event_loop(struct afb_daemon daemon) +{ + return daemon.itf->get_event_loop(daemon.closure); +} + +/* + * Retrieves the common systemd's user/session d-bus of AFB + * 'daemon' MUST be the daemon given in interface when activating the binding. + */ +static inline struct sd_bus *afb_daemon_get_user_bus(struct afb_daemon daemon) +{ + return daemon.itf->get_user_bus(daemon.closure); +} + +/* + * Retrieves the common systemd's system d-bus of AFB + * 'daemon' MUST be the daemon given in interface when activating the binding. + */ +static inline struct sd_bus *afb_daemon_get_system_bus(struct afb_daemon daemon) +{ + return daemon.itf->get_system_bus(daemon.closure); +} + +/* + * Broadcasts widely the event of 'name' with the data 'object'. + * 'object' can be NULL. + * 'daemon' MUST be the daemon given in interface when activating the binding. + * + * For convenience, the function calls 'json_object_put' for 'object'. + * Thus, in the case where 'object' should remain available after + * the function returns, the function 'json_object_get' shall be used. + * + * Returns the count of clients that received the event. + */ +static inline int afb_daemon_broadcast_event(struct afb_daemon daemon, const char *name, struct json_object *object) +{ + return daemon.itf->event_broadcast(daemon.closure, name, object); +} + +/* + * Creates an event of 'name' and returns it. + * 'daemon' MUST be the daemon given in interface when activating the binding. + */ +static inline struct afb_event afb_daemon_make_event(struct afb_daemon daemon, const char *name) +{ + return daemon.itf->event_make(daemon.closure, name); +} + +/* + * Send a message described by 'fmt' and following parameters + * to the journal for the verbosity 'level'. + * 'file' and 'line' are indicators of position of the code in source files. + * 'daemon' MUST be the daemon given in interface when activating the binding. + */ +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))); +static inline void afb_daemon_verbose(struct afb_daemon daemon, int level, const char *file, int line, const char *fmt, ...) +{ + va_list args; + va_start(args, fmt); + daemon.itf->vverbose(daemon.closure, level, file, line, fmt, args); + va_end(args); +} + +/* + * Get the root directory file descriptor. This file descriptor can + * be used with functions 'openat', 'fstatat', ... + */ +static inline int afb_daemon_rootdir_get_fd(struct afb_daemon daemon) +{ + return daemon.itf->rootdir_get_fd(daemon.closure); +} + +/* + * Opens 'filename' within the root directory with 'flags' (see function openat) + * using the 'locale' definition (example: "jp,en-US") that can be NULL. + * Returns the file descriptor or -1 in case of error. + */ +static inline int afb_daemon_rootdir_open_locale(struct afb_daemon daemon, const char *filename, int flags, const char *locale) +{ + return daemon.itf->rootdir_open_locale(daemon.closure, filename, flags, locale); +} + +/* + * Queue the job defined by 'callback' and 'argument' for being executed asynchronously + * in this thread (later) or in an other thread. + * If 'group' is not NUL, the jobs queued with a same value (as the pointer value 'group') + * are executed in sequence in the order of there submission. + * If 'timeout' is not 0, it represent the maximum execution time for the job in seconds. + * At first, the job is called with 0 as signum and the given argument. + * The job is executed with the monitoring of its time and some signals like SIGSEGV and + * SIGFPE. When a such signal is catched, the job is terminated and reexecuted but with + * signum being the signal number (SIGALRM when timeout expired). + * + * Returns 0 in case of success or -1 in case of error. + */ +static inline int afb_daemon_queue_job(struct afb_daemon daemon, void (*callback)(int signum, void *arg), void *argument, void *group, int timeout) +{ + return daemon.itf->queue_job(daemon.closure, callback, argument, group, timeout); +} diff --git a/include/afb/afb-session.h b/include/afb/afb-session.h new file mode 100644 index 00000000..fe8edc1a --- /dev/null +++ b/include/afb/afb-session.h @@ -0,0 +1,65 @@ +/* + * Copyright (C) 2016, 2017 "IoT.bzh" + * Author: José Bollo <jose.bollo@iot.bzh> + * + * 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. + */ + +#pragma once + +/* + * Enum for Session/Token/Assurance middleware. + */ +enum afb_session_flags +{ + AFB_SESSION_NONE = 0, /* nothing required */ +#if defined(AFB_BINDING_PRAGMA_DECLARE_V1) && defined(AFB_BINDING_PRAGMA_KEEP_OBSOLETE_V1) + AFB_SESSION_CREATE = 1, /* Obsolete */ +#endif + AFB_SESSION_CLOSE = 2, /* After token authentification, closes the session at end */ + AFB_SESSION_RENEW = 4, /* After token authentification, refreshes the token at end */ + AFB_SESSION_CHECK = 8, /* Requires token authentification */ + + AFB_SESSION_LOA_GE = 16, /* check that the LOA is greater or equal to the given value */ +#if defined(AFB_BINDING_PRAGMA_DECLARE_V1) || defined(AFB_BINDING_PRAGMA_KEEP_OBSOLETE_V2) + AFB_SESSION_LOA_LE = 32, /* check that the LOA is lesser or equal to the given value */ + AFB_SESSION_LOA_EQ = 48, /* check that the LOA is equal to the given value */ +#endif + + AFB_SESSION_LOA_SHIFT = 6, /* shift for LOA */ + AFB_SESSION_LOA_MASK = 7, /* mask for LOA */ + + AFB_SESSION_LOA_0 = 0, /* value for LOA of 0 */ + AFB_SESSION_LOA_1 = 64, /* value for LOA of 1 */ + AFB_SESSION_LOA_2 = 128, /* value for LOA of 2 */ + AFB_SESSION_LOA_3 = 192, /* value for LOA of 3 */ + AFB_SESSION_LOA_4 = 256, /* value for LOA of 4 */ + +#if defined(AFB_BINDING_PRAGMA_DECLARE_V1) || defined(AFB_BINDING_PRAGMA_KEEP_OBSOLETE_V2) + AFB_SESSION_LOA_LE_0 = AFB_SESSION_LOA_LE | AFB_SESSION_LOA_0, /* check LOA <= 0 */ + AFB_SESSION_LOA_LE_1 = AFB_SESSION_LOA_LE | AFB_SESSION_LOA_1, /* check LOA <= 1 */ + AFB_SESSION_LOA_LE_2 = AFB_SESSION_LOA_LE | AFB_SESSION_LOA_2, /* check LOA <= 2 */ + AFB_SESSION_LOA_LE_3 = AFB_SESSION_LOA_LE | AFB_SESSION_LOA_3, /* check LOA <= 3 */ + + AFB_SESSION_LOA_EQ_0 = AFB_SESSION_LOA_EQ | AFB_SESSION_LOA_0, /* check LOA == 0 */ + AFB_SESSION_LOA_EQ_1 = AFB_SESSION_LOA_EQ | AFB_SESSION_LOA_1, /* check LOA == 1 */ + AFB_SESSION_LOA_EQ_2 = AFB_SESSION_LOA_EQ | AFB_SESSION_LOA_2, /* check LOA == 2 */ + AFB_SESSION_LOA_EQ_3 = AFB_SESSION_LOA_EQ | AFB_SESSION_LOA_3, /* check LOA == 3 */ +#endif + + AFB_SESSION_LOA_GE_0 = AFB_SESSION_LOA_GE | AFB_SESSION_LOA_0, /* check LOA >= 0 */ + AFB_SESSION_LOA_GE_1 = AFB_SESSION_LOA_GE | AFB_SESSION_LOA_1, /* check LOA >= 1 */ + AFB_SESSION_LOA_GE_2 = AFB_SESSION_LOA_GE | AFB_SESSION_LOA_2, /* check LOA >= 2 */ + AFB_SESSION_LOA_GE_3 = AFB_SESSION_LOA_GE | AFB_SESSION_LOA_3 /* check LOA >= 3 */ +}; + |