src/vnet/ipsec/ipsec_format.c

   1 /*
   2  * decap.c : IPSec tunnel support
   3  *
   4  * Copyright (c) 2015 Cisco and/or its affiliates.
   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 #include <vnet/vnet.h>
  19 #include <vnet/api_errno.h>
  20 #include <vnet/ip/ip.h>
  21 #include <vnet/interface.h>
  22 #include <vnet/fib/fib_table.h>
  23
  24 #include <vnet/ipsec/ipsec.h>
  25
  26 u8 *
  27 format_ipsec_policy_action (u8 * s, va_list * args)
  28 {
  29   u32 i = va_arg (*args, u32);
  30   char *t = 0;
  31
  32   switch (i)
  33     {
  34 #define _(v,f,str) case IPSEC_POLICY_ACTION_##f: t = str; break;
  35       foreach_ipsec_policy_action
  36 #undef _
  37     default:
  38       s = format (s, "unknown");
  39     }
  40   s = format (s, "%s", t);
  41   return s;
  42 }
  43
  44 u8 *
  45 format_ipsec_policy_type (u8 * s, va_list * args)
  46 {
  47   u32 i = va_arg (*args, u32);
  48   char *t = 0;
  49
  50   switch (i)
  51     {
  52 #define _(f,str) case IPSEC_SPD_POLICY_##f: t = str; break;
  53       foreach_ipsec_spd_policy_type
  54 #undef _
  55     default:
  56       s = format (s, "unknown");
  57     }
  58   s = format (s, "%s", t);
  59   return s;
  60 }
  61
  62 uword
  63 unformat_ipsec_policy_action (unformat_input_t * input, va_list * args)
  64 {
  65   u32 *r = va_arg (*args, u32 *);
  66
  67   if (0);
  68 #define _(v,f,s) else if (unformat (input, s)) *r = IPSEC_POLICY_ACTION_##f;
  69   foreach_ipsec_policy_action
  70 #undef _
  71     else
  72     return 0;
  73   return 1;
  74 }
  75
  76 u8 *
  77 format_ipsec_crypto_alg (u8 * s, va_list * args)
  78 {
  79   u32 i = va_arg (*args, u32);
  80   u8 *t = 0;
  81
  82   switch (i)
  83     {
  84 #define _(v,f,str) case IPSEC_CRYPTO_ALG_##f: t = (u8 *) str; break;
  85       foreach_ipsec_crypto_alg
  86 #undef _
  87     default:
  88       s = format (s, "unknown");
  89     }
  90   s = format (s, "%s", t);
  91   return s;
  92 }
  93
  94 uword
  95 unformat_ipsec_crypto_alg (unformat_input_t * input, va_list * args)
  96 {
  97   u32 *r = va_arg (*args, u32 *);
  98
  99   if (0);
 100 #define _(v,f,s) else if (unformat (input, s)) *r = IPSEC_CRYPTO_ALG_##f;
 101   foreach_ipsec_crypto_alg
 102 #undef _
 103     else
 104     return 0;
 105   return 1;
 106 }
 107
 108 u8 *
 109 format_ipsec_integ_alg (u8 * s, va_list * args)
 110 {
 111   u32 i = va_arg (*args, u32);
 112   u8 *t = 0;
 113
 114   switch (i)
 115     {
 116 #define _(v,f,str) case IPSEC_INTEG_ALG_##f: t = (u8 *) str; break;
 117       foreach_ipsec_integ_alg
 118 #undef _
 119     default:
 120       s = format (s, "unknown");
 121     }
 122   s = format (s, "%s", t);
 123   return s;
 124 }
 125
 126 uword
 127 unformat_ipsec_integ_alg (unformat_input_t * input, va_list * args)
 128 {
 129   u32 *r = va_arg (*args, u32 *);
 130
 131   if (0);
 132 #define _(v,f,s) else if (unformat (input, s)) *r = IPSEC_INTEG_ALG_##f;
 133   foreach_ipsec_integ_alg
 134 #undef _
 135     else
 136     return 0;
 137   return 1;
 138 }
 139
 140 u8 *
 141 format_ipsec_replay_window (u8 * s, va_list * args)
 142 {
 143   u64 w = va_arg (*args, u64);
 144   u8 i;
 145
 146   for (i = 0; i < 64; i++)
 147     {
 148       s = format (s, "%u", w & (1ULL << i) ? 1 : 0);
 149     }
 150
 151   return s;
 152 }
 153
 154 u8 *
 155 format_ipsec_policy (u8 * s, va_list * args)
 156 {
 157   u32 pi = va_arg (*args, u32);
 158   ip46_type_t ip_type = IP46_TYPE_IP4;
 159   ipsec_main_t *im = &ipsec_main;
 160   ipsec_policy_t *p;
 161   vlib_counter_t counts;
 162
 163   p = pool_elt_at_index (im->policies, pi);
 164
 165   s = format (s, "  [%d] priority %d action %U type %U protocol ",
 166               pi, p->priority,
 167               format_ipsec_policy_action, p->policy,
 168               format_ipsec_policy_type, p->type);
 169   if (p->protocol)
 170     {
 171       s = format (s, "%U", format_ip_protocol, p->protocol);
 172     }
 173   else
 174     {
 175       s = format (s, "any");
 176     }
 177   if (p->policy == IPSEC_POLICY_ACTION_PROTECT)
 178     {
 179       s = format (s, " sa %u", p->sa_id);
 180     }
 181   if (p->is_ipv6)
 182     {
 183       ip_type = IP46_TYPE_IP6;
 184     }
 185
 186   s = format (s, "\n     local addr range %U - %U port range %u - %u",
 187               format_ip46_address, &p->laddr.start, ip_type,
 188               format_ip46_address, &p->laddr.stop, ip_type,
 189               clib_net_to_host_u16 (p->lport.start),
 190               clib_net_to_host_u16 (p->lport.stop));
 191   s = format (s, "\n     remote addr range %U - %U port range %u - %u",
 192               format_ip46_address, &p->raddr.start, ip_type,
 193               format_ip46_address, &p->raddr.stop, ip_type,
 194               clib_net_to_host_u16 (p->rport.start),
 195               clib_net_to_host_u16 (p->rport.stop));
 196
 197   vlib_get_combined_counter (&ipsec_spd_policy_counters, pi, &counts);
 198   s = format (s, "\n     packets %u bytes %u", counts.packets, counts.bytes);
 199
 200   return (s);
 201 }
 202
 203 u8 *
 204 format_ipsec_spd (u8 * s, va_list * args)
 205 {
 206   u32 si = va_arg (*args, u32);
 207   ipsec_main_t *im = &ipsec_main;
 208   ipsec_spd_t *spd;
 209   u32 *i;
 210
 211   if (pool_is_free_index (im->spds, si))
 212     {
 213       s = format (s, "No such SPD index: %d", si);
 214       goto done;
 215     }
 216
 217   spd = pool_elt_at_index (im->spds, si);
 218
 219   s = format (s, "spd %u", spd->id);
 220
 221 #define _(v, n)                                                 \
 222   s = format (s, "\n %s:", n);                                  \
 223   vec_foreach(i, spd->policies[IPSEC_SPD_POLICY_##v])           \
 224   {                                                             \
 225     s = format (s, "\n %U", format_ipsec_policy, *i);           \
 226   }
 227   foreach_ipsec_spd_policy_type;
 228 #undef _
 229
 230 done:
 231   return (s);
 232 }
 233
 234 u8 *
 235 format_ipsec_key (u8 * s, va_list * args)
 236 {
 237   ipsec_key_t *key = va_arg (*args, ipsec_key_t *);
 238
 239   return (format (s, "%U", format_hex_bytes, key->data, key->len));
 240 }
 241
 242 uword
 243 unformat_ipsec_key (unformat_input_t * input, va_list * args)
 244 {
 245   ipsec_key_t *key = va_arg (*args, ipsec_key_t *);
 246   u8 *data;
 247
 248   if (unformat (input, "%U", unformat_hex_string, &data))
 249     {
 250       ipsec_mk_key (key, data, vec_len (data));
 251       vec_free (data);
 252     }
 253   else
 254     return 0;
 255   return 1;
 256 }
 257
 258 u8 *
 259 format_ipsec_sa_flags (u8 * s, va_list * args)
 260 {
 261   ipsec_sa_flags_t flags = va_arg (*args, int);
 262
 263   if (0)
 264     ;
 265 #define _(v, f, str) else if (flags & IPSEC_SA_FLAG_##f) s = format(s, "%s ", str);
 266   foreach_ipsec_sa_flags
 267 #undef _
 268     return (s);
 269 }
 270
 271 u8 *
 272 format_ipsec_sa (u8 * s, va_list * args)
 273 {
 274   u32 sai = va_arg (*args, u32);
 275   ipsec_format_flags_t flags = va_arg (*args, ipsec_format_flags_t);
 276   ipsec_main_t *im = &ipsec_main;
 277   vlib_counter_t counts;
 278   u32 tx_table_id;
 279   ipsec_sa_t *sa;
 280
 281   if (pool_is_free_index (im->sad, sai))
 282     {
 283       s = format (s, "No such SA index: %d", sai);
 284       goto done;
 285     }
 286
 287   sa = pool_elt_at_index (im->sad, sai);
 288
 289   s = format (s, "[%d] sa 0x%x spi %u mode %s%s protocol %s %U",
 290               sai, sa->id, sa->spi,
 291               ipsec_sa_is_set_IS_TUNNEL (sa) ? "tunnel" : "transport",
 292               ipsec_sa_is_set_IS_TUNNEL_V6 (sa) ? "-ip6" : "",
 293               sa->protocol ? "esp" : "ah", format_ipsec_sa_flags, sa->flags);
 294
 295   if (!(flags & IPSEC_FORMAT_DETAIL))
 296     goto done;
 297
 298   s = format (s, "\n   salt 0x%x", clib_net_to_host_u32 (sa->salt));
 299   s = format (s, "\n   seq %u seq-hi %u", sa->seq, sa->seq_hi);
 300   s = format (s, "\n   last-seq %u last-seq-hi %u window %U",
 301               sa->last_seq, sa->last_seq_hi,
 302               format_ipsec_replay_window, sa->replay_window);
 303   s = format (s, "\n   crypto alg %U",
 304               format_ipsec_crypto_alg, sa->crypto_alg);
 305   if (sa->crypto_alg)
 306     s = format (s, " key %U", format_ipsec_key, &sa->crypto_key);
 307   s = format (s, "\n   integrity alg %U",
 308               format_ipsec_integ_alg, sa->integ_alg);
 309   if (sa->integ_alg)
 310     s = format (s, " key %U", format_ipsec_key, &sa->integ_key);
 311
 312   vlib_get_combined_counter (&ipsec_sa_counters, sai, &counts);
 313   s = format (s, "\n   packets %u bytes %u", counts.packets, counts.bytes);
 314
 315   if (ipsec_sa_is_set_IS_TUNNEL (sa))
 316     {
 317       tx_table_id = fib_table_get_table_id (sa->tx_fib_index,
 318                                             FIB_PROTOCOL_IP4);
 319       s = format (s, "\n   table-ID %d tunnel src %U dst %U",
 320                   tx_table_id,
 321                   format_ip46_address, &sa->tunnel_src_addr, IP46_TYPE_ANY,
 322                   format_ip46_address, &sa->tunnel_dst_addr, IP46_TYPE_ANY);
 323       if (!ipsec_sa_is_set_IS_INBOUND (sa))
 324         {
 325           s =
 326             format (s, "\n    resovle via fib-entry: %d",
 327                     sa->fib_entry_index);
 328           s = format (s, "\n    stacked on:");
 329           s = format (s, "\n      %U", format_dpo_id, &sa->dpo, 6);
 330         }
 331     }
 332
 333 done:
 334   return (s);
 335 }
 336
 337 u8 *
 338 format_ipsec_tunnel (u8 * s, va_list * args)
 339 {
 340   ipsec_main_t *im = &ipsec_main;
 341   u32 ti = va_arg (*args, u32);
 342   ipsec_tunnel_if_t *t;
 343
 344   if (pool_is_free_index (im->tunnel_interfaces, ti))
 345     {
 346       s = format (s, "No such tunnel index: %d", ti);
 347       goto done;
 348     }
 349
 350   t = pool_elt_at_index (im->tunnel_interfaces, ti);
 351
 352   if (t->hw_if_index == ~0)
 353     goto done;
 354
 355   s =
 356     format (s, "%U\n", format_vnet_hw_if_index_name, im->vnet_main,
 357             t->hw_if_index);
 358
 359   s = format (s, "   out-bound sa: ");
 360   s = format (s, "%U\n", format_ipsec_sa, t->output_sa_index,
 361               IPSEC_FORMAT_BRIEF);
 362
 363   s = format (s, "    in-bound sa: ");
 364   s = format (s, "%U\n", format_ipsec_sa, t->input_sa_index,
 365               IPSEC_FORMAT_BRIEF);
 366
 367 done:
 368   return (s);
 369 }
 370
 371 /*
 372  * fd.io coding-style-patch-verification: ON
 373  *
 374  * Local Variables:
 375  * eval: (c-set-style "gnu")
 376  * End:
 377  */