message.cpp 8.35 KB
Newer Older
Mark Haines's avatar
Mark Haines committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
/* 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.
 */
15
#include "olm/message.hh"
Mark Haines's avatar
Mark Haines committed
16
17
18
19
20
21
22
23

namespace {

template<typename T>
std::size_t varint_length(
    T value
) {
    std::size_t result = 1;
24
    while (value >= 128U) {
Mark Haines's avatar
Mark Haines committed
25
26
27
28
29
30
31
32
33
34
35
36
        ++result;
        value >>= 7;
    }
    return result;
}


template<typename T>
std::uint8_t * varint_encode(
    std::uint8_t * output,
    T value
) {
37
    while (value >= 128U) {
Mark Haines's avatar
Mark Haines committed
38
        *(output++) = (0x7F & value) | 0x80;
39
        value >>= 7;
Mark Haines's avatar
Mark Haines committed
40
41
42
43
44
45
46
47
48
49
50
51
    }
    (*output++) = value;
    return output;
}


template<typename T>
T varint_decode(
    std::uint8_t const * varint_start,
    std::uint8_t const * varint_end
) {
    T value = 0;
52
53
54
    if (varint_end == varint_start) {
        return 0;
    }
Mark Haines's avatar
Mark Haines committed
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
    do {
        value <<= 7;
        value |= 0x7F & *(--varint_end);
    } while (varint_end != varint_start);
    return value;
}


std::uint8_t const * varint_skip(
    std::uint8_t const * input,
    std::uint8_t const * input_end
) {
    while (input != input_end) {
        std::uint8_t tmp = *(input++);
        if ((tmp & 0x80) == 0) {
            return input;
        }
    }
    return input;
}


std::size_t varstring_length(
    std::size_t string_length
) {
    return varint_length(string_length) + string_length;
}

static std::size_t const VERSION_LENGTH = 1;
static std::uint8_t const RATCHET_KEY_TAG = 012;
static std::uint8_t const COUNTER_TAG = 020;
static std::uint8_t const CIPHERTEXT_TAG = 042;

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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
std::uint8_t * encode(
    std::uint8_t * pos,
    std::uint8_t tag,
    std::uint32_t value
) {
    *(pos++) = tag;
    return varint_encode(pos, value);
}

std::uint8_t * encode(
    std::uint8_t * pos,
    std::uint8_t tag,
    std::uint8_t * & value, std::size_t value_length
) {
    *(pos++) = tag;
    pos = varint_encode(pos, value_length);
    value = pos;
    return pos + value_length;
}

std::uint8_t const * decode(
    std::uint8_t const * pos, std::uint8_t const * end,
    std::uint8_t tag,
    std::uint32_t & value, bool & has_value
) {
    if (pos != end && *pos == tag) {
        ++pos;
        std::uint8_t const * value_start = pos;
        pos = varint_skip(pos, end);
        value = varint_decode<std::uint32_t>(value_start, pos);
        has_value = true;
    }
    return pos;
}


std::uint8_t const * decode(
    std::uint8_t const * pos, std::uint8_t const * end,
    std::uint8_t tag,
    std::uint8_t const * & value, std::size_t & value_length
) {
    if (pos != end && *pos == tag) {
        ++pos;
        std::uint8_t const * len_start = pos;
        pos = varint_skip(pos, end);
        std::size_t len = varint_decode<std::size_t>(len_start, pos);
        if (len > end - pos) return end;
        value = pos;
        value_length = len;
        pos += len;
    }
    return pos;
}

std::uint8_t const * skip_unknown(
    std::uint8_t const * pos, std::uint8_t const * end
) {
    if (pos != end) {
        uint8_t tag = *pos;
147
        if ((tag & 0x7) == 0) {
148
149
            pos = varint_skip(pos, end);
            pos = varint_skip(pos, end);
150
        } else if ((tag & 0x7) == 2) {
151
152
153
154
155
156
157
158
159
160
161
162
163
            pos = varint_skip(pos, end);
            std::uint8_t const * len_start = pos;
            pos = varint_skip(pos, end);
            std::size_t len = varint_decode<std::size_t>(len_start, pos);
            if (len > end - pos) return end;
            pos += len;
        } else {
            return end;
        }
    }
    return pos;
}

Mark Haines's avatar
Mark Haines committed
164
165
166
} // namespace


167
std::size_t olm::encode_message_length(
Mark Haines's avatar
Mark Haines committed
168
169
170
171
172
173
174
175
176
    std::uint32_t counter,
    std::size_t ratchet_key_length,
    std::size_t ciphertext_length,
    std::size_t mac_length
) {
    std::size_t length = VERSION_LENGTH;
    length += 1 + varstring_length(ratchet_key_length);
    length += 1 + varint_length(counter);
    length += 1 + varstring_length(ciphertext_length);
177
178
    length += mac_length;
    return length;
Mark Haines's avatar
Mark Haines committed
179
180
181
}


