1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
/** @file
* IPRT - Message-Digest algorithm 5.
*/
/*
* Copyright (C) 2006-2022 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
* in the VirtualBox distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*
* SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
*/
#ifndef IPRT_INCLUDED_md5_h
#define IPRT_INCLUDED_md5_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include <iprt/types.h>
/** @defgroup grp_rt_md5 RTMd5 - Message-Digest algorithm 5
* @ingroup grp_rt
* @{
*/
/** Size of a MD5 hash. */
#define RTMD5_HASH_SIZE 16
/** @deprecated Use RTMD5_HASH_SIZE. */
#define RTMD5HASHSIZE RTMD5_HASH_SIZE
/** The length of a MD5 digest string. The terminator is not included. */
#define RTMD5_DIGEST_LEN 32
/** Size of a MD5 hash.
* @deprecated Use RTMD5_DIGEST_LEN */
#define RTMD5_STRING_LEN RTMD5_DIGEST_LEN
/**
* MD5 hash algorithm context.
*/
typedef union RTMD5CONTEXT
{
uint64_t u64BetterAlignment;
uint8_t abPadding[(4 + 6 + 16 + 1) * sizeof(uint32_t)];
/** Context used by md5-alt.cpp. */
struct
{
uint32_t in[16];
uint32_t buf[4];
uint32_t bits[2];
} AltPrivate;
#ifdef RT_MD5_OPENSSL_PRIVATE_CONTEXT
/** Context used by md5-openssl.cpp. */
MD5_CTX OsslPrivate;
#endif
} RTMD5CONTEXT;
/** Pointer to MD5 hash algorithm context. */
typedef RTMD5CONTEXT *PRTMD5CONTEXT;
RT_C_DECLS_BEGIN
/**
* Compute the MD5 hash of the data.
*
* @param pvBuf Pointer to data.
* @param cbBuf Length of data (in bytes).
* @param pabDigest Where to store the hash.
* (What's passed is a pointer to the caller's buffer.)
*/
RTDECL(void) RTMd5(const void *pvBuf, size_t cbBuf, uint8_t pabDigest[RTMD5HASHSIZE]);
/**
* Initialize MD5 context.
*
* @param pCtx Pointer to the MD5 context to initialize.
*/
RTDECL(void) RTMd5Init(PRTMD5CONTEXT pCtx);
/**
* Feed data into the MD5 computation.
*
* @param pCtx Pointer to the MD5 context.
* @param pvBuf Pointer to data.
* @param cbBuf Length of data (in bytes).
*/
RTDECL(void) RTMd5Update(PRTMD5CONTEXT pCtx, const void *pvBuf, size_t cbBuf);
/**
* Compute the MD5 hash of the data.
*
* @param pabDigest Where to store the hash.
* (What's passed is a pointer to the caller's buffer.)
* @param pCtx Pointer to the MD5 context.
*/
RTDECL(void) RTMd5Final(uint8_t pabDigest[RTMD5HASHSIZE], PRTMD5CONTEXT pCtx);
/**
* Converts a MD5 hash to a digest string.
*
* @returns IPRT status code.
*
* @param pabDigest The binary digest returned by RTMd5Final or RTMd5.
* @param pszDigest Where to return the stringified digest.
* @param cchDigest The size of the output buffer. Should be at least
* RTMD5_STRING_LEN + 1 bytes.
*/
RTDECL(int) RTMd5ToString(uint8_t const pabDigest[RTMD5_HASH_SIZE], char *pszDigest, size_t cchDigest);
/**
* Converts a MD5 hash to a digest string.
*
* @returns IPRT status code.
*
* @param pszDigest The stringified digest. Leading and trailing spaces are
* ignored.
* @param pabDigest Where to store the hash. (What is passed is a pointer to
* the caller's buffer.)
*/
RTDECL(int) RTMd5FromString(char const *pszDigest, uint8_t pabDigest[RTMD5_HASH_SIZE]);
RT_C_DECLS_END
/** @} */
#endif /* !IPRT_INCLUDED_md5_h */
|
