dsa.h 12 KB

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