ObjFW
OFScrypt.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2008-2024 Jonathan Schleifer <js@nil.im>
3  *
4  * All rights reserved.
5  *
6  * This file is part of ObjFW. It may be distributed under the terms of the
7  * Q Public License 1.0, which can be found in the file LICENSE.QPL included in
8  * the packaging of this file.
9  *
10  * Alternatively, it may be distributed under the terms of the GNU General
11  * Public License, either version 2 or 3, which can be found in the file
12  * LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
13  * file.
14  */
15 
16 #ifndef __STDC_LIMIT_MACROS
17 # define __STDC_LIMIT_MACROS
18 #endif
19 #ifndef __STDC_CONSTANT_MACROS
20 # define __STDC_CONSTANT_MACROS
21 #endif
22 
23 #import "macros.h"
24 
25 OF_ASSUME_NONNULL_BEGIN
26 
29 @class OFHMAC;
30 
34 typedef struct {
36  size_t blockSize;
38  size_t costFactor;
42  const unsigned char *salt;
44  size_t saltLength;
46  const char *password;
50  unsigned char *key;
56  size_t keyLength;
60 
61 #ifdef __cplusplus
62 extern "C" {
63 #endif
64 extern void OFSalsa20_8Core(uint32_t buffer[_Nonnull 16]);
65 extern void OFScryptBlockMix(uint32_t *output, const uint32_t *input,
66  size_t blockSize);
67 extern void OFScryptROMix(uint32_t *buffer, size_t blockSize,
68  size_t costFactor, uint32_t *tmp);
69 
75 extern void OFScrypt(OFScryptParameters parameters);
76 #ifdef __cplusplus
77 }
78 #endif
79 
80 OF_ASSUME_NONNULL_END
const unsigned char * salt
The salt to derive a key with.
Definition: OFScrypt.h:42
A class which provides methods to calculate an HMAC.
Definition: OFHMAC.h:27
size_t passwordLength
The length of the password.
Definition: OFScrypt.h:48
size_t keyLength
The desired length for the derived key.
Definition: OFScrypt.h:56
size_t parallelization
The parallelization to use.
Definition: OFScrypt.h:40
unsigned char * key
The buffer to write the key to.
Definition: OFScrypt.h:50
size_t saltLength
The length of the salt.
Definition: OFScrypt.h:44
size_t blockSize
The block size to use.
Definition: OFScrypt.h:36
The parameters for OFScrypt.
Definition: OFScrypt.h:34
bool allowsSwappableMemory
Whether data may be stored in swappable memory.
Definition: OFScrypt.h:58
size_t costFactor
The CPU/memory cost factor to use.
Definition: OFScrypt.h:38
const char * password
The password to derive a key from.
Definition: OFScrypt.h:46
void OFScrypt(OFScryptParameters parameters)
Derives a key from a password and a salt using scrypt.
Definition: OFScrypt.m:141