EVP_MAC-Poly1305.pod 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. =pod
  2. =head1 NAME
  3. EVP_MAC-Poly1305 - The Poly1305 EVP_MAC implementation
  4. =head1 DESCRIPTION
  5. Support for computing Poly1305 MACs through the B<EVP_MAC> API.
  6. =head2 Identity
  7. This implementation is identified with this name and properties, to be
  8. used with EVP_MAC_fetch():
  9. =over 4
  10. =item "POLY1305", "provider=default"
  11. =back
  12. =head2 Supported parameters
  13. The general description of these parameters can be found in
  14. L<EVP_MAC(3)/PARAMETERS>.
  15. The following parameter can be set with EVP_MAC_CTX_set_params():
  16. =over 4
  17. =item "key" (B<OSSL_MAC_PARAM_KEY>) <octet string>
  18. =back
  19. The following parameters can be retrieved with
  20. EVP_MAC_CTX_get_params():
  21. =over 4
  22. =item "size" (B<OSSL_MAC_PARAM_SIZE>) <unsigned integer>
  23. =back
  24. The "size" parameter can also be retrieved with with EVP_MAC_CTX_get_mac_size().
  25. The length of the "size" parameter should not exceed that of an B<unsigned int>.
  26. =head1 SEE ALSO
  27. L<EVP_MAC_CTX_get_params(3)>, L<EVP_MAC_CTX_set_params(3)>,
  28. L<EVP_MAC(3)/PARAMETERS>, L<OSSL_PARAM(3)>
  29. =head1 COPYRIGHT
  30. Copyright 2018-2020 The OpenSSL Project Authors. All Rights Reserved.
  31. Licensed under the Apache License 2.0 (the "License"). You may not use
  32. this file except in compliance with the License. You can obtain a copy
  33. in the file LICENSE in the source distribution or at
  34. L<https://www.openssl.org/source/license.html>.
  35. =cut