Skip to content

Commit

Permalink
[#77]Working Save and Load - TODO: Validate Unit tests
Browse files Browse the repository at this point in the history
  • Loading branch information
@rjbrown6
rjbrown6 committed Apr 25, 2024
1 parent 58f82ff commit 3bab2d3
Show file tree
Hide file tree
Showing 5 changed files with 173 additions and 13 deletions.
5 changes: 5 additions & 0 deletions CMakeLists.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ option(SUPPORT "Support" OFF)
option(SYSTEM_INSTALL "SystemInstall" OFF)
option(TEST "Test" OFF)
option(TEST_ENC "Tests - Encryption" OFF)
option(SA_FILE "Save Security Association to File" OFF)

OPTION(KMC_MDB_RH "KMC-MDB-RedHat-Integration-Testing" OFF) #Disabled by default, enable with: -DKMC_MDB_RH=ON
OPTION(KMC_MDB_DB "KMC-MDB-Debian-Integration-Testing" OFF) #Disabled by default, enable with: -DKMC_MDB_DB=ON
Expand All @@ -53,6 +54,10 @@ if(CODECOV)
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fprofile-arcs -ftest-coverage")
endif()

if(SA_FILE)
add_definitions(-DSA_FILE)
endif()

if(DEBUG)
add_definitions(-DDEBUG -DOCF_DEBUG -DFECF_DEBUG -DSA_DEBUG -DPDU_DEBUG -DCCSDS_DEBUG -DTC_DEBUG -DMAC_DEBUG -DTM_DEBUG -DAOS_DEBUG)
add_compile_options(-ggdb)
Expand Down
2 changes: 2 additions & 0 deletions include/crypto_error.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,8 @@
#define CRYPTO_LIB_ERR_INPUT_FRAME_TOO_SHORT_FOR_AOS_STANDARD (-49)
#define CRYPTO_LIB_ERR_TC_ENUM_USED_FOR_AOS_CONFIG (-50)
#define CRYPTO_LIB_ERR_INVALID_SA_SERVICE_TYPE (-51)
#define CRYPTO_LIB_ERR_FAIL_SA_SAVE (-52)
#define CRYPTO_LIB_ERR_FAIL_SA_LOAD (-53)

extern char *crypto_enum_errlist_core[];
extern char *crypto_enum_errlist_config[];
Expand Down
2 changes: 2 additions & 0 deletions src/core/crypto_error.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@ char *crypto_enum_errlist_core[] =
(char*) "CRYPTO_LIB_ERR_INPUT_FRAME_TOO_SHORT_FOR_AOS_STANDARD",
(char*) "CRYPTO_LIB_ERR_TC_ENUM_USED_FOR_AOS_CONFIG",
(char*) "CRYPTO_LIB_ERR_INVALID_SA_SERVICE_TYPE",
(char*) "CRYPTO_LIB_ERR_FAIL_SA_SAVE",
(char*) "CRYPTO_LIB_ERR_FAIL_SA_LOAD",
};

char *crypto_enum_errlist_config[] =
Expand Down
175 changes: 163 additions & 12 deletions src/sa/internal/sa_interface_inmemory.template.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
*/

#include "crypto.h"
#include <stdio.h>
#include <stdlib.h>

// Security Association Initialization Functions
static int32_t sa_config(void);
Expand Down Expand Up @@ -64,17 +66,74 @@ SaInterface get_sa_interface_inmemory(void)
return &sa_if_struct;
}

/**
* @brief Function; sa_config
* @return int32: Success/Failure
**/
int32_t sa_config(void)
int32_t sa_load_file()
{
FILE *sa_save_file;
int32_t status = CRYPTO_LIB_SUCCESS;
int success_flag = 0;

sa_save_file = fopen("sa_save_file.bin", "rb+"); // Should this be rb instead of wb+

if (sa_save_file == NULL)
{
printf("Unable to open sa_save_file!\n");
status = CRYPTO_LIB_ERR_FAIL_SA_LOAD;
}
else{
printf("Opened sa_save_file successfully!\n");
}
if( status == CRYPTO_LIB_SUCCESS)
{
//sa[0].spi = 999;
//sa[1].spi = 888;
printf("TEST: SA: SPI0: %d\n", sa[0].spi);
printf("TEST: SA: SPI1: %d\n", sa[1].spi);
printf("TEST: SA: SPI2: %d\n", sa[2].spi);
printf("TEST: SA: SPI3: %d\n", sa[3].spi);
printf("TEST: SA: SPI17: %d\n", sa[17].spi);
success_flag = fread(sa, SA_SIZE, NUM_SA, sa_save_file);
printf("TEST: SA: SPI0: %d\n", sa[0].spi);
printf("TEST: SA: SPI1: %d\n", sa[1].spi);
printf("TEST: SA: SPI2: %d\n", sa[2].spi);
printf("TEST: SA: SPI3: %d\n", sa[3].spi);
printf("TEST: SA: SPI17: %d\n", sa[17].spi);
if(success_flag)
{
status = CRYPTO_LIB_SUCCESS;
//#ifdef SA_DEBUG
printf("SA Load Successfull!\n");
//#endif
}
else
{
printf("Status Flag: %d\n", success_flag);
status = CRYPTO_LIB_ERR_FAIL_SA_LOAD;
//#ifdef SA_DEBUG
printf("SA Load Failure!\n");
//#endif
}
}

if(sa_save_file != NULL) fclose(sa_save_file);
return status;
}

