1 /* $Id$ */ 2 /* 3 * Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com) 4 * Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org> 5 * 6 * This program is free software; you can redistribute it and/or modify 7 * it under the terms of the GNU General Public License as published by 8 * the Free Software Foundation; either version 2 of the License, or 9 * (at your option) any later version. 10 * 11 * This program is distributed in the hope that it will be useful, 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 * GNU General Public License for more details. 15 * 16 * You should have received a copy of the GNU General Public License 17 * along with this program; if not, write to the Free Software 18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 19 */ 20 #ifndef __PJLIB_UTIL_BASE64_H__ 21 #define __PJLIB_UTIL_BASE64_H__ 22 23 /** 24 * @file base64.h 25 * @brief Base64 encoding and decoding 26 */ 27 28 #include <pjlib-util/types.h> 29 30 PJ_BEGIN_DECL 31 32 /** 33 * @defgroup PJLIB_UTIL_BASE64 Base64 Encoding/Decoding 34 * @ingroup PJLIB_UTIL_ENCRYPTION 35 * @{ 36 * This module implements base64 encoding and decoding. 37 */ 38 39 /** 40 * Helper macro to calculate the approximate length required for base256 to 41 * base64 conversion. 42 */ 43 #define PJ_BASE256_TO_BASE64_LEN(len) (len * 4 / 3 + 3) 44 45 /** 46 * Helper macro to calculate the approximage length required for base64 to 47 * base256 conversion. 48 */ 49 #define PJ_BASE64_TO_BASE256_LEN(len) (len * 3 / 4) 50 51 52 /** 53 * Encode a buffer into base64 encoding. 54 * 55 * @param input The input buffer. 56 * @param in_len Size of the input buffer. 57 * @param output Output buffer. Caller must allocate this buffer with 58 * the appropriate size. 59 * @param out_len On entry, it specifies the length of the output buffer. 60 * Upon return, this will be filled with the actual 61 * length of the output buffer. 62 * 63 * @return PJ_SUCCESS on success. 64 */ 65 PJ_DECL(pj_status_t) pj_base64_encode(const pj_uint8_t *input, int in_len, 66 char *output, int *out_len); 67 68 69 /** 70 * Decode base64 string. 71 * 72 * @param input Input string. 73 * @param out Buffer to store the output. Caller must allocate 74 * this buffer with the appropriate size. 75 * @param out_len On entry, it specifies the length of the output buffer. 76 * Upon return, this will be filled with the actual 77 * length of the output. 78 */ 79 PJ_DECL(pj_status_t) pj_base64_decode(const pj_str_t *input, 80 pj_uint8_t *out, int *out_len); 81 82 83 84 /** 85 * @} 86 */ 87 88 PJ_END_DECL 89 90 91 #endif /* __PJLIB_UTIL_BASE64_H__ */ 92 93