sha_crypt.h File Reference

Unix crypt using SHA-256 and SHA-512. More...

#include "core/crypto.h"

Go to the source code of this file.

Macros

#define SHA_CRYPT_MIN_ROUNDS   1000
 
#define SHA_CRYPT_MAX_ROUNDS   999999999
 
#define SHA_CRYPT_DEFAULT_ROUNDS   5000
 
#define SHA_CRYPT_MAX_SALT_LEN   16
 

Functions

error_t shaCrypt (const HashAlgo *hashAlgo, const char_t *password, const char_t *salt, char_t *output, size_t *outputLen)
 SHA-crypt algorithm. More...
 
size_t shaCryptEncodeBase64 (const HashAlgo *hashAlgo, const uint8_t *input, uint8_t *output)
 base-64 encoding algorithm More...
 

Detailed Description

Unix crypt using SHA-256 and SHA-512.

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

Macro Definition Documentation

◆ SHA_CRYPT_DEFAULT_ROUNDS

#define SHA_CRYPT_DEFAULT_ROUNDS   5000

Definition at line 42 of file sha_crypt.h.

◆ SHA_CRYPT_MAX_ROUNDS

#define SHA_CRYPT_MAX_ROUNDS   999999999

Definition at line 40 of file sha_crypt.h.

◆ SHA_CRYPT_MAX_SALT_LEN

#define SHA_CRYPT_MAX_SALT_LEN   16

Definition at line 45 of file sha_crypt.h.

◆ SHA_CRYPT_MIN_ROUNDS

#define SHA_CRYPT_MIN_ROUNDS   1000

Definition at line 38 of file sha_crypt.h.

Function Documentation

◆ shaCrypt()

error_t shaCrypt ( const HashAlgo hashAlgo,
const char_t password,
const char_t salt,
char_t output,
size_t *  outputLen 
)

SHA-crypt algorithm.

Parameters
[in]hashAlgoUnderlying hash function (SHA-256 or SHA-512)
[in]passwordNULL-terminated password
[in]saltNULL-terminated salt string
[out]outputOutput string
[out]outputLenLength of the output string (optional parameter)
Returns
Error code

Definition at line 62 of file sha_crypt.c.

◆ shaCryptEncodeBase64()

size_t shaCryptEncodeBase64 ( const HashAlgo hashAlgo,
const uint8_t *  input,
uint8_t *  output 
)

base-64 encoding algorithm

Parameters
[in]hashAlgoUnderlying hash function (SHA-256 or SHA-512)
[in]inputInput digest to encode
[out]outputNULL-terminated string encoded with base-64 algorithm
Returns
Length of the base-64 string

Definition at line 360 of file sha_crypt.c.