php_hash.h 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172
  1. /*
  2. +----------------------------------------------------------------------+
  3. | Copyright (c) The PHP Group |
  4. +----------------------------------------------------------------------+
  5. | This source file is subject to version 3.01 of the PHP license, |
  6. | that is bundled with this package in the file LICENSE, and is |
  7. | available through the world-wide-web at the following url: |
  8. | https://www.php.net/license/3_01.txt |
  9. | If you did not receive a copy of the PHP license and are unable to |
  10. | obtain it through the world-wide-web, please send a note to |
  11. | license@php.net so we can mail you a copy immediately. |
  12. +----------------------------------------------------------------------+
  13. | Author: Sara Golemon <pollita@php.net> |
  14. +----------------------------------------------------------------------+
  15. */
  16. #ifndef PHP_HASH_H
  17. #define PHP_HASH_H
  18. #include "php.h"
  19. #define PHP_HASH_EXTNAME "hash"
  20. #define PHP_HASH_VERSION PHP_VERSION
  21. #define PHP_MHASH_VERSION PHP_VERSION
  22. #define PHP_HASH_HMAC 0x0001
  23. #define PHP_HASH_SERIALIZE_MAGIC_SPEC 2
  24. #define L64 INT64_C
  25. typedef struct _php_hashcontext_object php_hashcontext_object;
  26. typedef void (*php_hash_init_func_t)(void *context, HashTable *args);
  27. typedef void (*php_hash_update_func_t)(void *context, const unsigned char *buf, size_t count);
  28. typedef void (*php_hash_final_func_t)(unsigned char *digest, void *context);
  29. typedef int (*php_hash_copy_func_t)(const void *ops, void *orig_context, void *dest_context);
  30. typedef int (*php_hash_serialize_func_t)(const php_hashcontext_object *hash, zend_long *magic, zval *zv);
  31. typedef int (*php_hash_unserialize_func_t)(php_hashcontext_object *hash, zend_long magic, const zval *zv);
  32. typedef struct _php_hash_ops {
  33. const char *algo;
  34. php_hash_init_func_t hash_init;
  35. php_hash_update_func_t hash_update;
  36. php_hash_final_func_t hash_final;
  37. php_hash_copy_func_t hash_copy;
  38. php_hash_serialize_func_t hash_serialize;
  39. php_hash_unserialize_func_t hash_unserialize;
  40. const char *serialize_spec;
  41. size_t digest_size;
  42. size_t block_size;
  43. size_t context_size;
  44. unsigned is_crypto: 1;
  45. } php_hash_ops;
  46. struct _php_hashcontext_object {
  47. const php_hash_ops *ops;
  48. void *context;
  49. zend_long options;
  50. unsigned char *key;
  51. zend_object std;
  52. };
  53. static inline php_hashcontext_object *php_hashcontext_from_object(zend_object *obj) {
  54. return ((php_hashcontext_object*)(obj + 1)) - 1;
  55. }
  56. extern const php_hash_ops php_hash_md2_ops;
  57. extern const php_hash_ops php_hash_md4_ops;
  58. extern const php_hash_ops php_hash_md5_ops;
  59. extern const php_hash_ops php_hash_sha1_ops;
  60. extern const php_hash_ops php_hash_sha224_ops;
  61. extern const php_hash_ops php_hash_sha256_ops;
  62. extern const php_hash_ops php_hash_sha384_ops;
  63. extern const php_hash_ops php_hash_sha512_ops;
  64. extern const php_hash_ops php_hash_sha512_256_ops;
  65. extern const php_hash_ops php_hash_sha512_224_ops;
  66. extern const php_hash_ops php_hash_sha3_224_ops;
  67. extern const php_hash_ops php_hash_sha3_256_ops;
  68. extern const php_hash_ops php_hash_sha3_384_ops;
  69. extern const php_hash_ops php_hash_sha3_512_ops;
  70. extern const php_hash_ops php_hash_ripemd128_ops;
  71. extern const php_hash_ops php_hash_ripemd160_ops;
  72. extern const php_hash_ops php_hash_ripemd256_ops;
  73. extern const php_hash_ops php_hash_ripemd320_ops;
  74. extern const php_hash_ops php_hash_whirlpool_ops;
  75. extern const php_hash_ops php_hash_3tiger128_ops;
  76. extern const php_hash_ops php_hash_3tiger160_ops;
  77. extern const php_hash_ops php_hash_3tiger192_ops;
  78. extern const php_hash_ops php_hash_4tiger128_ops;
  79. extern const php_hash_ops php_hash_4tiger160_ops;
  80. extern const php_hash_ops php_hash_4tiger192_ops;
  81. extern const php_hash_ops php_hash_snefru_ops;
  82. extern const php_hash_ops php_hash_gost_ops;
  83. extern const php_hash_ops php_hash_gost_crypto_ops;
  84. extern const php_hash_ops php_hash_adler32_ops;
  85. extern const php_hash_ops php_hash_crc32_ops;
  86. extern const php_hash_ops php_hash_crc32b_ops;
  87. extern const php_hash_ops php_hash_crc32c_ops;
  88. extern const php_hash_ops php_hash_fnv132_ops;
  89. extern const php_hash_ops php_hash_fnv1a32_ops;
  90. extern const php_hash_ops php_hash_fnv164_ops;
  91. extern const php_hash_ops php_hash_fnv1a64_ops;
  92. extern const php_hash_ops php_hash_joaat_ops;
  93. extern const php_hash_ops php_hash_murmur3a_ops;
  94. extern const php_hash_ops php_hash_murmur3c_ops;
  95. extern const php_hash_ops php_hash_murmur3f_ops;
  96. extern const php_hash_ops php_hash_xxh32_ops;
  97. extern const php_hash_ops php_hash_xxh64_ops;
  98. extern const php_hash_ops php_hash_xxh3_64_ops;
  99. extern const php_hash_ops php_hash_xxh3_128_ops;
  100. #define PHP_HASH_HAVAL_OPS(p,b) extern const php_hash_ops php_hash_##p##haval##b##_ops;
  101. PHP_HASH_HAVAL_OPS(3,128)
  102. PHP_HASH_HAVAL_OPS(3,160)
  103. PHP_HASH_HAVAL_OPS(3,192)
  104. PHP_HASH_HAVAL_OPS(3,224)
  105. PHP_HASH_HAVAL_OPS(3,256)
  106. PHP_HASH_HAVAL_OPS(4,128)
  107. PHP_HASH_HAVAL_OPS(4,160)
  108. PHP_HASH_HAVAL_OPS(4,192)
  109. PHP_HASH_HAVAL_OPS(4,224)
  110. PHP_HASH_HAVAL_OPS(4,256)
  111. PHP_HASH_HAVAL_OPS(5,128)
  112. PHP_HASH_HAVAL_OPS(5,160)
  113. PHP_HASH_HAVAL_OPS(5,192)
  114. PHP_HASH_HAVAL_OPS(5,224)
  115. PHP_HASH_HAVAL_OPS(5,256)
  116. extern zend_module_entry hash_module_entry;
  117. #define phpext_hash_ptr &hash_module_entry
  118. #ifdef PHP_WIN32
  119. # define PHP_HASH_API __declspec(dllexport)
  120. #elif defined(__GNUC__) && __GNUC__ >= 4
  121. # define PHP_HASH_API __attribute__ ((visibility("default")))
  122. #else
  123. # define PHP_HASH_API
  124. #endif
  125. extern PHP_HASH_API zend_class_entry *php_hashcontext_ce;
  126. PHP_HASH_API const php_hash_ops *php_hash_fetch_ops(zend_string *algo);
  127. PHP_HASH_API void php_hash_register_algo(const char *algo, const php_hash_ops *ops);
  128. PHP_HASH_API int php_hash_copy(const void *ops, void *orig_context, void *dest_context);
  129. PHP_HASH_API int php_hash_serialize(const php_hashcontext_object *context, zend_long *magic, zval *zv);
  130. PHP_HASH_API int php_hash_unserialize(php_hashcontext_object *context, zend_long magic, const zval *zv);
  131. PHP_HASH_API int php_hash_serialize_spec(const php_hashcontext_object *context, zval *zv, const char *spec);
  132. PHP_HASH_API int php_hash_unserialize_spec(php_hashcontext_object *hash, const zval *zv, const char *spec);
  133. static inline void *php_hash_alloc_context(const php_hash_ops *ops) {
  134. /* Zero out context memory so serialization doesn't expose internals */
  135. return ecalloc(1, ops->context_size);
  136. }
  137. static inline void php_hash_bin2hex(char *out, const unsigned char *in, size_t in_len)
  138. {
  139. static const char hexits[17] = "0123456789abcdef";
  140. size_t i;
  141. for(i = 0; i < in_len; i++) {
  142. out[i * 2] = hexits[in[i] >> 4];
  143. out[(i * 2) + 1] = hexits[in[i] & 0x0F];
  144. }
  145. }
  146. #endif /* PHP_HASH_H */