diff options
Diffstat (limited to 'libs/libsignal/src/signal_protocol.h')
| -rw-r--r-- | libs/libsignal/src/signal_protocol.h | 822 |
1 files changed, 822 insertions, 0 deletions
diff --git a/libs/libsignal/src/signal_protocol.h b/libs/libsignal/src/signal_protocol.h new file mode 100644 index 0000000000..4e71355c2e --- /dev/null +++ b/libs/libsignal/src/signal_protocol.h @@ -0,0 +1,822 @@ +#ifndef SIGNAL_PROTOCOL_H +#define SIGNAL_PROTOCOL_H + +#include <stdio.h> +#include <stdlib.h> +#include <stdint.h> + +#include "ratchet.h" +#include "curve.h" +#include "session_record.h" +#include "session_pre_key.h" +#include "sender_key_record.h" +#include "signal_protocol_types.h" + +#ifdef __cplusplus +extern "C" { +#endif + +#define SG_SUCCESS 0 + +/* Standard error codes with values that match errno.h equivalents */ +#define SG_ERR_NOMEM -12 /* Not enough space */ +#define SG_ERR_INVAL -22 /* Invalid argument */ + +/* Custom error codes for error conditions specific to the library */ +#define SG_ERR_UNKNOWN -1000 +#define SG_ERR_DUPLICATE_MESSAGE -1001 +#define SG_ERR_INVALID_KEY -1002 +#define SG_ERR_INVALID_KEY_ID -1003 +#define SG_ERR_INVALID_MAC -1004 +#define SG_ERR_INVALID_MESSAGE -1005 +#define SG_ERR_INVALID_VERSION -1006 +#define SG_ERR_LEGACY_MESSAGE -1007 +#define SG_ERR_NO_SESSION -1008 +#define SG_ERR_STALE_KEY_EXCHANGE -1009 +#define SG_ERR_UNTRUSTED_IDENTITY -1010 +#define SG_ERR_VRF_SIG_VERIF_FAILED -1011 +#define SG_ERR_INVALID_PROTO_BUF -1100 +#define SG_ERR_FP_VERSION_MISMATCH -1200 +#define SG_ERR_FP_IDENT_MISMATCH -1201 + +/* + * Minimum negative error code value that this library may use. + * When implementing library callback functions, using values + * less than this constant will ensure that application-specific + * errors can be distinguished from library errors. + */ +#define SG_ERR_MINIMUM -9999 + +/* Log levels */ +#define SG_LOG_ERROR 0 +#define SG_LOG_WARNING 1 +#define SG_LOG_NOTICE 2 +#define SG_LOG_INFO 3 +#define SG_LOG_DEBUG 4 + +/* Mode settings for the crypto callbacks */ +#define SG_CIPHER_AES_CTR_NOPADDING 1 +#define SG_CIPHER_AES_CBC_PKCS5 2 + +void signal_type_ref(signal_type_base *instance); +void signal_type_unref(signal_type_base *instance); + +#ifdef DEBUG_REFCOUNT +int signal_type_ref_count(signal_type_base *instance); +#define SIGNAL_REF(instance) do { \ + signal_type_ref((signal_type_base *)instance); \ + fprintf(stderr, "REF: " #instance " = %d\n", signal_type_ref_count((signal_type_base *)instance)); \ + } while (0) +#define SIGNAL_UNREF(instance) do { \ + fprintf(stderr, "UNREF: " #instance " = %d\n", signal_type_ref_count((signal_type_base *)instance)); \ + signal_type_unref((signal_type_base *)instance); \ + instance = 0; \ + } while(0) +#else +#define SIGNAL_REF(instance) signal_type_ref((signal_type_base *)instance) +#define SIGNAL_UNREF(instance) do { signal_type_unref((signal_type_base *)instance); instance = 0; } while(0) +#endif + +/** + * Allocate a new buffer to store data of the provided length. + * + * @param len length of the buffer to allocate + * @return pointer to the allocated buffer, or 0 on failure + */ +signal_buffer *signal_buffer_alloc(size_t len); + +/** + * Create a new buffer and copy the provided data into it. + * + * @param data pointer to the start of the data + * @param len length of the data + * @return pointer to the allocated buffer, or 0 on failure + */ +signal_buffer *signal_buffer_create(const uint8_t *data, size_t len); + +/** + * Create a copy of an existing buffer. + * + * @param buffer the existing buffer to copy + * @return pointer to the updated buffer, or 0 on failure + */ +signal_buffer *signal_buffer_copy(const signal_buffer *buffer); + +/** + * Create a copy of an existing buffer. + * + * @param buffer the existing buffer to copy + * @param n the maximum number of bytes to copy + * @return pointer to the updated buffer, or 0 on failure + */ +signal_buffer *signal_buffer_n_copy(const signal_buffer *buffer, size_t n); + +/** + * Append the provided data to an existing buffer. + * Note: The underlying buffer is only expanded by an amount sufficient + * to hold the data being appended. There is no additional reserved space + * to reduce the need for memory allocations. + * + * @param buffer the existing buffer to append to + * @param data pointer to the start of the data + * @param len length of the data + * @return pointer to the updated buffer, or 0 on failure + */ +signal_buffer *signal_buffer_append(signal_buffer *buffer, const uint8_t *data, size_t len); + +/** + * Gets the data pointer for the buffer. + * This can be used to read and write data stored in the buffer. + * + * @param buffer pointer to the buffer instance + * @return data pointer + */ +uint8_t *signal_buffer_data(signal_buffer *buffer); + +/** + * Gets the data pointer for the buffer. + * This can be used to read and write data stored in the buffer. + * + * @param buffer pointer to the buffer instance + * @return data pointer + */ +const uint8_t *signal_buffer_const_data(const signal_buffer *buffer); + +/** + * Gets the length of the data stored within the buffer. + * + * @param buffer pointer to the buffer instance + * @return data length + */ +size_t signal_buffer_len(const signal_buffer *buffer); + +/** + * Compare two buffers. + * + * @param buffer1 first buffer to compare + * @param buffer2 second buffer to compare + * @return 0 if the two buffers are equal, negative or positive otherwise + */ +int signal_buffer_compare(signal_buffer *buffer1, signal_buffer *buffer2); + +/** + * Free the data buffer. + * + * @param buffer pointer to the buffer instance to free + */ +void signal_buffer_free(signal_buffer *buffer); + +/** + * Zero and free the data buffer. + * This function should be used when the buffer contains sensitive + * data, to make sure the memory is cleared before being freed. + * + * @param buffer pointer to the buffer instance to free + */ +void signal_buffer_bzero_free(signal_buffer *buffer); + +/** + * Allocate a new buffer list. + * + * @return pointer to the allocated buffer, or 0 on failure + */ +signal_buffer_list *signal_buffer_list_alloc(void); + +/** + * Create a copy of an existing buffer list. + * + * @param list the existing buffer list to copy + * @return pointer to the updated buffer, or 0 on failure + */ +signal_buffer_list *signal_buffer_list_copy(const signal_buffer_list *list); + +/** + * Push the provided buffer onto the end of the list. + * The list will take ownership of the buffer, and free it when the list is + * freed. + * + * @param list the buffer list + * @param buffer the buffer to push + * @return 0 on success, or negative on failure + */ +int signal_buffer_list_push_back(signal_buffer_list *list, signal_buffer *buffer); + +/** + * Gets the size of the buffer list. + * + * @param list the buffer list + * @return the size of the list + */ +unsigned int signal_buffer_list_size(signal_buffer_list *list); + +/** + * Gets the value of the element at a particular index in the list + * + * @param list the list + * @param index the index within the list + * @return the value + */ +signal_buffer *signal_buffer_list_at(signal_buffer_list *list, unsigned int index); + +/** + * Free the buffer list, including all the buffers added to it. + * + * @param list the buffer list + */ +void signal_buffer_list_free(signal_buffer_list *list); + +/** + * Free the buffer list, including all the buffers added to it. + * This function should be used when the buffer list contains sensitive + * data, to make sure the memory is cleared before being freed. + * + * @param list the buffer list + */ +void signal_buffer_list_bzero_free(signal_buffer_list *list); + +/** + * Allocate a new int list + * + * @return pointer to the allocated buffer, or 0 on failure + */ +signal_int_list *signal_int_list_alloc(void); + +/** + * Push a new value onto the end of the list + * + * @param list the list + * @param value the value to push + * @return 0 on success, or negative on failure + */ +int signal_int_list_push_back(signal_int_list *list, int value); + +/** + * Gets the size of the list. + * + * @param list the list + * @return the size of the list + */ +unsigned int signal_int_list_size(signal_int_list *list); + +/** + * Gets the value of the element at a particular index in the list + * + * @param list the list + * @param index the index within the list + * @return the value + */ +int signal_int_list_at(signal_int_list *list, unsigned int index); + +/** + * Free the int list + * @param list the list to free + */ +void signal_int_list_free(signal_int_list *list); + +typedef struct signal_crypto_provider { + /** + * Callback for a secure random number generator. + * This function shall fill the provided buffer with random bytes. + * + * @param data pointer to the output buffer + * @param len size of the output buffer + * @return 0 on success, negative on failure + */ + int (*random_func)(uint8_t *data, size_t len, void *user_data); + + /** + * Callback for an HMAC-SHA256 implementation. + * This function shall initialize an HMAC context with the provided key. + * + * @param hmac_context private HMAC context pointer + * @param key pointer to the key + * @param key_len length of the key + * @return 0 on success, negative on failure + */ + int (*hmac_sha256_init_func)(void **hmac_context, const uint8_t *key, size_t key_len, void *user_data); + + /** + * Callback for an HMAC-SHA256 implementation. + * This function shall update the HMAC context with the provided data + * + * @param hmac_context private HMAC context pointer + * @param data pointer to the data + * @param data_len length of the data + * @return 0 on success, negative on failure + */ + int (*hmac_sha256_update_func)(void *hmac_context, const uint8_t *data, size_t data_len, void *user_data); + + /** + * Callback for an HMAC-SHA256 implementation. + * This function shall finalize an HMAC calculation and populate the output + * buffer with the result. + * + * @param hmac_context private HMAC context pointer + * @param output buffer to be allocated and populated with the result + * @return 0 on success, negative on failure + */ + int (*hmac_sha256_final_func)(void *hmac_context, signal_buffer **output, void *user_data); + + /** + * Callback for an HMAC-SHA256 implementation. + * This function shall free the private context allocated in + * hmac_sha256_init_func. + * + * @param hmac_context private HMAC context pointer + */ + void (*hmac_sha256_cleanup_func)(void *hmac_context, void *user_data); + + /** + * Callback for a SHA512 message digest implementation. + * This function shall initialize a digest context. + * + * @param digest_context private digest context pointer + * @return 0 on success, negative on failure + */ + int (*sha512_digest_init_func)(void **digest_context, void *user_data); + + /** + * Callback for a SHA512 message digest implementation. + * This function shall update the digest context with the provided data. + * + * @param digest_context private digest context pointer + * @param data pointer to the data + * @param data_len length of the data + * @return 0 on success, negative on failure + */ + int (*sha512_digest_update_func)(void *digest_context, const uint8_t *data, size_t data_len, void *user_data); + + /** + * Callback for a SHA512 message digest implementation. + * This function shall finalize the digest calculation, populate the + * output buffer with the result, and prepare the context for reuse. + * + * @param digest_context private digest context pointer + * @param output buffer to be allocated and populated with the result + * @return 0 on success, negative on failure + */ + int (*sha512_digest_final_func)(void *digest_context, signal_buffer **output, void *user_data); + + /** + * Callback for a SHA512 message digest implementation. + * This function shall free the private context allocated in + * sha512_digest_init_func. + * + * @param digest_context private digest context pointer + */ + void (*sha512_digest_cleanup_func)(void *digest_context, void *user_data); + + /** + * Callback for an AES encryption implementation. + * + * @param output buffer to be allocated and populated with the ciphertext + * @param cipher specific cipher variant to use, either SG_CIPHER_AES_CTR_NOPADDING or SG_CIPHER_AES_CBC_PKCS5 + * @param key the encryption key + * @param key_len length of the encryption key + * @param iv the initialization vector + * @param iv_len length of the initialization vector + * @param plaintext the plaintext to encrypt + * @param plaintext_len length of the plaintext + * @return 0 on success, negative on failure + */ + int (*encrypt_func)(signal_buffer **output, + int cipher, + const uint8_t *key, size_t key_len, + const uint8_t *iv, size_t iv_len, + const uint8_t *plaintext, size_t plaintext_len, + void *user_data); + + /** + * Callback for an AES decryption implementation. + * + * @param output buffer to be allocated and populated with the plaintext + * @param cipher specific cipher variant to use, either SG_CIPHER_AES_CTR_NOPADDING or SG_CIPHER_AES_CBC_PKCS5 + * @param key the encryption key + * @param key_len length of the encryption key + * @param iv the initialization vector + * @param iv_len length of the initialization vector + * @param ciphertext the ciphertext to decrypt + * @param ciphertext_len length of the ciphertext + * @return 0 on success, negative on failure + */ + int (*decrypt_func)(signal_buffer **output, + int cipher, + const uint8_t *key, size_t key_len, + const uint8_t *iv, size_t iv_len, + const uint8_t *ciphertext, size_t ciphertext_len, + void *user_data); + + /** User data pointer */ + void *user_data; +} signal_crypto_provider; + +typedef struct signal_protocol_session_store { + /** + * Returns a copy of the serialized session record corresponding to the + * provided recipient ID + device ID tuple. + * + * @param record pointer to a freshly allocated buffer containing the + * serialized session record. Unset if no record was found. + * The Signal Protocol library is responsible for freeing this buffer. + * @param user_record pointer to a freshly allocated buffer containing + * application specific data stored alongside the serialized session + * record. If no such data exists, then this pointer may be left unset. + * The Signal Protocol library is responsible for freeing this buffer. + * @param address the address of the remote client + * @return 1 if the session was loaded, 0 if the session was not found, negative on failure + */ + int (*load_session_func)(signal_buffer **record, signal_buffer **user_record, const signal_protocol_address *address, void *user_data); + + /** + * Returns all known devices with active sessions for a recipient + * + * @param pointer to an array that will be allocated and populated with the result + * @param name the name of the remote client + * @param name_len the length of the name + * @return size of the sessions array, or negative on failure + */ + int (*get_sub_device_sessions_func)(signal_int_list **sessions, const char *name, size_t name_len, void *user_data); + + /** + * Commit to storage the session record for a given + * recipient ID + device ID tuple. + * + * @param address the address of the remote client + * @param record pointer to a buffer containing the serialized session + * record for the remote client + * @param record_len length of the serialized session record + * @param user_record pointer to a buffer containing application specific + * data to be stored alongside the serialized session record for the + * remote client. If no such data exists, then this pointer will be null. + * @param user_record_len length of the application specific data + * @return 0 on success, negative on failure + */ + int (*store_session_func)(const signal_protocol_address *address, uint8_t *record, size_t record_len, uint8_t *user_record, size_t user_record_len, void *user_data); + + /** + * Determine whether there is a committed session record for a + * recipient ID + device ID tuple. + * + * @param address the address of the remote client + * @return 1 if a session record exists, 0 otherwise. + */ + int (*contains_session_func)(const signal_protocol_address *address, void *user_data); + + /** + * Remove a session record for a recipient ID + device ID tuple. + * + * @param address the address of the remote client + * @return 1 if a session was deleted, 0 if a session was not deleted, negative on error + */ + int (*delete_session_func)(const signal_protocol_address *address, void *user_data); + + /** + * Remove the session records corresponding to all devices of a recipient ID. + * + * @param name the name of the remote client + * @param name_len the length of the name + * @return the number of deleted sessions on success, negative on failure + */ + int (*delete_all_sessions_func)(const char *name, size_t name_len, void *user_data); + + /** + * Function called to perform cleanup when the data store context is being + * destroyed. + */ + void (*destroy_func)(void *user_data); + + /** User data pointer */ + void *user_data; +} signal_protocol_session_store; + +typedef struct signal_protocol_pre_key_store { + /** + * Load a local serialized PreKey record. + * + * @param record pointer to a newly allocated buffer containing the record, + * if found. Unset if no record was found. + * The Signal Protocol library is responsible for freeing this buffer. + * @param pre_key_id the ID of the local serialized PreKey record + * @retval SG_SUCCESS if the key was found + * @retval SG_ERR_INVALID_KEY_ID if the key could not be found + */ + int (*load_pre_key)(signal_buffer **record, uint32_t pre_key_id, void *user_data); + + /** + * Store a local serialized PreKey record. + * + * @param pre_key_id the ID of the PreKey record to store. + * @param record pointer to a buffer containing the serialized record + * @param record_len length of the serialized record + * @return 0 on success, negative on failure + */ + int (*store_pre_key)(uint32_t pre_key_id, uint8_t *record, size_t record_len, void *user_data); + + /** + * Determine whether there is a committed PreKey record matching the + * provided ID. + * + * @param pre_key_id A PreKey record ID. + * @return 1 if the store has a record for the PreKey ID, 0 otherwise + */ + int (*contains_pre_key)(uint32_t pre_key_id, void *user_data); + + /** + * Delete a PreKey record from local storage. + * + * @param pre_key_id The ID of the PreKey record to remove. + * @return 0 on success, negative on failure + */ + int (*remove_pre_key)(uint32_t pre_key_id, void *user_data); + + /** + * Function called to perform cleanup when the data store context is being + * destroyed. + */ + void (*destroy_func)(void *user_data); + + /** User data pointer */ + void *user_data; +} signal_protocol_pre_key_store; + +typedef struct signal_protocol_signed_pre_key_store { + /** + * Load a local serialized signed PreKey record. + * + * @param record pointer to a newly allocated buffer containing the record, + * if found. Unset if no record was found. + * The Signal Protocol library is responsible for freeing this buffer. + * @param signed_pre_key_id the ID of the local signed PreKey record + * @retval SG_SUCCESS if the key was found + * @retval SG_ERR_INVALID_KEY_ID if the key could not be found + */ + int (*load_signed_pre_key)(signal_buffer **record, uint32_t signed_pre_key_id, void *user_data); + + /** + * Store a local serialized signed PreKey record. + * + * @param signed_pre_key_id the ID of the signed PreKey record to store + * @param record pointer to a buffer containing the serialized record + * @param record_len length of the serialized record + * @return 0 on success, negative on failure + */ + int (*store_signed_pre_key)(uint32_t signed_pre_key_id, uint8_t *record, size_t record_len, void *user_data); + + /** + * Determine whether there is a committed signed PreKey record matching + * the provided ID. + * + * @param signed_pre_key_id A signed PreKey record ID. + * @return 1 if the store has a record for the signed PreKey ID, 0 otherwise + */ + int (*contains_signed_pre_key)(uint32_t signed_pre_key_id, void *user_data); + + /** + * Delete a SignedPreKeyRecord from local storage. + * + * @param signed_pre_key_id The ID of the signed PreKey record to remove. + * @return 0 on success, negative on failure + */ + int (*remove_signed_pre_key)(uint32_t signed_pre_key_id, void *user_data); + + /** + * Function called to perform cleanup when the data store context is being + * destroyed. + */ + void (*destroy_func)(void *user_data); + + /** User data pointer */ + void *user_data; +} signal_protocol_signed_pre_key_store; + +typedef struct signal_protocol_identity_key_store { + /** + * Get the local client's identity key pair. + * + * @param public_data pointer to a newly allocated buffer containing the + * public key, if found. Unset if no record was found. + * The Signal Protocol library is responsible for freeing this buffer. + * @param private_data pointer to a newly allocated buffer containing the + * private key, if found. Unset if no record was found. + * The Signal Protocol library is responsible for freeing this buffer. + * @return 0 on success, negative on failure + */ + int (*get_identity_key_pair)(signal_buffer **public_data, signal_buffer **private_data, void *user_data); + + /** + * Return the local client's registration ID. + * + * Clients should maintain a registration ID, a random number + * between 1 and 16380 that's generated once at install time. + * + * @param registration_id pointer to be set to the local client's + * registration ID, if it was successfully retrieved. + * @return 0 on success, negative on failure + */ + int (*get_local_registration_id)(void *user_data, uint32_t *registration_id); + + /** + * Save a remote client's identity key + * <p> + * Store a remote client's identity key as trusted. + * The value of key_data may be null. In this case remove the key data + * from the identity store, but retain any metadata that may be kept + * alongside it. + * + * @param address the address of the remote client + * @param key_data Pointer to the remote client's identity key, may be null + * @param key_len Length of the remote client's identity key + * @return 0 on success, negative on failure + */ + int (*save_identity)(const signal_protocol_address *address, uint8_t *key_data, size_t key_len, void *user_data); + + /** + * Verify a remote client's identity key. + * + * Determine whether a remote client's identity is trusted. Convention is + * that the TextSecure protocol is 'trust on first use.' This means that + * an identity key is considered 'trusted' if there is no entry for the recipient + * in the local store, or if it matches the saved key for a recipient in the local + * store. Only if it mismatches an entry in the local store is it considered + * 'untrusted.' + * + * @param address the address of the remote client + * @param identityKey The identity key to verify. + * @param key_data Pointer to the identity key to verify + * @param key_len Length of the identity key to verify + * @return 1 if trusted, 0 if untrusted, negative on failure + */ + int (*is_trusted_identity)(const signal_protocol_address *address, uint8_t *key_data, size_t key_len, void *user_data); + + /** + * Function called to perform cleanup when the data store context is being + * destroyed. + */ + void (*destroy_func)(void *user_data); + + /** User data pointer */ + void *user_data; +} signal_protocol_identity_key_store; + +typedef struct signal_protocol_sender_key_store { + /** + * Store a serialized sender key record for a given + * (groupId + senderId + deviceId) tuple. + * + * @param sender_key_name the (groupId + senderId + deviceId) tuple + * @param record pointer to a buffer containing the serialized record + * @param record_len length of the serialized record + * @param user_record pointer to a buffer containing application specific + * data to be stored alongside the serialized record. If no such + * data exists, then this pointer will be null. + * @param user_record_len length of the application specific data + * @return 0 on success, negative on failure + */ + int (*store_sender_key)(const signal_protocol_sender_key_name *sender_key_name, uint8_t *record, size_t record_len, uint8_t *user_record, size_t user_record_len, void *user_data); + + /** + * Returns a copy of the sender key record corresponding to the + * (groupId + senderId + deviceId) tuple. + * + * @param record pointer to a newly allocated buffer containing the record, + * if found. Unset if no record was found. + * The Signal Protocol library is responsible for freeing this buffer. + * @param user_record pointer to a newly allocated buffer containing + * application-specific data stored alongside the record. If no such + * data exists, then this pointer may be left unset. + * The Signal Protocol library is responsible for freeing this buffer. + * @param sender_key_name the (groupId + senderId + deviceId) tuple + * @return 1 if the record was loaded, 0 if the record was not found, negative on failure + */ + int (*load_sender_key)(signal_buffer **record, signal_buffer **user_record, const signal_protocol_sender_key_name *sender_key_name, void *user_data); + + /** + * Function called to perform cleanup when the data store context is being + * destroyed. + */ + void (*destroy_func)(void *user_data); + + /** User data pointer */ + void *user_data; +} signal_protocol_sender_key_store; + +/** + * Create a new instance of the global library context. + */ +int signal_context_create(signal_context **context, void *user_data); + +/** + * Set the crypto provider to be used by the Signal Protocol library. + * + * @param crypto_provider Populated structure of crypto provider function + * pointers. The contents of this structure are copied, so the caller + * does not need to maintain its instance. + * @return 0 on success, negative on failure + */ +int signal_context_set_crypto_provider(signal_context *context, const signal_crypto_provider *crypto_provider); + +/** + * Set the locking functions to be used by the Signal Protocol library for + * synchronization. + * + * Note: These functions must allow recursive locking (e.g. PTHREAD_MUTEX_RECURSIVE) + * + * @param lock function to lock a mutex + * @param unlock function to unlock a mutex + * @return 0 on success, negative on failure + */ +int signal_context_set_locking_functions(signal_context *context, + void (*lock)(void *user_data), void (*unlock)(void *user_data)); + +/** + * Set the log function to be used by the Signal Protocol library for logging. + * + * @return 0 on success, negative on failure + */ +int signal_context_set_log_function(signal_context *context, + void (*log)(int level, const char *message, size_t len, void *user_data)); + +void signal_context_destroy(signal_context *context); + +/** + * Create a new instance of the Signal Protocol data store interface. + */ +int signal_protocol_store_context_create(signal_protocol_store_context **context, signal_context *global_context); + +int signal_protocol_store_context_set_session_store(signal_protocol_store_context *context, const signal_protocol_session_store *store); +int signal_protocol_store_context_set_pre_key_store(signal_protocol_store_context *context, const signal_protocol_pre_key_store *store); +int signal_protocol_store_context_set_signed_pre_key_store(signal_protocol_store_context *context, const signal_protocol_signed_pre_key_store *store); +int signal_protocol_store_context_set_identity_key_store(signal_protocol_store_context *context, const signal_protocol_identity_key_store *store); +int signal_protocol_store_context_set_sender_key_store(signal_protocol_store_context *context, const signal_protocol_sender_key_store *store); + +void signal_protocol_store_context_destroy(signal_protocol_store_context *context); + +/* + * Interface to the session store. + * These functions will use the callbacks in the provided + * signal_protocol_store_context instance and operate in terms of higher level + * library data structures. + */ + +int signal_protocol_session_load_session(signal_protocol_store_context *context, session_record **record, const signal_protocol_address *address); +int signal_protocol_session_get_sub_device_sessions(signal_protocol_store_context *context, signal_int_list **sessions, const char *name, size_t name_len); +int signal_protocol_session_store_session(signal_protocol_store_context *context, const signal_protocol_address *address, session_record *record); +int signal_protocol_session_contains_session(signal_protocol_store_context *context, const signal_protocol_address *address); +int signal_protocol_session_delete_session(signal_protocol_store_context *context, const signal_protocol_address *address); +int signal_protocol_session_delete_all_sessions(signal_protocol_store_context *context, const char *name, size_t name_len); + + +/* + * Interface to the pre-key store. + * These functions will use the callbacks in the provided + * signal_protocol_store_context instance and operate in terms of higher level + * library data structures. + */ + +int signal_protocol_pre_key_load_key(signal_protocol_store_context *context, session_pre_key **pre_key, uint32_t pre_key_id); +int signal_protocol_pre_key_store_key(signal_protocol_store_context *context, session_pre_key *pre_key); +int signal_protocol_pre_key_contains_key(signal_protocol_store_context *context, uint32_t pre_key_id); +int signal_protocol_pre_key_remove_key(signal_protocol_store_context *context, uint32_t pre_key_id); + + +/* + * Interface to the signed pre-key store. + * These functions will use the callbacks in the provided + * signal_protocol_store_context instance and operate in terms of higher level + * library data structures. + */ + +int signal_protocol_signed_pre_key_load_key(signal_protocol_store_context *context, session_signed_pre_key **pre_key, uint32_t signed_pre_key_id); +int signal_protocol_signed_pre_key_store_key(signal_protocol_store_context *context, session_signed_pre_key *pre_key); +int signal_protocol_signed_pre_key_contains_key(signal_protocol_store_context *context, uint32_t signed_pre_key_id); +int signal_protocol_signed_pre_key_remove_key(signal_protocol_store_context *context, uint32_t signed_pre_key_id); + + +/* + * Interface to the identity key store. + * These functions will use the callbacks in the provided + * signal_protocol_store_context instance and operate in terms of higher level + * library data structures. + */ + +int signal_protocol_identity_get_key_pair(signal_protocol_store_context *context, ratchet_identity_key_pair **key_pair); +int signal_protocol_identity_get_local_registration_id(signal_protocol_store_context *context, uint32_t *registration_id); +int signal_protocol_identity_save_identity(signal_protocol_store_context *context, const signal_protocol_address *address, ec_public_key *identity_key); +int signal_protocol_identity_is_trusted_identity(signal_protocol_store_context *context, const signal_protocol_address *address, ec_public_key *identity_key); + + +/* + * Interface to the sender key store. + * These functions will use the callbacks in the provided + * signal_protocol_store_context instance and operate in terms of higher level + * library data structures. + */ + +int signal_protocol_sender_key_store_key(signal_protocol_store_context *context, const signal_protocol_sender_key_name *sender_key_name, sender_key_record *record); +int signal_protocol_sender_key_load_key(signal_protocol_store_context *context, sender_key_record **record, const signal_protocol_sender_key_name *sender_key_name); + +#ifdef __cplusplus +} +#endif + +#endif /* SIGNAL_PROTOCOL_H */ |