include/internal/sha3.h

   1 /*
   2  * Copyright 2019-2020 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 /* TODO(3.0) Move this header into provider when dependencies are 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 *inp, size_t len);
  26 typedef int (sha3_final_fn)(unsigned char *md, void *vctx);
  27
  28 typedef struct prov_sha3_meth_st
  29 {
  30     sha3_absorb_fn *absorb;
  31     sha3_final_fn *final;
  32 } PROV_SHA3_METHOD;
  33
  34 struct keccak_st {
  35     uint64_t A[5][5];
  36     size_t block_size;          /* cached ctx->digest->block_size */
  37     size_t md_size;             /* output length, variable in XOF */
  38     size_t bufsz;               /* used bytes in below buffer */
  39     unsigned char buf[KECCAK1600_WIDTH / 8 - 32];
  40     unsigned char pad;
  41     PROV_SHA3_METHOD meth;
  42 };
  43
  44 void ossl_sha3_reset(KECCAK1600_CTX *ctx);
  45 int ossl_sha3_init(KECCAK1600_CTX *ctx, unsigned char pad, size_t bitlen);
  46 int ossl_keccak_kmac_init(KECCAK1600_CTX *ctx, unsigned char pad,
  47                           size_t bitlen);
  48 int ossl_sha3_update(KECCAK1600_CTX *ctx, const void *_inp, size_t len);
  49 int ossl_sha3_final(unsigned char *md, KECCAK1600_CTX *ctx);
  50
  51 size_t SHA3_absorb(uint64_t A[5][5], const unsigned char *inp, size_t len,
  52                    size_t r);
  53
  54 #endif /* OSSL_INTERNAL_SHA3_H */