src/vnet/bfd/bfd_protocol.h

   1 /*
   2  * Copyright (c) 2011-2016 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 #ifndef __included_bfd_protocol_h__
  16 #define __included_bfd_protocol_h__
  17 /**
  18  * @file
  19  * @brief BFD protocol declarations
  20  */
  21
  22 #include <vppinfra/types.h>
  23 #include <vppinfra/clib.h>
  24
  25 /* auth type value, max key length, name, description */
  26 #define foreach_bfd_auth_type(F)                          \
  27   F (0, 0, reserved, "Reserved")                          \
  28   F (1, 16, simple_password, "Simple Password")           \
  29   F (2, 16, keyed_md5, "Keyed MD5")                       \
  30   F (3, 16, meticulous_keyed_md5, "Meticulous Keyed MD5") \
  31   F (4, 20, keyed_sha1, "Keyed SHA1")                     \
  32   F (5, 20, meticulous_keyed_sha1, "Meticulous Keyed SHA1")
  33
  34 #define BFD_AUTH_TYPE_NAME(t) BFD_AUTH_TYPE_##t
  35
  36 typedef enum
  37 {
  38 #define F(n, l, t, s) BFD_AUTH_TYPE_NAME (t) = n,
  39   foreach_bfd_auth_type (F)
  40 #undef F
  41 } bfd_auth_type_e;
  42
  43 /**
  44  * @brief get the maximum length of key data for given auth type
  45  */
  46 u32 bfd_max_key_len_for_auth_type (bfd_auth_type_e auth_type);
  47 const char *bfd_auth_type_str (bfd_auth_type_e auth_type);
  48
  49 typedef CLIB_PACKED (struct {
  50   u8 type;
  51   u8 len;
  52 }) bfd_auth_common_t;
  53
  54 typedef CLIB_PACKED (struct {
  55   /*
  56    * 4.4.  Keyed SHA1 and Meticulous Keyed SHA1 Authentication Section Format
  57
  58    *     If the Authentication Present (A) bit is set in the header, and the
  59    *     Authentication Type field contains 4 (Keyed SHA1) or 5 (Meticulous
  60    *     Keyed SHA1), the Authentication Section has the following format:
  61
  62    *      0                   1                   2                   3
  63    *      0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  64    *     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  65    *     |   Auth Type   |   Auth Len    |  Auth Key ID  |   Reserved    |
  66    *     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  67    *     |                        Sequence Number                        |
  68    *     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  69    *     |                       Auth Key/Hash...                        |
  70    *     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  71    *     |                              ...                              |
  72    *     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  73    */
  74   bfd_auth_common_t type_len;
  75   u8 key_id;
  76   u8 reserved;
  77   u32 seq_num;
  78   /*
  79    *  Auth Key/Hash
  80
  81    *     This field carries the 20-byte SHA1 hash for the packet.  When the
  82    *     hash is calculated, the shared SHA1 key is stored in this field,
  83    *     padded to a length of 20 bytes with trailing zero bytes if needed.
  84    *     The shared key MUST be encoded and configured to section 6.7.4.
  85    */
  86   u8 hash[20];
  87 }) bfd_auth_sha1_t;
  88
  89 typedef CLIB_PACKED (struct {
  90   /*
  91    *  The Mandatory Section of a BFD Control packet has the following
  92    *  format:
  93
  94    *   0                   1                   2                   3
  95    *   0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  96    *  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  97    *  |Vers |  Diag   |Sta|P|F|C|A|D|M|  Detect Mult  |    Length     |
  98    *  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  99    *  |                       My Discriminator                        |
 100    *  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 101    *  |                      Your Discriminator                       |
 102    *  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 103    *  |                    Desired Min TX Interval                    |
 104    *  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 105    *  |                   Required Min RX Interval                    |
 106    *  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 107    *  |                 Required Min Echo RX Interval                 |
 108    *  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 109    */
 110   struct
 111   {
 112     u8 vers_diag;
 113     u8 sta_flags;
 114     u8 detect_mult;
 115     u8 length;
 116   } head;
 117   u32 my_disc;
 118   u32 your_disc;
 119   u32 des_min_tx;
 120   u32 req_min_rx;
 121   u32 req_min_echo_rx;
 122 }) bfd_pkt_t;
 123
 124 typedef CLIB_PACKED (struct {
 125   bfd_pkt_t pkt;
 126   bfd_auth_common_t common_auth;
 127 }) bfd_pkt_with_common_auth_t;
 128
 129 typedef CLIB_PACKED (struct {
 130   bfd_pkt_t pkt;
 131   bfd_auth_sha1_t sha1_auth;
 132 }) bfd_pkt_with_sha1_auth_t;
 133
 134 u8 bfd_pkt_get_version (const bfd_pkt_t * pkt);
 135 void bfd_pkt_set_version (bfd_pkt_t * pkt, int version);
 136 u8 bfd_pkt_get_diag_code (const bfd_pkt_t * pkt);
 137 void bfd_pkt_set_diag_code (bfd_pkt_t * pkt, int value);
 138 u8 bfd_pkt_get_state (const bfd_pkt_t * pkt);
 139 void bfd_pkt_set_state (bfd_pkt_t * pkt, int value);
 140 u8 bfd_pkt_get_poll (const bfd_pkt_t * pkt);
 141 void bfd_pkt_set_final (bfd_pkt_t * pkt);
 142 u8 bfd_pkt_get_final (const bfd_pkt_t * pkt);
 143 void bfd_pkt_set_poll (bfd_pkt_t * pkt);
 144 u8 bfd_pkt_get_control_plane_independent (const bfd_pkt_t * pkt);
 145 void bfd_pkt_set_control_plane_independent (bfd_pkt_t * pkt);
 146 u8 bfd_pkt_get_auth_present (const bfd_pkt_t * pkt);
 147 void bfd_pkt_set_auth_present (bfd_pkt_t * pkt);
 148 u8 bfd_pkt_get_demand (const bfd_pkt_t * pkt);
 149 void bfd_pkt_set_demand (bfd_pkt_t * pkt);
 150 u8 bfd_pkt_get_multipoint (const bfd_pkt_t * pkt);
 151 void bfd_pkt_set_multipoint (bfd_pkt_t * pkt);
 152
 153 /* BFD diagnostic codes */
 154 #define foreach_bfd_diag_code(F)                             \
 155   F (0, no_diag, "No Diagnostic")                            \
 156   F (1, det_time_exp, "Control Detection Time Expired")      \
 157   F (2, echo_failed, "Echo Function Failed")                 \
 158   F (3, neighbor_sig_down, "Neighbor Signaled Session Down") \
 159   F (4, fwd_plain_reset, "Forwarding Plane Reset")           \
 160   F (5, path_down, "Path Down")                              \
 161   F (6, concat_path_down, "Concatenated Path Down")          \
 162   F (7, admin_down, "Administratively Down")                 \
 163   F (8, reverse_concat_path_down, "Reverse Concatenated Path Down")
 164
 165 #define BFD_DIAG_CODE_NAME(t) BFD_DIAG_CODE_##t
 166
 167 typedef enum
 168 {
 169 #define F(n, t, s) BFD_DIAG_CODE_NAME (t) = n,
 170   foreach_bfd_diag_code (F)
 171 #undef F
 172 } bfd_diag_code_e;
 173
 174 const char *bfd_diag_code_string (bfd_diag_code_e diag);
 175
 176 /* BFD state values */
 177 #define foreach_bfd_state(F)     \
 178   F (0, admin_down, "AdminDown") \
 179   F (1, down, "Down")            \
 180   F (2, init, "Init")            \
 181   F (3, up, "Up")
 182
 183 #define BFD_STATE_NAME(t) BFD_STATE_##t
 184
 185 typedef enum
 186 {
 187 #define F(n, t, s) BFD_STATE_NAME (t) = n,
 188   foreach_bfd_state (F)
 189 #undef F
 190 } bfd_state_e;
 191
 192 const char *bfd_state_string (bfd_state_e state);
 193
 194 #endif /* __included_bfd_protocol_h__ */
 195
 196 /*
 197  * fd.io coding-style-patch-verification: ON
 198  *
 199  * Local Variables:
 200  * eval: (c-set-style "gnu")
 201  * End:
 202  */