| 1 | /** @file
|
|---|
| 2 | * IPRT - Base64, MIME content transfer encoding.
|
|---|
| 3 | */
|
|---|
| 4 |
|
|---|
| 5 | /*
|
|---|
| 6 | * Copyright (C) 2009 Oracle Corporation
|
|---|
| 7 | *
|
|---|
| 8 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 9 | * available from http://www.virtualbox.org. This file is free software;
|
|---|
| 10 | * you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 11 | * General Public License (GPL) as published by the Free Software
|
|---|
| 12 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
|---|
| 13 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
|---|
| 14 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 15 | *
|
|---|
| 16 | * The contents of this file may alternatively be used under the terms
|
|---|
| 17 | * of the Common Development and Distribution License Version 1.0
|
|---|
| 18 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
|---|
| 19 | * VirtualBox OSE distribution, in which case the provisions of the
|
|---|
| 20 | * CDDL are applicable instead of those of the GPL.
|
|---|
| 21 | *
|
|---|
| 22 | * You may elect to license modified versions of this file under the
|
|---|
| 23 | * terms and conditions of either the GPL or the CDDL or both.
|
|---|
| 24 | */
|
|---|
| 25 |
|
|---|
| 26 | #ifndef ___iprt_base64_h
|
|---|
| 27 | #define ___iprt_base64_h
|
|---|
| 28 |
|
|---|
| 29 | #include <iprt/types.h>
|
|---|
| 30 |
|
|---|
| 31 | RT_C_DECLS_BEGIN
|
|---|
| 32 |
|
|---|
| 33 | /** @defgroup grp_rt_base64 RTBase64 - Base64, MIME content transfer encoding.
|
|---|
| 34 | * @ingroup grp_rt
|
|---|
| 35 | * @{
|
|---|
| 36 | */
|
|---|
| 37 |
|
|---|
| 38 | /** @def RTBASE64_EOL_SIZE
|
|---|
| 39 | * The size of the end-of-line marker. */
|
|---|
| 40 | #if defined(RT_OS_OS2) || defined(RT_OS_WINDOWS)
|
|---|
| 41 | # define RTBASE64_EOL_SIZE (sizeof("\r\n") - 1)
|
|---|
| 42 | #else
|
|---|
| 43 | # define RTBASE64_EOL_SIZE (sizeof("\n") - 1)
|
|---|
| 44 | #endif
|
|---|
| 45 |
|
|---|
| 46 | /**
|
|---|
| 47 | * Calculates the decoded data size for a Base64 encoded string.
|
|---|
| 48 | *
|
|---|
| 49 | * @returns The length in bytes. -1 if the encoding is bad.
|
|---|
| 50 | *
|
|---|
| 51 | * @param pszString The Base64 encoded string.
|
|---|
| 52 | * @param ppszEnd If not NULL, this will point to the first char
|
|---|
| 53 | * following the Base64 encoded text block. If
|
|---|
| 54 | * NULL the entire string is assumed to be Base64.
|
|---|
| 55 | */
|
|---|
| 56 | RTDECL(ssize_t) RTBase64DecodedSize(const char *pszString, char **ppszEnd);
|
|---|
| 57 |
|
|---|
| 58 | /**
|
|---|
| 59 | * Decodes a Base64 encoded string into the buffer supplied by the caller.
|
|---|
| 60 | *
|
|---|
| 61 | * @returns IPRT status code.
|
|---|
| 62 | * @retval VERR_BUFFER_OVERFLOW if the buffer is too small. pcbActual will not
|
|---|
| 63 | * be set, nor will ppszEnd.
|
|---|
| 64 | * @retval VERR_INVALID_BASE64_ENCODING if the encoding is wrong.
|
|---|
| 65 | *
|
|---|
| 66 | * @param pszString The Base64 string. Whether the entire string or
|
|---|
| 67 | * just the start of the string is in Base64 depends
|
|---|
| 68 | * on whether ppszEnd is specified or not.
|
|---|
| 69 | * @param pvData Where to store the decoded data.
|
|---|
| 70 | * @param cbData The size of the output buffer that pvData points to.
|
|---|
| 71 | * @param pcbActual Where to store the actual number of bytes returned.
|
|---|
| 72 | * Optional.
|
|---|
| 73 | * @param ppszEnd Indicates that the string may contain other stuff
|
|---|
| 74 | * after the Base64 encoded data when not NULL. Will
|
|---|
| 75 | * be set to point to the first char that's not part of
|
|---|
| 76 | * the encoding. If NULL the entire string must be part
|
|---|
| 77 | * of the Base64 encoded data.
|
|---|
| 78 | */
|
|---|
| 79 | RTDECL(int) RTBase64Decode(const char *pszString, void *pvData, size_t cbData, size_t *pcbActual, char **ppszEnd);
|
|---|
| 80 |
|
|---|
| 81 | /**
|
|---|
| 82 | * Calculates the length of the Base64 encoding of a given number of bytes of
|
|---|
| 83 | * data.
|
|---|
| 84 | *
|
|---|
| 85 | * This will assume line breaks every 64 chars. A RTBase64EncodedLengthEx
|
|---|
| 86 | * function can be added if closer control over the output is found to be
|
|---|
| 87 | * required.
|
|---|
| 88 | *
|
|---|
| 89 | * @returns The Base64 string length.
|
|---|
| 90 | * @param cbData The number of bytes to encode.
|
|---|
| 91 | */
|
|---|
| 92 | RTDECL(size_t) RTBase64EncodedLength(size_t cbData);
|
|---|
| 93 |
|
|---|
| 94 | /**
|
|---|
| 95 | * Encodes the specifed data into a Base64 string, the caller supplies the
|
|---|
| 96 | * output buffer.
|
|---|
| 97 | *
|
|---|
| 98 | * This will make the same assumptions about line breaks and EOL size as
|
|---|
| 99 | * RTBase64EncodedLength() does. A RTBase64EncodeEx function can be added if
|
|---|
| 100 | * more strict control over the output formatting is found necessary.
|
|---|
| 101 | *
|
|---|
| 102 | * @returns IRPT status code.
|
|---|
| 103 | * @retval VERR_BUFFER_OVERFLOW if the output buffer is too small. The buffer
|
|---|
| 104 | * may contain an invalid Base64 string.
|
|---|
| 105 | *
|
|---|
| 106 | * @param pvData The data to encode.
|
|---|
| 107 | * @param cbData The number of bytes to encode.
|
|---|
| 108 | * @param pszBuf Where to put the Base64 string.
|
|---|
| 109 | * @param cbBuf The size of the output buffer, including the terminator.
|
|---|
| 110 | * @param pcchActual The actual number of characters returned.
|
|---|
| 111 | */
|
|---|
| 112 | RTDECL(int) RTBase64Encode(const void *pvData, size_t cbData, char *pszBuf, size_t cbBuf, size_t *pcchActual);
|
|---|
| 113 |
|
|---|
| 114 | /** @} */
|
|---|
| 115 |
|
|---|
| 116 | RT_C_DECLS_END
|
|---|
| 117 |
|
|---|
| 118 | #endif
|
|---|
| 119 |
|
|---|
