You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

dsa.h 11 kB

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