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


#define KECCAK_L   6
#define keccak_lane_t   uint64_t
#define KECCAK_ROL(a, n)   ROL64(a, n)
#define KECCAK_HTOLE(a)   htole64(a)
#define KECCAK_LETOH(a)   letoh64(a)
#define KECCAK_W   (1 << KECCAK_L)
#define KECCAK_B   (KECCAK_W * 25)
#define KECCAK_NR   (12 + 2 * KECCAK_L)
#define KECCAK_PAD   0x01
#define KECCAK_SHA3_PAD   0x06
#define KECCAK_XOF_PAD   0x1F


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.


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

Copyright (C) 2010-2020 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.

Oryx Embedded SARL (

Definition in file keccak.h.

Macro Definition Documentation


#define KECCAK_B   (KECCAK_W * 25)

Definition at line 86 of file keccak.h.


#define KECCAK_HTOLE (   a)    htole64(a)

Definition at line 76 of file keccak.h.


#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.


#define KECCAK_LETOH (   a)    letoh64(a)

Definition at line 78 of file keccak.h.


#define KECCAK_NR   (12 + 2 * KECCAK_L)

Definition at line 88 of file keccak.h.


#define KECCAK_PAD   0x01

Definition at line 91 of file keccak.h.


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

Definition at line 74 of file keccak.h.


#define KECCAK_SHA3_PAD   0x06

Definition at line 93 of file keccak.h.


#define KECCAK_W   (1 << KECCAK_L)

Definition at line 84 of file keccak.h.


#define KECCAK_XOF_PAD   0x1F

Definition at line 95 of file keccak.h.

Function Documentation

◆ keccakAbsorb()

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

Absorb data.

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

Definition at line 318 of file keccak.c.

◆ keccakFinal()

void keccakFinal ( KeccakContext context,
uint8_t  pad 

Finish absorbing phase.

[in]contextPointer to the Keccak context
[in]padValue of the padding byte (0x01 for Keccak, 0x06 for SHA-3 and 0x1F for XOF)

Definition at line 369 of file keccak.c.

◆ keccakInit()

error_t keccakInit ( KeccakContext context,
uint_t  capacity 

Initialize Keccak context.

[in]contextPointer to the Keccak context to initialize
[in]capacityCapacity of the sponge function

Definition at line 285 of file keccak.c.

◆ keccakPermutBlock()

void keccakPermutBlock ( KeccakContext context)

Block permutation.

[in]contextPointer to the Keccak context

Definition at line 473 of file keccak.c.

◆ keccakSqueeze()

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

Extract data from the squeezing phase.

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

Definition at line 413 of file keccak.c.