dh.h revision 109998
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#ifdef OPENSSL_NO_DH 63#error DH is disabled. 64#endif 65 66#ifndef OPENSSL_NO_BIO 67#include <openssl/bio.h> 68#endif 69#include <openssl/bn.h> 70#include <openssl/crypto.h> 71#include <openssl/ossl_typ.h> 72 73#define DH_FLAG_CACHE_MONT_P 0x01 74 75#ifdef __cplusplus 76extern "C" { 77#endif 78 79typedef struct dh_st DH; 80 81typedef struct dh_method { 82 const char *name; 83 /* Methods here */ 84 int (*generate_key)(DH *dh); 85 int (*compute_key)(unsigned char *key,const BIGNUM *pub_key,DH *dh); 86 int (*bn_mod_exp)(const DH *dh, BIGNUM *r, const BIGNUM *a, 87 const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx, 88 BN_MONT_CTX *m_ctx); /* Can be null */ 89 90 int (*init)(DH *dh); 91 int (*finish)(DH *dh); 92 int flags; 93 char *app_data; 94} DH_METHOD; 95 96struct dh_st 97 { 98 /* This first argument is used to pick up errors when 99 * a DH is passed instead of a EVP_PKEY */ 100 int pad; 101 int version; 102 BIGNUM *p; 103 BIGNUM *g; 104 long length; /* optional */ 105 BIGNUM *pub_key; /* g^x */ 106 BIGNUM *priv_key; /* x */ 107 108 int flags; 109 char *method_mont_p; 110 /* Place holders if we want to do X9.42 DH */ 111 BIGNUM *q; 112 BIGNUM *j; 113 unsigned char *seed; 114 int seedlen; 115 BIGNUM *counter; 116 117 int references; 118 CRYPTO_EX_DATA ex_data; 119 const DH_METHOD *meth; 120 ENGINE *engine; 121 }; 122 123#define DH_GENERATOR_2 2 124/* #define DH_GENERATOR_3 3 */ 125#define DH_GENERATOR_5 5 126 127/* DH_check error codes */ 128#define DH_CHECK_P_NOT_PRIME 0x01 129#define DH_CHECK_P_NOT_SAFE_PRIME 0x02 130#define DH_UNABLE_TO_CHECK_GENERATOR 0x04 131#define DH_NOT_SUITABLE_GENERATOR 0x08 132 133/* primes p where (p-1)/2 is prime too are called "safe"; we define 134 this for backward compatibility: */ 135#define DH_CHECK_P_NOT_STRONG_PRIME DH_CHECK_P_NOT_SAFE_PRIME 136 137#define DHparams_dup(x) (DH *)ASN1_dup((int (*)())i2d_DHparams, \ 138 (char *(*)())d2i_DHparams,(char *)(x)) 139#define d2i_DHparams_fp(fp,x) (DH *)ASN1_d2i_fp((char *(*)())DH_new, \ 140 (char *(*)())d2i_DHparams,(fp),(unsigned char **)(x)) 141#define i2d_DHparams_fp(fp,x) ASN1_i2d_fp(i2d_DHparams,(fp), \ 142 (unsigned char *)(x)) 143#define d2i_DHparams_bio(bp,x) (DH *)ASN1_d2i_bio((char *(*)())DH_new, \ 144 (char *(*)())d2i_DHparams,(bp),(unsigned char **)(x)) 145#ifdef __cplusplus 146#define i2d_DHparams_bio(bp,x) ASN1_i2d_bio((int (*)())i2d_DHparams,(bp), \ 147 (unsigned char *)(x)) 148#else 149#define i2d_DHparams_bio(bp,x) ASN1_i2d_bio(i2d_DHparams,(bp), \ 150 (unsigned char *)(x)) 151#endif 152 153const DH_METHOD *DH_OpenSSL(void); 154 155void DH_set_default_method(const DH_METHOD *meth); 156const DH_METHOD *DH_get_default_method(void); 157int DH_set_method(DH *dh, const DH_METHOD *meth); 158DH *DH_new_method(ENGINE *engine); 159 160DH * DH_new(void); 161void DH_free(DH *dh); 162int DH_up_ref(DH *dh); 163int DH_size(const DH *dh); 164int DH_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, 165 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); 166int DH_set_ex_data(DH *d, int idx, void *arg); 167void *DH_get_ex_data(DH *d, int idx); 168DH * DH_generate_parameters(int prime_len,int generator, 169 void (*callback)(int,int,void *),void *cb_arg); 170int DH_check(const DH *dh,int *codes); 171int DH_generate_key(DH *dh); 172int DH_compute_key(unsigned char *key,const BIGNUM *pub_key,DH *dh); 173DH * d2i_DHparams(DH **a,const unsigned char **pp, long length); 174int i2d_DHparams(const DH *a,unsigned char **pp); 175#ifndef OPENSSL_NO_FP_API 176int DHparams_print_fp(FILE *fp, const DH *x); 177#endif 178#ifndef OPENSSL_NO_BIO 179int DHparams_print(BIO *bp, const DH *x); 180#else 181int DHparams_print(char *bp, const DH *x); 182#endif 183 184/* BEGIN ERROR CODES */ 185/* The following lines are auto generated by the script mkerr.pl. Any changes 186 * made after this point may be overwritten when the script is next run. 187 */ 188void ERR_load_DH_strings(void); 189 190/* Error codes for the DH functions. */ 191 192/* Function codes. */ 193#define DH_F_DHPARAMS_PRINT 100 194#define DH_F_DHPARAMS_PRINT_FP 101 195#define DH_F_DH_COMPUTE_KEY 102 196#define DH_F_DH_GENERATE_KEY 103 197#define DH_F_DH_GENERATE_PARAMETERS 104 198#define DH_F_DH_NEW_METHOD 105 199 200/* Reason codes. */ 201#define DH_R_BAD_GENERATOR 101 202#define DH_R_NO_PRIVATE_VALUE 100 203 204#ifdef __cplusplus 205} 206#endif 207#endif 208