include/afb/afb-session.h

   1 /*
   2  * Copyright (C) 2016, 2017 "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 /*
  21  * Enum for Session/Token/Assurance middleware.
  22  */
  23 enum afb_session_flags
  24 {
  25        AFB_SESSION_NONE = 0,   /* nothing required */
  26 #if defined(AFB_BINDING_PRAGMA_DECLARE_V1) && defined(AFB_BINDING_PRAGMA_KEEP_OBSOLETE_V1)
  27        AFB_SESSION_CREATE = 1, /* Obsolete */
  28 #endif
  29        AFB_SESSION_CLOSE = 2,  /* After token authentification, closes the session at end */
  30        AFB_SESSION_RENEW = 4,  /* After token authentification, refreshes the token at end */
  31        AFB_SESSION_CHECK = 8,  /* Requires token authentification */
  32
  33        AFB_SESSION_LOA_GE = 16, /* check that the LOA is greater or equal to the given value */
  34 #if defined(AFB_BINDING_PRAGMA_DECLARE_V1) || defined(AFB_BINDING_PRAGMA_KEEP_OBSOLETE_V2)
  35        AFB_SESSION_LOA_LE = 32, /* check that the LOA is lesser or equal to the given value */
  36        AFB_SESSION_LOA_EQ = 48, /* check that the LOA is equal to the given value */
  37 #endif
  38
  39        AFB_SESSION_LOA_SHIFT = 6, /* shift for LOA */
  40        AFB_SESSION_LOA_MASK = 7,  /* mask for LOA */
  41
  42        AFB_SESSION_LOA_0 = 0,   /* value for LOA of 0 */
  43        AFB_SESSION_LOA_1 = 64,  /* value for LOA of 1 */
  44        AFB_SESSION_LOA_2 = 128, /* value for LOA of 2 */
  45        AFB_SESSION_LOA_3 = 192, /* value for LOA of 3 */
  46        AFB_SESSION_LOA_4 = 256, /* value for LOA of 4 */
  47
  48 #if defined(AFB_BINDING_PRAGMA_DECLARE_V1) || defined(AFB_BINDING_PRAGMA_KEEP_OBSOLETE_V2)
  49        AFB_SESSION_LOA_LE_0 = AFB_SESSION_LOA_LE | AFB_SESSION_LOA_0, /* check LOA <= 0 */
  50        AFB_SESSION_LOA_LE_1 = AFB_SESSION_LOA_LE | AFB_SESSION_LOA_1, /* check LOA <= 1 */
  51        AFB_SESSION_LOA_LE_2 = AFB_SESSION_LOA_LE | AFB_SESSION_LOA_2, /* check LOA <= 2 */
  52        AFB_SESSION_LOA_LE_3 = AFB_SESSION_LOA_LE | AFB_SESSION_LOA_3, /* check LOA <= 3 */
  53
  54        AFB_SESSION_LOA_EQ_0 = AFB_SESSION_LOA_EQ | AFB_SESSION_LOA_0, /* check LOA == 0 */
  55        AFB_SESSION_LOA_EQ_1 = AFB_SESSION_LOA_EQ | AFB_SESSION_LOA_1, /* check LOA == 1 */
  56        AFB_SESSION_LOA_EQ_2 = AFB_SESSION_LOA_EQ | AFB_SESSION_LOA_2, /* check LOA == 2 */
  57        AFB_SESSION_LOA_EQ_3 = AFB_SESSION_LOA_EQ | AFB_SESSION_LOA_3, /* check LOA == 3 */
  58 #endif
  59
  60        AFB_SESSION_LOA_GE_0 = AFB_SESSION_LOA_GE | AFB_SESSION_LOA_0, /* check LOA >= 0 */
  61        AFB_SESSION_LOA_GE_1 = AFB_SESSION_LOA_GE | AFB_SESSION_LOA_1, /* check LOA >= 1 */
  62        AFB_SESSION_LOA_GE_2 = AFB_SESSION_LOA_GE | AFB_SESSION_LOA_2, /* check LOA >= 2 */
  63        AFB_SESSION_LOA_GE_3 = AFB_SESSION_LOA_GE | AFB_SESSION_LOA_3  /* check LOA >= 3 */
  64 };
  65