rtmpdh: Make sure ret is initialized in the nettle version of bn_hex2bn
[ffmpeg.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 "config.h"
30 #include "rtmpdh.h"
31 #include "libavutil/random_seed.h"
32
33 #define P1024                                          \
34     "FFFFFFFFFFFFFFFFC90FDAA22168C234C4C6628B80DC1CD1" \
35     "29024E088A67CC74020BBEA63B139B22514A08798E3404DD" \
36     "EF9519B3CD3A431B302B0A6DF25F14374FE1356D6D51C245" \
37     "E485B576625E7EC6F44C42E9A637ED6B0BFF5CB6F406B7ED" \
38     "EE386BFB5A899FA5AE9F24117C4B1FE649286651ECE65381" \
39     "FFFFFFFFFFFFFFFF"
40
41 #define Q1024                                          \
42     "7FFFFFFFFFFFFFFFE487ED5110B4611A62633145C06E0E68" \
43     "948127044533E63A0105DF531D89CD9128A5043CC71A026E" \
44     "F7CA8CD9E69D218D98158536F92F8A1BA7F09AB6B6A8E122" \
45     "F242DABB312F3F637A262174D31BF6B585FFAE5B7A035BF6" \
46     "F71C35FDAD44CFD2D74F9208BE258FF324943328F67329C0" \
47     "FFFFFFFFFFFFFFFF"
48
49 #if CONFIG_NETTLE || CONFIG_GCRYPT
50 #if CONFIG_NETTLE
51 #define bn_new(bn)                      \
52     do {                                \
53         bn = av_malloc(sizeof(*bn));    \
54         if (bn)                         \
55             mpz_init2(bn, 1);           \
56     } while (0)
57 #define bn_free(bn)     \
58     do {                \
59         mpz_clear(bn);  \
60         av_free(bn);    \
61     } while (0)
62 #define bn_set_word(bn, w)          mpz_set_ui(bn, w)
63 #define bn_cmp(a, b)                mpz_cmp(a, b)
64 #define bn_copy(to, from)           mpz_set(to, from)
65 #define bn_sub_word(bn, w)          mpz_sub_ui(bn, bn, w)
66 #define bn_cmp_1(bn)                mpz_cmp_ui(bn, 1)
67 #define bn_num_bytes(bn)            (mpz_sizeinbase(bn, 2) + 7) / 8
68 #define bn_bn2bin(bn, buf, len)     nettle_mpz_get_str_256(len, buf, bn)
69 #define bn_bin2bn(bn, buf, len)                     \
70     do {                                            \
71         bn_new(bn);                                 \
72         if (bn)                                     \
73             nettle_mpz_set_str_256_u(bn, len, buf); \
74     } while (0)
75 #define bn_hex2bn(bn, buf, ret)                     \
76     do {                                            \
77         bn_new(bn);                                 \
78         if (bn)                                     \
79             ret = (mpz_set_str(bn, buf, 16) == 0);  \
80         else                                        \
81             ret = 1;                                \
82     } while (0)
83 #define bn_modexp(bn, y, q, p)      mpz_powm(bn, y, q, p)
84 #define bn_random(bn, num_bytes)                    \
85     do {                                            \
86         gmp_randstate_t rs;                         \
87         gmp_randinit_mt(rs);                        \
88         gmp_randseed_ui(rs, av_get_random_seed());  \
89         mpz_urandomb(bn, rs, num_bytes);            \
90         gmp_randclear(rs);                          \
91     } while (0)
92 #elif CONFIG_GCRYPT
93 #define bn_new(bn)                  bn = gcry_mpi_new(1)
94 #define bn_free(bn)                 gcry_mpi_release(bn)
95 #define bn_set_word(bn, w)          gcry_mpi_set_ui(bn, w)
96 #define bn_cmp(a, b)                gcry_mpi_cmp(a, b)
97 #define bn_copy(to, from)           gcry_mpi_set(to, from)
98 #define bn_sub_word(bn, w)          gcry_mpi_sub_ui(bn, bn, w)
99 #define bn_cmp_1(bn)                gcry_mpi_cmp_ui(bn, 1)
100 #define bn_num_bytes(bn)            (gcry_mpi_get_nbits(bn) + 7) / 8
101 #define bn_bn2bin(bn, buf, len)     gcry_mpi_print(GCRYMPI_FMT_USG, buf, len, NULL, bn)
102 #define bn_bin2bn(bn, buf, len)     gcry_mpi_scan(&bn, GCRYMPI_FMT_USG, buf, len, NULL)
103 #define bn_hex2bn(bn, buf, ret)     ret = (gcry_mpi_scan(&bn, GCRYMPI_FMT_HEX, buf, 0, 0) == 0)
104 #define bn_modexp(bn, y, q, p)      gcry_mpi_powm(bn, y, q, p)
105 #define bn_random(bn, num_bytes)    gcry_mpi_randomize(bn, num_bytes, GCRY_WEAK_RANDOM)
106 #endif
107
108 #define MAX_BYTES 18000
109
110 #define dh_new()                    av_malloc(sizeof(FF_DH))
111
112 static FFBigNum dh_generate_key(FF_DH *dh)
113 {
114     int num_bytes;
115
116     num_bytes = bn_num_bytes(dh->p) - 1;
117     if (num_bytes <= 0 || num_bytes > MAX_BYTES)
118         return NULL;
119
120     bn_new(dh->priv_key);
121     if (!dh->priv_key)
122         return NULL;
123     bn_random(dh->priv_key, num_bytes);
124
125     bn_new(dh->pub_key);
126     if (!dh->pub_key) {
127         bn_free(dh->priv_key);
128         return NULL;
129     }
130
131     bn_modexp(dh->pub_key, dh->g, dh->priv_key, dh->p);
132
133     return dh->pub_key;
134 }
135
136 static int dh_compute_key(FF_DH *dh, FFBigNum pub_key_bn,
137                           uint32_t pub_key_len, uint8_t *secret_key)
138 {
139     FFBigNum k;
140     int num_bytes;
141
142     num_bytes = bn_num_bytes(dh->p);
143     if (num_bytes <= 0 || num_bytes > MAX_BYTES)
144         return -1;
145
146     bn_new(k);
147     if (!k)
148         return -1;
149
150     bn_modexp(k, pub_key_bn, dh->priv_key, dh->p);
151     bn_bn2bin(k, secret_key, pub_key_len);
152     bn_free(k);
153
154     /* return the length of the shared secret key like DH_compute_key */
155     return pub_key_len;
156 }
157
158 void ff_dh_free(FF_DH *dh)
159 {
160     bn_free(dh->p);
161     bn_free(dh->g);
162     bn_free(dh->pub_key);
163     bn_free(dh->priv_key);
164     av_free(dh);
165 }
166 #elif CONFIG_OPENSSL
167 #define bn_new(bn)                  bn = BN_new()
168 #define bn_free(bn)                 BN_free(bn)
169 #define bn_set_word(bn, w)          BN_set_word(bn, w)
170 #define bn_cmp(a, b)                BN_cmp(a, b)
171 #define bn_copy(to, from)           BN_copy(to, from)
172 #define bn_sub_word(bn, w)          BN_sub_word(bn, w)
173 #define bn_cmp_1(bn)                BN_cmp(bn, BN_value_one())
174 #define bn_num_bytes(bn)            BN_num_bytes(bn)
175 #define bn_bn2bin(bn, buf, len)     BN_bn2bin(bn, buf)
176 #define bn_bin2bn(bn, buf, len)     bn = BN_bin2bn(buf, len, 0)
177 #define bn_hex2bn(bn, buf, ret)     ret = BN_hex2bn(&bn, buf)
178 #define bn_modexp(bn, y, q, p)               \
179     do {                                     \
180         BN_CTX *ctx = BN_CTX_new();          \
181         if (!ctx)                            \
182             return AVERROR(ENOMEM);          \
183         if (!BN_mod_exp(bn, y, q, p, ctx)) { \
184             BN_CTX_free(ctx);                \
185             return AVERROR(EINVAL);          \
186         }                                    \
187         BN_CTX_free(ctx);                    \
188     } while (0)
189
190 #define dh_new()                                DH_new()
191 #define dh_generate_key(dh)                     DH_generate_key(dh)
192 #define dh_compute_key(dh, pub, len, secret)    DH_compute_key(secret, pub, dh)
193
194 void ff_dh_free(FF_DH *dh)
195 {
196     DH_free(dh);
197 }
198 #endif
199
200 static int dh_is_valid_public_key(FFBigNum y, FFBigNum p, FFBigNum q)
201 {
202     FFBigNum bn = NULL;
203     int ret = AVERROR(EINVAL);
204
205     bn_new(bn);
206     if (!bn)
207         return AVERROR(ENOMEM);
208
209     /* y must lie in [2, p - 1] */
210     bn_set_word(bn, 1);
211     if (!bn_cmp(y, bn))
212         goto fail;
213
214     /* bn = p - 2 */
215     bn_copy(bn, p);
216     bn_sub_word(bn, 1);
217     if (!bn_cmp(y, bn))
218         goto fail;
219
220     /* Verify with Sophie-Germain prime
221      *
222      * This is a nice test to make sure the public key position is calculated
223      * correctly. This test will fail in about 50% of the cases if applied to
224      * random data.
225      */
226     /* y must fulfill y^q mod p = 1 */
227     bn_modexp(bn, y, q, p);
228
229     if (bn_cmp_1(bn))
230         goto fail;
231
232     ret = 0;
233 fail:
234     bn_free(bn);
235
236     return ret;
237 }
238
239 av_cold FF_DH *ff_dh_init(int key_len)
240 {
241     FF_DH *dh;
242     int ret;
243
244     if (!(dh = dh_new()))
245         return NULL;
246
247     bn_new(dh->g);
248     if (!dh->g)
249         goto fail;
250
251     bn_hex2bn(dh->p, P1024, ret);
252     if (!ret)
253         goto fail;
254
255     bn_set_word(dh->g, 2);
256     dh->length = key_len;
257
258     return dh;
259
260 fail:
261     ff_dh_free(dh);
262
263     return NULL;
264 }
265
266 int ff_dh_generate_public_key(FF_DH *dh)
267 {
268     int ret = 0;
269
270     while (!ret) {
271         FFBigNum q1 = NULL;
272
273         if (!dh_generate_key(dh))
274             return AVERROR(EINVAL);
275
276         bn_hex2bn(q1, Q1024, ret);
277         if (!ret)
278             return AVERROR(ENOMEM);
279
280         ret = dh_is_valid_public_key(dh->pub_key, dh->p, q1);
281         bn_free(q1);
282
283         if (!ret) {
284             /* the public key is valid */
285             break;
286         }
287     }
288
289     return ret;
290 }
291
292 int ff_dh_write_public_key(FF_DH *dh, uint8_t *pub_key, int pub_key_len)
293 {
294     int len;
295
296     /* compute the length of the public key */
297     len = bn_num_bytes(dh->pub_key);
298     if (len <= 0 || len > pub_key_len)
299         return AVERROR(EINVAL);
300
301     /* convert the public key value into big-endian form */
302     memset(pub_key, 0, pub_key_len);
303     bn_bn2bin(dh->pub_key, pub_key + pub_key_len - len, len);
304
305     return 0;
306 }
307
308 int ff_dh_compute_shared_secret_key(FF_DH *dh, const uint8_t *pub_key,
309                                     int pub_key_len, uint8_t *secret_key)
310 {
311     FFBigNum q1 = NULL, pub_key_bn = NULL;
312     int ret;
313
314     /* convert the big-endian form of the public key into a bignum */
315     bn_bin2bn(pub_key_bn, pub_key, pub_key_len);
316     if (!pub_key_bn)
317         return AVERROR(ENOMEM);
318
319     /* convert the string containing a hexadecimal number into a bignum */
320     bn_hex2bn(q1, Q1024, ret);
321     if (!ret) {
322         ret = AVERROR(ENOMEM);
323         goto fail;
324     }
325
326     /* when the public key is valid we have to compute the shared secret key */
327     if ((ret = dh_is_valid_public_key(pub_key_bn, dh->p, q1)) < 0) {
328         goto fail;
329     } else if ((ret = dh_compute_key(dh, pub_key_bn, pub_key_len,
330                                      secret_key)) < 0) {
331         ret = AVERROR(EINVAL);
332         goto fail;
333     }
334
335 fail:
336     bn_free(pub_key_bn);
337     bn_free(q1);
338
339     return ret;
340 }
341