crypto/dh/dh.h

   1 /* crypto/dh/dh.h */
   2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   3  * All rights reserved.
   4  *
   5  * This package is an SSL implementation written
   6  * by Eric Young (eay@cryptsoft.com).
   7  * The implementation was written so as to conform with Netscapes SSL.
   8  *
   9  * This library is free for commercial and non-commercial use as long as
  10  * the following conditions are aheared to.  The following conditions
  11  * apply to all code found in this distribution, be it the RC4, RSA,
  12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  13  * included with this distribution is covered by the same copyright terms
  14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  15  *
  16  * Copyright remains Eric Young's, and as such any Copyright notices in
  17  * the code are not to be removed.
  18  * If this package is used in a product, Eric Young should be given attribution
  19  * as the author of the parts of the library used.
  20  * This can be in the form of a textual message at program startup or
  21  * in documentation (online or textual) provided with the package.
  22  *
  23  * Redistribution and use in source and binary forms, with or without
  24  * modification, are permitted provided that the following conditions
  25  * are met:
  26  * 1. Redistributions of source code must retain the copyright
  27  *    notice, this list of conditions and the following disclaimer.
  28  * 2. Redistributions in binary form must reproduce the above copyright
  29  *    notice, this list of conditions and the following disclaimer in the
  30  *    documentation and/or other materials provided with the distribution.
  31  * 3. All advertising materials mentioning features or use of this software
  32  *    must display the following acknowledgement:
  33  *    "This product includes cryptographic software written by
  34  *     Eric Young (eay@cryptsoft.com)"
  35  *    The word 'cryptographic' can be left out if the rouines from the library
  36  *    being used are not cryptographic related :-).
  37  * 4. If you include any Windows specific code (or a derivative thereof) from
  38  *    the apps directory (application code) you must include an acknowledgement:
  39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  40  *
  41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  51  * SUCH DAMAGE.
  52  *
  53  * The licence and distribution terms for any publically available version or
  54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  55  * copied and put under another distribution licence
  56  * [including the GNU Public Licence.]
  57  */
  58
  59 #ifndef HEADER_DH_H
  60 #define HEADER_DH_H
  61
  62 #include <openssl/e_os2.h>
  63
  64 #ifdef OPENSSL_NO_DH
  65 #error DH is disabled.
  66 #endif
  67
  68 #ifndef OPENSSL_NO_BIO
  69 #include <openssl/bio.h>
  70 #endif
  71 #include <openssl/ossl_typ.h>
  72 #ifndef OPENSSL_NO_DEPRECATED
  73 #include <openssl/bn.h>
  74 #endif
  75
  76 #ifndef OPENSSL_DH_MAX_MODULUS_BITS
  77 # define OPENSSL_DH_MAX_MODULUS_BITS    10000
  78 #endif
  79
  80 #define DH_FLAG_CACHE_MONT_P     0x01
  81 #define DH_FLAG_NO_EXP_CONSTTIME 0x02 /* new with 0.9.7h; the built-in DH
  82                                        * implementation now uses constant time
  83                                        * modular exponentiation for secret exponents
  84                                        * by default. This flag causes the
  85                                        * faster variable sliding window method to
  86                                        * be used for all exponents.
  87                                        */
  88
  89 /* If this flag is set the DH method is FIPS compliant and can be used
  90  * in FIPS mode. This is set in the validated module method. If an
  91  * application sets this flag in its own methods it is its reposibility
  92  * to ensure the result is compliant.
  93  */
  94
  95 #define DH_FLAG_FIPS_METHOD                     0x0400
  96
  97 /* If this flag is set the operations normally disabled in FIPS mode are
  98  * permitted it is then the applications responsibility to ensure that the
  99  * usage is compliant.
 100  */
 101
 102 #define DH_FLAG_NON_FIPS_ALLOW                  0x0400
 103
 104 #ifdef  __cplusplus
 105 extern "C" {
 106 #endif
 107
 108 /* Already defined in ossl_typ.h */
 109 /* typedef struct dh_st DH; */
 110 /* typedef struct dh_method DH_METHOD; */
 111
 112 struct dh_method
 113         {
 114         const char *name;
 115         /* Methods here */
 116         int (*generate_key)(DH *dh);
 117         int (*compute_key)(unsigned char *key,const BIGNUM *pub_key,DH *dh);
 118
 119         /* Can be null */
 120         int (*bn_mod_exp)(const DH *dh, BIGNUM *r, const BIGNUM *a,
 121                                 const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
 122                                 BN_MONT_CTX *m_ctx);
 123
 124         int (*init)(DH *dh);
 125         int (*finish)(DH *dh);
 126         int flags;
 127         char *app_data;
 128         /* If this is non-NULL, it will be used to generate parameters */
 129         int (*generate_params)(DH *dh, int prime_len, int generator, BN_GENCB *cb);
 130         };
 131
 132 struct dh_st
 133         {
 134         /* This first argument is used to pick up errors when
 135          * a DH is passed instead of a EVP_PKEY */
 136         int pad;
 137         int version;
 138         BIGNUM *p;
 139         BIGNUM *g;
 140         long length; /* optional */
 141         BIGNUM *pub_key;        /* g^x */
 142         BIGNUM *priv_key;       /* x */
 143
 144         int flags;
 145         BN_MONT_CTX *method_mont_p;
 146         /* Place holders if we want to do X9.42 DH */
 147         BIGNUM *q;
 148         BIGNUM *j;
 149         unsigned char *seed;
 150         int seedlen;
 151         BIGNUM *counter;
 152
 153         int references;
 154         CRYPTO_EX_DATA ex_data;
 155         const DH_METHOD *meth;
 156         ENGINE *engine;
 157         };
 158
 159 #define DH_GENERATOR_2          2
 160 /* #define DH_GENERATOR_3       3 */
 161 #define DH_GENERATOR_5          5
 162
 163 /* DH_check error codes */
 164 #define DH_CHECK_P_NOT_PRIME            0x01
 165 #define DH_CHECK_P_NOT_SAFE_PRIME       0x02
 166 #define DH_UNABLE_TO_CHECK_GENERATOR    0x04
 167 #define DH_NOT_SUITABLE_GENERATOR       0x08
 168 #define DH_CHECK_Q_NOT_PRIME            0x10
 169 #define DH_CHECK_INVALID_Q_VALUE        0x20
 170 #define DH_CHECK_INVALID_J_VALUE        0x40
 171
 172 /* DH_check_pub_key error codes */
 173 #define DH_CHECK_PUBKEY_TOO_SMALL       0x01
 174 #define DH_CHECK_PUBKEY_TOO_LARGE       0x02
 175
 176 /* primes p where (p-1)/2 is prime too are called "safe"; we define
 177    this for backward compatibility: */
 178 #define DH_CHECK_P_NOT_STRONG_PRIME     DH_CHECK_P_NOT_SAFE_PRIME
 179
 180 #define d2i_DHparams_fp(fp,x) (DH *)ASN1_d2i_fp((char *(*)())DH_new, \
 181                 (char *(*)())d2i_DHparams,(fp),(unsigned char **)(x))
 182 #define i2d_DHparams_fp(fp,x) ASN1_i2d_fp(i2d_DHparams,(fp), \
 183                 (unsigned char *)(x))
 184 #define d2i_DHparams_bio(bp,x) ASN1_d2i_bio_of(DH,DH_new,d2i_DHparams,bp,x)
 185 #define i2d_DHparams_bio(bp,x) ASN1_i2d_bio_of_const(DH,i2d_DHparams,bp,x)
 186
 187 DH *DHparams_dup(DH *);
 188
 189 const DH_METHOD *DH_OpenSSL(void);
 190
 191 void DH_set_default_method(const DH_METHOD *meth);
 192 const DH_METHOD *DH_get_default_method(void);
 193 int DH_set_method(DH *dh, const DH_METHOD *meth);
 194 DH *DH_new_method(ENGINE *engine);
 195
 196 DH *    DH_new(void);
 197 void    DH_free(DH *dh);
 198 int     DH_up_ref(DH *dh);
 199 int     DH_size(const DH *dh);
 200 int DH_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
 201              CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
 202 int DH_set_ex_data(DH *d, int idx, void *arg);
 203 void *DH_get_ex_data(DH *d, int idx);
 204
 205 /* Deprecated version */
 206 #ifndef OPENSSL_NO_DEPRECATED
 207 DH *    DH_generate_parameters(int prime_len,int generator,
 208                 void (*callback)(int,int,void *),void *cb_arg);
 209 #endif /* !defined(OPENSSL_NO_DEPRECATED) */
 210
 211 /* New version */
 212 int     DH_generate_parameters_ex(DH *dh, int prime_len,int generator, BN_GENCB *cb);
 213
 214 int     DH_check(const DH *dh,int *codes);
 215 int     DH_check_pub_key(const DH *dh,const BIGNUM *pub_key, int *codes);
 216 int     DH_generate_key(DH *dh);
 217 int     DH_compute_key(unsigned char *key,const BIGNUM *pub_key,DH *dh);
 218 int     DH_compute_key_padded(unsigned char *key,const BIGNUM *pub_key,DH *dh);
 219 DH *    d2i_DHparams(DH **a,const unsigned char **pp, long length);
 220 int     i2d_DHparams(const DH *a,unsigned char **pp);
 221 DH *    d2i_DHxparams(DH **a,const unsigned char **pp, long length);
 222 int     i2d_DHxparams(const DH *a,unsigned char **pp);
 223 #ifndef OPENSSL_NO_FP_API
 224 int     DHparams_print_fp(FILE *fp, const DH *x);
 225 #endif
 226 #ifndef OPENSSL_NO_BIO
 227 int     DHparams_print(BIO *bp, const DH *x);
 228 #else
 229 int     DHparams_print(char *bp, const DH *x);
 230 #endif
 231
 232 /* RFC 5114 parameters */
 233 DH *DH_get_1024_160(void);
 234 DH *DH_get_2048_224(void);
 235 DH *DH_get_2048_256(void);
 236
 237 /* RFC2631 KDF */
 238 int DH_KDF_X9_42(unsigned char *out, size_t outlen,
 239                 const unsigned char *Z, size_t Zlen,
 240                 ASN1_OBJECT *key_oid,
 241                 const unsigned char *ukm, size_t ukmlen,
 242                 const EVP_MD *md);
 243
 244 #define EVP_PKEY_CTX_set_dh_paramgen_prime_len(ctx, len) \
 245         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
 246                         EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN, len, NULL)
 247
 248 #define EVP_PKEY_CTX_set_dh_paramgen_subprime_len(ctx, len) \
 249         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
 250                         EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN, len, NULL)
 251
 252 #define EVP_PKEY_CTX_set_dh_paramgen_type(ctx, typ) \
 253         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
 254                         EVP_PKEY_CTRL_DH_PARAMGEN_TYPE, typ, NULL)
 255
 256 #define EVP_PKEY_CTX_set_dh_paramgen_generator(ctx, gen) \
 257         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
 258                         EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR, gen, NULL)
 259
 260 #define EVP_PKEY_CTX_set_dh_rfc5114(ctx, gen) \
 261         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, EVP_PKEY_OP_PARAMGEN, \
 262                         EVP_PKEY_CTRL_DH_RFC5114, gen, NULL)
 263
 264 #define EVP_PKEY_CTX_set_dhx_rfc5114(ctx, gen) \
 265         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, EVP_PKEY_OP_PARAMGEN, \
 266                         EVP_PKEY_CTRL_DH_RFC5114, gen, NULL)
 267
 268 #define EVP_PKEY_CTX_set_dh_kdf_type(ctx, kdf) \
 269         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
 270                                 EVP_PKEY_OP_DERIVE, \
 271                                 EVP_PKEY_CTRL_DH_KDF_TYPE, kdf, NULL)
 272
 273 #define EVP_PKEY_CTX_get_dh_kdf_type(ctx) \
 274         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
 275                                 EVP_PKEY_OP_DERIVE, \
 276                                 EVP_PKEY_CTRL_DH_KDF_TYPE, -2, NULL)
 277
 278 #define EVP_PKEY_CTX_set0_dh_kdf_oid(ctx, oid) \
 279         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
 280                                 EVP_PKEY_OP_DERIVE, \
 281                                 EVP_PKEY_CTRL_DH_KDF_OID, 0, (void *)oid)
 282
 283 #define EVP_PKEY_CTX_get0_dh_kdf_oid(ctx, poid) \
 284         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
 285                                 EVP_PKEY_OP_DERIVE, \
 286                                 EVP_PKEY_CTRL_GET_DH_KDF_OID, 0, (void *)poid)
 287
 288 #define EVP_PKEY_CTX_set_dh_kdf_md(ctx, md) \
 289         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
 290                                 EVP_PKEY_OP_DERIVE, \
 291                                 EVP_PKEY_CTRL_DH_KDF_MD, 0, (void *)md)
 292
 293 #define EVP_PKEY_CTX_get_dh_kdf_md(ctx, pmd) \
 294         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
 295                                 EVP_PKEY_OP_DERIVE, \
 296                                 EVP_PKEY_CTRL_GET_DH_KDF_MD, 0, (void *)pmd)
 297
 298 #define EVP_PKEY_CTX_set_dh_kdf_outlen(ctx, len) \
 299         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
 300                                 EVP_PKEY_OP_DERIVE, \
 301                                 EVP_PKEY_CTRL_DH_KDF_OUTLEN, len, NULL)
 302
 303 #define EVP_PKEY_CTX_get_dh_kdf_outlen(ctx, plen) \
 304         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
 305                                 EVP_PKEY_OP_DERIVE, \
 306                         EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN, 0, (void *)plen)
 307
 308 #define EVP_PKEY_CTX_set0_dh_kdf_ukm(ctx, p, plen) \
 309         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
 310                                 EVP_PKEY_OP_DERIVE, \
 311                                 EVP_PKEY_CTRL_DH_KDF_UKM, plen, (void *)p)
 312
 313 #define EVP_PKEY_CTX_get0_dh_kdf_ukm(ctx, p) \
 314         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
 315                                 EVP_PKEY_OP_DERIVE, \
 316                                 EVP_PKEY_CTRL_GET_DH_KDF_UKM, 0, (void *)p)
 317
 318 #define EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN     (EVP_PKEY_ALG_CTRL + 1)
 319 #define EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR     (EVP_PKEY_ALG_CTRL + 2)
 320 #define EVP_PKEY_CTRL_DH_RFC5114                (EVP_PKEY_ALG_CTRL + 3)
 321 #define EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN  (EVP_PKEY_ALG_CTRL + 4)
 322 #define EVP_PKEY_CTRL_DH_PARAMGEN_TYPE          (EVP_PKEY_ALG_CTRL + 5)
 323 #define EVP_PKEY_CTRL_DH_KDF_TYPE               (EVP_PKEY_ALG_CTRL + 6)
 324 #define EVP_PKEY_CTRL_DH_KDF_MD                 (EVP_PKEY_ALG_CTRL + 7)
 325 #define EVP_PKEY_CTRL_GET_DH_KDF_MD             (EVP_PKEY_ALG_CTRL + 8)
 326 #define EVP_PKEY_CTRL_DH_KDF_OUTLEN             (EVP_PKEY_ALG_CTRL + 9)
 327 #define EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN         (EVP_PKEY_ALG_CTRL + 10)
 328 #define EVP_PKEY_CTRL_DH_KDF_UKM                (EVP_PKEY_ALG_CTRL + 11)
 329 #define EVP_PKEY_CTRL_GET_DH_KDF_UKM            (EVP_PKEY_ALG_CTRL + 12)
 330 #define EVP_PKEY_CTRL_DH_KDF_OID                (EVP_PKEY_ALG_CTRL + 13)
 331 #define EVP_PKEY_CTRL_GET_DH_KDF_OID            (EVP_PKEY_ALG_CTRL + 14)
 332
 333 /* KDF types */
 334 #define EVP_PKEY_DH_KDF_NONE                            1
 335 #define EVP_PKEY_DH_KDF_X9_42                           2
 336
 337 /* BEGIN ERROR CODES */
 338 /* The following lines are auto generated by the script mkerr.pl. Any changes
 339  * made after this point may be overwritten when the script is next run.
 340  */
 341 void ERR_load_DH_strings(void);
 342
 343 /* Error codes for the DH functions. */
 344
 345 /* Function codes. */
 346 #define DH_F_COMPUTE_KEY                                 102
 347 #define DH_F_DHPARAMS_PRINT_FP                           101
 348 #define DH_F_DH_BUILTIN_GENPARAMS                        106
 349 #define DH_F_DH_CMS_DECRYPT                              117
 350 #define DH_F_DH_CMS_SET_PEERKEY                          118
 351 #define DH_F_DH_CMS_SET_SHARED_INFO                      119
 352 #define DH_F_DH_COMPUTE_KEY                              114
 353 #define DH_F_DH_GENERATE_KEY                             115
 354 #define DH_F_DH_GENERATE_PARAMETERS_EX                   116
 355 #define DH_F_DH_NEW_METHOD                               105
 356 #define DH_F_DH_PARAM_DECODE                             107
 357 #define DH_F_DH_PRIV_DECODE                              110
 358 #define DH_F_DH_PRIV_ENCODE                              111
 359 #define DH_F_DH_PUB_DECODE                               108
 360 #define DH_F_DH_PUB_ENCODE                               109
 361 #define DH_F_DO_DH_PRINT                                 100
 362 #define DH_F_GENERATE_KEY                                103
 363 #define DH_F_GENERATE_PARAMETERS                         104
 364 #define DH_F_PKEY_DH_DERIVE                              112
 365 #define DH_F_PKEY_DH_KEYGEN                              113
 366
 367 /* Reason codes. */
 368 #define DH_R_BAD_GENERATOR                               101
 369 #define DH_R_BN_DECODE_ERROR                             109
 370 #define DH_R_BN_ERROR                                    106
 371 #define DH_R_DECODE_ERROR                                104
 372 #define DH_R_INVALID_PUBKEY                              102
 373 #define DH_R_KDF_PARAMETER_ERROR                         112
 374 #define DH_R_KEYS_NOT_SET                                108
 375 #define DH_R_KEY_SIZE_TOO_SMALL                          110
 376 #define DH_R_MODULUS_TOO_LARGE                           103
 377 #define DH_R_NON_FIPS_METHOD                             111
 378 #define DH_R_NO_PARAMETERS_SET                           107
 379 #define DH_R_NO_PRIVATE_VALUE                            100
 380 #define DH_R_PARAMETER_ENCODING_ERROR                    105
 381 #define DH_R_PEER_KEY_ERROR                              113
 382 #define DH_R_SHARED_INFO_ERROR                           114
 383
 384 #ifdef  __cplusplus
 385 }
 386 #endif
 387 #endif