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