CppCMS/base64.h

///////////////////////////////////////////////////////////////////////////////
//                                                                             
//  Copyright (C) 2008-2010  Artyom Beilis (Tonkikh) <artyomtnk@yahoo.com>     
//                                                                             
//  This program is free software: you can redistribute it and/or modify       
//  it under the terms of the GNU Lesser General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
//
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU Lesser General Public License for more details.
//
//  You should have received a copy of the GNU Lesser General Public License
//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
//
///////////////////////////////////////////////////////////////////////////////
#ifndef CPPCMS_BASE64_H
#define CPPCMS_BASE64_H

#include "defs.h"
#include <string>


namespace cppcms {
	/// 
	/// \brief this namespace provides functions useful for modified Base64 encoding for URL.
	/// This encoding does not insert newline characters, do not pad the text with = character and
	/// use "_" and "-" instead of "+" and "/" characters reserved by URL format for special purposes.
	///
namespace b64url {
	
	///
	/// Calculate required buffer size of base64-url compatible encoding for source of size \a s
	///
	int CPPCMS_API encoded_size(size_t s);
	///
	/// Calculate required buffer size of base64-url compatible decoding for source of size \a s
	///
	/// Note, if original size is invalid, negative value is returned
	///
	int CPPCMS_API decoded_size(size_t s);

	///
	/// Perform base64 URL encoding of the binary data in range [\a begin,\a end), and store it to output buffer
	/// \a target. The size of target storage should have a capacity calculated with encoded_size(end-begin).
	///
	/// Pointer to the first character directly after text string ends is returned.
	///
	unsigned char CPPCMS_API *encode(unsigned char const *begin,unsigned char const *end,unsigned char *target);

	///
	/// Perform base64 URL decoding of the binary data in range [\a begin,\a end), and store it to output buffer
	/// \a target. The size of target storage should have a capacity calculated with encoded_size(end-begin).
	///
	/// Pointer to the first character directly after text string ends is returned. Invalid codes are substituted
	/// by 0 values.
	///
	///
	unsigned char CPPCMS_API *decode(unsigned char const *begin,unsigned char const *end,unsigned char *target);
}
}


#endif