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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* 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_CIPHER_H_
#define _RTL_CIPHER_H_
#include <sal/types.h>
#ifdef __cplusplus
extern "C" {
#endif
/*========================================================================
*
* rtlCipher interface.
*
*======================================================================*/
/** Cipher Handle opaque type.
*/
typedef void* rtlCipher;
/** Cipher Algorithm enumeration.
@see rtl_cipher_create()
*/
enum __rtl_CipherAlgorithm
{
rtl_Cipher_AlgorithmBF,
rtl_Cipher_AlgorithmARCFOUR,
rtl_Cipher_AlgorithmInvalid,
rtl_Cipher_Algorithm_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
};
/** Cipher Algorithm type.
*/
typedef enum __rtl_CipherAlgorithm rtlCipherAlgorithm;
/** Cipher Mode enumeration.
@see rtl_cipher_create()
*/
enum __rtl_CipherMode
{
rtl_Cipher_ModeECB,
rtl_Cipher_ModeCBC,
rtl_Cipher_ModeStream,
rtl_Cipher_ModeInvalid,
rtl_Cipher_Mode_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
};
/** Cipher Mode type.
*/
typedef enum __rtl_CipherMode rtlCipherMode;
/** Cipher Direction enumeration.
@see rtl_cipher_init()
*/
enum __rtl_CipherDirection
{
rtl_Cipher_DirectionBoth,
rtl_Cipher_DirectionDecode,
rtl_Cipher_DirectionEncode,
rtl_Cipher_DirectionInvalid,
rtl_Cipher_Direction_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
};
/** Cipher Direction type.
*/
typedef enum __rtl_CipherDirection rtlCipherDirection;
/** Error Code enumeration.
*/
enum __rtl_CipherError
{
rtl_Cipher_E_None,
rtl_Cipher_E_Argument,
rtl_Cipher_E_Algorithm,
rtl_Cipher_E_Direction,
rtl_Cipher_E_Mode,
rtl_Cipher_E_BufferSize,
rtl_Cipher_E_Memory,
rtl_Cipher_E_Unknown,
rtl_Cipher_E_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
};
/** Error Code type.
*/
typedef enum __rtl_CipherError rtlCipherError;
/** Create a cipher handle for the given algorithm and mode.
@see rtlCipherAlgorithm
@see rtlCipherMode
@param Algorithm [in] cipher algorithm.
@param Mode [in] cipher mode.
@return Cipher handle, or 0 upon failure.
*/
rtlCipher SAL_CALL rtl_cipher_create (
rtlCipherAlgorithm Algorithm,
rtlCipherMode Mode
) SAL_THROW_EXTERN_C();
/** Inititialize a cipher for the given direction.
@see rtlCipherDirection
@param Cipher [in] cipher handle.
@param Direction [in] cipher direction.
@param pKeyData [in] key material buffer.
@param nKeyLen [in] key material length in bytes.
@param pArgData [in] initialization vector buffer.
@param nArgLen [in] initialization vector length in bytes.
@return rtl_Cipher_E_None upon success.
*/
rtlCipherError SAL_CALL rtl_cipher_init (
rtlCipher Cipher,
rtlCipherDirection Direction,
const sal_uInt8 *pKeyData, sal_Size nKeyLen,
const sal_uInt8 *pArgData, sal_Size nArgLen
) SAL_THROW_EXTERN_C();
/** Encode a buffer under a given cipher algorithm.
@precond Initialized for a compatible cipher direction.
@see rtl_cipher_init()
@param Cipher [in] cipher handle.
@param pData [in] plaintext buffer.
@param nDatLen [in] plaintext length in bytes.
@param pBuffer [out] ciphertext buffer.
@param nBufLen [in] ciphertext length in bytes.
@return rtl_Cipher_E_None upon success.
*/
rtlCipherError SAL_CALL rtl_cipher_encode (
rtlCipher Cipher,
const void *pData, sal_Size nDatLen,
sal_uInt8 *pBuffer, sal_Size nBufLen
) SAL_THROW_EXTERN_C();
/** Decode a buffer under a given cipher algorithm.
@precond Initialized for a compatible cipher direction.
@see rtl_cipher_init()
@param Cipher [in] cipher handle.
@param pData [in] ciphertext buffer.
@param nDatLen [in] ciphertext length in bytes.
@param pBuffer [out] plaintext buffer.
@param nBufLen [in] plaintext length in bytes.
@return rtl_Cipher_E_None upon success.
*/
rtlCipherError SAL_CALL rtl_cipher_decode (
rtlCipher Cipher,
const void *pData, sal_Size nDatLen,
sal_uInt8 *pBuffer, sal_Size nBufLen
) SAL_THROW_EXTERN_C();
/** Destroy a cipher handle.
@param Cipher [in] cipher handle to be destroyed.
@return None. Cipher handle destroyed and invalid.
*/
void SAL_CALL rtl_cipher_destroy (
rtlCipher Cipher
) SAL_THROW_EXTERN_C();
/*========================================================================
*
* rtl_cipherBF (Blowfish) interface.
*
*======================================================================*/
/** Create a Blowfish cipher handle for the given mode.
@descr The Blowfish block cipher algorithm is specified in
Bruce Schneier: Applied Cryptography, 2nd edition, ch. 14.3
@see rtl_cipher_create()
*/
rtlCipher SAL_CALL rtl_cipher_createBF (
rtlCipherMode Mode
) SAL_THROW_EXTERN_C();
/** Inititialize a Blowfish cipher for the given direction.
@see rtl_cipher_init()
*/
rtlCipherError SAL_CALL rtl_cipher_initBF (
rtlCipher Cipher,
rtlCipherDirection Direction,
const sal_uInt8 *pKeyData, sal_Size nKeyLen,
const sal_uInt8 *pArgData, sal_Size nArgLen
) SAL_THROW_EXTERN_C();
/** Encode a buffer under the Blowfish cipher algorithm.
@see rtl_cipher_encode()
*/
rtlCipherError SAL_CALL rtl_cipher_encodeBF (
rtlCipher Cipher,
const void *pData, sal_Size nDatLen,
sal_uInt8 *pBuffer, sal_Size nBufLen
) SAL_THROW_EXTERN_C();
/** Decode a buffer under the Blowfish cipher algorithm.
@see rtl_cipher_decode()
*/
rtlCipherError SAL_CALL rtl_cipher_decodeBF (
rtlCipher Cipher,
const void *pData, sal_Size nDatLen,
sal_uInt8 *pBuffer, sal_Size nBufLen
) SAL_THROW_EXTERN_C();
/** Destroy a Blowfish cipher handle.
@see rtl_cipher_destroy()
*/
void SAL_CALL rtl_cipher_destroyBF (
rtlCipher Cipher
) SAL_THROW_EXTERN_C();
/*========================================================================
*
* rtl_cipherARCFOUR (RC4) interface.
*
*======================================================================*/
/** Create a RC4 cipher handle for the given mode.
@descr The RC4 symmetric stream cipher algorithm is specified in
Bruce Schneier: Applied Cryptography, 2nd edition, ch. 17.1
@see rtl_cipher_create()
@param Mode [in] cipher mode. Must be rtl_Cipher_ModeStream.
@return Cipher handle, or 0 upon failure.
*/
rtlCipher SAL_CALL rtl_cipher_createARCFOUR (
rtlCipherMode Mode
) SAL_THROW_EXTERN_C();
/** Inititialize a RC4 cipher for the given direction.
@see rtl_cipher_init()
*/
rtlCipherError SAL_CALL rtl_cipher_initARCFOUR (
rtlCipher Cipher,
rtlCipherDirection Direction,
const sal_uInt8 *pKeyData, sal_Size nKeyLen,
const sal_uInt8 *pArgData, sal_Size nArgLen
) SAL_THROW_EXTERN_C();
/** Encode a buffer under the RC4 cipher algorithm.
@see rtl_cipher_encode()
*/
rtlCipherError SAL_CALL rtl_cipher_encodeARCFOUR (
rtlCipher Cipher,
const void *pData, sal_Size nDatLen,
sal_uInt8 *pBuffer, sal_Size nBufLen
) SAL_THROW_EXTERN_C();
/** Decode a buffer under the RC4 cipher algorithm.
@see rtl_cipher_decode()
*/
rtlCipherError SAL_CALL rtl_cipher_decodeARCFOUR (
rtlCipher Cipher,
const void *pData, sal_Size nDatLen,
sal_uInt8 *pBuffer, sal_Size nBufLen
) SAL_THROW_EXTERN_C();
/** Destroy a RC4 cipher handle.
@see rtl_cipher_destroy()
*/
void SAL_CALL rtl_cipher_destroyARCFOUR (
rtlCipher Cipher
) SAL_THROW_EXTERN_C();
/*========================================================================
*
* The End.
*
*======================================================================*/
#ifdef __cplusplus
}
#endif
#endif /* !_RTL_CIPHER_H_ */
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|