include/openssl/dsa.h

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