Debian Codegraph @

upstream/debian-unstable/man7/EVP_MAC-Siphash.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-SIPHASH 7SSL"
58 .TH EVP_MAC-SIPHASH 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\-Siphash \- The Siphash EVP_MAC implementation
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 Support for computing Siphash MACs through the \fBEVP_MAC\fR API.
68 .SS Identity
69 .IX Subsection "Identity"
70 This implementation is identified with this name and properties, to be
71 used with \fBEVP_MAC_fetch()\fR:
72 .IP """SIPHASH"", ""provider=default""" 4
73 .IX Item """SIPHASH"", ""provider=default"""
74 .SS "Supported parameters"
75 .IX Subsection "Supported parameters"
76 The general description of these parameters can be found in
77 "PARAMETERS" in \fBEVP_MAC\fR\|(3).
78 .PP
79 All these parameters can be set with \fBEVP_MAC_CTX_set_params()\fR.
80 Furthermore, the "size" parameter can be retrieved with
81 \&\fBEVP_MAC_CTX_get_params()\fR, or with \fBEVP_MAC_CTX_get_mac_size()\fR.
82 The length of the "size" parameter should not exceed that of a \fBsize_t\fR.
83 .IP """key"" (\fBOSSL_MAC_PARAM_KEY\fR) <octet string>" 4
84 .IX Item """key"" (OSSL_MAC_PARAM_KEY) <octet string>"
85 Sets the MAC key.
86 Setting this parameter is identical to passing a \fIkey\fR to \fBEVP_MAC_init\fR\|(3).
87 .IP """size"" (\fBOSSL_MAC_PARAM_SIZE\fR) <unsigned integer>" 4
88 .IX Item """size"" (OSSL_MAC_PARAM_SIZE) <unsigned integer>"
89 Sets the MAC size.
90 .IP """c\-rounds"" (\fBOSSL_MAC_PARAM_C_ROUNDS\fR) <unsigned integer>" 4
91 .IX Item """c-rounds"" (OSSL_MAC_PARAM_C_ROUNDS) <unsigned integer>"
92 Specifies the number of rounds per message block. By default this is \fI2\fR.
93 .IP """d\-rounds"" (\fBOSSL_MAC_PARAM_D_ROUNDS\fR) <unsigned integer>" 4
94 .IX Item """d-rounds"" (OSSL_MAC_PARAM_D_ROUNDS) <unsigned integer>"
95 Specifies the number of finalisation rounds. By default this is \fI4\fR.
96 .SH "SEE ALSO"
97 .IX Header "SEE ALSO"
98 \&\fBEVP_MAC_CTX_get_params\fR\|(3), \fBEVP_MAC_CTX_set_params\fR\|(3),
99 "PARAMETERS" in \fBEVP_MAC\fR\|(3), \fBOSSL_PARAM\fR\|(3)
100 .SH COPYRIGHT
101 .IX Header "COPYRIGHT"
102 Copyright 2018\-2021 The OpenSSL Project Authors. All Rights Reserved.
103 .PP
104 Licensed under the Apache License 2.0 (the "License"). You may not use
105 this file except in compliance with the License. You can obtain a copy
106 in the file LICENSE in the source distribution or at
107 <https://www.openssl.org/source/license.html>.