xref: /PHP-7.4/ext/standard/base64.h (revision 3b73c9fb)
1 /*
2    +----------------------------------------------------------------------+
3    | PHP Version 7                                                        |
4    +----------------------------------------------------------------------+
5    | Copyright (c) The PHP Group                                          |
6    +----------------------------------------------------------------------+
7    | This source file is subject to version 3.01 of the PHP license,      |
8    | that is bundled with this package in the file LICENSE, and is        |
9    | available through the world-wide-web at the following url:           |
10    | http://www.php.net/license/3_01.txt                                  |
11    | If you did not receive a copy of the PHP license and are unable to   |
12    | obtain it through the world-wide-web, please send a note to          |
13    | license@php.net so we can mail you a copy immediately.               |
14    +----------------------------------------------------------------------+
15    | Author: Jim Winstead <jimw@php.net>                                  |
16    |         Xinchen Hui <laruence@php.net>                               |
17    +----------------------------------------------------------------------+
18 */
19 
20 #ifndef BASE64_H
21 #define BASE64_H
22 
23 /*
24  * NEON implementation is based on https://github.com/WojciechMula/base64simd
25  * which is copyrighted to:
26  * Copyright (c) 2015-2018, Wojciech Mula
27  * All rights reserved.
28  *
29  * SSSE3 and AVX2 implementation are based on https://github.com/aklomp/base64
30  * which is copyrighted to:
31  *
32  * Copyright (c) 2005-2007, Nick Galbreath
33  * Copyright (c) 2013-2017, Alfred Klomp
34  * Copyright (c) 2015-2017, Wojciech Mula
35  * Copyright (c) 2016-2017, Matthieu Darbois
36  * All rights reserved.
37  *
38  * Redistribution and use in source and binary forms, with or without
39  * modification, are permitted provided that the following conditions are
40  * met:
41  *
42  * - Redistributions of source code must retain the above copyright notice,
43  *   this list of conditions and the following disclaimer.
44  *
45  * - Redistributions in binary form must reproduce the above copyright
46  *   notice, this list of conditions and the following disclaimer in the
47  *   documentation and/or other materials provided with the distribution.
48  *
49  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
50  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
51  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
52  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
53  * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
54  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
55  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
56  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
57  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
58  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
59  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
60  */
61 
62 PHP_FUNCTION(base64_decode);
63 PHP_FUNCTION(base64_encode);
64 
65 #if (ZEND_INTRIN_AVX2_FUNC_PTR || ZEND_INTRIN_SSSE3_FUNC_PTR) && !ZEND_INTRIN_AVX2_NATIVE
66 PHP_MINIT_FUNCTION(base64_intrin);
67 #endif
68 
69 PHPAPI extern zend_string *php_base64_encode(const unsigned char *, size_t);
70 PHPAPI extern zend_string *php_base64_decode_ex(const unsigned char *, size_t, zend_bool);
71 
php_base64_encode_str(const zend_string * str)72 static inline zend_string *php_base64_encode_str(const zend_string *str) {
73 	return php_base64_encode((const unsigned char*)(ZSTR_VAL(str)), ZSTR_LEN(str));
74 }
75 
php_base64_decode(const unsigned char * str,size_t len)76 static inline zend_string *php_base64_decode(const unsigned char *str, size_t len) {
77 	return php_base64_decode_ex(str, len, 0);
78 }
php_base64_decode_str(const zend_string * str)79 static inline zend_string *php_base64_decode_str(const zend_string *str) {
80 	return php_base64_decode_ex((const unsigned char*)(ZSTR_VAL(str)), ZSTR_LEN(str), 0);
81 }
82 
83 #endif /* BASE64_H */
84