Merge commit from fork

Base64 decode buffer length checking

Author: Donnie-Ice

include/crypto_error.h

@@ -58,6 +58,7 @@
 #define CRYPTOGRAHPY_KMC_CRYPTO_SERVICE_EMPTY_RESPONSE             513
 #define CRYPTOGRAHPY_KMC_CRYPTO_SERVICE_DECRYPT_ERROR              514
 #define CRYPTOGRAHPY_KMC_CRYPTO_SERVICE_ENCRYPT_ERROR              515
+#define CRYPTOGRAHPY_KMC_BASE64_DECRYPT_ERROR                      516
 
 #define CAM_CONFIG_NOT_SUPPORTED_ERROR                      600
 #define CAM_INVALID_COOKIE_FILE_CONFIGURATION_NULL          601
@@ -165,7 +166,7 @@
 #define CAM_ERROR_CODES_MAX 610
 
 #define KMC_ERROR_CODES     500
-#define KMC_ERROR_CODES_MAX 515
+#define KMC_ERROR_CODES_MAX 516
 
 #define CRYPTO_INTERFACE_ERROR_CODES     400
 #define CRYPTO_INTERFACE_ERROR_CODES_MAX 402

src/core/crypto_error.c

@@ -155,6 +155,7 @@ char *crypto_enum_errlist_crypto_kmc[] = {
     (char *)"CRYPTOGRAHPY_KMC_CRYPTO_SERVICE_EMPTY_RESPONSE",
     (char *)"CRYPTOGRAHPY_KMC_CRYPTO_SERVICE_DECRYPT_ERROR",
     (char *)"CRYPTOGRAHPY_KMC_CRYPTO_SERVICE_ENCRYPT_ERROR",
+    (char *)"CRYPTOGRAHPY_KMC_BASE64_DECRYPT_ERROR",
 };
 
 char *crypto_enum_errlist_crypto_cam[] = {

src/crypto/kmc/base64.c

@@ -174,7 +174,7 @@ void base64Encode(const void *input, size_t inputLen, char_t *output, size_t *ou
  * @return Error code
  **/
 
-int32_t base64Decode(const char_t *input, size_t inputLen, void *output, size_t *outputLen)
+int32_t base64Decode(const char_t *input, size_t inputLen, void *output, uint16_t decoded_buffer_size, size_t *outputLen)
 {
     int32_t  error;
     uint32_t value;
@@ -194,6 +194,18 @@ int32_t base64Decode(const char_t *input, size_t inputLen, void *output, size_t
     // Initialize status code
     error = NO_ERROR;
 
+    // Check expected output buffer size is large enough for decoded input
+    uint16_t outputLen_expected = 0;
+    uint8_t padding = 0;
+    if (inputLen >= 1 && input[inputLen-1] == '=')
+        padding++;
+    if (inputLen >= 2 && input[inputLen-2] == '=')
+        padding++;
+    outputLen_expected = ((inputLen * 3) / 4) - padding;
+
+    if (decoded_buffer_size < outputLen_expected)
+        return ERROR_INVALID_LENGTH;
+
     // Point to the buffer where to write the decoded data
     p = (uint8_t *)output;
 

src/crypto/kmc/base64.h

@@ -47,7 +47,7 @@ extern "C"
     // Base64 encoding related functions
     void base64Encode(const void *input, size_t inputLen, char_t *output, size_t *outputLen);
 
-    int32_t base64Decode(const char_t *input, size_t inputLen, void *output, size_t *outputLen);
+    int32_t base64Decode(const char_t *input, size_t inputLen, void *output, uint16_t decoded_buffer_size, size_t *outputLen);
 
 #define ERROR_INVALID_PARAMETER 21
 #define ERROR_INVALID_LENGTH    22

src/crypto/kmc/cryptography_interface_kmc_crypto_service.template.c

@@ -479,9 +479,15 @@ static int32_t cryptography_encrypt(uint8_t *data_out, size_t len_data_out, uint
 
     /* JSON Response Handling End */
 
-    uint8_t *ciphertext_decoded     = malloc((len_data_out)*2 + 1);
+    uint16_t decoded_buffer_size = (len_data_out)*2 + 1;
+    uint8_t *ciphertext_decoded     = malloc(decoded_buffer_size);
     size_t   ciphertext_decoded_len = 0;
-    base64Decode(ciphertext_base64, strlen(ciphertext_base64), ciphertext_decoded, &ciphertext_decoded_len);
+    if (base64Decode(ciphertext_base64, strlen(ciphertext_base64), ciphertext_decoded, decoded_buffer_size, &ciphertext_decoded_len) != 0)
+    {
+        free(chunk_write);
+        free(ciphertext_decoded);
+        return CRYPTOGRAHPY_KMC_BASE64_DECRYPT_ERROR;
+    }
 #ifdef DEBUG
     printf("Decoded Cipher Text Length: %ld\n", ciphertext_decoded_len);
     printf("Decoded Cipher Text: \n");
@@ -685,9 +691,15 @@ static int32_t cryptography_decrypt(uint8_t *data_out, size_t len_data_out, uint
 
     /* JSON Response Handling End */
 
-    uint8_t *cleartext_decoded     = malloc((len_data_out)*2 + 1);
+    uint16_t decoded_buffer_size = (len_data_out)*2 + 1;
+    uint8_t *cleartext_decoded     = malloc(decoded_buffer_size);
     size_t   cleartext_decoded_len = 0;
-    base64Decode(cleartext_base64, strlen(cleartext_base64), cleartext_decoded, &cleartext_decoded_len);
+    if (base64Decode(cleartext_base64, strlen(cleartext_base64), cleartext_decoded, decoded_buffer_size, &cleartext_decoded_len) != 0)
+    {
+        free(chunk_write);
+        free(cleartext_decoded);
+        return CRYPTOGRAHPY_KMC_BASE64_DECRYPT_ERROR;
+    }
 #ifdef DEBUG
     printf("Decoded Cipher Text Length: %ld\n", cleartext_decoded_len);
     printf("Decoded Cipher Text: \n");
@@ -1528,9 +1540,15 @@ static int32_t cryptography_aead_encrypt(uint8_t *data_out, size_t len_data_out,
 
     /* JSON Response Handling End */
 
+    uint16_t decoded_buffer_size = (len_data_out + mac_size + aad_len) * 2 + 1;
     uint8_t *ciphertext_decoded     = malloc((len_data_out + mac_size + aad_len) * 2 + 1);
     size_t   ciphertext_decoded_len = 0;
-    base64Decode(ciphertext_base64, strlen(ciphertext_base64), ciphertext_decoded, &ciphertext_decoded_len);
+    if (base64Decode(ciphertext_base64, strlen(ciphertext_base64), ciphertext_decoded, decoded_buffer_size,  &ciphertext_decoded_len) != 0)
+    {
+        free(chunk_write);
+        free(ciphertext_base64);
+        return CRYPTOGRAHPY_KMC_BASE64_DECRYPT_ERROR;
+    }
 #ifdef DEBUG
     printf("Mac size: %d\n", mac_size);
     printf("Decoded Cipher Text Length: %ld\n", ciphertext_decoded_len);
@@ -1836,9 +1854,15 @@ static int32_t cryptography_aead_decrypt(uint8_t *data_out, size_t len_data_out,
 
     /* JSON Response Handling End */
 
+    uint16_t decoded_buffer_size = (len_data_out + mac_size + aad_len) * 2 + 1;
     uint8_t *cleartext_decoded     = malloc((len_data_out + mac_size + aad_len) * 2 + 1);
     size_t   cleartext_decoded_len = 0;
-    base64Decode(cleartext_base64, strlen(cleartext_base64), cleartext_decoded, &cleartext_decoded_len);
+    if (base64Decode(cleartext_base64, strlen(cleartext_base64), cleartext_decoded, decoded_buffer_size, &cleartext_decoded_len) != 0)
+    {
+        free(chunk_write);
+        free(cleartext_base64);
+        return CRYPTOGRAHPY_KMC_BASE64_DECRYPT_ERROR;
+    }
 #ifdef DEBUG
     printf("Decoded Cipher Text Length: %ld\n", cleartext_decoded_len);
     printf("Decoded Cipher Text: \n");

test/CMakeLists.txt

@@ -106,6 +106,10 @@ if((KMC_MDB_DB OR KMC_MDB_RH))
     add_test(NAME UT_MARIADB
              COMMAND ${PROJECT_BINARY_DIR}/bin/ut_mariadb
              WORKING_DIRECTORY ${PROJECT_TEST_DIR})
+
+    add_test(NAME UT_B64
+             COMMAND ${PROJECT_BINARY_DIR}/bin/ut_b64
+             WORKING_DIRECTORY ${PROJECT_TEST_DIR})
 
     add_test(NAME UT_KMC_CRYPTO
              COMMAND ${PROJECT_BINARY_DIR}/bin/ut_kmc_crypto

test/include/ut_b64.h

@@ -0,0 +1,34 @@
+/* Copyright (C) 2009 - 2022 National Aeronautics and Space Administration.
+   All Foreign Rights are Reserved to the U.S. Government.
+
+   This software is provided "as is" without any warranty of any kind, either expressed, implied, or statutory,
+   including, but not limited to, any warranty that the software will conform to specifications, any implied warranties
+   of merchantability, fitness for a particular purpose, and freedom from infringement, and any warranty that the
+   documentation will conform to the program, or any warranty that the software will be error free.
+
+   In no event shall NASA be liable for any damages, including, but not limited to direct, indirect, special or
+   consequential damages, arising out of, resulting from, or in any way connected with the software or its
+   documentation, whether or not based upon warranty, contract, tort or otherwise, and whether or not loss was sustained
+   from, or arose out of the results of, or use of, the software, documentation or services provided hereunder.
+
+   ITC Team
+   NASA IV&V
+   jstar-development-team@mail.nasa.gov
+*/
+
+#ifndef CRYPTOLIB_UT_B64_H
+#define CRYPTOLIB_UT_B64_H
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+#include "crypto.h"
+#include <stdio.h>
+
+#ifdef __cplusplus
+} /* Close scope of 'extern "C"' declaration which encloses file. */
+#endif
+
+#endif // CRYPTOLIB_UT_B64_H