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
|
/** @file
* IPRT - Base64, MIME content transfer encoding.
*/
/*
* Copyright (C) 2009-2010 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*/
#ifndef ___iprt_base64_h
#define ___iprt_base64_h
#include <iprt/types.h>
RT_C_DECLS_BEGIN
/** @defgroup grp_rt_base64 RTBase64 - Base64, MIME content transfer encoding.
* @ingroup grp_rt
* @{
*/
/** @def RTBASE64_EOL_SIZE
* The size of the end-of-line marker. */
#if defined(RT_OS_OS2) || defined(RT_OS_WINDOWS)
# define RTBASE64_EOL_SIZE (sizeof("\r\n") - 1)
#else
# define RTBASE64_EOL_SIZE (sizeof("\n") - 1)
#endif
/**
* Calculates the decoded data size for a Base64 encoded string.
*
* @returns The length in bytes. -1 if the encoding is bad.
*
* @param pszString The Base64 encoded string.
* @param ppszEnd If not NULL, this will point to the first char
* following the Base64 encoded text block. If
* NULL the entire string is assumed to be Base64.
*/
RTDECL(ssize_t) RTBase64DecodedSize(const char *pszString, char **ppszEnd);
/**
* Decodes a Base64 encoded string into the buffer supplied by the caller.
*
* @returns IPRT status code.
* @retval VERR_BUFFER_OVERFLOW if the buffer is too small. pcbActual will not
* be set, nor will ppszEnd.
* @retval VERR_INVALID_BASE64_ENCODING if the encoding is wrong.
*
* @param pszString The Base64 string. Whether the entire string or
* just the start of the string is in Base64 depends
* on whether ppszEnd is specified or not.
* @param pvData Where to store the decoded data.
* @param cbData The size of the output buffer that pvData points to.
* @param pcbActual Where to store the actual number of bytes returned.
* Optional.
* @param ppszEnd Indicates that the string may contain other stuff
* after the Base64 encoded data when not NULL. Will
* be set to point to the first char that's not part of
* the encoding. If NULL the entire string must be part
* of the Base64 encoded data.
*/
RTDECL(int) RTBase64Decode(const char *pszString, void *pvData, size_t cbData, size_t *pcbActual, char **ppszEnd);
/**
* Calculates the length of the Base64 encoding of a given number of bytes of
* data.
*
* This will assume line breaks every 64 chars. A RTBase64EncodedLengthEx
* function can be added if closer control over the output is found to be
* required.
*
* @returns The Base64 string length.
* @param cbData The number of bytes to encode.
*/
RTDECL(size_t) RTBase64EncodedLength(size_t cbData);
/**
* Encodes the specifed data into a Base64 string, the caller supplies the
* output buffer.
*
* This will make the same assumptions about line breaks and EOL size as
* RTBase64EncodedLength() does. A RTBase64EncodeEx function can be added if
* more strict control over the output formatting is found necessary.
*
* @returns IRPT status code.
* @retval VERR_BUFFER_OVERFLOW if the output buffer is too small. The buffer
* may contain an invalid Base64 string.
*
* @param pvData The data to encode.
* @param cbData The number of bytes to encode.
* @param pszBuf Where to put the Base64 string.
* @param cbBuf The size of the output buffer, including the terminator.
* @param pcchActual The actual number of characters returned.
*/
RTDECL(int) RTBase64Encode(const void *pvData, size_t cbData, char *pszBuf, size_t cbBuf, size_t *pcchActual);
/** @} */
RT_C_DECLS_END
#endif
|
