xref: /PHP-7.4/ext/hash/php_hash.h (revision c79ce48d)
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: Sara Golemon <pollita@php.net>                               |
16   +----------------------------------------------------------------------+
17 */
18 
19 #ifndef PHP_HASH_H
20 #define PHP_HASH_H
21 
22 #include "php.h"
23 
24 #define PHP_HASH_EXTNAME	"hash"
25 #define PHP_HASH_VERSION	PHP_VERSION
26 #define PHP_MHASH_VERSION	PHP_VERSION
27 
28 #define PHP_HASH_HMAC		0x0001
29 
30 #define L64 INT64_C
31 
32 typedef void (*php_hash_init_func_t)(void *context);
33 typedef void (*php_hash_update_func_t)(void *context, const unsigned char *buf, size_t count);
34 typedef void (*php_hash_final_func_t)(unsigned char *digest, void *context);
35 typedef int  (*php_hash_copy_func_t)(const void *ops, void *orig_context, void *dest_context);
36 
37 typedef struct _php_hash_ops {
38 	php_hash_init_func_t hash_init;
39 	php_hash_update_func_t hash_update;
40 	php_hash_final_func_t hash_final;
41 	php_hash_copy_func_t hash_copy;
42 
43 	size_t digest_size;
44 	size_t block_size;
45 	size_t context_size;
46 	unsigned is_crypto: 1;
47 } php_hash_ops;
48 
49 typedef struct _php_hashcontext_object {
50 	const php_hash_ops *ops;
51 	void *context;
52 
53 	zend_long options;
54 	unsigned char *key;
55 
56 	zend_object std;
57 } php_hashcontext_object;
58 
php_hashcontext_from_object(zend_object * obj)59 static inline php_hashcontext_object *php_hashcontext_from_object(zend_object *obj) {
60 	return ((php_hashcontext_object*)(obj + 1)) - 1;
61 }
62 
63 extern const php_hash_ops php_hash_md2_ops;
64 extern const php_hash_ops php_hash_md4_ops;
65 extern const php_hash_ops php_hash_md5_ops;
66 extern const php_hash_ops php_hash_sha1_ops;
67 extern const php_hash_ops php_hash_sha224_ops;
68 extern const php_hash_ops php_hash_sha256_ops;
69 extern const php_hash_ops php_hash_sha384_ops;
70 extern const php_hash_ops php_hash_sha512_ops;
71 extern const php_hash_ops php_hash_sha512_256_ops;
72 extern const php_hash_ops php_hash_sha512_224_ops;
73 extern const php_hash_ops php_hash_sha3_224_ops;
74 extern const php_hash_ops php_hash_sha3_256_ops;
75 extern const php_hash_ops php_hash_sha3_384_ops;
76 extern const php_hash_ops php_hash_sha3_512_ops;
77 extern const php_hash_ops php_hash_ripemd128_ops;
78 extern const php_hash_ops php_hash_ripemd160_ops;
79 extern const php_hash_ops php_hash_ripemd256_ops;
80 extern const php_hash_ops php_hash_ripemd320_ops;
81 extern const php_hash_ops php_hash_whirlpool_ops;
82 extern const php_hash_ops php_hash_3tiger128_ops;
83 extern const php_hash_ops php_hash_3tiger160_ops;
84 extern const php_hash_ops php_hash_3tiger192_ops;
85 extern const php_hash_ops php_hash_4tiger128_ops;
86 extern const php_hash_ops php_hash_4tiger160_ops;
87 extern const php_hash_ops php_hash_4tiger192_ops;
88 extern const php_hash_ops php_hash_snefru_ops;
89 extern const php_hash_ops php_hash_gost_ops;
90 extern const php_hash_ops php_hash_gost_crypto_ops;
91 extern const php_hash_ops php_hash_adler32_ops;
92 extern const php_hash_ops php_hash_crc32_ops;
93 extern const php_hash_ops php_hash_crc32b_ops;
94 extern const php_hash_ops php_hash_crc32c_ops;
95 extern const php_hash_ops php_hash_fnv132_ops;
96 extern const php_hash_ops php_hash_fnv1a32_ops;
97 extern const php_hash_ops php_hash_fnv164_ops;
98 extern const php_hash_ops php_hash_fnv1a64_ops;
99 extern const php_hash_ops php_hash_joaat_ops;
100 
101 #define PHP_HASH_HAVAL_OPS(p,b)	extern const php_hash_ops php_hash_##p##haval##b##_ops;
102 
103 PHP_HASH_HAVAL_OPS(3,128)
104 PHP_HASH_HAVAL_OPS(3,160)
105 PHP_HASH_HAVAL_OPS(3,192)
106 PHP_HASH_HAVAL_OPS(3,224)
107 PHP_HASH_HAVAL_OPS(3,256)
108 
109 PHP_HASH_HAVAL_OPS(4,128)
110 PHP_HASH_HAVAL_OPS(4,160)
111 PHP_HASH_HAVAL_OPS(4,192)
112 PHP_HASH_HAVAL_OPS(4,224)
113 PHP_HASH_HAVAL_OPS(4,256)
114 
115 PHP_HASH_HAVAL_OPS(5,128)
116 PHP_HASH_HAVAL_OPS(5,160)
117 PHP_HASH_HAVAL_OPS(5,192)
118 PHP_HASH_HAVAL_OPS(5,224)
119 PHP_HASH_HAVAL_OPS(5,256)
120 
121 extern zend_module_entry hash_module_entry;
122 #define phpext_hash_ptr &hash_module_entry
123 
124 #ifdef PHP_WIN32
125 #	define PHP_HASH_API __declspec(dllexport)
126 #elif defined(__GNUC__) && __GNUC__ >= 4
127 #	define PHP_HASH_API __attribute__ ((visibility("default")))
128 #else
129 #	define PHP_HASH_API
130 #endif
131 
132 PHP_FUNCTION(hash);
133 PHP_FUNCTION(hash_file);
134 PHP_FUNCTION(hash_hkdf);
135 PHP_FUNCTION(hash_hmac);
136 PHP_FUNCTION(hash_hmac_file);
137 PHP_FUNCTION(hash_init);
138 PHP_FUNCTION(hash_update);
139 PHP_FUNCTION(hash_update_stream);
140 PHP_FUNCTION(hash_update_file);
141 PHP_FUNCTION(hash_final);
142 PHP_FUNCTION(hash_algos);
143 PHP_FUNCTION(hash_pbkdf2);
144 PHP_FUNCTION(hash_equals);
145 
146 extern PHP_HASH_API zend_class_entry *php_hashcontext_ce;
147 PHP_HASH_API const php_hash_ops *php_hash_fetch_ops(const char *algo, size_t algo_len);
148 PHP_HASH_API void php_hash_register_algo(const char *algo, const php_hash_ops *ops);
149 PHP_HASH_API int php_hash_copy(const void *ops, void *orig_context, void *dest_context);
150 
php_hash_bin2hex(char * out,const unsigned char * in,size_t in_len)151 static inline void php_hash_bin2hex(char *out, const unsigned char *in, size_t in_len)
152 {
153 	static const char hexits[17] = "0123456789abcdef";
154 	size_t i;
155 
156 	for(i = 0; i < in_len; i++) {
157 		out[i * 2]       = hexits[in[i] >> 4];
158 		out[(i * 2) + 1] = hexits[in[i] &  0x0F];
159 	}
160 }
161 
162 #endif	/* PHP_HASH_H */
163