Have Fleet Provisoning demo log recieved CBOR payloads (aws#1713)

Author: archigup

demos/fleet_provisioning/fleet_provisioning_with_csr/fleet_provisioning_serializer.c

@@ -21,6 +21,9 @@
  * SOFTWARE.
  */
 
+/* Standard includes */
+#include <stdarg.h>
+
 /* TinyCBOR library for CBOR encoding and decoding operations. */
 #include "cbor.h"
 
@@ -32,6 +35,35 @@
 
 /* Header include. */
 #include "fleet_provisioning_serializer.h"
+
+/*-----------------------------------------------------------*/
+
+/**
+ * @brief Context passed to tinyCBOR for #cborPrinter. Initial
+ * state should be zeroed.
+ */
+typedef struct
+{
+    const char * str;
+    size_t length;
+} CborPrintContext_t;
+
+/*-----------------------------------------------------------*/
+
+/**
+ * @brief Printing function to pass to tinyCBOR.
+ *
+ * cbor_value_to_pretty_stream calls it multiple times to print a textual CBOR
+ * representation.
+ *
+ * @param token Context for the function.
+ * @param fmt Printf style format string.
+ * @param ... Printf style args after format string.
+ */
+static CborError cborPrinter( void * token,
+                              const char * fmt,
+                              ... );
+
 /*-----------------------------------------------------------*/
 
 bool generateCsrRequest( uint8_t * pBuffer,
@@ -372,3 +404,82 @@ bool parseRegisterThingResponse( const uint8_t * pResponse,
     return( cborRet == CborNoError );
 }
 /*-----------------------------------------------------------*/
+
+static CborError cborPrinter( void * token,
+                              const char * fmt,
+                              ... )
+{
+    int result;
+    va_list args;
+    CborPrintContext_t * ctx = ( CborPrintContext_t * ) token;
+
+    va_start( args, fmt );
+
+    /* Compute length to write. */
+    result = vsnprintf( NULL, 0, fmt, args );
+
+    va_end( args );
+
+    if( result < 0 )
+    {
+        LogError( ( "Error formatting CBOR string." ) );
+    }
+    else
+    {
+        size_t newLen = ( unsigned ) result;
+        size_t oldLen = ctx->length;
+        char * newPtr;
+
+        ctx->length = oldLen + newLen;
+        newPtr = ( char * ) realloc( ( void * ) ctx->str, ctx->length + 1 );
+
+        if( newPtr == NULL )
+        {
+            LogError( ( "Failed to reallocate CBOR string." ) );
+            result = -1;
+        }
+        else
+        {
+            va_start( args, fmt );
+
+            result = vsnprintf( newPtr + oldLen, newLen + 1, fmt, args );
+
+            va_end( args );
+
+            ctx->str = newPtr;
+
+            if( result < 0 )
+            {
+                LogError( ( "Error printing CBOR string." ) );
+            }
+        }
+    }
+
+    return ( result < 0 ) ? CborErrorIO : CborNoError;
+}
+/*-----------------------------------------------------------*/
+
+const char * getStringFromCbor( const uint8_t * cbor,
+                                size_t length )
+{
+    CborPrintContext_t printCtx = { 0 };
+    CborParser parser;
+    CborValue value;
+    CborError error;
+
+    error = cbor_parser_init( cbor, length, 0, &parser, &value );
+
+    if( error == CborNoError )
+    {
+        error = cbor_value_to_pretty_stream( cborPrinter, &printCtx, &value, CborPrettyDefaultFlags );
+    }
+
+    if( error != CborNoError )
+    {
+        LogError( ( "Error printing CBOR payload." ) );
+        printCtx.str = "";
+    }
+
+    return printCtx.str;
+}
+/*-----------------------------------------------------------*/

demos/fleet_provisioning/fleet_provisioning_with_csr/fleet_provisioning_serializer.h

@@ -110,3 +110,14 @@ bool parseRegisterThingResponse( const uint8_t * pResponse,
                                  size_t length,
                                  char * pThingNameBuffer,
                                  size_t * pThingNameBufferLength );
+
+/**
+ * @brief Converts a CBOR document into a pretty printed string.
+ *
+ * @param[in] cbor The CBOR document.
+ * @param[in] length The length of the CBOR document.
+ *
+ * @returns The pretty printed string on success. "" on error.
+ */
+const char * getStringFromCbor( const uint8_t * cbor,
+                                size_t length );

demos/fleet_provisioning/fleet_provisioning_with_csr/fleet_provisioning_with_csr_demo.c

@@ -50,6 +50,7 @@
 
 /* Standard includes. */
 #include <stdlib.h>
+#include <stdio.h>
 #include <stdint.h>
 #include <stdbool.h>
 
@@ -60,9 +61,6 @@
 /* Demo config. */
 #include "demo_config.h"
 
-/* TinyCBOR library for CBOR encoding and decoding operations. */
-#include "cbor.h"
-
 /* corePKCS11 includes. */
 #include "core_pkcs11.h"
 #include "core_pkcs11_config.h"
@@ -233,6 +231,7 @@ static void provisioningPublishCallback( MQTTPublishInfo_t * pPublishInfo,
 {
     FleetProvisioningStatus_t status;
     FleetProvisioningTopic_t api;
+    const char * cborDump;
 
     /* Silence compiler warnings about unused variables. */
     ( void ) packetIdentifier;
@@ -252,6 +251,10 @@ static void provisioningPublishCallback( MQTTPublishInfo_t * pPublishInfo,
         {
             LogInfo( ( "Received accepted response from Fleet Provisioning CreateCertificateFromCsr API." ) );
 
+            cborDump = getStringFromCbor( ( const uint8_t * ) pPublishInfo->pPayload, pPublishInfo->payloadLength );
+            LogDebug( ( "Payload: %s", cborDump ) );
+            free( ( void * ) cborDump );
+
             responseStatus = ResponseAccepted;
 
             /* Copy the payload from the MQTT library's buffer to #payloadBuffer. */
@@ -265,12 +268,20 @@ static void provisioningPublishCallback( MQTTPublishInfo_t * pPublishInfo,
         {
             LogError( ( "Received rejected response from Fleet Provisioning CreateCertificateFromCsr API." ) );
 
+            cborDump = getStringFromCbor( ( const uint8_t * ) pPublishInfo->pPayload, pPublishInfo->payloadLength );
+            LogError( ( "Payload: %s", cborDump ) );
+            free( ( void * ) cborDump );
+
             responseStatus = ResponseRejected;
         }
         else if( api == FleetProvCborRegisterThingAccepted )
         {
             LogInfo( ( "Received accepted response from Fleet Provisioning RegisterThing API." ) );
 
+            cborDump = getStringFromCbor( ( const uint8_t * ) pPublishInfo->pPayload, pPublishInfo->payloadLength );
+            LogDebug( ( "Payload: %s", cborDump ) );
+            free( ( void * ) cborDump );
+
             responseStatus = ResponseAccepted;
 
             /* Copy the payload from the MQTT library's buffer to #payloadBuffer. */
@@ -284,6 +295,10 @@ static void provisioningPublishCallback( MQTTPublishInfo_t * pPublishInfo,
         {
             LogError( ( "Received rejected response from Fleet Provisioning RegisterThing API." ) );
 
+            cborDump = getStringFromCbor( ( const uint8_t * ) pPublishInfo->pPayload, pPublishInfo->payloadLength );
+            LogError( ( "Payload: %s", cborDump ) );
+            free( ( void * ) cborDump );
+
             responseStatus = ResponseRejected;
         }
         else

demos/lexicon.txt

@@ -1,4 +1,5 @@
 accel
+fmt
 accesskeyid
 ack
 acks
@@ -67,6 +68,7 @@ cas
 cb
 cbc
 cbor
+cborprinter
 ccm
 ccs
 cdn