Debian Codegraph @

upstream/debian-unstable/man3/MDC2_Init.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 "MDC2_INIT 3SSL"
58 .TH MDC2_INIT 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 MDC2, MDC2_Init, MDC2_Update, MDC2_Final \- MDC2 hash function
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/mdc2.h>
69 .Ve
70 .PP
71 The following functions have been deprecated since OpenSSL 3.0, and can be
72 hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value,
73 see \fBopenssl_user_macros\fR\|(7):
74 .PP
75 .Vb 2
76 \& unsigned char *MDC2(const unsigned char *d, unsigned long n,
77 \& unsigned char *md);
78 \&
79 \& int MDC2_Init(MDC2_CTX *c);
80 \& int MDC2_Update(MDC2_CTX *c, const unsigned char *data,
81 \& unsigned long len);
82 \& int MDC2_Final(unsigned char *md, MDC2_CTX *c);
83 .Ve
84 .SH DESCRIPTION
85 .IX Header "DESCRIPTION"
86 All of the functions described on this page are deprecated.
87 Applications should instead use \fBEVP_DigestInit_ex\fR\|(3), \fBEVP_DigestUpdate\fR\|(3)
88 and \fBEVP_DigestFinal_ex\fR\|(3).
89 .PP
90 MDC2 is a method to construct hash functions with 128 bit output from
91 block ciphers. These functions are an implementation of MDC2 with
92 DES.
93 .PP
94 \&\fBMDC2()\fR computes the MDC2 message digest of the \fBn\fR
95 bytes at \fBd\fR and places it in \fBmd\fR (which must have space for
96 MDC2_DIGEST_LENGTH == 16 bytes of output). If \fBmd\fR is NULL, the digest
97 is placed in a static array.
98 .PP
99 The following functions may be used if the message is not completely
100 stored in memory:
101 .PP
102 \&\fBMDC2_Init()\fR initializes a \fBMDC2_CTX\fR structure.
103 .PP
104 \&\fBMDC2_Update()\fR can be called repeatedly with chunks of the message to
105 be hashed (\fBlen\fR bytes at \fBdata\fR).
106 .PP
107 \&\fBMDC2_Final()\fR places the message digest in \fBmd\fR, which must have space
108 for MDC2_DIGEST_LENGTH == 16 bytes of output, and erases the \fBMDC2_CTX\fR.
109 .PP
110 Applications should use the higher level functions
111 \&\fBEVP_DigestInit\fR\|(3) etc. instead of calling the
112 hash functions directly.
113 .SH "RETURN VALUES"
114 .IX Header "RETURN VALUES"
115 \&\fBMDC2()\fR returns a pointer to the hash value.
116 .PP
117 \&\fBMDC2_Init()\fR, \fBMDC2_Update()\fR and \fBMDC2_Final()\fR return 1 for success, 0 otherwise.
118 .SH "CONFORMING TO"
119 .IX Header "CONFORMING TO"
120 ISO/IEC 10118\-2:2000 Hash-Function 2, with DES as the underlying block cipher.
121 .SH "SEE ALSO"
122 .IX Header "SEE ALSO"
123 \&\fBEVP_DigestInit\fR\|(3)
124 .SH HISTORY
125 .IX Header "HISTORY"
126 All of these functions were deprecated in OpenSSL 3.0.
127 .SH COPYRIGHT
128 .IX Header "COPYRIGHT"
129 Copyright 2000\-2020 The OpenSSL Project Authors. All Rights Reserved.
130 .PP
131 Licensed under the Apache License 2.0 (the "License"). You may not use
132 this file except in compliance with the License. You can obtain a copy
133 in the file LICENSE in the source distribution or at
134 <https://www.openssl.org/source/license.html>.