/* * AWS IoT Over-the-air Update v3.4.0 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * SPDX-License-Identifier: MIT * * 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. */ /* Standard includes. */ #include #include /* CBOR and OTA includes. */ #include "ota.h" #include "ota_private.h" #include "ota_cbor_private.h" /* Unity framework includes. */ #include "unity_fixture.h" #include "unity.h" /* test includes. */ #include "utest_helpers.h" #define CBOR_TEST_MESSAGE_BUFFER_SIZE ( OTA_FILE_BLOCK_SIZE * 2 ) #define CBOR_TEST_BITMAP_VALUE 0xAAAAAAAA #define CBOR_TEST_BLOCKIDENTITY_VALUE 0 /* ========================================================================== */ /** * @brief Test OTA_CBOR_Encode_GetStreamRequestMessage() encodes a message correctly. * */ void test_OTA_CborEncodeStreamRequest() { uint8_t cborWork[ CBOR_TEST_MESSAGE_BUFFER_SIZE ]; size_t encodedSize = 0; uint32_t bitmap = CBOR_TEST_BITMAP_VALUE; uint32_t numBlocksRequest = otaconfigMAX_NUM_BLOCKS_REQUEST; /* CBOR representation of a json get stream request message, * {"c": "ThisIsAClientToken", "f": 1, "l": 4096, "o": 0, "b": b"\xaa\xaa\xaa\xaa", "n": numBlocksRequest} */ uint8_t expectedData[] = { 0xa6, 0x61, 0x63, 0x72, 0x54, 0x68, 0x69, 0x73, 0x49, 0x73, 0x41, 0x43, 0x6c, 0x69, 0x65, 0x6e, 0x74, 0x54, 0x6f, 0x6b, 0x65, 0x6e, 0x61, 0x66, 0x1, 0x61, 0x6c, 0x19, 0x10, 0x0, 0x61, 0x6f, 0x0, 0x61, 0x62, 0x44, 0xaa, 0xaa, 0xaa, 0xaa, 0x61, 0x6e, numBlocksRequest }; bool result = OTA_CBOR_Encode_GetStreamRequestMessage( cborWork, /* output message buffer. */ sizeof( cborWork ), /* size of output message buffer. */ &encodedSize, /* size of encoded message. */ CBOR_TEST_CLIENTTOKEN_VALUE, /* client token. */ 1, /* file id. */ OTA_FILE_BLOCK_SIZE, /* block size. */ 0, /* block offset. */ ( uint8_t * ) &bitmap, /* block bitmap. */ sizeof( bitmap ), /* size of bitmap. */ otaconfigMAX_NUM_BLOCKS_REQUEST ); /* number of block requested. */ TEST_ASSERT_TRUE( result ); TEST_ASSERT_EQUAL( sizeof( expectedData ), encodedSize ); int i; for( i = 0; i < ( int ) sizeof( expectedData ); ++i ) { TEST_ASSERT_EQUAL( expectedData[ i ], cborWork[ i ] ); } } /** * @brief Test OTA_CBOR_Decode_GetStreamResponseMessage() decodes a message correctly. * */ void test_OTA_CborDecodeStreamResponse() { uint8_t blockPayload[ OTA_FILE_BLOCK_SIZE ] = { 0 }; uint8_t cborWork[ CBOR_TEST_MESSAGE_BUFFER_SIZE ] = { 0 }; size_t encodedSize = 0; int fileId = -1; int blockIndex = -1; int blockSize = -1; uint8_t decodedPayload[ OTA_FILE_BLOCK_SIZE ] = { 0 }; uint8_t * pDecodedPayload = decodedPayload; size_t payloadSize = -1; bool result = false; bool msgValidity = true; int i = 0; /* Test OTA_CBOR_Decode_GetStreamResponseMessage( ). */ for( i = 0; i < ( int ) sizeof( blockPayload ); i++ ) { blockPayload[ i ] = i % UINT8_MAX; } /* Encode the above payload. */ result = createOtaStreamingMessage( cborWork, sizeof( cborWork ), CBOR_TEST_BLOCKIDENTITY_VALUE, blockPayload, sizeof( blockPayload ), &encodedSize, msgValidity ); TEST_ASSERT_EQUAL( CborNoError, result ); result = OTA_CBOR_Decode_GetStreamResponseMessage( cborWork, encodedSize, &fileId, &blockIndex, &blockSize, &pDecodedPayload, &payloadSize ); TEST_ASSERT_TRUE( result ); TEST_ASSERT_EQUAL( CBOR_TEST_FILEIDENTITY_VALUE, fileId ); TEST_ASSERT_EQUAL( CBOR_TEST_BLOCKIDENTITY_VALUE, blockIndex ); TEST_ASSERT_EQUAL( OTA_FILE_BLOCK_SIZE, blockSize ); TEST_ASSERT_EQUAL( OTA_FILE_BLOCK_SIZE, payloadSize ); for( i = 0; i < ( int ) sizeof( blockPayload ); i++ ) { TEST_ASSERT_EQUAL( blockPayload[ i ], decodedPayload[ i ] ); } } /** * @brief Test OTA_CBOR_Encode throws an error with invalid(NULL) parameters. * */ void test_OTA_CborEncodeStreamRequest_Invalid() { uint8_t cborWork[ CBOR_TEST_MESSAGE_BUFFER_SIZE ]; size_t encodedSize = 0; uint32_t bitmap = CBOR_TEST_BITMAP_VALUE; /* Test that encoding fails with invalid bitmap. */ bool result = OTA_CBOR_Encode_GetStreamRequestMessage( cborWork, /* output message buffer. */ sizeof( cborWork ), /* size of output message buffer. */ &encodedSize, /* size of encoded message. */ CBOR_TEST_CLIENTTOKEN_VALUE, /* client token. */ 1, /* file id. */ OTA_FILE_BLOCK_SIZE, /* block size. */ 0, /* block offset. */ NULL, /* block bitmap. */ sizeof( bitmap ), /* size of bitmap. */ otaconfigMAX_NUM_BLOCKS_REQUEST ); /* number of block requested. */ TEST_ASSERT_FALSE( result ); /* Test that encoding fails with invalid message buffer. */ result = OTA_CBOR_Encode_GetStreamRequestMessage( NULL, /* output message buffer. */ sizeof( cborWork ), /* size of output message buffer. */ &encodedSize, /* size of encoded message. */ CBOR_TEST_CLIENTTOKEN_VALUE, /* client token. */ 1, /* file id. */ OTA_FILE_BLOCK_SIZE, /* block size. */ 0, /* block offset. */ ( uint8_t * ) &bitmap, /* block bitmap. */ sizeof( bitmap ), /* size of bitmap. */ otaconfigMAX_NUM_BLOCKS_REQUEST ); /* number of block requested. */ TEST_ASSERT_FALSE( result ); /* Test that encoding fails with invalid size of encoded message. */ result = OTA_CBOR_Encode_GetStreamRequestMessage( cborWork, /* output message buffer. */ sizeof( cborWork ), /* size of output message buffer. */ NULL, /* size of encoded message. */ CBOR_TEST_CLIENTTOKEN_VALUE, /* client token. */ 1, /* file id. */ OTA_FILE_BLOCK_SIZE, /* block size. */ 0, /* block offset. */ ( uint8_t * ) &bitmap, /* block bitmap. */ sizeof( bitmap ), /* size of bitmap. */ otaconfigMAX_NUM_BLOCKS_REQUEST ); /* number of block requested. */ TEST_ASSERT_FALSE( result ); /* Test that encoding fails with invalid client token. */ result = OTA_CBOR_Encode_GetStreamRequestMessage( cborWork, /* output message buffer. */ sizeof( cborWork ), /* size of output message buffer. */ &encodedSize, /* size of encoded message. */ NULL, /* client token. */ 1, /* file id. */ OTA_FILE_BLOCK_SIZE, /* block size. */ 0, /* block offset. */ ( uint8_t * ) &bitmap, /* block bitmap. */ sizeof( bitmap ), /* size of bitmap. */ otaconfigMAX_NUM_BLOCKS_REQUEST ); /* number of block requested. */ TEST_ASSERT_FALSE( result ); } /** * @brief Test OTA_CBOR_Decode fails for invalid(NULL) parameters or * incorrect datatype of a field. * */ void test_OTA_CborDecodeStreamResponse_Invalid() { uint8_t blockPayload[ OTA_FILE_BLOCK_SIZE ] = { 0 }; uint8_t cborWork[ CBOR_TEST_MESSAGE_BUFFER_SIZE ] = { 0 }; size_t encodedSize = 0; int fileId = -1; int blockIndex = -1; int blockSize = -1; uint8_t decodedPayload[ OTA_FILE_BLOCK_SIZE ] = { 0 }; uint8_t * pDecodedPayload = decodedPayload; size_t payloadSize = -1; bool result = false; bool msgValidity = false; int i = 0; /* Construct a payload. */ for( i = 0; i < ( int ) sizeof( blockPayload ); i++ ) { blockPayload[ i ] = i % UINT8_MAX; } /* Create an invalid message by encoding a string * instead of an integer for fileid. */ result = createOtaStreamingMessage( cborWork, sizeof( cborWork ), CBOR_TEST_BLOCKIDENTITY_VALUE, blockPayload, sizeof( blockPayload ), &encodedSize, msgValidity ); TEST_ASSERT_EQUAL( CborNoError, result ); result = OTA_CBOR_Decode_GetStreamResponseMessage( cborWork, encodedSize, &fileId, &blockIndex, &blockSize, &pDecodedPayload, &payloadSize ); TEST_ASSERT_FALSE( result ); /* Decoding fails because fileid is of type CborString. */ /* Test that decoding fails with invalid message buffer. */ result = OTA_CBOR_Decode_GetStreamResponseMessage( NULL, encodedSize, &fileId, &blockIndex, &blockSize, &pDecodedPayload, &payloadSize ); TEST_ASSERT_FALSE( result ); /* Test that decoding fails with invalid payload size. */ result = OTA_CBOR_Decode_GetStreamResponseMessage( cborWork, encodedSize, &fileId, &blockIndex, &blockSize, &pDecodedPayload, NULL ); TEST_ASSERT_FALSE( result ); /* Test that decoding fails with invalid payload buffer. */ result = OTA_CBOR_Decode_GetStreamResponseMessage( cborWork, encodedSize, &fileId, &blockIndex, &blockSize, NULL, &payloadSize ); TEST_ASSERT_FALSE( result ); /* Test that decoding fails with invalid block size. */ result = OTA_CBOR_Decode_GetStreamResponseMessage( cborWork, encodedSize, &fileId, &blockIndex, NULL, &pDecodedPayload, &payloadSize ); TEST_ASSERT_FALSE( result ); /* Test that decoding fails with invalid block id. */ result = OTA_CBOR_Decode_GetStreamResponseMessage( cborWork, encodedSize, &fileId, NULL, &blockSize, &pDecodedPayload, &payloadSize ); TEST_ASSERT_FALSE( result ); /* Test that decoding fails with invalid file index. */ result = OTA_CBOR_Decode_GetStreamResponseMessage( cborWork, encodedSize, NULL, &blockIndex, &blockSize, &pDecodedPayload, &payloadSize ); TEST_ASSERT_FALSE( result ); /* Test that decoding fails when payload size(0) lesser than actual payload. */ msgValidity = true; payloadSize = 0; result = createOtaStreamingMessage( cborWork, sizeof( cborWork ), CBOR_TEST_BLOCKIDENTITY_VALUE, blockPayload, sizeof( blockPayload ), &encodedSize, msgValidity ); TEST_ASSERT_EQUAL( CborNoError, result ); result = OTA_CBOR_Decode_GetStreamResponseMessage( cborWork, encodedSize, &fileId, &blockIndex, &blockSize, &pDecodedPayload, &payloadSize ); TEST_ASSERT_FALSE( result ); } /** * @brief Test OTA_CBOR_Decode throws an error if a CborArray * is received instead of CborMap. * */ void test_OTA_CborDecodeStreamResponse_InvalidMap() { uint8_t cborWork[ CBOR_TEST_MESSAGE_BUFFER_SIZE ] = { 0 }; size_t encodedSize = 0; int fileId = -1; int blockIndex = -1; int blockSize = -1; uint8_t decodedPayload[ OTA_FILE_BLOCK_SIZE ] = { 0 }; uint8_t * pDecodedPayload = decodedPayload; size_t payloadSize = -1; bool result = false; result = createCborArray( cborWork, sizeof( cborWork ), &encodedSize ); TEST_ASSERT_EQUAL( CborNoError, result ); result = OTA_CBOR_Decode_GetStreamResponseMessage( cborWork, encodedSize, &fileId, &blockIndex, &blockSize, &pDecodedPayload, &payloadSize ); TEST_ASSERT_FALSE( result ); }