include/openssl/dsa.h

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