| 1 | =pod
|
|---|
| 2 |
|
|---|
| 3 | =head1 NAME
|
|---|
| 4 |
|
|---|
| 5 | EVP_MAC-Siphash - The Siphash EVP_MAC implementation
|
|---|
| 6 |
|
|---|
| 7 | =head1 DESCRIPTION
|
|---|
| 8 |
|
|---|
| 9 | Support for computing Siphash 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 "SIPHASH", "provider=default"
|
|---|
| 19 |
|
|---|
| 20 | =back
|
|---|
| 21 |
|
|---|
| 22 |
|
|---|
| 23 | =head2 Supported parameters
|
|---|
| 24 |
|
|---|
| 25 | The general description of these parameters can be found in
|
|---|
| 26 | L<EVP_MAC(3)/PARAMETERS>.
|
|---|
| 27 |
|
|---|
| 28 | All these parameters can be set with EVP_MAC_CTX_set_params().
|
|---|
| 29 | Furthermore, the "size" parameter can be retrieved with
|
|---|
| 30 | EVP_MAC_CTX_get_params(), or with EVP_MAC_CTX_get_mac_size().
|
|---|
| 31 | The length of the "size" parameter should not exceed that of a B<size_t>.
|
|---|
| 32 |
|
|---|
| 33 | =over 4
|
|---|
| 34 |
|
|---|
| 35 | =item "key" (B<OSSL_MAC_PARAM_KEY>) <octet string>
|
|---|
| 36 |
|
|---|
| 37 | Sets the MAC key.
|
|---|
| 38 | Setting this parameter is identical to passing a I<key> to L<EVP_MAC_init(3)>.
|
|---|
| 39 |
|
|---|
| 40 | =item "size" (B<OSSL_MAC_PARAM_SIZE>) <unsigned integer>
|
|---|
| 41 |
|
|---|
| 42 | Sets the MAC size.
|
|---|
| 43 |
|
|---|
| 44 | =item "c-rounds" (B<OSSL_MAC_PARAM_C_ROUNDS>) <unsigned integer>
|
|---|
| 45 |
|
|---|
| 46 | Specifies the number of rounds per message block. By default this is I<2>.
|
|---|
| 47 |
|
|---|
| 48 | =item "d-rounds" (B<OSSL_MAC_PARAM_D_ROUNDS>) <unsigned integer>
|
|---|
| 49 |
|
|---|
| 50 | Specifies the number of finalisation rounds. By default this is I<4>.
|
|---|
| 51 |
|
|---|
| 52 | =back
|
|---|
| 53 |
|
|---|
| 54 | =head1 SEE ALSO
|
|---|
| 55 |
|
|---|
| 56 | L<EVP_MAC_CTX_get_params(3)>, L<EVP_MAC_CTX_set_params(3)>,
|
|---|
| 57 | L<EVP_MAC(3)/PARAMETERS>, L<OSSL_PARAM(3)>
|
|---|
| 58 |
|
|---|
| 59 | =head1 COPYRIGHT
|
|---|
| 60 |
|
|---|
| 61 | Copyright 2018-2021 The OpenSSL Project Authors. All Rights Reserved.
|
|---|
| 62 |
|
|---|
| 63 | Licensed under the Apache License 2.0 (the "License"). You may not use
|
|---|
| 64 | this file except in compliance with the License. You can obtain a copy
|
|---|
| 65 | in the file LICENSE in the source distribution or at
|
|---|
| 66 | L<https://www.openssl.org/source/license.html>.
|
|---|
| 67 |
|
|---|
| 68 | =cut
|
|---|
