e0c8df927d91665333bbe3056580bccecfb03112
[libgcrypt.git] / cipher / scrypt.h
1 /* scrypt.h - Scrypt password-based key derivation function.
2  *
3  * This file is part of Libgcrypt.
4  */
5
6 /* Adapted from the nettle, low-level cryptographics library for
7  * libgcrypt by Christian Grothoff; original license:
8  *
9  * Copyright (C) 2012 Simon Josefsson
10  *
11  * The nettle library is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License as published by
13  * the Free Software Foundation; either version 2.1 of the License, or (at your
14  * option) any later version.
15  *
16  * The nettle library is distributed in the hope that it will be useful, but
17  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
18  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
19  * License for more details.
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * along with the nettle library; see the file COPYING.LIB.  If not, write to
23  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
24  * MA 02111-1301, USA.
25  */
26
27 #ifndef SCRYPT_H_INCLUDED
28 #define SCRYPT_H_INCLUDED
29
30 #ifdef __cplusplus
31 extern "C"
32 {
33 #endif
34
35 #include <stdint.h>
36 #include "g10lib.h"
37 #include "cipher.h"
38
39
40 /* Transform a passphrase into a suitable key of length KEYSIZE and
41    store this key in the caller provided buffer KEYBUFFER.  The caller
42    must provide PRFALGO which indicates the pseudorandom function to
43    use: This shall be the algorithms id of a hash algorithm; it is
44    used in HMAC mode.  SALT is a salt of length SALTLEN and ITERATIONS
45    gives the number of iterations; implemented in 'kdf.c', used by
46    scrypt.c */
47 gpg_err_code_t
48 pkdf2 (const void *passphrase, size_t passphraselen,
49        int hashalgo,
50        const void *salt, size_t saltlen,
51        unsigned long iterations,
52        size_t keysize, void *keybuffer);
53
54
55 gcry_err_code_t
56 scrypt (const uint8_t * passwd, size_t passwdlen,
57         int subalgo,
58         const uint8_t * salt, size_t saltlen,
59         unsigned long iterations,
60         size_t dkLen, uint8_t * DK);
61
62 #ifdef __cplusplus
63 }
64 #endif
65
66 #endif /* SCRYPT_H_INCLUDED */