src/plugins/crypto_native/aes.h

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2020 Cisco and/or its affiliates.
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *------------------------------------------------------------------
  16  */
  17
  18 #ifndef __aesni_h__
  19 #define __aesni_h__
  20
  21 typedef enum
  22 {
  23   AES_KEY_128 = 0,
  24   AES_KEY_192 = 1,
  25   AES_KEY_256 = 2,
  26 } aes_key_size_t;
  27
  28 #define AES_KEY_ROUNDS(x)               (10 + x * 2)
  29 #define AES_KEY_BYTES(x)                (16 + x * 8)
  30
  31 static const u8x16 byte_mask_scale = {
  32   0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
  33 };
  34
  35 static_always_inline u8x16
  36 aes_block_load (u8 * p)
  37 {
  38   return *(u8x16u *) p;
  39 }
  40
  41 static_always_inline u8x16
  42 aes_enc_round (u8x16 a, u8x16 k)
  43 {
  44 #if defined (__AES__)
  45   return (u8x16) _mm_aesenc_si128 ((__m128i) a, (__m128i) k);
  46 #elif defined (__ARM_FEATURE_CRYPTO)
  47   return vaesmcq_u8 (vaeseq_u8 (a, u8x16_splat (0))) ^ k;
  48 #endif
  49 }
  50
  51 #if defined (__VAES__)
  52 static_always_inline u8x64
  53 aes_enc_round_x4 (u8x64 a, u8x64 k)
  54 {
  55   return (u8x64) _mm512_aesenc_epi128 ((__m512i) a, (__m512i) k);
  56 }
  57
  58 static_always_inline u8x64
  59 aes_enc_last_round_x4 (u8x64 a, u8x64 k)
  60 {
  61   return (u8x64) _mm512_aesenclast_epi128 ((__m512i) a, (__m512i) k);
  62 }
  63
  64 static_always_inline u8x64
  65 aes_dec_round_x4 (u8x64 a, u8x64 k)
  66 {
  67   return (u8x64) _mm512_aesdec_epi128 ((__m512i) a, (__m512i) k);
  68 }
  69
  70 static_always_inline u8x64
  71 aes_dec_last_round_x4 (u8x64 a, u8x64 k)
  72 {
  73   return (u8x64) _mm512_aesdeclast_epi128 ((__m512i) a, (__m512i) k);
  74 }
  75 #endif
  76
  77 static_always_inline u8x16
  78 aes_enc_last_round (u8x16 a, u8x16 k)
  79 {
  80 #if defined (__AES__)
  81   return (u8x16) _mm_aesenclast_si128 ((__m128i) a, (__m128i) k);
  82 #elif defined (__ARM_FEATURE_CRYPTO)
  83   return vaeseq_u8 (a, u8x16_splat (0)) ^ k;
  84 #endif
  85 }
  86
  87 #ifdef __x86_64__
  88
  89 static_always_inline u8x16
  90 aes_dec_round (u8x16 a, u8x16 k)
  91 {
  92   return (u8x16) _mm_aesdec_si128 ((__m128i) a, (__m128i) k);
  93 }
  94
  95 static_always_inline u8x16
  96 aes_dec_last_round (u8x16 a, u8x16 k)
  97 {
  98   return (u8x16) _mm_aesdeclast_si128 ((__m128i) a, (__m128i) k);
  99 }
 100 #endif
 101
 102 static_always_inline void
 103 aes_block_store (u8 * p, u8x16 r)
 104 {
 105   *(u8x16u *) p = r;
 106 }
 107
 108 static_always_inline u8x16
 109 aes_byte_mask (u8x16 x, u8 n_bytes)
 110 {
 111   return x & (u8x16_splat (n_bytes) > byte_mask_scale);
 112 }
 113
 114 static_always_inline u8x16
 115 aes_load_partial (u8x16u * p, int n_bytes)
 116 {
 117   ASSERT (n_bytes <= 16);
 118 #ifdef __AVX512F__
 119   __m128i zero = { };
 120   return (u8x16) _mm_mask_loadu_epi8 (zero, (1 << n_bytes) - 1, p);
 121 #else
 122   u8x16 v = {};
 123   CLIB_ASSUME (n_bytes < 16);
 124   clib_memcpy_fast (&v, p, n_bytes);
 125   return v;
 126 #endif
 127 }
 128
 129 static_always_inline void
 130 aes_store_partial (void *p, u8x16 r, int n_bytes)
 131 {
 132 #if __aarch64__
 133   clib_memcpy_fast (p, &r, n_bytes);
 134 #else
 135 #ifdef __AVX512F__
 136   _mm_mask_storeu_epi8 (p, (1 << n_bytes) - 1, (__m128i) r);
 137 #else
 138   u8x16 mask = u8x16_splat (n_bytes) > byte_mask_scale;
 139   _mm_maskmoveu_si128 ((__m128i) r, (__m128i) mask, p);
 140 #endif
 141 #endif
 142 }
 143
 144
 145 static_always_inline u8x16
 146 aes_encrypt_block (u8x16 block, const u8x16 * round_keys, aes_key_size_t ks)
 147 {
 148   int rounds = AES_KEY_ROUNDS (ks);
 149   block ^= round_keys[0];
 150   for (int i = 1; i < rounds; i += 1)
 151     block = aes_enc_round (block, round_keys[i]);
 152   return aes_enc_last_round (block, round_keys[rounds]);
 153 }
 154
 155 static_always_inline u8x16
 156 aes_inv_mix_column (u8x16 a)
 157 {
 158 #if defined (__AES__)
 159   return (u8x16) _mm_aesimc_si128 ((__m128i) a);
 160 #elif defined (__ARM_FEATURE_CRYPTO)
 161   return vaesimcq_u8 (a);
 162 #endif
 163 }
 164
 165 #ifdef __x86_64__
 166 #define aes_keygen_assist(a, b) \
 167   (u8x16) _mm_aeskeygenassist_si128((__m128i) a, b)
 168
 169 /* AES-NI based AES key expansion based on code samples from
 170    Intel(r) Advanced Encryption Standard (AES) New Instructions White Paper
 171    (323641-001) */
 172
 173 static_always_inline void
 174 aes128_key_assist (u8x16 * rk, u8x16 r)
 175 {
 176   u8x16 t = rk[-1];
 177   t ^= u8x16_word_shift_left (t, 4);
 178   t ^= u8x16_word_shift_left (t, 4);
 179   t ^= u8x16_word_shift_left (t, 4);
 180   rk[0] = t ^ (u8x16) u32x4_shuffle ((u32x4) r, 3, 3, 3, 3);
 181 }
 182
 183 static_always_inline void
 184 aes128_key_expand (u8x16 *rk, u8x16u const *k)
 185 {
 186   rk[0] = k[0];
 187   aes128_key_assist (rk + 1, aes_keygen_assist (rk[0], 0x01));
 188   aes128_key_assist (rk + 2, aes_keygen_assist (rk[1], 0x02));
 189   aes128_key_assist (rk + 3, aes_keygen_assist (rk[2], 0x04));
 190   aes128_key_assist (rk + 4, aes_keygen_assist (rk[3], 0x08));
 191   aes128_key_assist (rk + 5, aes_keygen_assist (rk[4], 0x10));
 192   aes128_key_assist (rk + 6, aes_keygen_assist (rk[5], 0x20));
 193   aes128_key_assist (rk + 7, aes_keygen_assist (rk[6], 0x40));
 194   aes128_key_assist (rk + 8, aes_keygen_assist (rk[7], 0x80));
 195   aes128_key_assist (rk + 9, aes_keygen_assist (rk[8], 0x1b));
 196   aes128_key_assist (rk + 10, aes_keygen_assist (rk[9], 0x36));
 197 }
 198
 199 static_always_inline void
 200 aes192_key_assist (u8x16 * r1, u8x16 * r2, u8x16 key_assist)
 201 {
 202   u8x16 t;
 203   r1[0] ^= t = u8x16_word_shift_left (r1[0], 4);
 204   r1[0] ^= t = u8x16_word_shift_left (t, 4);
 205   r1[0] ^= u8x16_word_shift_left (t, 4);
 206   r1[0] ^= (u8x16) _mm_shuffle_epi32 ((__m128i) key_assist, 0x55);
 207   r2[0] ^= u8x16_word_shift_left (r2[0], 4);
 208   r2[0] ^= (u8x16) _mm_shuffle_epi32 ((__m128i) r1[0], 0xff);
 209 }
 210
 211 static_always_inline void
 212 aes192_key_expand (u8x16 * rk, u8x16u const *k)
 213 {
 214   u8x16 r1, r2;
 215
 216   rk[0] = r1 = k[0];
 217   /* *INDENT-OFF* */
 218   rk[1] = r2 = (u8x16) (u64x2) { *(u64 *) (k + 1), 0 };
 219   /* *INDENT-ON* */
 220
 221   aes192_key_assist (&r1, &r2, aes_keygen_assist (r2, 0x1));
 222   rk[1] = (u8x16) _mm_shuffle_pd ((__m128d) rk[1], (__m128d) r1, 0);
 223   rk[2] = (u8x16) _mm_shuffle_pd ((__m128d) r1, (__m128d) r2, 1);
 224
 225   aes192_key_assist (&r1, &r2, aes_keygen_assist (r2, 0x2));
 226   rk[3] = r1;
 227   rk[4] = r2;
 228
 229   aes192_key_assist (&r1, &r2, aes_keygen_assist (r2, 0x4));
 230   rk[4] = (u8x16) _mm_shuffle_pd ((__m128d) rk[4], (__m128d) r1, 0);
 231   rk[5] = (u8x16) _mm_shuffle_pd ((__m128d) r1, (__m128d) r2, 1);
 232
 233   aes192_key_assist (&r1, &r2, aes_keygen_assist (r2, 0x8));
 234   rk[6] = r1;
 235   rk[7] = r2;
 236
 237   aes192_key_assist (&r1, &r2, aes_keygen_assist (r2, 0x10));
 238   rk[7] = (u8x16) _mm_shuffle_pd ((__m128d) rk[7], (__m128d) r1, 0);
 239   rk[8] = (u8x16) _mm_shuffle_pd ((__m128d) r1, (__m128d) r2, 1);
 240
 241   aes192_key_assist (&r1, &r2, aes_keygen_assist (r2, 0x20));
 242   rk[9] = r1;
 243   rk[10] = r2;
 244
 245   aes192_key_assist (&r1, &r2, aes_keygen_assist (r2, 0x40));
 246   rk[10] = (u8x16) _mm_shuffle_pd ((__m128d) rk[10], (__m128d) r1, 0);
 247   rk[11] = (u8x16) _mm_shuffle_pd ((__m128d) r1, (__m128d) r2, 1);
 248
 249   aes192_key_assist (&r1, &r2, aes_keygen_assist (r2, 0x80));
 250   rk[12] = r1;
 251 }
 252
 253 static_always_inline void
 254 aes256_key_assist (u8x16 * rk, int i, u8x16 key_assist)
 255 {
 256   u8x16 r, t;
 257   rk += i;
 258   r = rk[-2];
 259   r ^= t = u8x16_word_shift_left (r, 4);
 260   r ^= t = u8x16_word_shift_left (t, 4);
 261   r ^= u8x16_word_shift_left (t, 4);
 262   r ^= (u8x16) u32x4_shuffle ((u32x4) key_assist, 3, 3, 3, 3);
 263   rk[0] = r;
 264
 265   if (i >= 14)
 266     return;
 267
 268   key_assist = aes_keygen_assist (rk[0], 0x0);
 269   r = rk[-1];
 270   r ^= t = u8x16_word_shift_left (r, 4);
 271   r ^= t = u8x16_word_shift_left (t, 4);
 272   r ^= u8x16_word_shift_left (t, 4);
 273   r ^= (u8x16) u32x4_shuffle ((u32x4) key_assist, 2, 2, 2, 2);
 274   rk[1] = r;
 275 }
 276
 277 static_always_inline void
 278 aes256_key_expand (u8x16 * rk, u8x16u const *k)
 279 {
 280   rk[0] = k[0];
 281   rk[1] = k[1];
 282   aes256_key_assist (rk, 2, aes_keygen_assist (rk[1], 0x01));
 283   aes256_key_assist (rk, 4, aes_keygen_assist (rk[3], 0x02));
 284   aes256_key_assist (rk, 6, aes_keygen_assist (rk[5], 0x04));
 285   aes256_key_assist (rk, 8, aes_keygen_assist (rk[7], 0x08));
 286   aes256_key_assist (rk, 10, aes_keygen_assist (rk[9], 0x10));
 287   aes256_key_assist (rk, 12, aes_keygen_assist (rk[11], 0x20));
 288   aes256_key_assist (rk, 14, aes_keygen_assist (rk[13], 0x40));
 289 }
 290 #endif
 291
 292 #ifdef __aarch64__
 293
 294 static const u8x16 aese_prep_mask1 =
 295   { 13, 14, 15, 12, 13, 14, 15, 12, 13, 14, 15, 12, 13, 14, 15, 12 };
 296 static const u8x16 aese_prep_mask2 =
 297   { 12, 13, 14, 15, 12, 13, 14, 15, 12, 13, 14, 15, 12, 13, 14, 15 };
 298
 299 static_always_inline void
 300 aes128_key_expand_round_neon (u8x16 * rk, u32 rcon)
 301 {
 302   u8x16 r, t, last_round = rk[-1], z = { };
 303   r = vqtbl1q_u8 (last_round, aese_prep_mask1);
 304   r = vaeseq_u8 (r, z);
 305   r ^= (u8x16) vdupq_n_u32 (rcon);
 306   r ^= last_round;
 307   r ^= t = vextq_u8 (z, last_round, 12);
 308   r ^= t = vextq_u8 (z, t, 12);
 309   r ^= vextq_u8 (z, t, 12);
 310   rk[0] = r;
 311 }
 312
 313 static_always_inline void
 314 aes128_key_expand (u8x16 *rk, u8x16u const *k)
 315 {
 316   rk[0] = k[0];
 317   aes128_key_expand_round_neon (rk + 1, 0x01);
 318   aes128_key_expand_round_neon (rk + 2, 0x02);
 319   aes128_key_expand_round_neon (rk + 3, 0x04);
 320   aes128_key_expand_round_neon (rk + 4, 0x08);
 321   aes128_key_expand_round_neon (rk + 5, 0x10);
 322   aes128_key_expand_round_neon (rk + 6, 0x20);
 323   aes128_key_expand_round_neon (rk + 7, 0x40);
 324   aes128_key_expand_round_neon (rk + 8, 0x80);
 325   aes128_key_expand_round_neon (rk + 9, 0x1b);
 326   aes128_key_expand_round_neon (rk + 10, 0x36);
 327 }
 328
 329 static_always_inline void
 330 aes192_key_expand_round_neon (u8x8 * rk, u32 rcon)
 331 {
 332   u8x8 r, last_round = rk[-1], z = { };
 333   u8x16 r2, z2 = { };
 334
 335   r2 = (u8x16) vdupq_lane_u64 ((uint64x1_t) last_round, 0);
 336   r2 = vqtbl1q_u8 (r2, aese_prep_mask1);
 337   r2 = vaeseq_u8 (r2, z2);
 338   r2 ^= (u8x16) vdupq_n_u32 (rcon);
 339
 340   r = (u8x8) vdup_laneq_u64 ((u64x2) r2, 0);
 341   r ^= rk[-3];
 342   r ^= vext_u8 (z, rk[-3], 4);
 343   rk[0] = r;
 344
 345   r = rk[-2] ^ vext_u8 (r, z, 4);
 346   r ^= vext_u8 (z, r, 4);
 347   rk[1] = r;
 348
 349   if (rcon == 0x80)
 350     return;
 351
 352   r = rk[-1] ^ vext_u8 (r, z, 4);
 353   r ^= vext_u8 (z, r, 4);
 354   rk[2] = r;
 355 }
 356
 357 static_always_inline void
 358 aes192_key_expand (u8x16 * ek, const u8x16u * k)
 359 {
 360   u8x8 *rk = (u8x8 *) ek;
 361   ek[0] = k[0];
 362   rk[2] = *(u8x8u *) (k + 1);
 363   aes192_key_expand_round_neon (rk + 3, 0x01);
 364   aes192_key_expand_round_neon (rk + 6, 0x02);
 365   aes192_key_expand_round_neon (rk + 9, 0x04);
 366   aes192_key_expand_round_neon (rk + 12, 0x08);
 367   aes192_key_expand_round_neon (rk + 15, 0x10);
 368   aes192_key_expand_round_neon (rk + 18, 0x20);
 369   aes192_key_expand_round_neon (rk + 21, 0x40);
 370   aes192_key_expand_round_neon (rk + 24, 0x80);
 371 }
 372
 373
 374 static_always_inline void
 375 aes256_key_expand_round_neon (u8x16 * rk, u32 rcon)
 376 {
 377   u8x16 r, t, z = { };
 378
 379   r = vqtbl1q_u8 (rk[-1], rcon ? aese_prep_mask1 : aese_prep_mask2);
 380   r = vaeseq_u8 (r, z);
 381   if (rcon)
 382     r ^= (u8x16) vdupq_n_u32 (rcon);
 383   r ^= rk[-2];
 384   r ^= t = vextq_u8 (z, rk[-2], 12);
 385   r ^= t = vextq_u8 (z, t, 12);
 386   r ^= vextq_u8 (z, t, 12);
 387   rk[0] = r;
 388 }
 389
 390 static_always_inline void
 391 aes256_key_expand (u8x16 *rk, u8x16u const *k)
 392 {
 393   rk[0] = k[0];
 394   rk[1] = k[1];
 395   aes256_key_expand_round_neon (rk + 2, 0x01);
 396   aes256_key_expand_round_neon (rk + 3, 0);
 397   aes256_key_expand_round_neon (rk + 4, 0x02);
 398   aes256_key_expand_round_neon (rk + 5, 0);
 399   aes256_key_expand_round_neon (rk + 6, 0x04);
 400   aes256_key_expand_round_neon (rk + 7, 0);
 401   aes256_key_expand_round_neon (rk + 8, 0x08);
 402   aes256_key_expand_round_neon (rk + 9, 0);
 403   aes256_key_expand_round_neon (rk + 10, 0x10);
 404   aes256_key_expand_round_neon (rk + 11, 0);
 405   aes256_key_expand_round_neon (rk + 12, 0x20);
 406   aes256_key_expand_round_neon (rk + 13, 0);
 407   aes256_key_expand_round_neon (rk + 14, 0x40);
 408 }
 409
 410 #endif
 411
 412 static_always_inline void
 413 aes_key_expand (u8x16 * key_schedule, u8 const *key, aes_key_size_t ks)
 414 {
 415   switch (ks)
 416     {
 417     case AES_KEY_128:
 418       aes128_key_expand (key_schedule, (u8x16u const *) key);
 419       break;
 420     case AES_KEY_192:
 421       aes192_key_expand (key_schedule, (u8x16u const *) key);
 422       break;
 423     case AES_KEY_256:
 424       aes256_key_expand (key_schedule, (u8x16u const *) key);
 425       break;
 426     }
 427 }
 428
 429 static_always_inline void
 430 aes_key_enc_to_dec (u8x16 * ke, u8x16 * kd, aes_key_size_t ks)
 431 {
 432   int rounds = AES_KEY_ROUNDS (ks);
 433
 434   kd[rounds] = ke[0];
 435   kd[0] = ke[rounds];
 436
 437   for (int i = 1; i < (rounds / 2); i++)
 438     {
 439       kd[rounds - i] = aes_inv_mix_column (ke[i]);
 440       kd[i] = aes_inv_mix_column (ke[rounds - i]);
 441     }
 442
 443   kd[rounds / 2] = aes_inv_mix_column (ke[rounds / 2]);
 444 }
 445
 446 #endif /* __aesni_h__ */
 447
 448 /*
 449  * fd.io coding-style-patch-verification: ON
 450  *
 451  * Local Variables:
 452  * eval: (c-set-style "gnu")
 453  * End:
 454  */