Home | History | Annotate | Line # | Download | only in internal 
      1 /*
      2  * Copyright 2019-2024 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 /* This header can move into provider when legacy support is removed */
     11 #ifndef OSSL_INTERNAL_SHA3_H
     12 #define OSSL_INTERNAL_SHA3_H
     13 #pragma once
     14 
     15 #include <openssl/e_os2.h>
     16 #include <stddef.h>
     17 
     18 #define KECCAK1600_WIDTH 1600
     19 #define SHA3_MDSIZE(bitlen) (bitlen / 8)
     20 #define KMAC_MDSIZE(bitlen) 2 * (bitlen / 8)
     21 #define SHA3_BLOCKSIZE(bitlen) (KECCAK1600_WIDTH - bitlen * 2) / 8
     22 
     23 typedef struct keccak_st KECCAK1600_CTX;
     24 
     25 typedef size_t(sha3_absorb_fn)(void *vctx, const void *in, size_t inlen);
     26 typedef int(sha3_final_fn)(void *vctx, unsigned char *out, size_t outlen);
     27 typedef int(sha3_squeeze_fn)(void *vctx, unsigned char *out, size_t outlen);
     28 
     29 typedef struct prov_sha3_meth_st {
     30     sha3_absorb_fn *absorb;
     31     sha3_final_fn *final;
     32     sha3_squeeze_fn *squeeze;
     33 } PROV_SHA3_METHOD;
     34 
     35 #define XOF_STATE_INIT 0
     36 #define XOF_STATE_ABSORB 1
     37 #define XOF_STATE_FINAL 2
     38 #define XOF_STATE_SQUEEZE 3
     39 
     40 struct keccak_st {
     41     uint64_t A[5][5];
     42     unsigned char buf[KECCAK1600_WIDTH / 8 - 32];
     43     size_t block_size; /* cached ctx->digest->block_size */
     44     size_t md_size; /* output length, variable in XOF */
     45     size_t bufsz; /* used bytes in below buffer */
     46     unsigned char pad;
     47     PROV_SHA3_METHOD meth;
     48     int xof_state;
     49 };
     50 
     51 void ossl_sha3_reset(KECCAK1600_CTX *ctx);
     52 int ossl_sha3_init(KECCAK1600_CTX *ctx, unsigned char pad, size_t bitlen);
     53 int ossl_keccak_init(KECCAK1600_CTX *ctx, unsigned char pad,
     54     size_t typelen, size_t mdlen);
     55 int ossl_sha3_update(KECCAK1600_CTX *ctx, const void *_inp, size_t len);
     56 int ossl_sha3_final(KECCAK1600_CTX *ctx, unsigned char *out, size_t outlen);
     57 int ossl_sha3_squeeze(KECCAK1600_CTX *ctx, unsigned char *out, size_t outlen);
     58 
     59 size_t SHA3_absorb(uint64_t A[5][5], const unsigned char *inp, size_t len,
     60     size_t r);
     61 
     62 #endif /* OSSL_INTERNAL_SHA3_H */
     63