EVP_MAC-CMAC.pod 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. =pod
  2. =head1 NAME
  3. EVP_MAC-CMAC - The CMAC EVP_MAC implementation
  4. =head1 DESCRIPTION
  5. Support for computing CMAC 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 "CMAC", "default=yes"
  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. =item "cipher" (B<OSSL_MAC_PARAM_CIPHER>) <UTF8 string>
  19. =item "properties" (B<OSSL_MAC_PARAM_PROPERTIES>) <UTF8 string>
  20. =back
  21. The following parameters can be retrieved with
  22. EVP_MAC_CTX_get_params():
  23. =over 4
  24. =item "size" (B<OSSL_MAC_PARAM_SIZE>) <unsigned integer>
  25. =back
  26. The "size" parameter can also be retrieved with with EVP_MAC_size().
  27. The length of the "size" parameter is equal to that of an B<unsigned int>.
  28. =head1 SEE ALSO
  29. L<EVP_MAC_CTX_get_params(3)>, L<EVP_MAC_CTX_set_params(3)>,
  30. L<EVP_MAC(3)/PARAMETERS>, L<OSSL_PARAM(3)>
  31. =head1 COPYRIGHT
  32. Copyright 2018-2019 The OpenSSL Project Authors. All Rights Reserved.
  33. Licensed under the Apache License 2.0 (the "License"). You may not use
  34. this file except in compliance with the License. You can obtain a copy
  35. in the file LICENSE in the source distribution or at
  36. L<https://www.openssl.org/source/license.html>.
  37. =cut