Skip to content

Commit

Permalink
logger: fix file open issue if crypto algorithm is disabled
Browse files Browse the repository at this point in the history
move init_logfile_encryption() call after the buffer start_log() call
to have log file already open while storing the header and key data to
the beginning of the file.
  • Loading branch information
jnippula committed Jan 3, 2025
1 parent 326d486 commit dfd8f2c
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 26 deletions.
43 changes: 18 additions & 25 deletions src/modules/logger/log_writer_file.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ LogWriterFile::~LogWriterFile()
}

#if defined(PX4_CRYPTO)
bool LogWriterFile::init_logfile_encryption(const char *filename)
bool LogWriterFile::init_logfile_encryption(const LogType type)
{
if (_algorithm == CRYPTO_NONE) {
_min_blocksize = 1;
Expand Down Expand Up @@ -151,16 +151,16 @@ bool LogWriterFile::init_logfile_encryption(const char *filename)

rsa_crypto.close();

// Write the encrypted key to the disk
int key_fd = ::open((const char *)filename, O_CREAT | O_WRONLY | O_DIRECT | O_SYNC, PX4_O_MODE_666);
// Write the encrypted key to the beginning of the opened log file
int key_fd = _buffers[(int)type].fd();

if (key_fd < 0) {
PX4_ERR("Can't open key file, errno: %d", errno);
PX4_ERR("Log file not open for storing the key, errno: %d", errno);
free(key);
return false;
}

// write the header to the combined key exchange & cipherdata file
// write header and key to the beginning of the log file
struct ulog_key_header_s keyfile_header = {
.magic = {'U', 'L', 'o', 'g', 'E', 'n', 'c'},
.hdr_ver = 1,
Expand All @@ -171,20 +171,14 @@ bool LogWriterFile::init_logfile_encryption(const char *filename)
.initdata_size = (uint16_t)nonce_size
};

size_t hdr_sz = ::write(key_fd, (uint8_t *)&keyfile_header, sizeof(keyfile_header));
size_t written = 0;

if (hdr_sz == sizeof(keyfile_header)) {
// Header write succeeded, write the key
written = ::write(key_fd, key, key_size + nonce_size);
}
size_t written = ::write(key_fd, (uint8_t *)&keyfile_header, sizeof(keyfile_header));
written += ::write(key_fd, key, key_size + nonce_size);

// Free temporary memory allocations
free(key);
::close(key_fd);

// Check that writing to the disk succeeded
if (written != key_size + nonce_size) {
if (written != sizeof(keyfile_header) + key_size + nonce_size) {
PX4_ERR("Writing the encryption key to disk fail");
return false;
}
Expand Down Expand Up @@ -220,18 +214,21 @@ bool LogWriterFile::start_log(LogType type, const char *filename)
}
}

if (_buffers[(int)type].start_log(filename)) {

#if PX4_CRYPTO
bool enc_init = init_logfile_encryption(filename);
bool enc_init = init_logfile_encryption(type);

if (!enc_init) {
PX4_ERR("Failed to start encrypted logging");
_crypto.close();
return false;
}
if (!enc_init) {
PX4_ERR("Failed to start encrypted logging");
_crypto.close();
_buffers[(int)type]._should_run = false;
_buffers[(int)type].close_file();
return false;
}

#endif

if (_buffers[(int)type].start_log(filename)) {
PX4_INFO("Opened %s log file: %s", log_type_str(type), filename);
notify();
return true;
Expand Down Expand Up @@ -637,11 +634,7 @@ size_t LogWriterFile::LogFileBuffer::get_read_ptr(void **ptr, bool *is_part)

bool LogWriterFile::LogFileBuffer::start_log(const char *filename)
{
#if defined(PX4_CRYPTO)
_fd = ::open(filename, O_APPEND | O_WRONLY, PX4_O_MODE_666);
#else
_fd = ::open(filename, O_CREAT | O_WRONLY, PX4_O_MODE_666);
#endif
_had_write_error.store(false);

if (_fd < 0) {
Expand Down
2 changes: 1 addition & 1 deletion src/modules/logger/log_writer_file.h
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ class LogWriterFile
pthread_cond_t _cv;
pthread_t _thread = 0;
#if defined(PX4_CRYPTO)
bool init_logfile_encryption(const char *filename);
bool init_logfile_encryption(const LogType type);
PX4Crypto _crypto;
int _min_blocksize;
px4_crypto_algorithm_t _algorithm;
Expand Down

0 comments on commit dfd8f2c

Please sign in to comment.