scrypt.c File Reference

scrypt PBKDF (Password-Based Key Derivation Function) More...

#include "core/crypto.h"
#include "kdf/scrypt.h"
#include "kdf/pbkdf.h"
#include "hash/sha256.h"
#include "cipher/salsa20.h"

Go to the source code of this file.

Macros

#define TRACE_LEVEL   CRYPTO_TRACE_LEVEL
 

Functions

error_t scrypt (const char_t *password, const uint8_t *salt, size_t saltLen, uint_t n, uint_t r, uint_t p, uint8_t *dk, size_t dkLen)
 scrypt algorithm More...
 
void scryptRoMix (uint_t r, uint8_t *b, uint_t n, uint8_t *v, uint8_t *y)
 scryptROMix algorithm More...
 
void scryptBlockMix (uint_t r, uint8_t *b, uint8_t *y)
 scryptBlockMix algorithm More...
 
void scryptXorBlock (uint8_t *x, const uint8_t *a, const uint8_t *b, size_t n)
 XOR operation. More...
 

Detailed Description

scrypt PBKDF (Password-Based Key Derivation Function)

License

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

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

Description

scrypt is a password-based key derivation function. The function derives one or more secret keys from a secret string. It is based on memory-hard functions, which offer added protection against attacks using custom hardware. Refer to RFC 7914 for more details

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

Definition in file scrypt.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   CRYPTO_TRACE_LEVEL

Definition at line 39 of file scrypt.c.

Function Documentation

◆ scrypt()

error_t scrypt ( const char_t password,
const uint8_t *  salt,
size_t  saltLen,
uint_t  n,
uint_t  r,
uint_t  p,
uint8_t *  dk,
size_t  dkLen 
)

scrypt algorithm

Parameters
[in]passwordNULL-terminated passphrase
[in]saltRandom salt
[in]saltLenLength of the random salt, in bytes
[in]nCPU/Memory cost parameter
[in]rBlock size parameter
[in]pParallelization parameter
[out]dkDerived key
[in]dkLenIntended output length in octets of the derived key
Returns
Error code

Definition at line 65 of file scrypt.c.

◆ scryptBlockMix()

void scryptBlockMix ( uint_t  r,
uint8_t *  b,
uint8_t *  y 
)

scryptBlockMix algorithm

Parameters
[in]rBlock size parameter
[in,out]bOctet vector of length 128 * r octets
[in,out]yWorking array

Definition at line 233 of file scrypt.c.

◆ scryptRoMix()

void scryptRoMix ( uint_t  r,
uint8_t *  b,
uint_t  n,
uint8_t *  v,
uint8_t *  y 
)

scryptROMix algorithm

Parameters
[in]rBlock size parameter
[in,out]bOctet vector of length 128 * r octets
[in]nCPU/Memory cost parameter
[in,out]vWorking array
[in,out]yWorking array

Definition at line 188 of file scrypt.c.

◆ scryptXorBlock()

void scryptXorBlock ( uint8_t *  x,
const uint8_t *  a,
const uint8_t *  b,
size_t  n 
)

XOR operation.

Parameters
[out]xBlock resulting from the XOR operation
[in]aFirst block
[in]bSecond block
[in]nSize of the block

Definition at line 271 of file scrypt.c.