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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
15 #ifndef __included_ikev2_priv_h__
16 #define __included_ikev2_priv_h__
18 #include <vnet/vnet.h>
19 #include <vnet/ip/ip.h>
20 #include <vnet/ethernet/ethernet.h>
22 #include <plugins/ikev2/ikev2.h>
24 #include <vppinfra/hash.h>
25 #include <vppinfra/elog.h>
26 #include <vppinfra/error.h>
28 #include <openssl/rand.h>
29 #include <openssl/dh.h>
30 #include <openssl/hmac.h>
31 #include <openssl/evp.h>
33 #define foreach_ikev2_log_level \
36 _(0x02, LOG_WARNING) \
42 typedef enum ikev2_log_level_t_
44 #define _(n,f) IKEV2_##f = n,
45 foreach_ikev2_log_level
50 /* dataplane logging */
51 #define _ikev2_elog(_level, _msg) \
53 ikev2_main_t *km = &ikev2_main; \
54 if (PREDICT_FALSE (km->log_level >= _level)) \
56 ELOG_TYPE_DECLARE (e) = \
58 .format = "ikev2 " _msg, \
61 ELOG_DATA (&vlib_global_main.elog_main, e); \
65 #define ikev2_elog_sa_state(_format, _ispi) \
67 ikev2_main_t *km = &ikev2_main; \
68 if (PREDICT_FALSE (km->log_level >= IKEV2_LOG_DEBUG)) \
70 ELOG_TYPE_DECLARE (e) = \
72 .format = "ikev2: " _format, \
73 .format_args = "i8", \
79 ed = ELOG_DATA (&vlib_global_main.elog_main, e); \
84 #define ikev2_elog_exchange_internal(_format, _ispi, _rspi, _addr) \
86 ikev2_main_t *km = &ikev2_main; \
87 if (PREDICT_FALSE (km->log_level >= IKEV2_LOG_DEBUG)) \
89 ELOG_TYPE_DECLARE (e) = \
91 .format = "ikev2: " _format, \
92 .format_args = "i8i8i1i1i1i1", \
103 ed = ELOG_DATA (&vlib_global_main.elog_main, e); \
106 ed->oct4 = (_addr) >> 24; \
107 ed->oct3 = (_addr) >> 16; \
108 ed->oct2 = (_addr) >> 8; \
109 ed->oct1 = (_addr); \
113 #define IKE_ELOG_IP4_FMT "%d.%d.%d.%d"
114 #define IKE_ELOG_IP6_FMT "[v6]:%x%x:%x%x"
116 #define ikev2_elog_exchange(_fmt, _ispi, _rspi, _addr, _v4) \
119 ikev2_elog_exchange_internal (_fmt IKE_ELOG_IP4_FMT, _ispi, _rspi, _addr);\
121 ikev2_elog_exchange_internal (_fmt IKE_ELOG_IP6_FMT, _ispi, _rspi, _addr);\
124 #define ikev2_elog_uint(_level, _format, _val) \
126 ikev2_main_t *km = &ikev2_main; \
127 if (PREDICT_FALSE (km->log_level >= _level)) \
129 ELOG_TYPE_DECLARE (e) = \
131 .format = "ikev2: " _format, \
132 .format_args = "i8", \
138 ed = ELOG_DATA (&vlib_global_main.elog_main, e); \
143 #define ikev2_elog_uint_peers(_level, _format, _val, _ip1, _ip2) \
145 ikev2_main_t *km = &ikev2_main; \
146 if (PREDICT_FALSE (km->log_level >= _level)) \
148 ELOG_TYPE_DECLARE (e) = \
150 .format = "ikev2: " _format, \
151 .format_args = "i8i1i1i1i1i1i1i1i1", \
153 CLIB_PACKED(struct { \
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); \
159 ed->i14 = (_ip1) >> 24; \
160 ed->i13 = (_ip1) >> 16; \
161 ed->i12 = (_ip1) >> 8; \
163 ed->i24 = (_ip2) >> 24; \
164 ed->i23 = (_ip2) >> 16; \
165 ed->i22 = (_ip2) >> 8; \
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)
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__)
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,
201 ikev2_auth_method_t method:8;
203 u8 hex; /* hex encoding of the shared secret */
209 IKEV2_DH_GROUP_MODP = 0,
210 IKEV2_DH_GROUP_ECP = 1,
215 ikev2_transform_type_t type;
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;
235 } ikev2_sa_transform_t;
240 ikev2_protocol_id_t protocol_id:8;
242 ikev2_sa_transform_t *transforms;
243 } ikev2_sa_proposal_t;
247 ikev2_traffic_selector_type_t ts_type;
252 ip_address_t start_addr;
253 ip_address_t end_addr;
266 ikev2_transform_encr_type_t crypto_alg;
267 ikev2_transform_integ_type_t integ_alg;
268 ikev2_transform_dh_type_t dh_type;
270 } ikev2_transforms_set;
275 ikev2_id_type_t type:8;
281 /* sa proposals vectors */
282 ikev2_sa_proposal_t *i_proposals;
283 ikev2_sa_proposal_t *r_proposals;
285 /* Traffic Selectors */
302 f64 time_to_expiration;
310 u32 spi; /*for ESP and AH SPI size is 4, for IKE size is 0 */
318 ikev2_sa_proposal_t *i_proposal;
319 ikev2_sa_proposal_t *r_proposal;
341 ikev2_responder_t responder;
342 ikev2_transforms_set ike_ts;
343 ikev2_transforms_set esp_ts;
345 u64 lifetime_maxdata;
348 u16 ipsec_over_udp_port;
357 /* SA will switch to port 4500 when NAT is detected.
358 * This is the default. */
361 /* Do nothing when NAT is detected */
364 /* NAT was detected and port switched to 4500 */
366 } ikev2_natt_state_t;
368 #define ikev2_natt_active(_sa) ((_sa)->natt_state == IKEV2_NATT_ACTIVE)
376 u16 n_init_retransmit;
399 /* sa proposals vectors */
400 ikev2_sa_proposal_t *i_proposals;
401 ikev2_sa_proposal_t *r_proposals;
420 /* pending deletes */
423 /* pending rekeyings */
424 ikev2_rekey_t *rekey;
426 ikev2_rekey_t *new_child;
429 u8 *last_sa_init_req_packet_data;
430 u8 *last_sa_init_res_packet_data;
433 /* message id expected in the request from the other peer */
435 u8 *last_res_packet_data;
438 /* last message id that was used for an initiated request */
439 u32 last_init_msg_id;
444 u16 ipsec_over_udp_port;
446 f64 old_id_expiration;
447 u32 current_remote_id_mask;
449 u8 old_remote_id_present;
450 u8 init_response_received;
452 ikev2_child_sa_t *childs;
455 f64 liveness_period_check;
460 /* is NAT traversal mode */
461 ikev2_natt_state_t natt_state;
470 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
472 /* pool of IKEv2 Security Associations */
478 EVP_CIPHER_CTX *evp_ctx;
480 #if OPENSSL_VERSION_NUMBER < 0x10100000L
482 EVP_CIPHER_CTX _evp_ctx;
484 } ikev2_main_per_thread_data_t;
488 /* pool of IKEv2 profiles */
489 ikev2_profile_t *profiles;
491 /* vector of supported transform types */
492 ikev2_sa_transform_t *supported_transforms;
495 mhash_t profile_index_by_name;
497 /* local private key */
501 vlib_main_t *vlib_main;
502 vnet_main_t *vnet_main;
504 /* pool of IKEv2 Security Associations created in initiator mode */
509 ikev2_main_per_thread_data_t *per_thread_data;
511 /* interface indices managed by IKE */
512 uword *sw_if_indices;
514 /* API message ID base */
517 /* log class used for main thread */
518 vlib_log_class_t log_class;
521 ikev2_log_level_t log_level;
523 /* how often a liveness check will be performed */
526 /* max number of retries before considering peer dead */
527 u32 liveness_max_retries;
529 /* dead peer detection */
532 /* pointer to name resolver function in dns plugin */
533 int (*dns_resolve_name) ();
535 /* flag indicating whether lazy init is done or not */
538 /* refcount for IKEv2 udp ports and IPsec NATT punt registration */
541 /* punt handle for IPsec NATT IPSEC_PUNT_IP4_SPI_UDP_0 reason */
542 vlib_punt_hdl_t punt_hdl;
546 extern ikev2_main_t ikev2_main;
548 void ikev2_sa_free_proposal_vector (ikev2_sa_proposal_t ** v);
549 ikev2_sa_transform_t *ikev2_sa_get_td_for_type (ikev2_sa_proposal_t * p,
550 ikev2_transform_type_t type);
553 v8 *ikev2_calc_prf (ikev2_sa_transform_t * tr, v8 * key, v8 * data);
554 u8 *ikev2_calc_prfplus (ikev2_sa_transform_t * tr, u8 * key, u8 * seed,
556 v8 *ikev2_calc_integr (ikev2_sa_transform_t * tr, v8 * key, u8 * data,
558 int ikev2_decrypt_data (ikev2_main_per_thread_data_t * ptd, ikev2_sa_t * sa,
559 ikev2_sa_transform_t * tr_encr, u8 * data, int len,
561 int ikev2_encrypt_data (ikev2_main_per_thread_data_t * ptd, ikev2_sa_t * sa,
562 ikev2_sa_transform_t * tr_encr, v8 * src, u8 * dst);
563 int ikev2_encrypt_aead_data (ikev2_main_per_thread_data_t * ptd,
564 ikev2_sa_t * sa, ikev2_sa_transform_t * tr_encr,
565 v8 * src, u8 * dst, u8 * aad,
566 u32 aad_len, u8 * tag);
567 int ikev2_decrypt_aead_data (ikev2_main_per_thread_data_t * ptd,
568 ikev2_sa_t * sa, ikev2_sa_transform_t * tr_encr,
569 u8 * data, int data_len, u8 * aad, u32 aad_len,
570 u8 * tag, u32 * out_len);
571 void ikev2_generate_dh (ikev2_sa_t * sa, ikev2_sa_transform_t * t);
572 void ikev2_complete_dh (ikev2_sa_t * sa, ikev2_sa_transform_t * t);
573 int ikev2_verify_sign (EVP_PKEY * pkey, u8 * sigbuf, u8 * data);
574 u8 *ikev2_calc_sign (EVP_PKEY * pkey, u8 * data);
575 EVP_PKEY *ikev2_load_cert_file (u8 * file);
576 EVP_PKEY *ikev2_load_key_file (u8 * file);
577 void ikev2_crypto_init (ikev2_main_t * km);
579 /* ikev2_payload.c */
582 u8 first_payload_type;
585 } ikev2_payload_chain_t;
587 #define ikev2_payload_new_chain(V) vec_validate (V, 0)
588 #define ikev2_payload_destroy_chain(V) do { \
589 vec_free((V)->data); \
593 void ikev2_payload_add_notify (ikev2_payload_chain_t * c, u16 msg_type,
595 void ikev2_payload_add_notify_2 (ikev2_payload_chain_t * c, u16 msg_type,
596 u8 * data, ikev2_notify_t * notify);
597 void ikev2_payload_add_sa (ikev2_payload_chain_t * c,
598 ikev2_sa_proposal_t * proposals);
599 void ikev2_payload_add_ke (ikev2_payload_chain_t * c, u16 dh_group,
601 void ikev2_payload_add_nonce (ikev2_payload_chain_t * c, u8 * nonce);
602 void ikev2_payload_add_id (ikev2_payload_chain_t * c, ikev2_id_t * id,
604 void ikev2_payload_add_auth (ikev2_payload_chain_t * c, ikev2_auth_t * auth);
605 void ikev2_payload_add_ts (ikev2_payload_chain_t * c, ikev2_ts_t * ts,
607 void ikev2_payload_add_delete (ikev2_payload_chain_t * c, ikev2_delete_t * d);
608 void ikev2_payload_chain_add_padding (ikev2_payload_chain_t * c, int bs);
609 void ikev2_parse_vendor_payload (ike_payload_header_t * ikep);
610 ikev2_sa_proposal_t *ikev2_parse_sa_payload (ike_payload_header_t * ikep,
612 ikev2_ts_t *ikev2_parse_ts_payload (ike_payload_header_t * ikep, u32 rlen);
613 ikev2_delete_t *ikev2_parse_delete_payload (ike_payload_header_t * ikep,
615 ikev2_notify_t *ikev2_parse_notify_payload (ike_payload_header_t * ikep,
617 int ikev2_set_log_level (ikev2_log_level_t log_level);
618 u8 *ikev2_find_ike_notify_payload (ike_header_t * ike, u32 msg_type);
619 void ikev2_disable_dpd (void);
620 clib_error_t *ikev2_profile_natt_disable (u8 * name);
622 static_always_inline ikev2_main_per_thread_data_t *
623 ikev2_get_per_thread_data ()
625 u32 thread_index = vlib_get_thread_index ();
626 return vec_elt_at_index (ikev2_main.per_thread_data, thread_index);
628 #endif /* __included_ikev2_priv_h__ */
632 * fd.io coding-style-patch-verification: ON
635 * eval: (c-set-style "gnu")