scrypt.h File Reference

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

#include "core/crypto.h"

Go to the source code of this file.

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.

Author

Oryx Embedded SARL (www.oryx-embedded.com)

Version

2.4.4

Definition in file scrypt.h.

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]	password	NULL-terminated passphrase
[in]	salt	Random salt
[in]	saltLen	Length of the random salt, in bytes
[in]	n	CPU/Memory cost parameter
[in]	r	Block size parameter
[in]	p	Parallelization parameter
[out]	dk	Derived key
[in]	dkLen	Intended 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]	r	Block size parameter
[in,out]	b	Octet vector of length 128 * r octets
[in,out]	y	Working array

Definition at line 239 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]	r	Block size parameter
[in,out]	b	Octet vector of length 128 * r octets
[in]	n	CPU/Memory cost parameter
[in,out]	v	Working array
[in,out]	y	Working array

Definition at line 194 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]	x	Block resulting from the XOR operation
[in]	a	First block
[in]	b	Second block
[in]	n	Size of the block

Definition at line 277 of file scrypt.c.