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/session.hh | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'include/olm/session.hh') 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 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/session.hh | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) (limited to 'include/olm/session.hh') 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