-
Notifications
You must be signed in to change notification settings - Fork 17
/
fsl_sss_api.h
1892 lines (1703 loc) · 66.2 KB
/
fsl_sss_api.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 2018-2020 NXP
* SPDX-License-Identifier: Apache-2.0
*/
/** @file */
#ifndef _FSL_SSS_H_
#define _FSL_SSS_H_
#if !defined(SSS_CONFIG_FILE)
#include "fsl_sss_config.h"
#else
#include SSS_CONFIG_FILE
#endif
#include <fsl_sss_policy.h>
#include "fsl_sss_types.h"
/** Version of the SSS API */
#define SSS_API_VERSION (0x00000001u)
/** Size of an AES Block, in bytes */
#define SSS_AES_BLOCK_SIZE (16u)
/** Size of a DES Block, in bytes */
#define SSS_DES_BLOCK_SIZE (8u)
/** Size of a DES Key, in bytes */
#define SSS_DES_KEY_SIZE (8u)
/** Size of a DES IV, in bytes */
#define SSS_DES_IV_SIZE (8u)
/** Status of the SSS APIs */
typedef enum
{
/** Operation was successful */
kStatus_SSS_Success = 0x5a5a5a5au,
/** Operation failed */
kStatus_SSS_Fail = 0x3c3c0000u,
/** Operation not performed because some of the passed parameters
* were found inappropriate */
kStatus_SSS_InvalidArgument = 0x3c3c0001u,
/** Where the underlying sub-system *supports* multi-threading,
* Internal status to handle simultaneous access.
*
* This status is not expected to be returned to higher layers.
* */
kStatus_SSS_ResourceBusy = 0x3c3c0002u,
} sss_status_t;
/** Helper macro to set enum value */
#define SSS_ENUM(GROUP, INDEX) ((GROUP) | (INDEX))
/** Cryptographic sub system */
typedef enum
{
kType_SSS_SubSystem_NONE,
/** Software based */
kType_SSS_Software = SSS_ENUM(0x01 << 8, 0x00),
kType_SSS_mbedTLS = SSS_ENUM(kType_SSS_Software, 0x01),
kType_SSS_OpenSSL = SSS_ENUM(kType_SSS_Software, 0x02),
/** HOST HW Based */
kType_SSS_HW = SSS_ENUM(0x02 << 8, 0x00),
kType_SSS_SECO = SSS_ENUM(kType_SSS_HW, 0x01),
/** Isolated HW */
kType_SSS_Isolated_HW = SSS_ENUM(0x04 << 8, 0x00),
kType_SSS_Sentinel = SSS_ENUM(kType_SSS_Isolated_HW, 0x01),
kType_SSS_Sentinel200 = SSS_ENUM(kType_SSS_Isolated_HW, 0x02),
kType_SSS_Sentinel300 = SSS_ENUM(kType_SSS_Isolated_HW, 0x03),
kType_SSS_Sentinel400 = SSS_ENUM(kType_SSS_Isolated_HW, 0x04),
kType_SSS_Sentinel500 = SSS_ENUM(kType_SSS_Isolated_HW, 0x05),
/** Secure Element */
kType_SSS_SecureElement = SSS_ENUM(0x08 << 8, 0x00),
/** To connect to https://www.nxp.com/products/:A71CH */
kType_SSS_SE_A71CH = SSS_ENUM(kType_SSS_SecureElement, 0x01),
kType_SSS_SE_A71CL = SSS_ENUM(kType_SSS_SecureElement, 0x02),
/** To connect to https://www.nxp.com/products/:SE050 */
kType_SSS_SE_SE05x = SSS_ENUM(kType_SSS_SecureElement, 0x03),
kType_SSS_SubSystem_LAST
} sss_type_t;
/** Destintion connection type */
typedef enum
{
/* Plain => Lowest level of security requested.
* => Probably a system with no mechanism to *identify* who
* has opened the session from host
* => Probably a system with Easy for man in the middle attack.
*
*/
kSSS_ConnectionType_Plain,
/* Password:
* => Some level of user authentication/identification requested
* => Probably a system with "static" authentication/identification.
* => Probably same Password us always.
* => "Password" mostly gets sent in plain over the communication layer
* => Probably a system with replay attack possible
*/
kSSS_ConnectionType_Password,
/* Encrypted:
* Communication is guaranteed to be Encrypted.
* For SE => This would mean highest level of authentication
* For other system => channel would be encrypted
*
* In general, almost a level of security that is definitely higher than
* Plain/Password/PIN.
*
* Using *Dynamic* Sessions Keys for authenticated communication.
*/
kSSS_ConnectionType_Encrypted
} sss_connection_type_t;
#ifndef __DOXYGEN__
#define SSS_ALGORITHM_START_AES (0x00)
#define SSS_ALGORITHM_START_CHACHA (0x01)
#define SSS_ALGORITHM_START_DES (0x02)
#define SSS_ALGORITHM_START_SHA (0x03)
#define SSS_ALGORITHM_START_MAC (0x04)
#define SSS_ALGORITHM_START_DH (0x05)
#define SSS_ALGORITHM_START_DSA (0x06)
#define SSS_ALGORITHM_START_RSASSA_PKCS1_V1_5 (0x07)
#define SSS_ALGORITHM_START_RSASSA_PKCS1_PSS_MGF1 (0x08)
#define SSS_ALGORITHM_START_RSAES_PKCS1_OAEP (0x09)
#define SSS_ALGORITHM_START_RSAES_PKCS1_V1_5 (0x0A)
#define SSS_ALGORITHM_START_RSASSA_NO_PADDING (0x0B)
#define SSS_ALGORITHM_START_ECDSA (0x0C)
#define SSS_ALGORITHM_START_ECDAA (0x0D)
/* Not available outside this file */
#define SSS_ENUM_ALGORITHM(GROUP, INDEX) (((SSS_ALGORITHM_START_##GROUP) << 8) | (INDEX))
#endif
/** Cryptographic algorithm to be applied */
typedef enum /* _sss_algorithm */
{
kAlgorithm_None,
/* AES */
kAlgorithm_SSS_AES_ECB = SSS_ENUM_ALGORITHM(AES, 0x01),
kAlgorithm_SSS_AES_CBC = SSS_ENUM_ALGORITHM(AES, 0x02),
kAlgorithm_SSS_AES_CTR = SSS_ENUM_ALGORITHM(AES, 0x03),
kAlgorithm_SSS_AES_GCM = SSS_ENUM_ALGORITHM(AES, 0x04),
kAlgorithm_SSS_AES_CCM = SSS_ENUM_ALGORITHM(AES, 0x05),
kAlgorithm_SSS_AES_GCM_INT_IV = SSS_ENUM_ALGORITHM(AES, 0x06),
/* CHACHA_POLY */
kAlgorithm_SSS_CHACHA_POLY = SSS_ENUM_ALGORITHM(CHACHA, 0x01),
/* DES */
kAlgorithm_SSS_DES_ECB = SSS_ENUM_ALGORITHM(DES, 0x01),
kAlgorithm_SSS_DES_CBC = SSS_ENUM_ALGORITHM(DES, 0x02),
/* DES3 */
kAlgorithm_SSS_DES3_ECB = SSS_ENUM_ALGORITHM(DES, 0x03),
kAlgorithm_SSS_DES3_CBC = SSS_ENUM_ALGORITHM(DES, 0x04),
/* digest */
/* doc:start hash_algo */
kAlgorithm_SSS_SHA1 = SSS_ENUM_ALGORITHM(SHA, 0x01),
kAlgorithm_SSS_SHA224 = SSS_ENUM_ALGORITHM(SHA, 0x02),
kAlgorithm_SSS_SHA256 = SSS_ENUM_ALGORITHM(SHA, 0x03),
kAlgorithm_SSS_SHA384 = SSS_ENUM_ALGORITHM(SHA, 0x04),
kAlgorithm_SSS_SHA512 = SSS_ENUM_ALGORITHM(SHA, 0x05),
/* doc:end hash_algo */
/* MAC */
kAlgorithm_SSS_CMAC_AES = SSS_ENUM_ALGORITHM(MAC, 0x01),
kAlgorithm_SSS_HMAC_SHA1 = SSS_ENUM_ALGORITHM(MAC, 0x02),
kAlgorithm_SSS_HMAC_SHA224 = SSS_ENUM_ALGORITHM(MAC, 0x03),
kAlgorithm_SSS_HMAC_SHA256 = SSS_ENUM_ALGORITHM(MAC, 0x04),
kAlgorithm_SSS_HMAC_SHA384 = SSS_ENUM_ALGORITHM(MAC, 0x05),
kAlgorithm_SSS_HMAC_SHA512 = SSS_ENUM_ALGORITHM(MAC, 0x06),
/* See above:
* kAlgorithm_SSS_HMAC_SHA224 = SSS_ENUM_ALGORITHM(CHACHA, 0x01) */
/* Diffie-Helmann */
kAlgorithm_SSS_DH = SSS_ENUM_ALGORITHM(DH, 0x01),
kAlgorithm_SSS_ECDH = SSS_ENUM_ALGORITHM(DH, 0x02),
/* DSA */
kAlgorithm_SSS_DSA_SHA1 = SSS_ENUM_ALGORITHM(DSA, 0x01),
kAlgorithm_SSS_DSA_SHA224 = SSS_ENUM_ALGORITHM(DSA, 0x02),
kAlgorithm_SSS_DSA_SHA256 = SSS_ENUM_ALGORITHM(DSA, 0x03),
/* RSA */
/* doc:start rsa_sign_algo */
kAlgorithm_SSS_RSASSA_PKCS1_V1_5_NO_HASH = SSS_ENUM_ALGORITHM(RSASSA_PKCS1_V1_5, 0x01),
kAlgorithm_SSS_RSASSA_PKCS1_V1_5_SHA1 = SSS_ENUM_ALGORITHM(RSASSA_PKCS1_V1_5, 0x02),
kAlgorithm_SSS_RSASSA_PKCS1_V1_5_SHA224 = SSS_ENUM_ALGORITHM(RSASSA_PKCS1_V1_5, 0x03),
kAlgorithm_SSS_RSASSA_PKCS1_V1_5_SHA256 = SSS_ENUM_ALGORITHM(RSASSA_PKCS1_V1_5, 0x04),
kAlgorithm_SSS_RSASSA_PKCS1_V1_5_SHA384 = SSS_ENUM_ALGORITHM(RSASSA_PKCS1_V1_5, 0x05),
kAlgorithm_SSS_RSASSA_PKCS1_V1_5_SHA512 = SSS_ENUM_ALGORITHM(RSASSA_PKCS1_V1_5, 0x06),
kAlgorithm_SSS_RSASSA_PKCS1_PSS_MGF1_SHA1 = SSS_ENUM_ALGORITHM(RSASSA_PKCS1_PSS_MGF1, 0x01),
kAlgorithm_SSS_RSASSA_PKCS1_PSS_MGF1_SHA224 = SSS_ENUM_ALGORITHM(RSASSA_PKCS1_PSS_MGF1, 0x02),
kAlgorithm_SSS_RSASSA_PKCS1_PSS_MGF1_SHA256 = SSS_ENUM_ALGORITHM(RSASSA_PKCS1_PSS_MGF1, 0x03),
kAlgorithm_SSS_RSASSA_PKCS1_PSS_MGF1_SHA384 = SSS_ENUM_ALGORITHM(RSASSA_PKCS1_PSS_MGF1, 0x04),
kAlgorithm_SSS_RSASSA_PKCS1_PSS_MGF1_SHA512 = SSS_ENUM_ALGORITHM(RSASSA_PKCS1_PSS_MGF1, 0x05),
/* doc:end rsa_sign_algo */
/* doc:start rsa_enc_algo */
kAlgorithm_SSS_RSAES_PKCS1_OAEP_SHA1 = SSS_ENUM_ALGORITHM(RSAES_PKCS1_OAEP, 0x01),
kAlgorithm_SSS_RSAES_PKCS1_OAEP_SHA224 = SSS_ENUM_ALGORITHM(RSAES_PKCS1_OAEP, 0x02),
kAlgorithm_SSS_RSAES_PKCS1_OAEP_SHA256 = SSS_ENUM_ALGORITHM(RSAES_PKCS1_OAEP, 0x03),
kAlgorithm_SSS_RSAES_PKCS1_OAEP_SHA384 = SSS_ENUM_ALGORITHM(RSAES_PKCS1_OAEP, 0x04),
kAlgorithm_SSS_RSAES_PKCS1_OAEP_SHA512 = SSS_ENUM_ALGORITHM(RSAES_PKCS1_OAEP, 0x05),
kAlgorithm_SSS_RSAES_PKCS1_V1_5 = SSS_ENUM_ALGORITHM(RSAES_PKCS1_V1_5, 0x01),
/* doc:end rsa_enc_algo */
/* doc:start rsa_sign_algo_no_padding */
kAlgorithm_SSS_RSASSA_NO_PADDING = SSS_ENUM_ALGORITHM(RSASSA_NO_PADDING, 0x01),
/* doc:end rsa_sign_algo_no_padding */
/* ECDSA */
/* doc:start ecc_sign_algo */
kAlgorithm_SSS_ECDSA_SHA1 = SSS_ENUM_ALGORITHM(ECDSA, 0x01),
kAlgorithm_SSS_ECDSA_SHA224 = SSS_ENUM_ALGORITHM(ECDSA, 0x02),
kAlgorithm_SSS_ECDSA_SHA256 = SSS_ENUM_ALGORITHM(ECDSA, 0x03),
kAlgorithm_SSS_ECDSA_SHA384 = SSS_ENUM_ALGORITHM(ECDSA, 0x04),
kAlgorithm_SSS_ECDSA_SHA512 = SSS_ENUM_ALGORITHM(ECDSA, 0x05),
/* doc:end ecc_sign_algo */
/* ECDAA */
/* doc:start ecc_bn_sign_algo */
kAlgorithm_SSS_ECDAA = SSS_ENUM_ALGORITHM(ECDAA, 0x01),
/* doc:end ecc_bn_sign_algo */
} sss_algorithm_t;
#undef SSS_ENUM_ALGORITHM
#ifndef __DOXYGEN__
// Deprecated names for RSAES_PKCS1_OAEP algorithms
#define kAlgorithm_SSS_RSASSA_PKCS1_OEAP_SHA1 kAlgorithm_SSS_RSAES_PKCS1_OAEP_SHA1
#define kAlgorithm_SSS_RSASSA_PKCS1_OEAP_SHA224 kAlgorithm_SSS_RSAES_PKCS1_OAEP_SHA224
#define kAlgorithm_SSS_RSASSA_PKCS1_OEAP_SHA256 kAlgorithm_SSS_RSAES_PKCS1_OAEP_SHA256
#define kAlgorithm_SSS_RSASSA_PKCS1_OEAP_SHA384 kAlgorithm_SSS_RSAES_PKCS1_OAEP_SHA384
#define kAlgorithm_SSS_RSASSA_PKCS1_OEAP_SHA512 kAlgorithm_SSS_RSAES_PKCS1_OAEP_SHA512
// Deprecated names for RSAES_PKCS1_V1_5 algorithms
#define kAlgorithm_SSS_RSAES_PKCS1_V1_5_SHA1 kAlgorithm_SSS_RSAES_PKCS1_V1_5
#define kAlgorithm_SSS_RSAES_PKCS1_V1_5_SHA224 kAlgorithm_SSS_RSAES_PKCS1_V1_5
#define kAlgorithm_SSS_RSAES_PKCS1_V1_5_SHA256 kAlgorithm_SSS_RSAES_PKCS1_V1_5
#define kAlgorithm_SSS_RSAES_PKCS1_V1_5_SHA384 kAlgorithm_SSS_RSAES_PKCS1_V1_5
#define kAlgorithm_SSS_RSAES_PKCS1_V1_5_SHA512 kAlgorithm_SSS_RSAES_PKCS1_V1_5
#endif /* __DOXYGEN__ */
/** High level algorihtmic operations.
*
* Augmented by @ref sss_algorithm_t
*/
typedef enum
{
kMode_SSS_Encrypt = 1, //!< Encrypt
kMode_SSS_Decrypt = 2, //!< Decrypt
kMode_SSS_Sign = 3, //!< Sign
kMode_SSS_Verify = 4, //!< Verify
/* Compute Shared Secret. e.g. Diffie-Hellman */
kMode_SSS_ComputeSharedSecret = 5,
kMode_SSS_Digest = 6, //!< Message Digest
kMode_SSS_Mac = 7, //!< Message Authentication Code
// For now, use kMode_SSS_ComputeSharedSecret for HKDF Extract and Expand
// kMode_SSS_HKDF = 8, //!< HKDF Extract and Expand (RFC 5869)
kMode_SSS_HKDF_ExpandOnly = 9 //!< HKDF Expand Only (RFC 5869)
} sss_mode_t;
/**
* Permissions of an object
*/
typedef enum
{
/** Can read (applicable) contents of the key.
*
* @note This is not same as @ref kAccessPermission_SSS_Use.
*
* Without reading, the object, the key can be used.
*/
kAccessPermission_SSS_Read = (1u << 0),
/** Can change the value of an object */
kAccessPermission_SSS_Write = (1u << 1),
/** Can use an object */
kAccessPermission_SSS_Use = (1u << 2),
/** Can delete an object */
kAccessPermission_SSS_Delete = (1u << 3),
/** Can change permissions applicable to an object */
kAccessPermission_SSS_ChangeAttributes = (1u << 4),
/** Bitwise OR of all sss_access_permission. */
kAccessPermission_SSS_All_Permission = 0x1F,
} sss_access_permission_t;
/**
* Persistent / Non persistent mode of a key
*/
typedef enum
{
kKeyObject_Mode_None = 0, //!< kKeyObject_Mode_None
/** Key object will be persisted in memory
* and will retain it's value after a closed session
*/
kKeyObject_Mode_Persistent = 1,
/** Key Object will be stored in RAM.
* It will lose it's contents after a session is closed
*/
kKeyObject_Mode_Transient = 2,
} sss_key_object_mode_t;
/** Part of a key */
typedef enum
{
kSSS_KeyPart_NONE,
/** Applicable where we have UserID, Binary Files,
* Certificates, Symmetric Keys, PCR, HMAC-key, counter */
kSSS_KeyPart_Default = 1,
/** Public part of asymmetric key */
kSSS_KeyPart_Public = 2,
/** Private only part of asymmetric key */
kSSS_KeyPart_Private = 3,
/** Both, public and private part of asymmetric key */
kSSS_KeyPart_Pair = 4,
} sss_key_part_t;
/** For all cipher types, key bit length is provides at the time key is inserted/generated */
typedef enum
{
kSSS_CipherType_NONE,
kSSS_CipherType_AES = 10,
kSSS_CipherType_DES = 12,
kSSS_CipherType_CMAC = 20,
kSSS_CipherType_HMAC = 21,
kSSS_CipherType_MAC = 30,
kSSS_CipherType_RSA = 31, /*! RSA RAW format */
kSSS_CipherType_RSA_CRT = 32, /*! RSA CRT format */
/* The following keys can be identified
* solely by the *Family* and bit length
*/
kSSS_CipherType_EC_NIST_P = 40, /*! Keys Part of NIST-P Family */
kSSS_CipherType_EC_NIST_K = 41, /*! Keys Part of NIST-K Family */
/* The following keys need their full curve parameters (p,a,b,x,y,n,h)
*/
/** Montgomery Key, */
kSSS_CipherType_EC_MONTGOMERY = 50,
/** twisted Edwards form elliptic curve public key */
kSSS_CipherType_EC_TWISTED_ED = 51,
/** Brainpool form elliptic curve public key */
kSSS_CipherType_EC_BRAINPOOL = 52,
/** Barreto Naehrig curve */
kSSS_CipherType_EC_BARRETO_NAEHRIG = 53,
kSSS_CipherType_UserID = 70,
/** Use kSSS_CipherType_Binary to store Certificate */
kSSS_CipherType_Certificate = 71,
kSSS_CipherType_Binary = 72,
kSSS_CipherType_Count = 73,
kSSS_CipherType_PCR = 74,
kSSS_CipherType_ReservedPin = 75,
} sss_cipher_type_t;
/** XY Co-ordinates for ECC Curves */
typedef struct
{
/** X Point */
uint8_t *X;
/** Y Point */
uint8_t *Y;
} sss_ecc_point_t;
/** ECC Curve Parameter */
typedef struct
{
uint8_t *p; /**< ECC parameter P */
uint8_t *a; /**< ECC parameter a */
uint8_t *b; /**< ECC parameter b */
sss_ecc_point_t *G; /**< ECC parameter G */
uint8_t *n; /**< ECC parameter n */
uint8_t *h; /**< ECC parameter h */
} sss_eccgfp_group_t;
/**
* @addtogroup sss_session
* @{
*/
/** Properties of session that are U32
*
* From 0 to kSSS_SessionProp_Optional_Prop_Start,
* around 2^24 = 16777215 Properties are
* possible.
*
* From 0 to kSSS_SessionProp_Optional_Prop_Start,
* around 2^24 = 16777215 Properties are
* possible.
*
*/
typedef enum
{
/** Invalid */
kSSS_SessionProp_u32_NA = 0,
/** Major version */
kSSS_SessionProp_VerMaj,
/** Minor Version */
kSSS_SessionProp_VerMin,
/** Development Version */
kSSS_SessionProp_VerDev,
/* Lenght of UID */
kSSS_SessionProp_UIDLen,
/** Optional Properties Start */
kSSS_SessionProp_u32_Optional_Start = 0x00FFFFFFu,
/** How much persistent memory is free */
kSSS_KeyStoreProp_FreeMem_Persistant,
/** How much transient memory is free */
kSSS_KeyStoreProp_FreeMem_Transient,
/** Proprietary Properties Start */
kSSS_SessionProp_u32_Proprietary_Start = 0x01FFFFFFu,
} sss_session_prop_u32_t;
/** Properties of session that are S32
*
* From 0 to kSSS_SessionProp_Optional_Prop_Start,
* around 2^24 = 16777215 Properties are
* possible.
*
* From 0 to kSSS_SessionProp_Optional_Prop_Start,
* around 2^24 = 16777215 Properties are
* possible.
*
*/
typedef enum
{
/** Invalid */
kSSS_SessionProp_au8_NA = 0,
/** Name of the product, string */
kSSS_SessionProp_szName,
/** Unique Identifier */
kSSS_SessionProp_UID,
/** Optional Properties Start */
kSSS_SessionProp_au8_Optional_Start = 0x00FFFFFFu,
/** Proprietary Properties Start */
kSSS_SessionProp_au8_Proprietary_Start = 0x01FFFFFFu,
} sss_session_prop_au8_t;
/** @} */
/**
* @addtogroup sss_session
* @{
*/
/** @brief Root session
*
* This is a *singleton* for each connection (physical/logical)
* to individual cryptographic system.
*/
typedef struct
{
/** Indicates which security subsystem is selected.
*
* This is set when @ref sss_session_open is successful */
sss_type_t subsystem;
/** Reserved memory for implementation specific extension */
struct
{
uint8_t data[SSS_SESSION_MAX_CONTEXT_SIZE];
} extension;
} sss_session_t;
/** @} */
/**
* @addtogroup sss_key_store
* @{
*/
/** @brief Store for secure and non secure key objects within a cryptographic system.
*
* - A cryptographic system may have more than partitions to store such keys.
*
*/
typedef struct
{
/** Virtual connection between application (user context) and specific
* security subsystem and function thereof. */
sss_session_t *session;
/** Reserved memory for implementation specific extension */
struct
{
uint8_t data[SSS_KEY_STORE_MAX_CONTEXT_SIZE];
} extension;
} sss_key_store_t;
/** properties of a Key Store that return array */
typedef enum
{
/** Optional Properties Start */
kSSS_KeyStoreProp_au8_Optional_Start = 0x00FFFFFFu,
} sss_key_store_prop_au8_t;
/** Entity on the other side of the tunnel */
typedef enum
{
/** Default value */
kSSS_TunnelDest_None = 0,
/** SE05X IoT Applet */
kSSS_TunnelType_Se05x_Iot_applet,
} sss_tunnel_dest_t;
/** @} */
/**
* @addtogroup sss_key_object
* @{
*/
/** @brief An object (secure / non-secure) within a Key Store.
*
*/
typedef struct
{
/** key store holding the data and other properties */
sss_key_store_t *keyStore;
/** The type/part of object is referneced from @ref sss_key_part_t */
uint32_t objectType;
/** cipherType type from @ref sss_cipher_type_t */
uint32_t cipherType;
/** Application specific key identifier. The keyId is kept in the key store
* along with the key data and other properties. */
uint32_t keyId;
/** Reserved memory for implementation specific extension */
struct
{
uint8_t data[SSS_KEY_OBJECT_MAX_CONTEXT_SIZE];
} extension;
} sss_object_t;
/** @} */
/**
* @addtogroup sss_crypto_symmetric
* @{
*/
/** @brief Typedef for the symmetric crypto context */
typedef struct
{
/** Virtual connection between application (user context) and specific
* security subsystem and function thereof. */
sss_session_t *session;
/** Key to be used for the symmetric operation */
sss_object_t *keyObject;
/** Algorithm to be applied, e.g AES_ECB / CBC */
sss_algorithm_t algorithm;
/** Mode of operation, e.g Encryption/Decryption */
sss_mode_t mode;
/** Reserved memory for implementation specific extension */
struct
{
uint8_t data[SSS_SYMMETRIC_MAX_CONTEXT_SIZE];
} extension;
} sss_symmetric_t;
/** @} */
/** @brief Authenticated Encryption with Additional Data
*
*/
typedef struct
{
/** Virtual connection between application (user context) and specific
* security subsystem and function thereof. */
sss_session_t *session;
/** Key to be used for asymmetric */
sss_object_t *keyObject;
/** Algorithm to be used */
sss_algorithm_t algorithm;
/** High level operation (encrypt/decrypt) */
sss_mode_t mode;
/** Reserved memory for implementation specific extension */
struct
{
uint8_t data[SSS_AEAD_MAX_CONTEXT_SIZE];
} extension;
} sss_aead_t;
/** Message Digest operations */
typedef struct
{
/** Virtual connection between application (user context) and specific
* security subsystem and function thereof. */
sss_session_t *session;
/** Algorithm to be applied, e.g SHA1, SHA256 */
sss_algorithm_t algorithm;
/** Mode of operation, e.g Sign/Verify */
sss_mode_t mode;
/** Full digest length per algorithm definition. This field is initialized along with algorithm. */
size_t digestFullLen;
/** Reserved memory for implementation specific extension */
struct
{
uint8_t data[SSS_DIGEST_MAX_CONTEXT_SIZE];
} extension;
} sss_digest_t;
/** @brief Message Authentication Code
*
*/
typedef struct
{
/** Virtual connection between application (user context) and specific
* security subsystem and function thereof. */
sss_session_t *session;
/** Key to be used for ... */
sss_object_t *keyObject;
/** Algorithm to be applied, e.g. MAC/CMAC */
sss_algorithm_t algorithm;
/** Mode of operation for MAC (kMode_SSS_Mac) */
sss_mode_t mode;
/** Reserved memory for implementation specific extension */
struct
{
uint8_t data[SSS_MAC_MAX_CONTEXT_SIZE];
} extension;
} sss_mac_t;
/** @brief Asymmetric Cryptographic operations
*
* e.g. RSA/ECC.
*/
typedef struct
{
/** Pointer to root session */
sss_session_t *session;
/** KeyObject used for Asymmetric operation */
sss_object_t *keyObject;
/** Algorithm to be applied, e.g. ECDSA */
sss_algorithm_t algorithm;
/** Mode of operation for the Asymmetric operation.
* e.g. Sign/Verify/Encrypt/Decrypt */
sss_mode_t mode;
/** Reserved memory for implementation specific extension */
struct
{
uint8_t data[SSS_ASYMMETRIC_MAX_CONTEXT_SIZE];
} extension;
} sss_asymmetric_t;
/** Header for a IS716 APDU */
typedef struct
{
/** ISO 7816 APDU Header */
uint8_t hdr[0 /* For Indentation */
+ 1 /* CLA */
+ 1 /* INS */
+ 1 /* P1 */
+ 1 /* P2 */
];
} tlvHeader_t;
/** Tunneling
*
* Used for communication via another system.
*/
typedef struct
{
/** Pointer to the session */
sss_session_t *session;
/** Tunnel to which Applet (Currently unused) */
uint32_t tunnelType;
/** Reserved memory for implementation specific extension */
struct
{
uint8_t data[SSS_TUNNEL_MAX_CONTEXT_SIZE];
} extension;
} sss_tunnel_t;
/**
* @addtogroup sss_crypto_derive_key
* @{
*/
/** Key derivation */
typedef struct
{
/** Pointer to the session */
sss_session_t *session;
/** KeyObject used to derive key s*/
sss_object_t *keyObject;
/** Algorithm to be applied, e.g. ... */
sss_algorithm_t algorithm;
/** Mode of operation for .... e.g. ... */
sss_mode_t mode;
/** Reserved memory for implementation specific extension */
struct
{
uint8_t data[SSS_DERIVE_KEY_MAX_CONTEXT_SIZE];
} extension;
} sss_derive_key_t;
/** @} */
/** Random number generator context */
typedef struct
{
/** Pointer to the session */
sss_session_t *session;
/** Reserved memory for implementation specific extension */
struct
{
uint8_t data[SSS_RNG_MAX_CONTEXT_SIZE];
} context;
} sss_rng_context_t;
/*******************************************************************************
* API
******************************************************************************/
#if defined(__cplusplus)
extern "C" {
#endif
/**
* @addtogroup sss_session
* @{
*/
/**
* Same as @ref sss_session_open but to support sub systems
* that explictily need a create before opening.
*
* For the sake of portabilty across various sub systems,
* the applicaiton has to call @ref sss_session_create
* before calling @ref sss_session_open.
*
*
* @param[in,out] session Pointer to session context
* @param[in] subsystem See @ref sss_session_open
* @param[in] application_id See @ref sss_session_open
* @param[in] connection_type See @ref sss_session_open
* @param[in] connectionData See @ref sss_session_open
*/
sss_status_t sss_session_create(sss_session_t *session,
sss_type_t subsystem,
uint32_t application_id,
sss_connection_type_t connection_type,
void *connectionData);
/**
* @brief Open session between application and a security subsystem.
*
* Open virtual session between application (user context) and a
* security subsystem and function thereof. Pointer to session
* shall be supplied to all SSS APIs as argument. Low level SSS
* functions can provide implementation specific behaviour based
* on the session argument.
* Note: sss_session_open() must not be called concurrently from
* multiple threads. The application must ensure this.
*
* @param[in,out] session Session context.
* @param[in] subsystem Indicates which security subsystem is
* selected to be used.
* @param[in] application_id ObjectId/AuthenticationID Connecting to:
* - ``application_id`` == 0 => Super use / Plaform user
* - Anything else => Authenticated user
* @param[in] connection_type How are we connecting to the system.
* @param[in,out] connectionData subsystem specific connection parameters.
*
* @return status
*/
sss_status_t sss_session_open(sss_session_t *session,
sss_type_t subsystem,
uint32_t application_id,
sss_connection_type_t connection_type,
void *connectionData);
/**
* @brief Get an underlying property of the crypto sub system
*
* This API is used to get values that are
* numeric in nature.
*
* Property can be either fixed value that is
* calculated at compile time and returned
* directly, or it may involve some access to the
* underlying system.
*
* For applicable properties see @ref sss_session_prop_u32_t
*
* @param[in] session Session context
* @param[in] property Value that is part of @ref sss_session_prop_u32_t
* @param[out] pValue
*
* @return
*/
sss_status_t sss_session_prop_get_u32(sss_session_t *session, uint32_t property, uint32_t *pValue);
/**
* @brief Get an underlying property of the crypto sub system
*
* This API is used to get values that are
* numeric in nature.
*
* Property can be either fixed value that is
* calculated at compile time and returned
* directly, or it may involve some access to the
* underlying system.
*
* @param[in] session Session context
* @param[in] property Value that is part of @ref sss_session_prop_au8_t
* @param[out] pValue Output buffer array
* @param[in,out] pValueLen Count of values thare are/must br read
* @return
*/
sss_status_t sss_session_prop_get_au8(sss_session_t *session, uint32_t property, uint8_t *pValue, size_t *pValueLen);
/**
* @brief Close session between application and security subsystem.
*
* This function closes a session which has been opened with a security subsystem.
* All commands within the session must have completed before this function can be called.
* The implementation must do nothing if the input ``session`` parameter is NULL.
*
*
* @param session Session context.
*/
void sss_session_close(sss_session_t *session);
/** Counterpart to @ref sss_session_create
*
* Similar to contraint on @ref sss_session_create, application
* may call @ref sss_session_delete to explicitly release all
* underlying/used session specific resoures of that implementation.
*/
void sss_session_delete(sss_session_t *session);
/**
*@}
*/ /* end of sss_session */
/**
* @addtogroup sss_key_store
* @{
*/
/** @brief Constructor for the key store context data structure.
*
* @param[out] keyStore Pointer to key store context. Key store context is updated on function return.
* @param session Session context.
*/
sss_status_t sss_key_store_context_init(sss_key_store_t *keyStore, sss_session_t *session);
/** @brief Get handle to key store.
* If the key store already exists, nothing is allocated.
* If the key store does not exists, new empty key store is created and initialized.
* Key store context structure is updated with actual information.
*
* @param[out] keyStore Pointer to key store context. Key store context is updated on function return.
* @param keyStoreId Implementation specific ID, can be used in case security subsystem manages multiple different
* key stores.
*/
sss_status_t sss_key_store_allocate(sss_key_store_t *keyStore, uint32_t keyStoreId);
/** @brief Save all cached persistent objects to persistent memory.
*/
sss_status_t sss_key_store_save(sss_key_store_t *keyStore);
/** @brief Load from persistent memory to cached objects.
*/
sss_status_t sss_key_store_load(sss_key_store_t *keyStore);
/** @brief This function moves data[] from memory to the destination key store.
*
* @param keyStore Key store context
* @param keyObject Reference to a key and it's properties
* @param data Data to be stored in Key. When setting ecc private key only, do not include key header.
* @param dataLen Length of the data
* @param keyBitLen Crypto algorithm key bit length
* @param options Pointer to implementation specific options
* @param optionsLen Length of the options in bytes
*
* @return
*/
sss_status_t sss_key_store_set_key(sss_key_store_t *keyStore,
sss_object_t *keyObject,
const uint8_t *data,
size_t dataLen,
size_t keyBitLen,
void *options,
size_t optionsLen);
/** @brief This function generates key[] in the destination key store. */
sss_status_t sss_key_store_generate_key(
sss_key_store_t *keyStore, sss_object_t *keyObject, size_t keyBitLen, void *options);
/** @brief This function exports plain key[] from key store (if constraints and user id allows reading) */
sss_status_t sss_key_store_get_key(
sss_key_store_t *keyStore, sss_object_t *keyObject, uint8_t *data, size_t *dataLen, size_t *pKeyBitLen);
/**
* @brief Access key store using one more level of encryption
*
* e.g. Access keys / encryption key during storage
*
* @param keyStore The key store
* @param keyObject The key object that is to be used as a KEK (Key Encryption Key)
*
* @return The sss status.
*/
sss_status_t sss_key_store_open_key(sss_key_store_t *keyStore, sss_object_t *keyObject);
/**
* @brief The referenced key cannot be updated any more.
*
* @param keyStore The key store
* @param keyObject The key object to be locked / frozen.
*
* @return The sss status.
*/
sss_status_t sss_key_store_freeze_key(sss_key_store_t *keyStore, sss_object_t *keyObject);
/**
* @brief Delete / destroy allocated keyObect .
*
* @param keyStore The key store
* @param keyObject The key object to be deleted
*
* @return The sss status.
*/
sss_status_t sss_key_store_erase_key(sss_key_store_t *keyStore, sss_object_t *keyObject);
// sss_status_t sss_key_store_clear_all(sss_key_store_t *keyStore);
/** @brief Destructor for the key store context. */
void sss_key_store_context_free(sss_key_store_t *keyStore);
/**
*@}
*/ /* end of sss_key_store */
/**
* @addtogroup sss_key_object
* @{
*/
/** @brief Constructor for a key object data structure
* The function initializes keyObject data structure and associates it with a key store
* in which the plain key and other attributes are stored.
*
* @param keyObject
* @param keyStore
*
* @returns Status of the operation
* @retval #kStatus_SSS_Success The operation has completed successfully.
* @retval #kStatus_SSS_Fail The operation has failed.
* @retval #kStatus_SSS_InvalidArgument One of the arguments is invalid for the function to execute.
*/
sss_status_t sss_key_object_init(sss_object_t *keyObject, sss_key_store_t *keyStore);
/**
* @brief Allocate / pre-provision memory for new key
*
* This API allows underlying cryptographic subsystems to perform
* preconditions of before creating any cryptographic key object.
*
* @param[in,out] keyObject The object If required, update implementation
* defined values inside the keyObject
* @param keyId External Key ID. Later on this may be used by
* @ref sss_key_object_get_handle
* @param keyPart See @ref sss_key_part_t
* @param cipherType See @ref sss_cipher_type_t
* @param keyByteLenMax Maximum storage this type of key may need. For
* systems that have their own internal allocation
* table this would help
* @param options 0 = Persistant Key (Default) or Transient Key.
* See sss_key_object_mode_t
*
* @return Status of object allocation.
*/
sss_status_t sss_key_object_allocate_handle(sss_object_t *keyObject,
uint32_t keyId,
sss_key_part_t keyPart,