dsa.h 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276
  1. /* $OpenBSD: dsa.h,v 1.44 2024/03/02 09:33:14 tb Exp $ */
  2. /* Copyright (C) 1995-1998 Eric Young ([email protected])
  3. * All rights reserved.
  4. *
  5. * This package is an SSL implementation written
  6. * by Eric Young ([email protected]).
  7. * The implementation was written so as to conform with Netscapes SSL.
  8. *
  9. * This library is free for commercial and non-commercial use as long as
  10. * the following conditions are aheared to. The following conditions
  11. * apply to all code found in this distribution, be it the RC4, RSA,
  12. * lhash, DES, etc., code; not just the SSL code. The SSL documentation
  13. * included with this distribution is covered by the same copyright terms
  14. * except that the holder is Tim Hudson ([email protected]).
  15. *
  16. * Copyright remains Eric Young's, and as such any Copyright notices in
  17. * the code are not to be removed.
  18. * If this package is used in a product, Eric Young should be given attribution
  19. * as the author of the parts of the library used.
  20. * This can be in the form of a textual message at program startup or
  21. * in documentation (online or textual) provided with the package.
  22. *
  23. * Redistribution and use in source and binary forms, with or without
  24. * modification, are permitted provided that the following conditions
  25. * are met:
  26. * 1. Redistributions of source code must retain the copyright
  27. * notice, this list of conditions and the following disclaimer.
  28. * 2. Redistributions in binary form must reproduce the above copyright
  29. * notice, this list of conditions and the following disclaimer in the
  30. * documentation and/or other materials provided with the distribution.
  31. * 3. All advertising materials mentioning features or use of this software
  32. * must display the following acknowledgement:
  33. * "This product includes cryptographic software written by
  34. * Eric Young ([email protected])"
  35. * The word 'cryptographic' can be left out if the rouines from the library
  36. * being used are not cryptographic related :-).
  37. * 4. If you include any Windows specific code (or a derivative thereof) from
  38. * the apps directory (application code) you must include an acknowledgement:
  39. * "This product includes software written by Tim Hudson ([email protected])"
  40. *
  41. * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  42. * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  43. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  44. * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  45. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  46. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  47. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  49. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  50. * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  51. * SUCH DAMAGE.
  52. *
  53. * The licence and distribution terms for any publically available version or
  54. * derivative of this code cannot be changed. i.e. this code cannot simply be
  55. * copied and put under another distribution licence
  56. * [including the GNU Public Licence.]
  57. */
  58. /*
  59. * The DSS routines are based on patches supplied by
  60. * Steven Schoch <[email protected]>. He basically did the
  61. * work and I have just tweaked them a little to fit into my
  62. * stylistic vision for SSLeay :-) */
  63. #ifndef HEADER_DSA_H
  64. #define HEADER_DSA_H
  65. #include <openssl/opensslconf.h>
  66. #ifdef OPENSSL_NO_DSA
  67. #error DSA is disabled.
  68. #endif
  69. #ifndef OPENSSL_NO_BIO
  70. #include <openssl/bio.h>
  71. #endif
  72. #include <openssl/bn.h>
  73. #include <openssl/crypto.h>
  74. #ifndef OPENSSL_NO_DH
  75. # include <openssl/dh.h>
  76. #endif
  77. #include <openssl/ossl_typ.h>
  78. #ifndef OPENSSL_DSA_MAX_MODULUS_BITS
  79. # define OPENSSL_DSA_MAX_MODULUS_BITS 10000
  80. #endif
  81. #define DSA_FLAG_CACHE_MONT_P 0x01
  82. /* If this flag is set the DSA method is FIPS compliant and can be used
  83. * in FIPS mode. This is set in the validated module method. If an
  84. * application sets this flag in its own methods it is its reposibility
  85. * to ensure the result is compliant.
  86. */
  87. #define DSA_FLAG_FIPS_METHOD 0x0400
  88. /* If this flag is set the operations normally disabled in FIPS mode are
  89. * permitted it is then the applications responsibility to ensure that the
  90. * usage is compliant.
  91. */
  92. #define DSA_FLAG_NON_FIPS_ALLOW 0x0400
  93. #ifdef __cplusplus
  94. extern "C" {
  95. #endif
  96. typedef struct DSA_SIG_st DSA_SIG;
  97. DSA *d2i_DSAparams_bio(BIO *bp, DSA **a);
  98. int i2d_DSAparams_bio(BIO *bp, DSA *a);
  99. DSA *d2i_DSAparams_fp(FILE *fp, DSA **a);
  100. int i2d_DSAparams_fp(FILE *fp, DSA *a);
  101. DSA *DSAparams_dup(DSA *x);
  102. DSA_SIG * DSA_SIG_new(void);
  103. void DSA_SIG_free(DSA_SIG *a);
  104. int i2d_DSA_SIG(const DSA_SIG *a, unsigned char **pp);
  105. DSA_SIG * d2i_DSA_SIG(DSA_SIG **v, const unsigned char **pp, long length);
  106. void DSA_SIG_get0(const DSA_SIG *sig, const BIGNUM **pr, const BIGNUM **ps);
  107. int DSA_SIG_set0(DSA_SIG *sig, BIGNUM *r, BIGNUM *s);
  108. DSA_SIG * DSA_do_sign(const unsigned char *dgst,int dlen,DSA *dsa);
  109. int DSA_do_verify(const unsigned char *dgst,int dgst_len,
  110. DSA_SIG *sig,DSA *dsa);
  111. const DSA_METHOD *DSA_OpenSSL(void);
  112. void DSA_set_default_method(const DSA_METHOD *);
  113. const DSA_METHOD *DSA_get_default_method(void);
  114. int DSA_set_method(DSA *dsa, const DSA_METHOD *);
  115. DSA * DSA_new(void);
  116. DSA * DSA_new_method(ENGINE *engine);
  117. void DSA_free(DSA *r);
  118. /* "up" the DSA object's reference count */
  119. int DSA_up_ref(DSA *r);
  120. int DSA_size(const DSA *);
  121. int DSA_bits(const DSA *d);
  122. /* next 4 return -1 on error */
  123. int DSA_sign_setup( DSA *dsa,BN_CTX *ctx_in,BIGNUM **kinvp,BIGNUM **rp);
  124. int DSA_sign(int type,const unsigned char *dgst,int dlen,
  125. unsigned char *sig, unsigned int *siglen, DSA *dsa);
  126. int DSA_verify(int type,const unsigned char *dgst,int dgst_len,
  127. const unsigned char *sigbuf, int siglen, DSA *dsa);
  128. int DSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
  129. CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
  130. int DSA_set_ex_data(DSA *d, int idx, void *arg);
  131. void *DSA_get_ex_data(DSA *d, int idx);
  132. int DSA_security_bits(const DSA *d);
  133. DSA *d2i_DSAPublicKey(DSA **a, const unsigned char **pp, long length);
  134. int i2d_DSAPublicKey(const DSA *a, unsigned char **pp);
  135. extern const ASN1_ITEM DSAPublicKey_it;
  136. DSA *d2i_DSAPrivateKey(DSA **a, const unsigned char **pp, long length);
  137. int i2d_DSAPrivateKey(const DSA *a, unsigned char **pp);
  138. extern const ASN1_ITEM DSAPrivateKey_it;
  139. DSA *d2i_DSAparams(DSA **a, const unsigned char **pp, long length);
  140. int i2d_DSAparams(const DSA *a,unsigned char **pp);
  141. extern const ASN1_ITEM DSAparams_it;
  142. /* New version */
  143. int DSA_generate_parameters_ex(DSA *dsa, int bits,
  144. const unsigned char *seed,int seed_len,
  145. int *counter_ret, unsigned long *h_ret, BN_GENCB *cb);
  146. int DSA_generate_key(DSA *a);
  147. #ifndef OPENSSL_NO_BIO
  148. int DSAparams_print(BIO *bp, const DSA *x);
  149. int DSA_print(BIO *bp, const DSA *x, int off);
  150. #endif
  151. int DSAparams_print_fp(FILE *fp, const DSA *x);
  152. int DSA_print_fp(FILE *bp, const DSA *x, int off);
  153. /*
  154. * Primality test according to FIPS PUB 186-4, Appendix C.3. Set the number
  155. * to 64 rounds of Miller-Rabin, which corresponds to 128 bits of security.
  156. * This is necessary for keys of size >= 3072.
  157. */
  158. #define DSS_prime_checks 64
  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. /* Convert DSA structure (key or just parameters) into DH structure
  163. * (be careful to avoid small subgroup attacks when using this!) */
  164. DH *DSA_dup_DH(const DSA *r);
  165. #endif
  166. void DSA_get0_pqg(const DSA *d, const BIGNUM **p, const BIGNUM **q,
  167. const BIGNUM **g);
  168. int DSA_set0_pqg(DSA *d, BIGNUM *p, BIGNUM *q, BIGNUM *g);
  169. void DSA_get0_key(const DSA *d, const BIGNUM **pub_key, const BIGNUM **priv_key);
  170. int DSA_set0_key(DSA *d, BIGNUM *pub_key, BIGNUM *priv_key);
  171. const BIGNUM *DSA_get0_p(const DSA *d);
  172. const BIGNUM *DSA_get0_q(const DSA *d);
  173. const BIGNUM *DSA_get0_g(const DSA *d);
  174. const BIGNUM *DSA_get0_pub_key(const DSA *d);
  175. const BIGNUM *DSA_get0_priv_key(const DSA *d);
  176. void DSA_clear_flags(DSA *d, int flags);
  177. int DSA_test_flags(const DSA *d, int flags);
  178. void DSA_set_flags(DSA *d, int flags);
  179. ENGINE *DSA_get0_engine(DSA *d);
  180. DSA_METHOD *DSA_meth_new(const char *name, int flags);
  181. void DSA_meth_free(DSA_METHOD *meth);
  182. DSA_METHOD *DSA_meth_dup(const DSA_METHOD *meth);
  183. const char *DSA_meth_get0_name(const DSA_METHOD *meth);
  184. int DSA_meth_set1_name(DSA_METHOD *meth, const char *name);
  185. int DSA_meth_set_sign(DSA_METHOD *meth,
  186. DSA_SIG *(*sign)(const unsigned char *, int, DSA *));
  187. int DSA_meth_set_finish(DSA_METHOD *meth, int (*finish)(DSA *));
  188. #define EVP_PKEY_CTX_set_dsa_paramgen_bits(ctx, nbits) \
  189. EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DSA, EVP_PKEY_OP_PARAMGEN, \
  190. EVP_PKEY_CTRL_DSA_PARAMGEN_BITS, nbits, NULL)
  191. #define EVP_PKEY_CTRL_DSA_PARAMGEN_BITS (EVP_PKEY_ALG_CTRL + 1)
  192. #define EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS (EVP_PKEY_ALG_CTRL + 2)
  193. #define EVP_PKEY_CTRL_DSA_PARAMGEN_MD (EVP_PKEY_ALG_CTRL + 3)
  194. void ERR_load_DSA_strings(void);
  195. /* Error codes for the DSA functions. */
  196. /* Function codes. */
  197. #define DSA_F_D2I_DSA_SIG 110
  198. #define DSA_F_DO_DSA_PRINT 104
  199. #define DSA_F_DSAPARAMS_PRINT 100
  200. #define DSA_F_DSAPARAMS_PRINT_FP 101
  201. #define DSA_F_DSA_DO_SIGN 112
  202. #define DSA_F_DSA_DO_VERIFY 113
  203. #define DSA_F_DSA_GENERATE_KEY 124
  204. #define DSA_F_DSA_GENERATE_PARAMETERS_EX 123
  205. #define DSA_F_DSA_NEW_METHOD 103
  206. #define DSA_F_DSA_PARAM_DECODE 119
  207. #define DSA_F_DSA_PRINT_FP 105
  208. #define DSA_F_DSA_PRIV_DECODE 115
  209. #define DSA_F_DSA_PRIV_ENCODE 116
  210. #define DSA_F_DSA_PUB_DECODE 117
  211. #define DSA_F_DSA_PUB_ENCODE 118
  212. #define DSA_F_DSA_SIGN 106
  213. #define DSA_F_DSA_SIGN_SETUP 107
  214. #define DSA_F_DSA_SIG_NEW 109
  215. #define DSA_F_DSA_SIG_PRINT 125
  216. #define DSA_F_DSA_VERIFY 108
  217. #define DSA_F_I2D_DSA_SIG 111
  218. #define DSA_F_OLD_DSA_PRIV_DECODE 122
  219. #define DSA_F_PKEY_DSA_CTRL 120
  220. #define DSA_F_PKEY_DSA_KEYGEN 121
  221. #define DSA_F_SIG_CB 114
  222. /* Reason codes. */
  223. #define DSA_R_BAD_Q_VALUE 102
  224. #define DSA_R_BN_DECODE_ERROR 108
  225. #define DSA_R_BN_ERROR 109
  226. #define DSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE 100
  227. #define DSA_R_DECODE_ERROR 104
  228. #define DSA_R_INVALID_DIGEST_TYPE 106
  229. #define DSA_R_INVALID_PARAMETERS 112
  230. #define DSA_R_MISSING_PARAMETERS 101
  231. #define DSA_R_MODULUS_TOO_LARGE 103
  232. #define DSA_R_NEED_NEW_SETUP_VALUES 110
  233. #define DSA_R_NON_FIPS_DSA_METHOD 111
  234. #define DSA_R_NO_PARAMETERS_SET 107
  235. #define DSA_R_PARAMETER_ENCODING_ERROR 105
  236. #ifdef __cplusplus
  237. }
  238. #endif
  239. #endif