forked from intel/QAT_Engine
-
Notifications
You must be signed in to change notification settings - Fork 0
/
qat_ciphers.c
1802 lines (1611 loc) · 66.2 KB
/
qat_ciphers.c
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
/* ====================================================================
*
*
* BSD LICENSE
*
* Copyright(c) 2016-2019 Intel Corporation.
* All rights reserved.
*
* 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.
*
*
* ====================================================================
*/
/*
* This file contains modified code from OpenSSL/BoringSSL used
* in order to run certain operations in constant time.
* It is subject to the following license:
*/
/*
* Copyright 2002-2016 The OpenSSL Project Authors. All Rights Reserved.
*
* Licensed under the OpenSSL license (the "License"). You may not use
* this file except in compliance with the License. You can obtain a copy
* in the file LICENSE in the source distribution or at
* https://www.openssl.org/source/license.html
*/
/*****************************************************************************
* @file qat_ciphers.c
*
* This file contains the engine implementations for cipher operations
*
*****************************************************************************/
#ifndef _GNU_SOURCE
# define _GNU_SOURCE
#endif
#include <pthread.h>
#include <signal.h>
#ifdef USE_QAT_CONTIG_MEM
# include "qae_mem_utils.h"
#endif
#ifdef USE_QAE_MEM
# include "cmn_mem_drv_inf.h"
#endif
#include "qat_utils.h"
#include "e_qat.h"
#include "qat_callback.h"
#include "qat_polling.h"
#include "qat_events.h"
#include "e_qat_err.h"
#include "cpa.h"
#include "cpa_types.h"
#include "cpa_cy_sym.h"
#include "qat_ciphers.h"
#include "qat_constant_time.h"
#include <openssl/evp.h>
#include <openssl/aes.h>
#include <openssl/err.h>
#include <openssl/sha.h>
#include <openssl/tls1.h>
#include <openssl/async.h>
#include <openssl/lhash.h>
#include <openssl/ssl.h>
#include <string.h>
#ifdef OPENSSL_ENABLE_QAT_CIPHERS
# ifdef OPENSSL_DISABLE_QAT_CIPHERS
# undef OPENSSL_DISABLE_QAT_CIPHERS
# endif
#endif
#define GET_TLS_HDR(qctx, i) ((qctx)->aad[(i)])
#define GET_TLS_VERSION(hdr) (((hdr)[9]) << QAT_BYTE_SHIFT | (hdr)[10])
#define GET_TLS_PAYLOAD_LEN(hdr) (((((hdr)[11]) << QAT_BYTE_SHIFT) & 0xff00) | \
((hdr)[12] & 0x00ff))
#define SET_TLS_PAYLOAD_LEN(hdr, len) \
do { \
hdr[11] = (len & 0xff00) >> QAT_BYTE_SHIFT; \
hdr[12] = len & 0xff; \
} while(0)
#define FLATBUFF_ALLOC_AND_CHAIN(b1, b2, len) \
do { \
(b1).pData = qaeCryptoMemAlloc(len, __FILE__, __LINE__); \
(b2).pData = (b1).pData; \
(b1).dataLenInBytes = len; \
(b2).dataLenInBytes = len; \
} while(0)
# define GET_SW_CIPHER(ctx) \
qat_chained_cipher_sw_impl(EVP_CIPHER_CTX_nid((ctx)))
#define GET_SW_NON_CHAINED_CIPHER(ctx) \
get_cipher_from_nid(EVP_CIPHER_CTX_nid((ctx)))
#define DEBUG_PPL DEBUG
#ifndef OPENSSL_DISABLE_QAT_CIPHERS
static int qat_chained_ciphers_init(EVP_CIPHER_CTX *ctx,
const unsigned char *inkey,
const unsigned char *iv, int enc);
static int qat_chained_ciphers_cleanup(EVP_CIPHER_CTX *ctx);
static int qat_chained_ciphers_do_cipher(EVP_CIPHER_CTX *ctx,
unsigned char *out,
const unsigned char *in, size_t len);
static int qat_chained_ciphers_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg,
void *ptr);
#endif
static CpaStatus qat_sym_perform_op(int inst_num,
void *pCallbackTag,
const CpaCySymOpData * pOpData,
const CpaBufferList * pSrcBuffer,
CpaBufferList * pDstBuffer,
CpaBoolean * pVerifyResult);
int qatPerformOpRetries = 0;
typedef struct _chained_info {
const int nid;
EVP_CIPHER *cipher;
const int keylen;
} chained_info;
static chained_info info[] = {
{NID_aes_128_cbc_hmac_sha1, NULL, AES_KEY_SIZE_128},
{NID_aes_128_cbc_hmac_sha256, NULL, AES_KEY_SIZE_128},
{NID_aes_256_cbc_hmac_sha1, NULL, AES_KEY_SIZE_256},
{NID_aes_256_cbc_hmac_sha256, NULL, AES_KEY_SIZE_256},
};
static const unsigned int num_cc = sizeof(info) / sizeof(chained_info);
/* Qat Symmetric cipher function register */
int qat_cipher_nids[] = {
NID_aes_128_cbc_hmac_sha1,
NID_aes_128_cbc_hmac_sha256,
NID_aes_256_cbc_hmac_sha1,
NID_aes_256_cbc_hmac_sha256,
};
/* Setup template for Session Setup Data as most of the fields
* are constant. The constant values of some of the fields are
* chosen for Encryption operation.
*/
static const CpaCySymSessionSetupData template_ssd = {
.sessionPriority = CPA_CY_PRIORITY_HIGH,
.symOperation = CPA_CY_SYM_OP_ALGORITHM_CHAINING,
.cipherSetupData = {
.cipherAlgorithm = CPA_CY_SYM_CIPHER_AES_CBC,
.cipherKeyLenInBytes = 0,
.pCipherKey = NULL,
.cipherDirection = CPA_CY_SYM_CIPHER_DIRECTION_ENCRYPT,
},
.hashSetupData = {
.hashAlgorithm = CPA_CY_SYM_HASH_SHA1,
.hashMode = CPA_CY_SYM_HASH_MODE_AUTH,
.digestResultLenInBytes = 0,
.authModeSetupData = {
.authKey = NULL,
.authKeyLenInBytes = HMAC_KEY_SIZE,
.aadLenInBytes = 0,
},
.nestedModeSetupData = {0},
},
.algChainOrder = CPA_CY_SYM_ALG_CHAIN_ORDER_HASH_THEN_CIPHER,
.digestIsAppended = CPA_TRUE,
.verifyDigest = CPA_FALSE,
.partialsNotRequired = CPA_TRUE,
};
static const CpaCySymOpData template_opData = {
.sessionCtx = NULL,
.packetType = CPA_CY_SYM_PACKET_TYPE_FULL,
.pIv = NULL,
.ivLenInBytes = 0,
.cryptoStartSrcOffsetInBytes = QAT_BYTE_ALIGNMENT,
.messageLenToCipherInBytes = 0,
.hashStartSrcOffsetInBytes = QAT_BYTE_ALIGNMENT - TLS_VIRT_HDR_SIZE,
.messageLenToHashInBytes = 0,
.pDigestResult = NULL,
.pAdditionalAuthData = NULL
};
static inline int get_digest_len(int nid)
{
return (((nid) == NID_aes_128_cbc_hmac_sha1 ||
(nid) == NID_aes_256_cbc_hmac_sha1) ?
SHA_DIGEST_LENGTH : SHA256_DIGEST_LENGTH);
}
static inline const EVP_CIPHER *qat_chained_cipher_sw_impl(int nid)
{
switch (nid) {
case NID_aes_128_cbc_hmac_sha1:
return EVP_aes_128_cbc_hmac_sha1();
case NID_aes_256_cbc_hmac_sha1:
return EVP_aes_256_cbc_hmac_sha1();
case NID_aes_128_cbc_hmac_sha256:
return EVP_aes_128_cbc_hmac_sha256();
case NID_aes_256_cbc_hmac_sha256:
return EVP_aes_256_cbc_hmac_sha256();
default:
WARN("Invalid nid %d\n", nid);
return NULL;
}
}
static inline const EVP_CIPHER *get_cipher_from_nid(int nid)
{
switch (nid) {
case NID_aes_128_cbc_hmac_sha1:
case NID_aes_128_cbc_hmac_sha256:
return EVP_aes_128_cbc();
case NID_aes_256_cbc_hmac_sha1:
case NID_aes_256_cbc_hmac_sha256:
return EVP_aes_256_cbc();
default:
WARN("Invalid nid %d\n", nid);
return NULL;
}
}
static inline void qat_chained_ciphers_free_qop(qat_op_params **pqop,
unsigned int *num_elem)
{
unsigned int i = 0;
qat_op_params *qop = NULL;
if (pqop != NULL && ((qop = *pqop) != NULL)) {
for (i = 0; i < *num_elem; i++) {
QAT_CHK_QMFREE_FLATBUFF(qop[i].src_fbuf[0]);
QAT_CHK_QMFREE_FLATBUFF(qop[i].src_fbuf[1]);
QAT_QMEMFREE_BUFF(qop[i].src_sgl.pPrivateMetaData);
QAT_QMEMFREE_BUFF(qop[i].dst_sgl.pPrivateMetaData);
QAT_QMEMFREE_BUFF(qop[i].op_data.pIv);
}
OPENSSL_free(qop);
*pqop = NULL;
*num_elem = 0;
}
}
static const EVP_CIPHER *qat_create_cipher_meth(int nid, int keylen)
{
#ifndef OPENSSL_DISABLE_QAT_CIPHERS
EVP_CIPHER *c = NULL;
int res = 1;
if ((c = EVP_CIPHER_meth_new(nid, AES_BLOCK_SIZE, keylen)) == NULL) {
WARN("Failed to allocate cipher methods for nid %d\n", nid);
return NULL;
}
res &= EVP_CIPHER_meth_set_iv_length(c, AES_IV_LEN);
res &= EVP_CIPHER_meth_set_flags(c, QAT_CHAINED_FLAG);
res &= EVP_CIPHER_meth_set_init(c, qat_chained_ciphers_init);
res &= EVP_CIPHER_meth_set_do_cipher(c, qat_chained_ciphers_do_cipher);
res &= EVP_CIPHER_meth_set_cleanup(c, qat_chained_ciphers_cleanup);
res &= EVP_CIPHER_meth_set_impl_ctx_size(c, sizeof(qat_chained_ctx));
res &= EVP_CIPHER_meth_set_set_asn1_params(c, EVP_CIPH_FLAG_DEFAULT_ASN1 ?
NULL : EVP_CIPHER_set_asn1_iv);
res &= EVP_CIPHER_meth_set_get_asn1_params(c, EVP_CIPH_FLAG_DEFAULT_ASN1 ?
NULL : EVP_CIPHER_get_asn1_iv);
res &= EVP_CIPHER_meth_set_ctrl(c, qat_chained_ciphers_ctrl);
if (res == 0) {
WARN("Failed to set cipher methods for nid %d\n", nid);
EVP_CIPHER_meth_free(c);
c = NULL;
}
return c;
#else
return qat_chained_cipher_sw_impl(nid);
#endif
}
void qat_create_ciphers(void)
{
int i;
for (i = 0; i < num_cc; i++) {
if (info[i].cipher == NULL) {
info[i].cipher = (EVP_CIPHER *)
qat_create_cipher_meth(info[i].nid, info[i].keylen);
}
}
}
void qat_free_ciphers(void)
{
int i;
for (i = 0; i < num_cc; i++) {
if (info[i].cipher != NULL) {
#ifndef OPENSSL_DISABLE_QAT_CIPHERS
EVP_CIPHER_meth_free(info[i].cipher);
#endif
info[i].cipher = NULL;
}
}
}
#ifndef OPENSSL_ENABLE_QAT_SMALL_PACKET_CIPHER_OFFLOADS
# define CRYPTO_SMALL_PACKET_OFFLOAD_THRESHOLD_DEFAULT 2048
typedef struct cipher_threshold_table_s {
int nid;
int threshold;
} PKT_THRESHOLD;
static PKT_THRESHOLD qat_pkt_threshold_table[] = {
{NID_aes_128_cbc_hmac_sha1, CRYPTO_SMALL_PACKET_OFFLOAD_THRESHOLD_DEFAULT},
{NID_aes_256_cbc_hmac_sha1, CRYPTO_SMALL_PACKET_OFFLOAD_THRESHOLD_DEFAULT},
{NID_aes_128_cbc_hmac_sha256,
CRYPTO_SMALL_PACKET_OFFLOAD_THRESHOLD_DEFAULT},
{NID_aes_256_cbc_hmac_sha256, CRYPTO_SMALL_PACKET_OFFLOAD_THRESHOLD_DEFAULT}
};
static int pkt_threshold_table_size =
(sizeof(qat_pkt_threshold_table) / sizeof(qat_pkt_threshold_table[0]));
int qat_pkt_threshold_table_set_threshold(const char *cn,
int threshold)
{
int i = 0;
int nid;
if(threshold < 0)
threshold = 0;
else if (threshold > 16384)
threshold = 16384;
DEBUG("Set small packet threshold for %s: %d\n", cn, threshold);
nid = OBJ_sn2nid(cn);
do {
if (qat_pkt_threshold_table[i].nid == nid) {
qat_pkt_threshold_table[i].threshold = threshold;
return 1;
}
} while (++i < pkt_threshold_table_size);
WARN("nid %d not found in threshold table\n", nid);
return 0;
}
static inline int qat_pkt_threshold_table_get_threshold(int nid)
{
int i = 0;
do {
if (qat_pkt_threshold_table[i].nid == nid) {
return qat_pkt_threshold_table[i].threshold;
}
} while (++i < pkt_threshold_table_size);
WARN("nid %d not found in threshold table", nid);
return 0;
}
#endif
/******************************************************************************
* function:
* qat_chained_callbackFn(void *callbackTag, CpaStatus status,
* const CpaCySymOp operationType, void *pOpData,
* CpaBufferList * pDstBuffer, CpaBoolean verifyResult)
*
* @param pCallbackTag [IN] - Opaque value provided by user while making
* individual function call. Cast to op_done_pipe_t.
* @param status [IN] - Status of the operation.
* @param operationType [IN] - Identifies the operation type requested.
* @param pOpData [IN] - Pointer to structure with input parameters.
* @param pDstBuffer [IN] - Destination buffer to hold the data output.
* @param verifyResult [IN] - Used to verify digest result.
*
* description:
* Callback function used by chained ciphers with pipeline support. This
* function is called when operation is completed for each pipeline. However
* the paused job is woken up when all the pipelines have been proccessed.
*
******************************************************************************/
static void qat_chained_callbackFn(void *callbackTag, CpaStatus status,
const CpaCySymOp operationType,
void *pOpData, CpaBufferList *pDstBuffer,
CpaBoolean verifyResult)
{
ASYNC_JOB *job = NULL;
op_done_pipe_t *opdone = (op_done_pipe_t *)callbackTag;
CpaBoolean res = CPA_FALSE;
if (opdone == NULL) {
WARN("Callback Tag NULL\n");
return;
}
opdone->num_processed++;
res = (status == CPA_STATUS_SUCCESS) && verifyResult ? CPA_TRUE : CPA_FALSE;
/* If any single pipe processing failed, the entire operation
* is treated as failure. The default value of opDone.verifyResult
* is TRUE. Change it to false on Failure.
*/
if (res == CPA_FALSE) {
WARN("Pipe %u failed (status %d, verifyResult %d)\n",
opdone->num_processed, status, verifyResult);
opdone->opDone.verifyResult = CPA_FALSE;
}
/* The QAT API guarantees submission order for request
* i.e. first in first out. If not all requests have been
* submitted or processed, wait for more callbacks.
*/
if ((opdone->num_submitted != opdone->num_pipes) ||
(opdone->num_submitted != opdone->num_processed))
return;
if (enable_heuristic_polling) {
QAT_ATOMIC_DEC(num_cipher_pipeline_requests_in_flight);
}
/* Cache job pointer to avoid a race condition if opdone gets cleaned up
* in the calling thread.
*/
job = (ASYNC_JOB *)opdone->opDone.job;
/* Mark job as done when all the requests have been submitted and
* subsequently processed.
*/
opdone->opDone.flag = 1;
if (job) {
qat_wake_job(job, ASYNC_STATUS_OK);
}
}
/******************************************************************************
* function:
* qat_ciphers(ENGINE *e,
* const EVP_CIPHER **cipher,
* const int **nids,
* int nid)
*
* @param e [IN] - OpenSSL engine pointer
* @param cipher [IN] - cipher structure pointer
* @param nids [IN] - cipher function nids
* @param nid [IN] - cipher operation id
*
* description:
* Qat engine cipher operations registrar
******************************************************************************/
int qat_ciphers(ENGINE *e, const EVP_CIPHER **cipher, const int **nids, int nid)
{
int i;
if (unlikely((nids == NULL) && ((cipher == NULL) || (nid < 0)))) {
WARN("Invalid input param.\n");
if (cipher != NULL)
*cipher = NULL;
return 0;
}
/* No specific cipher => return a list of supported nids ... */
if (cipher == NULL) {
*nids = qat_cipher_nids;
/* num ciphers supported (size of array/size of 1 element) */
return (sizeof(qat_cipher_nids) / sizeof(qat_cipher_nids[0]));
}
for (i = 0; i < num_cc; i++) {
if (nid == info[i].nid) {
if (info[i].cipher == NULL)
qat_create_ciphers();
*cipher = info[i].cipher;
return 1;
}
}
WARN("NID %d not supported\n", nid);
*cipher = NULL;
return 0;
}
/******************************************************************************
* function:
* qat_setup_op_params(EVP_CIPHER_CTX *ctx)
*
* @param qctx [IN] - pointer to existing qat_chained_ctx
*
* @retval 1 function succeeded
* @retval 0 function failed
*
* description:
* This function initialises the flatbuffer and flat buffer list for use.
*
******************************************************************************/
static int qat_setup_op_params(EVP_CIPHER_CTX *ctx)
{
CpaCySymOpData *opd = NULL;
Cpa32U msize = 0;
qat_chained_ctx *qctx = qat_chained_data(ctx);
int i = 0;
unsigned int start;
/* When no pipelines are used, numpipes = 1. The actual number of pipes are
* not known until the start of do_cipher.
*/
if (PIPELINE_USED(qctx)) {
/* When Pipes have been previously used, the memory has been allocated
* for max supported pipes although initialised only for numpipes.
*/
start = qctx->npipes_last_used;
} else {
start = 1;
/* When the context switches from using no pipes to using pipes,
* free the previous allocated memory.
*/
if (qctx->qop != NULL && qctx->qop_len < qctx->numpipes) {
qat_chained_ciphers_free_qop(&qctx->qop, &qctx->qop_len);
DEBUG_PPL("[%p] qop memory freed\n", ctx);
}
}
/* Allocate memory for qop depending on whether pipes are used or not.
* In case of pipes, allocate for the maximum supported pipes.
*/
if (qctx->qop == NULL) {
if (PIPELINE_USED(qctx)) {
WARN("Pipeline used but no data allocated. Possible memory leak\n");
}
qctx->qop_len = qctx->numpipes > 1 ? QAT_MAX_PIPELINES : 1;
qctx->qop = (qat_op_params *) OPENSSL_zalloc(sizeof(qat_op_params)
* qctx->qop_len);
if (qctx->qop == NULL) {
WARN("Unable to allocate memory[%lu bytes] for qat op params\n",
sizeof(qat_op_params) * qctx->qop_len);
return 0;
}
/* start from 0 as New array of qat_op_params */
start = 0;
}
for (i = start; i < qctx->numpipes; i++) {
/* This is a whole block the size of the memory alignment. If the
* alignment was to become smaller than the header size
* (TLS_VIRT_HEADER_SIZE) which is unlikely then we would need to add
* some more logic here to work out how many blocks of size
* QAT_BYTE_ALIGNMENT we need to allocate to fit the header in.
*/
FLATBUFF_ALLOC_AND_CHAIN(qctx->qop[i].src_fbuf[0],
qctx->qop[i].dst_fbuf[0], QAT_BYTE_ALIGNMENT);
if (qctx->qop[i].src_fbuf[0].pData == NULL) {
WARN("Unable to allocate memory for TLS header\n");
goto err;
}
memset(qctx->qop[i].src_fbuf[0].pData, 0, QAT_BYTE_ALIGNMENT);
qctx->qop[i].src_fbuf[1].pData = NULL;
qctx->qop[i].dst_fbuf[1].pData = NULL;
qctx->qop[i].src_sgl.numBuffers = 2;
qctx->qop[i].src_sgl.pBuffers = qctx->qop[i].src_fbuf;
qctx->qop[i].src_sgl.pUserData = NULL;
qctx->qop[i].src_sgl.pPrivateMetaData = NULL;
qctx->qop[i].dst_sgl.numBuffers = 2;
qctx->qop[i].dst_sgl.pBuffers = qctx->qop[i].dst_fbuf;
qctx->qop[i].dst_sgl.pUserData = NULL;
qctx->qop[i].dst_sgl.pPrivateMetaData = NULL;
DEBUG("Pipe [%d] inst_num = %d\n", i, qctx->inst_num);
DEBUG("Pipe [%d] No of buffers = %d\n", i, qctx->qop[i].src_sgl.numBuffers);
/* setup meta data for buffer lists */
if (msize == 0 &&
cpaCyBufferListGetMetaSize(qat_instance_handles[qctx->inst_num],
qctx->qop[i].src_sgl.numBuffers,
&msize) != CPA_STATUS_SUCCESS) {
WARN("cpaCyBufferListGetBufferSize failed.\n");
goto err;
}
DEBUG("Pipe [%d] Size of meta data = %d\n", i, msize);
if (msize) {
qctx->qop[i].src_sgl.pPrivateMetaData =
qaeCryptoMemAlloc(msize, __FILE__, __LINE__);
qctx->qop[i].dst_sgl.pPrivateMetaData =
qaeCryptoMemAlloc(msize, __FILE__, __LINE__);
if (qctx->qop[i].src_sgl.pPrivateMetaData == NULL ||
qctx->qop[i].dst_sgl.pPrivateMetaData == NULL) {
WARN("QMEM alloc failed for PrivateData\n");
goto err;
}
}
opd = &qctx->qop[i].op_data;
/* Copy the opData template */
memcpy(opd, &template_opData, sizeof(template_opData));
/* Update Opdata */
opd->sessionCtx = qctx->session_ctx;
opd->pIv = qaeCryptoMemAlloc(EVP_CIPHER_CTX_iv_length(ctx),
__FILE__, __LINE__);
if (opd->pIv == NULL) {
WARN("QMEM Mem Alloc failed for pIv for pipe %d.\n", i);
goto err;
}
opd->ivLenInBytes = (Cpa32U) EVP_CIPHER_CTX_iv_length(ctx);
}
DEBUG_PPL("[%p] qop setup for %u elements\n", ctx, qctx->qop_len);
return 1;
err:
qat_chained_ciphers_free_qop(&qctx->qop, &qctx->qop_len);
return 0;
}
/******************************************************************************
* function:
* qat_chained_ciphers_init(EVP_CIPHER_CTX *ctx,
* const unsigned char *inkey,
* const unsigned char *iv,
* int enc)
*
* @param ctx [IN] - pointer to existing ctx
* @param inKey [IN] - input cipher key
* @param iv [IN] - initialisation vector
* @param enc [IN] - 1 encrypt 0 decrypt
*
* @retval 1 function succeeded
* @retval 0 function failed
*
* description:
* This function initialises the cipher and hash algorithm parameters for this
* EVP context.
*
******************************************************************************/
int qat_chained_ciphers_init(EVP_CIPHER_CTX *ctx,
const unsigned char *inkey,
const unsigned char *iv, int enc)
{
CpaCySymSessionSetupData *ssd = NULL;
Cpa32U sctx_size = 0;
CpaCySymSessionCtx sctx = NULL;
CpaStatus sts = 0;
qat_chained_ctx *qctx = NULL;
unsigned char *ckey = NULL;
int ckeylen;
int dlen;
int ret = 0;
if (ctx == NULL || inkey == NULL) {
WARN("ctx or inkey is NULL.\n");
return 0;
}
qctx = qat_chained_data(ctx);
if (qctx == NULL) {
WARN("qctx is NULL.\n");
return 0;
}
INIT_SEQ_CLEAR_ALL_FLAGS(qctx);
if (iv != NULL)
memcpy(EVP_CIPHER_CTX_iv_noconst(ctx), iv,
EVP_CIPHER_CTX_iv_length(ctx));
else
memset(EVP_CIPHER_CTX_iv_noconst(ctx), 0,
EVP_CIPHER_CTX_iv_length(ctx));
ckeylen = EVP_CIPHER_CTX_key_length(ctx);
ckey = OPENSSL_malloc(ckeylen);
if (ckey == NULL) {
WARN("Unable to allocate memory for Cipher key.\n");
return 0;
}
memcpy(ckey, inkey, ckeylen);
memset(qctx, 0, sizeof(*qctx));
qctx->numpipes = 1;
qctx->total_op = 0;
qctx->npipes_last_used = 1;
qctx->fallback = 0;
qctx->hmac_key = OPENSSL_zalloc(HMAC_KEY_SIZE);
if (qctx->hmac_key == NULL) {
WARN("Unable to allocate memory for HMAC Key\n");
goto err;
}
const EVP_CIPHER *sw_cipher = GET_SW_CIPHER(ctx);
unsigned int sw_size = EVP_CIPHER_impl_ctx_size(sw_cipher);
if (sw_size != 0) {
qctx->sw_ctx_cipher_data = OPENSSL_zalloc(sw_size);
if (qctx->sw_ctx_cipher_data == NULL) {
WARN("Unable to allocate memory [%u bytes] for sw_ctx_cipher_data\n",
sw_size);
goto err;
}
}
EVP_CIPHER_CTX_set_cipher_data(ctx, qctx->sw_ctx_cipher_data);
/* Run the software init function */
ret = EVP_CIPHER_meth_get_init(sw_cipher)(ctx, inkey, iv, enc);
EVP_CIPHER_CTX_set_cipher_data(ctx, qctx);
if (ret != 1)
goto err;
if (qat_get_qat_offload_disabled()) {
/*
* Setting qctx->fallback as a flag for the other functions.
* This means in the other functions (and in the err section in this function)
* we no longer need to check qat_get_qat_offload_disabled() but just check
* the fallback flag instead. This has the added benefit that even if
* the engine control message to enable HW offload is sent it will not affect
* requests that have already been init'd, they will continue to use SW until
* the request is complete, i.e. no race condition.
*/
qctx->fallback = 1;
goto err;
}
ssd = OPENSSL_malloc(sizeof(CpaCySymSessionSetupData));
if (ssd == NULL) {
WARN("Failed to allocate session setup data\n");
goto err;
}
qctx->session_data = ssd;
/* Copy over the template for most of the values */
memcpy(ssd, &template_ssd, sizeof(template_ssd));
/* Change constant values for decryption */
if (!enc) {
ssd->cipherSetupData.cipherDirection =
CPA_CY_SYM_CIPHER_DIRECTION_DECRYPT;
ssd->algChainOrder = CPA_CY_SYM_ALG_CHAIN_ORDER_CIPHER_THEN_HASH;
ssd->verifyDigest = CPA_TRUE;
}
ssd->cipherSetupData.cipherKeyLenInBytes = ckeylen;
ssd->cipherSetupData.pCipherKey = ckey;
dlen = get_digest_len(EVP_CIPHER_CTX_nid(ctx));
ssd->hashSetupData.digestResultLenInBytes = dlen;
if (dlen != SHA_DIGEST_LENGTH)
ssd->hashSetupData.hashAlgorithm = CPA_CY_SYM_HASH_SHA256;
ssd->hashSetupData.authModeSetupData.authKey = qctx->hmac_key;
qctx->inst_num = get_next_inst_num();
if (qctx->inst_num == QAT_INVALID_INSTANCE) {
WARN("Failed to get a QAT instance.\n");
if (qat_get_sw_fallback_enabled()) {
CRYPTO_QAT_LOG("Failed to get an instance - fallback to SW - %s\n", __func__);
qctx->fallback = 1;
}
goto err;
}
DEBUG("inst_num = %d\n", qctx->inst_num);
DUMP_SESSION_SETUP_DATA(ssd);
sts = cpaCySymSessionCtxGetSize(qat_instance_handles[qctx->inst_num], ssd, &sctx_size);
if (sts != CPA_STATUS_SUCCESS) {
WARN("Failed to get SessionCtx size.\n");
if (qat_get_sw_fallback_enabled()) {
CRYPTO_QAT_LOG("Failed to submit request to qat inst_num %d device_id %d - fallback to SW - %s\n",
qctx->inst_num,
qat_instance_details[qctx->inst_num].qat_instance_info.physInstId.packageId,
__func__);
qctx->fallback = 1;
}
goto err;
}
DEBUG("Size of session ctx = %d\n", sctx_size);
sctx = (CpaCySymSessionCtx) qaeCryptoMemAlloc(sctx_size, __FILE__,
__LINE__);
if (sctx == NULL) {
WARN("QMEM alloc failed for session ctx!\n");
goto err;
}
qctx->session_ctx = sctx;
qctx->qop = NULL;
qctx->qop_len = 0;
INIT_SEQ_SET_FLAG(qctx, INIT_SEQ_QAT_CTX_INIT);
DEBUG_PPL("[%p] qat chained cipher ctx %p initialised\n",ctx, qctx);
return 1;
err:
/* NOTE: no init seq flags will have been set if this 'err:' label code section is entered. */
QAT_CLEANSE_FREE_BUFF(ckey, ckeylen);
QAT_CLEANSE_FREE_BUFF(qctx->hmac_key, HMAC_KEY_SIZE);
if (ssd != NULL)
OPENSSL_free(ssd);
qctx->session_data = NULL;
QAT_QMEMFREE_BUFF(qctx->session_ctx);
if ((qctx->fallback == 1) && (qctx->sw_ctx_cipher_data != NULL) && (ret == 1)) {
DEBUG("- Fallback to software mode.\n");
CRYPTO_QAT_LOG("Resubmitting request to SW - %s\n", __func__);
return ret; /* result returned from running software init function */
}
if (qctx->sw_ctx_cipher_data != NULL) {
OPENSSL_free(qctx->sw_ctx_cipher_data);
qctx->sw_ctx_cipher_data = NULL;
}
return 0;
}
/******************************************************************************
* function:
* qat_chained_ciphers_ctrl(EVP_CIPHER_CTX *ctx,
* int type, int arg, void *ptr)
*
* @param ctx [IN] - pointer to existing ctx
* @param type [IN] - type of request either
* EVP_CTRL_AEAD_SET_MAC_KEY or EVP_CTRL_AEAD_TLS1_AAD
* @param arg [IN] - size of the pointed to by ptr
* @param ptr [IN] - input buffer contain the necessary parameters
*
* @retval x The return value is dependent on the type of request being made
* EVP_CTRL_AEAD_SET_MAC_KEY return of 1 is success
* EVP_CTRL_AEAD_TLS1_AAD return value indicates the amount fo padding to
* be applied to the SSL/TLS record
* @retval -1 function failed
*
* description:
* This function is a generic control interface provided by the EVP API. For
* chained requests this interface is used fro setting the hmac key value for
* authentication of the SSL/TLS record. The second type is used to specify the
* TLS virtual header which is used in the authentication calculationa nd to
* identify record payload size.
*
******************************************************************************/
int qat_chained_ciphers_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr)
{
qat_chained_ctx *qctx = NULL;
unsigned char *hmac_key = NULL;
CpaCySymSessionSetupData *ssd = NULL;
SHA_CTX hkey1;
SHA256_CTX hkey256;
CpaStatus sts;
char *hdr = NULL;
unsigned int len = 0;
int retVal = 0;
int retVal_sw = 0;
int dlen = 0;
if (ctx == NULL) {
WARN("ctx parameter is NULL.\n");
return -1;
}
qctx = qat_chained_data(ctx);
if (qctx == NULL) {
WARN("qctx is NULL.\n");
return -1;
}
if (qctx->fallback == 1)
goto sw_ctrl;
dlen = get_digest_len(EVP_CIPHER_CTX_nid(ctx));
switch (type) {
case EVP_CTRL_AEAD_SET_MAC_KEY:
hmac_key = qctx->hmac_key;
ssd = qctx->session_data;
memset(hmac_key, 0, HMAC_KEY_SIZE);
if (arg > HMAC_KEY_SIZE) {
if (dlen == SHA_DIGEST_LENGTH) {
SHA1_Init(&hkey1);
SHA1_Update(&hkey1, ptr, arg);
SHA1_Final(hmac_key, &hkey1);
} else {
SHA256_Init(&hkey256);
SHA256_Update(&hkey256, ptr, arg);
SHA256_Final(hmac_key, &hkey256);
}
} else {
memcpy(hmac_key, ptr, arg);
ssd->hashSetupData.authModeSetupData.authKeyLenInBytes = arg;
}
INIT_SEQ_SET_FLAG(qctx, INIT_SEQ_HMAC_KEY_SET);
DEBUG("inst_num = %d\n", qctx->inst_num);
DUMP_SESSION_SETUP_DATA(ssd);
DEBUG("session_ctx = %p\n", qctx->session_ctx);
if (!(is_instance_available(qctx->inst_num))) {
WARN("No QAT instance available so not creating session.\n");
if (qat_get_sw_fallback_enabled()) {
CRYPTO_QAT_LOG("Failed to get an instance - fallback to SW - %s\n", __func__);
qctx->fallback = 1; /* Set fallback even if already set */
}
else {
WARN("- No QAT instance available and s/w fallback not enabled.\n");
retVal = 0; /* Fail if software fallback not enabled. */
}
} else {
sts = cpaCySymInitSession(qat_instance_handles[qctx->inst_num],
qat_chained_callbackFn,
ssd, qctx->session_ctx);
if (sts != CPA_STATUS_SUCCESS) {
WARN("cpaCySymInitSession failed! Status = %d\n", sts);
if (qat_get_sw_fallback_enabled() &&
((sts == CPA_STATUS_RESTARTING) || (sts == CPA_STATUS_FAIL))) {
CRYPTO_QAT_LOG("Failed to submit request to qat inst_num %d device_id %d - fallback to SW - %s\n",
qctx->inst_num,
qat_instance_details[qctx->inst_num].qat_instance_info.physInstId.packageId,
__func__);
qctx->fallback = 1;
}
else
retVal = 0;
} else {
if (qat_get_sw_fallback_enabled()) {
CRYPTO_QAT_LOG("Submit success qat inst_num %d device_id %d - %s\n",
qctx->inst_num,
qat_instance_details[qctx->inst_num].qat_instance_info.physInstId.packageId,
__func__);
}
INIT_SEQ_SET_FLAG(qctx, INIT_SEQ_QAT_SESSION_INIT);
retVal = 1;
}
}
break;
case EVP_CTRL_AEAD_TLS1_AAD:
/* This returns the amount of padding required for
the send/encrypt direction.
*/
if (arg != TLS_VIRT_HDR_SIZE || qctx->aad_ctr >= QAT_MAX_PIPELINES) {
WARN("Invalid argument for AEAD_TLS1_AAD.\n");
retVal = -1;
break;
}
hdr = GET_TLS_HDR(qctx, qctx->aad_ctr);
memcpy(hdr, ptr, TLS_VIRT_HDR_SIZE);
qctx->aad_ctr++;
if (qctx->aad_ctr > 1)
INIT_SEQ_SET_FLAG(qctx, INIT_SEQ_PPL_AADCTR_SET);
len = GET_TLS_PAYLOAD_LEN(((char *)ptr));
if (GET_TLS_VERSION(((char *)ptr)) >= TLS1_1_VERSION) {
if (len < EVP_CIPHER_CTX_iv_length(ctx)) {
WARN("Length is smaller than the IV length\n");
retVal = 0;
break;
}
len -= EVP_CIPHER_CTX_iv_length(ctx);
} else if (qctx->aad_ctr > 1) {