crypto_ipsecmb: CBC IV size is always equal to block size
[vpp.git] / src / plugins / crypto_ipsecmb / ipsecmb.c
1 /*
2  * ipsecmb.c - Intel IPSec Multi-buffer library Crypto Engine
3  *
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:
8  *
9  *     http://www.apache.org/licenses/LICENSE-2.0
10  *
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.
16  */
17
18 #include <fcntl.h>
19
20 #include <intel-ipsec-mb.h>
21
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>
27
28 #define HMAC_MAX_BLOCK_SIZE SHA_512_BLOCK_SIZE
29 #define EXPANDED_KEY_N_BYTES (16 * 15)
30
31 typedef struct
32 {
33   MB_MGR *mgr;
34   __m128i cbc_iv;
35 } ipsecmb_per_thread_data_t;
36
37 typedef struct
38 {
39   u16 data_size;
40   u8 block_size;
41   aes_gcm_pre_t aes_gcm_pre;
42   keyexp_t keyexp;
43   hash_one_block_t hash_one_block;
44   hash_fn_t hash_fn;
45 } ipsecmb_alg_data_t;
46
47 typedef struct ipsecmb_main_t_
48 {
49   ipsecmb_per_thread_data_t *per_thread_data;
50   ipsecmb_alg_data_t alg_data[VNET_CRYPTO_N_ALGS];
51   void **key_data;
52 } ipsecmb_main_t;
53
54 typedef struct
55 {
56   u8 enc_key_exp[EXPANDED_KEY_N_BYTES];
57   u8 dec_key_exp[EXPANDED_KEY_N_BYTES];
58 } ipsecmb_aes_cbc_key_data_t;
59
60 static ipsecmb_main_t ipsecmb_main = { };
61
62 /*
63  * (Alg, JOB_HASH_ALG, fn, block-size-bytes, hash-size-bytes, digest-size-bytes)
64  */
65 #define foreach_ipsecmb_hmac_op                                \
66   _(SHA1,   SHA1,    sha1,   64,  20, 20)                      \
67   _(SHA224, SHA_224, sha224, 64,  32, 28)                      \
68   _(SHA256, SHA_256, sha256, 64,  32, 32)                      \
69   _(SHA384, SHA_384, sha384, 128, 64, 48)                      \
70   _(SHA512, SHA_512, sha512, 128, 64, 64)
71
72 /*
73  * (Alg, key-len-bits)
74  */
75 #define foreach_ipsecmb_cbc_cipher_op                          \
76   _(AES_128_CBC, 128)                                          \
77   _(AES_192_CBC, 192)                                          \
78   _(AES_256_CBC, 256)
79
80 /*
81  * (Alg, key-len-bytes, iv-len-bytes)
82  */
83 #define foreach_ipsecmb_gcm_cipher_op                          \
84   _(AES_128_GCM, 128, 12)                                      \
85   _(AES_192_GCM, 192, 12)                                      \
86   _(AES_256_GCM, 256, 12)
87
88 always_inline void
89 ipsecmb_retire_hmac_job (JOB_AES_HMAC * job, u32 * n_fail, u32 digest_size)
90 {
91   vnet_crypto_op_t *op = job->user_data;
92   u32 len = op->digest_len ? op->digest_len : digest_size;
93
94   if (STS_COMPLETED != job->status)
95     {
96       op->status = VNET_CRYPTO_OP_STATUS_FAIL_BAD_HMAC;
97       *n_fail = *n_fail + 1;
98       return;
99     }
100
101   if (op->flags & VNET_CRYPTO_OP_FLAG_HMAC_CHECK)
102     {
103       if ((memcmp (op->digest, job->auth_tag_output, len)))
104         {
105           *n_fail = *n_fail + 1;
106           op->status = VNET_CRYPTO_OP_STATUS_FAIL_BAD_HMAC;
107           return;
108         }
109     }
110   else if (len == digest_size)
111     clib_memcpy_fast (op->digest, job->auth_tag_output, digest_size);
112   else
113     clib_memcpy_fast (op->digest, job->auth_tag_output, len);
114
115   op->status = VNET_CRYPTO_OP_STATUS_COMPLETED;
116 }
117
118 static_always_inline u32
119 ipsecmb_ops_hmac_inline (vlib_main_t * vm, vnet_crypto_op_t * ops[],
120                          u32 n_ops, u32 block_size, u32 hash_size,
121                          u32 digest_size, JOB_HASH_ALG alg)
122 {
123   ipsecmb_main_t *imbm = &ipsecmb_main;
124   ipsecmb_per_thread_data_t *ptd = vec_elt_at_index (imbm->per_thread_data,
125                                                      vm->thread_index);
126   JOB_AES_HMAC *job;
127   u32 i, n_fail = 0;
128   u8 scratch[n_ops][digest_size];
129
130   /*
131    * queue all the jobs first ...
132    */
133   for (i = 0; i < n_ops; i++)
134     {
135       vnet_crypto_op_t *op = ops[i];
136       u8 *kd = (u8 *) imbm->key_data[op->key_index];
137
138       job = IMB_GET_NEXT_JOB (ptd->mgr);
139
140       job->src = op->src;
141       job->hash_start_src_offset_in_bytes = 0;
142       job->msg_len_to_hash_in_bytes = op->len;
143       job->hash_alg = alg;
144       job->auth_tag_output_len_in_bytes = digest_size;
145       job->auth_tag_output = scratch[i];
146
147       job->cipher_mode = NULL_CIPHER;
148       job->cipher_direction = DECRYPT;
149       job->chain_order = HASH_CIPHER;
150
151       job->u.HMAC._hashed_auth_key_xor_ipad = kd;
152       job->u.HMAC._hashed_auth_key_xor_opad = kd + hash_size;
153       job->user_data = op;
154
155       job = IMB_SUBMIT_JOB (ptd->mgr);
156
157       if (job)
158         ipsecmb_retire_hmac_job (job, &n_fail, digest_size);
159     }
160
161   while ((job = IMB_FLUSH_JOB (ptd->mgr)))
162     ipsecmb_retire_hmac_job (job, &n_fail, digest_size);
163
164   return n_ops - n_fail;
165 }
166
167 #define _(a, b, c, d, e, f)                                             \
168 static_always_inline u32                                                \
169 ipsecmb_ops_hmac_##a (vlib_main_t * vm,                                 \
170                       vnet_crypto_op_t * ops[],                         \
171                       u32 n_ops)                                        \
172 { return ipsecmb_ops_hmac_inline (vm, ops, n_ops, d, e, f, b); }        \
173
174 foreach_ipsecmb_hmac_op;
175 #undef _
176
177 always_inline void
178 ipsecmb_retire_cipher_job (JOB_AES_HMAC * job, u32 * n_fail)
179 {
180   vnet_crypto_op_t *op = job->user_data;
181
182   if (STS_COMPLETED != job->status)
183     {
184       op->status = VNET_CRYPTO_OP_STATUS_FAIL_BAD_HMAC;
185       *n_fail = *n_fail + 1;
186     }
187   else
188     op->status = VNET_CRYPTO_OP_STATUS_COMPLETED;
189 }
190
191 static_always_inline u32
192 ipsecmb_ops_cbc_cipher_inline (vlib_main_t * vm, vnet_crypto_op_t * ops[],
193                                u32 n_ops, u32 key_len,
194                                JOB_CIPHER_DIRECTION direction)
195 {
196   ipsecmb_main_t *imbm = &ipsecmb_main;
197   ipsecmb_per_thread_data_t *ptd = vec_elt_at_index (imbm->per_thread_data,
198                                                      vm->thread_index);
199   JOB_AES_HMAC *job;
200   u32 i, n_fail = 0;
201
202   for (i = 0; i < n_ops; i++)
203     {
204       ipsecmb_aes_cbc_key_data_t *kd;
205       vnet_crypto_op_t *op = ops[i];
206       kd = (ipsecmb_aes_cbc_key_data_t *) imbm->key_data[op->key_index];
207       __m128i iv;
208
209       job = IMB_GET_NEXT_JOB (ptd->mgr);
210
211       job->src = op->src;
212       job->dst = op->dst;
213       job->msg_len_to_cipher_in_bytes = op->len;
214       job->cipher_start_src_offset_in_bytes = 0;
215
216       job->hash_alg = NULL_HASH;
217       job->cipher_mode = CBC;
218       job->cipher_direction = direction;
219       job->chain_order = (direction == ENCRYPT ? CIPHER_HASH : HASH_CIPHER);
220
221       if ((direction == ENCRYPT) && (op->flags & VNET_CRYPTO_OP_FLAG_INIT_IV))
222         {
223           iv = ptd->cbc_iv;
224           _mm_storeu_si128 ((__m128i *) op->iv, iv);
225           ptd->cbc_iv = _mm_aesenc_si128 (iv, iv);
226         }
227
228       job->aes_key_len_in_bytes = key_len / 8;
229       job->aes_enc_key_expanded = kd->enc_key_exp;
230       job->aes_dec_key_expanded = kd->dec_key_exp;
231       job->iv = op->iv;
232       job->iv_len_in_bytes = AES_BLOCK_SIZE;
233
234       job->user_data = op;
235
236       job = IMB_SUBMIT_JOB (ptd->mgr);
237
238       if (job)
239         ipsecmb_retire_cipher_job (job, &n_fail);
240     }
241
242   while ((job = IMB_FLUSH_JOB (ptd->mgr)))
243     ipsecmb_retire_cipher_job (job, &n_fail);
244
245   return n_ops - n_fail;
246 }
247
248 #define _(a, b)                                                              \
249 static_always_inline u32                                                     \
250 ipsecmb_ops_cbc_cipher_enc_##a (vlib_main_t * vm,                            \
251                                 vnet_crypto_op_t * ops[],                    \
252                                 u32 n_ops)                                   \
253 { return ipsecmb_ops_cbc_cipher_inline (vm, ops, n_ops, b, ENCRYPT); }       \
254                                                                              \
255 static_always_inline u32                                                     \
256 ipsecmb_ops_cbc_cipher_dec_##a (vlib_main_t * vm,                            \
257                                 vnet_crypto_op_t * ops[],                    \
258                                 u32 n_ops)                                   \
259 { return ipsecmb_ops_cbc_cipher_inline (vm, ops, n_ops, b, DECRYPT); }       \
260
261 foreach_ipsecmb_cbc_cipher_op;
262 #undef _
263
264 always_inline void
265 ipsecmb_retire_gcm_cipher_job (JOB_AES_HMAC * job,
266                                u32 * n_fail, JOB_CIPHER_DIRECTION direction)
267 {
268   vnet_crypto_op_t *op = job->user_data;
269
270   if (STS_COMPLETED != job->status)
271     {
272       op->status = VNET_CRYPTO_OP_STATUS_FAIL_BAD_HMAC;
273       *n_fail = *n_fail + 1;
274     }
275   else
276     op->status = VNET_CRYPTO_OP_STATUS_COMPLETED;
277
278   if (DECRYPT == direction)
279     {
280       if ((memcmp (op->tag, job->auth_tag_output, op->tag_len)))
281         {
282           *n_fail = *n_fail + 1;
283           op->status = VNET_CRYPTO_OP_STATUS_FAIL_BAD_HMAC;
284         }
285     }
286 }
287
288 static_always_inline u32
289 ipsecmb_ops_gcm_cipher_inline (vlib_main_t * vm,
290                                vnet_crypto_op_t * ops[],
291                                u32 n_ops, u32 key_len, u32 iv_len,
292                                JOB_CIPHER_DIRECTION direction)
293 {
294   ipsecmb_main_t *imbm = &ipsecmb_main;
295   ipsecmb_per_thread_data_t *ptd = vec_elt_at_index (imbm->per_thread_data,
296                                                      vm->thread_index);
297   JOB_AES_HMAC *job;
298   u32 i, n_fail = 0;
299   u8 scratch[n_ops][64];
300
301   /*
302    * queue all the jobs first ...
303    */
304   for (i = 0; i < n_ops; i++)
305     {
306       struct gcm_key_data *kd;
307       vnet_crypto_op_t *op = ops[i];
308       kd = (struct gcm_key_data *) imbm->key_data[op->key_index];
309       u32 nonce[3];
310       __m128i iv;
311
312       job = IMB_GET_NEXT_JOB (ptd->mgr);
313
314       job->src = op->src;
315       job->dst = op->dst;
316       job->msg_len_to_cipher_in_bytes = op->len;
317       job->cipher_start_src_offset_in_bytes = 0;
318
319       job->hash_alg = AES_GMAC;
320       job->cipher_mode = GCM;
321       job->cipher_direction = direction;
322       job->chain_order = (direction == ENCRYPT ? CIPHER_HASH : HASH_CIPHER);
323
324       if (direction == ENCRYPT)
325         {
326           if (op->flags & VNET_CRYPTO_OP_FLAG_INIT_IV)
327             {
328               iv = ptd->cbc_iv;
329               // only use 8 bytes of the IV
330               clib_memcpy_fast (op->iv, &iv, 8);
331               ptd->cbc_iv = _mm_aesenc_si128 (iv, iv);
332             }
333           nonce[0] = op->salt;
334           clib_memcpy_fast (nonce + 1, op->iv, 8);
335           job->iv = (u8 *) nonce;
336         }
337       else
338         {
339           nonce[0] = op->salt;
340           clib_memcpy_fast (nonce + 1, op->iv, 8);
341           job->iv = op->iv;
342         }
343
344       job->aes_key_len_in_bytes = key_len / 8;
345       job->aes_enc_key_expanded = kd;
346       job->aes_dec_key_expanded = kd;
347       job->iv_len_in_bytes = iv_len;
348
349       job->u.GCM.aad = op->aad;
350       job->u.GCM.aad_len_in_bytes = op->aad_len;
351       job->auth_tag_output_len_in_bytes = op->tag_len;
352       if (DECRYPT == direction)
353         job->auth_tag_output = scratch[i];
354       else
355         job->auth_tag_output = op->tag;
356       job->user_data = op;
357
358       job = IMB_SUBMIT_JOB (ptd->mgr);
359
360       if (job)
361         ipsecmb_retire_gcm_cipher_job (job, &n_fail, direction);
362     }
363
364   /*
365    * .. then flush (i.e. complete) them
366    *  We will have queued enough to satisfy the 'multi' buffer
367    */
368   while ((job = IMB_FLUSH_JOB (ptd->mgr)))
369     {
370       ipsecmb_retire_gcm_cipher_job (job, &n_fail, direction);
371     }
372
373   return n_ops - n_fail;
374 }
375
376 #define _(a, b, c)                                                           \
377 static_always_inline u32                                                     \
378 ipsecmb_ops_gcm_cipher_enc_##a (vlib_main_t * vm,                            \
379                                 vnet_crypto_op_t * ops[],                    \
380                                 u32 n_ops)                                   \
381 { return ipsecmb_ops_gcm_cipher_inline (vm, ops, n_ops, b, c, ENCRYPT); }    \
382
383 foreach_ipsecmb_gcm_cipher_op;
384 #undef _
385
386 #define _(a, b, c)                                                           \
387 static_always_inline u32                                                     \
388 ipsecmb_ops_gcm_cipher_dec_##a (vlib_main_t * vm,                            \
389                                 vnet_crypto_op_t * ops[],                    \
390                                 u32 n_ops)                                   \
391 { return ipsecmb_ops_gcm_cipher_inline (vm, ops, n_ops, b, c, DECRYPT); }    \
392
393 foreach_ipsecmb_gcm_cipher_op;
394 #undef _
395
396 clib_error_t *
397 crypto_ipsecmb_iv_init (ipsecmb_main_t * imbm)
398 {
399   ipsecmb_per_thread_data_t *ptd;
400   clib_error_t *err = 0;
401   int fd;
402
403   if ((fd = open ("/dev/urandom", O_RDONLY)) < 0)
404     return clib_error_return_unix (0, "failed to open '/dev/urandom'");
405
406   vec_foreach (ptd, imbm->per_thread_data)
407   {
408     if (read (fd, &ptd->cbc_iv, sizeof (ptd->cbc_iv)) != sizeof (ptd->cbc_iv))
409       {
410         err = clib_error_return_unix (0, "'/dev/urandom' read failure");
411         close (fd);
412         return (err);
413       }
414   }
415
416   close (fd);
417   return (NULL);
418 }
419
420 static void
421 crypto_ipsecmb_key_handler (vlib_main_t * vm, vnet_crypto_key_op_t kop,
422                             vnet_crypto_key_index_t idx)
423 {
424   ipsecmb_main_t *imbm = &ipsecmb_main;
425   vnet_crypto_key_t *key = vnet_crypto_get_key (idx);
426   ipsecmb_alg_data_t *ad = imbm->alg_data + key->alg;
427   u32 i;
428   void *kd;
429
430   if (kop == VNET_CRYPTO_KEY_OP_DEL)
431     {
432       if (idx >= vec_len (imbm->key_data))
433         return;
434
435       if (imbm->key_data[idx] == 0)
436         return;
437
438       clib_memset_u8 (imbm->key_data[idx], 0,
439                       clib_mem_size (imbm->key_data[idx]));
440       clib_mem_free (imbm->key_data[idx]);
441       imbm->key_data[idx] = 0;
442       return;
443     }
444
445   if (ad->data_size == 0)
446     return;
447
448   vec_validate_aligned (imbm->key_data, idx, CLIB_CACHE_LINE_BYTES);
449
450   if (kop == VNET_CRYPTO_KEY_OP_MODIFY && imbm->key_data[idx])
451     {
452       clib_memset_u8 (imbm->key_data[idx], 0,
453                       clib_mem_size (imbm->key_data[idx]));
454       clib_mem_free (imbm->key_data[idx]);
455     }
456
457   kd = imbm->key_data[idx] = clib_mem_alloc_aligned (ad->data_size,
458                                                      CLIB_CACHE_LINE_BYTES);
459
460   /* AES CBC key expansion */
461   if (ad->keyexp)
462     {
463       ad->keyexp (key->data, ((ipsecmb_aes_cbc_key_data_t *) kd)->enc_key_exp,
464                   ((ipsecmb_aes_cbc_key_data_t *) kd)->dec_key_exp);
465       return;
466     }
467
468   /* AES GCM */
469   if (ad->aes_gcm_pre)
470     {
471       ad->aes_gcm_pre (key->data, (struct gcm_key_data *) kd);
472       return;
473     }
474
475   /* HMAC */
476   if (ad->hash_one_block)
477     {
478       const int block_qw = HMAC_MAX_BLOCK_SIZE / sizeof (u64);
479       u64 pad[block_qw], key_hash[block_qw];
480
481       clib_memset_u8 (key_hash, 0, HMAC_MAX_BLOCK_SIZE);
482       if (vec_len (key->data) <= ad->block_size)
483         clib_memcpy_fast (key_hash, key->data, vec_len (key->data));
484       else
485         ad->hash_fn (key->data, vec_len (key->data), key_hash);
486
487       for (i = 0; i < block_qw; i++)
488         pad[i] = key_hash[i] ^ 0x3636363636363636;
489       ad->hash_one_block (pad, kd);
490
491       for (i = 0; i < block_qw; i++)
492         pad[i] = key_hash[i] ^ 0x5c5c5c5c5c5c5c5c;
493       ad->hash_one_block (pad, ((u8 *) kd) + (ad->data_size / 2));
494
495       return;
496     }
497 }
498
499 static clib_error_t *
500 crypto_ipsecmb_init (vlib_main_t * vm)
501 {
502   ipsecmb_main_t *imbm = &ipsecmb_main;
503   ipsecmb_alg_data_t *ad;
504   ipsecmb_per_thread_data_t *ptd;
505   vlib_thread_main_t *tm = vlib_get_thread_main ();
506   clib_error_t *error;
507   MB_MGR *m = 0;
508   u32 eidx;
509   u8 *name;
510
511   if ((error = vlib_call_init_function (vm, vnet_crypto_init)))
512     return error;
513
514   /*
515    * A priority that is better than OpenSSL but worse than VPP natvie
516    */
517   name = format (0, "Intel(R) Multi-Buffer Crypto for IPsec Library %s%c",
518                  IMB_VERSION_STR, 0);
519   eidx = vnet_crypto_register_engine (vm, "ipsecmb", 80, (char *) name);
520
521   vec_validate (imbm->per_thread_data, tm->n_vlib_mains - 1);
522
523   /* *INDENT-OFF* */
524   vec_foreach (ptd, imbm->per_thread_data)
525     {
526         ptd->mgr = alloc_mb_mgr (0);
527         if (clib_cpu_supports_avx512f ())
528           init_mb_mgr_avx512 (ptd->mgr);
529         else if (clib_cpu_supports_avx2 ())
530           init_mb_mgr_avx2 (ptd->mgr);
531         else
532           init_mb_mgr_sse (ptd->mgr);
533
534         if (ptd == imbm->per_thread_data)
535           m = ptd->mgr;
536     }
537   /* *INDENT-ON* */
538
539   if (clib_cpu_supports_x86_aes () && (error = crypto_ipsecmb_iv_init (imbm)))
540     return (error);
541
542 #define _(a, b, c, d, e, f)                                              \
543   vnet_crypto_register_ops_handler (vm, eidx, VNET_CRYPTO_OP_##a##_HMAC, \
544                                     ipsecmb_ops_hmac_##a);               \
545   ad = imbm->alg_data + VNET_CRYPTO_ALG_HMAC_##a;                        \
546   ad->block_size = d;                                                    \
547   ad->data_size = e * 2;                                                 \
548   ad->hash_one_block = m-> c##_one_block;                                \
549   ad->hash_fn = m-> c;                                                   \
550
551   foreach_ipsecmb_hmac_op;
552 #undef _
553 #define _(a, b)                                                         \
554   vnet_crypto_register_ops_handler (vm, eidx, VNET_CRYPTO_OP_##a##_ENC, \
555                                     ipsecmb_ops_cbc_cipher_enc_##a);    \
556   vnet_crypto_register_ops_handler (vm, eidx, VNET_CRYPTO_OP_##a##_DEC, \
557                                     ipsecmb_ops_cbc_cipher_dec_##a);    \
558   ad = imbm->alg_data + VNET_CRYPTO_ALG_##a;                            \
559   ad->data_size = sizeof (ipsecmb_aes_cbc_key_data_t);                  \
560   ad->keyexp = m->keyexp_##b;                                           \
561
562   foreach_ipsecmb_cbc_cipher_op;
563 #undef _
564 #define _(a, b, c)                                                      \
565   vnet_crypto_register_ops_handler (vm, eidx, VNET_CRYPTO_OP_##a##_ENC, \
566                                     ipsecmb_ops_gcm_cipher_enc_##a);    \
567   vnet_crypto_register_ops_handler (vm, eidx, VNET_CRYPTO_OP_##a##_DEC, \
568                                     ipsecmb_ops_gcm_cipher_dec_##a);    \
569   ad = imbm->alg_data + VNET_CRYPTO_ALG_##a;                            \
570   ad->data_size = sizeof (struct gcm_key_data);                         \
571   ad->aes_gcm_pre = m->gcm##b##_pre;                                    \
572
573   foreach_ipsecmb_gcm_cipher_op;
574 #undef _
575
576   vnet_crypto_register_key_handler (vm, eidx, crypto_ipsecmb_key_handler);
577   return (NULL);
578 }
579
580 VLIB_INIT_FUNCTION (crypto_ipsecmb_init);
581
582 /* *INDENT-OFF* */
583 VLIB_PLUGIN_REGISTER () =
584 {
585   .version = VPP_BUILD_VER,
586   .description = "Intel IPSEC multi-buffer",
587 };
588 /* *INDENT-ON* */
589
590 /*
591  * fd.io coding-style-patch-verification: ON
592  *
593  * Local Variables:
594  * eval: (c-set-style "gnu")
595  * End:
596  */