void sa_populate(void)
{
sa[0].spi = 0;
sa[0].sa_state = SA_OPERATIONAL;
sa[0].est = 0;
sa[0].ast = 0;
sa[0].shivf_len = 0;
sa[0].shsnf_len = 2;
sa[0].arsn_len = 2;
sa[0].arsnw_len = 1;
sa[0].arsnw = 5;
sa[0].gvcid_blk.tfvn = 0;
sa[0].gvcid_blk.scid = SCID & 0x3FF;
sa[0].gvcid_blk.vcid = 0;
sa[0].gvcid_blk.mapid = TYPE_TC;

// Security Associations
// SA 1 - CLEAR MODE
// SA 1 VC0/1 is now SA 1-VC0, SA 8-VC1
sa[1].spi = 1;
sa[1].sa_state = SA_OPERATIONAL;
sa[1].est = 0;
Expand Down Expand Up @@ -247,7 +306,7 @@ int32_t sa_config(void)
sa[10].gvcid_blk.vcid = 1;
sa[10].gvcid_blk.mapid = TYPE_TC;
sa[10].ek_ref = (char*) "kmc/test/key130";

// SA 11 - KEYED; ARSNW:5; AES-GCM; IV:00...00; IV-len:12; MAC-len:16; Key-ID: 130
// SA 11 VC0/1 is now 4-VC0, 7-VC1
sa[11].spi = 11;
Expand Down Expand Up @@ -375,7 +434,41 @@ int32_t sa_config(void)
sa[17].gvcid_blk.tfvn = 0x01;
sa[17].gvcid_blk.scid = SCID & 0x3FF;
sa[17].gvcid_blk.vcid = 0;
}


/**
* @brief Function; sa_config
* @return int32: Success/Failure
**/
int32_t sa_config(void)
{
int32_t status = CRYPTO_LIB_SUCCESS;
int use_internal = 1;

#ifdef SA_FILE
use_internal = 0;
status = sa_load_file();
if (status != CRYPTO_LIB_SUCCESS) //Do we error out here, or is it ok to do as below and populate with internal on failure.
{
#ifdef DEBUG
printf("SA Load Failure!\n");
printf("Falling back to in-memory SA!\n");
sa_populate();
status = CRYPTO_LIB_SUCCESS;
#endif
}
#endif

if(use_internal)
{
sa_populate();
}


// Security Associations
// SA 1 - CLEAR MODE
// SA 1 VC0/1 is now SA 1-VC0, SA 8-VC1
return status;
}

Expand Down Expand Up @@ -677,17 +770,75 @@ static int32_t sa_get_operational_sa_from_gvcid(uint8_t tfvn, uint16_t scid, uin
return status;
}

// TODO: Nothing actually happens here

int32_t sa_perform_save(SecurityAssociation_t* sa)
{
int32_t status = CRYPTO_LIB_SUCCESS;
FILE* sa_save_file;
int success_flag = 0;
//SecurityAssociation_t sa_temp[NUM_SA];

// sa_temp[1].spi = 5;
// memcpy(sa_temp, sa, sizeof(*sa));

// printf("*******************TEST: SA2: %d\n", sa_temp[1].spi);

sa_save_file = fopen("sa_save_file.bin", "wb");

if (sa_save_file == NULL)
{
status = CRYPTO_LIB_ERR_FAIL_SA_SAVE;
}

if(status == CRYPTO_LIB_SUCCESS)
{
success_flag = fwrite(sa, SA_SIZE, NUM_SA, sa_save_file);

if(success_flag)
{
status = CRYPTO_LIB_SUCCESS;

//#ifdef DEBUG
printf("SA Written Successfull to file!\n");
//#endif


}
else
{
status = CRYPTO_LIB_ERR_FAIL_SA_SAVE;
//#ifdef DEBUG
printf("ERROR: SA Write FAILED!\n");
//#endif
}
}
fclose(sa_save_file);

return status;
}

/**
* @brief Function: sa_save_sa
* @param sa: SecurityAssociation_t*
* @return int32: Success/Failure
* @note Nothing currently actually happens in this function
**/
static int32_t sa_save_sa(SecurityAssociation_t* sa)
{
// if locked - wait.
// else get lock - lock, and do the below
// if immediate: always do TC_SH_SIZE
// if deferred: counter > X ? Reset Counter, perform save.
// size_t fwrite(variable, sizeof(variable), num elements, outfile);
// size_t fread(variable, sizeof(variable), num elements, infile)
int32_t status = CRYPTO_LIB_SUCCESS;
sa = sa; // TODO - use argument
int ignore_save = 1;

#ifdef SA_FILE
status = sa_perform_save(sa);
ignore_save = 0;
#endif
if (ignore_save) sa = sa; // TODO - use argument

// We could do a memory copy of the SA into the sa[NUM_SA] array at the given SPI, however, the inmemory code
// currently updates in place so no need for that.
// If we change the in-place update logic, we should update this function to actually update the SA.
Expand Down
2 changes: 1 addition & 1 deletion support/scripts/build_internal.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@
SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
source $SCRIPT_DIR/env.sh

cmake $BASE_DIR -DCODECOV=1 -DDEBUG=1 -DMC_INTERNAL=1 -DTEST=1 -DTEST_ENC=1 && make && make test
cmake $BASE_DIR -DCODECOV=1 -DDEBUG=1 -DMC_INTERNAL=1 -DTEST=1 -DTEST_ENC=1 -DSA_FILE=1 && make && make test

0 comments on commit 3bab2d3

Please sign in to comment.