corePKCS11  V3.0.0
PKCS #11 Cryptoki Library
core_pkcs11.h
Go to the documentation of this file.
1 /*
2  * corePKCS11 V3.0.0
3  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a copy of
6  * this software and associated documentation files (the "Software"), to deal in
7  * the Software without restriction, including without limitation the rights to
8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9  * the Software, and to permit persons to whom the Software is furnished to do so,
10  * subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in all
13  * copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21  *
22  * http://aws.amazon.com/freertos
23  * http://www.FreeRTOS.org
24  */
25 
26 #ifndef _CORE_PKCS11_H_
27 #define _CORE_PKCS11_H_
28 
29 #include <stdint.h>
30 
31 #ifdef _WIN32
32  #pragma pack(push, cryptoki, 1)
33 #endif
34 
50 #define CK_PTR *
51 
56 #ifndef NULL_PTR
57  #define NULL_PTR 0
58 #endif
59 
65 #define CK_DEFINE_FUNCTION( returnType, name ) returnType name
66 
72 #define CK_DECLARE_FUNCTION( returnType, name ) returnType name
73 
79 #define CK_DECLARE_FUNCTION_POINTER( returnType, name ) returnType( CK_PTR name )
80 
86 #define CK_CALLBACK_FUNCTION( returnType, name ) returnType( CK_PTR name )
87 
92 #define pkcs11SHA256_DIGEST_LENGTH 32UL
93 
100 #define pkcs11ECDSA_P256_SIGNATURE_LENGTH 64UL
101 
106 #define pkcs11ECDSA_P256_KEY_BITS 256UL
107 
112 #define pkcs11RSA_PUBLIC_EXPONENT { 0x01, 0x00, 0x01 }
113 
119 #define pkcs11RSA_2048_MODULUS_BITS 2048UL
120 
125 #define pkcs11RSA_2048_SIGNATURE_LENGTH ( pkcs11RSA_2048_MODULUS_BITS / 8UL )
126 
134 #define pkcs11RSA_SIGNATURE_INPUT_LENGTH 51UL
135 
141 #define pkcs11ELLIPTIC_CURVE_NISTP256 "1.2.840.10045.3.1.7"
142 
147 #define pkcs11MAX_LABEL_LENGTH 32UL /* 31 characters + 1 null terminator. */
148 
153 #define pkcs11DER_ENCODED_OID_P256 { 0x06, 0x08, 0x2a, 0x86, 0x48, 0xce, 0x3d, 0x03, 0x01, 0x07 }
154 
155 
161 #ifndef pkcs11configIMPORT_PRIVATE_KEYS_SUPPORTED
162  #define pkcs11configIMPORT_PRIVATE_KEYS_SUPPORTED 1
163 #endif
164 
185 #define pkcs11STUFF_APPENDED_TO_RSA_SIG { 0x30, 0x31, 0x30, 0x0d, 0x06, 0x09, 0x60, 0x86, 0x48, 0x01, 0x65, 0x03, 0x04, 0x02, 0x01, 0x05, 0x00, 0x04, 0x20 }
186 
187 /* Bring in the public header. */
188 
189 /* Undefine the macro for Keil Compiler to avoid conflict */
190 #if defined( __PASTE ) && defined( __CC_ARM )
191  /* ARM RCVT stdint.h has a duplicate definition with PKCS #11. */
192  #undef __PASTE
193 #endif
194 
195 #ifdef CreateMutex
196  #undef CreateMutex /* This is a workaround because CreateMutex is redefined to CreateMutexW in synchapi.h in windows. :/ */
197 #endif
198 
199 #include "pkcs11.h"
200 
206 typedef struct PKCS11_CertificateTemplate
207 {
208  CK_ATTRIBUTE xObjectClass;
209  CK_ATTRIBUTE xSubject;
210  CK_ATTRIBUTE xCertificateType;
211  CK_ATTRIBUTE xValue;
212  CK_ATTRIBUTE xLabel;
213  CK_ATTRIBUTE xTokenObject;
215 
216 /*------------------------ PKCS #11 wrapper functions -------------------------*/
217 
223 /* @[declare_pkcs11_core_xinitializepkcs11] */
224 CK_RV xInitializePKCS11( void );
225 /* @[declare_pkcs11_core_xinitializepkcs11] */
226 
241 /* @[declare_pkcs11_core_xgetslotlist] */
242 CK_RV xGetSlotList( CK_SLOT_ID ** ppxSlotId,
243  CK_ULONG * pxSlotCount );
244 /* @[declare_pkcs11_core_xgetslotlist] */
245 
255 /* @[declare_pkcs11_core_xinitializepkcs11session] */
256 CK_RV xInitializePkcs11Session( CK_SESSION_HANDLE * pxSession );
257 /* @[declare_pkcs11_core_xinitializepkcs11session] */
258 
265 /* @[declare_pkcs11_core_xinitializepkcs11token] */
266 CK_RV xInitializePkcs11Token( void );
267 /* @[declare_pkcs11_core_xinitializepkcs11token] */
268 
286 /* @[declare_pkcs11_core_xfindobjectwithlabelandclass] */
287 CK_RV xFindObjectWithLabelAndClass( CK_SESSION_HANDLE xSession,
288  char * pcLabelName,
289  CK_ULONG ulLabelNameLen,
290  CK_OBJECT_CLASS xClass,
291  CK_OBJECT_HANDLE_PTR pxHandle );
292 /* @[declare_pkcs11_core_xfindobjectwithlabelandclass] */
293 
313 /* @[declare_pkcs11_core_vappendsha256algorithmidentifiersequence] */
314 CK_RV vAppendSHA256AlgorithmIdentifierSequence( const uint8_t * puc32ByteHashedMessage,
315  uint8_t * puc51ByteHashOidBuffer );
316 /* @[declare_pkcs11_core_vappendsha256algorithmidentifiersequence] */
317 
318 #ifdef _WIN32
319  #pragma pack(pop, cryptoki)
320 #endif
321 
322 #endif /* ifndef _CORE_PKCS11_H_ */
PKCS11_CertificateTemplate_t::xObjectClass
CK_ATTRIBUTE xObjectClass
CKA_CLASS, set to CKO_CERTIFICATE.
Definition: core_pkcs11.h:208
xInitializePKCS11
CK_RV xInitializePKCS11(void)
Initializes a PKCS #11 session.
Definition: core_pkcs11.c:151
PKCS11_CertificateTemplate_t
Certificate Template The object class must be the first attribute in the array.
Definition: core_pkcs11.h:207
xGetSlotList
CK_RV xGetSlotList(CK_SLOT_ID **ppxSlotId, CK_ULONG *pxSlotCount)
Get a list of available PKCS #11 slots.
Definition: core_pkcs11.c:72
vAppendSHA256AlgorithmIdentifierSequence
CK_RV vAppendSHA256AlgorithmIdentifierSequence(const uint8_t *puc32ByteHashedMessage, uint8_t *puc51ByteHashOidBuffer)
Appends digest algorithm sequence to SHA-256 hash for RSA signatures.
Definition: core_pkcs11.c:375
PKCS11_CertificateTemplate_t::xTokenObject
CK_ATTRIBUTE xTokenObject
CKA_TOKEN.
Definition: core_pkcs11.h:213
xInitializePkcs11Token
CK_RV xInitializePkcs11Token(void)
Initializes a PKCS #11 module and token.
Definition: core_pkcs11.c:177
PKCS11_CertificateTemplate_t::xLabel
CK_ATTRIBUTE xLabel
CKA_LABEL.
Definition: core_pkcs11.h:212
PKCS11_CertificateTemplate_t::xCertificateType
CK_ATTRIBUTE xCertificateType
CKA_CERTIFICATE_TYPE, set to CKC_X_509.
Definition: core_pkcs11.h:210
PKCS11_CertificateTemplate_t::xValue
CK_ATTRIBUTE xValue
CKA_VALUE, the DER byte array of the certificate contents.
Definition: core_pkcs11.h:211
PKCS11_CertificateTemplate_t::xSubject
CK_ATTRIBUTE xSubject
CKA_SUBJECT, this parameter is required by the PKCS #11 standard.
Definition: core_pkcs11.h:209
xInitializePkcs11Session
CK_RV xInitializePkcs11Session(CK_SESSION_HANDLE *pxSession)
Initializes the PKCS #11 module and opens a session.
Definition: core_pkcs11.c:254
xFindObjectWithLabelAndClass
CK_RV xFindObjectWithLabelAndClass(CK_SESSION_HANDLE xSession, char *pcLabelName, CK_ULONG ulLabelNameLen, CK_OBJECT_CLASS xClass, CK_OBJECT_HANDLE_PTR pxHandle)
Searches for an object with a matching label and class provided.
Definition: core_pkcs11.c:310