From 248ba86f06b1903fff3e0538d7b06c02610b4806 Mon Sep 17 00:00:00 2001 From: José Bollo Date: Fri, 19 May 2017 10:42:21 +0200 Subject: Bindings V2: Refactor session flags MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: Idb104b3db69d785b11446fe9b66084839290362f Signed-off-by: José Bollo --- include/afb/afb-binding-v1.h | 59 +++++++++++++++++++++++++++++++++++++++- include/afb/afb-binding-v2.h | 34 ++++++++++++++++++++++- include/afb/afb-binding.h | 23 ++-------------- include/afb/afb-session-v1.h | 59 ++++++++++++++++++++++++++++++++++++++++ include/afb/afb-session-v2.h | 38 ++++++++++++++++++++++++++ include/afb/afb-session.h | 65 -------------------------------------------- 6 files changed, 190 insertions(+), 88 deletions(-) create mode 100644 include/afb/afb-session-v1.h create mode 100644 include/afb/afb-session-v2.h delete mode 100644 include/afb/afb-session.h (limited to 'include/afb') diff --git a/include/afb/afb-binding-v1.h b/include/afb/afb-binding-v1.h index dc7af6f5..d9b33f1c 100644 --- a/include/afb/afb-binding-v1.h +++ b/include/afb/afb-binding-v1.h @@ -17,6 +17,8 @@ #pragma once +#include "afb-session-v1.h" + struct json_object; struct afb_service; struct afb_binding_v1; @@ -79,7 +81,7 @@ extern void afbBindingV1ServiceEvent(const char *event, struct json_object *obje struct afb_verb_desc_v1 { const char *name; /* name of the verb */ - enum afb_session_flags session; /* authorisation and session requirements of the verb */ + enum afb_session_flags_v1 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 */ }; @@ -153,3 +155,58 @@ struct afb_binding_interface_v1 #endif +/***************************************************************************************************/ + +#if AFB_BINDING_VERSION == 1 + +# define afb_binding afb_binding_v1 +# define afb_binding_interface afb_binding_interface_v1 + +# define AFB_SESSION_NONE AFB_SESSION_NONE_V1 +# define AFB_SESSION_CREATE AFB_SESSION_CREATE_V1 +# define AFB_SESSION_CLOSE AFB_SESSION_CLOSE_V1 +# define AFB_SESSION_RENEW AFB_SESSION_RENEW_V1 +# define AFB_SESSION_CHECK AFB_SESSION_CHECK_V1 + +# define AFB_SESSION_LOA_GE AFB_SESSION_LOA_GE_V1 +# define AFB_SESSION_LOA_LE AFB_SESSION_LOA_LE_V1 +# define AFB_SESSION_LOA_EQ AFB_SESSION_LOA_EQ_V1 + +# define AFB_SESSION_LOA_SHIFT AFB_SESSION_LOA_SHIFT_V1 +# define AFB_SESSION_LOA_MASK AFB_SESSION_LOA_MASK_V1 + +# define AFB_SESSION_LOA_0 AFB_SESSION_LOA_0_V1 +# define AFB_SESSION_LOA_1 AFB_SESSION_LOA_1_V1 +# define AFB_SESSION_LOA_2 AFB_SESSION_LOA_2_V1 +# define AFB_SESSION_LOA_3 AFB_SESSION_LOA_3_V1 +# define AFB_SESSION_LOA_4 AFB_SESSION_LOA_4_V1 + +# define AFB_SESSION_LOA_LE_0 AFB_SESSION_LOA_LE_0_V1 +# define AFB_SESSION_LOA_LE_1 AFB_SESSION_LOA_LE_1_V1 +# define AFB_SESSION_LOA_LE_2 AFB_SESSION_LOA_LE_2_V1 +# define AFB_SESSION_LOA_LE_3 AFB_SESSION_LOA_LE_3_V1 + +# define AFB_SESSION_LOA_EQ_0 AFB_SESSION_LOA_EQ_0_V1 +# define AFB_SESSION_LOA_EQ_1 AFB_SESSION_LOA_EQ_1_V1 +# define AFB_SESSION_LOA_EQ_2 AFB_SESSION_LOA_EQ_2_V1 +# define AFB_SESSION_LOA_EQ_3 AFB_SESSION_LOA_EQ_3_V1 + +# define AFB_SESSION_LOA_GE_0 AFB_SESSION_LOA_GE_0_V1 +# define AFB_SESSION_LOA_GE_1 AFB_SESSION_LOA_GE_1_V1 +# define AFB_SESSION_LOA_GE_2 AFB_SESSION_LOA_GE_2_V1 +# define AFB_SESSION_LOA_GE_3 AFB_SESSION_LOA_GE_3_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 + + + diff --git a/include/afb/afb-binding-v2.h b/include/afb/afb-binding-v2.h index 19bff05a..d869dc6e 100644 --- a/include/afb/afb-binding-v2.h +++ b/include/afb/afb-binding-v2.h @@ -19,6 +19,8 @@ #include +#include "afb-session-v2.h" + struct afb_service; struct afb_daemon; struct afb_binding_v2; @@ -43,7 +45,7 @@ struct afb_verb_v2 { const char *verb; /* name of the verb */ void (*callback)(struct afb_req req); /* callback function implementing the verb */ - const struct afb_auth *auth; /* required authorisation */ + const struct afb_auth *auth; /* required authorisation */ uint32_t session; /* authorisation and session requirements of the verb */ }; @@ -78,3 +80,33 @@ struct afb_binding_v2 # define AFB_DEBUG_V2(daemon,...) do{if(afbBindingV2verbosity>=3)afb_daemon_verbose(daemon,7,NULL,0,__VA_ARGS__);}while(0) # endif #endif + +#if AFB_BINDING_VERSION == 2 + +# define afb_binding afb_binding_v2 +# define afb_binding_interface afb_binding_interface_v2 + +# define AFB_SESSION_NONE AFB_SESSION_NONE_V2 +# define AFB_SESSION_CLOSE AFB_SESSION_CLOSE_V2 +# define AFB_SESSION_RENEW AFB_SESSION_REFRESH_V2 +# define AFB_SESSION_REFRESH AFB_SESSION_REFRESH_V2 +# define AFB_SESSION_CHECK AFB_SESSION_CHECK_V2 + +# define AFB_SESSION_LOA_MASK AFB_SESSION_LOA_MASK_V2 + +# define AFB_SESSION_LOA_0 AFB_SESSION_LOA_0_V2 +# define AFB_SESSION_LOA_1 AFB_SESSION_LOA_1_V2 +# define AFB_SESSION_LOA_2 AFB_SESSION_LOA_2_V2 +# define AFB_SESSION_LOA_3 AFB_SESSION_LOA_3_V2 + +# if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_MACRO) + +# define ERROR AFB_ERROR_V2 +# define WARNING AFB_WARNING_V2 +# define NOTICE AFB_NOTICE_V2 +# define INFO AFB_INFO_V2 +# define DEBUG AFB_DEBUG_V2 + +# endif + +#endif diff --git a/include/afb/afb-binding.h b/include/afb/afb-binding.h index c78a79d4..5a6f9bc4 100644 --- a/include/afb/afb-binding.h +++ b/include/afb/afb-binding.h @@ -32,24 +32,18 @@ * */ -#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 +#ifndef AFB_BINDING_VERSION +#define AFB_BINDING_VERSION AFB_BINDING_DEFAULT_VERSION #endif /* * Some function of the library are exported to afb-daemon. */ -#include "afb-session.h" #include "afb-auth.h" #include "afb-req-itf.h" #include "afb-event-itf.h" @@ -58,16 +52,3 @@ #include "afb-binding-v1.h" #include "afb-binding-v2.h" -#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 - - diff --git a/include/afb/afb-session-v1.h b/include/afb/afb-session-v1.h new file mode 100644 index 00000000..c287765d --- /dev/null +++ b/include/afb/afb-session-v1.h @@ -0,0 +1,59 @@ +/* + * 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. + */ + +#pragma once + +/* + * Enum for Session/Token/Assurance middleware. + */ +enum afb_session_flags_v1 +{ + AFB_SESSION_NONE_V1 = 0, /* nothing required */ + AFB_SESSION_CREATE_V1 = 1, /* Obsolete */ + AFB_SESSION_CLOSE_V1 = 2, /* After token authentification, closes the session at end */ + AFB_SESSION_RENEW_V1 = 4, /* After token authentification, refreshes the token at end */ + AFB_SESSION_CHECK_V1 = 8, /* Requires token authentification */ + + AFB_SESSION_LOA_GE_V1 = 16, /* check that the LOA is greater or equal to the given value */ + AFB_SESSION_LOA_LE_V1 = 32, /* check that the LOA is lesser or equal to the given value */ + AFB_SESSION_LOA_EQ_V1 = 48, /* check that the LOA is equal to the given value */ + + AFB_SESSION_LOA_SHIFT_V1 = 6, /* shift for LOA */ + AFB_SESSION_LOA_MASK_V1 = 7, /* mask for LOA */ + + AFB_SESSION_LOA_0_V1 = 0, /* value for LOA of 0 */ + AFB_SESSION_LOA_1_V1 = 64, /* value for LOA of 1 */ + AFB_SESSION_LOA_2_V1 = 128, /* value for LOA of 2 */ + AFB_SESSION_LOA_3_V1 = 192, /* value for LOA of 3 */ + AFB_SESSION_LOA_4_V1 = 256, /* value for LOA of 4 */ + + AFB_SESSION_LOA_LE_0_V1 = AFB_SESSION_LOA_LE_V1 | AFB_SESSION_LOA_0_V1, /* check LOA <= 0 */ + AFB_SESSION_LOA_LE_1_V1 = AFB_SESSION_LOA_LE_V1 | AFB_SESSION_LOA_1_V1, /* check LOA <= 1 */ + AFB_SESSION_LOA_LE_2_V1 = AFB_SESSION_LOA_LE_V1 | AFB_SESSION_LOA_2_V1, /* check LOA <= 2 */ + AFB_SESSION_LOA_LE_3_V1 = AFB_SESSION_LOA_LE_V1 | AFB_SESSION_LOA_3_V1, /* check LOA <= 3 */ + + AFB_SESSION_LOA_EQ_0_V1 = AFB_SESSION_LOA_EQ_V1 | AFB_SESSION_LOA_0_V1, /* check LOA == 0 */ + AFB_SESSION_LOA_EQ_1_V1 = AFB_SESSION_LOA_EQ_V1 | AFB_SESSION_LOA_1_V1, /* check LOA == 1 */ + AFB_SESSION_LOA_EQ_2_V1 = AFB_SESSION_LOA_EQ_V1 | AFB_SESSION_LOA_2_V1, /* check LOA == 2 */ + AFB_SESSION_LOA_EQ_3_V1 = AFB_SESSION_LOA_EQ_V1 | AFB_SESSION_LOA_3_V1, /* check LOA == 3 */ + + AFB_SESSION_LOA_GE_0_V1 = AFB_SESSION_LOA_GE_V1 | AFB_SESSION_LOA_0_V1, /* check LOA >= 0 */ + AFB_SESSION_LOA_GE_1_V1 = AFB_SESSION_LOA_GE_V1 | AFB_SESSION_LOA_1_V1, /* check LOA >= 1 */ + AFB_SESSION_LOA_GE_2_V1 = AFB_SESSION_LOA_GE_V1 | AFB_SESSION_LOA_2_V1, /* check LOA >= 2 */ + AFB_SESSION_LOA_GE_3_V1 = AFB_SESSION_LOA_GE_V1 | AFB_SESSION_LOA_3_V1 /* check LOA >= 3 */ +}; + diff --git a/include/afb/afb-session-v2.h b/include/afb/afb-session-v2.h new file mode 100644 index 00000000..eb8bc664 --- /dev/null +++ b/include/afb/afb-session-v2.h @@ -0,0 +1,38 @@ +/* + * 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. + */ + +#pragma once + +/* + * Enum for Session/Token/Assurance middleware. + */ +enum afb_session_flags_v2 +{ + AFB_SESSION_LOA_MASK_V2 = 3, /* mask for LOA */ + + AFB_SESSION_LOA_0_V2 = 0, /* value for LOA of 0 */ + AFB_SESSION_LOA_1_V2 = 1, /* value for LOA of 1 */ + AFB_SESSION_LOA_2_V2 = 2, /* value for LOA of 2 */ + AFB_SESSION_LOA_3_V2 = 3, /* value for LOA of 3 */ + + AFB_SESSION_CHECK_V2 = 4, /* Requires token authentification */ + AFB_SESSION_REFRESH_V2 = 8, /* After token authentification, refreshes the token at end */ + AFB_SESSION_CLOSE_V2 = 16, /* After token authentification, closes the session at end */ + + AFB_SESSION_NONE_V2 = 0 /* nothing required */ +}; + diff --git a/include/afb/afb-session.h b/include/afb/afb-session.h deleted file mode 100644 index fe8edc1a..00000000 --- a/include/afb/afb-session.h +++ /dev/null @@ -1,65 +0,0 @@ -/* - * 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. - */ - -#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 */ -}; - -- cgit 1.2.3-korg