crypto/dsa/dsa.h

   1 /* crypto/dsa/dsa.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 /*
  60  * The DSS routines are based on patches supplied by
  61  * Steven Schoch <schoch@sheba.arc.nasa.gov>.  He basically did the
  62  * work and I have just tweaked them a little to fit into my
  63  * stylistic vision for SSLeay :-) */
  64
  65 #ifndef HEADER_DSA_H
  66 #define HEADER_DSA_H
  67
  68 #include <openssl/e_os2.h>
  69
  70 #ifdef OPENSSL_NO_DSA
  71 #error DSA is disabled.
  72 #endif
  73
  74 #ifndef OPENSSL_NO_BIO
  75 #include <openssl/bio.h>
  76 #endif
  77 #include <openssl/crypto.h>
  78 #include <openssl/ossl_typ.h>
  79
  80 #ifdef OPENSSL_USE_DEPRECATED
  81 #include <openssl/bn.h>
  82 #ifndef OPENSSL_NO_DH
  83 # include <openssl/dh.h>
  84 #endif
  85 #endif
  86
  87 #ifndef OPENSSL_DSA_MAX_MODULUS_BITS
  88 # define OPENSSL_DSA_MAX_MODULUS_BITS   10000
  89 #endif
  90
  91 #define OPENSSL_DSA_FIPS_MIN_MODULUS_BITS 1024
  92
  93 #define DSA_FLAG_CACHE_MONT_P   0x01
  94 /* new with 0.9.7h; the
  95  * built-in DSA
  96  * implementation now
  97  * uses constant time
  98  * modular exponentiation
  99  * for secret exponents
 100  * by default. This flag
 101  * causes the faster
 102  * variable sliding
 103  * window method to be
 104  * used for all
 105  * exponents.
 106  */
 107 #define DSA_FLAG_NO_EXP_CONSTTIME       0x02
 108
 109 /* If this flag is set the DSA method is FIPS compliant and can be used
 110  * in FIPS mode. This is set in the validated module method. If an
 111  * application sets this flag in its own methods it is its reposibility
 112  * to ensure the result is compliant.
 113  */
 114
 115 #define DSA_FLAG_FIPS_METHOD                    0x0400
 116
 117 /* If this flag is set the operations normally disabled in FIPS mode are
 118  * permitted it is then the applications responsibility to ensure that the
 119  * usage is compliant.
 120  */
 121
 122 #define DSA_FLAG_NON_FIPS_ALLOW                 0x0400
 123 #define DSA_FLAG_FIPS_CHECKED                   0x0800
 124
 125 #ifdef  __cplusplus
 126 extern "C" {
 127 #endif
 128
 129 /* Already defined in ossl_typ.h */
 130 /* typedef struct dsa_st DSA; */
 131 /* typedef struct dsa_method DSA_METHOD; */
 132
 133 typedef struct DSA_SIG_st
 134         {
 135         BIGNUM *r;
 136         BIGNUM *s;
 137         } DSA_SIG;
 138
 139 struct dsa_method
 140         {
 141         const char *name;
 142         DSA_SIG * (*dsa_do_sign)(const unsigned char *dgst, int dlen, DSA *dsa);
 143         int (*dsa_sign_setup)(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp,
 144                                                                 BIGNUM **rp);
 145         int (*dsa_do_verify)(const unsigned char *dgst, int dgst_len,
 146                              DSA_SIG *sig, DSA *dsa);
 147         int (*dsa_mod_exp)(DSA *dsa, BIGNUM *rr, BIGNUM *a1, BIGNUM *p1,
 148                         BIGNUM *a2, BIGNUM *p2, BIGNUM *m, BN_CTX *ctx,
 149                         BN_MONT_CTX *in_mont);
 150         /* Can be null */
 151         int (*bn_mod_exp)(DSA *dsa, BIGNUM *r, BIGNUM *a, const BIGNUM *p,
 152                                 const BIGNUM *m, BN_CTX *ctx,
 153                                 BN_MONT_CTX *m_ctx);
 154         int (*init)(DSA *dsa);
 155         int (*finish)(DSA *dsa);
 156         int flags;
 157         char *app_data;
 158         /* If this is non-NULL, it is used to generate DSA parameters */
 159         int (*dsa_paramgen)(DSA *dsa, int bits,
 160                         const unsigned char *seed, int seed_len,
 161                         int *counter_ret, unsigned long *h_ret,
 162                         BN_GENCB *cb);
 163         /* If this is non-NULL, it is used to generate DSA keys */
 164         int (*dsa_keygen)(DSA *dsa);
 165         };
 166
 167 struct dsa_st
 168         {
 169         /* This first variable is used to pick up errors where
 170          * a DSA is passed instead of of a EVP_PKEY */
 171         int pad;
 172         long version;
 173         int write_params;
 174         BIGNUM *p;
 175         BIGNUM *q;      /* == 20 */
 176         BIGNUM *g;
 177
 178         BIGNUM *pub_key;  /* y public key */
 179         BIGNUM *priv_key; /* x private key */
 180
 181         BIGNUM *kinv;   /* Signing pre-calc */
 182         BIGNUM *r;      /* Signing pre-calc */
 183
 184         int flags;
 185         /* Normally used to cache montgomery values */
 186         BN_MONT_CTX *method_mont_p;
 187         int references;
 188         CRYPTO_EX_DATA ex_data;
 189         const DSA_METHOD *meth;
 190         /* functional reference if 'meth' is ENGINE-provided */
 191         ENGINE *engine;
 192         };
 193
 194 #define d2i_DSAparams_fp(fp,x) (DSA *)ASN1_d2i_fp((char *(*)())DSA_new, \
 195                 (char *(*)())d2i_DSAparams,(fp),(unsigned char **)(x))
 196 #define i2d_DSAparams_fp(fp,x) ASN1_i2d_fp(i2d_DSAparams,(fp), \
 197                 (unsigned char *)(x))
 198 #define d2i_DSAparams_bio(bp,x) ASN1_d2i_bio_of(DSA,DSA_new,d2i_DSAparams,bp,x)
 199 #define i2d_DSAparams_bio(bp,x) ASN1_i2d_bio_of_const(DSA,i2d_DSAparams,bp,x)
 200
 201
 202 DSA *DSAparams_dup(DSA *x);
 203 DSA_SIG * DSA_SIG_new(void);
 204 void    DSA_SIG_free(DSA_SIG *a);
 205 int     i2d_DSA_SIG(const DSA_SIG *a, unsigned char **pp);
 206 DSA_SIG * d2i_DSA_SIG(DSA_SIG **v, const unsigned char **pp, long length);
 207
 208 DSA_SIG * DSA_do_sign(const unsigned char *dgst,int dlen,DSA *dsa);
 209 int     DSA_do_verify(const unsigned char *dgst,int dgst_len,
 210                       DSA_SIG *sig,DSA *dsa);
 211
 212 const DSA_METHOD *DSA_OpenSSL(void);
 213
 214 void    DSA_set_default_method(const DSA_METHOD *);
 215 const DSA_METHOD *DSA_get_default_method(void);
 216 int     DSA_set_method(DSA *dsa, const DSA_METHOD *);
 217
 218 DSA *   DSA_new(void);
 219 DSA *   DSA_new_method(ENGINE *engine);
 220 void    DSA_free (DSA *r);
 221 /* "up" the DSA object's reference count */
 222 int     DSA_up_ref(DSA *r);
 223 int     DSA_size(const DSA *);
 224 int     DSA_security_bits(const DSA *d);
 225         /* next 4 return -1 on error */
 226 int     DSA_sign_setup( DSA *dsa,BN_CTX *ctx_in,BIGNUM **kinvp,BIGNUM **rp);
 227 int     DSA_sign(int type,const unsigned char *dgst,int dlen,
 228                 unsigned char *sig, unsigned int *siglen, DSA *dsa);
 229 int     DSA_verify(int type,const unsigned char *dgst,int dgst_len,
 230                 const unsigned char *sigbuf, int siglen, DSA *dsa);
 231 int DSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
 232              CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
 233 int DSA_set_ex_data(DSA *d, int idx, void *arg);
 234 void *DSA_get_ex_data(DSA *d, int idx);
 235
 236 DSA *   d2i_DSAPublicKey(DSA **a, const unsigned char **pp, long length);
 237 DSA *   d2i_DSAPrivateKey(DSA **a, const unsigned char **pp, long length);
 238 DSA *   d2i_DSAparams(DSA **a, const unsigned char **pp, long length);
 239
 240 /* Deprecated version */
 241 #ifdef OPENSSL_USE_DEPRECATED
 242 DECLARE_DEPRECATED(DSA *        DSA_generate_parameters(int bits,
 243                 unsigned char *seed,int seed_len,
 244                 int *counter_ret, unsigned long *h_ret,void
 245                 (*callback)(int, int, void *),void *cb_arg));
 246 #endif /* defined(OPENSSL_USE_DEPRECATED) */
 247
 248 /* New version */
 249 int     DSA_generate_parameters_ex(DSA *dsa, int bits,
 250                 const unsigned char *seed,int seed_len,
 251                 int *counter_ret, unsigned long *h_ret, BN_GENCB *cb);
 252
 253 int     DSA_generate_key(DSA *a);
 254 int     i2d_DSAPublicKey(const DSA *a, unsigned char **pp);
 255 int     i2d_DSAPrivateKey(const DSA *a, unsigned char **pp);
 256 int     i2d_DSAparams(const DSA *a,unsigned char **pp);
 257
 258 #ifndef OPENSSL_NO_BIO
 259 int     DSAparams_print(BIO *bp, const DSA *x);
 260 int     DSA_print(BIO *bp, const DSA *x, int off);
 261 #endif
 262 #ifndef OPENSSL_NO_STDIO
 263 int     DSAparams_print_fp(FILE *fp, const DSA *x);
 264 int     DSA_print_fp(FILE *bp, const DSA *x, int off);
 265 #endif
 266
 267 #define DSS_prime_checks 50
 268 /* Primality test according to FIPS PUB 186[-1], Appendix 2.1:
 269  * 50 rounds of Rabin-Miller */
 270 #define DSA_is_prime(n, callback, cb_arg) \
 271         BN_is_prime(n, DSS_prime_checks, callback, NULL, cb_arg)
 272
 273 #ifndef OPENSSL_NO_DH
 274 /* Convert DSA structure (key or just parameters) into DH structure
 275  * (be careful to avoid small subgroup attacks when using this!) */
 276 DH *DSA_dup_DH(const DSA *r);
 277 #endif
 278
 279 #define EVP_PKEY_CTX_set_dsa_paramgen_bits(ctx, nbits) \
 280         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DSA, EVP_PKEY_OP_PARAMGEN, \
 281                                 EVP_PKEY_CTRL_DSA_PARAMGEN_BITS, nbits, NULL)
 282
 283 #define EVP_PKEY_CTRL_DSA_PARAMGEN_BITS         (EVP_PKEY_ALG_CTRL + 1)
 284 #define EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS       (EVP_PKEY_ALG_CTRL + 2)
 285 #define EVP_PKEY_CTRL_DSA_PARAMGEN_MD           (EVP_PKEY_ALG_CTRL + 3)
 286
 287 /* BEGIN ERROR CODES */
 288 /* The following lines are auto generated by the script mkerr.pl. Any changes
 289  * made after this point may be overwritten when the script is next run.
 290  */
 291 void ERR_load_DSA_strings(void);
 292
 293 /* Error codes for the DSA functions. */
 294
 295 /* Function codes. */
 296 #define DSA_F_D2I_DSA_SIG                                110
 297 #define DSA_F_DO_DSA_PRINT                               104
 298 #define DSA_F_DSAPARAMS_PRINT                            100
 299 #define DSA_F_DSAPARAMS_PRINT_FP                         101
 300 #define DSA_F_DSA_BUILTIN_KEYGEN                         124
 301 #define DSA_F_DSA_BUILTIN_PARAMGEN                       125
 302 #define DSA_F_DSA_BUILTIN_PARAMGEN2                      126
 303 #define DSA_F_DSA_DO_SIGN                                112
 304 #define DSA_F_DSA_DO_VERIFY                              113
 305 #define DSA_F_DSA_NEW_METHOD                             103
 306 #define DSA_F_DSA_PARAM_DECODE                           119
 307 #define DSA_F_DSA_PRINT_FP                               105
 308 #define DSA_F_DSA_PRIV_DECODE                            115
 309 #define DSA_F_DSA_PRIV_ENCODE                            116
 310 #define DSA_F_DSA_PUB_DECODE                             117
 311 #define DSA_F_DSA_PUB_ENCODE                             118
 312 #define DSA_F_DSA_SIGN                                   106
 313 #define DSA_F_DSA_SIGN_SETUP                             107
 314 #define DSA_F_DSA_SIG_NEW                                109
 315 #define DSA_F_DSA_SIG_PRINT                              123
 316 #define DSA_F_DSA_VERIFY                                 108
 317 #define DSA_F_I2D_DSA_SIG                                111
 318 #define DSA_F_OLD_DSA_PRIV_DECODE                        122
 319 #define DSA_F_PKEY_DSA_CTRL                              120
 320 #define DSA_F_PKEY_DSA_KEYGEN                            121
 321 #define DSA_F_SIG_CB                                     114
 322
 323 /* Reason codes. */
 324 #define DSA_R_BAD_Q_VALUE                                102
 325 #define DSA_R_BN_DECODE_ERROR                            108
 326 #define DSA_R_BN_ERROR                                   109
 327 #define DSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE                100
 328 #define DSA_R_DECODE_ERROR                               104
 329 #define DSA_R_INVALID_DIGEST_TYPE                        106
 330 #define DSA_R_INVALID_PARAMETERS                         112
 331 #define DSA_R_KEY_SIZE_TOO_SMALL                         111
 332 #define DSA_R_MISSING_PARAMETERS                         101
 333 #define DSA_R_MODULUS_TOO_LARGE                          103
 334 #define DSA_R_NEED_NEW_SETUP_VALUES                      110
 335 #define DSA_R_NO_PARAMETERS_SET                          107
 336 #define DSA_R_PARAMETER_ENCODING_ERROR                   105
 337 #define DSA_R_Q_NOT_PRIME                                113
 338
 339 #ifdef  __cplusplus
 340 }
 341 #endif
 342 #endif