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