Debian Codegraph @

upstream/debian-unstable/man7/EVP_MAC-BLAKE2.7ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "EVP_MAC-BLAKE2 7SSL"
58 .TH EVP_MAC-BLAKE2 7SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 EVP_MAC\-BLAKE2, EVP_MAC\-BLAKE2BMAC, EVP_MAC\-BLAKE2SMAC
65 \&\- The BLAKE2 EVP_MAC implementations
66 .SH DESCRIPTION
67 .IX Header "DESCRIPTION"
68 Support for computing BLAKE2 MACs through the \fBEVP_MAC\fR API.
69 .SS Identity
70 .IX Subsection "Identity"
71 These implementations are identified with one of these names and
72 properties, to be used with \fBEVP_MAC_fetch()\fR:
73 .IP """BLAKE2BMAC"", ""provider=default""" 4
74 .IX Item """BLAKE2BMAC"", ""provider=default"""
75 .PD 0
76 .IP """BLAKE2SMAC"", ""provider=default""" 4
77 .IX Item """BLAKE2SMAC"", ""provider=default"""
78 .PD
79 .SS "Supported parameters"
80 .IX Subsection "Supported parameters"
81 The general description of these parameters can be found in
82 "PARAMETERS" in \fBEVP_MAC\fR\|(3).
83 .PP
84 All these parameters (except for "block-size") can be set with
85 \&\fBEVP_MAC_CTX_set_params()\fR.
86 Furthermore, the "size" parameter can be retrieved with
87 \&\fBEVP_MAC_CTX_get_params()\fR, or with \fBEVP_MAC_CTX_get_mac_size()\fR.
88 The length of the "size" parameter should not exceed that of a \fBsize_t\fR.
89 Likewise, the "block-size" parameter can be retrieved with
90 \&\fBEVP_MAC_CTX_get_params()\fR, or with \fBEVP_MAC_CTX_get_block_size()\fR.
91 .IP """key"" (\fBOSSL_MAC_PARAM_KEY\fR) <octet string>" 4
92 .IX Item """key"" (OSSL_MAC_PARAM_KEY) <octet string>"
93 Sets the MAC key.
94 It may be at most 64 bytes for BLAKE2BMAC or 32 for BLAKE2SMAC and at
95 least 1 byte in both cases.
96 Setting this parameter is identical to passing a \fIkey\fR to \fBEVP_MAC_init\fR\|(3).
97 .IP """custom"" (\fBOSSL_MAC_PARAM_CUSTOM\fR) <octet string>" 4
98 .IX Item """custom"" (OSSL_MAC_PARAM_CUSTOM) <octet string>"
99 Sets the customization/personalization string.
100 It is an optional value of at most 16 bytes for BLAKE2BMAC or 8 for
101 BLAKE2SMAC, and is empty by default.
102 .IP """salt"" (\fBOSSL_MAC_PARAM_SALT\fR) <octet string>" 4
103 .IX Item """salt"" (OSSL_MAC_PARAM_SALT) <octet string>"
104 Sets the salt.
105 It is an optional value of at most 16 bytes for BLAKE2BMAC or 8 for
106 BLAKE2SMAC, and is empty by default.
107 .IP """size"" (\fBOSSL_MAC_PARAM_SIZE\fR) <unsigned integer>" 4
108 .IX Item """size"" (OSSL_MAC_PARAM_SIZE) <unsigned integer>"
109 Sets the MAC size.
110 It can be any number between 1 and 32 for EVP_MAC_BLAKE2S or between 1
111 and 64 for EVP_MAC_BLAKE2B.
112 It is 32 and 64 respectively by default.
113 .IP """block-size"" (\fBOSSL_MAC_PARAM_BLOCK_SIZE\fR) <unsigned integer>" 4
114 .IX Item """block-size"" (OSSL_MAC_PARAM_BLOCK_SIZE) <unsigned integer>"
115 Gets the MAC block size.
116 It is 64 for EVP_MAC_BLAKE2S and 128 for EVP_MAC_BLAKE2B.
117 .SH "SEE ALSO"
118 .IX Header "SEE ALSO"
119 \&\fBEVP_MAC_CTX_get_params\fR\|(3), \fBEVP_MAC_CTX_set_params\fR\|(3),
120 "PARAMETERS" in \fBEVP_MAC\fR\|(3), \fBOSSL_PARAM\fR\|(3)
121 .SH HISTORY
122 .IX Header "HISTORY"
123 The macros and functions described here were added to OpenSSL 3.0.
124 .SH COPYRIGHT
125 .IX Header "COPYRIGHT"
126 Copyright 2018\-2021 The OpenSSL Project Authors. All Rights Reserved.
127 .PP
128 Licensed under the Apache License 2.0 (the "License"). You may not use
129 this file except in compliance with the License. You can obtain a copy
130 in the file LICENSE in the source distribution or at
131 <https://www.openssl.org/source/license.html>.