aboutsummaryrefslogtreecommitdiff
path: root/include/olm/message.hh
blob: 5ce0a629541bbf68925851e786ffb28eb174fc7a (plain)
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
/* Copyright 2015 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.
 */
#include <cstddef>
#include <cstdint>


namespace olm {

/**
 * The length of the buffer needed to hold a message.
 */
std::size_t encode_message_length(
    std::uint32_t counter,
    std::size_t ratchet_key_length,
    std::size_t ciphertext_length,
    std::size_t mac_length
);


struct MessageWriter {
    std::uint8_t * ratchet_key;
    std::uint8_t * ciphertext;
};


struct MessageReader {
    std::uint8_t version;
    bool has_counter;
    std::uint32_t counter;
    std::uint8_t const * input; std::size_t input_length;
    std::uint8_t const * ratchet_key; std::size_t ratchet_key_length;
    std::uint8_t const * ciphertext; std::size_t ciphertext_length;
};


/**
 * Writes the message headers into the output buffer.
 * Populates the writer struct with pointers into the output buffer.
 */
void encode_message(
    MessageWriter & writer,
    std::uint8_t version,
    std::uint32_t counter,
    std::size_t ratchet_key_length,
    std::size_t ciphertext_length,
    std::uint8_t * output
);


/**
 * Reads the message headers from the input buffer.
 * Populates the reader struct with pointers into the input buffer.
 */
void decode_message(
    MessageReader & reader,
    std::uint8_t const * input, std::size_t input_length,
    std::size_t mac_length
);


struct PreKeyMessageWriter {
    std::uint8_t * identity_key;
    std::uint8_t * base_key;
    std::uint8_t * one_time_key;
    std::uint8_t * message;
};


struct PreKeyMessageReader {
    std::uint8_t version;
    std::uint8_t const * identity_key; std::size_t identity_key_length;
    std::uint8_t const * base_key; std::size_t base_key_length;
    std::uint8_t const * one_time_key; std::size_t one_time_key_length;
    std::uint8_t const * message; std::size_t message_length;
};


/**
 * The length of the buffer needed to hold a message.
 */
std::size_t encode_one_time_key_message_length(
    std::size_t identity_key_length,
    std::size_t base_key_length,
    std::size_t one_time_key_length,
    std::size_t message_length
);


/**
 * Writes the message headers into the output buffer.
 * Populates the writer struct with pointers into the output buffer.
 */
void encode_one_time_key_message(
    PreKeyMessageWriter & writer,
    std::uint8_t version,
    std::size_t identity_key_length,
    std::size_t base_key_length,
    std::size_t one_time_key_length,
    std::size_t message_length,
    std::uint8_t * output
);


/**
 * Reads the message headers from the input buffer.
 * Populates the reader struct with pointers into the input buffer.
 */
void decode_one_time_key_message(
    PreKeyMessageReader & reader,
    std::uint8_t const * input, std::size_t input_length
);


} // namespace olm