include/openssl/dsa.h

   1 /*
   2  * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #ifndef HEADER_DSA_H
  11 # define HEADER_DSA_H
  12
  13 # include <openssl/opensslconf.h>
  14
  15 # ifndef OPENSSL_NO_DSA
  16 # ifdef  __cplusplus
  17 extern "C" {
  18 # endif
  19 # include <openssl/e_os2.h>
  20 # include <openssl/asn1.h>
  21 # include <openssl/bio.h>
  22 # include <openssl/crypto.h>
  23 # include <openssl/ossl_typ.h>
  24 # include <openssl/bn.h>
  25 # if !OPENSSL_API_1_1_0
  26 #  include <openssl/dh.h>
  27 # endif
  28 # include <openssl/dsaerr.h>
  29
  30 # ifndef OPENSSL_DSA_MAX_MODULUS_BITS
  31 #  define OPENSSL_DSA_MAX_MODULUS_BITS   10000
  32 # endif
  33
  34 # define OPENSSL_DSA_FIPS_MIN_MODULUS_BITS 1024
  35
  36 # define DSA_FLAG_CACHE_MONT_P   0x01
  37 # if !OPENSSL_API_1_1_0
  38 /*
  39  * Does nothing. Previously this switched off constant time behaviour.
  40  */
  41 #  define DSA_FLAG_NO_EXP_CONSTTIME       0x00
  42 # endif
  43
  44 /*
  45  * If this flag is set the DSA method is FIPS compliant and can be used in
  46  * FIPS mode. This is set in the validated module method. If an application
  47  * sets this flag in its own methods it is its responsibility to ensure the
  48  * result is compliant.
  49  */
  50
  51 # define DSA_FLAG_FIPS_METHOD                    0x0400
  52
  53 /*
  54  * If this flag is set the operations normally disabled in FIPS mode are
  55  * permitted it is then the applications responsibility to ensure that the
  56  * usage is compliant.
  57  */
  58
  59 # define DSA_FLAG_NON_FIPS_ALLOW                 0x0400
  60 # define DSA_FLAG_FIPS_CHECKED                   0x0800
  61
  62 /* Already defined in ossl_typ.h */
  63 /* typedef struct dsa_st DSA; */
  64 /* typedef struct dsa_method DSA_METHOD; */
  65
  66 typedef struct DSA_SIG_st DSA_SIG;
  67
  68 # define d2i_DSAparams_fp(fp,x) (DSA *)ASN1_d2i_fp((char *(*)())DSA_new, \
  69                 (char *(*)())d2i_DSAparams,(fp),(unsigned char **)(x))
  70 # define i2d_DSAparams_fp(fp,x) ASN1_i2d_fp(i2d_DSAparams,(fp), \
  71                 (unsigned char *)(x))
  72 # define d2i_DSAparams_bio(bp,x) ASN1_d2i_bio_of(DSA,DSA_new,d2i_DSAparams,bp,x)
  73 # define i2d_DSAparams_bio(bp,x) ASN1_i2d_bio_of(DSA,i2d_DSAparams,bp,x)
  74
  75 DECLARE_ASN1_DUP_FUNCTION_name(DSA, DSAparams)
  76 DSA_SIG *DSA_SIG_new(void);
  77 void DSA_SIG_free(DSA_SIG *a);
  78 DECLARE_ASN1_ENCODE_FUNCTIONS_only(DSA_SIG, DSA_SIG)
  79 void DSA_SIG_get0(const DSA_SIG *sig, const BIGNUM **pr, const BIGNUM **ps);
  80 int DSA_SIG_set0(DSA_SIG *sig, BIGNUM *r, BIGNUM *s);
  81
  82 DSA_SIG *DSA_do_sign(const unsigned char *dgst, int dlen, DSA *dsa);
  83 int DSA_do_verify(const unsigned char *dgst, int dgst_len,
  84                   DSA_SIG *sig, DSA *dsa);
  85
  86 const DSA_METHOD *DSA_OpenSSL(void);
  87
  88 void DSA_set_default_method(const DSA_METHOD *);
  89 const DSA_METHOD *DSA_get_default_method(void);
  90 int DSA_set_method(DSA *dsa, const DSA_METHOD *);
  91 const DSA_METHOD *DSA_get_method(DSA *d);
  92
  93 DSA *DSA_new(void);
  94 DSA *DSA_new_method(ENGINE *engine);
  95 void DSA_free(DSA *r);
  96 /* "up" the DSA object's reference count */
  97 int DSA_up_ref(DSA *r);
  98 int DSA_size(const DSA *);
  99 int DSA_bits(const DSA *d);
 100 int DSA_security_bits(const DSA *d);
 101         /* next 4 return -1 on error */
 102 DEPRECATEDIN_3(int DSA_sign_setup(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp, BIGNUM **rp))
 103 int DSA_sign(int type, const unsigned char *dgst, int dlen,
 104              unsigned char *sig, unsigned int *siglen, DSA *dsa);
 105 int DSA_verify(int type, const unsigned char *dgst, int dgst_len,
 106                const unsigned char *sigbuf, int siglen, DSA *dsa);
 107 #define DSA_get_ex_new_index(l, p, newf, dupf, freef) \
 108     CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_DSA, l, p, newf, dupf, freef)
 109 int DSA_set_ex_data(DSA *d, int idx, void *arg);
 110 void *DSA_get_ex_data(DSA *d, int idx);
 111
 112 DECLARE_ASN1_ENCODE_FUNCTIONS_only(DSA, DSAPublicKey)
 113 DECLARE_ASN1_ENCODE_FUNCTIONS_only(DSA, DSAPrivateKey)
 114 DECLARE_ASN1_ENCODE_FUNCTIONS_only(DSA, DSAparams)
 115
 116 /* Deprecated version */
 117 DEPRECATEDIN_0_9_8(DSA *DSA_generate_parameters(int bits,
 118                                                 unsigned char *seed,
 119                                                 int seed_len,
 120                                                 int *counter_ret,
 121                                                 unsigned long *h_ret, void
 122                                                  (*callback) (int, int,
 123                                                               void *),
 124                                                 void *cb_arg))
 125
 126 /* New version */
 127 int DSA_generate_parameters_ex(DSA *dsa, int bits,
 128                                const unsigned char *seed, int seed_len,
 129                                int *counter_ret, unsigned long *h_ret,
 130                                BN_GENCB *cb);
 131
 132 int DSA_generate_key(DSA *a);
 133
 134 int DSAparams_print(BIO *bp, const DSA *x);
 135 int DSA_print(BIO *bp, const DSA *x, int off);
 136 # ifndef OPENSSL_NO_STDIO
 137 int DSAparams_print_fp(FILE *fp, const DSA *x);
 138 int DSA_print_fp(FILE *bp, const DSA *x, int off);
 139 # endif
 140
 141 # define DSS_prime_checks 64
 142 /*
 143  * Primality test according to FIPS PUB 186-4, Appendix C.3. Since we only
 144  * have one value here we set the number of checks to 64 which is the 128 bit
 145  * security level that is the highest level and valid for creating a 3072 bit
 146  * DSA key.
 147  */
 148 # define DSA_is_prime(n, callback, cb_arg) \
 149         BN_is_prime(n, DSS_prime_checks, callback, NULL, cb_arg)
 150
 151 # ifndef OPENSSL_NO_DH
 152 /*
 153  * Convert DSA structure (key or just parameters) into DH structure (be
 154  * careful to avoid small subgroup attacks when using this!)
 155  */
 156 DH *DSA_dup_DH(const DSA *r);
 157 # endif
 158
 159 # define EVP_PKEY_CTX_set_dsa_paramgen_bits(ctx, nbits) \
 160         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DSA, EVP_PKEY_OP_PARAMGEN, \
 161                                 EVP_PKEY_CTRL_DSA_PARAMGEN_BITS, nbits, NULL)
 162 # define EVP_PKEY_CTX_set_dsa_paramgen_q_bits(ctx, qbits) \
 163         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DSA, EVP_PKEY_OP_PARAMGEN, \
 164                                 EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS, qbits, NULL)
 165 # define EVP_PKEY_CTX_set_dsa_paramgen_md(ctx, md) \
 166         EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DSA, EVP_PKEY_OP_PARAMGEN, \
 167                                 EVP_PKEY_CTRL_DSA_PARAMGEN_MD, 0, (void *)(md))
 168
 169 # define EVP_PKEY_CTRL_DSA_PARAMGEN_BITS         (EVP_PKEY_ALG_CTRL + 1)
 170 # define EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS       (EVP_PKEY_ALG_CTRL + 2)
 171 # define EVP_PKEY_CTRL_DSA_PARAMGEN_MD           (EVP_PKEY_ALG_CTRL + 3)
 172
 173 void DSA_get0_pqg(const DSA *d,
 174                   const BIGNUM **p, const BIGNUM **q, const BIGNUM **g);
 175 int DSA_set0_pqg(DSA *d, BIGNUM *p, BIGNUM *q, BIGNUM *g);
 176 void DSA_get0_key(const DSA *d,
 177                   const BIGNUM **pub_key, const BIGNUM **priv_key);
 178 int DSA_set0_key(DSA *d, BIGNUM *pub_key, BIGNUM *priv_key);
 179 const BIGNUM *DSA_get0_p(const DSA *d);
 180 const BIGNUM *DSA_get0_q(const DSA *d);
 181 const BIGNUM *DSA_get0_g(const DSA *d);
 182 const BIGNUM *DSA_get0_pub_key(const DSA *d);
 183 const BIGNUM *DSA_get0_priv_key(const DSA *d);
 184 void DSA_clear_flags(DSA *d, int flags);
 185 int DSA_test_flags(const DSA *d, int flags);
 186 void DSA_set_flags(DSA *d, int flags);
 187 ENGINE *DSA_get0_engine(DSA *d);
 188
 189 DSA_METHOD *DSA_meth_new(const char *name, int flags);
 190 void DSA_meth_free(DSA_METHOD *dsam);
 191 DSA_METHOD *DSA_meth_dup(const DSA_METHOD *dsam);
 192 const char *DSA_meth_get0_name(const DSA_METHOD *dsam);
 193 int DSA_meth_set1_name(DSA_METHOD *dsam, const char *name);
 194 int DSA_meth_get_flags(const DSA_METHOD *dsam);
 195 int DSA_meth_set_flags(DSA_METHOD *dsam, int flags);
 196 void *DSA_meth_get0_app_data(const DSA_METHOD *dsam);
 197 int DSA_meth_set0_app_data(DSA_METHOD *dsam, void *app_data);
 198 DSA_SIG *(*DSA_meth_get_sign(const DSA_METHOD *dsam))
 199         (const unsigned char *, int, DSA *);
 200 int DSA_meth_set_sign(DSA_METHOD *dsam,
 201                        DSA_SIG *(*sign) (const unsigned char *, int, DSA *));
 202 int (*DSA_meth_get_sign_setup(const DSA_METHOD *dsam))
 203         (DSA *, BN_CTX *, BIGNUM **, BIGNUM **);
 204 int DSA_meth_set_sign_setup(DSA_METHOD *dsam,
 205         int (*sign_setup) (DSA *, BN_CTX *, BIGNUM **, BIGNUM **));
 206 int (*DSA_meth_get_verify(const DSA_METHOD *dsam))
 207         (const unsigned char *, int, DSA_SIG *, DSA *);
 208 int DSA_meth_set_verify(DSA_METHOD *dsam,
 209     int (*verify) (const unsigned char *, int, DSA_SIG *, DSA *));
 210 int (*DSA_meth_get_mod_exp(const DSA_METHOD *dsam))
 211         (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *, const BIGNUM *,
 212          const BIGNUM *, const BIGNUM *, BN_CTX *, BN_MONT_CTX *);
 213 int DSA_meth_set_mod_exp(DSA_METHOD *dsam,
 214     int (*mod_exp) (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *,
 215                     const BIGNUM *, const BIGNUM *, const BIGNUM *, BN_CTX *,
 216                     BN_MONT_CTX *));
 217 int (*DSA_meth_get_bn_mod_exp(const DSA_METHOD *dsam))
 218     (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *, const BIGNUM *,
 219      BN_CTX *, BN_MONT_CTX *);
 220 int DSA_meth_set_bn_mod_exp(DSA_METHOD *dsam,
 221     int (*bn_mod_exp) (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *,
 222                        const BIGNUM *, BN_CTX *, BN_MONT_CTX *));
 223 int (*DSA_meth_get_init(const DSA_METHOD *dsam))(DSA *);
 224 int DSA_meth_set_init(DSA_METHOD *dsam, int (*init)(DSA *));
 225 int (*DSA_meth_get_finish(const DSA_METHOD *dsam)) (DSA *);
 226 int DSA_meth_set_finish(DSA_METHOD *dsam, int (*finish) (DSA *));
 227 int (*DSA_meth_get_paramgen(const DSA_METHOD *dsam))
 228         (DSA *, int, const unsigned char *, int, int *, unsigned long *,
 229          BN_GENCB *);
 230 int DSA_meth_set_paramgen(DSA_METHOD *dsam,
 231         int (*paramgen) (DSA *, int, const unsigned char *, int, int *,
 232                          unsigned long *, BN_GENCB *));
 233 int (*DSA_meth_get_keygen(const DSA_METHOD *dsam)) (DSA *);
 234 int DSA_meth_set_keygen(DSA_METHOD *dsam, int (*keygen) (DSA *));
 235
 236
 237 #  ifdef  __cplusplus
 238 }
 239 #  endif
 240 # endif
 241 #endif