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(_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 ikev2_elog_uint(_level, _format, _val) \
115 ikev2_main_t *km = &ikev2_main; \
116 if (PREDICT_FALSE (km->log_level >= _level)) \
118 ELOG_TYPE_DECLARE (e) = \
120 .format = "ikev2: " _format, \
121 .format_args = "i8", \
127 ed = ELOG_DATA (&vlib_global_main.elog_main, e); \
132 #define ikev2_elog_uint_peers(_level, _format, _val, _ip1, _ip2) \
134 ikev2_main_t *km = &ikev2_main; \
135 if (PREDICT_FALSE (km->log_level >= _level)) \
137 ELOG_TYPE_DECLARE (e) = \
139 .format = "ikev2: " _format, \
140 .format_args = "i8i1i1i1i1i1i1i1i1", \
142 CLIB_PACKED(struct { \
144 u8 i11; u8 i12; u8 i13; u8 i14; \
145 u8 i21; u8 i22; u8 i23; u8 i24; }) *ed; \
146 ed = ELOG_DATA (&vlib_global_main.elog_main, e); \
148 ed->i14 = (_ip1) >> 24; \
149 ed->i13 = (_ip1) >> 16; \
150 ed->i12 = (_ip1) >> 8; \
152 ed->i24 = (_ip2) >> 24; \
153 ed->i23 = (_ip2) >> 16; \
154 ed->i22 = (_ip2) >> 8; \
159 #define ikev2_elog_peers(_level, _format, _ip1, _ip2) \
161 ikev2_main_t *km = &ikev2_main; \
162 if (PREDICT_FALSE (km->log_level >= _level)) \
164 ELOG_TYPE_DECLARE (e) = \
166 .format = "ikev2: " _format, \
167 .format_args = "i1i1i1i1i1i1i1i1", \
169 CLIB_PACKED(struct { \
170 u8 i11; u8 i12; u8 i13; u8 i14; \
171 u8 i21; u8 i22; u8 i23; u8 i24; }) *ed; \
172 ed = ELOG_DATA (&vlib_global_main.elog_main, e); \
173 ed->i14 = (_ip1) >> 24; \
174 ed->i13 = (_ip1) >> 16; \
175 ed->i12 = (_ip1) >> 8; \
177 ed->i24 = (_ip2) >> 24; \
178 ed->i23 = (_ip2) >> 16; \
179 ed->i22 = (_ip2) >> 8; \
184 #define ikev2_elog_error(_msg) \
185 _ikev2_elog(IKEV2_LOG_ERROR, "[error] " _msg)
186 #define ikev2_elog_warning(_msg) \
187 _ikev2_elog(IKEV2_LOG_WARNING, "[warning] " _msg)
188 #define ikev2_elog_debug(_msg) \
189 _ikev2_elog(IKEV2_LOG_DEBUG, "[debug] " _msg)
190 #define ikev2_elog_detail(_msg) \
191 _ikev2_elog(IKEV2_LOG_DETAIL, "[detail] " _msg)
193 /* logging for main thread */
194 #define ikev2_log_error(...) \
195 vlib_log(VLIB_LOG_LEVEL_ERR, ikev2_main.log_class, __VA_ARGS__)
196 #define ikev2_log_warning(...) \
197 vlib_log(VLIB_LOG_LEVEL_WARNING, ikev2_main.log_class, __VA_ARGS__)
198 #define ikev2_log_debug(...) \
199 vlib_log(VLIB_LOG_LEVEL_DEBUG, ikev2_main.log_class, __VA_ARGS__)
206 IKEV2_STATE_AUTH_FAILED,
207 IKEV2_STATE_AUTHENTICATED,
208 IKEV2_STATE_NOTIFY_AND_DELETE,
209 IKEV2_STATE_TS_UNACCEPTABLE,
210 IKEV2_STATE_NO_PROPOSAL_CHOSEN,
215 ikev2_auth_method_t method:8;
217 u8 hex; /* hex encoding of the shared secret */
223 IKEV2_DH_GROUP_MODP = 0,
224 IKEV2_DH_GROUP_ECP = 1,
229 ikev2_transform_type_t type;
233 ikev2_transform_encr_type_t encr_type:16;
234 ikev2_transform_prf_type_t prf_type:16;
235 ikev2_transform_integ_type_t integ_type:16;
236 ikev2_transform_dh_type_t dh_type:16;
237 ikev2_transform_esn_type_t esn_type:16;
249 } ikev2_sa_transform_t;
254 ikev2_protocol_id_t protocol_id:8;
256 ikev2_sa_transform_t *transforms;
257 } ikev2_sa_proposal_t;
266 ip4_address_t start_addr;
267 ip4_address_t end_addr;
278 ikev2_transform_encr_type_t crypto_alg;
279 ikev2_transform_integ_type_t integ_alg;
280 ikev2_transform_dh_type_t dh_type;
282 } ikev2_transforms_set;
287 ikev2_id_type_t type:8;
293 /* sa proposals vectors */
294 ikev2_sa_proposal_t *i_proposals;
295 ikev2_sa_proposal_t *r_proposals;
297 /* Traffic Selectors */
314 f64 time_to_expiration;
322 u32 spi; /*for ESP and AH SPI size is 4, for IKE size is 0 */
330 ikev2_sa_proposal_t *i_proposal;
331 ikev2_sa_proposal_t *r_proposal;
353 ikev2_responder_t responder;
354 ikev2_transforms_set ike_ts;
355 ikev2_transforms_set esp_ts;
357 u64 lifetime_maxdata;
360 u16 ipsec_over_udp_port;
385 /* sa proposals vectors */
386 ikev2_sa_proposal_t *i_proposals;
387 ikev2_sa_proposal_t *r_proposals;
406 /* pending deletes */
409 /* pending rekeyings */
410 ikev2_rekey_t *rekey;
413 u8 *last_sa_init_req_packet_data;
414 u8 *last_sa_init_res_packet_data;
418 u8 *last_res_packet_data;
421 u32 last_init_msg_id;
426 u16 ipsec_over_udp_port;
428 f64 old_id_expiration;
429 u32 current_remote_id_mask;
431 u8 old_remote_id_present;
432 u8 init_response_received;
434 ikev2_child_sa_t *childs;
437 f64 liveness_period_check;
442 /* is NAT traversal mode */
450 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
452 /* pool of IKEv2 Security Associations */
458 EVP_CIPHER_CTX *evp_ctx;
460 #if OPENSSL_VERSION_NUMBER < 0x10100000L
462 EVP_CIPHER_CTX _evp_ctx;
464 } ikev2_main_per_thread_data_t;
468 /* pool of IKEv2 profiles */
469 ikev2_profile_t *profiles;
471 /* vector of supported transform types */
472 ikev2_sa_transform_t *supported_transforms;
475 mhash_t profile_index_by_name;
477 /* local private key */
481 vlib_main_t *vlib_main;
482 vnet_main_t *vnet_main;
484 /* pool of IKEv2 Security Associations created in initiator mode */
489 ikev2_main_per_thread_data_t *per_thread_data;
491 /* interface indices managed by IKE */
492 uword *sw_if_indices;
494 /* API message ID base */
497 /* log class used for main thread */
498 vlib_log_class_t log_class;
501 ikev2_log_level_t log_level;
503 /* custom ipsec-over-udp ports managed by ike */
506 /* how often a liveness check will be performed */
509 /* max number of retries before considering peer dead */
510 u32 liveness_max_retries;
513 extern ikev2_main_t ikev2_main;
515 void ikev2_sa_free_proposal_vector (ikev2_sa_proposal_t ** v);
516 ikev2_sa_transform_t *ikev2_sa_get_td_for_type (ikev2_sa_proposal_t * p,
517 ikev2_transform_type_t type);
520 v8 *ikev2_calc_prf (ikev2_sa_transform_t * tr, v8 * key, v8 * data);
521 u8 *ikev2_calc_prfplus (ikev2_sa_transform_t * tr, u8 * key, u8 * seed,
523 v8 *ikev2_calc_integr (ikev2_sa_transform_t * tr, v8 * key, u8 * data,
525 v8 *ikev2_decrypt_data (ikev2_main_per_thread_data_t * ptd, ikev2_sa_t * sa,
526 ikev2_sa_transform_t * tr_encr, u8 * data, int len);
527 int ikev2_encrypt_data (ikev2_main_per_thread_data_t * ptd, ikev2_sa_t * sa,
528 ikev2_sa_transform_t * tr_encr, v8 * src, u8 * dst);
529 int ikev2_encrypt_aead_data (ikev2_main_per_thread_data_t * ptd,
530 ikev2_sa_t * sa, ikev2_sa_transform_t * tr_encr,
531 v8 * src, u8 * dst, u8 * aad,
532 u32 aad_len, u8 * tag);
533 u8 *ikev2_decrypt_aead_data (ikev2_main_per_thread_data_t * ptd,
534 ikev2_sa_t * sa, ikev2_sa_transform_t * tr_encr,
535 u8 * data, int data_len, u8 * aad, u32 aad_len,
537 void ikev2_generate_dh (ikev2_sa_t * sa, ikev2_sa_transform_t * t);
538 void ikev2_complete_dh (ikev2_sa_t * sa, ikev2_sa_transform_t * t);
539 int ikev2_verify_sign (EVP_PKEY * pkey, u8 * sigbuf, u8 * data);
540 u8 *ikev2_calc_sign (EVP_PKEY * pkey, u8 * data);
541 EVP_PKEY *ikev2_load_cert_file (u8 * file);
542 EVP_PKEY *ikev2_load_key_file (u8 * file);
543 void ikev2_crypto_init (ikev2_main_t * km);
545 /* ikev2_payload.c */
548 u8 first_payload_type;
551 } ikev2_payload_chain_t;
553 #define ikev2_payload_new_chain(V) vec_validate (V, 0)
554 #define ikev2_payload_destroy_chain(V) do { \
555 vec_free((V)->data); \
559 void ikev2_payload_add_notify (ikev2_payload_chain_t * c, u16 msg_type,
561 void ikev2_payload_add_notify_2 (ikev2_payload_chain_t * c, u16 msg_type,
562 u8 * data, ikev2_notify_t * notify);
563 void ikev2_payload_add_sa (ikev2_payload_chain_t * c,
564 ikev2_sa_proposal_t * proposals);
565 void ikev2_payload_add_ke (ikev2_payload_chain_t * c, u16 dh_group,
567 void ikev2_payload_add_nonce (ikev2_payload_chain_t * c, u8 * nonce);
568 void ikev2_payload_add_id (ikev2_payload_chain_t * c, ikev2_id_t * id,
570 void ikev2_payload_add_auth (ikev2_payload_chain_t * c, ikev2_auth_t * auth);
571 void ikev2_payload_add_ts (ikev2_payload_chain_t * c, ikev2_ts_t * ts,
573 void ikev2_payload_add_delete (ikev2_payload_chain_t * c, ikev2_delete_t * d);
574 void ikev2_payload_chain_add_padding (ikev2_payload_chain_t * c, int bs);
575 void ikev2_parse_vendor_payload (ike_payload_header_t * ikep);
576 ikev2_sa_proposal_t *ikev2_parse_sa_payload (ike_payload_header_t * ikep);
577 ikev2_ts_t *ikev2_parse_ts_payload (ike_payload_header_t * ikep);
578 ikev2_delete_t *ikev2_parse_delete_payload (ike_payload_header_t * ikep);
579 ikev2_notify_t *ikev2_parse_notify_payload (ike_payload_header_t * ikep);
580 int ikev2_set_log_level (ikev2_log_level_t log_level);
582 static_always_inline ikev2_main_per_thread_data_t *
583 ikev2_get_per_thread_data ()
585 u32 thread_index = vlib_get_thread_index ();
586 return vec_elt_at_index (ikev2_main.per_thread_data, thread_index);
588 #endif /* __included_ikev2_priv_h__ */
592 * fd.io coding-style-patch-verification: ON
595 * eval: (c-set-style "gnu")