2 * ipsecmb.c - Intel IPSec Multi-buffer library Crypto Engine
4 * Copyright (c) 2019 Cisco Systemss
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
20 #include <intel-ipsec-mb.h>
22 #include <vnet/vnet.h>
23 #include <vnet/plugin/plugin.h>
24 #include <vpp/app/version.h>
25 #include <vnet/crypto/crypto.h>
26 #include <vppinfra/cpu.h>
28 #define HMAC_MAX_BLOCK_SIZE SHA_512_BLOCK_SIZE
29 #define EXPANDED_KEY_N_BYTES (16 * 15)
33 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
36 } ipsecmb_per_thread_data_t;
42 aes_gcm_pre_t aes_gcm_pre;
44 hash_one_block_t hash_one_block;
48 typedef struct ipsecmb_main_t_
50 ipsecmb_per_thread_data_t *per_thread_data;
51 ipsecmb_alg_data_t alg_data[VNET_CRYPTO_N_ALGS];
57 u8 enc_key_exp[EXPANDED_KEY_N_BYTES];
58 u8 dec_key_exp[EXPANDED_KEY_N_BYTES];
59 } ipsecmb_aes_key_data_t;
61 static ipsecmb_main_t ipsecmb_main = { };
64 * (Alg, JOB_HASH_ALG, fn, block-size-bytes, hash-size-bytes, digest-size-bytes)
66 #define foreach_ipsecmb_hmac_op \
67 _(SHA1, SHA1, sha1, 64, 20, 20) \
68 _(SHA224, SHA_224, sha224, 64, 32, 28) \
69 _(SHA256, SHA_256, sha256, 64, 32, 32) \
70 _(SHA384, SHA_384, sha384, 128, 64, 48) \
71 _(SHA512, SHA_512, sha512, 128, 64, 64)
74 * (Alg, key-len-bits, JOB_CIPHER_MODE)
76 #define foreach_ipsecmb_cipher_op \
77 _ (AES_128_CBC, 128, CBC) \
78 _ (AES_192_CBC, 192, CBC) \
79 _ (AES_256_CBC, 256, CBC) \
80 _ (AES_128_CTR, 128, CNTR) \
81 _ (AES_192_CTR, 192, CNTR) \
82 _ (AES_256_CTR, 256, CNTR)
85 * (Alg, key-len-bytes, iv-len-bytes)
87 #define foreach_ipsecmb_gcm_cipher_op \
92 static_always_inline vnet_crypto_op_status_t
93 ipsecmb_status_job (JOB_STS status)
98 return VNET_CRYPTO_OP_STATUS_COMPLETED;
99 case STS_BEING_PROCESSED:
100 case STS_COMPLETED_AES:
101 case STS_COMPLETED_HMAC:
102 return VNET_CRYPTO_OP_STATUS_WORK_IN_PROGRESS;
103 case STS_INVALID_ARGS:
104 case STS_INTERNAL_ERROR:
106 return VNET_CRYPTO_OP_STATUS_FAIL_ENGINE_ERR;
109 return VNET_CRYPTO_OP_STATUS_FAIL_ENGINE_ERR;
113 ipsecmb_retire_hmac_job (JOB_AES_HMAC * job, u32 * n_fail, u32 digest_size)
115 vnet_crypto_op_t *op = job->user_data;
116 u32 len = op->digest_len ? op->digest_len : digest_size;
118 if (PREDICT_FALSE (STS_COMPLETED != job->status))
120 op->status = ipsecmb_status_job (job->status);
121 *n_fail = *n_fail + 1;
125 if (op->flags & VNET_CRYPTO_OP_FLAG_HMAC_CHECK)
127 if ((memcmp (op->digest, job->auth_tag_output, len)))
129 *n_fail = *n_fail + 1;
130 op->status = VNET_CRYPTO_OP_STATUS_FAIL_BAD_HMAC;
134 else if (len == digest_size)
135 clib_memcpy_fast (op->digest, job->auth_tag_output, digest_size);
137 clib_memcpy_fast (op->digest, job->auth_tag_output, len);
139 op->status = VNET_CRYPTO_OP_STATUS_COMPLETED;
142 static_always_inline u32
143 ipsecmb_ops_hmac_inline (vlib_main_t * vm, vnet_crypto_op_t * ops[],
144 u32 n_ops, u32 block_size, u32 hash_size,
145 u32 digest_size, JOB_HASH_ALG alg)
147 ipsecmb_main_t *imbm = &ipsecmb_main;
148 ipsecmb_per_thread_data_t *ptd = vec_elt_at_index (imbm->per_thread_data,
152 u8 scratch[n_ops][digest_size];
155 * queue all the jobs first ...
157 for (i = 0; i < n_ops; i++)
159 vnet_crypto_op_t *op = ops[i];
160 u8 *kd = (u8 *) imbm->key_data[op->key_index];
162 job = IMB_GET_NEXT_JOB (ptd->mgr);
165 job->hash_start_src_offset_in_bytes = 0;
166 job->msg_len_to_hash_in_bytes = op->len;
168 job->auth_tag_output_len_in_bytes = digest_size;
169 job->auth_tag_output = scratch[i];
171 job->cipher_mode = NULL_CIPHER;
172 job->cipher_direction = DECRYPT;
173 job->chain_order = HASH_CIPHER;
175 job->u.HMAC._hashed_auth_key_xor_ipad = kd;
176 job->u.HMAC._hashed_auth_key_xor_opad = kd + hash_size;
179 job = IMB_SUBMIT_JOB (ptd->mgr);
182 ipsecmb_retire_hmac_job (job, &n_fail, digest_size);
185 while ((job = IMB_FLUSH_JOB (ptd->mgr)))
186 ipsecmb_retire_hmac_job (job, &n_fail, digest_size);
188 return n_ops - n_fail;
191 #define _(a, b, c, d, e, f) \
192 static_always_inline u32 \
193 ipsecmb_ops_hmac_##a (vlib_main_t * vm, \
194 vnet_crypto_op_t * ops[], \
196 { return ipsecmb_ops_hmac_inline (vm, ops, n_ops, d, e, f, b); } \
198 foreach_ipsecmb_hmac_op;
202 ipsecmb_retire_cipher_job (JOB_AES_HMAC * job, u32 * n_fail)
204 vnet_crypto_op_t *op = job->user_data;
206 if (PREDICT_FALSE (STS_COMPLETED != job->status))
208 op->status = ipsecmb_status_job (job->status);
209 *n_fail = *n_fail + 1;
212 op->status = VNET_CRYPTO_OP_STATUS_COMPLETED;
215 static_always_inline u32
216 ipsecmb_ops_aes_cipher_inline (vlib_main_t *vm, vnet_crypto_op_t *ops[],
217 u32 n_ops, u32 key_len,
218 JOB_CIPHER_DIRECTION direction,
219 JOB_CIPHER_MODE cipher_mode)
221 ipsecmb_main_t *imbm = &ipsecmb_main;
222 ipsecmb_per_thread_data_t *ptd = vec_elt_at_index (imbm->per_thread_data,
227 for (i = 0; i < n_ops; i++)
229 ipsecmb_aes_key_data_t *kd;
230 vnet_crypto_op_t *op = ops[i];
231 kd = (ipsecmb_aes_key_data_t *) imbm->key_data[op->key_index];
234 job = IMB_GET_NEXT_JOB (ptd->mgr);
238 job->msg_len_to_cipher_in_bytes = op->len;
239 job->cipher_start_src_offset_in_bytes = 0;
241 job->hash_alg = NULL_HASH;
242 job->cipher_mode = cipher_mode;
243 job->cipher_direction = direction;
244 job->chain_order = (direction == ENCRYPT ? CIPHER_HASH : HASH_CIPHER);
246 if ((direction == ENCRYPT) && (op->flags & VNET_CRYPTO_OP_FLAG_INIT_IV))
249 _mm_storeu_si128 ((__m128i *) op->iv, iv);
250 ptd->cbc_iv = _mm_aesenc_si128 (iv, iv);
253 job->aes_key_len_in_bytes = key_len / 8;
254 job->aes_enc_key_expanded = kd->enc_key_exp;
255 job->aes_dec_key_expanded = kd->dec_key_exp;
257 job->iv_len_in_bytes = AES_BLOCK_SIZE;
261 job = IMB_SUBMIT_JOB (ptd->mgr);
264 ipsecmb_retire_cipher_job (job, &n_fail);
267 while ((job = IMB_FLUSH_JOB (ptd->mgr)))
268 ipsecmb_retire_cipher_job (job, &n_fail);
270 return n_ops - n_fail;
274 static_always_inline u32 ipsecmb_ops_cipher_enc_##a ( \
275 vlib_main_t *vm, vnet_crypto_op_t *ops[], u32 n_ops) \
277 return ipsecmb_ops_aes_cipher_inline (vm, ops, n_ops, b, ENCRYPT, c); \
280 static_always_inline u32 ipsecmb_ops_cipher_dec_##a ( \
281 vlib_main_t *vm, vnet_crypto_op_t *ops[], u32 n_ops) \
283 return ipsecmb_ops_aes_cipher_inline (vm, ops, n_ops, b, DECRYPT, c); \
286 foreach_ipsecmb_cipher_op;
290 static_always_inline u32 \
291 ipsecmb_ops_gcm_cipher_enc_##a##_chained (vlib_main_t * vm, \
292 vnet_crypto_op_t * ops[], vnet_crypto_op_chunk_t *chunks, u32 n_ops) \
294 ipsecmb_main_t *imbm = &ipsecmb_main; \
295 ipsecmb_per_thread_data_t *ptd = vec_elt_at_index (imbm->per_thread_data, \
297 MB_MGR *m = ptd->mgr; \
298 vnet_crypto_op_chunk_t *chp; \
301 for (i = 0; i < n_ops; i++) \
303 struct gcm_key_data *kd; \
304 struct gcm_context_data ctx; \
305 vnet_crypto_op_t *op = ops[i]; \
307 kd = (struct gcm_key_data *) imbm->key_data[op->key_index]; \
308 ASSERT (op->flags & VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS); \
309 IMB_AES##b##_GCM_INIT(m, kd, &ctx, op->iv, op->aad, op->aad_len); \
310 chp = chunks + op->chunk_index; \
311 for (j = 0; j < op->n_chunks; j++) \
313 IMB_AES##b##_GCM_ENC_UPDATE (m, kd, &ctx, chp->dst, chp->src, \
317 IMB_AES##b##_GCM_ENC_FINALIZE(m, kd, &ctx, op->tag, op->tag_len); \
319 op->status = VNET_CRYPTO_OP_STATUS_COMPLETED; \
325 static_always_inline u32 \
326 ipsecmb_ops_gcm_cipher_enc_##a (vlib_main_t * vm, vnet_crypto_op_t * ops[], \
329 ipsecmb_main_t *imbm = &ipsecmb_main; \
330 ipsecmb_per_thread_data_t *ptd = vec_elt_at_index (imbm->per_thread_data, \
332 MB_MGR *m = ptd->mgr; \
335 for (i = 0; i < n_ops; i++) \
337 struct gcm_key_data *kd; \
338 struct gcm_context_data ctx; \
339 vnet_crypto_op_t *op = ops[i]; \
341 kd = (struct gcm_key_data *) imbm->key_data[op->key_index]; \
342 IMB_AES##b##_GCM_ENC (m, kd, &ctx, op->dst, op->src, op->len, op->iv, \
343 op->aad, op->aad_len, op->tag, op->tag_len); \
345 op->status = VNET_CRYPTO_OP_STATUS_COMPLETED; \
351 static_always_inline u32 \
352 ipsecmb_ops_gcm_cipher_dec_##a##_chained (vlib_main_t * vm, \
353 vnet_crypto_op_t * ops[], vnet_crypto_op_chunk_t *chunks, u32 n_ops) \
355 ipsecmb_main_t *imbm = &ipsecmb_main; \
356 ipsecmb_per_thread_data_t *ptd = vec_elt_at_index (imbm->per_thread_data, \
358 MB_MGR *m = ptd->mgr; \
359 vnet_crypto_op_chunk_t *chp; \
360 u32 i, j, n_failed = 0; \
362 for (i = 0; i < n_ops; i++) \
364 struct gcm_key_data *kd; \
365 struct gcm_context_data ctx; \
366 vnet_crypto_op_t *op = ops[i]; \
369 kd = (struct gcm_key_data *) imbm->key_data[op->key_index]; \
370 ASSERT (op->flags & VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS); \
371 IMB_AES##b##_GCM_INIT(m, kd, &ctx, op->iv, op->aad, op->aad_len); \
372 chp = chunks + op->chunk_index; \
373 for (j = 0; j < op->n_chunks; j++) \
375 IMB_AES##b##_GCM_DEC_UPDATE (m, kd, &ctx, chp->dst, chp->src, \
379 IMB_AES##b##_GCM_DEC_FINALIZE(m, kd, &ctx, scratch, op->tag_len); \
381 if ((memcmp (op->tag, scratch, op->tag_len))) \
383 op->status = VNET_CRYPTO_OP_STATUS_FAIL_BAD_HMAC; \
387 op->status = VNET_CRYPTO_OP_STATUS_COMPLETED; \
390 return n_ops - n_failed; \
393 static_always_inline u32 \
394 ipsecmb_ops_gcm_cipher_dec_##a (vlib_main_t * vm, vnet_crypto_op_t * ops[], \
397 ipsecmb_main_t *imbm = &ipsecmb_main; \
398 ipsecmb_per_thread_data_t *ptd = vec_elt_at_index (imbm->per_thread_data, \
400 MB_MGR *m = ptd->mgr; \
401 u32 i, n_failed = 0; \
403 for (i = 0; i < n_ops; i++) \
405 struct gcm_key_data *kd; \
406 struct gcm_context_data ctx; \
407 vnet_crypto_op_t *op = ops[i]; \
410 kd = (struct gcm_key_data *) imbm->key_data[op->key_index]; \
411 IMB_AES##b##_GCM_DEC (m, kd, &ctx, op->dst, op->src, op->len, op->iv, \
412 op->aad, op->aad_len, scratch, op->tag_len); \
414 if ((memcmp (op->tag, scratch, op->tag_len))) \
416 op->status = VNET_CRYPTO_OP_STATUS_FAIL_BAD_HMAC; \
420 op->status = VNET_CRYPTO_OP_STATUS_COMPLETED; \
423 return n_ops - n_failed; \
426 foreach_ipsecmb_gcm_cipher_op;
430 crypto_ipsecmb_iv_init (ipsecmb_main_t * imbm)
432 ipsecmb_per_thread_data_t *ptd;
433 clib_error_t *err = 0;
436 if ((fd = open ("/dev/urandom", O_RDONLY)) < 0)
437 return clib_error_return_unix (0, "failed to open '/dev/urandom'");
439 vec_foreach (ptd, imbm->per_thread_data)
441 if (read (fd, &ptd->cbc_iv, sizeof (ptd->cbc_iv)) != sizeof (ptd->cbc_iv))
443 err = clib_error_return_unix (0, "'/dev/urandom' read failure");
454 crypto_ipsecmb_key_handler (vlib_main_t * vm, vnet_crypto_key_op_t kop,
455 vnet_crypto_key_index_t idx)
457 ipsecmb_main_t *imbm = &ipsecmb_main;
458 vnet_crypto_key_t *key = vnet_crypto_get_key (idx);
459 ipsecmb_alg_data_t *ad = imbm->alg_data + key->alg;
463 /** TODO: add linked alg support **/
464 if (key->type == VNET_CRYPTO_KEY_TYPE_LINK)
467 if (kop == VNET_CRYPTO_KEY_OP_DEL)
469 if (idx >= vec_len (imbm->key_data))
472 if (imbm->key_data[idx] == 0)
475 clib_mem_free_s (imbm->key_data[idx]);
476 imbm->key_data[idx] = 0;
480 if (ad->data_size == 0)
483 vec_validate_aligned (imbm->key_data, idx, CLIB_CACHE_LINE_BYTES);
485 if (kop == VNET_CRYPTO_KEY_OP_MODIFY && imbm->key_data[idx])
487 clib_mem_free_s (imbm->key_data[idx]);
490 kd = imbm->key_data[idx] = clib_mem_alloc_aligned (ad->data_size,
491 CLIB_CACHE_LINE_BYTES);
493 /* AES CBC key expansion */
496 ad->keyexp (key->data, ((ipsecmb_aes_key_data_t *) kd)->enc_key_exp,
497 ((ipsecmb_aes_key_data_t *) kd)->dec_key_exp);
504 ad->aes_gcm_pre (key->data, (struct gcm_key_data *) kd);
509 if (ad->hash_one_block)
511 const int block_qw = HMAC_MAX_BLOCK_SIZE / sizeof (u64);
512 u64 pad[block_qw], key_hash[block_qw];
514 clib_memset_u8 (key_hash, 0, HMAC_MAX_BLOCK_SIZE);
515 if (vec_len (key->data) <= ad->block_size)
516 clib_memcpy_fast (key_hash, key->data, vec_len (key->data));
518 ad->hash_fn (key->data, vec_len (key->data), key_hash);
520 for (i = 0; i < block_qw; i++)
521 pad[i] = key_hash[i] ^ 0x3636363636363636;
522 ad->hash_one_block (pad, kd);
524 for (i = 0; i < block_qw; i++)
525 pad[i] = key_hash[i] ^ 0x5c5c5c5c5c5c5c5c;
526 ad->hash_one_block (pad, ((u8 *) kd) + (ad->data_size / 2));
532 static clib_error_t *
533 crypto_ipsecmb_init (vlib_main_t * vm)
535 ipsecmb_main_t *imbm = &ipsecmb_main;
536 ipsecmb_alg_data_t *ad;
537 ipsecmb_per_thread_data_t *ptd;
538 vlib_thread_main_t *tm = vlib_get_thread_main ();
544 if (!clib_cpu_supports_aes ())
548 * A priority that is better than OpenSSL but worse than VPP natvie
550 name = format (0, "Intel(R) Multi-Buffer Crypto for IPsec Library %s%c",
552 eidx = vnet_crypto_register_engine (vm, "ipsecmb", 80, (char *) name);
554 vec_validate_aligned (imbm->per_thread_data, tm->n_vlib_mains - 1,
555 CLIB_CACHE_LINE_BYTES);
558 vec_foreach (ptd, imbm->per_thread_data)
560 ptd->mgr = alloc_mb_mgr (0);
561 if (clib_cpu_supports_avx512f ())
562 init_mb_mgr_avx512 (ptd->mgr);
563 else if (clib_cpu_supports_avx2 ())
564 init_mb_mgr_avx2 (ptd->mgr);
566 init_mb_mgr_sse (ptd->mgr);
568 if (ptd == imbm->per_thread_data)
573 if (clib_cpu_supports_x86_aes () && (error = crypto_ipsecmb_iv_init (imbm)))
576 #define _(a, b, c, d, e, f) \
577 vnet_crypto_register_ops_handler (vm, eidx, VNET_CRYPTO_OP_##a##_HMAC, \
578 ipsecmb_ops_hmac_##a); \
579 ad = imbm->alg_data + VNET_CRYPTO_ALG_HMAC_##a; \
580 ad->block_size = d; \
581 ad->data_size = e * 2; \
582 ad->hash_one_block = m-> c##_one_block; \
583 ad->hash_fn = m-> c; \
585 foreach_ipsecmb_hmac_op;
588 vnet_crypto_register_ops_handler (vm, eidx, VNET_CRYPTO_OP_##a##_ENC, \
589 ipsecmb_ops_cipher_enc_##a); \
590 vnet_crypto_register_ops_handler (vm, eidx, VNET_CRYPTO_OP_##a##_DEC, \
591 ipsecmb_ops_cipher_dec_##a); \
592 ad = imbm->alg_data + VNET_CRYPTO_ALG_##a; \
593 ad->data_size = sizeof (ipsecmb_aes_key_data_t); \
594 ad->keyexp = m->keyexp_##b;
596 foreach_ipsecmb_cipher_op;
599 vnet_crypto_register_ops_handler (vm, eidx, VNET_CRYPTO_OP_##a##_ENC, \
600 ipsecmb_ops_gcm_cipher_enc_##a); \
601 vnet_crypto_register_ops_handler (vm, eidx, VNET_CRYPTO_OP_##a##_DEC, \
602 ipsecmb_ops_gcm_cipher_dec_##a); \
603 vnet_crypto_register_chained_ops_handler \
604 (vm, eidx, VNET_CRYPTO_OP_##a##_ENC, \
605 ipsecmb_ops_gcm_cipher_enc_##a##_chained); \
606 vnet_crypto_register_chained_ops_handler \
607 (vm, eidx, VNET_CRYPTO_OP_##a##_DEC, \
608 ipsecmb_ops_gcm_cipher_dec_##a##_chained); \
609 ad = imbm->alg_data + VNET_CRYPTO_ALG_##a; \
610 ad->data_size = sizeof (struct gcm_key_data); \
611 ad->aes_gcm_pre = m->gcm##b##_pre; \
613 foreach_ipsecmb_gcm_cipher_op;
616 vnet_crypto_register_key_handler (vm, eidx, crypto_ipsecmb_key_handler);
621 VLIB_INIT_FUNCTION (crypto_ipsecmb_init) =
623 .runs_after = VLIB_INITS ("vnet_crypto_init"),
628 VLIB_PLUGIN_REGISTER () =
630 .version = VPP_BUILD_VER,
631 .description = "Intel IPSEC Multi-buffer Crypto Engine",
636 * fd.io coding-style-patch-verification: ON
639 * eval: (c-set-style "gnu")