message.h 2.32 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
/* Copyright 2016 OpenMarket Ltd
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * functions for encoding and decoding messages in the Olm protocol.
 *
 * Some of these functions have only C++ bindings, and are declared in
 * message.hh; in time, they should probably be converted to plain C and
 * declared here.
 */

#ifndef OLM_MESSAGE_H_
#define OLM_MESSAGE_H_

#include <stdint.h>
#include <stddef.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
 * The length of the buffer needed to hold a group message.
 */
size_t _olm_encode_group_message_length(
    uint32_t chain_index,
    size_t ciphertext_length,
    size_t mac_length
);

/**
 * Writes the message headers into the output buffer.
 *
 * version:            version number of the olm protocol
47
 * message_index:      message index
48
49
50
51
52
 * ciphertext_length:  length of the ciphertext
 * output:             where to write the output. Should be at least
 *                     olm_encode_group_message_length() bytes long.
 * ciphertext_ptr:     returns the address that the ciphertext
 *                     should be written to, followed by the MAC.
53
54
 *
 * Returns the size of the message, up to the MAC.
55
 */
56
size_t _olm_encode_group_message(
57
    uint8_t version,
58
    uint32_t message_index,
59
60
61
62
63
64
    size_t ciphertext_length,
    uint8_t *output,
    uint8_t **ciphertext_ptr
);


65
66
struct _OlmDecodeGroupMessageResults {
    uint8_t version;
67
68
    uint32_t message_index;
    int has_message_index;
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
    const uint8_t *ciphertext;
    size_t ciphertext_length;
};


/**
 * Reads the message headers from the input buffer.
 */
void _olm_decode_group_message(
    const uint8_t *input, size_t input_length,
    size_t mac_length,

    /* output structure: updated with results */
    struct _OlmDecodeGroupMessageResults *results
);



87
88
89
90
91
#ifdef __cplusplus
} // extern "C"
#endif

#endif /* OLM_MESSAGE_H_ */