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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
|
/** @file
* IPRT - SHA1 digest creation
*/
/*
* Copyright (C) 2009-2010 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE 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.
*/
#ifndef ___iprt_sha_h
#define ___iprt_sha_h
#include <iprt/types.h>
RT_C_DECLS_BEGIN
/** @defgroup grp_rt_sha RTSha - SHA Family of Hash Functions
* @ingroup grp_rt
* @{
*/
/** The size of a SHA-1 hash. */
#define RTSHA1_HASH_SIZE 20
/** The length of a SHA-1 digest string. The terminator is not included. */
#define RTSHA1_DIGEST_LEN 40
/**
* SHA-1 context.
*/
typedef union RTSHA1CONTEXT
{
uint64_t u64BetterAlignment;
uint8_t abPadding[8 + (5 + 80) * 4 + 4];
#ifdef RT_SHA1_PRIVATE_CONTEXT
SHA_CTX Private;
#endif
#ifdef RT_SHA1_PRIVATE_ALT_CONTEXT
RTSHA1ALTPRIVATECTX AltPrivate;
#endif
} RTSHA1CONTEXT;
/** Pointer to an SHA-1 context. */
typedef RTSHA1CONTEXT *PRTSHA1CONTEXT;
/**
* Compute the SHA-1 hash of the data.
*
* @param pvBuf Pointer to the data.
* @param cbBuf The amount of data (in bytes).
* @param pabDigest Where to store the hash. (What is passed is a pointer to
* the caller's buffer.)
*/
RTDECL(void) RTSha1(const void *pvBuf, size_t cbBuf, uint8_t pabDigest[RTSHA1_HASH_SIZE]);
/**
* Initializes the SHA-1 context.
*
* @param pCtx Pointer to the SHA-1 context.
*/
RTDECL(void) RTSha1Init(PRTSHA1CONTEXT pCtx);
/**
* Feed data into the SHA-1 computation.
*
* @param pCtx Pointer to the SHA-1 context.
* @param pvBuf Pointer to the data.
* @param cbBuf The length of the data (in bytes).
*/
RTDECL(void) RTSha1Update(PRTSHA1CONTEXT pCtx, const void *pvBuf, size_t cbBuf);
/**
* Compute the SHA-1 hash of the data.
*
* @param pCtx Pointer to the SHA-1 context.
* @param pabDigest Where to store the hash. (What is passed is a pointer to
* the caller's buffer.)
*/
RTDECL(void) RTSha1Final(PRTSHA1CONTEXT pCtx, uint8_t pabDigest[RTSHA1_HASH_SIZE]);
/**
* Converts a SHA-1 hash to a digest string.
*
* @returns IPRT status code.
*
* @param pabDigest The binary digest returned by RTSha1Final or RTSha1.
* @param pszDigest Where to return the stringified digest.
* @param cchDigest The size of the output buffer. Should be at least
* RTSHA1_DIGEST_LEN + 1 bytes.
*/
RTDECL(int) RTSha1ToString(uint8_t const pabDigest[RTSHA1_HASH_SIZE], char *pszDigest, size_t cchDigest);
/**
* Converts a SHA-1 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) RTSha1FromString(char const *pszDigest, uint8_t pabDigest[RTSHA1_HASH_SIZE]);
/**
* Creates a SHA1 digest for the given memory buffer.
*
* @returns iprt status code.
*
* @param pvBuf Memory buffer to create a SHA1 digest for.
* @param cbBuf The amount of data (in bytes).
* @param ppszDigest On success the SHA1 digest.
* @param pfnProgressCallback optional callback for the progress indication
* @param pvUser user defined pointer for the callback
*/
RTR3DECL(int) RTSha1Digest(void* pvBuf, size_t cbBuf, char **ppszDigest, PFNRTPROGRESS pfnProgressCallback, void *pvUser);
/**
* Creates a SHA1 digest for the given file.
*
* @returns iprt status code.
*
* @param pszFile Filename to create a SHA1 digest for.
* @param ppszDigest On success the SHA1 digest.
* @param pfnProgressCallback optional callback for the progress indication
* @param pvUser user defined pointer for the callback
*/
RTR3DECL(int) RTSha1DigestFromFile(const char *pszFile, char **ppszDigest, PFNRTPROGRESS pfnProgressCallback, void *pvUser);
/** The size of a SHA-256 hash. */
#define RTSHA256_HASH_SIZE 32
/** The length of a SHA-256 digest string. The terminator is not included. */
#define RTSHA256_DIGEST_LEN 64
/**
* SHA-256 context.
*/
typedef union RTSHA256CONTEXT
{
uint64_t u64BetterAlignment;
uint8_t abPadding[8 + (8 + 80) * 4];
#ifdef RT_SHA256_PRIVATE_CONTEXT
SHA256_CTX Private;
#endif
#ifdef RT_SHA256_PRIVATE_ALT_CONTEXT
RTSHA256ALTPRIVATECTX AltPrivate;
#endif
} RTSHA256CONTEXT;
/** Pointer to an SHA-256 context. */
typedef RTSHA256CONTEXT *PRTSHA256CONTEXT;
/**
* Compute the SHA-256 hash of the data.
*
* @param pvBuf Pointer to the data.
* @param cbBuf The amount of data (in bytes).
* @param pabDigest Where to store the hash. (What is passed is a pointer to
* the caller's buffer.)
*/
RTDECL(void) RTSha256(const void *pvBuf, size_t cbBuf, uint8_t pabDigest[RTSHA256_HASH_SIZE]);
/**
* Initializes the SHA-256 context.
*
* @param pCtx Pointer to the SHA-256 context.
*/
RTDECL(void) RTSha256Init(PRTSHA256CONTEXT pCtx);
/**
* Feed data into the SHA-256 computation.
*
* @param pCtx Pointer to the SHA-256 context.
* @param pvBuf Pointer to the data.
* @param cbBuf The length of the data (in bytes).
*/
RTDECL(void) RTSha256Update(PRTSHA256CONTEXT pCtx, const void *pvBuf, size_t cbBuf);
/**
* Compute the SHA-256 hash of the data.
*
* @param pCtx Pointer to the SHA-256 context.
* @param pabDigest Where to store the hash. (What is passed is a pointer to
* the caller's buffer.)
*/
RTDECL(void) RTSha256Final(PRTSHA256CONTEXT pCtx, uint8_t pabDigest[RTSHA256_HASH_SIZE]);
/**
* Converts a SHA-256 hash to a digest string.
*
* @returns IPRT status code.
*
* @param pabDigest The binary digest returned by RTSha256Final or RTSha256.
* @param pszDigest Where to return the stringified digest.
* @param cchDigest The size of the output buffer. Should be at least
* RTSHA256_DIGEST_LEN + 1 bytes.
*/
RTDECL(int) RTSha256ToString(uint8_t const pabDigest[RTSHA256_HASH_SIZE], char *pszDigest, size_t cchDigest);
/**
* Converts a SHA-256 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) RTSha256FromString(char const *pszDigest, uint8_t pabDigest[RTSHA256_HASH_SIZE]);
/**
* Creates a SHA256 digest for the given memory buffer.
*
* @returns iprt status code.
*
* @param pvBuf Memory buffer to create a
* SHA256 digest for.
* @param cbBuf The amount of data (in bytes).
* @param ppszDigest On success the SHA256 digest.
* @param pfnProgressCallback optional callback for the progress indication
* @param pvUser user defined pointer for the callback
*/
RTR3DECL(int) RTSha256Digest(void* pvBuf, size_t cbBuf, char **ppszDigest, PFNRTPROGRESS pfnProgressCallback, void *pvUser);
/**
* Creates a SHA256 digest for the given file.
*
* @returns iprt status code.
*
* @param pszFile Filename to create a SHA256
* digest for.
* @param ppszDigest On success the SHA256 digest.
* @param pfnProgressCallback optional callback for the progress indication
* @param pvUser user defined pointer for the callback
*/
RTR3DECL(int) RTSha256DigestFromFile(const char *pszFile, char **ppszDigest, PFNRTPROGRESS pfnProgressCallback, void *pvUser);
/** The size of a SHA-224 hash. */
#define RTSHA224_HASH_SIZE 28
/** The length of a SHA-224 digest string. The terminator is not included. */
#define RTSHA224_DIGEST_LEN 56
/** SHA-224 context (same as for SHA-256). */
typedef RTSHA256CONTEXT RTSHA224CONTEXT;
/** Pointer to an SHA-224 context. */
typedef RTSHA256CONTEXT *PRTSHA224CONTEXT;
/**
* Compute the SHA-224 hash of the data.
*
* @param pvBuf Pointer to the data.
* @param cbBuf The amount of data (in bytes).
* @param pabDigest Where to store the hash. (What is passed is a pointer to
* the caller's buffer.)
*/
RTDECL(void) RTSha224(const void *pvBuf, size_t cbBuf, uint8_t pabDigest[RTSHA224_HASH_SIZE]);
/**
* Initializes the SHA-224 context.
*
* @param pCtx Pointer to the SHA-224 context.
*/
RTDECL(void) RTSha224Init(PRTSHA224CONTEXT pCtx);
/**
* Feed data into the SHA-224 computation.
*
* @param pCtx Pointer to the SHA-224 context.
* @param pvBuf Pointer to the data.
* @param cbBuf The length of the data (in bytes).
*/
RTDECL(void) RTSha224Update(PRTSHA224CONTEXT pCtx, const void *pvBuf, size_t cbBuf);
/**
* Compute the SHA-224 hash of the data.
*
* @param pCtx Pointer to the SHA-224 context.
* @param pabDigest Where to store the hash. (What is passed is a pointer to
* the caller's buffer.)
*/
RTDECL(void) RTSha224Final(PRTSHA224CONTEXT pCtx, uint8_t pabDigest[RTSHA224_HASH_SIZE]);
/**
* Converts a SHA-224 hash to a digest string.
*
* @returns IPRT status code.
*
* @param pabDigest The binary digest returned by RTSha224Final or RTSha224.
* @param pszDigest Where to return the stringified digest.
* @param cchDigest The size of the output buffer. Should be at least
* RTSHA224_DIGEST_LEN + 1 bytes.
*/
RTDECL(int) RTSha224ToString(uint8_t const pabDigest[RTSHA224_HASH_SIZE], char *pszDigest, size_t cchDigest);
/**
* Converts a SHA-224 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) RTSha224FromString(char const *pszDigest, uint8_t pabDigest[RTSHA224_HASH_SIZE]);
/**
* Creates a SHA224 digest for the given memory buffer.
*
* @returns iprt status code.
*
* @param pvBuf Memory buffer to create a SHA224 digest for.
* @param cbBuf The amount of data (in bytes).
* @param ppszDigest On success the SHA224 digest.
* @param pfnProgressCallback optional callback for the progress indication
* @param pvUser user defined pointer for the callback
*/
RTR3DECL(int) RTSha224Digest(void* pvBuf, size_t cbBuf, char **ppszDigest, PFNRTPROGRESS pfnProgressCallback, void *pvUser);
/**
* Creates a SHA224 digest for the given file.
*
* @returns iprt status code.
*
* @param pszFile Filename to create a SHA224 digest for.
* @param ppszDigest On success the SHA224 digest.
* @param pfnProgressCallback optional callback for the progress indication
* @param pvUser user defined pointer for the callback
*/
RTR3DECL(int) RTSha224DigestFromFile(const char *pszFile, char **ppszDigest, PFNRTPROGRESS pfnProgressCallback, void *pvUser);
/** The size of a SHA-512 hash. */
#define RTSHA512_HASH_SIZE 64
/** The length of a SHA-512 digest string. The terminator is not included. */
#define RTSHA512_DIGEST_LEN 128
/**
* SHA-512 context.
*/
typedef union RTSHA512CONTEXT
{
uint64_t u64BetterAlignment;
uint8_t abPadding[16 + (80 + 8) * 8];
#ifdef RT_SHA512_PRIVATE_CONTEXT
SHA512_CTX Private;
#endif
#ifdef RT_SHA512_PRIVATE_ALT_CONTEXT
RTSHA512ALTPRIVATECTX AltPrivate;
#endif
} RTSHA512CONTEXT;
/** Pointer to an SHA-512 context. */
typedef RTSHA512CONTEXT *PRTSHA512CONTEXT;
/**
* Compute the SHA-512 hash of the data.
*
* @param pvBuf Pointer to the data.
* @param cbBuf The amount of data (in bytes).
* @param pabDigest Where to store the hash. (What is passed is a pointer to
* the caller's buffer.)
*/
RTDECL(void) RTSha512(const void *pvBuf, size_t cbBuf, uint8_t pabDigest[RTSHA512_HASH_SIZE]);
/**
* Initializes the SHA-512 context.
*
* @param pCtx Pointer to the SHA-512 context.
*/
RTDECL(void) RTSha512Init(PRTSHA512CONTEXT pCtx);
/**
* Feed data into the SHA-512 computation.
*
* @param pCtx Pointer to the SHA-512 context.
* @param pvBuf Pointer to the data.
* @param cbBuf The length of the data (in bytes).
*/
RTDECL(void) RTSha512Update(PRTSHA512CONTEXT pCtx, const void *pvBuf, size_t cbBuf);
/**
* Compute the SHA-512 hash of the data.
*
* @param pCtx Pointer to the SHA-512 context.
* @param pabDigest Where to store the hash. (What is passed is a pointer to
* the caller's buffer.)
*/
RTDECL(void) RTSha512Final(PRTSHA512CONTEXT pCtx, uint8_t pabDigest[RTSHA512_HASH_SIZE]);
/**
* Converts a SHA-512 hash to a digest string.
*
* @returns IPRT status code.
*
* @param pabDigest The binary digest returned by RTSha512Final or RTSha512.
* @param pszDigest Where to return the stringified digest.
* @param cchDigest The size of the output buffer. Should be at least
* RTSHA512_DIGEST_LEN + 1 bytes.
*/
RTDECL(int) RTSha512ToString(uint8_t const pabDigest[RTSHA512_HASH_SIZE], char *pszDigest, size_t cchDigest);
/**
* Converts a SHA-512 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) RTSha512FromString(char const *pszDigest, uint8_t pabDigest[RTSHA512_HASH_SIZE]);
/** Macro for declaring the interface for a SHA-512 variation.
* @internal */
#define RTSHA512_DECLARE_VARIANT(a_Name, a_UName) \
typedef RTSHA512CONTEXT RT_CONCAT3(RTSHA,a_UName,CONTEXT); \
typedef RTSHA512CONTEXT *RT_CONCAT3(PRTSHA,a_UName,CONTEXT); \
RTDECL(void) RT_CONCAT(RTSha,a_Name)(const void *pvBuf, size_t cbBuf, uint8_t pabDigest[RT_CONCAT3(RTSHA,a_UName,_HASH_SIZE)]); \
RTDECL(void) RT_CONCAT3(RTSha,a_Name,Init)(RT_CONCAT3(PRTSHA,a_UName,CONTEXT) pCtx); \
RTDECL(void) RT_CONCAT3(RTSha,a_Name,Update)(RT_CONCAT3(PRTSHA,a_UName,CONTEXT) pCtx, const void *pvBuf, size_t cbBuf); \
RTDECL(void) RT_CONCAT3(RTSha,a_Name,Final)(RT_CONCAT3(PRTSHA,a_UName,CONTEXT) pCtx, uint8_t pabDigest[RT_CONCAT3(RTSHA,a_UName,_HASH_SIZE)]); \
RTDECL(int) RT_CONCAT3(RTSha,a_Name,ToString)(uint8_t const pabDigest[RT_CONCAT3(RTSHA,a_UName,_HASH_SIZE)], char *pszDigest, size_t cchDigest); \
RTDECL(int) RT_CONCAT3(RTSha,a_Name,FromString)(char const *pszDigest, uint8_t pabDigest[RT_CONCAT3(RTSHA,a_UName,_HASH_SIZE)])
/** The size of a SHA-384 hash. */
#define RTSHA384_HASH_SIZE 48
/** The length of a SHA-384 digest string. The terminator is not included. */
#define RTSHA384_DIGEST_LEN 96
RTSHA512_DECLARE_VARIANT(384,384);
/** The size of a SHA-512/224 hash. */
#define RTSHA512T224_HASH_SIZE 28
/** The length of a SHA-512/224 digest string. The terminator is not
* included. */
#define RTSHA512T224_DIGEST_LEN 56
RTSHA512_DECLARE_VARIANT(512t224,512T224);
/** The size of a SHA-512/256 hash. */
#define RTSHA512T256_HASH_SIZE 32
/** The length of a SHA-512/256 digest string. The terminator is not
* included. */
#define RTSHA512T256_DIGEST_LEN 64
RTSHA512_DECLARE_VARIANT(512t256,512T256);
/** @} */
RT_C_DECLS_END
#endif
|
