1 /* 2 * Copyright 2019-2021 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 10 #include <string.h> 11 #include <openssl/core_names.h> 12 #include <openssl/crypto.h> 13 #include <openssl/evp.h> 14 #include <openssl/params.h> 15 #include <openssl/err.h> 16 #include <openssl/proverr.h> 17 #include "internal/sha3.h" 18 #include "prov/digestcommon.h" 19 #include "prov/implementations.h" 20 21 #define SHA3_FLAGS PROV_DIGEST_FLAG_ALGID_ABSENT 22 #define SHAKE_FLAGS PROV_DIGEST_FLAG_XOF 23 #define KMAC_FLAGS PROV_DIGEST_FLAG_XOF 24 25 /* 26 * Forward declaration of any unique methods implemented here. This is not strictly 27 * necessary for the compiler, but provides an assurance that the signatures 28 * of the functions in the dispatch table are correct. 29 */ 30 static OSSL_FUNC_digest_init_fn keccak_init; 31 static OSSL_FUNC_digest_init_fn keccak_init_params; 32 static OSSL_FUNC_digest_update_fn keccak_update; 33 static OSSL_FUNC_digest_final_fn keccak_final; 34 static OSSL_FUNC_digest_freectx_fn keccak_freectx; 35 static OSSL_FUNC_digest_dupctx_fn keccak_dupctx; 36 static OSSL_FUNC_digest_set_ctx_params_fn shake_set_ctx_params; 37 static OSSL_FUNC_digest_settable_ctx_params_fn shake_settable_ctx_params; 38 static sha3_absorb_fn generic_sha3_absorb; 39 static sha3_final_fn generic_sha3_final; 40 41 #if defined(OPENSSL_CPUID_OBJ) && defined(__s390__) && defined(KECCAK1600_ASM) 42 /* 43 * IBM S390X support 44 */ 45 # include "s390x_arch.h" 46 # define S390_SHA3 1 47 # define S390_SHA3_CAPABLE(name) \ 48 ((OPENSSL_s390xcap_P.kimd[0] & S390X_CAPBIT(S390X_##name)) && \ 49 (OPENSSL_s390xcap_P.klmd[0] & S390X_CAPBIT(S390X_##name))) 50 51 #endif 52 53 static int keccak_init(void *vctx, ossl_unused const OSSL_PARAM params[]) 54 { 55 if (!ossl_prov_is_running()) 56 return 0; 57 /* The newctx() handles most of the ctx fixed setup. */ 58 ossl_sha3_reset((KECCAK1600_CTX *)vctx); 59 return 1; 60 } 61 62 static int keccak_init_params(void *vctx, const OSSL_PARAM params[]) 63 { 64 return keccak_init(vctx, NULL) 65 && shake_set_ctx_params(vctx, params); 66 } 67 68 static int keccak_update(void *vctx, const unsigned char *inp, size_t len) 69 { 70 KECCAK1600_CTX *ctx = vctx; 71 const size_t bsz = ctx->block_size; 72 size_t num, rem; 73 74 if (len == 0) 75 return 1; 76 77 /* Is there anything in the buffer already ? */ 78 if ((num = ctx->bufsz) != 0) { 79 /* Calculate how much space is left in the buffer */ 80 rem = bsz - num; 81 /* If the new input does not fill the buffer then just add it */ 82 if (len < rem) { 83 memcpy(ctx->buf + num, inp, len); 84 ctx->bufsz += len; 85 return 1; 86 } 87 /* otherwise fill up the buffer and absorb the buffer */ 88 memcpy(ctx->buf + num, inp, rem); 89 /* Update the input pointer */ 90 inp += rem; 91 len -= rem; 92 ctx->meth.absorb(ctx, ctx->buf, bsz); 93 ctx->bufsz = 0; 94 } 95 /* Absorb the input - rem = leftover part of the input < blocksize) */ 96 rem = ctx->meth.absorb(ctx, inp, len); 97 /* Copy the leftover bit of the input into the buffer */ 98 if (rem) { 99 memcpy(ctx->buf, inp + len - rem, rem); 100 ctx->bufsz = rem; 101 } 102 return 1; 103 } 104 105 static int keccak_final(void *vctx, unsigned char *out, size_t *outl, 106 size_t outsz) 107 { 108 int ret = 1; 109 KECCAK1600_CTX *ctx = vctx; 110 111 if (!ossl_prov_is_running()) 112 return 0; 113 if (outsz > 0) 114 ret = ctx->meth.final(out, ctx); 115 116 *outl = ctx->md_size; 117 return ret; 118 } 119 120 /*- 121 * Generic software version of the absorb() and final(). 122 */ 123 static size_t generic_sha3_absorb(void *vctx, const void *inp, size_t len) 124 { 125 KECCAK1600_CTX *ctx = vctx; 126 127 return SHA3_absorb(ctx->A, inp, len, ctx->block_size); 128 } 129 130 static int generic_sha3_final(unsigned char *md, void *vctx) 131 { 132 return ossl_sha3_final(md, (KECCAK1600_CTX *)vctx); 133 } 134 135 static PROV_SHA3_METHOD sha3_generic_md = 136 { 137 generic_sha3_absorb, 138 generic_sha3_final 139 }; 140 141 #if defined(S390_SHA3) 142 143 static sha3_absorb_fn s390x_sha3_absorb; 144 static sha3_final_fn s390x_sha3_final; 145 static sha3_final_fn s390x_shake_final; 146 147 /*- 148 * The platform specific parts of the absorb() and final() for S390X. 149 */ 150 static size_t s390x_sha3_absorb(void *vctx, const void *inp, size_t len) 151 { 152 KECCAK1600_CTX *ctx = vctx; 153 size_t rem = len % ctx->block_size; 154 155 s390x_kimd(inp, len - rem, ctx->pad, ctx->A); 156 return rem; 157 } 158 159 static int s390x_sha3_final(unsigned char *md, void *vctx) 160 { 161 KECCAK1600_CTX *ctx = vctx; 162 163 if (!ossl_prov_is_running()) 164 return 0; 165 s390x_klmd(ctx->buf, ctx->bufsz, NULL, 0, ctx->pad, ctx->A); 166 memcpy(md, ctx->A, ctx->md_size); 167 return 1; 168 } 169 170 static int s390x_shake_final(unsigned char *md, void *vctx) 171 { 172 KECCAK1600_CTX *ctx = vctx; 173 174 if (!ossl_prov_is_running()) 175 return 0; 176 s390x_klmd(ctx->buf, ctx->bufsz, md, ctx->md_size, ctx->pad, ctx->A); 177 return 1; 178 } 179 180 static PROV_SHA3_METHOD sha3_s390x_md = 181 { 182 s390x_sha3_absorb, 183 s390x_sha3_final 184 }; 185 186 static PROV_SHA3_METHOD shake_s390x_md = 187 { 188 s390x_sha3_absorb, 189 s390x_shake_final 190 }; 191 192 # define SHA3_SET_MD(uname, typ) \ 193 if (S390_SHA3_CAPABLE(uname)) { \ 194 ctx->pad = S390X_##uname; \ 195 ctx->meth = typ##_s390x_md; \ 196 } else { \ 197 ctx->meth = sha3_generic_md; \ 198 } 199 #else 200 # define SHA3_SET_MD(uname, typ) ctx->meth = sha3_generic_md; 201 #endif /* S390_SHA3 */ 202 203 #define SHA3_newctx(typ, uname, name, bitlen, pad) \ 204 static OSSL_FUNC_digest_newctx_fn name##_newctx; \ 205 static void *name##_newctx(void *provctx) \ 206 { \ 207 KECCAK1600_CTX *ctx = ossl_prov_is_running() ? OPENSSL_zalloc(sizeof(*ctx)) \ 208 : NULL; \ 209 \ 210 if (ctx == NULL) \ 211 return NULL; \ 212 ossl_sha3_init(ctx, pad, bitlen); \ 213 SHA3_SET_MD(uname, typ) \ 214 return ctx; \ 215 } 216 217 #define KMAC_newctx(uname, bitlen, pad) \ 218 static OSSL_FUNC_digest_newctx_fn uname##_newctx; \ 219 static void *uname##_newctx(void *provctx) \ 220 { \ 221 KECCAK1600_CTX *ctx = ossl_prov_is_running() ? OPENSSL_zalloc(sizeof(*ctx)) \ 222 : NULL; \ 223 \ 224 if (ctx == NULL) \ 225 return NULL; \ 226 ossl_keccak_kmac_init(ctx, pad, bitlen); \ 227 ctx->meth = sha3_generic_md; \ 228 return ctx; \ 229 } 230 231 #define PROV_FUNC_SHA3_DIGEST_COMMON(name, bitlen, blksize, dgstsize, flags) \ 232 PROV_FUNC_DIGEST_GET_PARAM(name, blksize, dgstsize, flags) \ 233 const OSSL_DISPATCH ossl_##name##_functions[] = { \ 234 { OSSL_FUNC_DIGEST_NEWCTX, (void (*)(void))name##_newctx }, \ 235 { OSSL_FUNC_DIGEST_UPDATE, (void (*)(void))keccak_update }, \ 236 { OSSL_FUNC_DIGEST_FINAL, (void (*)(void))keccak_final }, \ 237 { OSSL_FUNC_DIGEST_FREECTX, (void (*)(void))keccak_freectx }, \ 238 { OSSL_FUNC_DIGEST_DUPCTX, (void (*)(void))keccak_dupctx }, \ 239 PROV_DISPATCH_FUNC_DIGEST_GET_PARAMS(name) 240 241 #define PROV_FUNC_SHA3_DIGEST(name, bitlen, blksize, dgstsize, flags) \ 242 PROV_FUNC_SHA3_DIGEST_COMMON(name, bitlen, blksize, dgstsize, flags), \ 243 { OSSL_FUNC_DIGEST_INIT, (void (*)(void))keccak_init }, \ 244 PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_END 245 246 #define PROV_FUNC_SHAKE_DIGEST(name, bitlen, blksize, dgstsize, flags) \ 247 PROV_FUNC_SHA3_DIGEST_COMMON(name, bitlen, blksize, dgstsize, flags), \ 248 { OSSL_FUNC_DIGEST_INIT, (void (*)(void))keccak_init_params }, \ 249 { OSSL_FUNC_DIGEST_SET_CTX_PARAMS, (void (*)(void))shake_set_ctx_params }, \ 250 { OSSL_FUNC_DIGEST_SETTABLE_CTX_PARAMS, \ 251 (void (*)(void))shake_settable_ctx_params }, \ 252 PROV_DISPATCH_FUNC_DIGEST_CONSTRUCT_END 253 254 static void keccak_freectx(void *vctx) 255 { 256 KECCAK1600_CTX *ctx = (KECCAK1600_CTX *)vctx; 257 258 OPENSSL_clear_free(ctx, sizeof(*ctx)); 259 } 260 261 static void *keccak_dupctx(void *ctx) 262 { 263 KECCAK1600_CTX *in = (KECCAK1600_CTX *)ctx; 264 KECCAK1600_CTX *ret = ossl_prov_is_running() ? OPENSSL_malloc(sizeof(*ret)) 265 : NULL; 266 267 if (ret != NULL) 268 *ret = *in; 269 return ret; 270 } 271 272 static const OSSL_PARAM known_shake_settable_ctx_params[] = { 273 {OSSL_DIGEST_PARAM_XOFLEN, OSSL_PARAM_UNSIGNED_INTEGER, NULL, 0, 0}, 274 OSSL_PARAM_END 275 }; 276 static const OSSL_PARAM *shake_settable_ctx_params(ossl_unused void *ctx, 277 ossl_unused void *provctx) 278 { 279 return known_shake_settable_ctx_params; 280 } 281 282 static int shake_set_ctx_params(void *vctx, const OSSL_PARAM params[]) 283 { 284 const OSSL_PARAM *p; 285 KECCAK1600_CTX *ctx = (KECCAK1600_CTX *)vctx; 286 287 if (ctx == NULL) 288 return 0; 289 if (params == NULL) 290 return 1; 291 292 p = OSSL_PARAM_locate_const(params, OSSL_DIGEST_PARAM_XOFLEN); 293 if (p != NULL && !OSSL_PARAM_get_size_t(p, &ctx->md_size)) { 294 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER); 295 return 0; 296 } 297 return 1; 298 } 299 300 #define IMPLEMENT_SHA3_functions(bitlen) \ 301 SHA3_newctx(sha3, SHA3_##bitlen, sha3_##bitlen, bitlen, '\x06') \ 302 PROV_FUNC_SHA3_DIGEST(sha3_##bitlen, bitlen, \ 303 SHA3_BLOCKSIZE(bitlen), SHA3_MDSIZE(bitlen), \ 304 SHA3_FLAGS) 305 306 #define IMPLEMENT_SHAKE_functions(bitlen) \ 307 SHA3_newctx(shake, SHAKE_##bitlen, shake_##bitlen, bitlen, '\x1f') \ 308 PROV_FUNC_SHAKE_DIGEST(shake_##bitlen, bitlen, \ 309 SHA3_BLOCKSIZE(bitlen), SHA3_MDSIZE(bitlen), \ 310 SHAKE_FLAGS) 311 #define IMPLEMENT_KMAC_functions(bitlen) \ 312 KMAC_newctx(keccak_kmac_##bitlen, bitlen, '\x04') \ 313 PROV_FUNC_SHAKE_DIGEST(keccak_kmac_##bitlen, bitlen, \ 314 SHA3_BLOCKSIZE(bitlen), KMAC_MDSIZE(bitlen), \ 315 KMAC_FLAGS) 316 317 /* ossl_sha3_224_functions */ 318 IMPLEMENT_SHA3_functions(224) 319 /* ossl_sha3_256_functions */ 320 IMPLEMENT_SHA3_functions(256) 321 /* ossl_sha3_384_functions */ 322 IMPLEMENT_SHA3_functions(384) 323 /* ossl_sha3_512_functions */ 324 IMPLEMENT_SHA3_functions(512) 325 /* ossl_shake_128_functions */ 326 IMPLEMENT_SHAKE_functions(128) 327 /* ossl_shake_256_functions */ 328 IMPLEMENT_SHAKE_functions(256) 329 /* ossl_keccak_kmac_128_functions */ 330 IMPLEMENT_KMAC_functions(128) 331 /* ossl_keccak_kmac_256_functions */ 332 IMPLEMENT_KMAC_functions(256) 333