Ota/fix sudo issue

platform/posix/ota_pal/source/include/ota_pal_posix.h

@@ -28,13 +28,22 @@
 
 #include "ota.h"
 
-
-
 /**
  * @brief Maximum file path length on Linux
  */
 #define OTA_FILE_PATH_LENGTH_MAX    512
 
+/**
+ * @brief The OTA platform interface status for generating
+ * absolute file path from the incoming relative file path.
+ */
+typedef enum OtaPalPathGenStatus
+{
+    OtaPalFileGenSuccess,    /*!< @brief Absolute path generation success. */
+    OtaPalCWDFailed,         /*!< @brief getcwd failed to output path. */
+    OtaPalBufferInsufficient /*!< @brief Buffer insufficient for storing the file path. */
+} OtaPalPathGenStatus_t;
+
 /**
  * @brief Abort an OTA transfer.
  *

platform/posix/ota_pal/source/ota_pal_posix.c

@@ -95,8 +95,8 @@ static OtaPalStatus_t otaPal_CheckFileSignature( OtaFileContext_t * const C );
  * @param realFilePath Buffer to store the file path + file name.
  * @param pFilePath File name to append to the end of current path.
  */
-static void getFilePathFromCWD( char * realFilePath,
-                                const char * pFilePath );
+static OtaPalPathGenStatus_t getFilePathFromCWD( char * realFilePath,
+                                                 const char * pFilePath );
 
 /*-----------------------------------------------------------*/
 
@@ -332,31 +332,36 @@ static OtaPalStatus_t otaPal_CheckFileSignature( OtaFileContext_t * const C )
     return OTA_PAL_COMBINE_ERR( mainErr, 0 );
 }
 
-static void getFilePathFromCWD( char * pCompleteFilePath,
-                                const char * pFileName )
+static OtaPalPathGenStatus_t getFilePathFromCWD( char * pCompleteFilePath,
+                                                 const char * pFileName )
 {
     char * pCurrentDir = NULL;
+    OtaPalPathGenStatus_t status = OtaPalFileGenSuccess;
 
     /* Get current directory. */
     pCurrentDir = getcwd( pCompleteFilePath, OTA_FILE_PATH_LENGTH_MAX - 1 );
 
     if( pCurrentDir == NULL )
     {
         LogError( ( "Failed to get current working directory: %s", strerror( errno ) ) );
+        status = OtaPalCWDFailed;
     }
     else
     {
         /* Add the filename . */
         if( strlen( pCompleteFilePath ) + strlen( pFileName ) + 2U > OTA_FILE_PATH_LENGTH_MAX )
         {
             LogError( ( "Insufficient space to generate file path" ) );
+            status = OtaPalBufferInsufficient;
         }
         else
         {
-            pCompleteFilePath[ strlen( pCompleteFilePath ) ] = '/';
-            strncat( pCompleteFilePath, pFileName, strlen( pFileName ) + 1U );
+            strcat( pCompleteFilePath, "/" );
+            strncat( pCompleteFilePath, pFileName, strlen( pFileName ) );
         }
     }
+
+    return status;
 }
 
 /*-----------------------------------------------------------*/
