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
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: digest.h,v $
* $Revision: 1.8 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef _RTL_DIGEST_H_
#define _RTL_DIGEST_H_ "$Revision: 1.8 $"
#include <sal/types.h>
#ifdef __cplusplus
extern "C" {
#endif
/*========================================================================
*
* rtlDigest.
*
*======================================================================*/
/** Digest Handle opaque type.
*/
typedef void* rtlDigest;
/** Digest Algorithm enumeration.
@see rtl_digest_create()
*/
enum __rtl_DigestAlgorithm
{
rtl_Digest_AlgorithmMD2,
rtl_Digest_AlgorithmMD5,
rtl_Digest_AlgorithmSHA,
rtl_Digest_AlgorithmSHA1,
rtl_Digest_AlgorithmHMAC_MD5,
rtl_Digest_AlgorithmHMAC_SHA1,
rtl_Digest_AlgorithmInvalid,
rtl_Digest_Algorithm_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
};
/** Digest Algorithm type.
*/
typedef enum __rtl_DigestAlgorithm rtlDigestAlgorithm;
/** Error Code enumeration.
*/
enum __rtl_DigestError
{
rtl_Digest_E_None,
rtl_Digest_E_Argument,
rtl_Digest_E_Algorithm,
rtl_Digest_E_BufferSize,
rtl_Digest_E_Memory,
rtl_Digest_E_Unknown,
rtl_Digest_E_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
};
/** Error Code type.
*/
typedef enum __rtl_DigestError rtlDigestError;
/** Create a digest handle for the given algorithm.
@see rtlDigestAlgorithm
@param Algorithm [in] digest algorithm.
@return Digest handle, or 0 upon failure.
*/
rtlDigest SAL_CALL rtl_digest_create (
rtlDigestAlgorithm Algorithm
) SAL_THROW_EXTERN_C();
/** Destroy a digest handle.
@postcond Digest handle destroyed and invalid.
@param Digest [in] digest handle to be destroyed.
@return None.
*/
void SAL_CALL rtl_digest_destroy (
rtlDigest Digest
) SAL_THROW_EXTERN_C();
/** Query the algorithm of a given digest.
@param Digest [in] digest handle.
@return digest algorithm, or rtl_Digest_AlgorithmInvalid upon failure.
*/
rtlDigestAlgorithm SAL_CALL rtl_digest_queryAlgorithm (
rtlDigest Digest
) SAL_THROW_EXTERN_C();
/** Query the length of a given digest.
@param Digest [in] digest handle.
@return digest length, or 0 upon failure.
*/
sal_uInt32 SAL_CALL rtl_digest_queryLength (
rtlDigest Digest
) SAL_THROW_EXTERN_C();
/** Initialize a digest with given data.
@param Digest [in] digest handle.
@param pData [in] data buffer.
@param nDatLen [in] data length.
@return rtl_Digest_E_None upon success.
*/
rtlDigestError SAL_CALL rtl_digest_init (
rtlDigest Digest,
const sal_uInt8 *pData, sal_uInt32 nDatLen
) SAL_THROW_EXTERN_C();
/** Update a digest with given data.
@param Digest [in] digest handle.
@param pData [in] data buffer.
@param nDatLen [in] data length.
@return rtl_Digest_E_None upon success.
*/
rtlDigestError SAL_CALL rtl_digest_update (
rtlDigest Digest,
const void *pData, sal_uInt32 nDatLen
) SAL_THROW_EXTERN_C();
/** Finalize a digest and retrieve the digest value.
@precond Digest value length must not be less than digest length.
@postcond Digest initialized to accept another update sequence.
@see rtl_digest_queryLength()
@see rtl_digest_update()
@param Digest [in] digest handle.
@param pBuffer [in] digest value buffer.
@param nBufLen [in] digest value length.
@return rtl_Digest_E_None upon success.
*/
rtlDigestError SAL_CALL rtl_digest_get (
rtlDigest Digest,
sal_uInt8 *pBuffer, sal_uInt32 nBufLen
) SAL_THROW_EXTERN_C();
/*========================================================================
*
* rtl_digest_MD2 interface.
*
*======================================================================*/
#define RTL_DIGEST_LENGTH_MD2 16
/** Create a MD2 digest handle.
@descr The MD2 digest algorithm is specified in
RFC 1319 (Informational)
The MD2 Message-Digest Algorithm
@see rtl_digest_create()
*/
rtlDigest SAL_CALL rtl_digest_createMD2 (void) SAL_THROW_EXTERN_C();
/** Destroy a MD2 digest handle.
@see rtl_digest_destroy()
*/
void SAL_CALL rtl_digest_destroyMD2 (
rtlDigest Digest
) SAL_THROW_EXTERN_C();
/** Update a MD2 digest with given data.
@see rtl_digest_update()
*/
rtlDigestError SAL_CALL rtl_digest_updateMD2 (
rtlDigest Digest,
const void *pData, sal_uInt32 nDatLen
) SAL_THROW_EXTERN_C();
/** Finalize a MD2 digest and retrieve the digest value.
@see rtl_digest_get()
*/
rtlDigestError SAL_CALL rtl_digest_getMD2 (
rtlDigest Digest,
sal_uInt8 *pBuffer, sal_uInt32 nBufLen
) SAL_THROW_EXTERN_C();
/** Evaluate a MD2 digest value from given data.
@descr This function performs an optimized call sequence on a
single data buffer, avoiding digest creation and destruction.
@see rtl_digest_updateMD2()
@see rtl_digest_getMD2()
@param pData [in] data buffer.
@param nDatLen [in] data length.
@param pBuffer [in] digest value buffer.
@param nBufLen [in] digest value length.
@return rtl_Digest_E_None upon success.
*/
rtlDigestError SAL_CALL rtl_digest_MD2 (
const void *pData, sal_uInt32 nDatLen,
sal_uInt8 *pBuffer, sal_uInt32 nBufLen
) SAL_THROW_EXTERN_C();
/*========================================================================
*
* rtl_digest_MD5 interface.
*
*======================================================================*/
#define RTL_DIGEST_LENGTH_MD5 16
/** Create a MD5 digest handle.
@descr The MD5 digest algorithm is specified in
RFC 1321 (Informational)
The MD5 Message-Digest Algorithm
@see rtl_digest_create()
*/
rtlDigest SAL_CALL rtl_digest_createMD5 (void) SAL_THROW_EXTERN_C();
/** Destroy a MD5 digest handle.
@see rtl_digest_destroy()
*/
void SAL_CALL rtl_digest_destroyMD5 (
rtlDigest Digest
) SAL_THROW_EXTERN_C();
/** Update a MD5 digest with given data.
@see rtl_digest_update()
*/
rtlDigestError SAL_CALL rtl_digest_updateMD5 (
rtlDigest Digest,
const void *pData, sal_uInt32 nDatLen
) SAL_THROW_EXTERN_C();
/** Finalize a MD5 digest and retrieve the digest value.
@see rtl_digest_get()
*/
rtlDigestError SAL_CALL rtl_digest_getMD5 (
rtlDigest Digest,
sal_uInt8 *pBuffer, sal_uInt32 nBufLen
) SAL_THROW_EXTERN_C();
/** Retrieve the raw (not finalized) MD5 digest value.
@descr This function is a non-standard replacement for
rtl_digest_getMD5() and must be used with caution.
@postcond Digest initialized to accept another update sequence.
@see rtl_digest_get()
*/
rtlDigestError SAL_CALL rtl_digest_rawMD5 (
rtlDigest Digest,
sal_uInt8 *pBuffer, sal_uInt32 nBufLen
) SAL_THROW_EXTERN_C();
/** Evaluate a MD5 digest value from given data.
@descr This function performs an optimized call sequence on a
single data buffer, avoiding digest creation and destruction.
@see rtl_digest_updateMD5()
@see rtl_digest_getMD5()
@param pData [in] data buffer.
@param nDatLen [in] data length.
@param pBuffer [in] digest value buffer.
@param nBufLen [in] digest value length.
@return rtl_Digest_E_None upon success.
*/
rtlDigestError SAL_CALL rtl_digest_MD5 (
const void *pData, sal_uInt32 nDatLen,
sal_uInt8 *pBuffer, sal_uInt32 nBufLen
) SAL_THROW_EXTERN_C();
/*========================================================================
*
* rtl_digest_SHA interface.
*
*======================================================================*/
#define RTL_DIGEST_LENGTH_SHA 20
/** Create a SHA digest handle.
@descr The SHA digest algorithm is specified in
FIPS PUB 180 (Superseded by FIPS PUB 180-1)
Secure Hash Standard
@see rtl_digest_create()
*/
rtlDigest SAL_CALL rtl_digest_createSHA (void) SAL_THROW_EXTERN_C();
/** Destroy a SHA digest handle.
@see rtl_digest_destroy()
*/
void SAL_CALL rtl_digest_destroySHA (
rtlDigest Digest
) SAL_THROW_EXTERN_C();
/** Update a SHA digest with given data.
@see rtl_digest_update()
*/
rtlDigestError SAL_CALL rtl_digest_updateSHA (
rtlDigest Digest,
const void *pData, sal_uInt32 nDatLen
) SAL_THROW_EXTERN_C();
/** Finalize a SHA digest and retrieve the digest value.
@see rtl_digest_get()
*/
rtlDigestError SAL_CALL rtl_digest_getSHA (
rtlDigest Digest,
sal_uInt8 *pBuffer, sal_uInt32 nBufLen
) SAL_THROW_EXTERN_C();
/** Evaluate a SHA digest value from given data.
@descr This function performs an optimized call sequence on a
single data buffer, avoiding digest creation and destruction.
@see rtl_digest_updateSHA()
@see rtl_digest_getSHA()
@param pData [in] data buffer.
@param nDatLen [in] data length.
@param pBuffer [in] digest value buffer.
@param nBufLen [in] digest value length.
@return rtl_Digest_E_None upon success.
*/
rtlDigestError SAL_CALL rtl_digest_SHA (
const void *pData, sal_uInt32 nDatLen,
sal_uInt8 *pBuffer, sal_uInt32 nBufLen
) SAL_THROW_EXTERN_C();
/*========================================================================
*
* rtl_digest_SHA1 interface.
*
*======================================================================*/
#define RTL_DIGEST_LENGTH_SHA1 20
/** Create a SHA1 digest handle.
@descr The SHA1 digest algorithm is specified in
FIPS PUB 180-1 (Supersedes FIPS PUB 180)
Secure Hash Standard
@see rtl_digest_create()
*/
rtlDigest SAL_CALL rtl_digest_createSHA1 (void) SAL_THROW_EXTERN_C();
/** Destroy a SHA1 digest handle.
@see rtl_digest_destroy()
*/
void SAL_CALL rtl_digest_destroySHA1 (
rtlDigest Digest
) SAL_THROW_EXTERN_C();
/** Update a SHA1 digest with given data.
@see rtl_digest_update()
*/
rtlDigestError SAL_CALL rtl_digest_updateSHA1 (
rtlDigest Digest,
const void *pData, sal_uInt32 nDatLen
) SAL_THROW_EXTERN_C();
/** Finalize a SHA1 digest and retrieve the digest value.
@see rtl_digest_get()
*/
rtlDigestError SAL_CALL rtl_digest_getSHA1 (
rtlDigest Digest,
sal_uInt8 *pBuffer, sal_uInt32 nBufLen
) SAL_THROW_EXTERN_C();
/** Evaluate a SHA1 digest value from given data.
@descr This function performs an optimized call sequence on a
single data buffer, avoiding digest creation and destruction.
@see rtl_digest_updateSHA1()
@see rtl_digest_getSHA1()
@param pData [in] data buffer.
@param nDatLen [in] data length.
@param pBuffer [in] digest value buffer.
@param nBufLen [in] digest value length.
@return rtl_Digest_E_None upon success.
*/
rtlDigestError SAL_CALL rtl_digest_SHA1 (
const void *pData, sal_uInt32 nDatLen,
sal_uInt8 *pBuffer, sal_uInt32 nBufLen
) SAL_THROW_EXTERN_C();
/*========================================================================
*
* rtl_digest_HMAC_MD5 interface.
*
*======================================================================*/
#define RTL_DIGEST_LENGTH_HMAC_MD5 RTL_DIGEST_LENGTH_MD5
/** Create a HMAC_MD5 digest handle.
@descr The HMAC_MD5 digest algorithm is specified in
RFC 2104 (Informational)
HMAC: Keyed-Hashing for Message Authentication
@see rtl_digest_create()
*/
rtlDigest SAL_CALL rtl_digest_createHMAC_MD5 (void) SAL_THROW_EXTERN_C();
/** Destroy a HMAC_MD5 digest handle.
@see rtl_digest_destroy()
*/
void SAL_CALL rtl_digest_destroyHMAC_MD5 (
rtlDigest Digest
) SAL_THROW_EXTERN_C();
/** Initialize a HMAC_MD5 digest.
@see rtl_digest_init()
@param Digest [in] digest handle.
@param pKeyData [in] key material buffer.
@param nKeyLen [in] key material length.
@return rtl_Digest_E_None upon success.
*/
rtlDigestError SAL_CALL rtl_digest_initHMAC_MD5 (
rtlDigest Digest,
const sal_uInt8 *pKeyData, sal_uInt32 nKeyLen
) SAL_THROW_EXTERN_C();
/** Update a HMAC_MD5 digest with given data.
@see rtl_digest_update()
*/
rtlDigestError SAL_CALL rtl_digest_updateHMAC_MD5 (
rtlDigest Digest,
const void *pData, sal_uInt32 nDatLen
) SAL_THROW_EXTERN_C();
/** Finalize a HMAC_MD5 digest and retrieve the digest value.
@see rtl_digest_get()
*/
rtlDigestError SAL_CALL rtl_digest_getHMAC_MD5 (
rtlDigest Digest,
sal_uInt8 *pBuffer, sal_uInt32 nBufLen
) SAL_THROW_EXTERN_C();
/** Evaluate a HMAC_MD5 digest value from given data.
@descr This function performs an optimized call sequence on a
single data buffer, avoiding digest creation and destruction.
@see rtl_digest_initHMAC_MD5()
@see rtl_digest_updateHMAC_MD5()
@see rtl_digest_getHMAC_MD5()
@param pKeyData [in] key material buffer.
@param nKeyLen [in] key material length.
@param pData [in] data buffer.
@param nDatLen [in] data length.
@param pBuffer [in] digest value buffer.
@param nBufLen [in] digest value length.
@return rtl_Digest_E_None upon success.
*/
rtlDigestError SAL_CALL rtl_digest_HMAC_MD5 (
const sal_uInt8 *pKeyData, sal_uInt32 nKeyLen,
const void *pData, sal_uInt32 nDatLen,
sal_uInt8 *pBuffer, sal_uInt32 nBufLen
) SAL_THROW_EXTERN_C();
/*========================================================================
*
* rtl_digest_HMAC_SHA1 interface.
*
*======================================================================*/
#define RTL_DIGEST_LENGTH_HMAC_SHA1 RTL_DIGEST_LENGTH_SHA1
/** Create a HMAC_SHA1 digest handle.
@descr The HMAC_SHA1 digest algorithm is specified in
RFC 2104 (Informational)
HMAC: Keyed-Hashing for Message Authentication
RFC 2898 (Informational)
PKCS #5: Password-Based Cryptography Specification Version 2.0
@see rtl_digest_create()
*/
rtlDigest SAL_CALL rtl_digest_createHMAC_SHA1 (void) SAL_THROW_EXTERN_C();
/** Destroy a HMAC_SHA1 digest handle.
@see rtl_digest_destroy()
*/
void SAL_CALL rtl_digest_destroyHMAC_SHA1 (
rtlDigest Digest
) SAL_THROW_EXTERN_C();
/** Initialize a HMAC_SHA1 digest.
@see rtl_digest_init()
@param Digest [in] digest handle.
@param pKeyData [in] key material buffer.
@param nKeyLen [in] key material length.
@return rtl_Digest_E_None upon success.
*/
rtlDigestError SAL_CALL rtl_digest_initHMAC_SHA1 (
rtlDigest Digest,
const sal_uInt8 *pKeyData, sal_uInt32 nKeyLen
) SAL_THROW_EXTERN_C();
/** Update a HMAC_SHA1 digest with given data.
@see rtl_digest_update()
*/
rtlDigestError SAL_CALL rtl_digest_updateHMAC_SHA1 (
rtlDigest Digest,
const void *pData, sal_uInt32 nDatLen
) SAL_THROW_EXTERN_C();
/** Finalize a HMAC_SHA1 digest and retrieve the digest value.
@see rtl_digest_get()
*/
rtlDigestError SAL_CALL rtl_digest_getHMAC_SHA1 (
rtlDigest Digest,
sal_uInt8 *pBuffer, sal_uInt32 nBufLen
) SAL_THROW_EXTERN_C();
/** Evaluate a HMAC_SHA1 digest value from given data.
@descr This function performs an optimized call sequence on a
single data buffer, avoiding digest creation and destruction.
@see rtl_digest_initHMAC_SHA1()
@see rtl_digest_updateHMAC_SHA1()
@see rtl_digest_getHMAC_SHA1()
@param pKeyData [in] key material buffer.
@param nKeyLen [in] key material length.
@param pData [in] data buffer.
@param nDatLen [in] data length.
@param pBuffer [in] digest value buffer.
@param nBufLen [in] digest value length.
@return rtl_Digest_E_None upon success.
*/
rtlDigestError SAL_CALL rtl_digest_HMAC_SHA1 (
const sal_uInt8 *pKeyData, sal_uInt32 nKeyLen,
const void *pData, sal_uInt32 nDatLen,
sal_uInt8 *pBuffer, sal_uInt32 nBufLen
) SAL_THROW_EXTERN_C();
/*========================================================================
*
* rtl_digest_PBKDF2 interface.
*
*======================================================================*/
/** Password-Based Key Derivation Function.
@descr The PBKDF2 key derivation function is specified in
RFC 2898 (Informational)
PKCS #5: Password-Based Cryptography Specification Version 2.0
@param pKeyData [out] derived key
@param nKeyLen [in] derived key length
@param pPassData [in] password
@param nPassLen [in] password length
@param pSaltData [in] salt
@param nSaltLen [in] salt length
@param nCount [in] iteration count
@return rtl_Digest_E_None upon success.
*/
rtlDigestError SAL_CALL rtl_digest_PBKDF2 (
sal_uInt8 *pKeyData , sal_uInt32 nKeyLen,
const sal_uInt8 *pPassData, sal_uInt32 nPassLen,
const sal_uInt8 *pSaltData, sal_uInt32 nSaltLen,
sal_uInt32 nCount
) SAL_THROW_EXTERN_C();
/*========================================================================
*
* The End.
*
*======================================================================*/
#ifdef __cplusplus
}
#endif
#endif /* _RTL_DIGEST_H_ */
|