2 * Copyright 2017-2018 The OpenSSL Project Authors. All Rights Reserved.
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
13 #include <openssl/evp.h>
14 #include <openssl/objects.h>
15 #include "internal/evp_int.h"
18 size_t SHA3_absorb(uint64_t A[5][5], const unsigned char *inp, size_t len,
20 void SHA3_squeeze(uint64_t A[5][5], unsigned char *out, size_t len, size_t r);
22 #define KECCAK1600_WIDTH 1600
26 size_t block_size; /* cached ctx->digest->block_size */
27 size_t md_size; /* output length, variable in XOF */
28 size_t num; /* used bytes in below buffer */
29 unsigned char buf[KECCAK1600_WIDTH / 8 - 32];
33 static int init(EVP_MD_CTX *evp_ctx, unsigned char pad)
35 KECCAK1600_CTX *ctx = evp_ctx->md_data;
36 size_t bsz = evp_ctx->digest->block_size;
38 if (bsz <= sizeof(ctx->buf)) {
39 memset(ctx->A, 0, sizeof(ctx->A));
42 ctx->block_size = bsz;
43 ctx->md_size = evp_ctx->digest->md_size;
52 static int sha3_init(EVP_MD_CTX *evp_ctx)
54 return init(evp_ctx, '\x06');
57 static int shake_init(EVP_MD_CTX *evp_ctx)
59 return init(evp_ctx, '\x1f');
62 static int kmac_init(EVP_MD_CTX *evp_ctx)
64 return init(evp_ctx, '\x04');
67 static int sha3_update(EVP_MD_CTX *evp_ctx, const void *_inp, size_t len)
69 KECCAK1600_CTX *ctx = evp_ctx->md_data;
70 const unsigned char *inp = _inp;
71 size_t bsz = ctx->block_size;
77 if ((num = ctx->num) != 0) { /* process intermediate buffer? */
81 memcpy(ctx->buf + num, inp, len);
86 * We have enough data to fill or overflow the intermediate
87 * buffer. So we append |rem| bytes and process the block,
88 * leaving the rest for later processing...
90 memcpy(ctx->buf + num, inp, rem);
91 inp += rem, len -= rem;
92 (void)SHA3_absorb(ctx->A, ctx->buf, bsz, bsz);
94 /* ctx->buf is processed, ctx->num is guaranteed to be zero */
98 rem = SHA3_absorb(ctx->A, inp, len, bsz);
103 memcpy(ctx->buf, inp + len - rem, rem);
110 static int sha3_final(EVP_MD_CTX *evp_ctx, unsigned char *md)
112 KECCAK1600_CTX *ctx = evp_ctx->md_data;
113 size_t bsz = ctx->block_size;
114 size_t num = ctx->num;
117 * Pad the data with 10*1. Note that |num| can be |bsz - 1|
118 * in which case both byte operations below are performed on
121 memset(ctx->buf + num, 0, bsz - num);
122 ctx->buf[num] = ctx->pad;
123 ctx->buf[bsz - 1] |= 0x80;
125 (void)SHA3_absorb(ctx->A, ctx->buf, bsz, bsz);
127 SHA3_squeeze(ctx->A, md, ctx->md_size, bsz);
132 static int shake_ctrl(EVP_MD_CTX *evp_ctx, int cmd, int p1, void *p2)
134 KECCAK1600_CTX *ctx = evp_ctx->md_data;
137 case EVP_MD_CTRL_XOF_LEN:
145 #if defined(OPENSSL_CPUID_OBJ) && defined(__s390__) && defined(KECCAK1600_ASM)
149 # include "s390x_arch.h"
151 # define S390X_SHA3_FC(ctx) ((ctx)->pad)
153 # define S390X_sha3_224_CAPABLE ((OPENSSL_s390xcap_P.kimd[0] & \
154 S390X_CAPBIT(S390X_SHA3_224)) && \
155 (OPENSSL_s390xcap_P.klmd[0] & \
156 S390X_CAPBIT(S390X_SHA3_224)))
157 # define S390X_sha3_256_CAPABLE ((OPENSSL_s390xcap_P.kimd[0] & \
158 S390X_CAPBIT(S390X_SHA3_256)) && \
159 (OPENSSL_s390xcap_P.klmd[0] & \
160 S390X_CAPBIT(S390X_SHA3_256)))
161 # define S390X_sha3_384_CAPABLE ((OPENSSL_s390xcap_P.kimd[0] & \
162 S390X_CAPBIT(S390X_SHA3_384)) && \
163 (OPENSSL_s390xcap_P.klmd[0] & \
164 S390X_CAPBIT(S390X_SHA3_384)))
165 # define S390X_sha3_512_CAPABLE ((OPENSSL_s390xcap_P.kimd[0] & \
166 S390X_CAPBIT(S390X_SHA3_512)) && \
167 (OPENSSL_s390xcap_P.klmd[0] & \
168 S390X_CAPBIT(S390X_SHA3_512)))
169 # define S390X_shake128_CAPABLE ((OPENSSL_s390xcap_P.kimd[0] & \
170 S390X_CAPBIT(S390X_SHAKE_128)) && \
171 (OPENSSL_s390xcap_P.klmd[0] & \
172 S390X_CAPBIT(S390X_SHAKE_128)))
173 # define S390X_shake256_CAPABLE ((OPENSSL_s390xcap_P.kimd[0] & \
174 S390X_CAPBIT(S390X_SHAKE_256)) && \
175 (OPENSSL_s390xcap_P.klmd[0] & \
176 S390X_CAPBIT(S390X_SHAKE_256)))
178 /* Convert md-size to block-size. */
179 # define S390X_KECCAK1600_BSZ(n) ((KECCAK1600_WIDTH - ((n) << 1)) >> 3)
181 static int s390x_sha3_init(EVP_MD_CTX *evp_ctx)
183 KECCAK1600_CTX *ctx = evp_ctx->md_data;
184 const size_t bsz = evp_ctx->digest->block_size;
187 * KECCAK1600_CTX structure's pad field is used to store the KIMD/KLMD
191 case S390X_KECCAK1600_BSZ(224):
192 ctx->pad = S390X_SHA3_224;
194 case S390X_KECCAK1600_BSZ(256):
195 ctx->pad = S390X_SHA3_256;
197 case S390X_KECCAK1600_BSZ(384):
198 ctx->pad = S390X_SHA3_384;
200 case S390X_KECCAK1600_BSZ(512):
201 ctx->pad = S390X_SHA3_512;
207 memset(ctx->A, 0, sizeof(ctx->A));
209 ctx->block_size = bsz;
210 ctx->md_size = evp_ctx->digest->md_size;
214 static int s390x_shake_init(EVP_MD_CTX *evp_ctx)
216 KECCAK1600_CTX *ctx = evp_ctx->md_data;
217 const size_t bsz = evp_ctx->digest->block_size;
220 * KECCAK1600_CTX structure's pad field is used to store the KIMD/KLMD
224 case S390X_KECCAK1600_BSZ(128):
225 ctx->pad = S390X_SHAKE_128;
227 case S390X_KECCAK1600_BSZ(256):
228 ctx->pad = S390X_SHAKE_256;
234 memset(ctx->A, 0, sizeof(ctx->A));
236 ctx->block_size = bsz;
237 ctx->md_size = evp_ctx->digest->md_size;
241 static int s390x_sha3_update(EVP_MD_CTX *evp_ctx, const void *_inp, size_t len)
243 KECCAK1600_CTX *ctx = evp_ctx->md_data;
244 const unsigned char *inp = _inp;
245 const size_t bsz = ctx->block_size;
251 if ((num = ctx->num) != 0) {
255 memcpy(ctx->buf + num, inp, len);
259 memcpy(ctx->buf + num, inp, rem);
262 s390x_kimd(ctx->buf, bsz, ctx->pad, ctx->A);
267 s390x_kimd(inp, len - rem, ctx->pad, ctx->A);
270 memcpy(ctx->buf, inp + len - rem, rem);
276 static int s390x_sha3_final(EVP_MD_CTX *evp_ctx, unsigned char *md)
278 KECCAK1600_CTX *ctx = evp_ctx->md_data;
280 s390x_klmd(ctx->buf, ctx->num, NULL, 0, ctx->pad, ctx->A);
281 memcpy(md, ctx->A, ctx->md_size);
285 static int s390x_shake_final(EVP_MD_CTX *evp_ctx, unsigned char *md)
287 KECCAK1600_CTX *ctx = evp_ctx->md_data;
289 s390x_klmd(ctx->buf, ctx->num, md, ctx->md_size, ctx->pad, ctx->A);
293 # define EVP_MD_SHA3(bitlen) \
294 const EVP_MD *EVP_sha3_##bitlen(void) \
296 static const EVP_MD s390x_sha3_##bitlen##_md = { \
298 NID_RSA_SHA3_##bitlen, \
300 EVP_MD_FLAG_DIGALGID_ABSENT, \
306 (KECCAK1600_WIDTH - bitlen * 2) / 8, \
307 sizeof(KECCAK1600_CTX), \
309 static const EVP_MD sha3_##bitlen##_md = { \
311 NID_RSA_SHA3_##bitlen, \
313 EVP_MD_FLAG_DIGALGID_ABSENT, \
319 (KECCAK1600_WIDTH - bitlen * 2) / 8, \
320 sizeof(KECCAK1600_CTX), \
322 return S390X_sha3_##bitlen##_CAPABLE ? \
323 &s390x_sha3_##bitlen##_md : \
324 &sha3_##bitlen##_md; \
327 # define EVP_MD_SHAKE(bitlen) \
328 const EVP_MD *EVP_shake##bitlen(void) \
330 static const EVP_MD s390x_shake##bitlen##_md = { \
340 (KECCAK1600_WIDTH - bitlen * 2) / 8, \
341 sizeof(KECCAK1600_CTX), \
344 static const EVP_MD shake##bitlen##_md = { \
354 (KECCAK1600_WIDTH - bitlen * 2) / 8, \
355 sizeof(KECCAK1600_CTX), \
358 return S390X_shake##bitlen##_CAPABLE ? \
359 &s390x_shake##bitlen##_md : \
360 &shake##bitlen##_md; \
365 # define EVP_MD_SHA3(bitlen) \
366 const EVP_MD *EVP_sha3_##bitlen(void) \
368 static const EVP_MD sha3_##bitlen##_md = { \
370 NID_RSA_SHA3_##bitlen, \
372 EVP_MD_FLAG_DIGALGID_ABSENT, \
378 (KECCAK1600_WIDTH - bitlen * 2) / 8, \
379 sizeof(KECCAK1600_CTX), \
381 return &sha3_##bitlen##_md; \
384 # define EVP_MD_SHAKE(bitlen) \
385 const EVP_MD *EVP_shake##bitlen(void) \
387 static const EVP_MD shake##bitlen##_md = { \
397 (KECCAK1600_WIDTH - bitlen * 2) / 8, \
398 sizeof(KECCAK1600_CTX), \
401 return &shake##bitlen##_md; \
415 # define EVP_MD_KECCAK_KMAC(bitlen) \
416 const EVP_MD *evp_keccak_kmac##bitlen(void) \
418 static const EVP_MD kmac_##bitlen##_md = { \
428 (KECCAK1600_WIDTH - bitlen * 2) / 8, \
429 sizeof(KECCAK1600_CTX), \
432 return &kmac_##bitlen##_md; \
435 EVP_MD_KECCAK_KMAC(128)
436 EVP_MD_KECCAK_KMAC(256)