dsa.h 9.8 KB

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