dsa.h 12 KB

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