keccak.h File Reference

Keccak sponge function. More...

#include "core/crypto.h"

Go to the source code of this file.

Data Structures
struct	KeccakContext
	Keccak context. More...

Macros
#define	KECCAK_L   6
#define	keccak_lane_t   uint64_t
#define	KECCAK_ROL(a, n)   ROL64(a, (n) % 64)
#define	KECCAK_LOAD_LANE(p)   LOAD64LE(p)
#define	KECCAK_STORE_LANE(a, p)   STORE64LE(a, p)
#define	KECCAK_W_BITS   (1 << KECCAK_L)
#define	KECCAK_W_BYTES   ((1 << KECCAK_L) / 8)
#define	KECCAK_B_BITS   (KECCAK_W_BITS * 25)
#define	KECCAK_B_BYTES   (KECCAK_W_BYTES * 25)
#define	KECCAK_NR   (12 + 2 * KECCAK_L)
#define	KECCAK_PAD   0x01
#define	KECCAK_SHA3_PAD   0x06
#define	KECCAK_SHAKE_PAD   0x1F
#define	KECCAK_CSHAKE_PAD   0x04

Functions
error_t	keccakInit (KeccakContext *context, uint_t capacity)
	Initialize Keccak context. More...
void	keccakAbsorb (KeccakContext *context, const void *input, size_t length)
	Absorb data. More...
void	keccakFinal (KeccakContext *context, uint8_t pad)
	Finish absorbing phase. More...
void	keccakSqueeze (KeccakContext *context, uint8_t *output, size_t length)
	Extract data from the squeezing phase. More...
void	keccakPermutBlock (KeccakContext *context)
	Block permutation. More...

Detailed Description

Keccak sponge function.

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 keccak.h.

Macro Definition Documentation

KECCAK_B_BITS

#define KECCAK_B_BITS   (KECCAK_W_BITS * 25)

Definition at line 89 of file keccak.h.

KECCAK_B_BYTES

#define KECCAK_B_BYTES   (KECCAK_W_BYTES * 25)

Definition at line 91 of file keccak.h.

KECCAK_CSHAKE_PAD

#define KECCAK_CSHAKE_PAD   0x04

Definition at line 103 of file keccak.h.

KECCAK_L

#define KECCAK_L   6

Definition at line 39 of file keccak.h.

keccak_lane_t

#define keccak_lane_t   uint64_t

Definition at line 72 of file keccak.h.

KECCAK_LOAD_LANE

#define KECCAK_LOAD_LANE

(

p

)

LOAD64LE(p)

Definition at line 76 of file keccak.h.

KECCAK_NR

#define KECCAK_NR   (12 + 2 * KECCAK_L)

Definition at line 94 of file keccak.h.

KECCAK_PAD

#define KECCAK_PAD   0x01

Definition at line 97 of file keccak.h.

KECCAK_ROL

#define KECCAK_ROL	(		a,
			n
	)		ROL64(a, (n) % 64)

Definition at line 74 of file keccak.h.

KECCAK_SHA3_PAD

#define KECCAK_SHA3_PAD   0x06

Definition at line 99 of file keccak.h.

KECCAK_SHAKE_PAD

#define KECCAK_SHAKE_PAD   0x1F

Definition at line 101 of file keccak.h.

KECCAK_STORE_LANE

#define KECCAK_STORE_LANE	(		a,
			p
	)		STORE64LE(a, p)

Definition at line 78 of file keccak.h.

KECCAK_W_BITS

#define KECCAK_W_BITS   (1 << KECCAK_L)

Definition at line 84 of file keccak.h.

KECCAK_W_BYTES

#define KECCAK_W_BYTES   ((1 << KECCAK_L) / 8)

Definition at line 86 of file keccak.h.

Function Documentation

keccakAbsorb()

void keccakAbsorb	(	KeccakContext *	context,
		const void *	input,
		size_t	length
	)

Absorb data.

Parameters

[in]	context	Pointer to the Keccak context
[in]	input	Pointer to the buffer being hashed
[in]	length	Length of the buffer

Definition at line 489 of file m460_crypto_hash.c.

keccakFinal()

void keccakFinal	(	KeccakContext *	context,
		uint8_t	pad
	)

Finish absorbing phase.

Parameters

[in]	context	Pointer to the Keccak context
[in]	pad	Padding byte used for domain separation

Definition at line 373 of file keccak.c.

keccakInit()

error_t keccakInit	(	KeccakContext *	context,
		uint_t	capacity
	)

Initialize Keccak context.

Parameters

[in]	context	Pointer to the Keccak context to initialize
[in]	capacity	Capacity of the sponge function

Definition at line 285 of file keccak.c.

keccakPermutBlock()

void keccakPermutBlock

(

KeccakContext *

context

)

Block permutation.

Parameters

[in]

context

Pointer to the Keccak context

Definition at line 546 of file m460_crypto_hash.c.

keccakSqueeze()

void keccakSqueeze	(	KeccakContext *	context,
		uint8_t *	output,
		size_t	length
	)

Extract data from the squeezing phase.

Parameters

[in]	context	Pointer to the Keccak context
[out]	output	Output string
[in]	length	Desired output length, in bytes

Definition at line 417 of file keccak.c.