app_base64.h
17.2 KB
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
/*****************************************************************************
* Copyright Statement:
* --------------------
* This software is protected by Copyright and the information contained
* herein is confidential. The software may not be copied and the information
* contained herein may not be used or disclosed except with the written
* permission of MediaTek Inc. (C) 2005
*
* BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
* THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
* RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
* AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
* NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
* SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
* SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
* THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
* NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
* SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
*
* BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
* LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
* AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
* OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
* MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
*
* THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
* WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
* LAWS PRINCIPLES. ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
* RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
* THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
*
*****************************************************************************/
/*****************************************************************************
*
* Filename:
* ---------
* app_base64.h
*
* Project:
* --------
* MAUI
*
* Description:
* ------------
* This file contains Base64 decode / encode function prototypes.
*
* Author:
* -------
* -------
*
*============================================================================
* HISTORY
* Below this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
*------------------------------------------------------------------------------
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
* removed!
* removed!
* removed!
*
*------------------------------------------------------------------------------
* Upper this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
*============================================================================
****************************************************************************/
#ifndef _APP_BASE64_H
#define _APP_BASE64_H
#include "kal_general_types.h"
/*
* Strem-style encode/decode context,
* To implement the STREAM-STYLE encoding/decoding process,
* one context data structure is defined to remember some information.
* But this context data is used only internally.
*/
typedef struct
{
kal_uint8 buf[4]; /* private data, All the fileds in this structure are absolutely private data, which only will be accessed by BASE64 lib inside. So no detail information about them be here. */
kal_uint8 buf_cnt; /* private data */
kal_uint8 finish_flag;/* private data */
kal_uint8 illchr_flag;/* private data */
kal_uint8 illpad_flag;/* private data */
kal_uint8 wrap_count;/* private data */
kal_uint8 wrap_max;/* private data */
kal_uint8 reserved[2];/* private data */
}applib_base64_part_context;
/*****************************************************************************
* FUNCTION
* applib_base64_encode_basic
* DESCRIPTION
* The applib_base64_encode_basic function encodes a piece of data into BASE64 format.
* PARAMETERS
* src : [IN] Point to the source content buffer to be encoded.
* srcl : [IN] Number of the size of source content buffer to be encoded.
* dst : [IN/OUT] Point to the output buffer of encoded content.
* If the parameter is NULL, the return value will be the needed output buffer size.
* dstl : [IN] Number of the size of output buffer of encoded content.
* If the [dst] parameter is NULL, this parameter will be ignored.
* auto_line_wrap : [IN] Line break (CRLF) will be added after each 76 bytes have been written to output buffer.
* RETURN VALUES
* -1 : It indicates that the given output buffer size is not enough, which SHOULD be avoid.
* >=0 : the number of needed output buffer size OR the number of bytes written to the buffer pointed to by [dst].
*****************************************************************************/
extern kal_int32 applib_base64_encode_basic(
const kal_char *src,
kal_int32 srcl,
kal_char *dst,
kal_int32 dstl,
kal_bool auto_line_wrap);
/*****************************************************************************
* FUNCTION
* applib_base64_decode_basic
* DESCRIPTION
* This function is used to decode Base64 string.
* PARAMETERS
* src : [IN] Pointer to the buffer containing encoded data
* srcl : [IN] Length of the encoded data
* dst : [IN/OUT] Point to the output buffer of decoded content.
* If the parameter is NULL, the return value will be the needed output buffer size.
* Note that the returned value is not accurate; it may be larger than the indeed decoded size.
* dstl : [IN] Length of destination buffer.
* RETURN VALUES
* -1 : It indicates that the given output buffer size is not enough, which should be avoid
* >=0 : The number of needed output buffer size OR the number of bytes written to the buffer pointed to by [dst].
*****************************************************************************/
extern kal_int32 applib_base64_decode_basic(
const kal_char *src,
kal_int32 srcl,
kal_char *dst,
kal_int32 dstl);
/*****************************************************************************
* FUNCTION
* applib_base64_part_encode_init
* DESCRIPTION
* This function initializes the STREAM-STYLE part by part BASE64
* encode process and calculate the needed output buffer size per-part.
* PARAMETERS
* cntx : [IN] point to the applib_base64_part_context
* max_part_buf_size : [IN] the number of MAX input buffer size per-part.
* auto_line_wrap : [IN] Line break (CRLF) will be added after each 76 bytes have been written to output buffer.
* RETURN VALUES
* -1 : Invalid parameter, It the context is NULL
* >= 0 : The MIN output buffer size needed for the per-parts process.
*****************************************************************************/
extern kal_int32 applib_base64_part_encode_init(
applib_base64_part_context *cntx,
kal_int32 max_part_buf_size,
kal_bool auto_line_wrap);
/*****************************************************************************
* FUNCTION
* applib_base64_part_encode_append
* DESCRIPTION
* The applib_base64_part_encode_append function accepts next part of source data, encode them to BASE64 format.
* PARAMETERS
* cntx : [IN] Point to the BASE64 part context.
* src : [IN] Point to the source content buffer to be encoded.
* srcl : [IN/OUT] Point to the number of the size of source content buffer to be encoded, it MUST NOT be NULL, the the number MUST NOT be less than ZERO.
* dst : [IN/OUT] Point to the output buffer of encoded content.
* dstl : [IN] Number of the size of output buffer.
* RETURN VALUES
* -1 : If the context is NULL or it was modified outside, the return value is -1.
* >=0 : If the function succeeds, the return value is the number of bytes written to output buffer, and the [*srcl] indicates how many input buffer was processed. Note that: if the output buffer size is NOT LESS THAN the return value of the applib_base64_part_decode_init function, and the input size buffer is NOT LARGER THAN the [max_part_buf_size] value, the OUT [*srcl] value is always equal to the IN [*src] value, in this case you can ignore the OUT [*srcl] value safely.
*****************************************************************************/
extern kal_int32 applib_base64_part_encode_append(
applib_base64_part_context *cntx,
const kal_char *src,
kal_int32 *srcl,
kal_char *dst,
kal_int32 dstl);
/*****************************************************************************
* FUNCTION
* applib_base64_part_encode_finish
* DESCRIPTION
* The applib_base64_part_encode_finish function finish the part-by-part encode process, encode the last bytes into BASE64 format if there are.
* PARAMETERS
* cntx : [IN] Point to the applib_qprint_context
* dst : [IN/OUT] Point to the output buffer of decoded content.
* dstl : [IN] Number of the size of output buffer of encoded content. It must be larger than 6.
* RETURN VALUES
* >=0 : If the function succeeds, the return value is the number of bytes written to output buffer,
* -1 : If the function failed, the return value is -1 it means the context data was NULL or be changed outsides or the output buffer size is too small.
*****************************************************************************/
extern kal_int32 applib_base64_part_encode_finish(
applib_base64_part_context* cntx,
kal_char *dst,
kal_int32 dstl);
/*****************************************************************************
* FUNCTION
* applib_base64_part_decode_init
* DESCRIPTION
* The applib_base64_part_decode_init function initialize the part by part style BASE64 decode process and calculate the needed output buffer size per-part.
* PARAMETERS
* cntx : [IN] Point to the BASE64 part context.
* max_part_buf_size : [IN] The number of MAX input buffer size per-part.
* RETURN VALUES
* >=0 : If the function succeeds, the return value is the MIN output buffer size needed for the per-part process.
* -1 : If the context is NULL, the return value is -1.
*****************************************************************************/
extern kal_int32 applib_base64_part_decode_init(
applib_base64_part_context *cntx,
kal_int32 max_part_buf_size);
/*****************************************************************************
* FUNCTION
* applib_base64_part_decode_append
* DESCRIPTION
* This function accepts next part of source data;
* decode them from BASE64 format
* PARAMETERS
* cntx : [IN] Point to the BASE64 part context.
* src : [IN] Point to the source content buffer to be decoded.
* srcl : [IN] Point to the number of the size of source content buffer to de encoded.
* dst : [IN/OUT] Point to the output buffer of decoded content.
* dstl : [IN] Number of the size of output buffer.
* RETURN VALUES
* >=0 : If the function succeeds, the return value is the number of bytes written to output buffer. and the [*srcl] indicates how many input buffer was processed. Note that: if the output buffer size is NOT LESS THAN the return value of the applib_base64_part_decode_init function, and the input size buffer is NOT LARGER THAN the [max_part_buf_size] value, the OUT [*srcl] value is always equal to the IN [*src] value
* -1 : It the context is NULL or modified outside, the return value is -1.
*****************************************************************************/
extern kal_int32 applib_base64_part_decode_append(
applib_base64_part_context* cntx,
const kal_char *src,
kal_int32 *srcl,
kal_char *dst,
kal_int32 dstl);
/*****************************************************************************
* FUNCTION
* applib_base64_part_decode_finish
* DESCRIPTION
* This function finishes the part-by-part decoding process.
* PARAMETERS
* cntx : [IN] Point to the BASE64 part context.
* illegal_format : [IN/OUT] Point to the illegal format flag, if you can ignore this safely, you can set it NULL.
* RETURN VALUES
* 0 : If the function succeeds, the return value is 0. if illegal character or invalid pad character was found during the process, and the [illegal_format] is NOT NULL, the [illegal_format] will be set as TRUE.
* -1 : If the context is NULL or modified outside, the return value is -1.
*****************************************************************************/
extern kal_int32 applib_base64_part_decode_finish(
applib_base64_part_context* cntx,
kal_bool* illegal_format);
/* DOM-NOT_FOR_SDK-BEGIN */
/*
* NOTE:
* the APIs below will be obsoleted
* them are here only for compatible with old code
*/
/*****************************************************************************
* FUNCTION
* applib_base64_decode
* DESCRIPTION
* This function is used to decode Base64 string.
* PARAMETERS
* src : [IN] Point to the source content buffer to be decoded.
* srcl : [IN] Number of the size of source content buffer to be decoded.
* dest : [IN/OUT] Point to the output buffer of decoded content.
* destl: [IN] Number of the size of output buffer of encoded content.
* If the [dst] parameter is NULL, this parameter will be ignored.
* RETURN VALUES
* >=0 : Success: the return value is the number of bytes written to dst. Not include the null terminator.
* -1 : Failure: -1. meaning the output buffer size is not enough.
*****************************************************************************/
extern kal_int32 applib_base64_decode(kal_char *src, kal_uint32 srcl, kal_char *dest, kal_uint32 destl);
/*****************************************************************************
* FUNCTION
* applib_base64_decode_len
* DESCRIPTION
* This function return the needed output buffer size for applib_base64_decode function
* PARAMETERS
* str : [IN] Input content which are BASE64 encoded.
* len : [IN] The input content size in bytes
* RETURNS
* The needed output buffer size for applib_base64_decode function
*****************************************************************************/
extern kal_uint32 applib_base64_decode_len(const kal_char *str, kal_uint32 len);
/*****************************************************************************
* FUNCTION
* applib_find_base64_boundary
* DESCRIPTION
* This function finds the boundary in the base64 encoded text.
* PARAMETERS
* ptr : [IN] Point to content which are BASE64 encoded.
* len : [IN] The input content size in bytes
* RETURNS
* remained bytes after the last line break.
*****************************************************************************/
extern kal_uint16 applib_find_base64_boundary(kal_char *ptr, kal_int32 len);
/*****************************************************************************
* FUNCTION
* applib_base64_encode
* DESCRIPTION
* This function is used to encode given string into base64 encoded string.
* PARAMETERS
* src : [IN] Point to the source content buffer to be encoded.
* srcl : [IN] Number of the size of source content buffer to be encoded.
* dest : [IN/OUT] Point to the output buffer of encoded content.
* destl : [IN] Number of the size of output buffer of encoded content.
* RETURN VALUES
* >=0 : If the function succeeds, the return value is the number of bytes written to output buffer, not including the null-terminator.
* -1 : If the function fails, the return value is -1.It indicates that the given output buffer size is not enough.
*****************************************************************************/
extern kal_int32 applib_base64_encode(kal_char *src, kal_uint32 srcl, kal_char *dest, kal_uint32 destl);
/*****************************************************************************
* FUNCTION
* applib_base64_encode_len
* DESCRIPTION
* This function is used to calculate converted base64 string length
* PARAMETERS
* len : [IN] The input content size in bytes
* RETURNS
* The needed output buffer size for applib_base64_encode function
*****************************************************************************/
extern kal_uint32 applib_base64_encode_len(kal_uint32 len);
/* DOM-NOT_FOR_SDK-END */
#endif /* _APP_BASE64_H */