mirror of
https://github.com/moparisthebest/curl
synced 2024-08-13 17:03:50 -04:00
![Yang Tse](/assets/img/avatar_default.png)
This commit renames lib/setup.h to lib/curl_setup.h and renames lib/setup_once.h to lib/curl_setup_once.h. Removes the need and usage of a header inclusion guard foreign to libcurl. [1] Removes the need and presence of an alarming notice we carried in old setup_once.h [2] ---------------------------------------- 1 - lib/setup_once.h used __SETUP_ONCE_H macro as header inclusion guard up to commitec691ca3
which changed this to HEADER_CURL_SETUP_ONCE_H, this single inclusion guard is enough to ensure that inclusion of lib/setup_once.h done from lib/setup.h is only done once. Additionally lib/setup.h has always used __SETUP_ONCE_H macro to protect inclusion of setup_once.h even after commitec691ca3
, this was to avoid a circular header inclusion triggered when building a c-ares enabled version with c-ares sources available which also has a setup_once.h header. Commitec691ca3
exposes the real nature of __SETUP_ONCE_H usage in lib/setup.h, it is a header inclusion guard foreign to libcurl belonging to c-ares's setup_once.h The renaming this commit does, fixes the circular header inclusion, and as such removes the need and usage of a header inclusion guard foreign to libcurl. Macro __SETUP_ONCE_H no longer used in libcurl. 2 - Due to the circular interdependency of old lib/setup_once.h and the c-ares setup_once.h header, old file lib/setup_once.h has carried back from 2006 up to now days an alarming and prominent notice about the need of keeping libcurl's and c-ares's setup_once.h in sync. Given that this commit fixes the circular interdependency, the need and presence of mentioned notice is removed. All mentioned interdependencies come back from now old days when the c-ares project lived inside a curl subdirectory. This commit removes last traces of such fact.
249 lines
6.8 KiB
C
249 lines
6.8 KiB
C
/***************************************************************************
|
|
* _ _ ____ _
|
|
* Project ___| | | | _ \| |
|
|
* / __| | | | |_) | |
|
|
* | (__| |_| | _ <| |___
|
|
* \___|\___/|_| \_\_____|
|
|
*
|
|
* Copyright (C) 1998 - 2012, Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
*
|
|
* This software is licensed as described in the file COPYING, which
|
|
* you should have received as part of this distribution. The terms
|
|
* are also available at http://curl.haxx.se/docs/copyright.html.
|
|
*
|
|
* You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
* copies of the Software, and permit persons to whom the Software is
|
|
* furnished to do so, under the terms of the COPYING file.
|
|
*
|
|
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
* KIND, either express or implied.
|
|
*
|
|
***************************************************************************/
|
|
|
|
/* Base64 encoding/decoding */
|
|
|
|
#include "curl_setup.h"
|
|
|
|
#define _MPRINTF_REPLACE /* use our functions only */
|
|
#include <curl/mprintf.h>
|
|
|
|
#include "urldata.h" /* for the SessionHandle definition */
|
|
#include "warnless.h"
|
|
#include "curl_base64.h"
|
|
#include "curl_memory.h"
|
|
#include "non-ascii.h"
|
|
|
|
/* include memdebug.h last */
|
|
#include "memdebug.h"
|
|
|
|
/* ---- Base64 Encoding/Decoding Table --- */
|
|
static const char table64[]=
|
|
"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
|
|
|
|
static void decodeQuantum(unsigned char *dest, const char *src)
|
|
{
|
|
const char *s, *p;
|
|
unsigned long i, v, x = 0;
|
|
|
|
for(i = 0, s = src; i < 4; i++, s++) {
|
|
v = 0;
|
|
p = table64;
|
|
while(*p && (*p != *s)) {
|
|
v++;
|
|
p++;
|
|
}
|
|
if(*p == *s)
|
|
x = (x << 6) + v;
|
|
else if(*s == '=')
|
|
x = (x << 6);
|
|
}
|
|
|
|
dest[2] = curlx_ultouc(x & 0xFFUL);
|
|
x >>= 8;
|
|
dest[1] = curlx_ultouc(x & 0xFFUL);
|
|
x >>= 8;
|
|
dest[0] = curlx_ultouc(x & 0xFFUL);
|
|
}
|
|
|
|
/*
|
|
* Curl_base64_decode()
|
|
*
|
|
* Given a base64 NUL-terminated string at src, decode it and return a
|
|
* pointer in *outptr to a newly allocated memory area holding decoded
|
|
* data. Size of decoded data is returned in variable pointed by outlen.
|
|
*
|
|
* Returns CURLE_OK on success, otherwise specific error code. Function
|
|
* output shall not be considered valid unless CURLE_OK is returned.
|
|
*
|
|
* When decoded data length is 0, returns NULL in *outptr.
|
|
*
|
|
* @unittest: 1302
|
|
*/
|
|
CURLcode Curl_base64_decode(const char *src,
|
|
unsigned char **outptr, size_t *outlen)
|
|
{
|
|
size_t length = 0;
|
|
size_t equalsTerm = 0;
|
|
size_t i;
|
|
size_t numQuantums;
|
|
unsigned char lastQuantum[3];
|
|
size_t rawlen = 0;
|
|
unsigned char *newstr;
|
|
|
|
*outptr = NULL;
|
|
*outlen = 0;
|
|
|
|
while((src[length] != '=') && src[length])
|
|
length++;
|
|
/* A maximum of two = padding characters is allowed */
|
|
if(src[length] == '=') {
|
|
equalsTerm++;
|
|
if(src[length+equalsTerm] == '=')
|
|
equalsTerm++;
|
|
}
|
|
numQuantums = (length + equalsTerm) / 4;
|
|
|
|
/* Don't allocate a buffer if the decoded length is 0 */
|
|
if(numQuantums == 0)
|
|
return CURLE_OK;
|
|
|
|
rawlen = (numQuantums * 3) - equalsTerm;
|
|
|
|
/* The buffer must be large enough to make room for the last quantum
|
|
(which may be partially thrown out) and the zero terminator. */
|
|
newstr = malloc(rawlen+4);
|
|
if(!newstr)
|
|
return CURLE_OUT_OF_MEMORY;
|
|
|
|
*outptr = newstr;
|
|
|
|
/* Decode all but the last quantum (which may not decode to a
|
|
multiple of 3 bytes) */
|
|
for(i = 0; i < numQuantums - 1; i++) {
|
|
decodeQuantum(newstr, src);
|
|
newstr += 3; src += 4;
|
|
}
|
|
|
|
/* This final decode may actually read slightly past the end of the buffer
|
|
if the input string is missing pad bytes. This will almost always be
|
|
harmless. */
|
|
decodeQuantum(lastQuantum, src);
|
|
for(i = 0; i < 3 - equalsTerm; i++)
|
|
newstr[i] = lastQuantum[i];
|
|
|
|
newstr[i] = '\0'; /* zero terminate */
|
|
|
|
*outlen = rawlen; /* return size of decoded data */
|
|
|
|
return CURLE_OK;
|
|
}
|
|
|
|
/*
|
|
* Curl_base64_encode()
|
|
*
|
|
* Given a pointer to an input buffer and an input size, encode it and
|
|
* return a pointer in *outptr to a newly allocated memory area holding
|
|
* encoded data. Size of encoded data is returned in variable pointed by
|
|
* outlen.
|
|
*
|
|
* Input length of 0 indicates input buffer holds a NUL-terminated string.
|
|
*
|
|
* Returns CURLE_OK on success, otherwise specific error code. Function
|
|
* output shall not be considered valid unless CURLE_OK is returned.
|
|
*
|
|
* When encoded data length is 0, returns NULL in *outptr.
|
|
*
|
|
* @unittest: 1302
|
|
*/
|
|
CURLcode Curl_base64_encode(struct SessionHandle *data,
|
|
const char *inputbuff, size_t insize,
|
|
char **outptr, size_t *outlen)
|
|
{
|
|
CURLcode error;
|
|
unsigned char ibuf[3];
|
|
unsigned char obuf[4];
|
|
int i;
|
|
int inputparts;
|
|
char *output;
|
|
char *base64data;
|
|
char *convbuf = NULL;
|
|
|
|
const char *indata = inputbuff;
|
|
|
|
*outptr = NULL;
|
|
*outlen = 0;
|
|
|
|
if(0 == insize)
|
|
insize = strlen(indata);
|
|
|
|
base64data = output = malloc(insize*4/3+4);
|
|
if(NULL == output)
|
|
return CURLE_OUT_OF_MEMORY;
|
|
|
|
/*
|
|
* The base64 data needs to be created using the network encoding
|
|
* not the host encoding. And we can't change the actual input
|
|
* so we copy it to a buffer, translate it, and use that instead.
|
|
*/
|
|
error = Curl_convert_clone(data, indata, insize, &convbuf);
|
|
if(error) {
|
|
free(output);
|
|
return error;
|
|
}
|
|
|
|
if(convbuf)
|
|
indata = (char *)convbuf;
|
|
|
|
while(insize > 0) {
|
|
for(i = inputparts = 0; i < 3; i++) {
|
|
if(insize > 0) {
|
|
inputparts++;
|
|
ibuf[i] = (unsigned char) *indata;
|
|
indata++;
|
|
insize--;
|
|
}
|
|
else
|
|
ibuf[i] = 0;
|
|
}
|
|
|
|
obuf[0] = (unsigned char) ((ibuf[0] & 0xFC) >> 2);
|
|
obuf[1] = (unsigned char) (((ibuf[0] & 0x03) << 4) | \
|
|
((ibuf[1] & 0xF0) >> 4));
|
|
obuf[2] = (unsigned char) (((ibuf[1] & 0x0F) << 2) | \
|
|
((ibuf[2] & 0xC0) >> 6));
|
|
obuf[3] = (unsigned char) (ibuf[2] & 0x3F);
|
|
|
|
switch(inputparts) {
|
|
case 1: /* only one byte read */
|
|
snprintf(output, 5, "%c%c==",
|
|
table64[obuf[0]],
|
|
table64[obuf[1]]);
|
|
break;
|
|
case 2: /* two bytes read */
|
|
snprintf(output, 5, "%c%c%c=",
|
|
table64[obuf[0]],
|
|
table64[obuf[1]],
|
|
table64[obuf[2]]);
|
|
break;
|
|
default:
|
|
snprintf(output, 5, "%c%c%c%c",
|
|
table64[obuf[0]],
|
|
table64[obuf[1]],
|
|
table64[obuf[2]],
|
|
table64[obuf[3]] );
|
|
break;
|
|
}
|
|
output += 4;
|
|
}
|
|
*output = '\0';
|
|
*outptr = base64data; /* return pointer to new data, allocated memory */
|
|
|
|
if(convbuf)
|
|
free(convbuf);
|
|
|
|
*outlen = strlen(base64data); /* return the length of the new data */
|
|
|
|
return CURLE_OK;
|
|
}
|
|
/* ---- End of Base64 Encoding ---- */
|