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.
18 #include <vnet/ip/ip.h>
19 #include <vnet/crypto/crypto.h>
20 #include <vnet/ipsec/ipsec.h>
40 typedef CLIB_PACKED (struct {
43 }) ip4_and_esp_header_t;
47 typedef CLIB_PACKED (struct {
51 }) ip4_and_udp_and_esp_header_t;
55 typedef CLIB_PACKED (struct {
58 }) ip6_and_esp_header_t;
62 * AES GCM Additional Authentication data
64 typedef struct esp_aead_t_
67 * for GCM: when using ESN it's:
68 * SPI, seq-hi, seg-low
73 } __clib_packed esp_aead_t;
75 #define ESP_SEQ_MAX (4294967295UL)
76 #define ESP_MAX_BLOCK_SIZE (16)
77 #define ESP_MAX_IV_SIZE (16)
78 #define ESP_MAX_ICV_SIZE (32)
80 u8 *format_esp_header (u8 * s, va_list * args);
82 /* TODO seq increment should be atomic to be accessed by multiple workers */
84 esp_seq_advance (ipsec_sa_t * sa)
86 if (PREDICT_TRUE (ipsec_sa_is_set_USE_ESN (sa)))
88 if (PREDICT_FALSE (sa->seq == ESP_SEQ_MAX))
90 if (PREDICT_FALSE (ipsec_sa_is_set_USE_ANTI_REPLAY (sa) &&
91 sa->seq_hi == ESP_SEQ_MAX))
99 if (PREDICT_FALSE (ipsec_sa_is_set_USE_ANTI_REPLAY (sa) &&
100 sa->seq == ESP_SEQ_MAX))
109 esp_aad_fill (u8 * data, const esp_header_t * esp, const ipsec_sa_t * sa)
113 aad = (esp_aead_t *) data;
114 aad->data[0] = esp->spi;
116 if (ipsec_sa_is_set_USE_ESN (sa))
118 /* SPI, seq-hi, seq-low */
119 aad->data[1] = (u32) clib_host_to_net_u32 (sa->seq_hi);
120 aad->data[2] = esp->seq;
126 aad->data[1] = esp->seq;
131 /* Special case to drop or hand off packets for sync/async modes.
133 * Different than sync mode, async mode only enqueue drop or hand-off packets
137 esp_set_next_index (int is_async, u32 * from, u16 * nexts, u32 bi,
138 u16 * drop_index, u16 drop_next, u16 * next)
142 from[*drop_index] = bi;
143 nexts[*drop_index] = drop_next;
150 /* when submitting a frame is failed, drop all buffers in the frame */
152 esp_async_recycle_failed_submit (vnet_crypto_async_frame_t * f,
153 vlib_buffer_t ** b, u32 * from, u16 * nexts,
154 u16 * n_dropped, u16 drop_next_index,
157 u32 n_drop = f->n_elts;
158 u32 *bi = f->buffer_indices;
163 esp_set_next_index (1, from, nexts, bi[0], n_dropped, drop_next_index,
168 vnet_crypto_async_reset_frame (f);
172 * The post data structure to for esp_encrypt/decrypt_inline to write to
173 * vib_buffer_t opaque unused field, and for post nodes to pick up after
184 ipsec_sa_flags_t flags;
196 } esp_decrypt_packet_data_t;
198 STATIC_ASSERT_SIZEOF (esp_decrypt_packet_data_t, 3 * sizeof (u64));
200 /* we are forced to store the decrypt post data into 2 separate places -
201 vlib_opaque and opaque2. */
205 u32 free_buffer_index;
207 } esp_decrypt_packet_data2_t;
212 esp_decrypt_packet_data_t decrypt_data;
215 STATIC_ASSERT (sizeof (esp_post_data_t) <=
216 STRUCT_SIZE_OF (vnet_buffer_opaque_t, unused),
217 "Custom meta-data too large for vnet_buffer_opaque_t");
219 #define esp_post_data(b) \
220 ((esp_post_data_t *)((u8 *)((b)->opaque) \
221 + STRUCT_OFFSET_OF (vnet_buffer_opaque_t, unused)))
223 STATIC_ASSERT (sizeof (esp_decrypt_packet_data2_t) <=
224 STRUCT_SIZE_OF (vnet_buffer_opaque2_t, unused),
225 "Custom meta-data too large for vnet_buffer_opaque2_t");
227 #define esp_post_data2(b) \
228 ((esp_decrypt_packet_data2_t *)((u8 *)((b)->opaque2) \
229 + STRUCT_OFFSET_OF (vnet_buffer_opaque2_t, unused)))
233 /* esp post node index for async crypto */
236 u32 esp4_tun_post_next;
237 u32 esp6_tun_post_next;
238 u32 esp_mpls_tun_post_next;
239 } esp_async_post_next_t;
241 extern esp_async_post_next_t esp_encrypt_async_next;
242 extern esp_async_post_next_t esp_decrypt_async_next;
244 #endif /* __ESP_H__ */
247 * fd.io coding-style-patch-verification: ON
250 * eval: (c-set-style "gnu")