dh.h revision 296341 
1220496Smarkm/* crypto/dh/dh.h */
244290Swollman/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3220496Smarkm * All rights reserved.
4220496Smarkm *
5220496Smarkm * This package is an SSL implementation written
6220496Smarkm * by Eric Young (eay@cryptsoft.com).
7220496Smarkm * The implementation was written so as to conform with Netscapes SSL.
8220496Smarkm *
9220496Smarkm * This library is free for commercial and non-commercial use as long as
10220496Smarkm * the following conditions are aheared to.  The following conditions
11220496Smarkm * apply to all code found in this distribution, be it the RC4, RSA,
12220496Smarkm * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13220496Smarkm * included with this distribution is covered by the same copyright terms
1484211Sdillon * except that the holder is Tim Hudson (tjh@cryptsoft.com).
1584211Sdillon *
1684211Sdillon * Copyright remains Eric Young's, and as such any Copyright notices in
17220496Smarkm * the code are not to be removed.
1844290Swollman * If this package is used in a product, Eric Young should be given attribution
19220496Smarkm * as the author of the parts of the library used.
20220496Smarkm * This can be in the form of a textual message at program startup or
21220496Smarkm * in documentation (online or textual) provided with the package.
2244290Swollman *
23220496Smarkm * Redistribution and use in source and binary forms, with or without
24220496Smarkm * modification, are permitted provided that the following conditions
25220496Smarkm * are met:
2644290Swollman * 1. Redistributions of source code must retain the copyright
2744290Swollman *    notice, this list of conditions and the following disclaimer.
28220496Smarkm * 2. Redistributions in binary form must reproduce the above copyright
2944290Swollman *    notice, this list of conditions and the following disclaimer in the
3044290Swollman *    documentation and/or other materials provided with the distribution.
3144290Swollman * 3. All advertising materials mentioning features or use of this software
3244290Swollman *    must display the following acknowledgement:
3344290Swollman *    "This product includes cryptographic software written by
3444290Swollman *     Eric Young (eay@cryptsoft.com)"
35143334Scperciva *    The word 'cryptographic' can be left out if the rouines from the library
36143334Scperciva *    being used are not cryptographic related :-).
37220496Smarkm * 4. If you include any Windows specific code (or a derivative thereof) from
38220496Smarkm *    the apps directory (application code) you must include an acknowledgement:
3944290Swollman *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
4044290Swollman *
41220496Smarkm * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42220496Smarkm * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43220496Smarkm * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
4444290Swollman * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45220496Smarkm * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
4644290Swollman * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47220496Smarkm * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48220496Smarkm * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
4944290Swollman * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
5044290Swollman * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51220496Smarkm * SUCH DAMAGE.
52220496Smarkm *
53220496Smarkm * The licence and distribution terms for any publically available version or
5444290Swollman * derivative of this code cannot be changed.  i.e. this code cannot simply be
55220496Smarkm * copied and put under another distribution licence
5644290Swollman * [including the GNU Public Licence.]
57220496Smarkm */
58220496Smarkm
59220496Smarkm#ifndef HEADER_DH_H
60220496Smarkm# define HEADER_DH_H
61220496Smarkm
62220496Smarkm# include <openssl/e_os2.h>
63220496Smarkm
64220496Smarkm# ifdef OPENSSL_NO_DH
65220496Smarkm#  error DH is disabled.
66220496Smarkm# endif
6744290Swollman
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
82/*
83 * new with 0.9.7h; the built-in DH
84 * implementation now uses constant time
85 * modular exponentiation for secret exponents
86 * by default. This flag causes the
87 * faster variable sliding window method to
88 * be used for all exponents.
89 */
90# define DH_FLAG_NO_EXP_CONSTTIME 0x02
91
92/*
93 * If this flag is set the DH method is FIPS compliant and can be used in
94 * FIPS mode. This is set in the validated module method. If an application
95 * sets this flag in its own methods it is its reposibility to ensure the
96 * result is compliant.
97 */
98
99# define DH_FLAG_FIPS_METHOD                     0x0400
100
101/*
102 * If this flag is set the operations normally disabled in FIPS mode are
103 * permitted it is then the applications responsibility to ensure that the
104 * usage is compliant.
105 */
106
107# define DH_FLAG_NON_FIPS_ALLOW                  0x0400
108
109#ifdef  __cplusplus
110extern "C" {
111#endif
112
113/* Already defined in ossl_typ.h */
114/* typedef struct dh_st DH; */
115/* typedef struct dh_method DH_METHOD; */
116
117struct dh_method {
118    const char *name;
119    /* Methods here */
120    int (*generate_key) (DH *dh);
121    int (*compute_key) (unsigned char *key, const BIGNUM *pub_key, DH *dh);
122    /* Can be null */
123    int (*bn_mod_exp) (const DH *dh, BIGNUM *r, const BIGNUM *a,
124                       const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
125                       BN_MONT_CTX *m_ctx);
126    int (*init) (DH *dh);
127    int (*finish) (DH *dh);
128    int flags;
129    char *app_data;
130    /* If this is non-NULL, it will be used to generate parameters */
131    int (*generate_params) (DH *dh, int prime_len, int generator,
132                            BN_GENCB *cb);
133};
134
135struct dh_st {
136    /*
137     * This first argument is used to pick up errors when a DH is passed
138     * instead of a EVP_PKEY
139     */
140    int pad;
141    int version;
142    BIGNUM *p;
143    BIGNUM *g;
144    long length;                /* optional */
145    BIGNUM *pub_key;            /* g^x */
146    BIGNUM *priv_key;           /* x */
147    int flags;
148    BN_MONT_CTX *method_mont_p;
149    /* Place holders if we want to do X9.42 DH */
150    BIGNUM *q;
151    BIGNUM *j;
152    unsigned char *seed;
153    int seedlen;
154    BIGNUM *counter;
155    int references;
156    CRYPTO_EX_DATA ex_data;
157    const DH_METHOD *meth;
158    ENGINE *engine;
159};
160
161# define DH_GENERATOR_2          2
162/* #define DH_GENERATOR_3       3 */
163# define DH_GENERATOR_5          5
164
165/* DH_check error codes */
166# define DH_CHECK_P_NOT_PRIME            0x01
167# define DH_CHECK_P_NOT_SAFE_PRIME       0x02
168# define DH_UNABLE_TO_CHECK_GENERATOR    0x04
169# define DH_NOT_SUITABLE_GENERATOR       0x08
170
171/* DH_check_pub_key error codes */
172# define DH_CHECK_PUBKEY_TOO_SMALL       0x01
173# define DH_CHECK_PUBKEY_TOO_LARGE       0x02
174
175/*
176 * primes p where (p-1)/2 is prime too are called "safe"; we define this for
177 * backward compatibility:
178 */
179# define DH_CHECK_P_NOT_STRONG_PRIME     DH_CHECK_P_NOT_SAFE_PRIME
180
181# define d2i_DHparams_fp(fp,x) (DH *)ASN1_d2i_fp((char *(*)())DH_new, \
182                (char *(*)())d2i_DHparams,(fp),(unsigned char **)(x))
183# define i2d_DHparams_fp(fp,x) ASN1_i2d_fp(i2d_DHparams,(fp), \
184                (unsigned char *)(x))
185# define d2i_DHparams_bio(bp,x) ASN1_d2i_bio_of(DH,DH_new,d2i_DHparams,bp,x)
186# define i2d_DHparams_bio(bp,x) ASN1_i2d_bio_of_const(DH,i2d_DHparams,bp,x)
187
188DH *DHparams_dup(DH *);
189
190const DH_METHOD *DH_OpenSSL(void);
191
192void DH_set_default_method(const DH_METHOD *meth);
193const DH_METHOD *DH_get_default_method(void);
194int DH_set_method(DH *dh, const DH_METHOD *meth);
195DH *DH_new_method(ENGINE *engine);
196
197DH *DH_new(void);
198void DH_free(DH *dh);
199int DH_up_ref(DH *dh);
200int DH_size(const DH *dh);
201int DH_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
202                        CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
203int DH_set_ex_data(DH *d, int idx, void *arg);
204void *DH_get_ex_data(DH *d, int idx);
205
206/* Deprecated version */
207# ifndef OPENSSL_NO_DEPRECATED
208DH *DH_generate_parameters(int prime_len, int generator,
209                           void (*callback) (int, int, void *), void *cb_arg);
210# endif                         /* !defined(OPENSSL_NO_DEPRECATED) */
211
212/* New version */
213int DH_generate_parameters_ex(DH *dh, int prime_len, int generator,
214                              BN_GENCB *cb);
215
216int DH_check(const DH *dh, int *codes);
217int DH_check_pub_key(const DH *dh, const BIGNUM *pub_key, int *codes);
218int DH_generate_key(DH *dh);
219int DH_compute_key(unsigned char *key, const BIGNUM *pub_key, DH *dh);
220DH *d2i_DHparams(DH **a, const unsigned char **pp, long length);
221int i2d_DHparams(const DH *a, unsigned char **pp);
222# ifndef OPENSSL_NO_FP_API
223int DHparams_print_fp(FILE *fp, const DH *x);
224# endif
225# ifndef OPENSSL_NO_BIO
226int DHparams_print(BIO *bp, const DH *x);
227# else
228int DHparams_print(char *bp, const DH *x);
229# endif
230
231# define EVP_PKEY_CTX_set_dh_paramgen_prime_len(ctx, len) \
232        EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
233                        EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN, len, NULL)
234
235# define EVP_PKEY_CTX_set_dh_paramgen_generator(ctx, gen) \
236        EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
237                        EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR, gen, NULL)
238
239# define EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN     (EVP_PKEY_ALG_CTRL + 1)
240# define EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR     (EVP_PKEY_ALG_CTRL + 2)
241
242/* BEGIN ERROR CODES */
243/*
244 * The following lines are auto generated by the script mkerr.pl. Any changes
245 * made after this point may be overwritten when the script is next run.
246 */
247void ERR_load_DH_strings(void);
248
249/* Error codes for the DH functions. */
250
251/* Function codes. */
252# define DH_F_COMPUTE_KEY                                 102
253# define DH_F_DHPARAMS_PRINT_FP                           101
254# define DH_F_DH_BUILTIN_GENPARAMS                        106
255# define DH_F_DH_COMPUTE_KEY                              114
256# define DH_F_DH_GENERATE_KEY                             115
257# define DH_F_DH_GENERATE_PARAMETERS_EX                   116
258# define DH_F_DH_NEW_METHOD                               105
259# define DH_F_DH_PARAM_DECODE                             107
260# define DH_F_DH_PRIV_DECODE                              110
261# define DH_F_DH_PRIV_ENCODE                              111
262# define DH_F_DH_PUB_DECODE                               108
263# define DH_F_DH_PUB_ENCODE                               109
264# define DH_F_DO_DH_PRINT                                 100
265# define DH_F_GENERATE_KEY                                103
266# define DH_F_GENERATE_PARAMETERS                         104
267# define DH_F_PKEY_DH_DERIVE                              112
268# define DH_F_PKEY_DH_KEYGEN                              113
269
270/* Reason codes. */
271# define DH_R_BAD_GENERATOR                               101
272# define DH_R_BN_DECODE_ERROR                             109
273# define DH_R_BN_ERROR                                    106
274# define DH_R_DECODE_ERROR                                104
275# define DH_R_INVALID_PUBKEY                              102
276# define DH_R_KEYS_NOT_SET                                108
277# define DH_R_KEY_SIZE_TOO_SMALL                          110
278# define DH_R_MODULUS_TOO_LARGE                           103
279# define DH_R_NON_FIPS_METHOD                             111
280# define DH_R_NO_PARAMETERS_SET                           107
281# define DH_R_NO_PRIVATE_VALUE                            100
282# define DH_R_PARAMETER_ENCODING_ERROR                    105
283
284#ifdef  __cplusplus
285}
286#endif
287#endif
288