dh.h revision 100928
195142Sjmallett/* crypto/dh/dh.h */ 295142Sjmallett/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) 3263227Sjmmv * All rights reserved. 4263227Sjmmv * 5263227Sjmmv * This package is an SSL implementation written 6263227Sjmmv * by Eric Young (eay@cryptsoft.com). 7263227Sjmmv * The implementation was written so as to conform with Netscapes SSL. 8263227Sjmmv * 9263227Sjmmv * This library is free for commercial and non-commercial use as long as 10263227Sjmmv * the following conditions are aheared to. The following conditions 11263227Sjmmv * apply to all code found in this distribution, be it the RC4, RSA, 12263227Sjmmv * lhash, DES, etc., code; not just the SSL code. The SSL documentation 13263227Sjmmv * included with this distribution is covered by the same copyright terms 14263227Sjmmv * except that the holder is Tim Hudson (tjh@cryptsoft.com). 15263227Sjmmv * 16263227Sjmmv * Copyright remains Eric Young's, and as such any Copyright notices in 17263227Sjmmv * the code are not to be removed. 18263227Sjmmv * If this package is used in a product, Eric Young should be given attribution 19263227Sjmmv * as the author of the parts of the library used. 20263227Sjmmv * This can be in the form of a textual message at program startup or 21263227Sjmmv * in documentation (online or textual) provided with the package. 22263227Sjmmv * 23263227Sjmmv * Redistribution and use in source and binary forms, with or without 24263227Sjmmv * modification, are permitted provided that the following conditions 25263227Sjmmv * are met: 26263227Sjmmv * 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 NO_DH 63#error DH is disabled. 64#endif 65 66#ifndef NO_BIO 67#include <openssl/bio.h> 68#endif 69#include <openssl/bn.h> 70#include <openssl/crypto.h> 71 72#define DH_FLAG_CACHE_MONT_P 0x01 73 74#ifdef __cplusplus 75extern "C" { 76#endif 77 78typedef struct dh_st DH; 79 80typedef struct dh_method { 81 const char *name; 82 /* Methods here */ 83 int (*generate_key)(DH *dh); 84 int (*compute_key)(unsigned char *key,BIGNUM *pub_key,DH *dh); 85 int (*bn_mod_exp)(DH *dh, BIGNUM *r, BIGNUM *a, const BIGNUM *p, 86 const BIGNUM *m, BN_CTX *ctx, 87 BN_MONT_CTX *m_ctx); /* Can be null */ 88 89 int (*init)(DH *dh); 90 int (*finish)(DH *dh); 91 int flags; 92 char *app_data; 93} DH_METHOD; 94 95struct dh_st 96 { 97 /* This first argument is used to pick up errors when 98 * a DH is passed instead of a EVP_PKEY */ 99 int pad; 100 int version; 101 BIGNUM *p; 102 BIGNUM *g; 103 int length; /* optional */ 104 BIGNUM *pub_key; /* g^x */ 105 BIGNUM *priv_key; /* x */ 106 107 int flags; 108 char *method_mont_p; 109 /* Place holders if we want to do X9.42 DH */ 110 BIGNUM *q; 111 BIGNUM *j; 112 unsigned char *seed; 113 int seedlen; 114 BIGNUM *counter; 115 116 int references; 117 CRYPTO_EX_DATA ex_data; 118 DH_METHOD *meth; 119 }; 120 121#define DH_GENERATOR_2 2 122/* #define DH_GENERATOR_3 3 */ 123#define DH_GENERATOR_5 5 124 125/* DH_check error codes */ 126#define DH_CHECK_P_NOT_PRIME 0x01 127#define DH_CHECK_P_NOT_SAFE_PRIME 0x02 128#define DH_UNABLE_TO_CHECK_GENERATOR 0x04 129#define DH_NOT_SUITABLE_GENERATOR 0x08 130 131/* primes p where (p-1)/2 is prime too are called "safe"; we define 132 this for backward compatibility: */ 133#define DH_CHECK_P_NOT_STRONG_PRIME DH_CHECK_P_NOT_SAFE_PRIME 134 135#define DHparams_dup(x) (DH *)ASN1_dup((int (*)())i2d_DHparams, \ 136 (char *(*)())d2i_DHparams,(char *)(x)) 137#define d2i_DHparams_fp(fp,x) (DH *)ASN1_d2i_fp((char *(*)())DH_new, \ 138 (char *(*)())d2i_DHparams,(fp),(unsigned char **)(x)) 139#define i2d_DHparams_fp(fp,x) ASN1_i2d_fp(i2d_DHparams,(fp), \ 140 (unsigned char *)(x)) 141#define d2i_DHparams_bio(bp,x) (DH *)ASN1_d2i_bio((char *(*)())DH_new, \ 142 (char *(*)())d2i_DHparams,(bp),(unsigned char **)(x)) 143#ifdef __cplusplus 144#define i2d_DHparams_bio(bp,x) ASN1_i2d_bio((int (*)())i2d_DHparams,(bp), \ 145 (unsigned char *)(x)) 146#else 147#define i2d_DHparams_bio(bp,x) ASN1_i2d_bio(i2d_DHparams,(bp), \ 148 (unsigned char *)(x)) 149#endif 150 151DH_METHOD *DH_OpenSSL(void); 152 153void DH_set_default_method(DH_METHOD *meth); 154DH_METHOD *DH_get_default_method(void); 155DH_METHOD *DH_set_method(DH *dh, DH_METHOD *meth); 156DH *DH_new_method(DH_METHOD *meth); 157 158DH * DH_new(void); 159void DH_free(DH *dh); 160int DH_size(DH *dh); 161int DH_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, 162 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); 163int DH_set_ex_data(DH *d, int idx, void *arg); 164void *DH_get_ex_data(DH *d, int idx); 165DH * DH_generate_parameters(int prime_len,int generator, 166 void (*callback)(int,int,void *),void *cb_arg); 167int DH_check(DH *dh,int *codes); 168int DH_generate_key(DH *dh); 169int DH_compute_key(unsigned char *key,BIGNUM *pub_key,DH *dh); 170DH * d2i_DHparams(DH **a,unsigned char **pp, long length); 171int i2d_DHparams(DH *a,unsigned char **pp); 172#ifndef NO_FP_API 173int DHparams_print_fp(FILE *fp, DH *x); 174#endif 175#ifndef NO_BIO 176int DHparams_print(BIO *bp, DH *x); 177#else 178int DHparams_print(char *bp, DH *x); 179#endif 180 181/* BEGIN ERROR CODES */ 182/* The following lines are auto generated by the script mkerr.pl. Any changes 183 * made after this point may be overwritten when the script is next run. 184 */ 185void ERR_load_DH_strings(void); 186 187/* Error codes for the DH functions. */ 188 189/* Function codes. */ 190#define DH_F_DHPARAMS_PRINT 100 191#define DH_F_DHPARAMS_PRINT_FP 101 192#define DH_F_DH_COMPUTE_KEY 102 193#define DH_F_DH_GENERATE_KEY 103 194#define DH_F_DH_GENERATE_PARAMETERS 104 195#define DH_F_DH_NEW 105 196 197/* Reason codes. */ 198#define DH_R_BAD_GENERATOR 101 199#define DH_R_NO_PRIVATE_VALUE 100 200 201#ifdef __cplusplus 202} 203#endif 204#endif 205