1 /* 2 * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved. 3 * 4 * Licensed under the OpenSSL license (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/bio.h> 21 # include <openssl/crypto.h> 22 # include <openssl/ossl_typ.h> 23 # include <openssl/bn.h> 24 # if OPENSSL_API_COMPAT < 0x10100000L 25 # include <openssl/dh.h> 26 # endif 27 # include <openssl/dsaerr.h> 28 29 # ifndef OPENSSL_DSA_MAX_MODULUS_BITS 30 # define OPENSSL_DSA_MAX_MODULUS_BITS 10000 31 # endif 32 33 # define OPENSSL_DSA_FIPS_MIN_MODULUS_BITS 1024 34 35 # define DSA_FLAG_CACHE_MONT_P 0x01 36 # if OPENSSL_API_COMPAT < 0x10100000L 37 /* 38 * Does nothing. Previously this switched off constant time behaviour. 39 */ 40 # define DSA_FLAG_NO_EXP_CONSTTIME 0x00 41 # endif 42 43 /* 44 * If this flag is set the DSA method is FIPS compliant and can be used in 45 * FIPS mode. This is set in the validated module method. If an application 46 * sets this flag in its own methods it is its responsibility to ensure the 47 * result is compliant. 48 */ 49 50 # define DSA_FLAG_FIPS_METHOD 0x0400 51 52 /* 53 * If this flag is set the operations normally disabled in FIPS mode are 54 * permitted it is then the applications responsibility to ensure that the 55 * usage is compliant. 56 */ 57 58 # define DSA_FLAG_NON_FIPS_ALLOW 0x0400 59 # define DSA_FLAG_FIPS_CHECKED 0x0800 60 61 /* Already defined in ossl_typ.h */ 62 /* typedef struct dsa_st DSA; */ 63 /* typedef struct dsa_method DSA_METHOD; */ 64 65 typedef struct DSA_SIG_st DSA_SIG; 66 67 # define d2i_DSAparams_fp(fp,x) (DSA *)ASN1_d2i_fp((char *(*)())DSA_new, \ 68 (char *(*)())d2i_DSAparams,(fp),(unsigned char **)(x)) 69 # define i2d_DSAparams_fp(fp,x) ASN1_i2d_fp(i2d_DSAparams,(fp), \ 70 (unsigned char *)(x)) 71 # define d2i_DSAparams_bio(bp,x) ASN1_d2i_bio_of(DSA,DSA_new,d2i_DSAparams,bp,x) 72 # define i2d_DSAparams_bio(bp,x) ASN1_i2d_bio_of_const(DSA,i2d_DSAparams,bp,x) 73 74 DSA *DSAparams_dup(DSA *x); 75 DSA_SIG *DSA_SIG_new(void); 76 void DSA_SIG_free(DSA_SIG *a); 77 int i2d_DSA_SIG(const DSA_SIG *a, unsigned char **pp); 78 DSA_SIG *d2i_DSA_SIG(DSA_SIG **v, const unsigned char **pp, long length); 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_1_2_0(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 DSA *d2i_DSAPublicKey(DSA **a, const unsigned char **pp, long length); 113 DSA *d2i_DSAPrivateKey(DSA **a, const unsigned char **pp, long length); 114 DSA *d2i_DSAparams(DSA **a, const unsigned char **pp, long length); 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 int i2d_DSAPublicKey(const DSA *a, unsigned char **pp); 134 int i2d_DSAPrivateKey(const DSA *a, unsigned char **pp); 135 int i2d_DSAparams(const DSA *a, unsigned char **pp); 136 137 int DSAparams_print(BIO *bp, const DSA *x); 138 int DSA_print(BIO *bp, const DSA *x, int off); 139 # ifndef OPENSSL_NO_STDIO 140 int DSAparams_print_fp(FILE *fp, const DSA *x); 141 int DSA_print_fp(FILE *bp, const DSA *x, int off); 142 # endif 143 144 # define DSS_prime_checks 64 145 /* 146 * Primality test according to FIPS PUB 186-4, Appendix C.3. Since we only 147 * have one value here we set the number of checks to 64 which is the 128 bit 148 * security level that is the highest level and valid for creating a 3072 bit 149 * DSA key. 150 */ 151 # define DSA_is_prime(n, callback, cb_arg) \ 152 BN_is_prime(n, DSS_prime_checks, callback, NULL, cb_arg) 153 154 # ifndef OPENSSL_NO_DH 155 /* 156 * Convert DSA structure (key or just parameters) into DH structure (be 157 * careful to avoid small subgroup attacks when using this!) 158 */ 159 DH *DSA_dup_DH(const DSA *r); 160 # endif 161 162 # define EVP_PKEY_CTX_set_dsa_paramgen_bits(ctx, nbits) \ 163 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DSA, EVP_PKEY_OP_PARAMGEN, \ 164 EVP_PKEY_CTRL_DSA_PARAMGEN_BITS, nbits, NULL) 165 # define EVP_PKEY_CTX_set_dsa_paramgen_q_bits(ctx, qbits) \ 166 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DSA, EVP_PKEY_OP_PARAMGEN, \ 167 EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS, qbits, NULL) 168 # define EVP_PKEY_CTX_set_dsa_paramgen_md(ctx, md) \ 169 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DSA, EVP_PKEY_OP_PARAMGEN, \ 170 EVP_PKEY_CTRL_DSA_PARAMGEN_MD, 0, (void *)(md)) 171 172 # define EVP_PKEY_CTRL_DSA_PARAMGEN_BITS (EVP_PKEY_ALG_CTRL + 1) 173 # define EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS (EVP_PKEY_ALG_CTRL + 2) 174 # define EVP_PKEY_CTRL_DSA_PARAMGEN_MD (EVP_PKEY_ALG_CTRL + 3) 175 176 void DSA_get0_pqg(const DSA *d, 177 const BIGNUM **p, const BIGNUM **q, const BIGNUM **g); 178 int DSA_set0_pqg(DSA *d, BIGNUM *p, BIGNUM *q, BIGNUM *g); 179 void DSA_get0_key(const DSA *d, 180 const BIGNUM **pub_key, const BIGNUM **priv_key); 181 int DSA_set0_key(DSA *d, BIGNUM *pub_key, BIGNUM *priv_key); 182 const BIGNUM *DSA_get0_p(const DSA *d); 183 const BIGNUM *DSA_get0_q(const DSA *d); 184 const BIGNUM *DSA_get0_g(const DSA *d); 185 const BIGNUM *DSA_get0_pub_key(const DSA *d); 186 const BIGNUM *DSA_get0_priv_key(const DSA *d); 187 void DSA_clear_flags(DSA *d, int flags); 188 int DSA_test_flags(const DSA *d, int flags); 189 void DSA_set_flags(DSA *d, int flags); 190 ENGINE *DSA_get0_engine(DSA *d); 191 192 DSA_METHOD *DSA_meth_new(const char *name, int flags); 193 void DSA_meth_free(DSA_METHOD *dsam); 194 DSA_METHOD *DSA_meth_dup(const DSA_METHOD *dsam); 195 const char *DSA_meth_get0_name(const DSA_METHOD *dsam); 196 int DSA_meth_set1_name(DSA_METHOD *dsam, const char *name); 197 int DSA_meth_get_flags(const DSA_METHOD *dsam); 198 int DSA_meth_set_flags(DSA_METHOD *dsam, int flags); 199 void *DSA_meth_get0_app_data(const DSA_METHOD *dsam); 200 int DSA_meth_set0_app_data(DSA_METHOD *dsam, void *app_data); 201 DSA_SIG *(*DSA_meth_get_sign(const DSA_METHOD *dsam)) 202 (const unsigned char *, int, DSA *); 203 int DSA_meth_set_sign(DSA_METHOD *dsam, 204 DSA_SIG *(*sign) (const unsigned char *, int, DSA *)); 205 int (*DSA_meth_get_sign_setup(const DSA_METHOD *dsam)) 206 (DSA *, BN_CTX *, BIGNUM **, BIGNUM **); 207 int DSA_meth_set_sign_setup(DSA_METHOD *dsam, 208 int (*sign_setup) (DSA *, BN_CTX *, BIGNUM **, BIGNUM **)); 209 int (*DSA_meth_get_verify(const DSA_METHOD *dsam)) 210 (const unsigned char *, int, DSA_SIG *, DSA *); 211 int DSA_meth_set_verify(DSA_METHOD *dsam, 212 int (*verify) (const unsigned char *, int, DSA_SIG *, DSA *)); 213 int (*DSA_meth_get_mod_exp(const DSA_METHOD *dsam)) 214 (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *, const BIGNUM *, 215 const BIGNUM *, const BIGNUM *, BN_CTX *, BN_MONT_CTX *); 216 int DSA_meth_set_mod_exp(DSA_METHOD *dsam, 217 int (*mod_exp) (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *, 218 const BIGNUM *, const BIGNUM *, const BIGNUM *, BN_CTX *, 219 BN_MONT_CTX *)); 220 int (*DSA_meth_get_bn_mod_exp(const DSA_METHOD *dsam)) 221 (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *, const BIGNUM *, 222 BN_CTX *, BN_MONT_CTX *); 223 int DSA_meth_set_bn_mod_exp(DSA_METHOD *dsam, 224 int (*bn_mod_exp) (DSA *, BIGNUM *, const BIGNUM *, const BIGNUM *, 225 const BIGNUM *, BN_CTX *, BN_MONT_CTX *)); 226 int (*DSA_meth_get_init(const DSA_METHOD *dsam))(DSA *); 227 int DSA_meth_set_init(DSA_METHOD *dsam, int (*init)(DSA *)); 228 int (*DSA_meth_get_finish(const DSA_METHOD *dsam)) (DSA *); 229 int DSA_meth_set_finish(DSA_METHOD *dsam, int (*finish) (DSA *)); 230 int (*DSA_meth_get_paramgen(const DSA_METHOD *dsam)) 231 (DSA *, int, const unsigned char *, int, int *, unsigned long *, 232 BN_GENCB *); 233 int DSA_meth_set_paramgen(DSA_METHOD *dsam, 234 int (*paramgen) (DSA *, int, const unsigned char *, int, int *, 235 unsigned long *, BN_GENCB *)); 236 int (*DSA_meth_get_keygen(const DSA_METHOD *dsam)) (DSA *); 237 int DSA_meth_set_keygen(DSA_METHOD *dsam, int (*keygen) (DSA *)); 238 239 240 # ifdef __cplusplus 241 } 242 # endif 243 # endif 244 #endif 245