OLD | NEW |
| (Empty) |
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ | |
2 /* | |
3 * The contents of this file are subject to the Mozilla Public | |
4 * License Version 1.1 (the "License"); you may not use this file | |
5 * except in compliance with the License. You may obtain a copy of | |
6 * the License at http://www.mozilla.org/MPL/ | |
7 * | |
8 * Software distributed under the License is distributed on an "AS | |
9 * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or | |
10 * implied. See the License for the specific language governing | |
11 * rights and limitations under the License. | |
12 * | |
13 * The Original Code is the Netscape Portable Runtime (NSPR). | |
14 * | |
15 * The Initial Developer of the Original Code is Netscape | |
16 * Communications Corporation. Portions created by Netscape are | |
17 * Copyright (C) 1998-2000 Netscape Communications Corporation. All | |
18 * Rights Reserved. | |
19 * | |
20 * Contributor(s): | |
21 * | |
22 * Alternatively, the contents of this file may be used under the | |
23 * terms of the GNU General Public License Version 2 or later (the | |
24 * "GPL"), in which case the provisions of the GPL are applicable | |
25 * instead of those above. If you wish to allow use of your | |
26 * version of this file only under the terms of the GPL and not to | |
27 * allow others to use your version of this file under the MPL, | |
28 * indicate your decision by deleting the provisions above and | |
29 * replace them with the notice and other provisions required by | |
30 * the GPL. If you do not delete the provisions above, a recipient | |
31 * may use your version of this file under either the MPL or the | |
32 * GPL. | |
33 */ | |
34 | |
35 #ifndef _plbase64_h | |
36 #define _plbase64_h | |
37 | |
38 #include "prtypes.h" | |
39 | |
40 PR_BEGIN_EXTERN_C | |
41 | |
42 /* | |
43 * PL_Base64Encode | |
44 * | |
45 * This routine encodes the data pointed to by the "src" parameter using the | |
46 * base64 algorithm, and returns a pointer to the result. If the "srclen" | |
47 * parameter is not zero, it specifies the length of the source data. If it | |
48 * is zero, the source data is assumed to be null-terminated, and PL_strlen | |
49 * is used to determine the source length. If the "dest" parameter is not | |
50 * null, it is assumed to point to a buffer of sufficient size (which may be | |
51 * calculated: ((srclen + 2)/3)*4) into which the encoded data is placed | |
52 * (without any termination). If the "dest" parameter is null, a buffer is | |
53 * allocated from the heap to hold the encoded data, and the result *will* | |
54 * be terminated with an extra null character. It is the caller's | |
55 * responsibility to free the result when it is allocated. A null is returned | |
56 * if the allocation fails. | |
57 */ | |
58 | |
59 PR_EXTERN(char *) | |
60 PL_Base64Encode | |
61 ( | |
62 const char *src, | |
63 PRUint32 srclen, | |
64 char *dest | |
65 ); | |
66 | |
67 /* | |
68 * PL_Base64Decode | |
69 * | |
70 * This routine decodes the data pointed to by the "src" parameter using | |
71 * the base64 algorithm, and returns a pointer to the result. The source | |
72 * may either include or exclude any trailing '=' characters. If the | |
73 * "srclen" parameter is not zero, it specifies the length of the source | |
74 * data. If it is zero, PL_strlen will be used to determine the source | |
75 * length. If the "dest" parameter is not null, it is assumed to point to | |
76 * a buffer of sufficient size (which may be calculated: (srclen * 3)/4 | |
77 * when srclen includes the '=' characters) into which the decoded data | |
78 * is placed (without any termination). If the "dest" parameter is null, | |
79 * a buffer is allocated from the heap to hold the decoded data, and the | |
80 * result *will* be terminated with an extra null character. It is the | |
81 * caller's responsibility to free the result when it is allocated. A null | |
82 * is retuned if the allocation fails, or if the source is not well-coded. | |
83 */ | |
84 | |
85 PR_EXTERN(char *) | |
86 PL_Base64Decode | |
87 ( | |
88 const char *src, | |
89 PRUint32 srclen, | |
90 char *dest | |
91 ); | |
92 | |
93 PR_END_EXTERN_C | |
94 | |
95 #endif /* _plbase64_h */ | |
OLD | NEW |