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. --- include/olm/olm.h | 2 ++ include/olm/session.hh | 12 ++++++++++++ 2 files changed, 14 insertions(+) (limited to 'include/olm') diff --git a/include/olm/olm.h b/include/olm/olm.h index 61ea07b..770be72 100644 --- a/include/olm/olm.h +++ b/include/olm/olm.h @@ -318,6 +318,8 @@ int olm_session_has_received_message( OlmSession *session ); +const char * olm_session_describe(OlmSession * session); + /** Checks if the PRE_KEY message is for this in-bound session. This can happen * if multiple messages are sent to this account before this account sends a * message in reply. The one_time_key_message buffer is destroyed. Returns 1 if diff --git a/include/olm/session.hh b/include/olm/session.hh index 9d44816..86598dd 100644 --- a/include/olm/session.hh +++ b/include/olm/session.hh @@ -17,6 +17,8 @@ #include "olm/ratchet.hh" +#define DESCRIBE_BUFFER_LEN 256 + namespace olm { struct Account; @@ -35,6 +37,8 @@ struct Session { bool received_message; + char describe_buffer[DESCRIBE_BUFFER_LEN]; + _olm_curve25519_public_key alice_identity_key; _olm_curve25519_public_key alice_base_key; _olm_curve25519_public_key bob_one_time_key; @@ -131,6 +135,14 @@ struct Session { std::uint8_t const * message, std::size_t message_length, std::uint8_t * plaintext, std::size_t max_plaintext_length ); + + /** + * Return a string describing this session and its state (not including the + * private key) + * The pointer returned refers to an internal buffer which will be valid + * up until the next time describe() is called. + */ + const char *describe(); }; -- cgit v1.2.3 From e73a208fb2b70fb5d195a74956f22ea6557d361f Mon Sep 17 00:00:00 2001 From: David Baker Date: Tue, 1 Oct 2019 11:18:05 +0100 Subject: doc string --- include/olm/olm.h | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'include/olm') diff --git a/include/olm/olm.h b/include/olm/olm.h index 770be72..242277a 100644 --- a/include/olm/olm.h +++ b/include/olm/olm.h @@ -318,6 +318,12 @@ int olm_session_has_received_message( OlmSession *session ); +/** + * Return a string describing the internal state of an olm session, + * for debugging and logging purposes. The pointer returned points + * to an internal buffer and is valid until the next call to + * olm_session_describe on the same olm session object. + */ const char * olm_session_describe(OlmSession * session); /** Checks if the PRE_KEY message is for this in-bound session. This can happen -- 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. --- include/olm/olm.h | 8 +++----- include/olm/session.hh | 14 +++++--------- 2 files changed, 8 insertions(+), 14 deletions(-) (limited to 'include/olm') diff --git a/include/olm/olm.h b/include/olm/olm.h index 242277a..a0ef46a 100644 --- a/include/olm/olm.h +++ b/include/olm/olm.h @@ -319,12 +319,10 @@ int olm_session_has_received_message( ); /** - * Return a string describing the internal state of an olm session, - * for debugging and logging purposes. The pointer returned points - * to an internal buffer and is valid until the next call to - * olm_session_describe on the same olm session object. + * Write a string describing the internal state of an olm session + * to the buffer provided for debugging and logging purposes. */ -const char * olm_session_describe(OlmSession * session); +void olm_session_describe(OlmSession * session, char *buf, size_t buflen); /** Checks if the PRE_KEY message is for this in-bound session. This can happen * if multiple messages are sent to this account before this account sends a diff --git a/include/olm/session.hh b/include/olm/session.hh index 86598dd..ce05fc8 100644 --- a/include/olm/session.hh +++ b/include/olm/session.hh @@ -17,8 +17,6 @@ #include "olm/ratchet.hh" -#define DESCRIBE_BUFFER_LEN 256 - namespace olm { struct Account; @@ -37,8 +35,6 @@ struct Session { bool received_message; - char describe_buffer[DESCRIBE_BUFFER_LEN]; - _olm_curve25519_public_key alice_identity_key; _olm_curve25519_public_key alice_base_key; _olm_curve25519_public_key bob_one_time_key; @@ -137,12 +133,12 @@ struct Session { ); /** - * Return a string describing this session and its state (not including the - * private key) - * The pointer returned refers to an internal buffer which will be valid - * up until the next time describe() is called. + * Write a string describing this session and its state (not including the + * private key) into the buffer provided. + * + * Takes a buffer to write to and the length of that buffer */ - const char *describe(); + void describe(char *buf, size_t buflen); }; -- 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 --- include/olm/olm.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'include/olm') diff --git a/include/olm/olm.h b/include/olm/olm.h index a0ef46a..6a2b3fb 100644 --- a/include/olm/olm.h +++ b/include/olm/olm.h @@ -319,8 +319,8 @@ int olm_session_has_received_message( ); /** - * Write a string describing the internal state of an olm session - * to the buffer provided for debugging and logging purposes. + * Write a null-terminated string describing the internal state of an olm + * session to the buffer provided for debugging and logging purposes. */ void olm_session_describe(OlmSession * session, char *buf, size_t buflen); -- cgit v1.2.3