182
183
void olm::encode_message(
    olm::MessageWriter & writer,
Mark Haines's avatar
Mark Haines committed
184
185
186
187
188
189
190
191
    std::uint8_t version,
    std::uint32_t counter,
    std::size_t ratchet_key_length,
    std::size_t ciphertext_length,
    std::uint8_t * output
) {
    std::uint8_t * pos = output;
    *(pos++) = version;
192
193
194
    pos = encode(pos, RATCHET_KEY_TAG, writer.ratchet_key, ratchet_key_length);
    pos = encode(pos, COUNTER_TAG, counter);
    pos = encode(pos, CIPHERTEXT_TAG, writer.ciphertext, ciphertext_length);
Mark Haines's avatar
Mark Haines committed
195
196
197
}


198
199
void olm::decode_message(
    olm::MessageReader & reader,
Mark Haines's avatar
Mark Haines committed
200
201
202
203
204
    std::uint8_t const * input, std::size_t input_length,
    std::size_t mac_length
) {
    std::uint8_t const * pos = input;
    std::uint8_t const * end = input + input_length - mac_length;
205
    std::uint8_t const * unknown = nullptr;
206
207
208
209

    reader.input = input;
    reader.input_length = input_length;
    reader.has_counter = false;
210
    reader.ratchet_key = nullptr;
211
    reader.ratchet_key_length = 0;
212
    reader.ciphertext = nullptr;
213
214
215
216
    reader.ciphertext_length = 0;

    if (pos == end) return;
    reader.version = *(pos++);
217

Mark Haines's avatar
Mark Haines committed
218
    while (pos != end) {
219
220
221
222
223
224
225
226
227
228
229
230
231
        pos = decode(
            pos, end, RATCHET_KEY_TAG,
            reader.ratchet_key, reader.ratchet_key_length
        );
        pos = decode(
            pos, end, COUNTER_TAG,
            reader.counter, reader.has_counter
        );
        pos = decode(
            pos, end, CIPHERTEXT_TAG,
            reader.ciphertext, reader.ciphertext_length
        );
        if (unknown == pos) {
232
            pos = skip_unknown(pos, end);
Mark Haines's avatar
Mark Haines committed
233
        }
234
        unknown = pos;
Mark Haines's avatar
Mark Haines committed
235
    }
236
237
238
239
240
}


namespace {

241
static std::uint8_t const ONE_TIME_KEY_ID_TAG = 012;
242
243
244
245
246
247
248
static std::uint8_t const BASE_KEY_TAG = 022;
static std::uint8_t const IDENTITY_KEY_TAG = 032;
static std::uint8_t const MESSAGE_TAG = 042;

} // namespace


249
std::size_t olm::encode_one_time_key_message_length(
250
    std::size_t one_time_key_length,
251
252
253
254
255
    std::size_t identity_key_length,
    std::size_t base_key_length,
    std::size_t message_length
) {
    std::size_t length = VERSION_LENGTH;
256
    length += 1 + varstring_length(one_time_key_length);
257
258
259
260
261
262
263
    length += 1 + varstring_length(identity_key_length);
    length += 1 + varstring_length(base_key_length);
    length += 1 + varstring_length(message_length);
    return length;
}


264
265
void olm::encode_one_time_key_message(
    olm::PreKeyMessageWriter & writer,
266
267
268
    std::uint8_t version,
    std::size_t identity_key_length,
    std::size_t base_key_length,
269
    std::size_t one_time_key_length,
270
271
272
273
274
    std::size_t message_length,
    std::uint8_t * output
) {
    std::uint8_t * pos = output;
    *(pos++) = version;
275
    pos = encode(pos, ONE_TIME_KEY_ID_TAG, writer.one_time_key, one_time_key_length);
276
277
278
279
280
281
    pos = encode(pos, BASE_KEY_TAG, writer.base_key, base_key_length);
    pos = encode(pos, IDENTITY_KEY_TAG, writer.identity_key, identity_key_length);
    pos = encode(pos, MESSAGE_TAG, writer.message, message_length);
}


282
void olm::decode_one_time_key_message(
283
284
285
286
287
    PreKeyMessageReader & reader,
    std::uint8_t const * input, std::size_t input_length
) {
    std::uint8_t const * pos = input;
    std::uint8_t const * end = input + input_length;
288
    std::uint8_t const * unknown = nullptr;
289

290
    reader.one_time_key = nullptr;
291
    reader.one_time_key_length = 0;
292
    reader.identity_key = nullptr;
293
    reader.identity_key_length = 0;
294
    reader.base_key = nullptr;
295
    reader.base_key_length = 0;
296
    reader.message = nullptr;
297
298
299
300
    reader.message_length = 0;

    if (pos == end) return;
    reader.version = *(pos++);
301
302
303
304

    while (pos != end) {
        pos = decode(
            pos, end, ONE_TIME_KEY_ID_TAG,
305
            reader.one_time_key, reader.one_time_key_length
306
307
308
309
310
311
312
313
314
315
316
317
318
319
        );
        pos = decode(
            pos, end, BASE_KEY_TAG,
            reader.base_key, reader.base_key_length
        );
        pos = decode(
            pos, end, IDENTITY_KEY_TAG,
            reader.identity_key, reader.identity_key_length
        );
        pos = decode(
            pos, end, MESSAGE_TAG,
            reader.message, reader.message_length
        );
        if (unknown == pos) {
320
            pos = skip_unknown(pos, end);
321
322
        }
        unknown = pos;
Mark Haines's avatar
Mark Haines committed
323
324
    }
}