dh.h 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343
  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. #ifndef HEADER_DH_H
  10. # define HEADER_DH_H
  11. # include <openssl/opensslconf.h>
  12. # ifndef OPENSSL_NO_DH
  13. # include <openssl/e_os2.h>
  14. # include <openssl/bio.h>
  15. # include <openssl/asn1.h>
  16. # include <openssl/ossl_typ.h>
  17. # if OPENSSL_API_COMPAT < 0x10100000L
  18. # include <openssl/bn.h>
  19. # endif
  20. # ifdef __cplusplus
  21. extern "C" {
  22. # endif
  23. # ifndef OPENSSL_DH_MAX_MODULUS_BITS
  24. # define OPENSSL_DH_MAX_MODULUS_BITS 10000
  25. # endif
  26. # define OPENSSL_DH_FIPS_MIN_MODULUS_BITS 1024
  27. # define DH_FLAG_CACHE_MONT_P 0x01
  28. # if OPENSSL_API_COMPAT < 0x10100000L
  29. /*
  30. * Does nothing. Previously this switched off constant time behaviour.
  31. */
  32. # define DH_FLAG_NO_EXP_CONSTTIME 0x00
  33. # endif
  34. /*
  35. * If this flag is set the DH method is FIPS compliant and can be used in
  36. * FIPS mode. This is set in the validated module method. If an application
  37. * sets this flag in its own methods it is its responsibility to ensure the
  38. * result is compliant.
  39. */
  40. # define DH_FLAG_FIPS_METHOD 0x0400
  41. /*
  42. * If this flag is set the operations normally disabled in FIPS mode are
  43. * permitted it is then the applications responsibility to ensure that the
  44. * usage is compliant.
  45. */
  46. # define DH_FLAG_NON_FIPS_ALLOW 0x0400
  47. /* Already defined in ossl_typ.h */
  48. /* typedef struct dh_st DH; */
  49. /* typedef struct dh_method DH_METHOD; */
  50. DECLARE_ASN1_ITEM(DHparams)
  51. # define DH_GENERATOR_2 2
  52. /* #define DH_GENERATOR_3 3 */
  53. # define DH_GENERATOR_5 5
  54. /* DH_check error codes */
  55. # define DH_CHECK_P_NOT_PRIME 0x01
  56. # define DH_CHECK_P_NOT_SAFE_PRIME 0x02
  57. # define DH_UNABLE_TO_CHECK_GENERATOR 0x04
  58. # define DH_NOT_SUITABLE_GENERATOR 0x08
  59. # define DH_CHECK_Q_NOT_PRIME 0x10
  60. # define DH_CHECK_INVALID_Q_VALUE 0x20
  61. # define DH_CHECK_INVALID_J_VALUE 0x40
  62. /* DH_check_pub_key error codes */
  63. # define DH_CHECK_PUBKEY_TOO_SMALL 0x01
  64. # define DH_CHECK_PUBKEY_TOO_LARGE 0x02
  65. # define DH_CHECK_PUBKEY_INVALID 0x04
  66. /*
  67. * primes p where (p-1)/2 is prime too are called "safe"; we define this for
  68. * backward compatibility:
  69. */
  70. # define DH_CHECK_P_NOT_STRONG_PRIME DH_CHECK_P_NOT_SAFE_PRIME
  71. # define d2i_DHparams_fp(fp,x) (DH *)ASN1_d2i_fp((char *(*)())DH_new, \
  72. (char *(*)())d2i_DHparams,(fp),(unsigned char **)(x))
  73. # define i2d_DHparams_fp(fp,x) ASN1_i2d_fp(i2d_DHparams,(fp), \
  74. (unsigned char *)(x))
  75. # define d2i_DHparams_bio(bp,x) ASN1_d2i_bio_of(DH,DH_new,d2i_DHparams,bp,x)
  76. # define i2d_DHparams_bio(bp,x) ASN1_i2d_bio_of_const(DH,i2d_DHparams,bp,x)
  77. DH *DHparams_dup(DH *);
  78. const DH_METHOD *DH_OpenSSL(void);
  79. void DH_set_default_method(const DH_METHOD *meth);
  80. const DH_METHOD *DH_get_default_method(void);
  81. int DH_set_method(DH *dh, const DH_METHOD *meth);
  82. DH *DH_new_method(ENGINE *engine);
  83. DH *DH_new(void);
  84. void DH_free(DH *dh);
  85. int DH_up_ref(DH *dh);
  86. int DH_bits(const DH *dh);
  87. int DH_size(const DH *dh);
  88. int DH_security_bits(const DH *dh);
  89. #define DH_get_ex_new_index(l, p, newf, dupf, freef) \
  90. CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_DH, l, p, newf, dupf, freef)
  91. int DH_set_ex_data(DH *d, int idx, void *arg);
  92. void *DH_get_ex_data(DH *d, int idx);
  93. /* Deprecated version */
  94. DEPRECATEDIN_0_9_8(DH *DH_generate_parameters(int prime_len, int generator,
  95. void (*callback) (int, int,
  96. void *),
  97. void *cb_arg))
  98. /* New version */
  99. int DH_generate_parameters_ex(DH *dh, int prime_len, int generator,
  100. BN_GENCB *cb);
  101. int DH_check(const DH *dh, int *codes);
  102. int DH_check_pub_key(const DH *dh, const BIGNUM *pub_key, int *codes);
  103. int DH_generate_key(DH *dh);
  104. int DH_compute_key(unsigned char *key, const BIGNUM *pub_key, DH *dh);
  105. int DH_compute_key_padded(unsigned char *key, const BIGNUM *pub_key, DH *dh);
  106. DH *d2i_DHparams(DH **a, const unsigned char **pp, long length);
  107. int i2d_DHparams(const DH *a, unsigned char **pp);
  108. DH *d2i_DHxparams(DH **a, const unsigned char **pp, long length);
  109. int i2d_DHxparams(const DH *a, unsigned char **pp);
  110. # ifndef OPENSSL_NO_STDIO
  111. int DHparams_print_fp(FILE *fp, const DH *x);
  112. # endif
  113. int DHparams_print(BIO *bp, const DH *x);
  114. /* RFC 5114 parameters */
  115. DH *DH_get_1024_160(void);
  116. DH *DH_get_2048_224(void);
  117. DH *DH_get_2048_256(void);
  118. # ifndef OPENSSL_NO_CMS
  119. /* RFC2631 KDF */
  120. int DH_KDF_X9_42(unsigned char *out, size_t outlen,
  121. const unsigned char *Z, size_t Zlen,
  122. ASN1_OBJECT *key_oid,
  123. const unsigned char *ukm, size_t ukmlen, const EVP_MD *md);
  124. # endif
  125. void DH_get0_pqg(const DH *dh,
  126. const BIGNUM **p, const BIGNUM **q, const BIGNUM **g);
  127. int DH_set0_pqg(DH *dh, BIGNUM *p, BIGNUM *q, BIGNUM *g);
  128. void DH_get0_key(const DH *dh,
  129. const BIGNUM **pub_key, const BIGNUM **priv_key);
  130. int DH_set0_key(DH *dh, BIGNUM *pub_key, BIGNUM *priv_key);
  131. void DH_clear_flags(DH *dh, int flags);
  132. int DH_test_flags(const DH *dh, int flags);
  133. void DH_set_flags(DH *dh, int flags);
  134. ENGINE *DH_get0_engine(DH *d);
  135. long DH_get_length(const DH *dh);
  136. int DH_set_length(DH *dh, long length);
  137. DH_METHOD *DH_meth_new(const char *name, int flags);
  138. void DH_meth_free(DH_METHOD *dhm);
  139. DH_METHOD *DH_meth_dup(const DH_METHOD *dhm);
  140. const char *DH_meth_get0_name(const DH_METHOD *dhm);
  141. int DH_meth_set1_name(DH_METHOD *dhm, const char *name);
  142. int DH_meth_get_flags(DH_METHOD *dhm);
  143. int DH_meth_set_flags(DH_METHOD *dhm, int flags);
  144. void *DH_meth_get0_app_data(const DH_METHOD *dhm);
  145. int DH_meth_set0_app_data(DH_METHOD *dhm, void *app_data);
  146. int (*DH_meth_get_generate_key(const DH_METHOD *dhm)) (DH *);
  147. int DH_meth_set_generate_key(DH_METHOD *dhm, int (*generate_key) (DH *));
  148. int (*DH_meth_get_compute_key(const DH_METHOD *dhm))
  149. (unsigned char *key, const BIGNUM *pub_key, DH *dh);
  150. int DH_meth_set_compute_key(DH_METHOD *dhm,
  151. int (*compute_key) (unsigned char *key, const BIGNUM *pub_key, DH *dh));
  152. int (*DH_meth_get_bn_mod_exp(const DH_METHOD *dhm))
  153. (const DH *, BIGNUM *, const BIGNUM *, const BIGNUM *, const BIGNUM *,
  154. BN_CTX *, BN_MONT_CTX *);
  155. int DH_meth_set_bn_mod_exp(DH_METHOD *dhm,
  156. int (*bn_mod_exp) (const DH *, BIGNUM *, const BIGNUM *, const BIGNUM *,
  157. const BIGNUM *, BN_CTX *, BN_MONT_CTX *));
  158. int (*DH_meth_get_init(const DH_METHOD *dhm))(DH *);
  159. int DH_meth_set_init(DH_METHOD *dhm, int (*init)(DH *));
  160. int (*DH_meth_get_finish(const DH_METHOD *dhm)) (DH *);
  161. int DH_meth_set_finish(DH_METHOD *dhm, int (*finish) (DH *));
  162. int (*DH_meth_get_generate_params(const DH_METHOD *dhm))
  163. (DH *, int, int, BN_GENCB *);
  164. int DH_meth_set_generate_params(DH_METHOD *dhm,
  165. int (*generate_params) (DH *, int, int, BN_GENCB *));
  166. # define EVP_PKEY_CTX_set_dh_paramgen_prime_len(ctx, len) \
  167. EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
  168. EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN, len, NULL)
  169. # define EVP_PKEY_CTX_set_dh_paramgen_subprime_len(ctx, len) \
  170. EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
  171. EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN, len, NULL)
  172. # define EVP_PKEY_CTX_set_dh_paramgen_type(ctx, typ) \
  173. EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
  174. EVP_PKEY_CTRL_DH_PARAMGEN_TYPE, typ, NULL)
  175. # define EVP_PKEY_CTX_set_dh_paramgen_generator(ctx, gen) \
  176. EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \
  177. EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR, gen, NULL)
  178. # define EVP_PKEY_CTX_set_dh_rfc5114(ctx, gen) \
  179. EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, EVP_PKEY_OP_PARAMGEN, \
  180. EVP_PKEY_CTRL_DH_RFC5114, gen, NULL)
  181. # define EVP_PKEY_CTX_set_dhx_rfc5114(ctx, gen) \
  182. EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, EVP_PKEY_OP_PARAMGEN, \
  183. EVP_PKEY_CTRL_DH_RFC5114, gen, NULL)
  184. # define EVP_PKEY_CTX_set_dh_kdf_type(ctx, kdf) \
  185. EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
  186. EVP_PKEY_OP_DERIVE, \
  187. EVP_PKEY_CTRL_DH_KDF_TYPE, kdf, NULL)
  188. # define EVP_PKEY_CTX_get_dh_kdf_type(ctx) \
  189. EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
  190. EVP_PKEY_OP_DERIVE, \
  191. EVP_PKEY_CTRL_DH_KDF_TYPE, -2, NULL)
  192. # define EVP_PKEY_CTX_set0_dh_kdf_oid(ctx, oid) \
  193. EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
  194. EVP_PKEY_OP_DERIVE, \
  195. EVP_PKEY_CTRL_DH_KDF_OID, 0, (void *)oid)
  196. # define EVP_PKEY_CTX_get0_dh_kdf_oid(ctx, poid) \
  197. EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
  198. EVP_PKEY_OP_DERIVE, \
  199. EVP_PKEY_CTRL_GET_DH_KDF_OID, 0, (void *)poid)
  200. # define EVP_PKEY_CTX_set_dh_kdf_md(ctx, md) \
  201. EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
  202. EVP_PKEY_OP_DERIVE, \
  203. EVP_PKEY_CTRL_DH_KDF_MD, 0, (void *)md)
  204. # define EVP_PKEY_CTX_get_dh_kdf_md(ctx, pmd) \
  205. EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
  206. EVP_PKEY_OP_DERIVE, \
  207. EVP_PKEY_CTRL_GET_DH_KDF_MD, 0, (void *)pmd)
  208. # define EVP_PKEY_CTX_set_dh_kdf_outlen(ctx, len) \
  209. EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
  210. EVP_PKEY_OP_DERIVE, \
  211. EVP_PKEY_CTRL_DH_KDF_OUTLEN, len, NULL)
  212. # define EVP_PKEY_CTX_get_dh_kdf_outlen(ctx, plen) \
  213. EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
  214. EVP_PKEY_OP_DERIVE, \
  215. EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN, 0, (void *)plen)
  216. # define EVP_PKEY_CTX_set0_dh_kdf_ukm(ctx, p, plen) \
  217. EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
  218. EVP_PKEY_OP_DERIVE, \
  219. EVP_PKEY_CTRL_DH_KDF_UKM, plen, (void *)p)
  220. # define EVP_PKEY_CTX_get0_dh_kdf_ukm(ctx, p) \
  221. EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DHX, \
  222. EVP_PKEY_OP_DERIVE, \
  223. EVP_PKEY_CTRL_GET_DH_KDF_UKM, 0, (void *)p)
  224. # define EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN (EVP_PKEY_ALG_CTRL + 1)
  225. # define EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR (EVP_PKEY_ALG_CTRL + 2)
  226. # define EVP_PKEY_CTRL_DH_RFC5114 (EVP_PKEY_ALG_CTRL + 3)
  227. # define EVP_PKEY_CTRL_DH_PARAMGEN_SUBPRIME_LEN (EVP_PKEY_ALG_CTRL + 4)
  228. # define EVP_PKEY_CTRL_DH_PARAMGEN_TYPE (EVP_PKEY_ALG_CTRL + 5)
  229. # define EVP_PKEY_CTRL_DH_KDF_TYPE (EVP_PKEY_ALG_CTRL + 6)
  230. # define EVP_PKEY_CTRL_DH_KDF_MD (EVP_PKEY_ALG_CTRL + 7)
  231. # define EVP_PKEY_CTRL_GET_DH_KDF_MD (EVP_PKEY_ALG_CTRL + 8)
  232. # define EVP_PKEY_CTRL_DH_KDF_OUTLEN (EVP_PKEY_ALG_CTRL + 9)
  233. # define EVP_PKEY_CTRL_GET_DH_KDF_OUTLEN (EVP_PKEY_ALG_CTRL + 10)
  234. # define EVP_PKEY_CTRL_DH_KDF_UKM (EVP_PKEY_ALG_CTRL + 11)
  235. # define EVP_PKEY_CTRL_GET_DH_KDF_UKM (EVP_PKEY_ALG_CTRL + 12)
  236. # define EVP_PKEY_CTRL_DH_KDF_OID (EVP_PKEY_ALG_CTRL + 13)
  237. # define EVP_PKEY_CTRL_GET_DH_KDF_OID (EVP_PKEY_ALG_CTRL + 14)
  238. /* KDF types */
  239. # define EVP_PKEY_DH_KDF_NONE 1
  240. # ifndef OPENSSL_NO_CMS
  241. # define EVP_PKEY_DH_KDF_X9_42 2
  242. # endif
  243. /* BEGIN ERROR CODES */
  244. /*
  245. * The following lines are auto generated by the script mkerr.pl. Any changes
  246. * made after this point may be overwritten when the script is next run.
  247. */
  248. int ERR_load_DH_strings(void);
  249. /* Error codes for the DH functions. */
  250. /* Function codes. */
  251. # define DH_F_COMPUTE_KEY 102
  252. # define DH_F_DHPARAMS_PRINT_FP 101
  253. # define DH_F_DH_BUILTIN_GENPARAMS 106
  254. # define DH_F_DH_CMS_DECRYPT 114
  255. # define DH_F_DH_CMS_SET_PEERKEY 115
  256. # define DH_F_DH_CMS_SET_SHARED_INFO 116
  257. # define DH_F_DH_METH_DUP 117
  258. # define DH_F_DH_METH_NEW 118
  259. # define DH_F_DH_METH_SET1_NAME 119
  260. # define DH_F_DH_NEW_METHOD 105
  261. # define DH_F_DH_PARAM_DECODE 107
  262. # define DH_F_DH_PRIV_DECODE 110
  263. # define DH_F_DH_PRIV_ENCODE 111
  264. # define DH_F_DH_PUB_DECODE 108
  265. # define DH_F_DH_PUB_ENCODE 109
  266. # define DH_F_DO_DH_PRINT 100
  267. # define DH_F_GENERATE_KEY 103
  268. # define DH_F_PKEY_DH_DERIVE 112
  269. # define DH_F_PKEY_DH_KEYGEN 113
  270. /* Reason codes. */
  271. # define DH_R_BAD_GENERATOR 101
  272. # define DH_R_BN_DECODE_ERROR 109
  273. # define DH_R_BN_ERROR 106
  274. # define DH_R_DECODE_ERROR 104
  275. # define DH_R_INVALID_PUBKEY 102
  276. # define DH_R_KDF_PARAMETER_ERROR 112
  277. # define DH_R_KEYS_NOT_SET 108
  278. # define DH_R_MODULUS_TOO_LARGE 103
  279. # define DH_R_NO_PARAMETERS_SET 107
  280. # define DH_R_NO_PRIVATE_VALUE 100
  281. # define DH_R_PARAMETER_ENCODING_ERROR 105
  282. # define DH_R_PEER_KEY_ERROR 111
  283. # define DH_R_SHARED_INFO_ERROR 113
  284. # ifdef __cplusplus
  285. }
  286. # endif
  287. # endif
  288. #endif