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>
21 #include <vnet/ipsec/ipsec.api_enum.h>
41 typedef CLIB_PACKED (struct {
44 }) ip4_and_esp_header_t;
48 typedef CLIB_PACKED (struct {
52 }) ip4_and_udp_and_esp_header_t;
56 typedef CLIB_PACKED (struct {
59 }) ip6_and_esp_header_t;
63 * AES counter mode nonce
69 u32 ctr; /* counter: 1 in big-endian for ctr, unused for gcm */
70 } __clib_packed esp_ctr_nonce_t;
72 STATIC_ASSERT_SIZEOF (esp_ctr_nonce_t, 16);
75 * AES GCM Additional Authentication data
77 typedef struct esp_aead_t_
80 * for GCM: when using ESN it's:
81 * SPI, seq-hi, seg-low
86 } __clib_packed esp_aead_t;
88 #define ESP_SEQ_MAX (4294967295UL)
90 u8 *format_esp_header (u8 * s, va_list * args);
92 /* TODO seq increment should be atomic to be accessed by multiple workers */
94 esp_seq_advance (ipsec_sa_t * sa)
96 if (PREDICT_TRUE (ipsec_sa_is_set_USE_ESN (sa)))
98 if (PREDICT_FALSE (sa->seq == ESP_SEQ_MAX))
100 if (PREDICT_FALSE (ipsec_sa_is_set_USE_ANTI_REPLAY (sa) &&
101 sa->seq_hi == ESP_SEQ_MAX))
109 if (PREDICT_FALSE (ipsec_sa_is_set_USE_ANTI_REPLAY (sa) &&
110 sa->seq == ESP_SEQ_MAX))
119 esp_aad_fill (u8 *data, const esp_header_t *esp, const ipsec_sa_t *sa,
124 aad = (esp_aead_t *) data;
125 aad->data[0] = esp->spi;
127 if (ipsec_sa_is_set_USE_ESN (sa))
129 /* SPI, seq-hi, seq-low */
130 aad->data[1] = (u32) clib_host_to_net_u32 (seq_hi);
131 aad->data[2] = esp->seq;
137 aad->data[1] = esp->seq;
143 esp_encrypt_err_to_sa_err (u32 err)
147 case ESP_ENCRYPT_ERROR_HANDOFF:
148 return IPSEC_SA_ERROR_HANDOFF;
149 case ESP_ENCRYPT_ERROR_SEQ_CYCLED:
150 return IPSEC_SA_ERROR_SEQ_CYCLED;
151 case ESP_ENCRYPT_ERROR_CRYPTO_ENGINE_ERROR:
152 return IPSEC_SA_ERROR_CRYPTO_ENGINE_ERROR;
153 case ESP_ENCRYPT_ERROR_CRYPTO_QUEUE_FULL:
154 return IPSEC_SA_ERROR_CRYPTO_QUEUE_FULL;
155 case ESP_ENCRYPT_ERROR_NO_BUFFERS:
156 return IPSEC_SA_ERROR_NO_BUFFERS;
157 case ESP_ENCRYPT_ERROR_NO_ENCRYPTION:
158 return IPSEC_SA_ERROR_NO_ENCRYPTION;
164 esp_decrypt_err_to_sa_err (u32 err)
168 case ESP_DECRYPT_ERROR_HANDOFF:
169 return IPSEC_SA_ERROR_HANDOFF;
170 case ESP_DECRYPT_ERROR_DECRYPTION_FAILED:
171 return IPSEC_SA_ERROR_DECRYPTION_FAILED;
172 case ESP_DECRYPT_ERROR_INTEG_ERROR:
173 return IPSEC_SA_ERROR_INTEG_ERROR;
174 case ESP_DECRYPT_ERROR_CRYPTO_ENGINE_ERROR:
175 return IPSEC_SA_ERROR_CRYPTO_ENGINE_ERROR;
176 case ESP_DECRYPT_ERROR_REPLAY:
177 return IPSEC_SA_ERROR_REPLAY;
178 case ESP_DECRYPT_ERROR_RUNT:
179 return IPSEC_SA_ERROR_RUNT;
180 case ESP_DECRYPT_ERROR_NO_BUFFERS:
181 return IPSEC_SA_ERROR_NO_BUFFERS;
182 case ESP_DECRYPT_ERROR_OVERSIZED_HEADER:
183 return IPSEC_SA_ERROR_OVERSIZED_HEADER;
184 case ESP_DECRYPT_ERROR_NO_TAIL_SPACE:
185 return IPSEC_SA_ERROR_NO_TAIL_SPACE;
186 case ESP_DECRYPT_ERROR_TUN_NO_PROTO:
187 return IPSEC_SA_ERROR_TUN_NO_PROTO;
188 case ESP_DECRYPT_ERROR_UNSUP_PAYLOAD:
189 return IPSEC_SA_ERROR_UNSUP_PAYLOAD;
195 esp_encrypt_set_next_index (vlib_buffer_t *b, vlib_node_runtime_t *node,
196 u32 thread_index, u32 err, u16 index, u16 *nexts,
197 u16 drop_next, u32 sa_index)
199 ipsec_set_next_index (b, node, thread_index, err,
200 esp_encrypt_err_to_sa_err (err), index, nexts,
201 drop_next, sa_index);
205 esp_decrypt_set_next_index (vlib_buffer_t *b, vlib_node_runtime_t *node,
206 u32 thread_index, u32 err, u16 index, u16 *nexts,
207 u16 drop_next, u32 sa_index)
209 ipsec_set_next_index (b, node, thread_index, err,
210 esp_decrypt_err_to_sa_err (err), index, nexts,
211 drop_next, sa_index);
215 * The post data structure to for esp_encrypt/decrypt_inline to write to
216 * vib_buffer_t opaque unused field, and for post nodes to pick up after
227 ipsec_sa_flags_t flags;
239 } esp_decrypt_packet_data_t;
241 STATIC_ASSERT_SIZEOF (esp_decrypt_packet_data_t, 3 * sizeof (u64));
242 STATIC_ASSERT_OFFSET_OF (esp_decrypt_packet_data_t, seq, sizeof (u64));
244 /* we are forced to store the decrypt post data into 2 separate places -
245 vlib_opaque and opaque2. */
249 u32 free_buffer_index;
251 } esp_decrypt_packet_data2_t;
256 esp_decrypt_packet_data_t decrypt_data;
259 STATIC_ASSERT (sizeof (esp_post_data_t) <=
260 STRUCT_SIZE_OF (vnet_buffer_opaque_t, unused),
261 "Custom meta-data too large for vnet_buffer_opaque_t");
263 #define esp_post_data(b) \
264 ((esp_post_data_t *)((u8 *)((b)->opaque) \
265 + STRUCT_OFFSET_OF (vnet_buffer_opaque_t, unused)))
267 STATIC_ASSERT (sizeof (esp_decrypt_packet_data2_t) <=
268 STRUCT_SIZE_OF (vnet_buffer_opaque2_t, unused),
269 "Custom meta-data too large for vnet_buffer_opaque2_t");
271 #define esp_post_data2(b) \
272 ((esp_decrypt_packet_data2_t *)((u8 *)((b)->opaque2) \
273 + STRUCT_OFFSET_OF (vnet_buffer_opaque2_t, unused)))
277 /* esp post node index for async crypto */
280 u32 esp4_tun_post_next;
281 u32 esp6_tun_post_next;
282 u32 esp_mpls_tun_post_next;
283 } esp_async_post_next_t;
285 extern esp_async_post_next_t esp_encrypt_async_next;
286 extern esp_async_post_next_t esp_decrypt_async_next;
288 /* when submitting a frame is failed, drop all buffers in the frame */
290 esp_async_recycle_failed_submit (vlib_main_t *vm, vnet_crypto_async_frame_t *f,
291 vlib_node_runtime_t *node, u32 err,
292 u32 ipsec_sa_err, u16 index, u32 *from,
293 u16 *nexts, u16 drop_next_index,
297 u32 n_drop = f->n_elts;
298 u32 *bi = f->buffer_indices;
305 b = vlib_get_buffer (vm, bi[0]);
309 sa_index = vnet_buffer (b)->ipsec.sad_index;
313 sa_index = esp_post_data (b)->decrypt_data.sa_index;
316 ipsec_set_next_index (b, node, vm->thread_index, err, ipsec_sa_err,
317 index, nexts, drop_next_index, sa_index);
325 #endif /* __ESP_H__ */
328 * fd.io coding-style-patch-verification: ON
331 * eval: (c-set-style "gnu")