include/openssl/dsa.h

   1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   2  * All rights reserved.
   3  *
   4  * This package is an SSL implementation written
   5  * by Eric Young (eay@cryptsoft.com).
   6  * The implementation was written so as to conform with Netscapes SSL.
   7  *
   8  * This library is free for commercial and non-commercial use as long as
   9  * the following conditions are aheared to.  The following conditions
  10  * apply to all code found in this distribution, be it the RC4, RSA,
  11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  12  * included with this distribution is covered by the same copyright terms
  13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  14  *
  15  * Copyright remains Eric Young's, and as such any Copyright notices in
  16  * the code are not to be removed.
  17  * If this package is used in a product, Eric Young should be given attribution
  18  * as the author of the parts of the library used.
  19  * This can be in the form of a textual message at program startup or
  20  * in documentation (online or textual) provided with the package.
  21  *
  22  * Redistribution and use in source and binary forms, with or without
  23  * modification, are permitted provided that the following conditions
  24  * are met:
  25  * 1. Redistributions of source code must retain the copyright
  26  *    notice, this list of conditions and the following disclaimer.
  27  * 2. Redistributions in binary form must reproduce the above copyright
  28  *    notice, this list of conditions and the following disclaimer in the
  29  *    documentation and/or other materials provided with the distribution.
  30  * 3. All advertising materials mentioning features or use of this software
  31  *    must display the following acknowledgement:
  32  *    "This product includes cryptographic software written by
  33  *     Eric Young (eay@cryptsoft.com)"
  34  *    The word 'cryptographic' can be left out if the rouines from the library
  35  *    being used are not cryptographic related :-).
  36  * 4. If you include any Windows specific code (or a derivative thereof) from
  37  *    the apps directory (application code) you must include an acknowledgement:
  38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  50  * SUCH DAMAGE.
  51  *
  52  * The licence and distribution terms for any publically available version or
  53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  54  * copied and put under another distribution licence
  55  * [including the GNU Public Licence.]
  56  */
  57
  58 /*
  59  * The DSS routines are based on patches supplied by
  60  * Steven Schoch <schoch@sheba.arc.nasa.gov>.
  61  */
  62
  63 #ifndef HEADER_DSA_H
  64 # define HEADER_DSA_H
  65
  66 # include <openssl/e_os2.h>
  67
  68 # ifdef OPENSSL_NO_DSA
  69 #  error DSA is disabled.
  70 # endif
  71
  72 # include <openssl/bio.h>
  73 # include <openssl/crypto.h>
  74 # include <openssl/ossl_typ.h>
  75 # include <openssl/opensslconf.h>
  76
  77 # if OPENSSL_API_COMPAT < 0x10100000L
  78 #  include <openssl/bn.h>
  79 #  ifndef OPENSSL_NO_DH
  80 #   include <openssl/dh.h>
  81 #  endif
  82 # endif
  83
  84 # ifndef OPENSSL_DSA_MAX_MODULUS_BITS
  85 #  define OPENSSL_DSA_MAX_MODULUS_BITS   10000
  86 # endif
  87
  88 # define OPENSSL_DSA_FIPS_MIN_MODULUS_BITS 1024
  89
  90 # define DSA_FLAG_CACHE_MONT_P   0x01
  91 /*
  92  * new with 0.9.7h; the built-in DSA implementation now uses constant time
  93  * modular exponentiation for secret exponents by default. This flag causes
  94  * the faster variable sliding window method to be used for all exponents.
  95  */
  96 # define DSA_FLAG_NO_EXP_CONSTTIME       0x02
  97
  98 /*
  99  * If this flag is set the DSA method is FIPS compliant and can be used in
 100  * FIPS mode. This is set in the validated module method. If an application
 101  * sets this flag in its own methods it is its reposibility to ensure the
 102  * result is compliant.
 103  */
 104
 105 # define DSA_FLAG_FIPS_METHOD                    0x0400
 106
 107 /*
 108  * If this flag is set the operations normally disabled in FIPS mode are
 109  * permitted it is then the applications responsibility to ensure that the
 110  * usage is compliant.
 111  */
 112
 113 # define DSA_FLAG_NON_FIPS_ALLOW                 0x0400
 114 # define DSA_FLAG_FIPS_CHECKED                   0x0800
 115
 116 #ifdef  __cplusplus
 117 extern "C" {
 118 #endif
 119
 120 /* Already defined in ossl_typ.h */
 121 /* typedef struct dsa_st DSA; */
 122 /* typedef struct dsa_method DSA_METHOD; */
 123
 124 typedef struct DSA_SIG_st {
 125     BIGNUM *r;
 126     BIGNUM *s;
 127 } DSA_SIG;
 128
 129 struct dsa_method {
 130     const char *name;
 131     DSA_SIG *(*dsa_do_sign) (const unsigned char *dgst, int dlen, DSA *dsa);
 132     int (*dsa_sign_setup) (DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp,
 133                            BIGNUM **rp);
 134     int (*dsa_do_verify) (const unsigned char *dgst, int dgst_len,
 135                           DSA_SIG *sig, DSA *dsa);
 136     int (*dsa_mod_exp) (DSA *dsa, BIGNUM *rr, BIGNUM *a1, BIGNUM *p1,
 137                         BIGNUM *a2, BIGNUM *p2, BIGNUM *m, BN_CTX *ctx,
 138                         BN_MONT_CTX *in_mont);
 139     /* Can be null */
 140     int (*bn_mod_exp) (DSA *dsa, BIGNUM *r, BIGNUM *a, const BIGNUM *p,
 141                        const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
 142     int (*init) (DSA *dsa);
 143     int (*finish) (DSA *dsa);
 144     int flags;
 145     char *app_data;
 146     /* If this is non-NULL, it is used to generate DSA parameters */
 147     int (*dsa_paramgen) (DSA *dsa, int bits,
 148                          const unsigned char *seed, int seed_len,
 149                          int *counter_ret, unsigned long *h_ret,
 150                          BN_GENCB *cb);
 151     /* If this is non-NULL, it is used to generate DSA keys */
 152     int (*dsa_keygen) (DSA *dsa);
 153 };
 154
 155 struct dsa_st {
 156     /*
 157      * This first variable is used to pick up errors where a DSA is passed
 158      * instead of of a EVP_PKEY
 159      */
 160     int pad;
 161     long version;
 162     BIGNUM *p;
 163     BIGNUM *q;                  /* == 20 */
 164     BIGNUM *g;
 165     BIGNUM *pub_key;            /* y public key */
 166     BIGNUM *priv_key;           /* x private key */
 167     int flags;
 168     /* Normally used to cache montgomery values */
 169     BN_MONT_CTX *method_mont_p;
 170     int references;
 171     CRYPTO_EX_DATA ex_data;
 172     const DSA_METHOD *meth;
 173     /* functional reference if 'meth' is ENGINE-provided */
 174     ENGINE *engine;
 175 };
 176
 177 # define d2i_DSAparams_fp(fp,x) (DSA *)ASN1_d2i_fp((char *(*)())DSA_new, \
 178                 (char *(*)())d2i_DSAparams,(fp),(unsigned char **)(x))
 179 # define i2d_DSAparams_fp(fp,x) ASN1_i2d_fp(i2d_DSAparams,(fp), \
 180                 (unsigned char *)(x))
 181 # define d2i_DSAparams_bio(bp,x) ASN1_d2i_bio_of(DSA,DSA_new,d2i_DSAparams,bp,x)
 182 # define i2d_DSAparams_bio(bp,x) ASN1_i2d_bio_of_const(DSA,i2d_DSAparams,bp,x)
 183
 184 DSA *DSAparams_dup(DSA *x);
 185 DSA_SIG *DSA_SIG_new(void);
 186 void DSA_SIG_free(DSA_SIG *a);
 187 int i2d_DSA_SIG(const DSA_SIG *a, unsigned char **pp);
 188 DSA_SIG *d2i_DSA_SIG(DSA_SIG **v, const unsigned char **pp, long length);
 189
 190 DSA_SIG *DSA_do_sign(const unsigned char *dgst, int dlen, DSA *dsa);
 191 int DSA_do_verify(const unsigned char *dgst, int dgst_len,
 192                   DSA_SIG *sig, DSA *dsa);
 193
 194 const DSA_METHOD *DSA_OpenSSL(void);
 195
 196 void DSA_set_default_method(const DSA_METHOD *);
 197 const DSA_METHOD *DSA_get_default_method(void);
 198 int DSA_set_method(DSA *dsa, const DSA_METHOD *);
 199
 200 DSA *DSA_new(void);
 201 DSA *DSA_new_method(ENGINE *engine);
 202 void DSA_free(DSA *r);
 203 /* "up" the DSA object's reference count */
 204 int DSA_up_ref(DSA *r);
 205 int DSA_size(const DSA *);
 206 int DSA_security_bits(const DSA *d);
 207         /* next 4 return -1 on error */
 208 int DSA_sign_setup(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp, BIGNUM **rp);
 209 int DSA_sign(int type, const unsigned char *dgst, int dlen,
 210              unsigned char *sig, unsigned int *siglen, DSA *dsa);
 211 int DSA_verify(int type, const unsigned char *dgst, int dgst_len,
 212                const unsigned char *sigbuf, int siglen, DSA *dsa);
 213 #define DSA_get_ex_new_index(l, p, newf, dupf, freef) \
 214     CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_DSA, l, p, newf, dupf, freef)
 215 int DSA_set_ex_data(DSA *d, int idx, void *arg);
 216 void *DSA_get_ex_data(DSA *d, int idx);
 217
 218 DSA *d2i_DSAPublicKey(DSA **a, const unsigned char **pp, long length);
 219 DSA *d2i_DSAPrivateKey(DSA **a, const unsigned char **pp, long length);
 220 DSA *d2i_DSAparams(DSA **a, const unsigned char **pp, long length);
 221
 222 /* Deprecated version */
 223 DEPRECATEDIN_0_9_8(DSA *DSA_generate_parameters(int bits,
 224                                                 unsigned char *seed,
 225                                                 int seed_len,
 226                                                 int *counter_ret,
 227                                                 unsigned long *h_ret, void
 228                                                  (*callback) (int, int,
 229                                                               void *),
 230                                                 void *cb_arg))
 231
 232 /* New version */
 233 int DSA_generate_parameters_ex(DSA *dsa, int bits,
 234                                const unsigned char *seed, int seed_len,
 235                                int *counter_ret, unsigned long *h_ret,
 236                                BN_GENCB *cb);
 237
 238 int DSA_generate_key(DSA *a);
 239 int i2d_DSAPublicKey(const DSA *a, unsigned char **pp);
 240 int i2d_DSAPrivateKey(const DSA *a, unsigned char **pp);
 241 int i2d_DSAparams(const DSA *a, unsigned char **pp);
 242
 243 int DSAparams_print(BIO *bp, const DSA *x);
 244 int DSA_print(BIO *bp, const DSA *x, int off);
 245 # ifndef OPENSSL_NO_STDIO
 246 int DSAparams_print_fp(FILE *fp, const DSA *x);
 247 int DSA_print_fp(FILE *bp, const DSA *x, int off);
 248 # endif
 249
 250 # define DSS_prime_checks 50
 251 /*
 252  * Primality test according to FIPS PUB 186[-1], Appendix 2.1: 50 rounds of
 253  * Rabin-Miller
 254  */
 255 # define DSA_is_prime(n, callback, cb_arg) \
 256         BN_is_prime(n, DSS_prime_checks, callback, NULL, cb_arg)
 257
 258 # ifndef OPENSSL_NO_DH
 259 /*
 260  * Convert DSA structure (key or just parameters) into DH structure (be
 261  * careful to avoid small subgroup attacks when using this!)
 262  */
 263 DH *DSA_dup_DH(const DSA *r);
 264 # endif
 265
 266 # define EVP_PKEY_CTX_set_dsa_paramgen_bits(ctx, nbits) \
 267         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DSA, EVP_PKEY_OP_PARAMGEN, \
 268                                 EVP_PKEY_CTRL_DSA_PARAMGEN_BITS, nbits, NULL)
 269
 270 # define EVP_PKEY_CTRL_DSA_PARAMGEN_BITS         (EVP_PKEY_ALG_CTRL + 1)
 271 # define EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS       (EVP_PKEY_ALG_CTRL + 2)
 272 # define EVP_PKEY_CTRL_DSA_PARAMGEN_MD           (EVP_PKEY_ALG_CTRL + 3)
 273
 274 /* BEGIN ERROR CODES */
 275 /*
 276  * The following lines are auto generated by the script mkerr.pl. Any changes
 277  * made after this point may be overwritten when the script is next run.
 278  */
 279 void ERR_load_DSA_strings(void);
 280
 281 /* Error codes for the DSA functions. */
 282
 283 /* Function codes. */
 284 # define DSA_F_D2I_DSA_SIG                                110
 285 # define DSA_F_DO_DSA_PRINT                               104
 286 # define DSA_F_DSAPARAMS_PRINT                            100
 287 # define DSA_F_DSAPARAMS_PRINT_FP                         101
 288 # define DSA_F_DSA_BUILTIN_KEYGEN                         124
 289 # define DSA_F_DSA_BUILTIN_PARAMGEN                       125
 290 # define DSA_F_DSA_BUILTIN_PARAMGEN2                      126
 291 # define DSA_F_DSA_DO_SIGN                                112
 292 # define DSA_F_DSA_DO_VERIFY                              113
 293 # define DSA_F_DSA_NEW_METHOD                             103
 294 # define DSA_F_DSA_PARAM_DECODE                           119
 295 # define DSA_F_DSA_PRINT_FP                               105
 296 # define DSA_F_DSA_PRIV_DECODE                            115
 297 # define DSA_F_DSA_PRIV_ENCODE                            116
 298 # define DSA_F_DSA_PUB_DECODE                             117
 299 # define DSA_F_DSA_PUB_ENCODE                             118
 300 # define DSA_F_DSA_SIGN                                   106
 301 # define DSA_F_DSA_SIGN_SETUP                             107
 302 # define DSA_F_DSA_SIG_NEW                                109
 303 # define DSA_F_DSA_SIG_PRINT                              123
 304 # define DSA_F_DSA_VERIFY                                 108
 305 # define DSA_F_I2D_DSA_SIG                                111
 306 # define DSA_F_OLD_DSA_PRIV_DECODE                        122
 307 # define DSA_F_PKEY_DSA_CTRL                              120
 308 # define DSA_F_PKEY_DSA_KEYGEN                            121
 309 # define DSA_F_SIG_CB                                     114
 310
 311 /* Reason codes. */
 312 # define DSA_R_BAD_Q_VALUE                                102
 313 # define DSA_R_BN_DECODE_ERROR                            108
 314 # define DSA_R_BN_ERROR                                   109
 315 # define DSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE                100
 316 # define DSA_R_DECODE_ERROR                               104
 317 # define DSA_R_INVALID_DIGEST_TYPE                        106
 318 # define DSA_R_INVALID_PARAMETERS                         112
 319 # define DSA_R_KEY_SIZE_TOO_SMALL                         111
 320 # define DSA_R_MISSING_PARAMETERS                         101
 321 # define DSA_R_MODULUS_TOO_LARGE                          103
 322 # define DSA_R_NEED_NEW_SETUP_VALUES                      110
 323 # define DSA_R_NO_PARAMETERS_SET                          107
 324 # define DSA_R_PARAMETER_ENCODING_ERROR                   105
 325 # define DSA_R_Q_NOT_PRIME                                113
 326
 327 #ifdef  __cplusplus
 328 }
 329 #endif
 330 #endif