aws_iot_provisioning_internal.h

Go to the documentation of this file.

/*
 * Copyright (C) 2019 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.
 */

#ifndef AWS_IOT_PROVISIONING_INTERNAL_H_
#define AWS_IOT_PROVISIONING_INTERNAL_H_

/* The config header is always included first. */
#include "iot_config.h"

/* AWS IoT common header include. */
#include "aws_iot.h"

/* Provisioning include. */
#include "aws_iot_provisioning.h"

/* Serializer include. */
#include "iot_serializer.h"

#if AWS_IOT_PROVISIONING_ENABLE_ASSERTS == 1
    #ifndef AwsIotProvisioning_Assert
        #ifdef Iot_DefaultAssert
            #define AwsIotProvisioning_Assert( expression )    Iot_DefaultAssert( expression )
        #else
            #error "Asserts are enabled for MQTT, but AwsIotProvisioning_Assert is not defined"
        #endif
    #endif
#else
    #define AwsIotProvisioning_Assert( expression )
#endif

/* Configure logs for PROVISIONING functions. */
#ifdef AWS_IOT_LOG_LEVEL_PROVISIONING
    #define LIBRARY_LOG_LEVEL        AWS_IOT_LOG_LEVEL_PROVISIONING
#else
    #ifdef IOT_LOG_LEVEL_GLOBAL
        #define LIBRARY_LOG_LEVEL    IOT_LOG_LEVEL_GLOBAL
    #else
        #define LIBRARY_LOG_LEVEL    IOT_LOG_NONE
    #endif
#endif

#define LIBRARY_LOG_NAME    ( "Provisioning" )
#include "iot_logging_setup.h"

#define CREATE_KEYS_AND_CERTIFICATE_OPERATION_LOG    "CREATE KEYS AND CERTIFICATE"
#define CREATE_CERT_FROM_CSR_OPERATION_LOG           "CREATE CERTIFICATE FROM CSR"
#define REGISTER_THING_OPERATION_LOG                 "REGISTER DEVICE"

#ifndef AWS_IOT_PROVISIONING_FORMAT
    #define AWS_IOT_PROVISIONING_FORMAT    AWS_IOT_PROVISIONING_FORMAT_CBOR
#endif

/* In current release, JSON format is not supported. */
#if AWS_IOT_PROVISIONING_FORMAT == AWS_IOT_PROVISIONING_FORMAT_JSON
    #error "AWS_IOT_PROVISIONING_FORMAT_JSON is not supported."
#endif

#if AWS_IOT_PROVISIONING_FORMAT == AWS_IOT_PROVISIONING_FORMAT_CBOR
    #define PROVISIONING_FORMAT    "cbor"
#else /* if AWS_IOT_PROVISIONING_FORMAT == AWS_IOT_PROVISIONING_FORMAT_CBOR */
    #error "AWS_IOT_PROVISIONING_FORMAT must be AWS_IOT_PROVISIONING_FORMAT_CBOR."
#endif /* if AWS_IOT_PROVISIONING_FORMAT == AWS_IOT_PROVISIONING_FORMAT_CBOR */

/*
 * Provide default values for undefined memory allocation functions based on
 * the usage of dynamic memory allocation.
 */
#if IOT_STATIC_MEMORY_ONLY == 1
    #include "iot_static_memory.h"

    #define AwsIotProvisioning_MallocPayload    Iot_MallocMessageBuffer

    #define AwsIotProvisioning_FreePayload      Iot_FreeMessageBuffer

    #define AwsIotProvisioning_MallocString     Iot_MallocMessageBuffer

    #define AwsIotProvisioning_FreeString       Iot_FreeMessageBuffer


    #define AwsIotProvisioning_MallocDeviceConfigurationList    Iot_MallocMessageBuffer

    #define AwsIotProvisioning_FreeDeviceConfigurationList      Iot_FreeMessageBuffer


