matrix.inbound_group

Undocumented in source.

Members

Classes

InboundGroupSession
class InboundGroupSession
Undocumented in source.

Functions

olm_clear_inbound_group_session
size_t olm_clear_inbound_group_session(OlmInboundGroupSession* session)

Clears the memory used to back this group session

olm_export_inbound_group_session
size_t olm_export_inbound_group_session(OlmInboundGroupSession* session, char* key, size_t key_length, uint message_index)

Export the base64-encoded ratchet key for this session, at the given index, in a format which can be used by olm_import_inbound_group_session

olm_export_inbound_group_session_length
size_t olm_export_inbound_group_session_length(OlmInboundGroupSession* session)

Get the number of bytes returned by olm_export_inbound_group_session()

olm_group_decrypt
size_t olm_group_decrypt(OlmInboundGroupSession* session, char* message, size_t message_length, char* plaintext, size_t max_plaintext_length, uint* message_index)

Decrypt a message.

olm_group_decrypt_max_plaintext_length
size_t olm_group_decrypt_max_plaintext_length(OlmInboundGroupSession* session, char* message, size_t message_length)

Get an upper bound on the number of bytes of plain-text the decrypt method will write for a given input message length. The actual size could be different due to padding.

olm_import_inbound_group_session
size_t olm_import_inbound_group_session(OlmInboundGroupSession* session, const(char)* session_key, size_t session_key_length)

Import an inbound group session, from a previous export.

olm_inbound_group_session
OlmInboundGroupSession* olm_inbound_group_session(void* memory)

Initialise an inbound group session object using the supplied memory The supplied memory should be at least olm_inbound_group_session_size() bytes.

olm_inbound_group_session_first_known_index
uint olm_inbound_group_session_first_known_index(OlmInboundGroupSession* session)

Get the first message index we know how to decrypt.

olm_inbound_group_session_id
size_t olm_inbound_group_session_id(OlmInboundGroupSession* session, char* id, size_t id_length)

Get a base64-encoded identifier for this session.

olm_inbound_group_session_id_length
size_t olm_inbound_group_session_id_length(OlmInboundGroupSession* session)

Get the number of bytes returned by olm_inbound_group_session_id()

olm_inbound_group_session_is_verified
int olm_inbound_group_session_is_verified(OlmInboundGroupSession* session)

Check if the session has been verified as a valid session.

olm_inbound_group_session_last_error
const(char)* olm_inbound_group_session_last_error(OlmInboundGroupSession* session)

* A null terminated string describing the most recent error to happen to a * group session

olm_inbound_group_session_size
size_t olm_inbound_group_session_size()

get the size of an inbound group session, in bytes.

olm_init_inbound_group_session
size_t olm_init_inbound_group_session(OlmInboundGroupSession* session, const(char)* session_key, size_t session_key_length)

Start a new inbound group session, from a key exported from olm_outbound_group_session_key

olm_pickle_inbound_group_session
size_t olm_pickle_inbound_group_session(OlmInboundGroupSession* session, const(void)* key, size_t key_length, void* pickled, size_t pickled_length)

Stores a group session as a base64 string. Encrypts the session using the supplied key. Returns the length of the session on success.

olm_pickle_inbound_group_session_length
size_t olm_pickle_inbound_group_session_length(OlmInboundGroupSession* session)

Returns the number of bytes needed to store an inbound group session

olm_unpickle_inbound_group_session
size_t olm_unpickle_inbound_group_session(OlmInboundGroupSession* session, const(void)* key, size_t key_length, void* pickled, size_t pickled_length)

Loads a group session from a pickled base64 string. Decrypts the session using the supplied key.

Structs

OlmInboundGroupSession
struct OlmInboundGroupSession
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.

Meta