A local copy of OpenSSL from GitHub
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

287 lines
12 KiB

This is a first-cut at improving the callback mechanisms used in key-generation and prime-checking functions. Rather than explicitly passing callback functions and caller-defined context data for the callbacks, a new structure BN_GENCB is defined that encapsulates this; a pointer to the structure is passed to all such functions instead. This wrapper structure allows the encapsulation of "old" and "new" style callbacks - "new" callbacks return a boolean result on the understanding that returning FALSE should terminate keygen/primality processing. The BN_GENCB abstraction will allow future callback modifications without needing to break binary compatibility nor change the API function prototypes. The new API functions have been given names ending in "_ex" and the old functions are implemented as wrappers to the new ones. The OPENSSL_NO_DEPRECATED symbol has been introduced so that, if defined, declaration of the older functions will be skipped. NB: Some openssl-internal code will stick with the older callbacks for now, so appropriate "#undef" logic will be put in place - this is in case the user is *building* openssl (rather than *including* its headers) with this symbol defined. There is another change in the new _ex functions; the key-generation functions do not return key structures but operate on structures passed by the caller, the return value is a boolean. This will allow for a smoother transition to having key-generation as "virtual function" in the various ***_METHOD tables.
20 years ago
This is a first-cut at improving the callback mechanisms used in key-generation and prime-checking functions. Rather than explicitly passing callback functions and caller-defined context data for the callbacks, a new structure BN_GENCB is defined that encapsulates this; a pointer to the structure is passed to all such functions instead. This wrapper structure allows the encapsulation of "old" and "new" style callbacks - "new" callbacks return a boolean result on the understanding that returning FALSE should terminate keygen/primality processing. The BN_GENCB abstraction will allow future callback modifications without needing to break binary compatibility nor change the API function prototypes. The new API functions have been given names ending in "_ex" and the old functions are implemented as wrappers to the new ones. The OPENSSL_NO_DEPRECATED symbol has been introduced so that, if defined, declaration of the older functions will be skipped. NB: Some openssl-internal code will stick with the older callbacks for now, so appropriate "#undef" logic will be put in place - this is in case the user is *building* openssl (rather than *including* its headers) with this symbol defined. There is another change in the new _ex functions; the key-generation functions do not return key structures but operate on structures passed by the caller, the return value is a boolean. This will allow for a smoother transition to having key-generation as "virtual function" in the various ***_METHOD tables.
20 years ago
  1. /*
  2. * Copyright 1995-2016 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. /*
  35. * new with 0.9.7h; the built-in DSA implementation now uses constant time
  36. * modular exponentiation for secret exponents by default. This flag causes
  37. * the faster variable sliding window method to be used for all exponents.
  38. */
  39. # define DSA_FLAG_NO_EXP_CONSTTIME 0x02
  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(BIGNUM **pr, BIGNUM **ps, const DSA_SIG *sig);
  70. DSA_SIG *DSA_do_sign(const unsigned char *dgst, int dlen, DSA *dsa);
  71. int DSA_do_verify(const unsigned char *dgst, int dgst_len,
  72. DSA_SIG *sig, DSA *dsa);
  73. const DSA_METHOD *DSA_OpenSSL(void);
  74. void DSA_set_default_method(const DSA_METHOD *);
  75. const DSA_METHOD *DSA_get_default_method(void);
  76. int DSA_set_method(DSA *dsa, const DSA_METHOD *);
  77. const DSA_METHOD *DSA_get_method(DSA *d);
  78. DSA *DSA_new(void);
  79. DSA *DSA_new_method(ENGINE *engine);
  80. void DSA_free(DSA *r);
  81. /* "up" the DSA object's reference count */
  82. int DSA_up_ref(DSA *r);
  83. int DSA_size(const DSA *);
  84. int DSA_security_bits(const DSA *d);
  85. /* next 4 return -1 on error */
  86. int DSA_sign_setup(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp, BIGNUM **rp);
  87. int DSA_sign(int type, const unsigned char *dgst, int dlen,
  88. unsigned char *sig, unsigned int *siglen, DSA *dsa);
  89. int DSA_verify(int type, const unsigned char *dgst, int dgst_len,
  90. const unsigned char *sigbuf, int siglen, DSA *dsa);
  91. #define DSA_get_ex_new_index(l, p, newf, dupf, freef) \
  92. CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_DSA, l, p, newf, dupf, freef)
  93. int DSA_set_ex_data(DSA *d, int idx, void *arg);
  94. void *DSA_get_ex_data(DSA *d, int idx);
  95. DSA *d2i_DSAPublicKey(DSA **a, const unsigned char **pp, long length);
  96. DSA *d2i_DSAPrivateKey(DSA **a, const unsigned char **pp, long length);
  97. DSA *d2i_DSAparams(DSA **a, const unsigned char **pp, long length);
  98. /* Deprecated version */
  99. DEPRECATEDIN_0_9_8(DSA *DSA_generate_parameters(int bits,
  100. unsigned char *seed,
  101. int seed_len,
  102. int *counter_ret,
  103. unsigned long *h_ret, void
  104. (*callback) (int, int,
  105. void *),
  106. void *cb_arg))
  107. /* New version */
  108. int DSA_generate_parameters_ex(DSA *dsa, int bits,
  109. const unsigned char *seed, int seed_len,
  110. int *counter_ret, unsigned long *h_ret,
  111. BN_GENCB *cb);
  112. int DSA_generate_key(DSA *a);
  113. int i2d_DSAPublicKey(const DSA *a, unsigned char **pp);
  114. int i2d_DSAPrivateKey(const DSA *a, unsigned char **pp);
  115. int i2d_DSAparams(const DSA *a, unsigned char **pp);
  116. int DSAparams_print(BIO *bp, const DSA *x);
  117. int DSA_print(BIO *bp, const DSA *x, int off);
  118. # ifndef OPENSSL_NO_STDIO
  119. int DSAparams_print_fp(FILE *fp, const DSA *x);
  120. int DSA_print_fp(FILE *bp, const DSA *x, int off);
  121. # endif
  122. # define DSS_prime_checks 50
  123. /*
  124. * Primality test according to FIPS PUB 186[-1], Appendix 2.1: 50 rounds of
  125. * Rabin-Miller
  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_CTRL_DSA_PARAMGEN_BITS (EVP_PKEY_ALG_CTRL + 1)
  140. # define EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS (EVP_PKEY_ALG_CTRL + 2)
  141. # define EVP_PKEY_CTRL_DSA_PARAMGEN_MD (EVP_PKEY_ALG_CTRL + 3)
  142. void DSA_get0_pqg(const DSA *d, BIGNUM **p, BIGNUM **q, BIGNUM **g);
  143. int DSA_set0_pqg(DSA *d, BIGNUM *p, BIGNUM *q, BIGNUM *g);
  144. void DSA_get0_key(const DSA *d, BIGNUM **pub_key, BIGNUM **priv_key);
  145. int DSA_set0_key(DSA *d, BIGNUM *pub_key, BIGNUM *priv_key);
  146. void DSA_clear_flags(DSA *d, int flags);
  147. int DSA_test_flags(const DSA *d, int flags);
  148. void DSA_set_flags(DSA *d, int flags);
  149. ENGINE *DSA_get0_engine(DSA *d);
  150. DSA_METHOD *DSA_meth_new(const char *name, int flags);
  151. void DSA_meth_free(DSA_METHOD *dsam);
  152. DSA_METHOD *DSA_meth_dup(const DSA_METHOD *dsam);
  153. const char *DSA_meth_get0_name(const DSA_METHOD *dsam);
  154. int DSA_meth_set1_name(DSA_METHOD *dsam, const char *name);
  155. int DSA_meth_get_flags(DSA_METHOD *dsam);
  156. int DSA_meth_set_flags(DSA_METHOD *dsam, int flags);
  157. void *DSA_meth_get0_app_data(const DSA_METHOD *dsam);
  158. int DSA_meth_set0_app_data(DSA_METHOD *dsam, void *app_data);
  159. DSA_SIG *(*DSA_meth_get_sign(const DSA_METHOD *dsam))
  160. (const unsigned char *, int, DSA *);
  161. int DSA_meth_set_sign(DSA_METHOD *dsam,
  162. DSA_SIG *(*sign) (const unsigned char *, int, DSA *));
  163. int (*DSA_meth_get_sign_setup(const DSA_METHOD *dsam))
  164. (DSA *, BN_CTX *, BIGNUM **, BIGNUM **);
  165. int DSA_meth_set_sign_setup(DSA_METHOD *dsam,
  166. int (*sign_setup) (DSA *, BN_CTX *, BIGNUM **, BIGNUM **));
  167. int (*DSA_meth_get_verify(const DSA_METHOD *dsam))
  168. (const unsigned char *, int , DSA_SIG *, DSA *);
  169. int DSA_meth_set_verify(DSA_METHOD *dsam,
  170. int (*verify) (const unsigned char *, int, DSA_SIG *, DSA *));
  171. int (*DSA_meth_get_mod_exp(const DSA_METHOD *dsam))
  172. (DSA *, BIGNUM *, BIGNUM *, BIGNUM *, BIGNUM *, BIGNUM *, BIGNUM *,
  173. BN_CTX *, BN_MONT_CTX *);
  174. int DSA_meth_set_mod_exp(DSA_METHOD *dsam,
  175. int (*mod_exp) (DSA *, BIGNUM *, BIGNUM *, BIGNUM *, BIGNUM *, BIGNUM *,
  176. BIGNUM *, BN_CTX *, BN_MONT_CTX *));
  177. int (*DSA_meth_get_bn_mod_exp(const DSA_METHOD *dsam))
  178. (DSA *, BIGNUM *, BIGNUM *, const BIGNUM *, const BIGNUM *, BN_CTX *,
  179. BN_MONT_CTX *);
  180. int DSA_meth_set_bn_mod_exp(DSA_METHOD *dsam,
  181. int (*bn_mod_exp) (DSA *, BIGNUM *, BIGNUM *, const BIGNUM *,
  182. const BIGNUM *, BN_CTX *, BN_MONT_CTX *));
  183. int (*DSA_meth_get_init(const DSA_METHOD *dsam))(DSA *);
  184. int DSA_meth_set_init(DSA_METHOD *dsam, int (*init)(DSA *));
  185. int (*DSA_meth_get_finish(const DSA_METHOD *dsam)) (DSA *);
  186. int DSA_meth_set_finish(DSA_METHOD *dsam, int (*finish) (DSA *));
  187. int (*DSA_meth_get_paramgen(const DSA_METHOD *dsam))
  188. (DSA *, int, const unsigned char *, int, int *, unsigned long *,
  189. BN_GENCB *);
  190. int DSA_meth_set_paramgen(DSA_METHOD *dsam,
  191. int (*paramgen) (DSA *, int, const unsigned char *, int, int *,
  192. unsigned long *, BN_GENCB *));
  193. int (*DSA_meth_get_keygen(const DSA_METHOD *dsam)) (DSA *);
  194. int DSA_meth_set_keygen(DSA_METHOD *dsam, int (*keygen) (DSA *));
  195. /* BEGIN ERROR CODES */
  196. /*
  197. * The following lines are auto generated by the script mkerr.pl. Any changes
  198. * made after this point may be overwritten when the script is next run.
  199. */
  200. void ERR_load_DSA_strings(void);
  201. /* Error codes for the DSA functions. */
  202. /* Function codes. */
  203. # define DSA_F_D2I_DSA_SIG 110
  204. # define DSA_F_DO_DSA_PRINT 104
  205. # define DSA_F_DSAPARAMS_PRINT 100
  206. # define DSA_F_DSAPARAMS_PRINT_FP 101
  207. # define DSA_F_DSA_BUILTIN_KEYGEN 124
  208. # define DSA_F_DSA_BUILTIN_PARAMGEN 125
  209. # define DSA_F_DSA_BUILTIN_PARAMGEN2 126
  210. # define DSA_F_DSA_DO_SIGN 112
  211. # define DSA_F_DSA_DO_VERIFY 113
  212. # define DSA_F_DSA_METH_DUP 127
  213. # define DSA_F_DSA_METH_NEW 128
  214. # define DSA_F_DSA_METH_SET1_NAME 129
  215. # define DSA_F_DSA_NEW_METHOD 103
  216. # define DSA_F_DSA_PARAM_DECODE 119
  217. # define DSA_F_DSA_PRINT_FP 105
  218. # define DSA_F_DSA_PRIV_DECODE 115
  219. # define DSA_F_DSA_PRIV_ENCODE 116
  220. # define DSA_F_DSA_PUB_DECODE 117
  221. # define DSA_F_DSA_PUB_ENCODE 118
  222. # define DSA_F_DSA_SIGN 106
  223. # define DSA_F_DSA_SIGN_SETUP 107
  224. # define DSA_F_DSA_SIG_NEW 109
  225. # define DSA_F_DSA_SIG_PRINT 123
  226. # define DSA_F_DSA_VERIFY 108
  227. # define DSA_F_I2D_DSA_SIG 111
  228. # define DSA_F_OLD_DSA_PRIV_DECODE 122
  229. # define DSA_F_PKEY_DSA_CTRL 120
  230. # define DSA_F_PKEY_DSA_KEYGEN 121
  231. # define DSA_F_SIG_CB 114
  232. /* Reason codes. */
  233. # define DSA_R_BAD_Q_VALUE 102
  234. # define DSA_R_BN_DECODE_ERROR 108
  235. # define DSA_R_BN_ERROR 109
  236. # define DSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE 100
  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_KEY_SIZE_TOO_SMALL 111
  241. # define DSA_R_MISSING_PARAMETERS 101
  242. # define DSA_R_MODULUS_TOO_LARGE 103
  243. # define DSA_R_NEED_NEW_SETUP_VALUES 110
  244. # define DSA_R_NO_PARAMETERS_SET 107
  245. # define DSA_R_PARAMETER_ENCODING_ERROR 105
  246. # define DSA_R_Q_NOT_PRIME 113
  247. # ifdef __cplusplus
  248. }
  249. # endif
  250. # endif
  251. #endif