doc/man7/EVP_MAC-BLAKE2.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 EVP_MAC-BLAKE2, EVP_MAC-BLAKE2BMAC, EVP_MAC-BLAKE2SMAC
   6 - The BLAKE2 EVP_MAC implementations
   7
   8 =head1 DESCRIPTION
   9
  10 Support for computing BLAKE2 MACs through the B<EVP_MAC> API.
  11
  12 =head2 Identity
  13
  14 These implementations are identified with one of these names and
  15 properties, to be used with EVP_MAC_fetch():
  16
  17 =over 4
  18
  19 =item "BLAKE2BMAC", "provider=default"
  20
  21 =item "BLAKE2SMAC", "provider=default"
  22
  23 =back
  24
  25 =head2 Supported parameters
  26
  27 The general description of these parameters can be found in
  28 L<EVP_MAC(3)/PARAMETERS>.
  29
  30 All these parameters can be set with EVP_MAC_CTX_set_params().
  31 Furthermore, the "size" parameter can be retrieved with
  32 EVP_MAC_CTX_get_params(), or with EVP_MAC_CTX_get_mac_size().
  33 The length of the "size" parameter should not exceed that of a B<size_t>.
  34
  35 =over 4
  36
  37 =item "key" (B<OSSL_MAC_PARAM_KEY>) <octet string>
  38
  39 Sets the MAC key.
  40 It may be at most 64 bytes for BLAKE2BMAC or 32 for BLAKE2SMAC and at
  41 least 1 byte in both cases.
  42 Setting this parameter is identical to passing a I<key> to L<EVP_MAC_init(3)>.
  43
  44 =item "custom" (B<OSSL_MAC_PARAM_CUSTOM>) <octet string>
  45
  46 Sets the custom value.
  47 It is an optional value of at most 16 bytes for BLAKE2BMAC or 8 for
  48 BLAKE2SMAC, and is empty by default.
  49
  50 =item "salt" (B<OSSL_MAC_PARAM_SALT>) <octet string>
  51
  52 Sets the salt.
  53 It is an optional value of at most 16 bytes for BLAKE2BMAC or 8 for
  54 BLAKE2SMAC, and is empty by default.
  55
  56 =item "size" (B<OSSL_MAC_PARAM_SIZE>) <unsigned integer>
  57
  58 Sets the MAC size.
  59 It can be any number between 1 and 32 for EVP_MAC_BLAKE2S or between 1
  60 and 64 for EVP_MAC_BLAKE2B.
  61 It is 32 and 64 respectively by default.
  62
  63 =back
  64
  65 =head1 SEE ALSO
  66
  67 L<EVP_MAC_CTX_get_params(3)>, L<EVP_MAC_CTX_set_params(3)>,
  68 L<EVP_MAC(3)/PARAMETERS>, L<OSSL_PARAM(3)>
  69
  70 =head1 HISTORY
  71
  72 The macros and functions described here were added to OpenSSL 3.0.
  73
  74 =head1 COPYRIGHT
  75
  76 Copyright 2018-2020 The OpenSSL Project Authors. All Rights Reserved.
  77
  78 Licensed under the Apache License 2.0 (the "License").  You may not use
  79 this file except in compliance with the License.  You can obtain a copy
  80 in the file LICENSE in the source distribution or at
  81 L<https://www.openssl.org/source/license.html>.
  82
  83 =cut