Debian Codegraph @

upstream/debian-unstable/man3/EVP_sha3_224.3ssl

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_SHA3_224 3SSL"
58 .TH EVP_SHA3_224 3SSL 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_sha3_224,
65 EVP_sha3_256,
66 EVP_sha3_384,
67 EVP_sha3_512,
68 EVP_shake128,
69 EVP_shake256
70 \&\- SHA\-3 For EVP
71 .SH SYNOPSIS
72 .IX Header "SYNOPSIS"
73 .Vb 1
74 \& #include <openssl/evp.h>
75 \&
76 \& const EVP_MD *EVP_sha3_224(void);
77 \& const EVP_MD *EVP_sha3_256(void);
78 \& const EVP_MD *EVP_sha3_384(void);
79 \& const EVP_MD *EVP_sha3_512(void);
80 \&
81 \& const EVP_MD *EVP_shake128(void);
82 \& const EVP_MD *EVP_shake256(void);
83 .Ve
84 .SH DESCRIPTION
85 .IX Header "DESCRIPTION"
86 SHA\-3 (Secure Hash Algorithm 3) is a family of cryptographic hash functions
87 standardized in NIST FIPS 202, first published in 2015. It is based on the
88 Keccak algorithm.
89 .IP "\fBEVP_sha3_224()\fR, \fBEVP_sha3_256()\fR, \fBEVP_sha3_384()\fR, \fBEVP_sha3_512()\fR" 4
90 .IX Item "EVP_sha3_224(), EVP_sha3_256(), EVP_sha3_384(), EVP_sha3_512()"
91 The SHA\-3 SHA\-3\-224, SHA\-3\-256, SHA\-3\-384, and SHA\-3\-512 algorithms
92 respectively. They produce 224, 256, 384 and 512 bits of output from a given
93 input.
94 .IP "\fBEVP_shake128()\fR, \fBEVP_shake256()\fR" 4
95 .IX Item "EVP_shake128(), EVP_shake256()"
96 The SHAKE\-128 and SHAKE\-256 Extendable Output Functions (XOF) that can generate
97 a variable hash length.
98 .Sp
99 Specifically, \fBEVP_shake128\fR provides an overall security of 128 bits, while
100 \&\fBEVP_shake256\fR provides that of 256 bits.
101 .SH NOTES
102 .IX Header "NOTES"
103 Developers should be aware of the negative performance implications of
104 calling these functions multiple times and should consider using
105 \&\fBEVP_MD_fetch\fR\|(3) with \fBEVP_MD\-SHA3\fR\|(7) or \fBEVP_MD\-SHAKE\fR\|(7) instead.
106 See "Performance" in \fBcrypto\fR\|(7) for further information.
107 .SH "RETURN VALUES"
108 .IX Header "RETURN VALUES"
109 These functions return a \fBEVP_MD\fR structure that contains the
110 implementation of the message digest. See \fBEVP_MD_meth_new\fR\|(3) for
111 details of the \fBEVP_MD\fR structure.
112 .SH "CONFORMING TO"
113 .IX Header "CONFORMING TO"
114 NIST FIPS 202.
115 .SH "SEE ALSO"
116 .IX Header "SEE ALSO"
117 \&\fBevp\fR\|(7),
118 \&\fBEVP_DigestInit\fR\|(3)
119 .SH COPYRIGHT
120 .IX Header "COPYRIGHT"
121 Copyright 2017\-2023 The OpenSSL Project Authors. All Rights Reserved.
122 .PP
123 Licensed under the Apache License 2.0 (the "License"). You may not use
124 this file except in compliance with the License. You can obtain a copy
125 in the file LICENSE in the source distribution or at
126 <https://www.openssl.org/source/license.html>.