Data Structures | Macros | Functions | Variables
shake.h File Reference

SHAKE128 and SHAKE256 extendable-output functions. More...

#include "core/crypto.h"
#include "xof/keccak.h"

Go to the source code of this file.

Data Structures

struct  ShakeContext
 SHAKE algorithm context. More...
 

Macros

#define SHAKE128_XOF_ALGO   (&shake128XofAlgo)
 
#define SHAKE256_XOF_ALGO   (&shake256XofAlgo)
 

Functions

error_t shakeCompute (uint_t strength, const void *input, size_t inputLen, uint8_t *output, size_t outputLen)
 Digest a message using SHAKE128 or SHAKE256. More...
 
error_t shake128Compute (const void *input, size_t inputLen, uint8_t *output, size_t outputLen)
 Digest a message using SHAKE128. More...
 
error_t shake256Compute (const void *input, size_t inputLen, uint8_t *output, size_t outputLen)
 Digest a message using SHAKE256. More...
 
error_t shakeInit (ShakeContext *context, uint_t strength)
 Initialize SHAKE context. More...
 
error_t shake128Init (ShakeContext *context)
 Initialize SHAKE128 context. More...
 
error_t shake256Init (ShakeContext *context)
 Initialize SHAKE256 context. More...
 
void shakeAbsorb (ShakeContext *context, const void *input, size_t length)
 Absorb data. More...
 
void shakeFinal (ShakeContext *context)
 Finish absorbing phase. More...
 
void shakeSqueeze (ShakeContext *context, uint8_t *output, size_t length)
 Extract data from the squeezing phase. More...
 

Variables

const uint8_t SHAKE128_OID [9]
 
const uint8_t SHAKE256_OID [9]
 
const XofAlgo shake128XofAlgo
 
const XofAlgo shake256XofAlgo
 

Detailed Description

SHAKE128 and SHAKE256 extendable-output functions.

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2010-2025 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneCRYPTO Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author
Oryx Embedded SARL (www.oryx-embedded.com)
Version
2.5.4

Definition in file shake.h.

Macro Definition Documentation

◆ SHAKE128_XOF_ALGO

#define SHAKE128_XOF_ALGO   (&shake128XofAlgo)

Definition at line 39 of file shake.h.

◆ SHAKE256_XOF_ALGO

#define SHAKE256_XOF_ALGO   (&shake256XofAlgo)

Definition at line 40 of file shake.h.

Function Documentation

◆ shake128Compute()

error_t shake128Compute ( const void *  input,
size_t  inputLen,
uint8_t *  output,
size_t  outputLen 
)

Digest a message using SHAKE128.

Parameters
[in]inputPointer to the input data
[in]inputLenLength of the input data
[out]outputPointer to the output data
[in]outputLenExpected length of the output data
Returns
Error code

Definition at line 150 of file shake.c.

◆ shake128Init()

error_t shake128Init ( ShakeContext *  context)

Initialize SHAKE128 context.

Parameters
[in]contextPointer to the SHAKE context to initialize
Returns
Error code

Definition at line 210 of file shake.c.

◆ shake256Compute()

error_t shake256Compute ( const void *  input,
size_t  inputLen,
uint8_t *  output,
size_t  outputLen 
)

Digest a message using SHAKE256.

Parameters
[in]inputPointer to the input data
[in]inputLenLength of the input data
[out]outputPointer to the output data
[in]outputLenExpected length of the output data
Returns
Error code

Definition at line 167 of file shake.c.

◆ shake256Init()

error_t shake256Init ( ShakeContext *  context)

Initialize SHAKE256 context.

Parameters
[in]contextPointer to the SHAKE context to initialize
Returns
Error code

Definition at line 223 of file shake.c.

◆ shakeAbsorb()

void shakeAbsorb ( ShakeContext *  context,
const void *  input,
size_t  length 
)

Absorb data.

Parameters
[in]contextPointer to the SHAKE context
[in]inputPointer to the buffer being hashed
[in]lengthLength of the buffer

Definition at line 237 of file shake.c.

◆ shakeCompute()

error_t shakeCompute ( uint_t  strength,
const void *  input,
size_t  inputLen,
uint8_t *  output,
size_t  outputLen 
)

Digest a message using SHAKE128 or SHAKE256.

Parameters
[in]strengthNumber of bits of security (128 for SHAKE128 and 256 for SHAKE256)
[in]inputPointer to the input data
[in]inputLenLength of the input data
[out]outputPointer to the output data
[in]outputLenExpected length of the output data
Returns
Error code

Definition at line 92 of file shake.c.

◆ shakeFinal()

void shakeFinal ( ShakeContext *  context)

Finish absorbing phase.

Parameters
[in]contextPointer to the SHAKE context

Definition at line 249 of file shake.c.

◆ shakeInit()

error_t shakeInit ( ShakeContext *  context,
uint_t  strength 
)

Initialize SHAKE context.

Parameters
[in]contextPointer to the SHAKE context to initialize
[in]strengthNumber of bits of security (128 for SHAKE128 and 256 for SHAKE256)
Returns
Error code

Definition at line 183 of file shake.c.

◆ shakeSqueeze()

void shakeSqueeze ( ShakeContext *  context,
uint8_t *  output,
size_t  length 
)

Extract data from the squeezing phase.

Parameters
[in]contextPointer to the SHAKE context
[out]outputOutput string
[in]lengthDesired output length, in bytes

Definition at line 263 of file shake.c.

Variable Documentation

◆ SHAKE128_OID

const uint8_t SHAKE128_OID[9]
extern

Definition at line 48 of file shake.c.

◆ shake128XofAlgo

const XofAlgo shake128XofAlgo
extern

Definition at line 53 of file shake.c.

◆ SHAKE256_OID

const uint8_t SHAKE256_OID[9]
extern

Definition at line 50 of file shake.c.

◆ shake256XofAlgo

const XofAlgo shake256XofAlgo
extern

Definition at line 67 of file shake.c.