sha_crypt.h
Go to the documentation of this file.
1 /**
2  * @file sha_crypt.h
3  * @brief Unix crypt using SHA-256 and SHA-512
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneCRYPTO Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 2.4.4
29  **/
30 
31 #ifndef _SHA_CRYPT_H
32 #define _SHA_CRYPT_H
33 
34 //Dependencies
35 #include "core/crypto.h"
36 
37 //Minimum number of rounds
38 #define SHA_CRYPT_MIN_ROUNDS 1000
39 //Maximum number of rounds
40 #define SHA_CRYPT_MAX_ROUNDS 999999999
41 //Default number of rounds
42 #define SHA_CRYPT_DEFAULT_ROUNDS 5000
43 
44 //Maximum length of the salt string
45 #define SHA_CRYPT_MAX_SALT_LEN 16
46 
47 //C++ guard
48 #ifdef __cplusplus
49 extern "C" {
50 #endif
51 
52 //SHA-crypt related functions
53 error_t shaCrypt(const HashAlgo *hashAlgo, const char_t *password,
54  const char_t *salt, char_t *output, size_t *outputLen);
55 
56 size_t shaCryptEncodeBase64(const HashAlgo *hashAlgo, const uint8_t *input,
57  uint8_t *output);
58 
59 //C++ guard
60 #ifdef __cplusplus
61 }
62 #endif
63 
64 #endif
error_t shaCrypt(const HashAlgo *hashAlgo, const char_t *password, const char_t *salt, char_t *output, size_t *outputLen)
SHA-crypt algorithm.
Definition: sha_crypt.c:62
error_t
Error codes.
Definition: error.h:43
size_t shaCryptEncodeBase64(const HashAlgo *hashAlgo, const uint8_t *input, uint8_t *output)
base-64 encoding algorithm
Definition: sha_crypt.c:360
General definitions for cryptographic algorithms.
char char_t
Definition: compiler_port.h:48
Common interface for hash algorithms.
Definition: crypto.h:1046