Finished Digest and mechanisms demo #11
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,257 @@ | ||
| /* | ||
| * FreeRTOS PKCS #11 V1.0.3 | ||
| * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy of | ||
| * this software and associated documentation files (the "Software"), to deal in | ||
| * the Software without restriction, including without limitation the rights to | ||
| * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of | ||
| * the Software, and to permit persons to whom the Software is furnished to do so, | ||
| * subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in all | ||
| * copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS | ||
| * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR | ||
| * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER | ||
| * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN | ||
| * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
| * | ||
| * http://aws.amazon.com/freertos | ||
| * http://www.FreeRTOS.org | ||
| */ | ||
|
|
||
| /* FreeRTOS includes. */ | ||
| #include "FreeRTOS.h" | ||
| #include "task.h" | ||
|
|
||
| /* Standard includes. */ | ||
| #include "stdio.h" | ||
|
|
||
| /* PKCS #11 includes. */ | ||
| #include "iot_pkcs11_config.h" | ||
| #include "iot_pkcs11.h" | ||
| #include "pkcs11.h" | ||
|
|
||
| /* This function contains standard setup code for PKCS #11. See the | ||
| * "management_and_rng.c" file for the demo code explaining this section | ||
| * of cryptoki. | ||
| */ | ||
| void prvStart( CK_SESSION_HANDLE * pxSession, | ||
| CK_SLOT_ID ** ppxSlotId ) | ||
| { | ||
| CK_RV xResult = CKR_OK; | ||
|
|
||
| CK_FUNCTION_LIST_PTR pxFunctionList = NULL; | ||
| CK_C_INITIALIZE_ARGS xInitArgs = { 0 }; | ||
| CK_SESSION_HANDLE hSession = CK_INVALID_HANDLE; | ||
| CK_ULONG xSlotCount = 0; | ||
| CK_SLOT_ID * pxSlotId = NULL; | ||
|
|
||
| xResult = C_GetFunctionList( &pxFunctionList ); | ||
| configASSERT( xResult == CKR_OK ); | ||
| configASSERT( pxFunctionList != NULL ); | ||
| configASSERT( pxFunctionList->C_Initialize != NULL ); | ||
| configASSERT( pxFunctionList->C_GetSlotList != NULL ); | ||
| configASSERT( pxFunctionList->C_OpenSession != NULL ); | ||
| configASSERT( pxFunctionList->C_Login != NULL ); | ||
| configASSERT( pxFunctionList->C_GenerateRandom != NULL ); | ||
| configASSERT( pxFunctionList->C_CloseSession != NULL ); | ||
| configASSERT( pxFunctionList->C_Finalize != NULL ); | ||
|
|
||
| xResult = pxFunctionList->C_Initialize( &xInitArgs ); | ||
| configASSERT( xResult == CKR_OK ); | ||
|
|
||
| xResult = pxFunctionList->C_GetSlotList( CK_TRUE, | ||
| NULL, | ||
| &xSlotCount ); | ||
| configASSERT( xResult == CKR_OK ); | ||
|
|
||
| pxSlotId = pvPortMalloc( sizeof( CK_SLOT_ID ) * ( xSlotCount ) ); | ||
| configASSERT( pxSlotId != NULL ); | ||
|
|
||
| xResult = pxFunctionList->C_GetSlotList( CK_TRUE, | ||
| pxSlotId, | ||
| &xSlotCount ); | ||
| configASSERT( xResult == CKR_OK ); | ||
|
|
||
| xResult = pxFunctionList->C_OpenSession( pxSlotId[ 0 ], | ||
| CKF_SERIAL_SESSION | CKF_RW_SESSION, | ||
| NULL, /* Application defined pointer. */ | ||
| NULL, /* Callback function. */ | ||
| &hSession ); | ||
| configASSERT( xResult == CKR_OK ); | ||
|
|
||
|
|
||
| xResult = pxFunctionList->C_Login( hSession, | ||
| CKU_USER, | ||
| ( CK_UTF8CHAR_PTR ) configPKCS11_DEFAULT_USER_PIN, | ||
| sizeof( configPKCS11_DEFAULT_USER_PIN ) - 1UL ); | ||
| configASSERT( xResult == CKR_OK ); | ||
|
|
||
| *ppxSlotId = pxSlotId; | ||
| *pxSession = hSession; | ||
| } | ||
| /*-----------------------------------------------------------*/ | ||
|
|
||
| /* This function contains standard tear down code for PKCS #11. See the | ||
| * "management_and_rng.c" file for the demo code explaining this section | ||
| * of cryptoki. | ||
| */ | ||
| void prvEnd( CK_SESSION_HANDLE xSession, | ||
| CK_SLOT_ID * pxSlotId ) | ||
| { | ||
| C_CloseSession( xSession ); | ||
| C_Finalize( NULL ); | ||
| vPortFree( pxSlotId ); | ||
| } | ||
| /*-----------------------------------------------------------*/ | ||
|
|
||
| /* Write the ASN.1 encoded bytes of the device public key to the console. */ | ||
| void vWriteHexBytesToConsole( char * pcDescription, | ||
| CK_BYTE * pucData, | ||
| CK_ULONG ulDataLength ) | ||
| { | ||
| #define BYTES_TO_DISPLAY_PER_ROW 16 | ||
| char pcByteRow[ 1 + ( BYTES_TO_DISPLAY_PER_ROW * 2 ) + ( BYTES_TO_DISPLAY_PER_ROW / 2 ) ]; | ||
|
Contributor
There was a problem hiding this comment. Curious about the "math", a comment would help. |
||
| char * pcNextChar = pcByteRow; | ||
| uint32_t ulIndex = 0; | ||
| uint8_t ucByteValue = 0; | ||
|
Contributor
There was a problem hiding this comment.
|
||
|
|
||
| /* Write help text to the console. */ | ||
| configPRINTF( ( "%s, %d bytes:\r\n", pcDescription, ulDataLength ) ); | ||
|
|
||
| /* Iterate over the bytes of the encoded public key. */ | ||
| for( ; ulIndex < ulDataLength; ulIndex++ ) | ||
|
Contributor
There was a problem hiding this comment. I would leave |
||
| { | ||
| /* Convert one byte to ASCII hex. */ | ||
| ucByteValue = *( pucData + ulIndex ); | ||
| snprintf( pcNextChar, | ||
| sizeof( pcByteRow ) - ( pcNextChar - pcByteRow ), | ||
| "%02x", | ||
| ucByteValue ); | ||
| pcNextChar += 2; | ||
|
|
||
| /* Check for the end of a two-byte display word. */ | ||
| if( 0 == ( ( ulIndex + 1 ) % sizeof( uint16_t ) ) ) | ||
| { | ||
| *pcNextChar = ' '; | ||
| pcNextChar++; | ||
| } | ||
|
|
||
| /* Check for the end of a row. */ | ||
| if( 0 == ( ( ulIndex + 1 ) % BYTES_TO_DISPLAY_PER_ROW ) ) | ||
| { | ||
| *pcNextChar = '\0'; | ||
| configPRINTF( ( pcByteRow ) ); | ||
| configPRINTF( ( "\r\n" ) ); | ||
| pcNextChar = pcByteRow; | ||
| } | ||
| } | ||
|
|
||
| /* Check for a partial line to print. */ | ||
| if( pcNextChar > pcByteRow ) | ||
| { | ||
| *pcNextChar = '\0'; | ||
| configPRINTF( ( pcByteRow ) ); | ||
| configPRINTF( ( "\r\n" ) ); | ||
| } | ||
| } | ||
| /*-----------------------------------------------------------*/ | ||
|
|
||
| /* Extract ECDSA public key. */ | ||
| CK_RV vExportPublicKey( CK_SESSION_HANDLE xSession, | ||
| CK_OBJECT_HANDLE xPublicKeyHandle, | ||
| CK_BYTE ** ppucDerPublicKey, | ||
| CK_ULONG * pulDerPublicKeyLength ) | ||
| { | ||
| CK_RV xResult; | ||
| CK_FUNCTION_LIST_PTR pxFunctionList; | ||
| CK_KEY_TYPE xKeyType = 0; | ||
| CK_ATTRIBUTE xTemplate = { 0 }; | ||
| uint8_t pucEcP256AsnAndOid[] = | ||
|
Contributor
There was a problem hiding this comment. Would appreciate some comment on the key header format. If there's a quick link to wiki, that'll help. |
||
| { | ||
| 0x30, 0x59, 0x30, 0x13, 0x06, 0x07, 0x2a, 0x86, | ||
| 0x48, 0xce, 0x3d, 0x02, 0x01, 0x06, 0x08, 0x2a, | ||
| 0x86, 0x48, 0xce, 0x3d, 0x03, 0x01, 0x07, 0x03, | ||
| 0x42, 0x00 | ||
| }; | ||
| uint8_t pucUnusedKeyTag[] = { 0x04, 0x41 }; | ||
|
|
||
| /* This variable is used only for its size. This gets rid of compiler warnings. */ | ||
| ( void ) pucUnusedKeyTag; | ||
|
|
||
| xResult = C_GetFunctionList( &pxFunctionList ); | ||
|
|
||
| /* Query the key type. */ | ||
| if( CKR_OK == xResult ) | ||
| { | ||
| xTemplate.type = CKA_KEY_TYPE; | ||
| xTemplate.pValue = &xKeyType; | ||
| xTemplate.ulValueLen = sizeof( xKeyType ); | ||
| xResult = pxFunctionList->C_GetAttributeValue( xSession, | ||
| xPublicKeyHandle, | ||
| &xTemplate, | ||
| 1 ); | ||
| } | ||
|
|
||
| /* Scope to ECDSA keys only, since there's currently no use case for | ||
| * onboard keygen and certificate enrollment for RSA. */ | ||
| if( ( CKR_OK == xResult ) && ( CKK_ECDSA == xKeyType ) ) | ||
| { | ||
| /* Query the size of the public key. */ | ||
| xTemplate.type = CKA_EC_POINT; | ||
| xTemplate.pValue = NULL; | ||
| xTemplate.ulValueLen = 0; | ||
| xResult = pxFunctionList->C_GetAttributeValue( xSession, | ||
| xPublicKeyHandle, | ||
| &xTemplate, | ||
| 1 ); | ||
|
|
||
| /* Allocate a buffer large enough for the full, encoded public key. */ | ||
| if( CKR_OK == xResult ) | ||
| { | ||
| /* Add space for the full DER header. */ | ||
| xTemplate.ulValueLen += sizeof( pucEcP256AsnAndOid ) - sizeof( pucUnusedKeyTag ); | ||
| *pulDerPublicKeyLength = xTemplate.ulValueLen; | ||
|
|
||
| /* Get a heap buffer. */ | ||
| *ppucDerPublicKey = pvPortMalloc( xTemplate.ulValueLen ); | ||
|
|
||
| /* Check for resource exhaustion. */ | ||
| if( NULL == *ppucDerPublicKey ) | ||
| { | ||
| xResult = CKR_HOST_MEMORY; | ||
| } | ||
| } | ||
|
|
||
| /* Export the public key. */ | ||
| if( CKR_OK == xResult ) | ||
| { | ||
| xTemplate.pValue = *ppucDerPublicKey + sizeof( pucEcP256AsnAndOid ) - sizeof( pucUnusedKeyTag ); | ||
| xTemplate.ulValueLen -= ( sizeof( pucEcP256AsnAndOid ) - sizeof( pucUnusedKeyTag ) ); | ||
| xResult = pxFunctionList->C_GetAttributeValue( xSession, | ||
| xPublicKeyHandle, | ||
| &xTemplate, | ||
| 1 ); | ||
| } | ||
|
|
||
| /* Prepend the full DER header. */ | ||
| if( CKR_OK == xResult ) | ||
| { | ||
| memcpy( *ppucDerPublicKey, pucEcP256AsnAndOid, sizeof( pucEcP256AsnAndOid ) ); | ||
| } | ||
| } | ||
|
|
||
| /* Free memory if there was an error after allocation. */ | ||
| if( ( NULL != *ppucDerPublicKey ) && ( CKR_OK != xResult ) ) | ||
| { | ||
| vPortFree( *ppucDerPublicKey ); | ||
| *ppucDerPublicKey = NULL; | ||
| } | ||
|
|
||
| return xResult; | ||
| } | ||
| /*-----------------------------------------------------------*/ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure whether this library/demo is targeting at ANSI C. May get a warning with "{0}"