Debian Codegraph @

upstream/debian-unstable/man7/EVP_MD-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_MD-BLAKE2 7SSL"
58 .TH EVP_MD-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_MD\-BLAKE2 \- The BLAKE2 EVP_MD implementation
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 Support for computing BLAKE2 digests through the \fBEVP_MD\fR API.
68 .SS Identities
69 .IX Subsection "Identities"
70 This implementation is only available with the default provider, and
71 includes the following varieties:
72 .IP BLAKE2S\-256 4
73 .IX Item "BLAKE2S-256"
74 Known names are "BLAKE2S\-256" and "BLAKE2s256".
75 .IP BLAKE2B\-512 4
76 .IX Item "BLAKE2B-512"
77 Known names are "BLAKE2B\-512" and "BLAKE2b512".
78 .SS "Settable Parameters"
79 .IX Subsection "Settable Parameters"
80 "BLAKE2B\-512" supports the following \fBEVP_MD_CTX_set_params()\fR key
81 described in "PARAMETERS" in \fBEVP_DigestInit\fR\|(3).
82 .IP """size"" (\fBOSSL_DIGEST_PARAM_SIZE\fR) <unsigned integer>" 4
83 .IX Item """size"" (OSSL_DIGEST_PARAM_SIZE) <unsigned integer>"
84 .SS "Gettable Parameters"
85 .IX Subsection "Gettable Parameters"
86 This implementation supports the common gettable parameters described
87 in \fBEVP_MD\-common\fR\|(7).
88 .SS "Settable Context Parameters"
89 .IX Subsection "Settable Context Parameters"
90 The implementation supports the following \fBOSSL_PARAM\fR\|(3) entries which
91 are settable for an \fBEVP_MD_CTX\fR with \fBEVP_DigestInit_ex2\fR\|(3) or
92 \&\fBEVP_MD_CTX_set_params\fR\|(3):
93 .IP """size"" (\fBOSSL_DIGEST_PARAM_SIZE\fR) <unsigned integer>" 4
94 .IX Item """size"" (OSSL_DIGEST_PARAM_SIZE) <unsigned integer>"
95 Sets a different digest length for the \fBEVP_DigestFinal\fR\|(3) output.
96 The value of the "size" parameter must not exceed the default digest length
97 of the respective BLAKE2 algorithm variants, 64 for BLAKE2B\-512 and
98 32 for BLAKE2S\-256. The parameter must be set with the
99 \&\fBEVP_DigestInit_ex2\fR\|(3) call to have an immediate effect. When set with
100 \&\fBEVP_MD_CTX_set_params\fR\|(3) it will have an effect only if the \fBEVP_MD_CTX\fR
101 context is reinitialized.
102 .SH "SEE ALSO"
103 .IX Header "SEE ALSO"
104 \&\fBprovider\-digest\fR\|(7), \fBOSSL_PROVIDER\-default\fR\|(7)
105 .SH HISTORY
106 .IX Header "HISTORY"
107 This functionality was added in OpenSSL 3.0.
108 .PP
109 The variable size support was added in OpenSSL 3.2 for BLAKE2B\-512 and
110 in OpenSSL 3.3 for BLAKE2S\-256.
111 .SH COPYRIGHT
112 .IX Header "COPYRIGHT"
113 Copyright 2020\-2024 The OpenSSL Project Authors. All Rights Reserved.
114 .PP
115 Licensed under the Apache License 2.0 (the "License"). You may not use
116 this file except in compliance with the License. You can obtain a copy
117 in the file LICENSE in the source distribution or at
118 <https://www.openssl.org/source/license.html>.