sha3_prov.c 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621
  1. /*
  2. * Copyright 2019-2025 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. #include <string.h>
  10. #include <openssl/core_names.h>
  11. #include <openssl/crypto.h>
  12. #include <openssl/evp.h>
  13. #include <openssl/params.h>
  14. #include <openssl/err.h>
  15. #include <openssl/proverr.h>
  16. #include "internal/sha3.h"
  17. #include "prov/digestcommon.h"
  18. #include "prov/implementations.h"
  19. #define SHA3_FLAGS PROV_DIGEST_FLAG_ALGID_ABSENT
  20. #define SHAKE_FLAGS (PROV_DIGEST_FLAG_XOF | PROV_DIGEST_FLAG_ALGID_ABSENT)
  21. #define KMAC_FLAGS PROV_DIGEST_FLAG_XOF
  22. /*
  23. * Forward declaration of any unique methods implemented here. This is not strictly
  24. * necessary for the compiler, but provides an assurance that the signatures
  25. * of the functions in the dispatch table are correct.
  26. */
  27. static OSSL_FUNC_digest_init_fn keccak_init;
  28. static OSSL_FUNC_digest_init_fn keccak_init_params;
  29. static OSSL_FUNC_digest_update_fn keccak_update;
  30. static OSSL_FUNC_digest_final_fn keccak_final;
  31. static OSSL_FUNC_digest_freectx_fn keccak_freectx;
  32. static OSSL_FUNC_digest_dupctx_fn keccak_dupctx;
  33. static OSSL_FUNC_digest_squeeze_fn shake_squeeze;
  34. static OSSL_FUNC_digest_set_ctx_params_fn shake_set_ctx_params;
  35. static OSSL_FUNC_digest_settable_ctx_params_fn shake_settable_ctx_params;
  36. static sha3_absorb_fn generic_sha3_absorb;
  37. static sha3_final_fn generic_sha3_final;
  38. static sha3_squeeze_fn generic_sha3_squeeze;
  39. #if defined(OPENSSL_CPUID_OBJ) && defined(__s390__) && defined(KECCAK1600_ASM)
  40. /*
  41. * IBM S390X support
  42. */
  43. # include "s390x_arch.h"
  44. # define S390_SHA3 1
  45. # define S390_SHA3_CAPABLE(name) \
  46. ((OPENSSL_s390xcap_P.kimd[0] & S390X_CAPBIT(S390X_##name)) && \
  47. (OPENSSL_s390xcap_P.klmd[0] & S390X_CAPBIT(S390X_##name)))
  48. #endif
  49. static int keccak_init(void *vctx, ossl_unused const OSSL_PARAM params[])
  50. {
  51. if (!ossl_prov_is_running())
  52. return 0;
  53. /* The newctx() handles most of the ctx fixed setup. */
  54. ossl_sha3_reset((KECCAK1600_CTX *)vctx);
  55. return 1;
  56. }
  57. static int keccak_init_params(void *vctx, const OSSL_PARAM params[])
  58. {
  59. return keccak_init(vctx, NULL)
  60. && shake_set_ctx_params(vctx, params);
  61. }
  62. static int keccak_update(void *vctx, const unsigned char *inp, size_t len)
  63. {
  64. KECCAK1600_CTX *ctx = vctx;
  65. const size_t bsz = ctx->block_size;
  66. size_t num, rem;
  67. if (len == 0)
  68. return 1;
  69. /* Is there anything in the buffer already ? */
  70. if ((num = ctx->bufsz) != 0) {
  71. /* Calculate how much space is left in the buffer */
  72. rem = bsz - num;
  73. /* If the new input does not fill the buffer then just add it */
  74. if (len < rem) {
  75. memcpy(ctx->buf + num, inp, len);
  76. ctx->bufsz += len;
  77. return 1;
  78. }
  79. /* otherwise fill up the buffer and absorb the buffer */
  80. memcpy(ctx->buf + num, inp, rem);
  81. /* Update the input pointer */
  82. inp += rem;
  83. len -= rem;
  84. ctx->meth.absorb(ctx, ctx->buf, bsz);
  85. ctx->bufsz = 0;
  86. }
  87. /* Absorb the input - rem = leftover part of the input < blocksize) */
  88. rem = ctx->meth.absorb(ctx, inp, len);
  89. /* Copy the leftover bit of the input into the buffer */
  90. if (rem) {
  91. memcpy(ctx->buf, inp + len - rem, rem);
  92. ctx->bufsz = rem;
  93. }
  94. return 1;
  95. }
  96. static int keccak_final(void *vctx, unsigned char *out, size_t *outl,
  97. size_t outlen)
  98. {
  99. int ret = 1;
  100. KECCAK1600_CTX *ctx = vctx;
  101. if (!ossl_prov_is_running())
  102. return 0;
  103. if (outlen > 0)
  104. ret = ctx->meth.final(ctx, out, ctx->md_size);
  105. *outl = ctx->md_size;
  106. return ret;
  107. }
  108. static int shake_squeeze(void *vctx, unsigned char *out, size_t *outl,
  109. size_t outlen)
  110. {
  111. int ret = 1;
  112. KECCAK1600_CTX *ctx = vctx;
  113. if (!ossl_prov_is_running())
  114. return 0;
  115. if (ctx->meth.squeeze == NULL)
  116. return 0;
  117. if (outlen > 0)
  118. ret = ctx->meth.squeeze(ctx, out, outlen);
  119. *outl = outlen;
  120. return ret;
  121. }
  122. /*-
  123. * Generic software version of the absorb() and final().
  124. */
  125. static size_t generic_sha3_absorb(void *vctx, const void *inp, size_t len)
  126. {
  127. KECCAK1600_CTX *ctx = vctx;
  128. if (!(ctx->xof_state == XOF_STATE_INIT ||
  129. ctx->xof_state == XOF_STATE_ABSORB))
  130. return 0;
  131. ctx->xof_state = XOF_STATE_ABSORB;
  132. return SHA3_absorb(ctx->A, inp, len, ctx->block_size);
  133. }
  134. static int generic_sha3_final(void *vctx, unsigned char *out, size_t outlen)
  135. {
  136. return ossl_sha3_final((KECCAK1600_CTX *)vctx, out, outlen);
  137. }
  138. static int generic_sha3_squeeze(void *vctx, unsigned char *out, size_t outlen)
  139. {
  140. return ossl_sha3_squeeze((KECCAK1600_CTX *)vctx, out, outlen);
  141. }
  142. static PROV_SHA3_METHOD sha3_generic_md =
  143. {
  144. generic_sha3_absorb,
  145. generic_sha3_final,
  146. NULL
  147. };
  148. static PROV_SHA3_METHOD shake_generic_md =
  149. {
  150. generic_sha3_absorb,
  151. generic_sha3_final,
  152. generic_sha3_squeeze
  153. };
  154. #if defined(S390_SHA3)
  155. static sha3_absorb_fn s390x_sha3_absorb;
  156. static sha3_final_fn s390x_sha3_final;
  157. static sha3_final_fn s390x_shake_final;
  158. /*-
  159. * The platform specific parts of the absorb() and final() for S390X.
  160. */
  161. static size_t s390x_sha3_absorb(void *vctx, const void *inp, size_t len)
  162. {
  163. KECCAK1600_CTX *ctx = vctx;
  164. size_t rem = len % ctx->block_size;
  165. if (!(ctx->xof_state == XOF_STATE_INIT ||
  166. ctx->xof_state == XOF_STATE_ABSORB))
  167. return 0;
  168. ctx->xof_state = XOF_STATE_ABSORB;
  169. s390x_kimd(inp, len - rem, ctx->pad, ctx->A);
  170. return rem;
  171. }
  172. static int s390x_sha3_final(void *vctx, unsigned char *out, size_t outlen)
  173. {
  174. KECCAK1600_CTX *ctx = vctx;
  175. if (!ossl_prov_is_running())
  176. return 0;
  177. if (!(ctx->xof_state == XOF_STATE_INIT ||
  178. ctx->xof_state == XOF_STATE_ABSORB))
  179. return 0;
  180. ctx->xof_state = XOF_STATE_FINAL;
  181. s390x_klmd(ctx->buf, ctx->bufsz, NULL, 0, ctx->pad, ctx->A);
  182. memcpy(out, ctx->A, outlen);
  183. return 1;
  184. }
  185. static int s390x_shake_final(void *vctx, unsigned char *out, size_t outlen)
  186. {
  187. KECCAK1600_CTX *ctx = vctx;
  188. if (!ossl_prov_is_running())
  189. return 0;
  190. if (!(ctx->xof_state == XOF_STATE_INIT ||
  191. ctx->xof_state == XOF_STATE_ABSORB))
  192. return 0;
  193. ctx->xof_state = XOF_STATE_FINAL;
  194. s390x_klmd(ctx->buf, ctx->bufsz, out, outlen, ctx->pad, ctx->A);
  195. return 1;
  196. }
  197. static int s390x_shake_squeeze(void *vctx, unsigned char *out, size_t outlen)
  198. {
  199. KECCAK1600_CTX *ctx = vctx;
  200. size_t len;
  201. if (!ossl_prov_is_running())
  202. return 0;
  203. if (ctx->xof_state == XOF_STATE_FINAL)
  204. return 0;
  205. /*
  206. * On the first squeeze call, finish the absorb process (incl. padding).
  207. */
  208. if (ctx->xof_state != XOF_STATE_SQUEEZE) {
  209. ctx->xof_state = XOF_STATE_SQUEEZE;
  210. s390x_klmd(ctx->buf, ctx->bufsz, out, outlen, ctx->pad, ctx->A);
  211. ctx->bufsz = outlen % ctx->block_size;
  212. /* reuse ctx->bufsz to count bytes squeezed from current sponge */
  213. return 1;
  214. }
  215. ctx->xof_state = XOF_STATE_SQUEEZE;
  216. if (ctx->bufsz != 0) {
  217. len = ctx->block_size - ctx->bufsz;
  218. if (outlen < len)
  219. len = outlen;
  220. memcpy(out, (char *)ctx->A + ctx->bufsz, len);
  221. out += len;
  222. outlen -= len;
  223. ctx->bufsz += len;
  224. if (ctx->bufsz == ctx->block_size)
  225. ctx->bufsz = 0;
  226. }
  227. if (outlen == 0)
  228. return 1;
  229. s390x_klmd(NULL, 0, out, outlen, ctx->pad | S390X_KLMD_PS, ctx->A);
  230. ctx->bufsz = outlen % ctx->block_size;
  231. return 1;
  232. }
  233. static int s390x_keccakc_final(void *vctx, unsigned char *out, size_t outlen,
  234. int padding)
  235. {
  236. KECCAK1600_CTX *ctx = vctx;
  237. size_t bsz = ctx->block_size;
  238. size_t num = ctx->bufsz;
  239. size_t needed = outlen;
  240. if (!ossl_prov_is_running())
  241. return 0;
  242. if (!(ctx->xof_state == XOF_STATE_INIT ||
  243. ctx->xof_state == XOF_STATE_ABSORB))
  244. return 0;
  245. ctx->xof_state = XOF_STATE_FINAL;
  246. if (outlen == 0)
  247. return 1;
  248. memset(ctx->buf + num, 0, bsz - num);
  249. ctx->buf[num] = padding;
  250. ctx->buf[bsz - 1] |= 0x80;
  251. s390x_kimd(ctx->buf, bsz, ctx->pad, ctx->A);
  252. num = needed > bsz ? bsz : needed;
  253. memcpy(out, ctx->A, num);
  254. needed -= num;
  255. if (needed > 0)
  256. s390x_klmd(NULL, 0, out + bsz, needed, ctx->pad | S390X_KLMD_PS, ctx->A);
  257. return 1;
  258. }
  259. static int s390x_keccak_final(void *vctx, unsigned char *out, size_t outlen)
  260. {
  261. return s390x_keccakc_final(vctx, out, outlen, 0x01);
  262. }
  263. static int s390x_kmac_final(void *vctx, unsigned char *out, size_t outlen)
  264. {
  265. return s390x_keccakc_final(vctx, out, outlen, 0x04);
  266. }
  267. static int s390x_keccakc_squeeze(void *vctx, unsigned char *out, size_t outlen,
  268. int padding)
  269. {
  270. KECCAK1600_CTX *ctx = vctx;
  271. size_t len;
  272. if (!ossl_prov_is_running())
  273. return 0;
  274. if (ctx->xof_state == XOF_STATE_FINAL)
  275. return 0;
  276. /*
  277. * On the first squeeze call, finish the absorb process
  278. * by adding the trailing padding and then doing
  279. * a final absorb.
  280. */
  281. if (ctx->xof_state != XOF_STATE_SQUEEZE) {
  282. len = ctx->block_size - ctx->bufsz;
  283. memset(ctx->buf + ctx->bufsz, 0, len);
  284. ctx->buf[ctx->bufsz] = padding;
  285. ctx->buf[ctx->block_size - 1] |= 0x80;
  286. s390x_kimd(ctx->buf, ctx->block_size, ctx->pad, ctx->A);
  287. ctx->bufsz = 0;
  288. /* reuse ctx->bufsz to count bytes squeezed from current sponge */
  289. }
  290. if (ctx->bufsz != 0 || ctx->xof_state != XOF_STATE_SQUEEZE) {
  291. len = ctx->block_size - ctx->bufsz;
  292. if (outlen < len)
  293. len = outlen;
  294. memcpy(out, (char *)ctx->A + ctx->bufsz, len);
  295. out += len;
  296. outlen -= len;
  297. ctx->bufsz += len;
  298. if (ctx->bufsz == ctx->block_size)
  299. ctx->bufsz = 0;
  300. }
  301. ctx->xof_state = XOF_STATE_SQUEEZE;
  302. if (outlen == 0)
  303. return 1;
  304. s390x_klmd(NULL, 0, out, outlen, ctx->pad | S390X_KLMD_PS, ctx->A);
  305. ctx->bufsz = outlen % ctx->block_size;
  306. return 1;
  307. }
  308. static int s390x_keccak_squeeze(void *vctx, unsigned char *out, size_t outlen)
  309. {
  310. return s390x_keccakc_squeeze(vctx, out, outlen, 0x01);
  311. }
  312. static int s390x_kmac_squeeze(void *vctx, unsigned char *out, size_t outlen)
  313. {
  314. return s390x_keccakc_squeeze(vctx, out, outlen, 0x04);
  315. }
  316. static PROV_SHA3_METHOD sha3_s390x_md =
  317. {
  318. s390x_sha3_absorb,
  319. s390x_sha3_final,
  320. NULL,
  321. };
  322. static PROV_SHA3_METHOD keccak_s390x_md =
  323. {
  324. s390x_sha3_absorb,
  325. s390x_keccak_final,
  326. s390x_keccak_squeeze,
  327. };
  328. static PROV_SHA3_METHOD shake_s390x_md =
  329. {
  330. s390x_sha3_absorb,
  331. s390x_shake_final,
  332. s390x_shake_squeeze,
  333. };
  334. static PROV_SHA3_METHOD kmac_s390x_md =
  335. {
  336. s390x_sha3_absorb,
  337. s390x_kmac_final,
  338. s390x_kmac_squeeze,
  339. };
  340. # define SHAKE_SET_MD(uname, typ) \
  341. if (S390_SHA3_CAPABLE(uname)) { \
  342. ctx->pad = S390X_##uname; \
  343. ctx->meth = typ##_s390x_md; \
  344. } else { \
  345. ctx->meth = shake_generic_md; \
  346. }
  347. # define SHA3_SET_MD(uname, typ) \
  348. if (S390_SHA3_CAPABLE(uname)) { \
  349. ctx->pad = S390X_##uname; \
  350. ctx->meth = typ##_s390x_md; \
  351. } else { \
  352. ctx->meth = sha3_generic_md; \
  353. }
  354. # define KMAC_SET_MD(bitlen) \
  355. if (S390_SHA3_CAPABLE(SHAKE_##bitlen)) { \
  356. ctx->pad = S390X_SHAKE_##bitlen; \
  357. ctx->meth = kmac_s390x_md; \
  358. } else { \
  359. ctx->meth = sha3_generic_md; \
  360. }
  361. #elif defined(__aarch64__) && defined(KECCAK1600_ASM)
  362. # include "arm_arch.h"
  363. static sha3_absorb_fn armsha3_sha3_absorb;
  364. size_t SHA3_absorb_cext(uint64_t A[5][5], const unsigned char *inp, size_t len,
  365. size_t r);
  366. /*-
  367. * Hardware-assisted ARMv8.2 SHA3 extension version of the absorb()
  368. */
  369. static size_t armsha3_sha3_absorb(void *vctx, const void *inp, size_t len)
  370. {
  371. KECCAK1600_CTX *ctx = vctx;
  372. return SHA3_absorb_cext(ctx->A, inp, len, ctx->block_size);
  373. }
  374. static PROV_SHA3_METHOD sha3_ARMSHA3_md =
  375. {
  376. armsha3_sha3_absorb,
  377. generic_sha3_final
  378. };
  379. static PROV_SHA3_METHOD shake_ARMSHA3_md =
  380. {
  381. armsha3_sha3_absorb,
  382. generic_sha3_final,
  383. generic_sha3_squeeze
  384. };
  385. # define SHAKE_SET_MD(uname, typ) \
  386. if (OPENSSL_armcap_P & ARMV8_HAVE_SHA3_AND_WORTH_USING) { \
  387. ctx->meth = shake_ARMSHA3_md; \
  388. } else { \
  389. ctx->meth = shake_generic_md; \
  390. }
  391. # define SHA3_SET_MD(uname, typ) \
  392. if (OPENSSL_armcap_P & ARMV8_HAVE_SHA3_AND_WORTH_USING) { \
  393. ctx->meth = sha3_ARMSHA3_md; \
  394. } else { \
  395. ctx->meth = sha3_generic_md; \
  396. }
  397. # define KMAC_SET_MD(bitlen) \
  398. if (OPENSSL_armcap_P & ARMV8_HAVE_SHA3_AND_WORTH_USING) { \
  399. ctx->meth = sha3_ARMSHA3_md; \
  400. } else { \
  401. ctx->meth = sha3_generic_md; \
  402. }
  403. #else
  404. # define SHA3_SET_MD(uname, typ) ctx->meth = sha3_generic_md;
  405. # define KMAC_SET_MD(bitlen) ctx->meth = sha3_generic_md;
  406. # define SHAKE_SET_MD(uname, typ) ctx->meth = shake_generic_md;
  407. #endif /* S390_SHA3 */
  408. #define SHA3_newctx(typ, uname, name, bitlen, pad) \
  409. static OSSL_FUNC_digest_newctx_fn name##_newctx; \
  410. static void *name##_newctx(void *provctx) \
  411. { \
  412. KECCAK1600_CTX *ctx = ossl_prov_is_running() ? OPENSSL_zalloc(sizeof(*ctx)) \
  413. : NULL; \
  414. \
  415. if (ctx == NULL) \
  416. return NULL; \
  417. ossl_sha3_init(ctx, pad, bitlen); \
  418. SHA3_SET_MD(uname, typ) \
  419. return ctx; \
  420. }
  421. #define SHAKE_newctx(typ, uname, name, bitlen, pad) \
  422. static OSSL_FUNC_digest_newctx_fn name##_newctx; \
  423. static void *name##_newctx(void *provctx) \
  424. { \
  425. KECCAK1600_CTX *ctx = ossl_prov_is_running() ? OPENSSL_zalloc(sizeof(*ctx))\
  426. : NULL; \
  427. \
  428. if (ctx == NULL) \
  429. return NULL; \
  430. ossl_sha3_init(ctx, pad, bitlen); \
  431. SHAKE_SET_MD(uname, typ) \
  432. return ctx; \
  433. }
  434. #define KMAC_newctx(uname, bitlen, pad) \
  435. static OSSL_FUNC_digest_newctx_fn uname##_newctx; \
  436. static void *uname##_newctx(void *provctx) \
  437. { \
  438. KECCAK1600_CTX *ctx = ossl_prov_is_running() ? OPENSSL_zalloc(sizeof(*ctx)) \
  439. : NULL; \
  440. \
  441. if (ctx == NULL) \
  442. return NULL; \
  443. ossl_keccak_kmac_init(ctx, pad, bitlen); \
  444. KMAC_SET_MD(bitlen) \
  445. return ctx; \
  446. }
  447. #define PROV_FUNC_SHA3_DIGEST_COMMON(name, bitlen, blksize, dgstsize, flags) \
  448. PROV_FUNC_DIGEST_GET_PARAM(name, blksize, dgstsize, flags) \
  449. const OSSL_DISPATCH ossl_##name##_functions[] = { \
  450. { OSSL_FUNC_DIGEST_NEWCTX, (void (*)(void))name##_newctx }, \
  451. { OSSL_FUNC_DIGEST_UPDATE, (void (*)(void))keccak_update }, \
  452. { OSSL_FUNC_DIGEST_FINAL, (void (*)(void))keccak_final }, \
  453. { OSSL_FUNC_DIGEST_FREECTX, (void (*)(void))keccak_freectx }, \
  454. { OSSL_FUNC_DIGEST_DUPCTX, (void (*)(void))keccak_dupctx }, \
  455. PROV_DISPATCH_FUNC_DIGEST_GET_PARAMS(name)
  456. #define PROV_FUNC_SHA3_DIGEST(name, bitlen, blksize, dgstsize, flags) \
  457. PROV_FUNC_SHA3_DIGEST_COMMON(name, bitlen, blksize, dgstsize, flags), \
  458. { OSSL_FUNC_DIGEST_INIT, (void (*)(void))keccak_init }, \
  459. PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_END
  460. #define PROV_FUNC_SHAKE_DIGEST(name, bitlen, blksize, dgstsize, flags) \
  461. PROV_FUNC_SHA3_DIGEST_COMMON(name, bitlen, blksize, dgstsize, flags), \
  462. { OSSL_FUNC_DIGEST_SQUEEZE, (void (*)(void))shake_squeeze }, \
  463. { OSSL_FUNC_DIGEST_INIT, (void (*)(void))keccak_init_params }, \
  464. { OSSL_FUNC_DIGEST_SET_CTX_PARAMS, (void (*)(void))shake_set_ctx_params }, \
  465. { OSSL_FUNC_DIGEST_SETTABLE_CTX_PARAMS, \
  466. (void (*)(void))shake_settable_ctx_params }, \
  467. PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_END
  468. static void keccak_freectx(void *vctx)
  469. {
  470. KECCAK1600_CTX *ctx = (KECCAK1600_CTX *)vctx;
  471. OPENSSL_clear_free(ctx, sizeof(*ctx));
  472. }
  473. static void *keccak_dupctx(void *ctx)
  474. {
  475. KECCAK1600_CTX *in = (KECCAK1600_CTX *)ctx;
  476. KECCAK1600_CTX *ret = ossl_prov_is_running() ? OPENSSL_malloc(sizeof(*ret))
  477. : NULL;
  478. if (ret != NULL)
  479. *ret = *in;
  480. return ret;
  481. }
  482. static const OSSL_PARAM known_shake_settable_ctx_params[] = {
  483. {OSSL_DIGEST_PARAM_XOFLEN, OSSL_PARAM_UNSIGNED_INTEGER, NULL, 0, 0},
  484. OSSL_PARAM_END
  485. };
  486. static const OSSL_PARAM *shake_settable_ctx_params(ossl_unused void *ctx,
  487. ossl_unused void *provctx)
  488. {
  489. return known_shake_settable_ctx_params;
  490. }
  491. static int shake_set_ctx_params(void *vctx, const OSSL_PARAM params[])
  492. {
  493. const OSSL_PARAM *p;
  494. KECCAK1600_CTX *ctx = (KECCAK1600_CTX *)vctx;
  495. if (ctx == NULL)
  496. return 0;
  497. if (params == NULL)
  498. return 1;
  499. p = OSSL_PARAM_locate_const(params, OSSL_DIGEST_PARAM_XOFLEN);
  500. if (p != NULL && !OSSL_PARAM_get_size_t(p, &ctx->md_size)) {
  501. ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
  502. return 0;
  503. }
  504. return 1;
  505. }
  506. #define IMPLEMENT_SHA3_functions(bitlen) \
  507. SHA3_newctx(sha3, SHA3_##bitlen, sha3_##bitlen, bitlen, '\x06') \
  508. PROV_FUNC_SHA3_DIGEST(sha3_##bitlen, bitlen, \
  509. SHA3_BLOCKSIZE(bitlen), SHA3_MDSIZE(bitlen), \
  510. SHA3_FLAGS)
  511. #define IMPLEMENT_KECCAK_functions(bitlen) \
  512. SHA3_newctx(keccak, KECCAK_##bitlen, keccak_##bitlen, bitlen, '\x01') \
  513. PROV_FUNC_SHA3_DIGEST(keccak_##bitlen, bitlen, \
  514. SHA3_BLOCKSIZE(bitlen), SHA3_MDSIZE(bitlen), \
  515. SHA3_FLAGS)
  516. #define IMPLEMENT_SHAKE_functions(bitlen) \
  517. SHAKE_newctx(shake, SHAKE_##bitlen, shake_##bitlen, bitlen, '\x1f') \
  518. PROV_FUNC_SHAKE_DIGEST(shake_##bitlen, bitlen, \
  519. SHA3_BLOCKSIZE(bitlen), SHA3_MDSIZE(bitlen), \
  520. SHAKE_FLAGS)
  521. #define IMPLEMENT_KMAC_functions(bitlen) \
  522. KMAC_newctx(keccak_kmac_##bitlen, bitlen, '\x04') \
  523. PROV_FUNC_SHAKE_DIGEST(keccak_kmac_##bitlen, bitlen, \
  524. SHA3_BLOCKSIZE(bitlen), KMAC_MDSIZE(bitlen), \
  525. KMAC_FLAGS)
  526. /* ossl_sha3_224_functions */
  527. IMPLEMENT_SHA3_functions(224)
  528. /* ossl_sha3_256_functions */
  529. IMPLEMENT_SHA3_functions(256)
  530. /* ossl_sha3_384_functions */
  531. IMPLEMENT_SHA3_functions(384)
  532. /* ossl_sha3_512_functions */
  533. IMPLEMENT_SHA3_functions(512)
  534. /* ossl_keccak_224_functions */
  535. IMPLEMENT_KECCAK_functions(224)
  536. /* ossl_keccak_256_functions */
  537. IMPLEMENT_KECCAK_functions(256)
  538. /* ossl_keccak_384_functions */
  539. IMPLEMENT_KECCAK_functions(384)
  540. /* ossl_keccak_512_functions */
  541. IMPLEMENT_KECCAK_functions(512)
  542. /* ossl_shake_128_functions */
  543. IMPLEMENT_SHAKE_functions(128)
  544. /* ossl_shake_256_functions */
  545. IMPLEMENT_SHAKE_functions(256)
  546. /* ossl_keccak_kmac_128_functions */
  547. IMPLEMENT_KMAC_functions(128)
  548. /* ossl_keccak_kmac_256_functions */
  549. IMPLEMENT_KMAC_functions(256)