libavformat: add mbedTLS based TLS
[libav.git] / libavformat / rtmpdh.c
1 /*
2 * RTMP Diffie-Hellmann utilities
3 * Copyright (c) 2009 Andrej Stepanchuk
4 * Copyright (c) 2009-2010 Howard Chu
5 * Copyright (c) 2012 Samuel Pitoiset
6 *
7 * This file is part of Libav.
8 *
9 * Libav is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
13 *
14 * Libav is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
18 *
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with Libav; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 */
23
24 /**
25 * @file
26 * RTMP Diffie-Hellmann utilities
27 */
28
29 #include <stdint.h>
30 #include <string.h>
31
32 #include "config.h"
33
34 #include "libavutil/attributes.h"
35 #include "libavutil/error.h"
36 #include "libavutil/mem.h"
37 #include "libavutil/random_seed.h"
38
39 #include "rtmpdh.h"
40
41 #define P1024 \
42 "FFFFFFFFFFFFFFFFC90FDAA22168C234C4C6628B80DC1CD1" \
43 "29024E088A67CC74020BBEA63B139B22514A08798E3404DD" \
44 "EF9519B3CD3A431B302B0A6DF25F14374FE1356D6D51C245" \
45 "E485B576625E7EC6F44C42E9A637ED6B0BFF5CB6F406B7ED" \
46 "EE386BFB5A899FA5AE9F24117C4B1FE649286651ECE65381" \
47 "FFFFFFFFFFFFFFFF"
48
49 #define Q1024 \
50 "7FFFFFFFFFFFFFFFE487ED5110B4611A62633145C06E0E68" \
51 "948127044533E63A0105DF531D89CD9128A5043CC71A026E" \
52 "F7CA8CD9E69D218D98158536F92F8A1BA7F09AB6B6A8E122" \
53 "F242DABB312F3F637A262174D31BF6B585FFAE5B7A035BF6" \
54 "F71C35FDAD44CFD2D74F9208BE258FF324943328F67329C0" \
55 "FFFFFFFFFFFFFFFF"
56
57 #if CONFIG_GMP
58 #define bn_new(bn) \
59 do { \
60 bn = av_malloc(sizeof(*bn)); \
61 if (bn) \
62 mpz_init2(bn, 1); \
63 } while (0)
64 #define bn_free(bn) \
65 do { \
66 mpz_clear(bn); \
67 av_free(bn); \
68 } while (0)
69 #define bn_set_word(bn, w) mpz_set_ui(bn, w)
70 #define bn_cmp(a, b) mpz_cmp(a, b)
71 #define bn_copy(to, from) mpz_set(to, from)
72 #define bn_sub_word(bn, w) mpz_sub_ui(bn, bn, w)
73 #define bn_cmp_1(bn) mpz_cmp_ui(bn, 1)
74 #define bn_num_bytes(bn) (mpz_sizeinbase(bn, 2) + 7) / 8
75 #define bn_bn2bin(bn, buf, len) \
76 do { \
77 memset(buf, 0, len); \
78 if (bn_num_bytes(bn) <= len) \
79 mpz_export(buf, NULL, 1, 1, 0, 0, bn); \
80 } while (0)
81 #define bn_bin2bn(bn, buf, len) \
82 do { \
83 bn_new(bn); \
84 if (bn) \
85 mpz_import(bn, len, 1, 1, 0, 0, buf); \
86 } while (0)
87 #define bn_hex2bn(bn, buf, ret) \
88 do { \
89 bn_new(bn); \
90 if (bn) \
91 ret = (mpz_set_str(bn, buf, 16) == 0); \
92 else \
93 ret = 1; \
94 } while (0)
95 #define bn_random(bn, num_bits) \
96 do { \
97 int bits = num_bits; \
98 mpz_set_ui(bn, 0); \
99 for (bits = num_bits; bits > 0; bits -= 32) { \
100 mpz_mul_2exp(bn, bn, 32); \
101 mpz_add_ui(bn, bn, av_get_random_seed()); \
102 } \
103 mpz_fdiv_r_2exp(bn, bn, num_bits); \
104 } while (0)
105 static int bn_modexp(FFBigNum bn, FFBigNum y, FFBigNum q, FFBigNum p)
106 {
107 mpz_powm(bn, y, q, p);
108 return 0;
109 }
110 #elif CONFIG_OPENSSL
111 #define bn_new(bn) bn = BN_new()
112 #define bn_free(bn) BN_free(bn)
113 #define bn_set_word(bn, w) BN_set_word(bn, w)
114 #define bn_cmp(a, b) BN_cmp(a, b)
115 #define bn_copy(to, from) BN_copy(to, from)
116 #define bn_sub_word(bn, w) BN_sub_word(bn, w)
117 #define bn_cmp_1(bn) BN_cmp(bn, BN_value_one())
118 #define bn_num_bytes(bn) BN_num_bytes(bn)
119 #define bn_bn2bin(bn, buf, len) BN_bn2bin(bn, buf)
120 #define bn_bin2bn(bn, buf, len) bn = BN_bin2bn(buf, len, 0)
121 #define bn_hex2bn(bn, buf, ret) ret = BN_hex2bn(&bn, buf)
122 #define bn_random(bn, num_bits) BN_rand(bn, num_bits, 0, 0)
123 static int bn_modexp(FFBigNum bn, FFBigNum y, FFBigNum q, FFBigNum p)
124 {
125 BN_CTX *ctx = BN_CTX_new();
126 if (!ctx)
127 return AVERROR(ENOMEM);
128 if (!BN_mod_exp(bn, y, q, p, ctx)) {
129 BN_CTX_free(ctx);
130 return AVERROR(EINVAL);
131 }
132 BN_CTX_free(ctx);
133 return 0;
134 }
135 #elif CONFIG_MBEDTLS
136 #define bn_new(bn) \
137 do { \
138 bn = av_malloc(sizeof(*bn)); \
139 if (bn) \
140 mbedtls_mpi_init(bn); \
141 } while (0)
142 #define bn_free(bn) \
143 do { \
144 mbedtls_mpi_free(bn); \
145 av_free(bn); \
146 } while (0)
147 #define bn_set_word(bn, w) mbedtls_mpi_lset(bn, w)
148 #define bn_cmp(a, b) mbedtls_mpi_cmp_mpi(a, b)
149 #define bn_copy(to, from) mbedtls_mpi_copy(to, from)
150 #define bn_sub_word(bn, w) mbedtls_mpi_sub_int(bn, bn, w)
151 #define bn_cmp_1(bn) mbedtls_mpi_cmp_int(bn, 1)
152 #define bn_num_bytes(bn) (mbedtls_mpi_bitlen(bn) + 7) / 8
153 #define bn_bn2bin(bn, buf, len) mbedtls_mpi_write_binary(bn, buf, len)
154 #define bn_bin2bn(bn, buf, len) \
155 do { \
156 bn_new(bn); \
157 if (bn) \
158 mbedtls_mpi_read_binary(bn, buf, len); \
159 } while (0)
160 #define bn_hex2bn(bn, buf, ret) \
161 do { \
162 bn_new(bn); \
163 if (bn) \
164 ret = (mbedtls_mpi_read_string(bn, 16, buf) == 0); \
165 else \
166 ret = 1; \
167 } while (0)
168 #define bn_random(bn, num_bits) \
169 do { \
170 mbedtls_entropy_context entropy_ctx; \
171 mbedtls_ctr_drbg_context ctr_drbg_ctx; \
172 \
173 mbedtls_entropy_init(&entropy_ctx); \
174 mbedtls_ctr_drbg_init(&ctr_drbg_ctx); \
175 mbedtls_ctr_drbg_seed(&ctr_drbg_ctx, \
176 mbedtls_entropy_func, \
177 &entropy_ctx, \
178 NULL, 0); \
179 mbedtls_mpi_fill_random(bn, (num_bits + 7) / 8, mbedtls_ctr_drbg_random, &ctr_drbg_ctx); \
180 mbedtls_ctr_drbg_free(&ctr_drbg_ctx); \
181 mbedtls_entropy_free(&entropy_ctx); \
182 } while (0)
183 #define bn_modexp(bn, y, q, p) mbedtls_mpi_exp_mod(bn, y, q, p, 0)
184
185 #endif
186
187 #define MAX_BYTES 18000
188
189 #define dh_new() av_mallocz(sizeof(FF_DH))
190
191 static FFBigNum dh_generate_key(FF_DH *dh)
192 {
193 int num_bytes;
194
195 num_bytes = bn_num_bytes(dh->p) - 1;
196 if (num_bytes <= 0 || num_bytes > MAX_BYTES)
197 return NULL;
198
199 bn_new(dh->priv_key);
200 if (!dh->priv_key)
201 return NULL;
202 bn_random(dh->priv_key, 8 * num_bytes);
203
204 bn_new(dh->pub_key);
205 if (!dh->pub_key) {
206 bn_free(dh->priv_key);
207 return NULL;
208 }
209
210 if (bn_modexp(dh->pub_key, dh->g, dh->priv_key, dh->p) < 0)
211 return NULL;
212
213 return dh->pub_key;
214 }
215
216 static int dh_compute_key(FF_DH *dh, FFBigNum pub_key_bn,
217 uint32_t secret_key_len, uint8_t *secret_key)
218 {
219 FFBigNum k;
220 int ret;
221
222 bn_new(k);
223 if (!k)
224 return -1;
225
226 if ((ret = bn_modexp(k, pub_key_bn, dh->priv_key, dh->p)) < 0) {
227 bn_free(k);
228 return ret;
229 }
230 bn_bn2bin(k, secret_key, secret_key_len);
231 bn_free(k);
232
233 /* return the length of the shared secret key like DH_compute_key */
234 return secret_key_len;
235 }
236
237 void ff_dh_free(FF_DH *dh)
238 {
239 if (!dh)
240 return;
241 bn_free(dh->p);
242 bn_free(dh->g);
243 bn_free(dh->pub_key);
244 bn_free(dh->priv_key);
245 av_free(dh);
246 }
247
248 static int dh_is_valid_public_key(FFBigNum y, FFBigNum p, FFBigNum q)
249 {
250 FFBigNum bn = NULL;
251 int ret = AVERROR(EINVAL);
252
253 bn_new(bn);
254 if (!bn)
255 return AVERROR(ENOMEM);
256
257 /* y must lie in [2, p - 1] */
258 bn_set_word(bn, 1);
259 if (!bn_cmp(y, bn))
260 goto fail;
261
262 /* bn = p - 2 */
263 bn_copy(bn, p);
264 bn_sub_word(bn, 1);
265 if (!bn_cmp(y, bn))
266 goto fail;
267
268 /* Verify with Sophie-Germain prime
269 *
270 * This is a nice test to make sure the public key position is calculated
271 * correctly. This test will fail in about 50% of the cases if applied to
272 * random data.
273 */
274 /* y must fulfill y^q mod p = 1 */
275 if ((ret = bn_modexp(bn, y, q, p)) < 0)
276 goto fail;
277
278 ret = AVERROR(EINVAL);
279 if (bn_cmp_1(bn))
280 goto fail;
281
282 ret = 0;
283 fail:
284 bn_free(bn);
285
286 return ret;
287 }
288
289 av_cold FF_DH *ff_dh_init(int key_len)
290 {
291 FF_DH *dh;
292 int ret;
293
294 if (!(dh = dh_new()))
295 return NULL;
296
297 bn_new(dh->g);
298 if (!dh->g)
299 goto fail;
300
301 bn_hex2bn(dh->p, P1024, ret);
302 if (!ret)
303 goto fail;
304
305 bn_set_word(dh->g, 2);
306 dh->length = key_len;
307
308 return dh;
309
310 fail:
311 ff_dh_free(dh);
312
313 return NULL;
314 }
315
316 int ff_dh_generate_public_key(FF_DH *dh)
317 {
318 int ret = 0;
319
320 while (!ret) {
321 FFBigNum q1 = NULL;
322
323 if (!dh_generate_key(dh))
324 return AVERROR(EINVAL);
325
326 bn_hex2bn(q1, Q1024, ret);
327 if (!ret)
328 return AVERROR(ENOMEM);
329
330 ret = dh_is_valid_public_key(dh->pub_key, dh->p, q1);
331 bn_free(q1);
332
333 if (!ret) {
334 /* the public key is valid */
335 break;
336 }
337 }
338
339 return ret;
340 }
341
342 int ff_dh_write_public_key(FF_DH *dh, uint8_t *pub_key, int pub_key_len)
343 {
344 int len;
345
346 /* compute the length of the public key */
347 len = bn_num_bytes(dh->pub_key);
348 if (len <= 0 || len > pub_key_len)
349 return AVERROR(EINVAL);
350
351 /* convert the public key value into big-endian form */
352 memset(pub_key, 0, pub_key_len);
353 bn_bn2bin(dh->pub_key, pub_key + pub_key_len - len, len);
354
355 return 0;
356 }
357
358 int ff_dh_compute_shared_secret_key(FF_DH *dh, const uint8_t *pub_key,
359 int pub_key_len, uint8_t *secret_key,
360 int secret_key_len)
361 {
362 FFBigNum q1 = NULL, pub_key_bn = NULL;
363 int ret;
364
365 /* convert the big-endian form of the public key into a bignum */
366 bn_bin2bn(pub_key_bn, pub_key, pub_key_len);
367 if (!pub_key_bn)
368 return AVERROR(ENOMEM);
369
370 /* convert the string containing a hexadecimal number into a bignum */
371 bn_hex2bn(q1, Q1024, ret);
372 if (!ret) {
373 ret = AVERROR(ENOMEM);
374 goto fail;
375 }
376
377 /* when the public key is valid we have to compute the shared secret key */
378 if ((ret = dh_is_valid_public_key(pub_key_bn, dh->p, q1)) < 0) {
379 goto fail;
380 } else if ((ret = dh_compute_key(dh, pub_key_bn, secret_key_len,
381 secret_key)) < 0) {
382 ret = AVERROR(EINVAL);
383 goto fail;
384 }
385
386 fail:
387 bn_free(pub_key_bn);
388 bn_free(q1);
389
390 return ret;
391 }