src/libpolarssl/dhm.h

   1 /**
   2  * \file dhm.h
   3  *
   4  * \brief Diffie-Hellman-Merkle key exchange
   5  *
   6  *  Copyright (C) 2006-2013, Brainspark B.V.
   7  *
   8  *  This file is part of PolarSSL (http://www.polarssl.org)
   9  *  Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org>
  10  *
  11  *  All rights reserved.
  12  *
  13  *  This program is free software; you can redistribute it and/or modify
  14  *  it under the terms of the GNU General Public License as published by
  15  *  the Free Software Foundation; either version 2 of the License, or
  16  *  (at your option) any later version.
  17  *
  18  *  This program is distributed in the hope that it will be useful,
  19  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  *  GNU General Public License for more details.
  22  *
  23  *  You should have received a copy of the GNU General Public License along
  24  *  with this program; if not, write to the Free Software Foundation, Inc.,
  25  *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  26  */
  27 #ifndef POLARSSL_DHM_H
  28 #define POLARSSL_DHM_H
  29
  30 #include "bignum.h"
  31
  32 /*
  33  * DHM Error codes
  34  */
  35 #define POLARSSL_ERR_DHM_BAD_INPUT_DATA                    -0x3080  /**< Bad input parameters to function. */
  36 #define POLARSSL_ERR_DHM_READ_PARAMS_FAILED                -0x3100  /**< Reading of the DHM parameters failed. */
  37 #define POLARSSL_ERR_DHM_MAKE_PARAMS_FAILED                -0x3180  /**< Making of the DHM parameters failed. */
  38 #define POLARSSL_ERR_DHM_READ_PUBLIC_FAILED                -0x3200  /**< Reading of the public values failed. */
  39 #define POLARSSL_ERR_DHM_MAKE_PUBLIC_FAILED                -0x3280  /**< Making of the public value failed. */
  40 #define POLARSSL_ERR_DHM_CALC_SECRET_FAILED                -0x3300  /**< Calculation of the DHM secret failed. */
  41 #define POLARSSL_ERR_DHM_INVALID_FORMAT                    -0x3380  /**< The ASN.1 data is not formatted correctly. */
  42 #define POLARSSL_ERR_DHM_MALLOC_FAILED                     -0x3400  /**< Allocation of memory failed. */
  43 #define POLARSSL_ERR_DHM_FILE_IO_ERROR                     -0x3480  /**< Read/write of file failed. */
  44
  45 /**
  46  * RFC 3526 defines a number of standardized Diffie-Hellman groups
  47  * for IKE.
  48  * RFC 5114 defines a number of standardized Diffie-Hellman groups
  49  * that can be used.
  50  *
  51  * Some are included here for convenience.
  52  *
  53  * Included are:
  54  *  RFC 3526 3.    2048-bit MODP Group
  55  *  RFC 3526 4.    3072-bit MODP Group
  56  *  RFC 5114 2.1.  1024-bit MODP Group with 160-bit Prime Order Subgroup
  57  *  RFC 5114 2.2.  2048-bit MODP Group with 224-bit Prime Order Subgroup
  58  */
  59 #define POLARSSL_DHM_RFC3526_MODP_2048_P               \
  60     "FFFFFFFFFFFFFFFFC90FDAA22168C234C4C6628B80DC1CD1" \
  61     "29024E088A67CC74020BBEA63B139B22514A08798E3404DD" \
  62     "EF9519B3CD3A431B302B0A6DF25F14374FE1356D6D51C245" \
  63     "E485B576625E7EC6F44C42E9A637ED6B0BFF5CB6F406B7ED" \
  64     "EE386BFB5A899FA5AE9F24117C4B1FE649286651ECE45B3D" \
  65     "C2007CB8A163BF0598DA48361C55D39A69163FA8FD24CF5F" \
  66     "83655D23DCA3AD961C62F356208552BB9ED529077096966D" \
  67     "670C354E4ABC9804F1746C08CA18217C32905E462E36CE3B" \
  68     "E39E772C180E86039B2783A2EC07A28FB5C55DF06F4C52C9" \
  69     "DE2BCBF6955817183995497CEA956AE515D2261898FA0510" \
  70     "15728E5A8AACAA68FFFFFFFFFFFFFFFF"
  71
  72 #define POLARSSL_DHM_RFC3526_MODP_2048_G          "02"
  73
  74 #define POLARSSL_DHM_RFC3526_MODP_3072_P               \
  75     "FFFFFFFFFFFFFFFFC90FDAA22168C234C4C6628B80DC1CD1" \
  76     "29024E088A67CC74020BBEA63B139B22514A08798E3404DD" \
  77     "EF9519B3CD3A431B302B0A6DF25F14374FE1356D6D51C245" \
  78     "E485B576625E7EC6F44C42E9A637ED6B0BFF5CB6F406B7ED" \
  79     "EE386BFB5A899FA5AE9F24117C4B1FE649286651ECE45B3D" \
  80     "C2007CB8A163BF0598DA48361C55D39A69163FA8FD24CF5F" \
  81     "83655D23DCA3AD961C62F356208552BB9ED529077096966D" \
  82     "670C354E4ABC9804F1746C08CA18217C32905E462E36CE3B" \
  83     "E39E772C180E86039B2783A2EC07A28FB5C55DF06F4C52C9" \
  84     "DE2BCBF6955817183995497CEA956AE515D2261898FA0510" \
  85     "15728E5A8AAAC42DAD33170D04507A33A85521ABDF1CBA64" \
  86     "ECFB850458DBEF0A8AEA71575D060C7DB3970F85A6E1E4C7" \
  87     "ABF5AE8CDB0933D71E8C94E04A25619DCEE3D2261AD2EE6B" \
  88     "F12FFA06D98A0864D87602733EC86A64521F2B18177B200C" \
  89     "BBE117577A615D6C770988C0BAD946E208E24FA074E5AB31" \
  90     "43DB5BFCE0FD108E4B82D120A93AD2CAFFFFFFFFFFFFFFFF"
  91
  92 #define POLARSSL_DHM_RFC3526_MODP_3072_G          "02"
  93
  94 #define POLARSSL_DHM_RFC5114_MODP_1024_P               \
  95     "B10B8F96A080E01DDE92DE5EAE5D54EC52C99FBCFB06A3C6" \
  96     "9A6A9DCA52D23B616073E28675A23D189838EF1E2EE652C0" \
  97     "13ECB4AEA906112324975C3CD49B83BFACCBDD7D90C4BD70" \
  98     "98488E9C219A73724EFFD6FAE5644738FAA31A4FF55BCCC0" \
  99     "A151AF5F0DC8B4BD45BF37DF365C1A65E68CFDA76D4DA708" \
 100     "DF1FB2BC2E4A4371"
 101
 102 #define POLARSSL_DHM_RFC5114_MODP_1024_G               \
 103     "A4D1CBD5C3FD34126765A442EFB99905F8104DD258AC507F" \
 104     "D6406CFF14266D31266FEA1E5C41564B777E690F5504F213" \
 105     "160217B4B01B886A5E91547F9E2749F4D7FBD7D3B9A92EE1" \
 106     "909D0D2263F80A76A6A24C087A091F531DBF0A0169B6A28A" \
 107     "D662A4D18E73AFA32D779D5918D08BC8858F4DCEF97C2A24" \
 108     "855E6EEB22B3B2E5"
 109
 110 #define POLARSSL_DHM_RFC5114_MODP_2048_P               \
 111     "AD107E1E9123A9D0D660FAA79559C51FA20D64E5683B9FD1" \
 112     "B54B1597B61D0A75E6FA141DF95A56DBAF9A3C407BA1DF15" \
 113     "EB3D688A309C180E1DE6B85A1274A0A66D3F8152AD6AC212" \
 114     "9037C9EDEFDA4DF8D91E8FEF55B7394B7AD5B7D0B6C12207" \
 115     "C9F98D11ED34DBF6C6BA0B2C8BBC27BE6A00E0A0B9C49708" \
 116     "B3BF8A317091883681286130BC8985DB1602E714415D9330" \
 117     "278273C7DE31EFDC7310F7121FD5A07415987D9ADC0A486D" \
 118     "CDF93ACC44328387315D75E198C641A480CD86A1B9E587E8" \
 119     "BE60E69CC928B2B9C52172E413042E9B23F10B0E16E79763" \
 120     "C9B53DCF4BA80A29E3FB73C16B8E75B97EF363E2FFA31F71" \
 121     "CF9DE5384E71B81C0AC4DFFE0C10E64F"
 122
 123 #define POLARSSL_DHM_RFC5114_MODP_2048_G              \
 124     "AC4032EF4F2D9AE39DF30B5C8FFDAC506CDEBE7B89998CAF"\
 125     "74866A08CFE4FFE3A6824A4E10B9A6F0DD921F01A70C4AFA"\
 126     "AB739D7700C29F52C57DB17C620A8652BE5E9001A8D66AD7"\
 127     "C17669101999024AF4D027275AC1348BB8A762D0521BC98A"\
 128     "E247150422EA1ED409939D54DA7460CDB5F6C6B250717CBE"\
 129     "F180EB34118E98D119529A45D6F834566E3025E316A330EF"\
 130     "BB77A86F0C1AB15B051AE3D428C8F8ACB70A8137150B8EEB"\
 131     "10E183EDD19963DDD9E263E4770589EF6AA21E7F5F2FF381"\
 132     "B539CCE3409D13CD566AFBB48D6C019181E1BCFE94B30269"\
 133     "EDFE72FE9B6AA4BD7B5A0F1C71CFFF4C19C418E1F6EC0179"\
 134     "81BC087F2A7065B384B890D3191F2BFA"
 135
 136 #ifdef __cplusplus
 137 extern "C" {
 138 #endif
 139
 140 /**
 141  * \brief          DHM context structure
 142  */
 143 typedef struct
 144 {
 145     size_t len; /*!<  size(P) in chars  */
 146     mpi P;      /*!<  prime modulus     */
 147     mpi G;      /*!<  generator         */
 148     mpi X;      /*!<  secret value      */
 149     mpi GX;     /*!<  self = G^X mod P  */
 150     mpi GY;     /*!<  peer = G^Y mod P  */
 151     mpi K;      /*!<  key = GY^X mod P  */
 152     mpi RP;     /*!<  cached R^2 mod P  */
 153     mpi Vi;     /*!<  blinding value    */
 154     mpi Vf;     /*!<  un-blinding value */
 155     mpi pX;     /*!<  previous X        */
 156 }
 157 dhm_context;
 158
 159 /**
 160  * \brief          Parse the ServerKeyExchange parameters
 161  *
 162  * \param ctx      DHM context
 163  * \param p        &(start of input buffer)
 164  * \param end      end of buffer
 165  *
 166  * \return         0 if successful, or an POLARSSL_ERR_DHM_XXX error code
 167  */
 168 int dhm_read_params( dhm_context *ctx,
 169                      unsigned char **p,
 170                      const unsigned char *end );
 171
 172 /**
 173  * \brief          Setup and write the ServerKeyExchange parameters
 174  *
 175  * \param ctx      DHM context
 176  * \param x_size   private value size in bytes
 177  * \param output   destination buffer
 178  * \param olen     number of chars written
 179  * \param f_rng    RNG function
 180  * \param p_rng    RNG parameter
 181  *
 182  * \note           This function assumes that ctx->P and ctx->G
 183  *                 have already been properly set (for example
 184  *                 using mpi_read_string or mpi_read_binary).
 185  *
 186  * \return         0 if successful, or an POLARSSL_ERR_DHM_XXX error code
 187  */
 188 int dhm_make_params( dhm_context *ctx, int x_size,
 189                      unsigned char *output, size_t *olen,
 190                      int (*f_rng)(void *, unsigned char *, size_t),
 191                      void *p_rng );
 192
 193 /**
 194  * \brief          Import the peer's public value G^Y
 195  *
 196  * \param ctx      DHM context
 197  * \param input    input buffer
 198  * \param ilen     size of buffer
 199  *
 200  * \return         0 if successful, or an POLARSSL_ERR_DHM_XXX error code
 201  */
 202 int dhm_read_public( dhm_context *ctx,
 203                      const unsigned char *input, size_t ilen );
 204
 205 /**
 206  * \brief          Create own private value X and export G^X
 207  *
 208  * \param ctx      DHM context
 209  * \param x_size   private value size in bytes
 210  * \param output   destination buffer
 211  * \param olen     must be equal to ctx->P.len
 212  * \param f_rng    RNG function
 213  * \param p_rng    RNG parameter
 214  *
 215  * \return         0 if successful, or an POLARSSL_ERR_DHM_XXX error code
 216  */
 217 int dhm_make_public( dhm_context *ctx, int x_size,
 218                      unsigned char *output, size_t olen,
 219                      int (*f_rng)(void *, unsigned char *, size_t),
 220                      void *p_rng );
 221
 222 /**
 223  * \brief          Derive and export the shared secret (G^Y)^X mod P
 224  *
 225  * \param ctx      DHM context
 226  * \param output   destination buffer
 227  * \param olen     number of chars written
 228  * \param f_rng    RNG function, for blinding purposes
 229  * \param p_rng    RNG parameter
 230  *
 231  * \return         0 if successful, or an POLARSSL_ERR_DHM_XXX error code
 232  *
 233  * \note           If non-NULL, f_rng is used to blind the input as
 234  *                 countermeasure against timing attacks. Blinding is
 235  *                 automatically used if and only if our secret value X is
 236  *                 re-used and costs nothing otherwise, so it is recommended
 237  *                 to always pass a non-NULL f_rng argument.
 238  */
 239 int dhm_calc_secret( dhm_context *ctx,
 240                      unsigned char *output, size_t *olen,
 241                      int (*f_rng)(void *, unsigned char *, size_t),
 242                      void *p_rng );
 243
 244 /**
 245  * \brief          Free the components of a DHM key
 246  */
 247 void dhm_free( dhm_context *ctx );
 248
 249 #if defined(POLARSSL_ASN1_PARSE_C)
 250 /** \ingroup x509_module */
 251 /**
 252  * \brief          Parse DHM parameters
 253  *
 254  * \param dhm      DHM context to be initialized
 255  * \param dhmin    input buffer
 256  * \param dhminlen size of the buffer
 257  *
 258  * \return         0 if successful, or a specific DHM or PEM error code
 259  */
 260 int dhm_parse_dhm( dhm_context *dhm, const unsigned char *dhmin,
 261                    size_t dhminlen );
 262
 263 #if defined(POLARSSL_FS_IO)
 264 /** \ingroup x509_module */
 265 /**
 266  * \brief          Load and parse DHM parameters
 267  *
 268  * \param dhm      DHM context to be initialized
 269  * \param path     filename to read the DHM Parameters from
 270  *
 271  * \return         0 if successful, or a specific DHM or PEM error code
 272  */
 273 int dhm_parse_dhmfile( dhm_context *dhm, const char *path );
 274 #endif /* POLARSSL_FS_IO */
 275 #endif /* POLARSSL_ASN1_PARSE_C */
 276
 277 /**
 278  * \brief          Checkup routine
 279  *
 280  * \return         0 if successful, or 1 if the test failed
 281  */
 282 int dhm_self_test( int verbose );
 283
 284 #ifdef __cplusplus
 285 }
 286 #endif
 287
 288 #endif /* dhm.h */