include/afb/afb-session-v1.h

   1 /*
   2  * Copyright (C) 2016, 2017, 2018 "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_v1
  24 {
  25        AFB_SESSION_NONE_V1 = 0,   /* nothing required */
  26        AFB_SESSION_CREATE_V1 = 1, /* Obsolete */
  27        AFB_SESSION_CLOSE_V1 = 2,  /* After token authentification, closes the session at end */
  28        AFB_SESSION_RENEW_V1 = 4,  /* After token authentification, refreshes the token at end */
  29        AFB_SESSION_CHECK_V1 = 8,  /* Requires token authentification */
  30
  31        AFB_SESSION_LOA_GE_V1 = 16, /* check that the LOA is greater or equal to the given value */
  32        AFB_SESSION_LOA_LE_V1 = 32, /* check that the LOA is lesser or equal to the given value */
  33        AFB_SESSION_LOA_EQ_V1 = 48, /* check that the LOA is equal to the given value */
  34
  35        AFB_SESSION_LOA_SHIFT_V1 = 6, /* shift for LOA */
  36        AFB_SESSION_LOA_MASK_V1 = 7,  /* mask for LOA */
  37
  38        AFB_SESSION_LOA_0_V1 = 0,   /* value for LOA of 0 */
  39        AFB_SESSION_LOA_1_V1 = 64,  /* value for LOA of 1 */
  40        AFB_SESSION_LOA_2_V1 = 128, /* value for LOA of 2 */
  41        AFB_SESSION_LOA_3_V1 = 192, /* value for LOA of 3 */
  42        AFB_SESSION_LOA_4_V1 = 256, /* value for LOA of 4 */
  43
  44        AFB_SESSION_LOA_LE_0_V1 = AFB_SESSION_LOA_LE_V1 | AFB_SESSION_LOA_0_V1, /* check LOA <= 0 */
  45        AFB_SESSION_LOA_LE_1_V1 = AFB_SESSION_LOA_LE_V1 | AFB_SESSION_LOA_1_V1, /* check LOA <= 1 */
  46        AFB_SESSION_LOA_LE_2_V1 = AFB_SESSION_LOA_LE_V1 | AFB_SESSION_LOA_2_V1, /* check LOA <= 2 */
  47        AFB_SESSION_LOA_LE_3_V1 = AFB_SESSION_LOA_LE_V1 | AFB_SESSION_LOA_3_V1, /* check LOA <= 3 */
  48
  49        AFB_SESSION_LOA_EQ_0_V1 = AFB_SESSION_LOA_EQ_V1 | AFB_SESSION_LOA_0_V1, /* check LOA == 0 */
  50        AFB_SESSION_LOA_EQ_1_V1 = AFB_SESSION_LOA_EQ_V1 | AFB_SESSION_LOA_1_V1, /* check LOA == 1 */
  51        AFB_SESSION_LOA_EQ_2_V1 = AFB_SESSION_LOA_EQ_V1 | AFB_SESSION_LOA_2_V1, /* check LOA == 2 */
  52        AFB_SESSION_LOA_EQ_3_V1 = AFB_SESSION_LOA_EQ_V1 | AFB_SESSION_LOA_3_V1, /* check LOA == 3 */
  53
  54        AFB_SESSION_LOA_GE_0_V1 = AFB_SESSION_LOA_GE_V1 | AFB_SESSION_LOA_0_V1, /* check LOA >= 0 */
  55        AFB_SESSION_LOA_GE_1_V1 = AFB_SESSION_LOA_GE_V1 | AFB_SESSION_LOA_1_V1, /* check LOA >= 1 */
  56        AFB_SESSION_LOA_GE_2_V1 = AFB_SESSION_LOA_GE_V1 | AFB_SESSION_LOA_2_V1, /* check LOA >= 2 */
  57        AFB_SESSION_LOA_GE_3_V1 = AFB_SESSION_LOA_GE_V1 | AFB_SESSION_LOA_3_V1  /* check LOA >= 3 */
  58 };
  59