doc/man7/EVP_KDF_SCRYPT.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 EVP_KDF_SCRYPT - The scrypt EVP_KDF implementation
   6
   7 =head1 DESCRIPTION
   8
   9 Support for computing the B<scrypt> password-based KDF through the B<EVP_KDF>
  10 API.
  11
  12 The EVP_KDF_SCRYPT algorithm implements the scrypt password-based key
  13 derivation function, as described in RFC 7914.  It is memory-hard in the sense
  14 that it deliberately requires a significant amount of RAM for efficient
  15 computation. The intention of this is to render brute forcing of passwords on
  16 systems that lack large amounts of main memory (such as GPUs or ASICs)
  17 computationally infeasible.
  18
  19 scrypt provides three work factors that can be customized: N, r and p. N, which
  20 has to be a positive power of two, is the general work factor and scales CPU
  21 time in an approximately linear fashion. r is the block size of the internally
  22 used hash function and p is the parallelization factor. Both r and p need to be
  23 greater than zero. The amount of RAM that scrypt requires for its computation
  24 is roughly (128 * N * r * p) bytes.
  25
  26 In the original paper of Colin Percival ("Stronger Key Derivation via
  27 Sequential Memory-Hard Functions", 2009), the suggested values that give a
  28 computation time of less than 5 seconds on a 2.5 GHz Intel Core 2 Duo are N =
  29 2^20 = 1048576, r = 8, p = 1. Consequently, the required amount of memory for
  30 this computation is roughly 1 GiB. On a more recent CPU (Intel i7-5930K at 3.5
  31 GHz), this computation takes about 3 seconds. When N, r or p are not specified,
  32 they default to 1048576, 8, and 1, respectively. The maximum amount of RAM that
  33 may be used by scrypt defaults to 1025 MiB.
  34
  35 =head2 Numeric identity
  36
  37 B<EVP_KDF_SCRYPT> is the numeric identity for this implementation; it
  38 can be used with the EVP_KDF_CTX_new_id() function.
  39
  40 =head2 Supported controls
  41
  42 The supported controls are:
  43
  44 =over 4
  45
  46 =item B<EVP_KDF_CTRL_SET_PASS>
  47
  48 =item B<EVP_KDF_CTRL_SET_SALT>
  49
  50 These controls work as described in L<EVP_KDF_CTX(3)/CONTROLS>.
  51
  52 =item B<EVP_KDF_CTRL_SET_SCRYPT_N>
  53
  54 =item B<EVP_KDF_CTRL_SET_SCRYPT_R>
  55
  56 =item B<EVP_KDF_CTRL_SET_SCRYPT_P>
  57
  58 B<EVP_KDF_CTRL_SET_SCRYPT_N> expects one argument: C<uint64_t N>
  59
  60 B<EVP_KDF_CTRL_SET_SCRYPT_R> expects one argument: C<uint32_t r>
  61
  62 B<EVP_KDF_CTRL_SET_SCRYPT_P> expects one argument: C<uint32_t p>
  63
  64 These controls configure the scrypt work factors N, r and p.
  65
  66 EVP_KDF_ctrl_str() type strings: "N", "r" and "p", respectively.
  67
  68 The corresponding value strings are expected to be decimal numbers.
  69
  70 =back
  71
  72 =head1 NOTES
  73
  74 A context for scrypt can be obtained by calling:
  75
  76  EVP_KDF_CTX *kctx = EVP_KDF_CTX_new_id(EVP_KDF_SCRYPT);
  77
  78 The output length of an scrypt key derivation is specified via the
  79 B<keylen> parameter to the L<EVP_KDF_derive(3)> function.
  80
  81 =head1 EXAMPLE
  82
  83 This example derives a 64-byte long test vector using scrypt with the password
  84 "password", salt "NaCl" and N = 1024, r = 8, p = 16.
  85
  86  EVP_KDF_CTX *kctx;
  87  unsigned char out[64];
  88
  89  kctx = EVP_KDF_CTX_new_id(EVP_KDF_SCRYPT);
  90
  91  if (EVP_KDF_ctrl(kctx, EVP_KDF_CTRL_SET_PASS, "password", (size_t)8) <= 0) {
  92      error("EVP_KDF_CTRL_SET_PASS");
  93  }
  94  if (EVP_KDF_ctrl(kctx, EVP_KDF_CTRL_SET_SALT, "NaCl", (size_t)4) <= 0) {
  95      error("EVP_KDF_CTRL_SET_SALT");
  96  }
  97  if (EVP_KDF_ctrl(kctx, EVP_KDF_CTRL_SET_SCRYPT_N, (uint64_t)1024) <= 0) {
  98      error("EVP_KDF_CTRL_SET_SCRYPT_N");
  99  }
 100  if (EVP_KDF_ctrl(kctx, EVP_KDF_CTRL_SET_SCRYPT_R, (uint32_t)8) <= 0) {
 101      error("EVP_KDF_CTRL_SET_SCRYPT_R");
 102  }
 103  if (EVP_KDF_ctrl(kctx, EVP_KDF_CTRL_SET_SCRYPT_P, (uint32_t)16) <= 0) {
 104      error("EVP_KDF_CTRL_SET_SCRYPT_P");
 105  }
 106  if (EVP_KDF_derive(kctx, out, sizeof(out)) <= 0) {
 107      error("EVP_KDF_derive");
 108  }
 109
 110  {
 111      const unsigned char expected[sizeof(out)] = {
 112          0xfd, 0xba, 0xbe, 0x1c, 0x9d, 0x34, 0x72, 0x00,
 113          0x78, 0x56, 0xe7, 0x19, 0x0d, 0x01, 0xe9, 0xfe,
 114          0x7c, 0x6a, 0xd7, 0xcb, 0xc8, 0x23, 0x78, 0x30,
 115          0xe7, 0x73, 0x76, 0x63, 0x4b, 0x37, 0x31, 0x62,
 116          0x2e, 0xaf, 0x30, 0xd9, 0x2e, 0x22, 0xa3, 0x88,
 117          0x6f, 0xf1, 0x09, 0x27, 0x9d, 0x98, 0x30, 0xda,
 118          0xc7, 0x27, 0xaf, 0xb9, 0x4a, 0x83, 0xee, 0x6d,
 119          0x83, 0x60, 0xcb, 0xdf, 0xa2, 0xcc, 0x06, 0x40
 120      };
 121
 122      assert(!memcmp(out, expected, sizeof(out)));
 123  }
 124
 125  EVP_KDF_CTX_free(kctx);
 126
 127 =head1 CONFORMING TO
 128
 129 RFC 7914
 130
 131 =head1 SEE ALSO
 132
 133 L<EVP_KDF_CTX>,
 134 L<EVP_KDF_CTX_new_id(3)>,
 135 L<EVP_KDF_CTX_free(3)>,
 136 L<EVP_KDF_ctrl(3)>,
 137 L<EVP_KDF_derive(3)>,
 138 L<EVP_KDF_CTX(3)/CONTROLS>
 139
 140 =head1 COPYRIGHT
 141
 142 Copyright 2017-2018 The OpenSSL Project Authors. All Rights Reserved.
 143
 144 Licensed under the Apache License 2.0 (the "License").  You may not use
 145 this file except in compliance with the License.  You can obtain a copy
 146 in the file LICENSE in the source distribution or at
 147 L<https://www.openssl.org/source/license.html>.
 148
 149 =cut