include/afb/afb-session-x1.h

   1 /*
   2  * Copyright (C) 2016-2019 "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  * @deprecated use bindings version 3
  22  *
  23  * Enum for Session/Token/Assurance of bindings version 1.
  24  */
  25 enum afb_session_flags_x1
  26 {
  27        AFB_SESSION_NONE_X1 = 0,   /**< nothing required */
  28        AFB_SESSION_CREATE_X1 = 1, /**< Obsolete */
  29        AFB_SESSION_CLOSE_X1 = 2,  /**< After token authentification, closes the session at end */
  30        AFB_SESSION_RENEW_X1 = 4,  /**< After token authentification, refreshes the token at end */
  31        AFB_SESSION_CHECK_X1 = 8,  /**< Requires token authentification */
  32
  33        AFB_SESSION_LOA_GE_X1 = 16, /**< check that the LOA is greater or equal to the given value */
  34        AFB_SESSION_LOA_LE_X1 = 32, /**< check that the LOA is lesser or equal to the given value */
  35        AFB_SESSION_LOA_EQ_X1 = 48, /**< check that the LOA is equal to the given value */
  36
  37        AFB_SESSION_LOA_SHIFT_X1 = 6, /**< shift for LOA */
  38        AFB_SESSION_LOA_MASK_X1 = 7,  /**< mask for LOA */
  39
  40        AFB_SESSION_LOA_0_X1 = 0,   /**< value for LOA of 0 */
  41        AFB_SESSION_LOA_1_X1 = 64,  /**< value for LOA of 1 */
  42        AFB_SESSION_LOA_2_X1 = 128, /**< value for LOA of 2 */
  43        AFB_SESSION_LOA_3_X1 = 192, /**< value for LOA of 3 */
  44        AFB_SESSION_LOA_4_X1 = 256, /**< value for LOA of 4 */
  45
  46        AFB_SESSION_LOA_LE_0_X1 = AFB_SESSION_LOA_LE_X1 | AFB_SESSION_LOA_0_X1, /**< check LOA <= 0 */
  47        AFB_SESSION_LOA_LE_1_X1 = AFB_SESSION_LOA_LE_X1 | AFB_SESSION_LOA_1_X1, /**< check LOA <= 1 */
  48        AFB_SESSION_LOA_LE_2_X1 = AFB_SESSION_LOA_LE_X1 | AFB_SESSION_LOA_2_X1, /**< check LOA <= 2 */
  49        AFB_SESSION_LOA_LE_3_X1 = AFB_SESSION_LOA_LE_X1 | AFB_SESSION_LOA_3_X1, /**< check LOA <= 3 */
  50
  51        AFB_SESSION_LOA_EQ_0_X1 = AFB_SESSION_LOA_EQ_X1 | AFB_SESSION_LOA_0_X1, /**< check LOA == 0 */
  52        AFB_SESSION_LOA_EQ_1_X1 = AFB_SESSION_LOA_EQ_X1 | AFB_SESSION_LOA_1_X1, /**< check LOA == 1 */
  53        AFB_SESSION_LOA_EQ_2_X1 = AFB_SESSION_LOA_EQ_X1 | AFB_SESSION_LOA_2_X1, /**< check LOA == 2 */
  54        AFB_SESSION_LOA_EQ_3_X1 = AFB_SESSION_LOA_EQ_X1 | AFB_SESSION_LOA_3_X1, /**< check LOA == 3 */
  55
  56        AFB_SESSION_LOA_GE_0_X1 = AFB_SESSION_LOA_GE_X1 | AFB_SESSION_LOA_0_X1, /**< check LOA >= 0 */
  57        AFB_SESSION_LOA_GE_1_X1 = AFB_SESSION_LOA_GE_X1 | AFB_SESSION_LOA_1_X1, /**< check LOA >= 1 */
  58        AFB_SESSION_LOA_GE_2_X1 = AFB_SESSION_LOA_GE_X1 | AFB_SESSION_LOA_2_X1, /**< check LOA >= 2 */
  59        AFB_SESSION_LOA_GE_3_X1 = AFB_SESSION_LOA_GE_X1 | AFB_SESSION_LOA_3_X1  /**< check LOA >= 3 */
  60 };
  61