doc/man7/EVP_MAC-Poly1305.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 EVP_MAC-Poly1305 - The Poly1305 EVP_MAC implementation
   6
   7 =head1 DESCRIPTION
   8
   9 Support for computing Poly1305 MACs through the B<EVP_MAC> API.
  10
  11 =head2 Identity
  12
  13 This implementation is identified with this name and properties, to be
  14 used with EVP_MAC_fetch():
  15
  16 =over 4
  17
  18 =item "POLY1305", "provider=default"
  19
  20 =back
  21
  22 =head2 Supported parameters
  23
  24 The general description of these parameters can be found in
  25 L<EVP_MAC(3)/PARAMETERS>.
  26
  27 The following parameter can be set with EVP_MAC_CTX_set_params():
  28
  29 =over 4
  30
  31 =item "key" (B<OSSL_MAC_PARAM_KEY>) <octet string>
  32
  33 Sets the MAC key.
  34 Setting this parameter is identical to passing a I<key> to L<EVP_MAC_init(3)>.
  35
  36 =back
  37
  38 The following parameters can be retrieved with
  39 EVP_MAC_CTX_get_params():
  40
  41 =over 4
  42
  43 =item "size" (B<OSSL_MAC_PARAM_SIZE>) <unsigned integer>
  44
  45 Gets the MAC size.
  46
  47 =back
  48
  49 The "size" parameter can also be retrieved with with EVP_MAC_CTX_get_mac_size().
  50 The length of the "size" parameter should not exceed that of an B<unsigned int>.
  51
  52 =head1 SEE ALSO
  53
  54 L<EVP_MAC_CTX_get_params(3)>, L<EVP_MAC_CTX_set_params(3)>,
  55 L<EVP_MAC(3)/PARAMETERS>, L<OSSL_PARAM(3)>
  56
  57 =head1 COPYRIGHT
  58
  59 Copyright 2018-2021 The OpenSSL Project Authors. All Rights Reserved.
  60
  61 Licensed under the Apache License 2.0 (the "License").  You may not use
  62 this file except in compliance with the License.  You can obtain a copy
  63 in the file LICENSE in the source distribution or at
  64 L<https://www.openssl.org/source/license.html>.
  65
  66 =cut