From 39a1ee0b18f0fced6d7bc293cc9a46ea70ec9e96 Mon Sep 17 00:00:00 2001 From: David Baker Date: Tue, 1 Oct 2019 11:14:16 +0100 Subject: Add olm_session_describe As a way to dump the state of an olm session, ie. the chain indicies, so we can debug why olm sessions break and get out of sync. --- src/olm.cpp | 6 ++++++ src/session.cpp | 29 +++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+) (limited to 'src') diff --git a/src/olm.cpp b/src/olm.cpp index d626c84..65e506d 100644 --- a/src/olm.cpp +++ b/src/olm.cpp @@ -535,6 +535,12 @@ int olm_session_has_received_message( return from_c(session)->received_message; } +const char * olm_session_describe( + OlmSession * session +) { + return from_c(session)->describe(); +} + size_t olm_matches_inbound_session( OlmSession * session, void * one_time_key_message, size_t message_length diff --git a/src/session.cpp b/src/session.cpp index f1bc5a7..bad19de 100644 --- a/src/session.cpp +++ b/src/session.cpp @@ -21,6 +21,7 @@ #include "olm/pickle.hh" #include +#include namespace { @@ -397,6 +398,34 @@ std::size_t olm::Session::decrypt( return result; } +const char * olm::Session::describe() { + describe_buffer[0] = '\0'; + char *buf_pos = describe_buffer; + + buf_pos += snprintf( + buf_pos, DESCRIBE_BUFFER_LEN - (buf_pos - describe_buffer), + "sender chain index: %d ", ratchet.sender_chain[0].chain_key.index + ); + + buf_pos += snprintf(buf_pos, DESCRIBE_BUFFER_LEN - (buf_pos - describe_buffer), "receiver chain indcies:"); + for (size_t i = 0; i < ratchet.receiver_chains.size(); ++i) { + buf_pos += snprintf( + buf_pos, DESCRIBE_BUFFER_LEN - (buf_pos - describe_buffer), + " %d", ratchet.receiver_chains[i].chain_key.index + ); + } + + buf_pos += snprintf(buf_pos, DESCRIBE_BUFFER_LEN - (buf_pos - describe_buffer), " skipped message keys:"); + for (size_t i = 0; i < ratchet.skipped_message_keys.size(); ++i) { + buf_pos += snprintf( + buf_pos, DESCRIBE_BUFFER_LEN - (buf_pos - describe_buffer), + " %d", ratchet.skipped_message_keys[i].message_key.index + ); + } + + return describe_buffer; +} + namespace { // the master branch writes pickle version 1; the logging_enabled branch writes // 0x80000001. -- cgit v1.2.3 From b482321213e6e896d0981c266bed12f4e1f67441 Mon Sep 17 00:00:00 2001 From: David Baker Date: Fri, 4 Oct 2019 11:43:40 +0100 Subject: Pass in a buffer to olm_session_describe instead of having a static one, as that could end up taking up a lot of memory if your app keeps olm sessions hanging about. --- src/olm.cpp | 6 +++--- src/session.cpp | 16 ++++++++-------- 2 files changed, 11 insertions(+), 11 deletions(-) (limited to 'src') diff --git a/src/olm.cpp b/src/olm.cpp index 65e506d..0333b10 100644 --- a/src/olm.cpp +++ b/src/olm.cpp @@ -535,10 +535,10 @@ int olm_session_has_received_message( return from_c(session)->received_message; } -const char * olm_session_describe( - OlmSession * session +void olm_session_describe( + OlmSession * session, char *buf, size_t buflen ) { - return from_c(session)->describe(); + from_c(session)->describe(buf, buflen); } size_t olm_matches_inbound_session( diff --git a/src/session.cpp b/src/session.cpp index bad19de..d6761d5 100644 --- a/src/session.cpp +++ b/src/session.cpp @@ -398,32 +398,32 @@ std::size_t olm::Session::decrypt( return result; } -const char * olm::Session::describe() { +void olm::Session::describe(char *describe_buffer, size_t buflen) { + if (buflen == 0) return; + describe_buffer[0] = '\0'; char *buf_pos = describe_buffer; buf_pos += snprintf( - buf_pos, DESCRIBE_BUFFER_LEN - (buf_pos - describe_buffer), + buf_pos, buflen - (buf_pos - describe_buffer), "sender chain index: %d ", ratchet.sender_chain[0].chain_key.index ); - buf_pos += snprintf(buf_pos, DESCRIBE_BUFFER_LEN - (buf_pos - describe_buffer), "receiver chain indcies:"); + buf_pos += snprintf(buf_pos, buflen - (buf_pos - describe_buffer), "receiver chain indcies:"); for (size_t i = 0; i < ratchet.receiver_chains.size(); ++i) { buf_pos += snprintf( - buf_pos, DESCRIBE_BUFFER_LEN - (buf_pos - describe_buffer), + buf_pos, buflen - (buf_pos - describe_buffer), " %d", ratchet.receiver_chains[i].chain_key.index ); } - buf_pos += snprintf(buf_pos, DESCRIBE_BUFFER_LEN - (buf_pos - describe_buffer), " skipped message keys:"); + buf_pos += snprintf(buf_pos, buflen - (buf_pos - describe_buffer), " skipped message keys:"); for (size_t i = 0; i < ratchet.skipped_message_keys.size(); ++i) { buf_pos += snprintf( - buf_pos, DESCRIBE_BUFFER_LEN - (buf_pos - describe_buffer), + buf_pos, buflen - (buf_pos - describe_buffer), " %d", ratchet.skipped_message_keys[i].message_key.index ); } - - return describe_buffer; } namespace { -- cgit v1.2.3 From fc423fad15ee3daaf236f211d67a25d03f63b560 Mon Sep 17 00:00:00 2001 From: Hubert Chathi Date: Tue, 8 Oct 2019 17:44:09 -0400 Subject: check return value of snprintf, fix typo, add clarification --- src/session.cpp | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) (limited to 'src') diff --git a/src/session.cpp b/src/session.cpp index d6761d5..b619e56 100644 --- a/src/session.cpp +++ b/src/session.cpp @@ -404,25 +404,32 @@ void olm::Session::describe(char *describe_buffer, size_t buflen) { describe_buffer[0] = '\0'; char *buf_pos = describe_buffer; - buf_pos += snprintf( + int size; + + size = snprintf( buf_pos, buflen - (buf_pos - describe_buffer), "sender chain index: %d ", ratchet.sender_chain[0].chain_key.index ); + if (size > 0) buf_pos += size; - buf_pos += snprintf(buf_pos, buflen - (buf_pos - describe_buffer), "receiver chain indcies:"); + size = snprintf(buf_pos, buflen - (buf_pos - describe_buffer), "receiver chain indices:"); + if (size > 0) buf_pos += size; for (size_t i = 0; i < ratchet.receiver_chains.size(); ++i) { - buf_pos += snprintf( + size = snprintf( buf_pos, buflen - (buf_pos - describe_buffer), " %d", ratchet.receiver_chains[i].chain_key.index ); + if (size > 0) buf_pos += size; } - buf_pos += snprintf(buf_pos, buflen - (buf_pos - describe_buffer), " skipped message keys:"); + size = snprintf(buf_pos, buflen - (buf_pos - describe_buffer), " skipped message keys:"); + if (size >= 0) buf_pos += size; for (size_t i = 0; i < ratchet.skipped_message_keys.size(); ++i) { - buf_pos += snprintf( + size = snprintf( buf_pos, buflen - (buf_pos - describe_buffer), " %d", ratchet.skipped_message_keys[i].message_key.index ); + if (size > 0) buf_pos += size; } } -- cgit v1.2.3