src/plugins/ikev2/ikev2_priv.h

   1 /*
   2  * Copyright (c) 2015 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_ikev2_priv_h__
  16 #define __included_ikev2_priv_h__
  17
  18 #include <vnet/vnet.h>
  19 #include <vnet/ip/ip.h>
  20 #include <vnet/ethernet/ethernet.h>
  21
  22 #include <plugins/ikev2/ikev2.h>
  23
  24 #include <vppinfra/hash.h>
  25 #include <vppinfra/elog.h>
  26 #include <vppinfra/error.h>
  27
  28 #include <openssl/rand.h>
  29 #include <openssl/dh.h>
  30 #include <openssl/hmac.h>
  31 #include <openssl/evp.h>
  32
  33 #define foreach_ikev2_log_level \
  34   _(0x00, LOG_NONE)             \
  35   _(0x01, LOG_ERROR)            \
  36   _(0x02, LOG_WARNING)          \
  37   _(0x03, LOG_INFO)             \
  38   _(0x04, LOG_DEBUG)            \
  39   _(0x05, LOG_DETAIL)           \
  40
  41
  42 typedef enum ikev2_log_level_t_
  43 {
  44 #define _(n,f) IKEV2_##f = n,
  45   foreach_ikev2_log_level
  46 #undef _
  47   IKEV2_LOG_MAX
  48 } ikev2_log_level_t;
  49
  50 /* dataplane logging */
  51 #define _ikev2_elog(_level, _msg)                                             \
  52 do {                                                                          \
  53   ikev2_main_t *km = &ikev2_main;                                             \
  54   if (PREDICT_FALSE (km->log_level >= _level))                                \
  55     {                                                                         \
  56       ELOG_TYPE_DECLARE (e) =                                                 \
  57         {                                                                     \
  58           .format = "ikev2 " _msg,                                            \
  59           .format_args = "",                                                  \
  60         };                                                                    \
  61       ELOG_DATA (&vlib_global_main.elog_main, e);                             \
  62     }                                                                         \
  63 } while (0)
  64
  65 #define ikev2_elog_sa_state(_format, _ispi)                                   \
  66 do {                                                                          \
  67   ikev2_main_t *km = &ikev2_main;                                             \
  68   if (PREDICT_FALSE (km->log_level >= IKEV2_LOG_DEBUG))                       \
  69     {                                                                         \
  70       ELOG_TYPE_DECLARE (e) =                                                 \
  71         {                                                                     \
  72           .format = "ikev2: " _format,                                        \
  73           .format_args = "i8",                                                \
  74         };                                                                    \
  75       CLIB_PACKED(struct                                                      \
  76         {                                                                     \
  77           u64 ispi;                                                           \
  78         }) *ed;                                                               \
  79       ed = ELOG_DATA (&vlib_global_main.elog_main, e);                        \
  80       ed->ispi = _ispi;                                                       \
  81     }                                                                         \
  82 } while (0)                                                                   \
  83
  84 #define ikev2_elog_exchange_internal(_format, _ispi, _rspi, _addr)            \
  85 do {                                                                          \
  86   ikev2_main_t *km = &ikev2_main;                                             \
  87   if (PREDICT_FALSE (km->log_level >= IKEV2_LOG_DEBUG))                       \
  88     {                                                                         \
  89       ELOG_TYPE_DECLARE (e) =                                                 \
  90         {                                                                     \
  91           .format = "ikev2: " _format,                                        \
  92           .format_args = "i8i8i1i1i1i1",                                      \
  93         };                                                                    \
  94       CLIB_PACKED(struct                                                      \
  95         {                                                                     \
  96           u64 ispi;                                                           \
  97           u64 rspi;                                                           \
  98           u8 oct1;                                                            \
  99           u8 oct2;                                                            \
 100           u8 oct3;                                                            \
 101           u8 oct4;                                                            \
 102         }) *ed;                                                               \
 103       ed = ELOG_DATA (&vlib_global_main.elog_main, e);                        \
 104       ed->ispi = _ispi;                                                       \
 105       ed->rspi = _rspi;                                                       \
 106       ed->oct4 = (_addr) >> 24;                                               \
 107       ed->oct3 = (_addr) >> 16;                                               \
 108       ed->oct2 = (_addr) >> 8;                                                \
 109       ed->oct1 = (_addr);                                                     \
 110     }                                                                         \
 111 } while (0)                                                                   \
 112
 113 #define IKE_ELOG_IP4_FMT "%d.%d.%d.%d"
 114 #define IKE_ELOG_IP6_FMT "[v6]:%x%x:%x%x"
 115
 116 #define ikev2_elog_exchange(_fmt, _ispi, _rspi, _addr, _v4)                   \
 117 do {                                                                          \
 118   if (_v4)                                                                    \
 119     ikev2_elog_exchange_internal (_fmt IKE_ELOG_IP4_FMT, _ispi, _rspi, _addr);\
 120   else                                                                        \
 121     ikev2_elog_exchange_internal (_fmt IKE_ELOG_IP6_FMT, _ispi, _rspi, _addr);\
 122 } while (0)
 123
 124 #define ikev2_elog_uint(_level, _format, _val)                                \
 125 do {                                                                          \
 126   ikev2_main_t *km = &ikev2_main;                                             \
 127   if (PREDICT_FALSE (km->log_level >= _level))                                \
 128     {                                                                         \
 129       ELOG_TYPE_DECLARE (e) =                                                 \
 130         {                                                                     \
 131           .format = "ikev2: " _format,                                        \
 132           .format_args = "i8",                                                \
 133         };                                                                    \
 134       CLIB_PACKED(struct                                                      \
 135         {                                                                     \
 136           u64 val;                                                            \
 137         }) *ed;                                                               \
 138       ed = ELOG_DATA (&vlib_global_main.elog_main, e);                        \
 139       ed->val = _val;                                                         \
 140     }                                                                         \
 141 } while (0)
 142
 143 #define ikev2_elog_uint_peers(_level, _format, _val, _ip1, _ip2)              \
 144 do {                                                                          \
 145   ikev2_main_t *km = &ikev2_main;                                             \
 146   if (PREDICT_FALSE (km->log_level >= _level))                                \
 147     {                                                                         \
 148       ELOG_TYPE_DECLARE (e) =                                                 \
 149         {                                                                     \
 150           .format = "ikev2: " _format,                                        \
 151           .format_args = "i8i1i1i1i1i1i1i1i1",                                \
 152         };                                                                    \
 153       CLIB_PACKED(struct {                                                    \
 154         u64 val;                                                              \
 155         u8 i11; u8 i12; u8 i13; u8 i14;                                       \
 156         u8 i21; u8 i22; u8 i23; u8 i24; }) *ed;                               \
 157       ed = ELOG_DATA (&vlib_global_main.elog_main, e);                        \
 158       ed->val = _val;                                                         \
 159       ed->i14 = (_ip1) >> 24;                                                 \
 160       ed->i13 = (_ip1) >> 16;                                                 \
 161       ed->i12 = (_ip1) >> 8;                                                  \
 162       ed->i11 = (_ip1);                                                       \
 163       ed->i24 = (_ip2) >> 24;                                                 \
 164       ed->i23 = (_ip2) >> 16;                                                 \
 165       ed->i22 = (_ip2) >> 8;                                                  \
 166       ed->i21 = (_ip2);                                                       \
 167     }                                                                         \
 168 } while (0)
 169
 170 #define ikev2_elog_error(_msg) \
 171   _ikev2_elog(IKEV2_LOG_ERROR, "[error] " _msg)
 172 #define ikev2_elog_warning(_msg) \
 173   _ikev2_elog(IKEV2_LOG_WARNING, "[warning] " _msg)
 174 #define ikev2_elog_debug(_msg) \
 175   _ikev2_elog(IKEV2_LOG_DEBUG, "[debug] " _msg)
 176 #define ikev2_elog_detail(_msg) \
 177   _ikev2_elog(IKEV2_LOG_DETAIL, "[detail] " _msg)
 178
 179 /* logging for main thread */
 180 #define ikev2_log_error(...) \
 181   vlib_log(VLIB_LOG_LEVEL_ERR, ikev2_main.log_class, __VA_ARGS__)
 182 #define ikev2_log_warning(...) \
 183   vlib_log(VLIB_LOG_LEVEL_WARNING, ikev2_main.log_class, __VA_ARGS__)
 184 #define ikev2_log_debug(...) \
 185   vlib_log(VLIB_LOG_LEVEL_DEBUG, ikev2_main.log_class, __VA_ARGS__)
 186
 187 typedef enum
 188 {
 189   IKEV2_STATE_UNKNOWN,
 190   IKEV2_STATE_SA_INIT,
 191   IKEV2_STATE_DELETED,
 192   IKEV2_STATE_AUTH_FAILED,
 193   IKEV2_STATE_AUTHENTICATED,
 194   IKEV2_STATE_NOTIFY_AND_DELETE,
 195   IKEV2_STATE_TS_UNACCEPTABLE,
 196   IKEV2_STATE_NO_PROPOSAL_CHOSEN,
 197 } ikev2_state_t;
 198
 199 typedef struct
 200 {
 201   ikev2_auth_method_t method:8;
 202   u8 *data;
 203   u8 hex;                       /* hex encoding of the shared secret */
 204   EVP_PKEY *key;
 205 } ikev2_auth_t;
 206
 207 typedef enum
 208 {
 209   IKEV2_DH_GROUP_MODP = 0,
 210   IKEV2_DH_GROUP_ECP = 1,
 211 } ikev2_dh_group_t;
 212
 213 typedef struct
 214 {
 215   ikev2_transform_type_t type;
 216   union
 217   {
 218     u16 transform_id;
 219     ikev2_transform_encr_type_t encr_type:16;
 220     ikev2_transform_prf_type_t prf_type:16;
 221     ikev2_transform_integ_type_t integ_type:16;
 222     ikev2_transform_dh_type_t dh_type:16;
 223     ikev2_transform_esn_type_t esn_type:16;
 224   };
 225   u8 *attrs;
 226   u16 key_len;
 227   u16 key_trunc;
 228   u16 block_size;
 229   u8 dh_group;
 230   int nid;
 231   const char *dh_p;
 232   const char *dh_g;
 233   const void *md;
 234   const void *cipher;
 235 } ikev2_sa_transform_t;
 236
 237 typedef struct
 238 {
 239   u8 proposal_num;
 240   ikev2_protocol_id_t protocol_id:8;
 241   u32 spi;
 242   ikev2_sa_transform_t *transforms;
 243 } ikev2_sa_proposal_t;
 244
 245 typedef struct
 246 {
 247   ikev2_traffic_selector_type_t ts_type;
 248   u8 protocol_id;
 249   u16 selector_len;
 250   u16 start_port;
 251   u16 end_port;
 252   ip_address_t start_addr;
 253   ip_address_t end_addr;
 254 } ikev2_ts_t;
 255
 256 typedef struct
 257 {
 258   u32 sw_if_index;
 259   ip_address_t addr;
 260 } ikev2_responder_t;
 261
 262 typedef struct
 263 {
 264   ikev2_transform_encr_type_t crypto_alg;
 265   ikev2_transform_integ_type_t integ_alg;
 266   ikev2_transform_dh_type_t dh_type;
 267   u32 crypto_key_size;
 268 } ikev2_transforms_set;
 269
 270
 271 typedef struct
 272 {
 273   ikev2_id_type_t type:8;
 274   u8 *data;
 275 } ikev2_id_t;
 276
 277 typedef struct
 278 {
 279   /* sa proposals vectors */
 280   ikev2_sa_proposal_t *i_proposals;
 281   ikev2_sa_proposal_t *r_proposals;
 282
 283   /* Traffic Selectors */
 284   ikev2_ts_t *tsi;
 285   ikev2_ts_t *tsr;
 286
 287   /* keys */
 288   u8 *sk_ai;
 289   u8 *sk_ar;
 290   u8 *sk_ei;
 291   u8 *sk_er;
 292   u32 salt_ei;
 293   u32 salt_er;
 294
 295   /* installed data */
 296   u32 local_sa_id;
 297   u32 remote_sa_id;
 298
 299   /* lifetime data */
 300   f64 time_to_expiration;
 301   u8 is_expired;
 302   i8 rekey_retries;
 303 } ikev2_child_sa_t;
 304
 305 typedef struct
 306 {
 307   u8 protocol_id;
 308   u32 spi;                      /*for ESP and AH SPI size is 4, for IKE size is 0 */
 309 } ikev2_delete_t;
 310
 311 typedef struct
 312 {
 313   u8 protocol_id;
 314   u32 spi;
 315   u32 ispi;
 316   ikev2_sa_proposal_t *i_proposal;
 317   ikev2_sa_proposal_t *r_proposal;
 318   ikev2_ts_t *tsi;
 319   ikev2_ts_t *tsr;
 320 } ikev2_rekey_t;
 321
 322 typedef struct
 323 {
 324   u16 msg_type;
 325   u8 protocol_id;
 326   u32 spi;
 327   u8 *data;
 328 } ikev2_notify_t;
 329
 330 typedef struct
 331 {
 332   u8 *name;
 333
 334   ikev2_auth_t auth;
 335   ikev2_id_t loc_id;
 336   ikev2_id_t rem_id;
 337   ikev2_ts_t loc_ts;
 338   ikev2_ts_t rem_ts;
 339   ikev2_responder_t responder;
 340   ikev2_transforms_set ike_ts;
 341   ikev2_transforms_set esp_ts;
 342   u64 lifetime;
 343   u64 lifetime_maxdata;
 344   u32 lifetime_jitter;
 345   u32 handover;
 346   u16 ipsec_over_udp_port;
 347
 348   u32 tun_itf;
 349   u8 udp_encap;
 350 } ikev2_profile_t;
 351
 352 typedef struct
 353 {
 354   ikev2_state_t state;
 355   u8 unsupported_cp;
 356   u8 initial_contact;
 357   ip_address_t iaddr;
 358   ip_address_t raddr;
 359   u64 ispi;
 360   u64 rspi;
 361   u8 *i_nonce;
 362   u8 *r_nonce;
 363
 364   /* DH data */
 365   u16 dh_group;
 366   u8 *dh_shared_key;
 367   u8 *dh_private_key;
 368   u8 *i_dh_data;
 369   u8 *r_dh_data;
 370
 371   /* sa proposals vectors */
 372   ikev2_sa_proposal_t *i_proposals;
 373   ikev2_sa_proposal_t *r_proposals;
 374
 375   /* keys */
 376   u8 *sk_d;
 377   u8 *sk_ai;
 378   u8 *sk_ar;
 379   u8 *sk_ei;
 380   u8 *sk_er;
 381   u8 *sk_pi;
 382   u8 *sk_pr;
 383
 384   /* auth */
 385   ikev2_auth_t i_auth;
 386   ikev2_auth_t r_auth;
 387
 388   /* ID */
 389   ikev2_id_t i_id;
 390   ikev2_id_t r_id;
 391
 392   /* pending deletes */
 393   ikev2_delete_t *del;
 394
 395   /* pending rekeyings */
 396   ikev2_rekey_t *rekey;
 397
 398   /* packet data */
 399   u8 *last_sa_init_req_packet_data;
 400   u8 *last_sa_init_res_packet_data;
 401
 402   /* retransmit */
 403   u32 last_msg_id;
 404   u8 *last_res_packet_data;
 405
 406   u8 is_initiator;
 407   u32 last_init_msg_id;
 408   u32 profile_index;
 409   u8 is_tun_itf_set;
 410   u32 tun_itf;
 411   u8 udp_encap;
 412   u16 ipsec_over_udp_port;
 413
 414   f64 old_id_expiration;
 415   u32 current_remote_id_mask;
 416   u32 old_remote_id;
 417   u8 old_remote_id_present;
 418   u8 init_response_received;
 419
 420   ikev2_child_sa_t *childs;
 421
 422   u8 liveness_retries;
 423   f64 liveness_period_check;
 424
 425   u16 dst_port;
 426   u32 sw_if_index;
 427
 428   /* is NAT traversal mode */
 429   u8 natt;
 430   u8 keys_generated;
 431 } ikev2_sa_t;
 432
 433
 434 typedef struct
 435 {
 436   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 437
 438   /* pool of IKEv2 Security Associations */
 439   ikev2_sa_t *sas;
 440
 441   /* hash */
 442   uword *sa_by_rspi;
 443
 444   EVP_CIPHER_CTX *evp_ctx;
 445   HMAC_CTX *hmac_ctx;
 446 #if OPENSSL_VERSION_NUMBER < 0x10100000L
 447   HMAC_CTX _hmac_ctx;
 448   EVP_CIPHER_CTX _evp_ctx;
 449 #endif
 450 } ikev2_main_per_thread_data_t;
 451
 452 typedef struct
 453 {
 454   /* pool of IKEv2 profiles */
 455   ikev2_profile_t *profiles;
 456
 457   /* vector of supported transform types */
 458   ikev2_sa_transform_t *supported_transforms;
 459
 460   /* hash */
 461   mhash_t profile_index_by_name;
 462
 463   /* local private key */
 464   EVP_PKEY *pkey;
 465
 466   /* convenience */
 467   vlib_main_t *vlib_main;
 468   vnet_main_t *vnet_main;
 469
 470   /* pool of IKEv2 Security Associations created in initiator mode */
 471   ikev2_sa_t *sais;
 472   /* hash */
 473   uword *sa_by_ispi;
 474
 475   ikev2_main_per_thread_data_t *per_thread_data;
 476
 477   /* interface indices managed by IKE */
 478   uword *sw_if_indices;
 479
 480   /* API message ID base */
 481   u16 msg_id_base;
 482
 483   /* log class used for main thread */
 484   vlib_log_class_t log_class;
 485
 486   /* logging level */
 487   ikev2_log_level_t log_level;
 488
 489   /* custom ipsec-over-udp ports managed by ike */
 490   uword *udp_ports;
 491
 492   /* how often a liveness check will be performed */
 493   u32 liveness_period;
 494
 495   /* max number of retries before considering peer dead */
 496   u32 liveness_max_retries;
 497 } ikev2_main_t;
 498
 499 extern ikev2_main_t ikev2_main;
 500
 501 void ikev2_sa_free_proposal_vector (ikev2_sa_proposal_t ** v);
 502 ikev2_sa_transform_t *ikev2_sa_get_td_for_type (ikev2_sa_proposal_t * p,
 503                                                 ikev2_transform_type_t type);
 504
 505 /* ikev2_crypto.c */
 506 v8 *ikev2_calc_prf (ikev2_sa_transform_t * tr, v8 * key, v8 * data);
 507 u8 *ikev2_calc_prfplus (ikev2_sa_transform_t * tr, u8 * key, u8 * seed,
 508                         int len);
 509 v8 *ikev2_calc_integr (ikev2_sa_transform_t * tr, v8 * key, u8 * data,
 510                        int len);
 511 int ikev2_decrypt_data (ikev2_main_per_thread_data_t * ptd, ikev2_sa_t * sa,
 512                         ikev2_sa_transform_t * tr_encr, u8 * data, int len,
 513                         u32 * out_len);
 514 int ikev2_encrypt_data (ikev2_main_per_thread_data_t * ptd, ikev2_sa_t * sa,
 515                         ikev2_sa_transform_t * tr_encr, v8 * src, u8 * dst);
 516 int ikev2_encrypt_aead_data (ikev2_main_per_thread_data_t * ptd,
 517                              ikev2_sa_t * sa, ikev2_sa_transform_t * tr_encr,
 518                              v8 * src, u8 * dst, u8 * aad,
 519                              u32 aad_len, u8 * tag);
 520 int ikev2_decrypt_aead_data (ikev2_main_per_thread_data_t * ptd,
 521                              ikev2_sa_t * sa, ikev2_sa_transform_t * tr_encr,
 522                              u8 * data, int data_len, u8 * aad, u32 aad_len,
 523                              u8 * tag, u32 * out_len);
 524 void ikev2_generate_dh (ikev2_sa_t * sa, ikev2_sa_transform_t * t);
 525 void ikev2_complete_dh (ikev2_sa_t * sa, ikev2_sa_transform_t * t);
 526 int ikev2_verify_sign (EVP_PKEY * pkey, u8 * sigbuf, u8 * data);
 527 u8 *ikev2_calc_sign (EVP_PKEY * pkey, u8 * data);
 528 EVP_PKEY *ikev2_load_cert_file (u8 * file);
 529 EVP_PKEY *ikev2_load_key_file (u8 * file);
 530 void ikev2_crypto_init (ikev2_main_t * km);
 531
 532 /* ikev2_payload.c */
 533 typedef struct
 534 {
 535   u8 first_payload_type;
 536   u16 last_hdr_off;
 537   u8 *data;
 538 } ikev2_payload_chain_t;
 539
 540 #define ikev2_payload_new_chain(V) vec_validate (V, 0)
 541 #define ikev2_payload_destroy_chain(V) do { \
 542   vec_free((V)->data);                 \
 543   vec_free(V);                         \
 544 } while (0)
 545
 546 void ikev2_payload_add_notify (ikev2_payload_chain_t * c, u16 msg_type,
 547                                u8 * data);
 548 void ikev2_payload_add_notify_2 (ikev2_payload_chain_t * c, u16 msg_type,
 549                                  u8 * data, ikev2_notify_t * notify);
 550 void ikev2_payload_add_sa (ikev2_payload_chain_t * c,
 551                            ikev2_sa_proposal_t * proposals);
 552 void ikev2_payload_add_ke (ikev2_payload_chain_t * c, u16 dh_group,
 553                            u8 * dh_data);
 554 void ikev2_payload_add_nonce (ikev2_payload_chain_t * c, u8 * nonce);
 555 void ikev2_payload_add_id (ikev2_payload_chain_t * c, ikev2_id_t * id,
 556                            u8 type);
 557 void ikev2_payload_add_auth (ikev2_payload_chain_t * c, ikev2_auth_t * auth);
 558 void ikev2_payload_add_ts (ikev2_payload_chain_t * c, ikev2_ts_t * ts,
 559                            u8 type);
 560 void ikev2_payload_add_delete (ikev2_payload_chain_t * c, ikev2_delete_t * d);
 561 void ikev2_payload_chain_add_padding (ikev2_payload_chain_t * c, int bs);
 562 void ikev2_parse_vendor_payload (ike_payload_header_t * ikep);
 563 ikev2_sa_proposal_t *ikev2_parse_sa_payload (ike_payload_header_t * ikep,
 564                                              u32 rlen);
 565 ikev2_ts_t *ikev2_parse_ts_payload (ike_payload_header_t * ikep, u32 rlen);
 566 ikev2_delete_t *ikev2_parse_delete_payload (ike_payload_header_t * ikep,
 567                                             u32 rlen);
 568 ikev2_notify_t *ikev2_parse_notify_payload (ike_payload_header_t * ikep,
 569                                             u32 rlen);
 570 int ikev2_set_log_level (ikev2_log_level_t log_level);
 571
 572 static_always_inline ikev2_main_per_thread_data_t *
 573 ikev2_get_per_thread_data ()
 574 {
 575   u32 thread_index = vlib_get_thread_index ();
 576   return vec_elt_at_index (ikev2_main.per_thread_data, thread_index);
 577 }
 578 #endif /* __included_ikev2_priv_h__ */
 579
 580
 581 /*
 582  * fd.io coding-style-patch-verification: ON
 583  *
 584  * Local Variables:
 585  * eval: (c-set-style "gnu")
 586  * End:
 587  */