forked from intel/intel-ipsec-mb
-
Notifications
You must be signed in to change notification settings - Fork 0
/
intel-ipsec-mb.h
2409 lines (2213 loc) · 106 KB
/
intel-ipsec-mb.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*******************************************************************************
Copyright (c) 2012-2019, Intel Corporation
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the name of Intel Corporation nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/
#ifndef IMB_IPSEC_MB_H
#define IMB_IPSEC_MB_H
#include <stdlib.h>
#include <stdint.h>
#ifdef __cplusplus
extern "C" {
#endif
/* 128-bit data type that is not in sdtint.h */
typedef struct {
uint64_t low;
uint64_t high;
} uint128_t;
/*
* Macros for aligning data structures and function inlines
*/
#if defined __linux__ || defined __FreeBSD__
/* Linux/FreeBSD */
#define DECLARE_ALIGNED(decl, alignval) \
decl __attribute__((aligned(alignval)))
#define __forceinline \
static inline __attribute__((always_inline))
#if __GNUC__ >= 4
#define IMB_DLL_EXPORT __attribute__((visibility("default")))
#define IMB_DLL_LOCAL __attribute__((visibility("hidden")))
#else /* GNU C 4.0 and later */
#define IMB_DLL_EXPORT
#define IMB_DLL_LOCAL
#endif /* different C compiler */
#else
/* Windows */
#define DECLARE_ALIGNED(decl, alignval) \
__declspec(align(alignval)) decl
#define __forceinline \
static __forceinline
/* Windows DLL export is done via DEF file */
#define IMB_DLL_EXPORT
#define IMB_DLL_LOCAL
#endif
/* Library version */
#define IMB_VERSION_STR "0.52.3-dev"
#define IMB_VERSION_NUM 0x3403
/* Macro to translate version number */
#define IMB_VERSION(a,b,c) (((a) << 16) + ((b) << 8) + (c))
/*
* Custom ASSERT and DIM macros
*/
#ifdef DEBUG
#include <assert.h>
#define IMB_ASSERT(x) assert(x)
#else
#define IMB_ASSERT(x)
#endif
#ifndef IMB_DIM
#define IMB_DIM(x) (sizeof(x) / sizeof(x[0]))
#endif
/*
* Algorithm constants
*/
#define DES_KEY_SCHED_SIZE (16 * 8) /* 16 rounds x 8 bytes */
#define DES_BLOCK_SIZE 8
#define AES_BLOCK_SIZE 16
#define NUM_MD5_DIGEST_WORDS 4
#define NUM_SHA_DIGEST_WORDS 5
#define NUM_SHA_256_DIGEST_WORDS 8
#define NUM_SHA_224_DIGEST_WORDS 7
#define NUM_SHA_512_DIGEST_WORDS 8
#define NUM_SHA_384_DIGEST_WORDS 6
#define SHA_DIGEST_WORD_SIZE 4
#define SHA224_DIGEST_WORD_SIZE 4
#define SHA256_DIGEST_WORD_SIZE 4
#define SHA384_DIGEST_WORD_SIZE 8
#define SHA512_DIGEST_WORD_SIZE 8
#define SHA1_DIGEST_SIZE_IN_BYTES \
(NUM_SHA_DIGEST_WORDS * SHA_DIGEST_WORD_SIZE)
#define SHA224_DIGEST_SIZE_IN_BYTES \
(NUM_SHA_224_DIGEST_WORDS * SHA224_DIGEST_WORD_SIZE)
#define SHA256_DIGEST_SIZE_IN_BYTES \
(NUM_SHA_256_DIGEST_WORDS * SHA256_DIGEST_WORD_SIZE)
#define SHA384_DIGEST_SIZE_IN_BYTES \
(NUM_SHA_384_DIGEST_WORDS * SHA384_DIGEST_WORD_SIZE)
#define SHA512_DIGEST_SIZE_IN_BYTES \
(NUM_SHA_512_DIGEST_WORDS * SHA512_DIGEST_WORD_SIZE)
#define SHA1_BLOCK_SIZE 64 /* 512 bits is 64 byte blocks */
#define SHA_256_BLOCK_SIZE 64 /* 512 bits is 64 byte blocks */
#define SHA_384_BLOCK_SIZE 128
#define SHA_512_BLOCK_SIZE 128
#define KASUMI_KEY_SIZE 16
#define KASUMI_IV_SIZE 8
#define KASUMI_BLOCK_SIZE 8
#define KASUMI_DIGEST_SIZE 4
/* Number of lanes AVX512, AVX2, AVX and SSE */
#define AVX512_NUM_SHA1_LANES 16
#define AVX512_NUM_SHA256_LANES 16
#define AVX512_NUM_SHA512_LANES 8
#define AVX512_NUM_MD5_LANES 32
#define AVX512_NUM_DES_LANES 16
#define AVX2_NUM_SHA1_LANES 8
#define AVX2_NUM_SHA256_LANES 8
#define AVX2_NUM_SHA512_LANES 4
#define AVX2_NUM_MD5_LANES 16
#define AVX_NUM_SHA1_LANES 4
#define AVX_NUM_SHA256_LANES 4
#define AVX_NUM_SHA512_LANES 2
#define AVX_NUM_MD5_LANES 8
#define SSE_NUM_SHA1_LANES AVX_NUM_SHA1_LANES
#define SSE_NUM_SHA256_LANES AVX_NUM_SHA256_LANES
#define SSE_NUM_SHA512_LANES AVX_NUM_SHA512_LANES
#define SSE_NUM_MD5_LANES AVX_NUM_MD5_LANES
/*
* Each row is sized to hold enough lanes for AVX2, AVX1 and SSE use a subset
* of each row. Thus one row is not adjacent in memory to its neighboring rows
* in the case of SSE and AVX1.
*/
#define MD5_DIGEST_SZ (NUM_MD5_DIGEST_WORDS * AVX512_NUM_MD5_LANES)
#define SHA1_DIGEST_SZ (NUM_SHA_DIGEST_WORDS * AVX512_NUM_SHA1_LANES)
#define SHA256_DIGEST_SZ (NUM_SHA_256_DIGEST_WORDS * AVX512_NUM_SHA256_LANES)
#define SHA512_DIGEST_SZ (NUM_SHA_512_DIGEST_WORDS * AVX512_NUM_SHA512_LANES)
/*
* Job structure definitions
*/
typedef enum {
STS_BEING_PROCESSED = 0,
STS_COMPLETED_AES = 1,
STS_COMPLETED_HMAC = 2,
STS_COMPLETED = 3, /* COMPLETED_AES | COMPLETED_HMAC */
STS_INVALID_ARGS = 4,
STS_INTERNAL_ERROR,
STS_ERROR
} JOB_STS;
typedef enum {
CBC = 1,
CNTR,
NULL_CIPHER,
DOCSIS_SEC_BPI,
#ifndef NO_GCM
GCM,
#endif /* !NO_GCM */
CUSTOM_CIPHER,
DES,
DOCSIS_DES,
CCM,
DES3,
PON_AES_CNTR,
ECB,
CNTR_BITLEN, /* 128-EEA2/NIA2 (3GPP) */
} JOB_CIPHER_MODE;
typedef enum {
ENCRYPT = 1,
DECRYPT
} JOB_CIPHER_DIRECTION;
typedef enum {
SHA1 = 1, /* HMAC-SHA1 */
SHA_224, /* HMAC-SHA224 */
SHA_256, /* HMAC-SHA256 */
SHA_384, /* HMAC-SHA384 */
SHA_512, /* HMAC-SHA512 */
AES_XCBC,
MD5, /* HMAC-MD5 */
NULL_HASH,
#ifndef NO_GCM
AES_GMAC,
#endif /* !NO_GCM */
CUSTOM_HASH,
AES_CCM, /* AES128-CCM */
AES_CMAC, /* AES128-CMAC */
PLAIN_SHA1, /* SHA1 */
PLAIN_SHA_224, /* SHA224 */
PLAIN_SHA_256, /* SHA256 */
PLAIN_SHA_384, /* SHA384 */
PLAIN_SHA_512, /* SHA512 */
AES_CMAC_BITLEN, /* 128-EIA2 (3GPP) */
PON_CRC_BIP
} JOB_HASH_ALG;
typedef enum {
CIPHER_HASH = 1,
HASH_CIPHER
} JOB_CHAIN_ORDER;
typedef enum {
AES_128_BYTES = 16,
AES_192_BYTES = 24,
AES_256_BYTES = 32
} AES_KEY_SIZE_BYTES;
typedef struct JOB_AES_HMAC {
/*
* For AES, aes_enc_key_expanded and aes_dec_key_expanded are
* expected to point to expanded keys structure.
* - AES-CTR, AES-ECB and AES-CCM, only aes_enc_key_expanded is used
* - DOCSIS (AES-CBC + AES-CFB), both pointers are used
* aes_enc_key_expanded has to be set always for the partial block
*
* For DES, aes_enc_key_expanded and aes_dec_key_expanded are
* expected to point to DES key schedule.
* - same key schedule used for enc and dec operations
*
* For 3DES, aes_enc_key_expanded and aes_dec_key_expanded are
* expected to point to an array of 3 pointers for
* the corresponding 3 key schedules.
* - same key schedule used for enc and dec operations
*/
const void *aes_enc_key_expanded; /* 16-byte aligned pointer. */
const void *aes_dec_key_expanded;
uint64_t aes_key_len_in_bytes; /* 16, 24 and 32 byte (128, 192 and
* 256-bit) keys supported */
const uint8_t *src; /* Input. May be cipher text or plaintext.
* In-place ciphering allowed. */
uint8_t *dst; /*Output. May be cipher text or plaintext.
* In-place ciphering allowed, i.e. dst = src. */
uint64_t cipher_start_src_offset_in_bytes;
/* Max len = 65472 bytes.
* IPSec case, the maximum cipher
* length would be:
* 65535 -
* 20 (outer IP header) -
* 24 (ESP header + IV) -
* 12 (supported ICV length) */
union {
uint64_t msg_len_to_cipher_in_bytes;
uint64_t msg_len_to_cipher_in_bits;
};
uint64_t hash_start_src_offset_in_bytes;
/* Max len = 65496 bytes.
* (Max cipher len +
* 24 bytes ESP header) */
union {
uint64_t msg_len_to_hash_in_bytes;
uint64_t msg_len_to_hash_in_bits;
};
const uint8_t *iv; /* AES IV. */
uint64_t iv_len_in_bytes; /* AES IV length in bytes. */
uint8_t *auth_tag_output; /* HMAC Tag output. This may point to
* a location in the src buffer
* (for in place)*/
uint64_t auth_tag_output_len_in_bytes; /* Authentication (i.e. HMAC) tag
* output length in bytes
* (may be a truncated value) */
/* Start algorithm-specific fields */
union {
struct _HMAC_specific_fields {
/* Hashed result of HMAC key xor'd with ipad (0x36). */
const uint8_t *_hashed_auth_key_xor_ipad;
/* Hashed result of HMAC key xor'd with opad (0x5c). */
const uint8_t *_hashed_auth_key_xor_opad;
} HMAC;
struct _AES_XCBC_specific_fields {
/* 16-byte aligned pointers */
const uint32_t *_k1_expanded;
const uint8_t *_k2;
const uint8_t *_k3;
} XCBC;
struct _AES_CCM_specific_fields {
/* Additional Authentication Data (AAD) */
const void *aad;
uint64_t aad_len_in_bytes; /* Length of AAD */
} CCM;
struct _AES_CMAC_specific_fields {
const void *_key_expanded; /* 16-byte aligned */
const void *_skey1;
const void *_skey2;
} CMAC;
#ifndef NO_GCM
struct _AES_GCM_specific_fields {
/* Additional Authentication Data (AAD) */
const void *aad;
uint64_t aad_len_in_bytes; /* Length of AAD */
} GCM;
#endif /* !NO_GCM */
} u;
JOB_STS status;
JOB_CIPHER_MODE cipher_mode; /* CBC, CNTR, DES, GCM etc. */
JOB_CIPHER_DIRECTION cipher_direction; /* Encrypt/decrypt */
JOB_HASH_ALG hash_alg; /* SHA-1 or others... */
JOB_CHAIN_ORDER chain_order; /* CIPHER_HASH or HASH_CIPHER.
* For AES-CCM, when encrypting,
* HASH_CIPHER must be selected,
* and when decrypting,
* CIPHER_HASH must be selected. */
void *user_data;
void *user_data2;
/*
* stateless custom cipher and hash
* Return:
* success: 0
* fail: other
*/
int (*cipher_func)(struct JOB_AES_HMAC *);
int (*hash_func)(struct JOB_AES_HMAC *);
} JOB_AES_HMAC;
/*
* Argument structures for various algorithms
*/
typedef struct {
const uint8_t *in[16];
uint8_t *out[16];
const uint32_t *keys[16];
DECLARE_ALIGNED(uint128_t IV[16], 64);
DECLARE_ALIGNED(uint128_t key_tab[15][16], 64);
} AES_ARGS;
typedef struct {
DECLARE_ALIGNED(uint32_t digest[SHA1_DIGEST_SZ], 32);
uint8_t *data_ptr[AVX512_NUM_SHA1_LANES];
} SHA1_ARGS;
typedef struct {
DECLARE_ALIGNED(uint32_t digest[SHA256_DIGEST_SZ], 32);
uint8_t *data_ptr[AVX512_NUM_SHA256_LANES];
} SHA256_ARGS;
typedef struct {
DECLARE_ALIGNED(uint64_t digest[SHA512_DIGEST_SZ], 32);
uint8_t *data_ptr[AVX512_NUM_SHA512_LANES];
} SHA512_ARGS;
typedef struct {
DECLARE_ALIGNED(uint32_t digest[MD5_DIGEST_SZ], 32);
uint8_t *data_ptr[AVX512_NUM_MD5_LANES];
} MD5_ARGS;
typedef struct {
const uint8_t *in[8];
const uint32_t *keys[8];
DECLARE_ALIGNED(uint128_t ICV[8], 32);
} AES_XCBC_ARGS_x8;
typedef struct {
const uint8_t *in[AVX512_NUM_DES_LANES];
uint8_t *out[AVX512_NUM_DES_LANES];
const uint8_t *keys[AVX512_NUM_DES_LANES];
uint32_t IV[AVX512_NUM_DES_LANES * 2]; /* uint32_t is more handy here */
uint32_t partial_len[AVX512_NUM_DES_LANES];
uint32_t block_len[AVX512_NUM_DES_LANES];
const uint8_t *last_in[AVX512_NUM_DES_LANES];
uint8_t *last_out[AVX512_NUM_DES_LANES];
} DES_ARGS_x16;
/* AES out-of-order scheduler fields */
typedef struct {
AES_ARGS args;
DECLARE_ALIGNED(uint16_t lens[16], 16);
/* each nibble is index (0...15) of an unused lane,
* the last nibble is set to F as a flag
*/
uint64_t unused_lanes;
JOB_AES_HMAC *job_in_lane[16];
uint64_t num_lanes_inuse;
} MB_MGR_AES_OOO;
/* AES XCBC out-of-order scheduler fields */
typedef struct {
DECLARE_ALIGNED(uint8_t final_block[2 * 16], 32);
JOB_AES_HMAC *job_in_lane;
uint64_t final_done;
} XCBC_LANE_DATA;
typedef struct {
AES_XCBC_ARGS_x8 args;
DECLARE_ALIGNED(uint16_t lens[8], 16);
/* each byte is index (0...3) of unused lanes
* byte 4 is set to FF as a flag
*/
uint64_t unused_lanes;
XCBC_LANE_DATA ldata[8];
} MB_MGR_AES_XCBC_OOO;
/* AES-CCM out-of-order scheduler structure */
typedef struct {
AES_ARGS args; /* need to re-use AES arguments */
DECLARE_ALIGNED(uint16_t lens[8], 16);
DECLARE_ALIGNED(uint16_t init_done[8], 16);
/* each byte is index (0...3) of unused lanes
* byte 4 is set to FF as a flag
*/
uint64_t unused_lanes;
JOB_AES_HMAC *job_in_lane[8];
DECLARE_ALIGNED(uint8_t init_blocks[8 * (4 * 16)], 32);
} MB_MGR_CCM_OOO;
/* AES-CMAC out-of-order scheduler structure */
typedef struct {
AES_ARGS args; /* need to re-use AES arguments */
DECLARE_ALIGNED(uint16_t lens[8], 16);
DECLARE_ALIGNED(uint16_t init_done[8], 16);
/* each byte is index (0...3) of unused lanes
* byte 4 is set to FF as a flag
*/
uint64_t unused_lanes;
JOB_AES_HMAC *job_in_lane[8];
DECLARE_ALIGNED(uint8_t scratch[8 * 16], 32);
} MB_MGR_CMAC_OOO;
/* DES out-of-order scheduler fields */
typedef struct {
DES_ARGS_x16 args;
DECLARE_ALIGNED(uint16_t lens[16], 16);
/* each nibble is index (0...7) of unused lanes
* nibble 8 is set to F as a flag
*/
uint64_t unused_lanes;
JOB_AES_HMAC *job_in_lane[16];
uint64_t num_lanes_inuse;
} MB_MGR_DES_OOO;
/* HMAC-SHA1 and HMAC-SHA256/224 */
typedef struct {
/* YMM aligned access to extra_block */
DECLARE_ALIGNED(uint8_t extra_block[2 * SHA1_BLOCK_SIZE+8], 32);
JOB_AES_HMAC *job_in_lane;
uint8_t outer_block[64];
uint32_t outer_done;
uint32_t extra_blocks; /* num extra blocks (1 or 2) */
uint32_t size_offset; /* offset in extra_block to start of
* size field */
uint32_t start_offset; /* offset to start of data */
} HMAC_SHA1_LANE_DATA;
/* HMAC-SHA512/384 */
typedef struct {
DECLARE_ALIGNED(uint8_t extra_block[2 * SHA_512_BLOCK_SIZE + 16], 32);
uint8_t outer_block[SHA_512_BLOCK_SIZE];
JOB_AES_HMAC *job_in_lane;
uint32_t outer_done;
uint32_t extra_blocks; /* num extra blocks (1 or 2) */
uint32_t size_offset; /* offset in extra_block to start of
* size field */
uint32_t start_offset; /* offset to start of data */
} HMAC_SHA512_LANE_DATA;
/*
* unused_lanes contains a list of unused lanes stored as bytes or as
* nibbles depending on the arch. The end of list is either FF or F.
*/
typedef struct {
SHA1_ARGS args;
DECLARE_ALIGNED(uint16_t lens[16], 32);
uint64_t unused_lanes;
HMAC_SHA1_LANE_DATA ldata[AVX512_NUM_SHA1_LANES];
uint32_t num_lanes_inuse;
} MB_MGR_HMAC_SHA_1_OOO;
typedef struct {
SHA256_ARGS args;
DECLARE_ALIGNED(uint16_t lens[16], 16);
uint64_t unused_lanes;
HMAC_SHA1_LANE_DATA ldata[AVX512_NUM_SHA256_LANES];
uint32_t num_lanes_inuse;
} MB_MGR_HMAC_SHA_256_OOO;
typedef struct {
SHA512_ARGS args;
DECLARE_ALIGNED(uint16_t lens[8], 16);
uint64_t unused_lanes;
HMAC_SHA512_LANE_DATA ldata[AVX512_NUM_SHA512_LANES];
} MB_MGR_HMAC_SHA_512_OOO;
/* MD5-HMAC out-of-order scheduler fields */
typedef struct {
MD5_ARGS args;
DECLARE_ALIGNED(uint16_t lens[AVX512_NUM_MD5_LANES], 16);
/*
* In the avx2 case, all 16 nibbles of unused lanes are used.
* In that case num_lanes_inuse is used to detect the end of the list
*/
uint64_t unused_lanes;
HMAC_SHA1_LANE_DATA ldata[AVX512_NUM_MD5_LANES];
uint32_t num_lanes_inuse;
} MB_MGR_HMAC_MD5_OOO;
/* KASUMI */
/* 64 precomputed words for key schedule */
#define KASUMI_KEY_SCHEDULE_SIZE 64
/**
* Structure to maintain internal key scheduling
*/
typedef struct kasumi_key_sched_s {
/* Kasumi internal scheduling */
uint16_t sk16[KASUMI_KEY_SCHEDULE_SIZE]; /* key schedule */
uint16_t msk16[KASUMI_KEY_SCHEDULE_SIZE]; /* modified key schedule */
} kasumi_key_sched_t;
/* GCM data structures */
#define GCM_BLOCK_LEN 16
/**
* @brief holds GCM operation context
*/
struct gcm_context_data {
/* init, update and finalize context data */
uint8_t aad_hash[GCM_BLOCK_LEN];
uint64_t aad_length;
uint64_t in_length;
uint8_t partial_block_enc_key[GCM_BLOCK_LEN];
uint8_t orig_IV[GCM_BLOCK_LEN];
uint8_t current_counter[GCM_BLOCK_LEN];
uint64_t partial_block_length;
};
/* Authenticated Tag Length in bytes.
* Valid values are 16 (most likely), 12 or 8. */
#define MAX_TAG_LEN (16)
/*
* IV data is limited to 16 bytes as follows:
* 12 bytes is provided by an application -
* pre-counter block j0: 4 byte salt (from Security Association)
* concatenated with 8 byte Initialization Vector (from IPSec ESP
* Payload).
* 4 byte value 0x00000001 is padded automatically by the library -
* there is no need to add these 4 bytes on application side anymore.
*/
#define GCM_IV_DATA_LEN (12)
#define LONGEST_TESTED_AAD_LENGTH (2 * 1024)
/* Key lengths of 128 and 256 supported */
#define GCM_128_KEY_LEN (16)
#define GCM_192_KEY_LEN (24)
#define GCM_256_KEY_LEN (32)
/* #define GCM_BLOCK_LEN 16 */
#define GCM_ENC_KEY_LEN 16
#define GCM_KEY_SETS (15) /*exp key + 14 exp round keys*/
/**
* @brief holds intermediate key data needed to improve performance
*
* gcm_key_data hold internal key information used by gcm128, gcm192 and gcm256.
*/
#ifdef __WIN32
__declspec(align(64))
#endif /* WIN32 */
struct gcm_key_data {
uint8_t expanded_keys[GCM_ENC_KEY_LEN * GCM_KEY_SETS];
union {
/* Storage for precomputed hash keys */
struct {
/*
* This is needed for schoolbook multiply purposes.
* (HashKey<<1 mod poly), (HashKey^2<<1 mod poly), ...,
* (Hashkey^48<<1 mod poly)
*/
uint8_t shifted_hkey[GCM_ENC_KEY_LEN * 8];
/*
* This is needed for Karatsuba multiply purposes.
* Storage for XOR of High 64 bits and low 64 bits
* of HashKey mod poly.
*
* (HashKey<<1 mod poly), (HashKey^2<<1 mod poly), ...,
* (Hashkey^128<<1 mod poly)
*/
uint8_t shifted_hkey_k[GCM_ENC_KEY_LEN * 8];
} sse_avx;
struct {
/*
* This is needed for schoolbook multiply purposes.
* (HashKey<<1 mod poly), (HashKey^2<<1 mod poly), ...,
* (Hashkey^48<<1 mod poly)
*/
uint8_t shifted_hkey[GCM_ENC_KEY_LEN * 8];
} avx2_avx512;
struct {
#ifdef GCM_BIG_DATA
/*
* (HashKey<<1 mod poly), (HashKey^2<<1 mod poly), ...,
* (Hashkey^128<<1 mod poly)
*/
uint8_t shifted_hkey[GCM_ENC_KEY_LEN * 128];
#else
/*
* (HashKey<<1 mod poly), (HashKey^2<<1 mod poly), ...,
* (Hashkey^48<<1 mod poly)
*/
uint8_t shifted_hkey[GCM_ENC_KEY_LEN * 48];
#endif
} vaes_avx512;
} ghash_keys;
}
#ifdef LINUX
__attribute__((aligned(64)));
#else
;
#endif
/* ========================================================================== */
/* API data type definitions */
struct MB_MGR;
typedef void (*init_mb_mgr_t)(struct MB_MGR *);
typedef JOB_AES_HMAC *(*get_next_job_t)(struct MB_MGR *);
typedef JOB_AES_HMAC *(*submit_job_t)(struct MB_MGR *);
typedef JOB_AES_HMAC *(*get_completed_job_t)(struct MB_MGR *);
typedef JOB_AES_HMAC *(*flush_job_t)(struct MB_MGR *);
typedef uint32_t (*queue_size_t)(struct MB_MGR *);
typedef void (*keyexp_t)(const void *, void *, void *);
typedef void (*cmac_subkey_gen_t)(const void *, void *, void *);
typedef void (*hash_one_block_t)(const void *, void *);
typedef void (*hash_fn_t)(const void *, const uint64_t, void *);
typedef void (*xcbc_keyexp_t)(const void *, void *, void *, void *);
typedef int (*des_keysched_t)(uint64_t *, const void *);
typedef void (*aes128_cfb_t)(void *, const void *, const void *, const void *,
uint64_t);
typedef void (*aes_gcm_enc_dec_t)(const struct gcm_key_data *,
struct gcm_context_data *,
uint8_t *, uint8_t const *, uint64_t,
const uint8_t *, uint8_t const *, uint64_t,
uint8_t *, uint64_t);
typedef void (*aes_gcm_init_t)(const struct gcm_key_data *,
struct gcm_context_data *,
const uint8_t *, uint8_t const *, uint64_t);
typedef void (*aes_gcm_enc_dec_update_t)(const struct gcm_key_data *,
struct gcm_context_data *,
uint8_t *, const uint8_t *, uint64_t);
typedef void (*aes_gcm_enc_dec_finalize_t)(const struct gcm_key_data *,
struct gcm_context_data *,
uint8_t *, uint64_t);
typedef void (*aes_gcm_precomp_t)(struct gcm_key_data *);
typedef void (*aes_gcm_pre_t)(const void *, struct gcm_key_data *);
typedef void (*zuc_eea3_1_buffer_t)(const void *, const void *, const void *,
void *, const uint32_t);
typedef void (*zuc_eea3_4_buffer_t)(const void * const *, const void * const *,
const void * const *, void **,
const uint32_t *);
typedef void (*zuc_eea3_n_buffer_t)(const void * const *, const void * const *,
const void * const *, void **,
const uint32_t *, const uint32_t);
typedef void (*zuc_eia3_1_buffer_t)(const void *, const void *, const void *,
const uint32_t, uint32_t *);
typedef void (*kasumi_f8_1_buffer_t)(const kasumi_key_sched_t *,
const uint64_t, const void *, void *,
const uint32_t);
typedef void (*kasumi_f8_1_buffer_bit_t)(const kasumi_key_sched_t *,
const uint64_t, const void *,
void *,
const uint32_t, const uint32_t);
typedef void (*kasumi_f8_2_buffer_t)(const kasumi_key_sched_t *,
const uint64_t, const uint64_t,
const void *, void *,
const uint32_t,
const void *, void *,
const uint32_t);
typedef void (*kasumi_f8_3_buffer_t)(const kasumi_key_sched_t *,
const uint64_t, const uint64_t,
const uint64_t,
const void *, void *,
const void *, void *,
const void *, void *,
const uint32_t);
typedef void (*kasumi_f8_4_buffer_t)(const kasumi_key_sched_t *,
const uint64_t, const uint64_t,
const uint64_t, const uint64_t,
const void *, void *,
const void *, void *,
const void *, void *,
const void *, void *,
const uint32_t);
typedef void (*kasumi_f8_n_buffer_t)(const kasumi_key_sched_t *,
const uint64_t *, const void * const *,
void **, const uint32_t *,
const uint32_t);
typedef void (*kasumi_f9_1_buffer_user_t)(const kasumi_key_sched_t *,
const uint64_t, const void *,
const uint32_t, void *,
const uint32_t);
typedef void (*kasumi_f9_1_buffer_t)(const kasumi_key_sched_t *,
const void *,
const uint32_t, void *);
typedef int (*kasumi_init_f8_key_sched_t)(const void *,
kasumi_key_sched_t *);
typedef int (*kasumi_init_f9_key_sched_t)(const void *,
kasumi_key_sched_t *);
typedef size_t (*kasumi_key_sched_size_t)(void);
/**
* Snow3G key scheduling structure
*/
typedef struct snow3g_key_schedule_s {
/* KEY */
uint32_t k[4];
} snow3g_key_schedule_t;
typedef void (*snow3g_f8_1_buffer_t)(const snow3g_key_schedule_t *,
const void *, const void *,
void *, const uint32_t);
typedef void (*snow3g_f8_1_buffer_bit_t)(const snow3g_key_schedule_t *,
const void *, const void *, void *,
const uint32_t, const uint32_t);
typedef void (*snow3g_f8_2_buffer_t)(const snow3g_key_schedule_t *,
const void *, const void *,
const void *, void *, const uint32_t,
const void *, void *,const uint32_t);
typedef void (*snow3g_f8_4_buffer_t)(const snow3g_key_schedule_t *,
const void *, const void *,const void *,
const void *, const void *, void *,
const uint32_t, const void *, void *,
const uint32_t, const void *, void *,
const uint32_t, const void *, void *,
const uint32_t);
typedef void (*snow3g_f8_8_buffer_t)(const snow3g_key_schedule_t *,
const void *, const void *,const void *,
const void *, const void *, const void *,
const void *, const void *, const void *,
void *, const uint32_t, const void *,
void *, const uint32_t, const void *,
void *, const uint32_t, const void *,
void *, const uint32_t, const void *,
void *, const uint32_t, const void *,
void *, const uint32_t, const void *,
void *, const uint32_t, const void *,
void *, const uint32_t);
typedef void
(*snow3g_f8_8_buffer_multikey_t)(const snow3g_key_schedule_t * const [],
const void * const [], const void * const [],
void *[], const uint32_t[]);
typedef void (*snow3g_f8_n_buffer_t)(const snow3g_key_schedule_t *,
const void * const [],
const void * const [],
void *[], const uint32_t[],
const uint32_t);
typedef void
(*snow3g_f8_n_buffer_multikey_t)(const snow3g_key_schedule_t * const [],
const void * const [],
const void * const [],
void *[], const uint32_t[],
const uint32_t);
typedef void (*snow3g_f9_1_buffer_t)(const snow3g_key_schedule_t *,
const void *, const void *,
const uint64_t, void *);
typedef int (*snow3g_init_key_sched_t)(const void *,
snow3g_key_schedule_t *);
typedef size_t (*snow3g_key_sched_size_t)(void);
/* ========================================================================== */
/* Multi-buffer manager flags passed to alloc_mb_mgr() */
#define IMB_FLAG_SHANI_OFF (1ULL << 0) /* disable use of SHANI extension */
#define IMB_FLAG_AESNI_OFF (1ULL << 1) /* disable use of AESNI extension */
/* ========================================================================== */
/* Multi-buffer manager detected features
* - if bit is set then hardware supports given extension
* - valid after call to init_mb_mgr() or alloc_mb_mgr()
* - some HW supported features can be disabled via IMB_FLAG_xxx (see above)
*/
#define IMB_FEATURE_SHANI (1ULL << 0)
#define IMB_FEATURE_AESNI (1ULL << 1)
#define IMB_FEATURE_PCLMULQDQ (1ULL << 2)
#define IMB_FEATURE_CMOV (1ULL << 3)
#define IMB_FEATURE_SSE4_2 (1ULL << 4)
#define IMB_FEATURE_AVX (1ULL << 5)
#define IMB_FEATURE_AVX2 (1ULL << 6)
#define IMB_FEATURE_AVX512F (1ULL << 7)
#define IMB_FEATURE_AVX512DQ (1ULL << 8)
#define IMB_FEATURE_AVX512CD (1ULL << 9)
#define IMB_FEATURE_AVX512BW (1ULL << 10)
#define IMB_FEATURE_AVX512VL (1ULL << 11)
#define IMB_FEATURE_AVX512_SKX (IMB_FEATURE_AVX512F | IMB_FEATURE_AVX512DQ | \
IMB_FEATURE_AVX512CD | IMB_FEATURE_AVX512BW | \
IMB_FEATURE_AVX512VL)
#define IMB_FEATURE_VAES (1ULL << 12)
#define IMB_FEATURE_VPCLMULQDQ (1ULL << 13)
#define IMB_FEATURE_SAFE_DATA (1ULL << 14)
#define IMB_FEATURE_SAFE_PARAM (1ULL << 15)
/* ========================================================================== */
/* TOP LEVEL (MB_MGR) Data structure fields */
#define MAX_JOBS 128
typedef struct MB_MGR {
/*
* flags - passed to alloc_mb_mgr()
* features - reflects features of multi-buffer instance
*/
uint64_t flags;
uint64_t features;
/*
* Reserved for the future
*/
uint64_t reserved[6];
/*
* ARCH handlers / API
* Careful as changes here can break ABI compatibility
*/
get_next_job_t get_next_job;
submit_job_t submit_job;
submit_job_t submit_job_nocheck;
get_completed_job_t get_completed_job;
flush_job_t flush_job;
queue_size_t queue_size;
keyexp_t keyexp_128;
keyexp_t keyexp_192;
keyexp_t keyexp_256;
cmac_subkey_gen_t cmac_subkey_gen_128;
xcbc_keyexp_t xcbc_keyexp;
des_keysched_t des_key_sched;
hash_one_block_t sha1_one_block;
hash_one_block_t sha224_one_block;
hash_one_block_t sha256_one_block;
hash_one_block_t sha384_one_block;
hash_one_block_t sha512_one_block;
hash_one_block_t md5_one_block;
hash_fn_t sha1;
hash_fn_t sha224;
hash_fn_t sha256;
hash_fn_t sha384;
hash_fn_t sha512;
aes128_cfb_t aes128_cfb_one;
aes_gcm_enc_dec_t gcm128_enc;
aes_gcm_enc_dec_t gcm192_enc;
aes_gcm_enc_dec_t gcm256_enc;
aes_gcm_enc_dec_t gcm128_dec;
aes_gcm_enc_dec_t gcm192_dec;
aes_gcm_enc_dec_t gcm256_dec;
aes_gcm_init_t gcm128_init;
aes_gcm_init_t gcm192_init;
aes_gcm_init_t gcm256_init;
aes_gcm_enc_dec_update_t gcm128_enc_update;
aes_gcm_enc_dec_update_t gcm192_enc_update;
aes_gcm_enc_dec_update_t gcm256_enc_update;
aes_gcm_enc_dec_update_t gcm128_dec_update;
aes_gcm_enc_dec_update_t gcm192_dec_update;
aes_gcm_enc_dec_update_t gcm256_dec_update;
aes_gcm_enc_dec_finalize_t gcm128_enc_finalize;
aes_gcm_enc_dec_finalize_t gcm192_enc_finalize;
aes_gcm_enc_dec_finalize_t gcm256_enc_finalize;
aes_gcm_enc_dec_finalize_t gcm128_dec_finalize;
aes_gcm_enc_dec_finalize_t gcm192_dec_finalize;
aes_gcm_enc_dec_finalize_t gcm256_dec_finalize;
aes_gcm_precomp_t gcm128_precomp;
aes_gcm_precomp_t gcm192_precomp;
aes_gcm_precomp_t gcm256_precomp;
aes_gcm_pre_t gcm128_pre;
aes_gcm_pre_t gcm192_pre;
aes_gcm_pre_t gcm256_pre;
zuc_eea3_1_buffer_t eea3_1_buffer;
zuc_eea3_4_buffer_t eea3_4_buffer;
zuc_eea3_n_buffer_t eea3_n_buffer;
zuc_eia3_1_buffer_t eia3_1_buffer;
kasumi_f8_1_buffer_t f8_1_buffer;
kasumi_f8_1_buffer_bit_t f8_1_buffer_bit;
kasumi_f8_2_buffer_t f8_2_buffer;
kasumi_f8_3_buffer_t f8_3_buffer;
kasumi_f8_4_buffer_t f8_4_buffer;
kasumi_f8_n_buffer_t f8_n_buffer;
kasumi_f9_1_buffer_t f9_1_buffer;
kasumi_f9_1_buffer_user_t f9_1_buffer_user;
kasumi_init_f8_key_sched_t kasumi_init_f8_key_sched;
kasumi_init_f9_key_sched_t kasumi_init_f9_key_sched;
kasumi_key_sched_size_t kasumi_key_sched_size;
snow3g_f8_1_buffer_bit_t snow3g_f8_1_buffer_bit;
snow3g_f8_1_buffer_t snow3g_f8_1_buffer;
snow3g_f8_2_buffer_t snow3g_f8_2_buffer;
snow3g_f8_4_buffer_t snow3g_f8_4_buffer;
snow3g_f8_8_buffer_t snow3g_f8_8_buffer;
snow3g_f8_n_buffer_t snow3g_f8_n_buffer;
snow3g_f8_8_buffer_multikey_t snow3g_f8_8_buffer_multikey;
snow3g_f8_n_buffer_multikey_t snow3g_f8_n_buffer_multikey;
snow3g_f9_1_buffer_t snow3g_f9_1_buffer;
snow3g_init_key_sched_t snow3g_init_key_sched;
snow3g_key_sched_size_t snow3g_key_sched_size;
/* in-order scheduler fields */
int earliest_job; /* byte offset, -1 if none */
int next_job; /* byte offset */
JOB_AES_HMAC jobs[MAX_JOBS];
/* out of order managers */
DECLARE_ALIGNED(MB_MGR_AES_OOO aes128_ooo, 64);
DECLARE_ALIGNED(MB_MGR_AES_OOO aes192_ooo, 64);
DECLARE_ALIGNED(MB_MGR_AES_OOO aes256_ooo, 64);
DECLARE_ALIGNED(MB_MGR_AES_OOO docsis_sec_ooo, 64);
DECLARE_ALIGNED(MB_MGR_DES_OOO des_enc_ooo, 64);
DECLARE_ALIGNED(MB_MGR_DES_OOO des_dec_ooo, 64);
DECLARE_ALIGNED(MB_MGR_DES_OOO des3_enc_ooo, 64);
DECLARE_ALIGNED(MB_MGR_DES_OOO des3_dec_ooo, 64);
DECLARE_ALIGNED(MB_MGR_DES_OOO docsis_des_enc_ooo, 64);
DECLARE_ALIGNED(MB_MGR_DES_OOO docsis_des_dec_ooo, 64);
DECLARE_ALIGNED(MB_MGR_HMAC_SHA_1_OOO hmac_sha_1_ooo, 64);
DECLARE_ALIGNED(MB_MGR_HMAC_SHA_256_OOO hmac_sha_224_ooo, 64);
DECLARE_ALIGNED(MB_MGR_HMAC_SHA_256_OOO hmac_sha_256_ooo, 64);
DECLARE_ALIGNED(MB_MGR_HMAC_SHA_512_OOO hmac_sha_384_ooo, 64);
DECLARE_ALIGNED(MB_MGR_HMAC_SHA_512_OOO hmac_sha_512_ooo, 64);
DECLARE_ALIGNED(MB_MGR_HMAC_MD5_OOO hmac_md5_ooo, 64);
DECLARE_ALIGNED(MB_MGR_AES_XCBC_OOO aes_xcbc_ooo, 64);
DECLARE_ALIGNED(MB_MGR_CCM_OOO aes_ccm_ooo, 64);
DECLARE_ALIGNED(MB_MGR_CMAC_OOO aes_cmac_ooo, 64);
} MB_MGR;
/* ========================================================================== */
/* API definitions */
/**
* @brief Get library version in string format
*
* @return library version string
*/
IMB_DLL_EXPORT const char *imb_get_version_str(void);
/**
* @brief Get library version in numerical format
*
* Use IMB_VERSION() macro to compare this
* numerical version against known library version.
*
* @return library version number
*/
IMB_DLL_EXPORT unsigned imb_get_version(void);