#else /* if IOT_STATIC_MEMORY_ONLY == 1 */
    #ifndef AwsIotProvisioning_MallocPayload
        #ifdef Iot_DefaultMalloc
            #define AwsIotProvisioning_MallocPayload    Iot_DefaultMalloc
        #else
            #error "No malloc function defined for AwsIotProvisioning_MallocPayload"
        #endif
    #endif

    #ifndef AwsIotProvisioning_FreePayload
        #ifdef Iot_DefaultFree
            #define AwsIotProvisioning_FreePayload    Iot_DefaultFree
        #else
            #error "No Free function defined for AwsIotProvisioning_FreePayload"
        #endif
    #endif

    #ifndef AwsIotProvisioning_MallocString
        #ifdef Iot_DefaultMalloc
            #define AwsIotProvisioning_MallocString    Iot_DefaultMalloc
        #else
            #error "No malloc function defined for AwsIotProvisioning_MallocString"
        #endif
    #endif

    #ifndef AwsIotProvisioning_FreeString
        #ifdef Iot_DefaultFree
            #define AwsIotProvisioning_FreeString    Iot_DefaultFree
        #else
            #error "No Free function defined for AwsIotProvisioning_FreeString"
        #endif
    #endif

    #ifndef AwsIotProvisioning_MallocDeviceConfigurationList
        #ifdef Iot_DefaultMalloc
            #define AwsIotProvisioning_MallocDeviceConfigurationList    Iot_DefaultMalloc
        #else
            #error "No malloc function defined for AwsIotProvisioning_MallocDeviceConfigurationList"
        #endif
    #endif

    #ifndef AwsIotProvisioning_FreeDeviceConfigurationList
        #ifdef Iot_DefaultFree
            #define AwsIotProvisioning_FreeDeviceConfigurationList    Iot_DefaultFree
        #else
            #error "No Free function defined for AwsIotProvisioning_FreeDeviceConfigurationList"
        #endif
    #endif

#endif /* if IOT_STATIC_MEMORY_ONLY == 1 */

#ifndef AWS_IOT_PROVISIONING_DEFAULT_MQTT_TIMEOUT_MS
    #define AWS_IOT_PROVISIONING_DEFAULT_MQTT_TIMEOUT_MS    ( 5000 )
#endif

#define PROVISIONING_CREATE_KEYS_AND_CERTIFICATE_RESPONSE_TOPIC_FILTER \
    "$aws/certificates/create/"PROVISIONING_FORMAT

#define PROVISIONING_CREATE_KEYS_AND_CERTIFICATE_RESPONSE_TOPIC_FILTER_LENGTH \
    ( ( uint16_t ) ( sizeof( PROVISIONING_CREATE_KEYS_AND_CERTIFICATE_RESPONSE_TOPIC_FILTER ) - 1 ) )

#define PROVISIONING_CREATE_KEYS_AND_CERTIFICATE_RESPONSE_MAX_TOPIC_LENGTH \
    ( PROVISIONING_CREATE_KEYS_AND_CERTIFICATE_RESPONSE_TOPIC_FILTER_LENGTH + sizeof( AWS_IOT_REJECTED_SUFFIX ) )

#define PROVISIONING_CREATE_KEYS_AND_CERTIFICATE_REQUEST_TOPIC \
    "$aws/certificates/create/"PROVISIONING_FORMAT

#define PROVISIONING_CREATE_KEYS_AND_CERTIFICATE_REQUEST_TOPIC_LENGTH \
    ( ( uint16_t ) ( sizeof( PROVISIONING_CREATE_KEYS_AND_CERTIFICATE_REQUEST_TOPIC ) - 1 ) )

#define PROVISIONING_CREATE_CERT_FROM_CSR_RESPONSE_TOPIC_FILTER \
    "$aws/certificates/create-from-csr/"PROVISIONING_FORMAT

#define PROVISIONING_CREATE_CERT_FROM_CSR_RESPONSE_TOPIC_FILTER_LENGTH \
    ( ( uint16_t ) ( sizeof( PROVISIONING_CREATE_CERT_FROM_CSR_RESPONSE_TOPIC_FILTER ) - 1 ) )

#define PROVISIONING_CREATE_CERT_FROM_CSR_RESPONSE_MAX_TOPIC_LENGTH \
    ( PROVISIONING_CREATE_CERT_FROM_CSR_RESPONSE_TOPIC_FILTER_LENGTH + sizeof( AWS_IOT_REJECTED_SUFFIX ) )

