LibreOffice
LibreOffice 7.4 SDK C/C++ API Reference
digest.h
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 
20 /*
21  * This file is part of LibreOffice published API.
22  */
23 
24 #ifndef INCLUDED_RTL_DIGEST_H
25 #define INCLUDED_RTL_DIGEST_H
26 
27 #include "sal/config.h"
28 
29 #include "sal/saldllapi.h"
30 #include "sal/types.h"
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
38 typedef void* rtlDigest;
39 
40 
45 {
50 
53 
56 };
57 
61 
62 
66 {
74 };
75 
79 
80 
88  rtlDigestAlgorithm Algorithm
90 
91 
98  rtlDigest Digest
100 
101 
107  rtlDigest Digest
109 
110 
116  rtlDigest Digest
118 
119 
128  rtlDigest Digest,
129  const sal_uInt8 *pData, sal_uInt32 nDatLen
131 
132 
141  rtlDigest Digest,
142  const void *pData, sal_uInt32 nDatLen
144 
145 
159  rtlDigest Digest,
160  sal_uInt8 *pBuffer, sal_uInt32 nBufLen
162 
163 #define RTL_DIGEST_LENGTH_MD2 16
164 
174 
175 
180  rtlDigest Digest
182 
187  rtlDigest Digest,
188  const void *pData, sal_uInt32 nDatLen
190 
195  rtlDigest Digest,
196  sal_uInt8 *pBuffer, sal_uInt32 nBufLen
198 
215  const void *pData, sal_uInt32 nDatLen,
216  sal_uInt8 *pBuffer, sal_uInt32 nBufLen
218 
219 #define RTL_DIGEST_LENGTH_MD5 16
220 
230 
235  rtlDigest Digest
237 
242  rtlDigest Digest,
243  const void *pData, sal_uInt32 nDatLen
245 
250  rtlDigest Digest,
251  sal_uInt8 *pBuffer, sal_uInt32 nBufLen
253 
263  rtlDigest Digest,
264  sal_uInt8 *pBuffer, sal_uInt32 nBufLen
266 
283  const void *pData, sal_uInt32 nDatLen,
284  sal_uInt8 *pBuffer, sal_uInt32 nBufLen
286 
287 #define RTL_DIGEST_LENGTH_SHA 20
288 
301 
310  rtlDigest Digest
312 
313 
322  rtlDigest Digest,
323  const void *pData, sal_uInt32 nDatLen
325 
334  rtlDigest Digest,
335  sal_uInt8 *pBuffer, sal_uInt32 nBufLen
337 
357  const void *pData, sal_uInt32 nDatLen,
358  sal_uInt8 *pBuffer, sal_uInt32 nBufLen
360 
361 /*========================================================================
362  *
363  * rtl_digest_SHA1 interface.
364  *
365  *======================================================================*/
366 #define RTL_DIGEST_LENGTH_SHA1 20
367 
380 
389  rtlDigest Digest
391 
400  rtlDigest Digest,
401  const void *pData, sal_uInt32 nDatLen
403 
412  rtlDigest Digest,
413  sal_uInt8 *pBuffer, sal_uInt32 nBufLen
415 
435  const void *pData, sal_uInt32 nDatLen,
436  sal_uInt8 *pBuffer, sal_uInt32 nBufLen
438 
439 #define RTL_DIGEST_LENGTH_HMAC_MD5 RTL_DIGEST_LENGTH_MD5
440 
451 
456  rtlDigest Digest
458 
469  rtlDigest Digest,
470  const sal_uInt8 *pKeyData, sal_uInt32 nKeyLen
472 
477  rtlDigest Digest,
478  const void *pData, sal_uInt32 nDatLen
480 
485  rtlDigest Digest,
486  sal_uInt8 *pBuffer, sal_uInt32 nBufLen
488 
508  const sal_uInt8 *pKeyData, sal_uInt32 nKeyLen,
509  const void *pData, sal_uInt32 nDatLen,
510  sal_uInt8 *pBuffer, sal_uInt32 nBufLen
512 
513 #define RTL_DIGEST_LENGTH_HMAC_SHA1 RTL_DIGEST_LENGTH_SHA1
514 
529 
538  rtlDigest Digest
540 
555  rtlDigest Digest,
556  const sal_uInt8 *pKeyData, sal_uInt32 nKeyLen
558 
567  rtlDigest Digest,
568  const void *pData, sal_uInt32 nDatLen
570 
579  rtlDigest Digest,
580  sal_uInt8 *pBuffer, sal_uInt32 nBufLen
582 
605  const sal_uInt8 *pKeyData, sal_uInt32 nKeyLen,
606  const void *pData, sal_uInt32 nDatLen,
607  sal_uInt8 *pBuffer, sal_uInt32 nBufLen
609 
632  sal_uInt8 *pKeyData , sal_uInt32 nKeyLen,
633  const sal_uInt8 *pPassData, sal_uInt32 nPassLen,
634  const sal_uInt8 *pSaltData, sal_uInt32 nSaltLen,
635  sal_uInt32 nCount
637 
638 #ifdef __cplusplus
639 }
640 #endif
641 
642 #endif // INCLUDED_RTL_DIGEST_H
643 
644 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
#define SAL_DLLPUBLIC
Definition: saldllapi.h:34
#define SAL_MAX_ENUM
Definition: types.h:205
unsigned char sal_uInt8
Definition: types.h:44
#define SAL_THROW_EXTERN_C()
Nothrow specification for C functions.
Definition: types.h:334
SAL_DLLPUBLIC void rtl_digest_destroySHA(rtlDigest Digest) SAL_THROW_EXTERN_C()
Destroy a SHA digest handle.
SAL_DLLPUBLIC rtlDigestError rtl_digest_init(rtlDigest Digest, const sal_uInt8 *pData, sal_uInt32 nDatLen) SAL_THROW_EXTERN_C()
Initialize a digest with given data.
SAL_DLLPUBLIC rtlDigestError rtl_digest_MD2(const void *pData, sal_uInt32 nDatLen, sal_uInt8 *pBuffer, sal_uInt32 nBufLen) SAL_THROW_EXTERN_C()
Evaluate a MD2 digest value from given data.
SAL_DLLPUBLIC rtlDigestError rtl_digest_updateSHA1(rtlDigest Digest, const void *pData, sal_uInt32 nDatLen) SAL_THROW_EXTERN_C()
Update a SHA1 digest with given data.
SAL_DLLPUBLIC rtlDigestError rtl_digest_initHMAC_MD5(rtlDigest Digest, const sal_uInt8 *pKeyData, sal_uInt32 nKeyLen) SAL_THROW_EXTERN_C()
Initialize a HMAC_MD5 digest.
SAL_DLLPUBLIC rtlDigest rtl_digest_createHMAC_MD5(void) SAL_THROW_EXTERN_C()
Create a HMAC_MD5 digest handle.
__rtl_DigestError
Error Code enumeration.
Definition: digest.h:66
@ rtl_Digest_E_Argument
Definition: digest.h:68
@ rtl_Digest_E_None
Definition: digest.h:67
@ rtl_Digest_E_Memory
Definition: digest.h:71
@ rtl_Digest_E_Unknown
Definition: digest.h:72
@ rtl_Digest_E_FORCE_EQUAL_SIZE
Definition: digest.h:73
@ rtl_Digest_E_Algorithm
Definition: digest.h:69
@ rtl_Digest_E_BufferSize
Definition: digest.h:70
SAL_DLLPUBLIC rtlDigestError rtl_digest_updateHMAC_SHA1(rtlDigest Digest, const void *pData, sal_uInt32 nDatLen) SAL_THROW_EXTERN_C()
Update a HMAC_SHA1 digest with given data.
SAL_DLLPUBLIC rtlDigest rtl_digest_createHMAC_SHA1(void) SAL_THROW_EXTERN_C()
Create a HMAC_SHA1 digest handle.
SAL_DLLPUBLIC rtlDigestError rtl_digest_MD5(const void *pData, sal_uInt32 nDatLen, sal_uInt8 *pBuffer, sal_uInt32 nBufLen) SAL_THROW_EXTERN_C()
Evaluate a MD5 digest value from given data.
SAL_DLLPUBLIC sal_uInt32 rtl_digest_queryLength(rtlDigest Digest) SAL_THROW_EXTERN_C()
Query the length of a given digest.
enum __rtl_DigestAlgorithm rtlDigestAlgorithm
Digest Algorithm type.
Definition: digest.h:60
SAL_DLLPUBLIC rtlDigestError rtl_digest_updateSHA(rtlDigest Digest, const void *pData, sal_uInt32 nDatLen) SAL_THROW_EXTERN_C()
Update a SHA digest with given data.
SAL_DLLPUBLIC rtlDigest rtl_digest_create(rtlDigestAlgorithm Algorithm) SAL_THROW_EXTERN_C()
Create a digest handle for the given algorithm.
SAL_DLLPUBLIC void rtl_digest_destroy(rtlDigest Digest) SAL_THROW_EXTERN_C()
Destroy a digest handle.
SAL_DLLPUBLIC rtlDigest rtl_digest_createSHA1(void) SAL_THROW_EXTERN_C()
Create a SHA1 digest handle.
SAL_DLLPUBLIC rtlDigestError 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()
Evaluate a HMAC_SHA1 digest value from given data.
SAL_DLLPUBLIC rtlDigestError 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()
Password-Based Key Derivation Function.
SAL_DLLPUBLIC void rtl_digest_destroySHA1(rtlDigest Digest) SAL_THROW_EXTERN_C()
Destroy a SHA1 digest handle.
SAL_DLLPUBLIC rtlDigestError rtl_digest_update(rtlDigest Digest, const void *pData, sal_uInt32 nDatLen) SAL_THROW_EXTERN_C()
Update a digest with given data.
SAL_DLLPUBLIC void rtl_digest_destroyMD2(rtlDigest Digest) SAL_THROW_EXTERN_C()
Destroy a MD2 digest handle.
SAL_DLLPUBLIC rtlDigestError rtl_digest_getSHA1(rtlDigest Digest, sal_uInt8 *pBuffer, sal_uInt32 nBufLen) SAL_THROW_EXTERN_C()
Finalize a SHA1 digest and retrieve the digest value.
SAL_DLLPUBLIC rtlDigest rtl_digest_createSHA(void) SAL_THROW_EXTERN_C()
Create a SHA digest handle.
SAL_DLLPUBLIC rtlDigestError rtl_digest_updateMD5(rtlDigest Digest, const void *pData, sal_uInt32 nDatLen) SAL_THROW_EXTERN_C()
Update a MD5 digest with given data.
SAL_DLLPUBLIC rtlDigest rtl_digest_createMD5(void) SAL_THROW_EXTERN_C()
Create a MD5 digest handle.
SAL_DLLPUBLIC rtlDigestError rtl_digest_updateHMAC_MD5(rtlDigest Digest, const void *pData, sal_uInt32 nDatLen) SAL_THROW_EXTERN_C()
Update a HMAC_MD5 digest with given data.
SAL_DLLPUBLIC rtlDigestError rtl_digest_getMD2(rtlDigest Digest, sal_uInt8 *pBuffer, sal_uInt32 nBufLen) SAL_THROW_EXTERN_C()
Finalize a MD2 digest and retrieve the digest value.
SAL_DLLPUBLIC rtlDigestError rtl_digest_updateMD2(rtlDigest Digest, const void *pData, sal_uInt32 nDatLen) SAL_THROW_EXTERN_C()
Update a MD2 digest with given data.
SAL_DLLPUBLIC rtlDigestError rtl_digest_getSHA(rtlDigest Digest, sal_uInt8 *pBuffer, sal_uInt32 nBufLen) SAL_THROW_EXTERN_C()
Finalize a SHA digest and retrieve the digest value.
SAL_DLLPUBLIC rtlDigestError rtl_digest_getHMAC_MD5(rtlDigest Digest, sal_uInt8 *pBuffer, sal_uInt32 nBufLen) SAL_THROW_EXTERN_C()
Finalize a HMAC_MD5 digest and retrieve the digest value.
SAL_DLLPUBLIC rtlDigestError 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()
Evaluate a HMAC_MD5 digest value from given data.
SAL_DLLPUBLIC rtlDigestError rtl_digest_SHA1(const void *pData, sal_uInt32 nDatLen, sal_uInt8 *pBuffer, sal_uInt32 nBufLen) SAL_THROW_EXTERN_C()
Evaluate a SHA1 digest value from given data.
SAL_DLLPUBLIC rtlDigestError rtl_digest_get(rtlDigest Digest, sal_uInt8 *pBuffer, sal_uInt32 nBufLen) SAL_THROW_EXTERN_C()
Finalize a digest and retrieve the digest value.
SAL_DLLPUBLIC rtlDigestAlgorithm rtl_digest_queryAlgorithm(rtlDigest Digest) SAL_THROW_EXTERN_C()
Query the algorithm of a given digest.
SAL_DLLPUBLIC void rtl_digest_destroyHMAC_SHA1(rtlDigest Digest) SAL_THROW_EXTERN_C()
Destroy a HMAC_SHA1 digest handle.
SAL_DLLPUBLIC void rtl_digest_destroyHMAC_MD5(rtlDigest Digest) SAL_THROW_EXTERN_C()
Destroy a HMAC_MD5 digest handle.
enum __rtl_DigestError rtlDigestError
Error Code type.
Definition: digest.h:78
SAL_DLLPUBLIC void rtl_digest_destroyMD5(rtlDigest Digest) SAL_THROW_EXTERN_C()
Destroy a MD5 digest handle.
SAL_DLLPUBLIC rtlDigestError rtl_digest_initHMAC_SHA1(rtlDigest Digest, const sal_uInt8 *pKeyData, sal_uInt32 nKeyLen) SAL_THROW_EXTERN_C()
Initialize a HMAC_SHA1 digest.
__rtl_DigestAlgorithm
Digest Algorithm enumeration.
Definition: digest.h:45
@ rtl_Digest_AlgorithmHMAC_SHA1
Definition: digest.h:52
@ rtl_Digest_AlgorithmSHA
Definition: digest.h:48
@ rtl_Digest_AlgorithmHMAC_MD5
Definition: digest.h:51
@ rtl_Digest_AlgorithmMD2
Definition: digest.h:46
@ rtl_Digest_AlgorithmMD5
Definition: digest.h:47
@ rtl_Digest_Algorithm_FORCE_EQUAL_SIZE
Definition: digest.h:55
@ rtl_Digest_AlgorithmSHA1
Definition: digest.h:49
@ rtl_Digest_AlgorithmInvalid
Definition: digest.h:54
SAL_DLLPUBLIC rtlDigestError rtl_digest_rawMD5(rtlDigest Digest, sal_uInt8 *pBuffer, sal_uInt32 nBufLen) SAL_THROW_EXTERN_C()
Retrieve the raw (not finalized) MD5 digest value.
SAL_DLLPUBLIC rtlDigestError rtl_digest_getHMAC_SHA1(rtlDigest Digest, sal_uInt8 *pBuffer, sal_uInt32 nBufLen) SAL_THROW_EXTERN_C()
Finalize a HMAC_SHA1 digest and retrieve the digest value.
SAL_DLLPUBLIC rtlDigestError rtl_digest_SHA(const void *pData, sal_uInt32 nDatLen, sal_uInt8 *pBuffer, sal_uInt32 nBufLen) SAL_THROW_EXTERN_C()
Evaluate a SHA digest value from given data.
SAL_DLLPUBLIC rtlDigest rtl_digest_createMD2(void) SAL_THROW_EXTERN_C()
Create a MD2 digest handle.
void * rtlDigest
Digest Handle opaque type.
Definition: digest.h:38
SAL_DLLPUBLIC rtlDigestError rtl_digest_getMD5(rtlDigest Digest, sal_uInt8 *pBuffer, sal_uInt32 nBufLen) SAL_THROW_EXTERN_C()
Finalize a MD5 digest and retrieve the digest value.