@@ -409,21 +414,26 @@ OtaPalStatus_t otaPal_CreateFileForRx( OtaFileContext_t * const C )
 {
     OtaPalStatus_t result = OTA_PAL_COMBINE_ERR( OtaPalUninitialized, 0 );
     char realFilePath[ OTA_FILE_PATH_LENGTH_MAX ];
-
+    OtaPalPathGenStatus_t status = OtaPalFileGenSuccess;
 
     if( C != NULL )
     {
         if( C->pFilePath != NULL )
         {
             if( C->pFilePath[ 0 ] != ( uint8_t ) '/' )
             {
-                getFilePathFromCWD( realFilePath, ( const char * ) C->pFilePath );
+                status = getFilePathFromCWD( realFilePath, ( const char * ) C->pFilePath );
             }
             else
             {
                 ( void ) strncpy( realFilePath, ( const char * ) C->pFilePath, strlen( ( const char * ) C->pFilePath ) + 1U );
             }
 
+            if( status != OtaPalFileGenSuccess )
+            {
+                LogError( ( "Could not generate the absolute path for the file" ) );
+            }
+
             /* POSIX port using standard library */
             /* coverity[misra_c_2012_rule_21_6_violation] */
             C->pFile = fopen( ( const char * ) realFilePath, "w+b" );
@@ -578,6 +588,7 @@ OtaPalStatus_t otaPal_SetPlatformImageState( OtaFileContext_t * const C,
                                              OtaImageState_t eState )
 {
     OtaPalMainStatus_t mainErr = OtaPalBadImageState;
+    OtaPalPathGenStatus_t status = OtaPalFileGenSuccess;
     int32_t subErr = 0;
     FILE * pPlatformImageState = NULL;
     char imageStateFile[ OTA_FILE_PATH_LENGTH_MAX ] = { 0 };
@@ -587,7 +598,12 @@ OtaPalStatus_t otaPal_SetPlatformImageState( OtaFileContext_t * const C,
     if( ( eState != OtaImageStateUnknown ) && ( eState <= OtaLastImageState ) )
     {
         /* Get file path for the image state file. */
-        getFilePathFromCWD( imageStateFile, OTA_PLATFORM_IMAGE_STATE_FILE );
+        status = getFilePathFromCWD( imageStateFile, OTA_PLATFORM_IMAGE_STATE_FILE );
+
+        if( status != OtaPalFileGenSuccess )
+        {
+            LogError( ( "Could not generate the absolute path for the file" ) );
+        }
 
         /* POSIX port using standard library */
         /* coverity[misra_c_2012_rule_21_6_violation] */
@@ -664,12 +680,18 @@ OtaPalImageState_t otaPal_GetPlatformImageState( OtaFileContext_t * const C )
     FILE * pPlatformImageState = NULL;
     OtaImageState_t eSavedAgentState = OtaImageStateUnknown;
     OtaPalImageState_t ePalState = OtaPalImageStateUnknown;
+    OtaPalPathGenStatus_t status = OtaPalFileGenSuccess;
     char imageStateFile[ OTA_FILE_PATH_LENGTH_MAX ] = { 0 };
 
     ( void ) C;
 
     /* Get file path for the image state file. */
-    getFilePathFromCWD( imageStateFile, OTA_PLATFORM_IMAGE_STATE_FILE );
+    status = getFilePathFromCWD( imageStateFile, OTA_PLATFORM_IMAGE_STATE_FILE );
+
+    if( status != OtaPalFileGenSuccess )
+    {
+        LogError( ( "Could not generate the absolute path for the file" ) );
+    }
 
     /* POSIX port using standard library */
     /* coverity[misra_c_2012_rule_21_6_violation] */

platform/posix/ota_pal/utest/ota_pal_posix_utest.c

@@ -505,6 +505,34 @@ void test_OTAPAL_CreateFileForRx_PathTypes( void )
     TEST_ASSERT_EQUAL( OtaPalSuccess, result );
 }
 
+/**
+ * @brief Test that otaPal_CreateFileForRx will correctly handle a file path
+ * that is too long.
+ */
+void test_OTAPAL_CreateFileForRx_InvalidPathLength( void )
+{
+    OtaPalMainStatus_t result;
+    FILE placeholder_file;
+    OtaFileContext_t otaFileContext;
+    const size_t invalidLength = OTA_FILE_PATH_LENGTH_MAX + 1U;
+    char invalidLengthPath[ invalidLength ];
+    size_t i;
+
+    /* Test calling getcwd and having it return a path that is too long. */
+    for( i = 0U; i < ( invalidLength - 1U ); ++i )
+    {
+        invalidLengthPath[ i ] = 'x';
+    }
+
+    invalidLengthPath[ invalidLength - 1U ] = '\0';
+    otaFileContext.pFilePath = ( uint8_t * ) "placeholder_path";
+    getcwd_ExpectAnyArgsAndReturn( "placeholder_return" );
+    getcwd_ReturnArrayThruPtr_buf( invalidLengthPath, invalidLength );
+    fopen_ExpectAnyArgsAndReturn( &placeholder_file );
+    result = OTA_PAL_MAIN_ERR( otaPal_CreateFileForRx( &otaFileContext ) );
+    TEST_ASSERT_EQUAL( OtaPalSuccess, result );
+}
+
 /**
  * @brief Test that otaPal_CreateFileForRx will return correct result code.
  */
@@ -1153,5 +1181,5 @@ void test_OTAPAL_GetPlatformImageState_getcwd_fail( void )
     OTA_PAL_FailSingleMock_unistd( getcwd_fn );
     OTA_PAL_FailSingleMock_stdio( none_fn, NULL );
     ePalImageState = otaPal_GetPlatformImageState( &otaFileContext );
-    TEST_ASSERT_EQUAL( OtaPalImageStateValid, ePalImageState );
+    TEST_ASSERT_EQUAL( OtaPalImageStateInvalid, ePalImageState );
 }