#define PROVISIONING_CREATE_CERT_FROM_CSR_REQUEST_TOPIC \
    "$aws/certificates/create-from-csr/"PROVISIONING_FORMAT

#define PROVISIONING_CREATE_CERT_FROM_CSR_REQUEST_TOPIC_LENGTH \
    ( ( uint16_t ) ( sizeof( PROVISIONING_CREATE_CERT_FROM_CSR_REQUEST_TOPIC ) - 1 ) )

#define PROVISIONING_CREATE_CERT_FROM_CSR_REQUEST_PAYLOAD_PEM_STRING                    "certificateSigningRequest"

#define PROVISIONING_SERVER_RESPONSE_PAYLOAD_CERTIFICATE_PEM_STRING                     "certificatePem"

#define PROVISIONING_SERVER_RESPONSE_PAYLOAD_CERTIFICATE_ID_STRING                      "certificateId"

#define PROVISIONING_CREATE_KEYS_AND_CERTIFICATE_RESPONSE_PAYLOAD_PRIVATE_KEY_STRING    "privateKey"

#define PROVISIONING_SERVER_RESPONSE_PAYLOAD_CERTIFICATE_TOKEN_KEY_STRING               "certificateOwnershipToken"

#define PROVISIONING_REGISTER_THING_TOPICS_COMMON_PREFIX \
    "$aws/provisioning-templates/"

#define PROVISIONING_REGISTER_THING_TOPICS_COMMON_PREFIX_LENGTH \
    ( ( uint16_t ) ( sizeof( PROVISIONING_REGISTER_THING_TOPICS_COMMON_PREFIX ) - 1 ) )

#define PROVISIONING_MAX_TEMPLATE_NAME_LENGTH               ( 36 )

#define PROVISIONING_REGISTER_THING_TOPICS_COMMON_SUFFIX    "/provision/"PROVISIONING_FORMAT

#define PROVISIONING_REGISTER_THING_TOPICS_COMMON_SUFFIX_LENGTH \
    ( ( uint16_t ) ( sizeof( PROVISIONING_REGISTER_THING_TOPICS_COMMON_SUFFIX ) - 1 ) )


#define PROVISIONING_REGISTER_THING_REQUEST_TOPIC_LENGTH                                                \
    ( PROVISIONING_REGISTER_THING_TOPICS_COMMON_PREFIX_LENGTH + PROVISIONING_MAX_TEMPLATE_NAME_LENGTH + \
      PROVISIONING_REGISTER_THING_TOPICS_COMMON_SUFFIX_LENGTH )

#define PROVISIONING_REGISTER_THING_REQUEST_PAYLOAD_CERTIFICATE_ID_STRING       "certificateId"

#define PROVISIONING_REGISTER_THING_REQUEST_PAYLOAD_CERTIFICATE_TOKEN_STRING    "certificateOwnershipToken"

#define PROVISIONING_REGISTER_THING_REQUEST_PAYLOAD_PARAMETERS_STRING           "parameters"

#define PROVISIONING_REGISTER_THING_RESPONSE_TOPIC_FILTER_LENGTH                                        \
    ( PROVISIONING_REGISTER_THING_TOPICS_COMMON_PREFIX_LENGTH + PROVISIONING_MAX_TEMPLATE_NAME_LENGTH + \
      PROVISIONING_REGISTER_THING_TOPICS_COMMON_SUFFIX_LENGTH )

#define PROVISIONING_REGISTER_THING_RESPONSE_MAX_TOPIC_LENGTH \
    ( PROVISIONING_REGISTER_THING_RESPONSE_TOPIC_FILTER_LENGTH + sizeof( AWS_IOT_REJECTED_SUFFIX ) )

#define PROVISIONING_REGISTER_THING_RESPONSE_PAYLOAD_DEVICE_CONFIGURATION_STRING    "deviceConfiguration"

#define PROVISIONING_REGISTER_THING_RESPONSE_PAYLOAD_THING_NAME_STRING              "thingName"

#define PROVISIONING_REJECTED_RESPONSE_STATUS_CODE_STRING                           "statusCode"

#define PROVISIONING_REJECTED_RESPONSE_ERROR_CODE_STRING                            "errorCode"

