doc/man3/EVP_PKEY_CTX_set_scrypt_N.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 EVP_PKEY_CTX_set1_scrypt_salt,
   6 EVP_PKEY_CTX_set_scrypt_N,
   7 EVP_PKEY_CTX_set_scrypt_r,
   8 EVP_PKEY_CTX_set_scrypt_p,
   9 EVP_PKEY_CTX_set_scrypt_maxmem_bytes
  10 - EVP_PKEY scrypt KDF support functions
  11
  12 =head1 SYNOPSIS
  13
  14  #include <openssl/kdf.h>
  15
  16  int EVP_PKEY_CTX_set1_scrypt_salt(EVP_PKEY_CTX *pctx, unsigned char *salt,
  17                                    int saltlen);
  18
  19  int EVP_PKEY_CTX_set_scrypt_N(EVP_PKEY_CTX *pctx, uint64_t N);
  20
  21  int EVP_PKEY_CTX_set_scrypt_r(EVP_PKEY_CTX *pctx, uint64_t r);
  22
  23  int EVP_PKEY_CTX_set_scrypt_p(EVP_PKEY_CTX *pctx, uint64_t p);
  24
  25  int EVP_PKEY_CTX_set_scrypt_maxmem_bytes(EVP_PKEY_CTX *pctx,
  26                                           uint64_t maxmem);
  27
  28 =head1 DESCRIPTION
  29
  30 These functions are used to set up the necessary data to use the
  31 scrypt KDF.
  32 For more information on scrypt, see L<scrypt(7)>.
  33
  34 EVP_PKEY_CTX_set1_scrypt_salt() sets the B<saltlen> bytes long salt
  35 value.
  36
  37 EVP_PKEY_CTX_set_scrypt_N(), EVP_PKEY_CTX_set_scrypt_r() and
  38 EVP_PKEY_CTX_set_scrypt_p() configure the work factors N, r and p.
  39
  40 EVP_PKEY_CTX_set_scrypt_maxmem_bytes() sets how much RAM key
  41 derivation may maximally use, given in bytes.
  42 If RAM is exceeded because the load factors are chosen too high, the
  43 key derivation will fail.
  44
  45 =head1 STRING CTRLS
  46
  47 scrypt also supports string based control operations via
  48 L<EVP_PKEY_CTX_ctrl_str(3)>.
  49 Similarly, the B<salt> can either be specified using the B<type>
  50 parameter "salt" or in hex encoding by using the "hexsalt" parameter.
  51 The work factors B<N>, B<r> and B<p> as well as B<maxmem_bytes> can be
  52 set by using the parameters "N", "r", "p" and "maxmem_bytes",
  53 respectively.
  54
  55 =head1 NOTES
  56
  57 The scrypt KDF also uses EVP_PKEY_CTX_set1_pbe_pass() as well as
  58 the value from the string controls "pass" and "hexpass".
  59 See L<EVP_PKEY_CTX_set1_pbe_pass(3)>.
  60
  61 All the functions described here are implemented as macros.
  62
  63 =head1 RETURN VALUES
  64
  65 All these functions return 1 for success and 0 or a negative value for
  66 failure.
  67 In particular a return value of -2 indicates the operation is not
  68 supported by the public key algorithm.
  69
  70 =head1 SEE ALSO
  71
  72 L<scrypt(7)>,
  73 L<EVP_PKEY_CTX_new(3)>,
  74 L<EVP_PKEY_CTX_ctrl_str(3)>,
  75 L<EVP_PKEY_derive(3)>
  76
  77 =head1 COPYRIGHT
  78
  79 Copyright 2017-2018 The OpenSSL Project Authors. All Rights Reserved.
  80
  81 Licensed under the Apache License 2.0 (the "License").  You may not use
  82 this file except in compliance with the License.  You can obtain a copy
  83 in the file LICENSE in the source distribution or at
  84 L<https://www.openssl.org/source/license.html>.
  85
  86 =cut