#define PROVISIONING_REJECTED_RESPONSE_ERROR_MESSAGE_STRING                         "errorMessage"

/*---------------------- Provisioning internal data structures ----------------------*/

typedef enum _provisioningOperationType
{
    PROVISIONING_CREATE_KEYS_AND_CERTIFICATE = 0, 
    PROVISIONING_REGISTER_THING = 1,              
} _provisioningOperationType_t;

typedef union _provisioningCallbackInfo
{
    AwsIotProvisioningCreateKeysAndCertificateCallbackInfo_t createKeysAndCertificateCallback;

    AwsIotProvisioningCreateCertFromCsrCallbackInfo_t createCertFromCsrCallback;

    AwsIotProvisioningRegisterThingCallbackInfo_t registerThingCallback;
} _provisioningCallbackInfo_t;

typedef AwsIotProvisioningError_t ( * _provisioningServerResponseParser)( AwsIotStatus_t responseType,
                                                                          const uint8_t * responsePayload,
                                                                          size_t responsePayloadLength,
                                                                          const _provisioningCallbackInfo_t * userCallback );

typedef struct _provisioningOperationInfo
{
    AwsIotProvisioningError_t status;         
    _provisioningCallbackInfo_t userCallback; 
} _provisioningOperationInfo_t;

typedef struct _provisioningOperation
{
    _provisioningOperationInfo_t info;  
    uint32_t semReferenceCount;         
    IotSemaphore_t responseReceivedSem; 
} _provisioningOperation_t;

/*----------------- Declaration of INTERNAL global variables --------------------*/

extern uint32_t _AwsIotProvisioningMqttTimeoutMs;
extern const IotSerializerEncodeInterface_t * _pAwsIotProvisioningEncoder;
extern const IotSerializerDecodeInterface_t * _pAwsIotProvisioningDecoder;

/*---------------------- Declaration of Provisioning INTERNAL functions ----------------------*/

size_t _AwsIotProvisioning_GenerateRegisterThingTopicFilter( const char * pTemplateName,
                                                             size_t templateNameLength,
                                                             char * pTopicFilterBuffer );

AwsIotProvisioningError_t _AwsIotProvisioning_ParseKeysAndCertificateResponse( AwsIotStatus_t responseType,
                                                                               const uint8_t * pResponsePayload,
                                                                               size_t payloadLength,
                                                                               const _provisioningCallbackInfo_t * userCallbackInfo );

AwsIotProvisioningError_t _AwsIotProvisioning_ParseCsrResponse( AwsIotStatus_t responseType,
                                                                const uint8_t * pResponsePayload,
                                                                size_t payloadLength,
                                                                const _provisioningCallbackInfo_t * userCallbackInfo );

AwsIotProvisioningError_t _AwsIotProvisioning_ParseRegisterThingResponse( AwsIotStatus_t responseType,
                                                                          const uint8_t * pResponsePayload,
                                                                          size_t responsePayloadLength,
                                                                          const _provisioningCallbackInfo_t * userCallbackInfo );

AwsIotProvisioningError_t _AwsIotProvisioning_SerializeCreateKeysAndCertificateRequestPayload( uint8_t ** pSerializationBuffer,
                                                                                               size_t * pBufferSize );

AwsIotProvisioningError_t _AwsIotProvisioning_CalculateCertFromCsrPayloadSize( const char * pCertificateSigningRequest,
                                                                               size_t csrLength,
                                                                               size_t * pPayloadSize );

AwsIotProvisioningError_t _AwsIotProvisioning_SerializeCreateCertFromCsrRequestPayload( const char * pCertificateSigningRequest,
                                                                                        size_t csrLength,
                                                                                        uint8_t * pSerializationBuffer,
                                                                                        size_t pBufferSize );

AwsIotProvisioningError_t _AwsIotProvisioning_SerializeRegisterThingRequestPayload( const AwsIotProvisioningRegisterThingRequestInfo_t * pRequestData,
                                                                                    uint8_t ** pSerializationBuffer,
                                                                                    size_t * pBufferSize );

#endif /* ifndef AWS_IOT_PROVISIONING_INTERNAL_H_ */