1 /* 2 +----------------------------------------------------------------------+ 3 | PHP Version 7 | 4 +----------------------------------------------------------------------+ 5 | Copyright (c) 1997-2017 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: Sascha Schumann <sascha@schumann.cx> | 16 +----------------------------------------------------------------------+ 17 */ 18 19 /* $Id$ */ 20 21 #ifndef PHP_SESSION_H 22 #define PHP_SESSION_H 23 24 #include "ext/standard/php_var.h" 25 26 #if defined(HAVE_HASH_EXT) && !defined(COMPILE_DL_HASH) 27 # include "ext/hash/php_hash.h" 28 #endif 29 30 #define PHP_SESSION_API 20150121 31 32 #include "php_version.h" 33 #define PHP_SESSION_VERSION PHP_VERSION 34 35 /* save handler macros */ 36 #define PS_NUM_APIS 9 37 #define PS_OPEN_ARGS void **mod_data, const char *save_path, const char *session_name 38 #define PS_CLOSE_ARGS void **mod_data 39 #define PS_READ_ARGS void **mod_data, zend_string *key, zend_string **val, zend_long maxlifetime 40 #define PS_WRITE_ARGS void **mod_data, zend_string *key, zend_string *val, zend_long maxlifetime 41 #define PS_DESTROY_ARGS void **mod_data, zend_string *key 42 #define PS_GC_ARGS void **mod_data, zend_long maxlifetime, int *nrdels 43 #define PS_CREATE_SID_ARGS void **mod_data 44 #define PS_VALIDATE_SID_ARGS void **mod_data, zend_string *key 45 #define PS_UPDATE_TIMESTAMP_ARGS void **mod_data, zend_string *key, zend_string *val, zend_long maxlifetime 46 47 typedef struct ps_module_struct { 48 const char *s_name; 49 int (*s_open)(PS_OPEN_ARGS); 50 int (*s_close)(PS_CLOSE_ARGS); 51 int (*s_read)(PS_READ_ARGS); 52 int (*s_write)(PS_WRITE_ARGS); 53 int (*s_destroy)(PS_DESTROY_ARGS); 54 int (*s_gc)(PS_GC_ARGS); 55 zend_string *(*s_create_sid)(PS_CREATE_SID_ARGS); 56 int (*s_validate_sid)(PS_VALIDATE_SID_ARGS); 57 int (*s_update_timestamp)(PS_UPDATE_TIMESTAMP_ARGS); 58 } ps_module; 59 60 #define PS_GET_MOD_DATA() *mod_data 61 #define PS_SET_MOD_DATA(a) *mod_data = (a) 62 63 #define PS_OPEN_FUNC(x) int ps_open_##x(PS_OPEN_ARGS) 64 #define PS_CLOSE_FUNC(x) int ps_close_##x(PS_CLOSE_ARGS) 65 #define PS_READ_FUNC(x) int ps_read_##x(PS_READ_ARGS) 66 #define PS_WRITE_FUNC(x) int ps_write_##x(PS_WRITE_ARGS) 67 #define PS_DESTROY_FUNC(x) int ps_delete_##x(PS_DESTROY_ARGS) 68 #define PS_GC_FUNC(x) int ps_gc_##x(PS_GC_ARGS) 69 #define PS_CREATE_SID_FUNC(x) zend_string *ps_create_sid_##x(PS_CREATE_SID_ARGS) 70 #define PS_VALIDATE_SID_FUNC(x) int ps_validate_sid_##x(PS_VALIDATE_SID_ARGS) 71 #define PS_UPDATE_TIMESTAMP_FUNC(x) int ps_update_timestamp_##x(PS_UPDATE_TIMESTAMP_ARGS) 72 73 /* Legacy save handler module definitions */ 74 #define PS_FUNCS(x) \ 75 PS_OPEN_FUNC(x); \ 76 PS_CLOSE_FUNC(x); \ 77 PS_READ_FUNC(x); \ 78 PS_WRITE_FUNC(x); \ 79 PS_DESTROY_FUNC(x); \ 80 PS_GC_FUNC(x); \ 81 PS_CREATE_SID_FUNC(x) 82 83 #define PS_MOD(x) \ 84 #x, ps_open_##x, ps_close_##x, ps_read_##x, ps_write_##x, \ 85 ps_delete_##x, ps_gc_##x, php_session_create_id, \ 86 php_session_validate_sid, php_session_update_timestamp 87 88 /* Legacy SID creation enabled save handler module definitions */ 89 #define PS_FUNCS_SID(x) \ 90 PS_OPEN_FUNC(x); \ 91 PS_CLOSE_FUNC(x); \ 92 PS_READ_FUNC(x); \ 93 PS_WRITE_FUNC(x); \ 94 PS_DESTROY_FUNC(x); \ 95 PS_GC_FUNC(x); \ 96 PS_CREATE_SID_FUNC(x); \ 97 PS_VALIDATE_SID_FUNC(x); \ 98 PS_UPDATE_TIMESTAMP_FUNC(x); 99 100 #define PS_MOD_SID(x) \ 101 #x, ps_open_##x, ps_close_##x, ps_read_##x, ps_write_##x, \ 102 ps_delete_##x, ps_gc_##x, ps_create_sid_##x, \ 103 php_session_validate_sid, php_session_update_timestamp 104 105 /* Update timestamp enabled save handler module definitions 106 New save handlers should use this API */ 107 #define PS_FUNCS_UPDATE_TIMESTAMP(x) \ 108 PS_OPEN_FUNC(x); \ 109 PS_CLOSE_FUNC(x); \ 110 PS_READ_FUNC(x); \ 111 PS_WRITE_FUNC(x); \ 112 PS_DESTROY_FUNC(x); \ 113 PS_GC_FUNC(x); \ 114 PS_CREATE_SID_FUNC(x); \ 115 PS_VALIDATE_SID_FUNC(x); \ 116 PS_UPDATE_TIMESTAMP_FUNC(x); 117 118 #define PS_MOD_UPDATE_TIMESTAMP(x) \ 119 #x, ps_open_##x, ps_close_##x, ps_read_##x, ps_write_##x, \ 120 ps_delete_##x, ps_gc_##x, ps_create_sid_##x, \ 121 ps_validate_sid_##x, ps_update_timestamp_##x 122 123 124 typedef enum { 125 php_session_disabled, 126 php_session_none, 127 php_session_active 128 } php_session_status; 129 130 typedef struct _php_session_rfc1867_progress { 131 size_t sname_len; 132 zval sid; 133 smart_str key; 134 135 zend_long update_step; 136 zend_long next_update; 137 double next_update_time; 138 zend_bool cancel_upload; 139 zend_bool apply_trans_sid; 140 size_t content_length; 141 142 zval data; /* the array exported to session data */ 143 zval *post_bytes_processed; /* data["bytes_processed"] */ 144 zval files; /* data["files"] array */ 145 zval current_file; /* array of currently uploading file */ 146 zval *current_file_bytes_processed; 147 } php_session_rfc1867_progress; 148 149 typedef struct _php_ps_globals { 150 char *save_path; 151 char *session_name; 152 zend_string *id; 153 char *extern_referer_chk; 154 char *entropy_file; 155 char *cache_limiter; 156 zend_long entropy_length; 157 zend_long cookie_lifetime; 158 char *cookie_path; 159 char *cookie_domain; 160 zend_bool cookie_secure; 161 zend_bool cookie_httponly; 162 ps_module *mod; 163 ps_module *default_mod; 164 void *mod_data; 165 php_session_status session_status; 166 zend_long gc_probability; 167 zend_long gc_divisor; 168 zend_long gc_maxlifetime; 169 int module_number; 170 zend_long cache_expire; 171 union { 172 zval names[PS_NUM_APIS]; 173 struct { 174 zval ps_open; 175 zval ps_close; 176 zval ps_read; 177 zval ps_write; 178 zval ps_destroy; 179 zval ps_gc; 180 zval ps_create_sid; 181 zval ps_validate_sid; 182 zval ps_update_timestamp; 183 } name; 184 } mod_user_names; 185 int mod_user_implemented; 186 int mod_user_is_open; 187 const struct ps_serializer_struct *serializer; 188 zval http_session_vars; 189 zend_bool auto_start; 190 zend_bool use_cookies; 191 zend_bool use_only_cookies; 192 zend_bool use_trans_sid; /* contains the INI value of whether to use trans-sid */ 193 194 zend_long hash_func; 195 #if defined(HAVE_HASH_EXT) && !defined(COMPILE_DL_HASH) 196 php_hash_ops *hash_ops; 197 #endif 198 zend_long hash_bits_per_character; 199 int send_cookie; 200 int define_sid; 201 202 php_session_rfc1867_progress *rfc1867_progress; 203 zend_bool rfc1867_enabled; /* session.upload_progress.enabled */ 204 zend_bool rfc1867_cleanup; /* session.upload_progress.cleanup */ 205 char *rfc1867_prefix; /* session.upload_progress.prefix */ 206 char *rfc1867_name; /* session.upload_progress.name */ 207 zend_long rfc1867_freq; /* session.upload_progress.freq */ 208 double rfc1867_min_freq; /* session.upload_progress.min_freq */ 209 210 zend_bool use_strict_mode; /* whether or not PHP accepts unknown session ids */ 211 zend_bool lazy_write; /* omit session write when it is possible */ 212 zend_string *session_vars; /* serialized original session data */ 213 } php_ps_globals; 214 215 typedef php_ps_globals zend_ps_globals; 216 217 extern zend_module_entry session_module_entry; 218 #define phpext_session_ptr &session_module_entry 219 220 #ifdef ZTS 221 #define PS(v) ZEND_TSRMG(ps_globals_id, php_ps_globals *, v) 222 #ifdef COMPILE_DL_SESSION 223 ZEND_TSRMLS_CACHE_EXTERN() 224 #endif 225 #else 226 #define PS(v) (ps_globals.v) 227 #endif 228 229 #define PS_SERIALIZER_ENCODE_ARGS void 230 #define PS_SERIALIZER_DECODE_ARGS const char *val, size_t vallen 231 232 typedef struct ps_serializer_struct { 233 const char *name; 234 zend_string *(*encode)(PS_SERIALIZER_ENCODE_ARGS); 235 int (*decode)(PS_SERIALIZER_DECODE_ARGS); 236 } ps_serializer; 237 238 #define PS_SERIALIZER_ENCODE_NAME(x) ps_srlzr_encode_##x 239 #define PS_SERIALIZER_DECODE_NAME(x) ps_srlzr_decode_##x 240 241 #define PS_SERIALIZER_ENCODE_FUNC(x) \ 242 zend_string *PS_SERIALIZER_ENCODE_NAME(x)(PS_SERIALIZER_ENCODE_ARGS) 243 #define PS_SERIALIZER_DECODE_FUNC(x) \ 244 int PS_SERIALIZER_DECODE_NAME(x)(PS_SERIALIZER_DECODE_ARGS) 245 246 #define PS_SERIALIZER_FUNCS(x) \ 247 PS_SERIALIZER_ENCODE_FUNC(x); \ 248 PS_SERIALIZER_DECODE_FUNC(x) 249 250 #define PS_SERIALIZER_ENTRY(x) \ 251 { #x, PS_SERIALIZER_ENCODE_NAME(x), PS_SERIALIZER_DECODE_NAME(x) } 252 253 /* default create id function */ 254 PHPAPI zend_string *php_session_create_id(PS_CREATE_SID_ARGS); 255 /* Dummy PS module functions */ 256 PHPAPI int php_session_validate_sid(PS_VALIDATE_SID_ARGS); 257 PHPAPI int php_session_update_timestamp(PS_UPDATE_TIMESTAMP_ARGS); 258 259 PHPAPI void session_adapt_url(const char *, size_t, char **, size_t *); 260 261 PHPAPI void php_add_session_var(zend_string *name); 262 PHPAPI zval *php_set_session_var(zend_string *name, zval *state_val, php_unserialize_data_t *var_hash); 263 PHPAPI zval *php_get_session_var(zend_string *name); 264 265 PHPAPI int php_session_register_module(ps_module *); 266 267 PHPAPI int php_session_register_serializer(const char *name, 268 zend_string *(*encode)(PS_SERIALIZER_ENCODE_ARGS), 269 int (*decode)(PS_SERIALIZER_DECODE_ARGS)); 270 271 PHPAPI void php_session_set_id(char *id); 272 PHPAPI void php_session_start(void); 273 274 PHPAPI ps_module *_php_find_ps_module(char *name); 275 PHPAPI const ps_serializer *_php_find_ps_serializer(char *name); 276 277 PHPAPI int php_session_valid_key(const char *key); 278 PHPAPI void php_session_reset_id(void); 279 280 #define PS_ADD_VARL(name) do { \ 281 php_add_session_var(name); \ 282 } while (0) 283 284 #define PS_ADD_VAR(name) PS_ADD_VARL(name) 285 286 #define PS_DEL_VARL(name) do { \ 287 if (!Z_ISNULL(PS(http_session_vars))) { \ 288 zend_hash_del(Z_ARRVAL(PS(http_session_vars)), name); \ 289 } \ 290 } while (0) 291 292 293 #define PS_ENCODE_VARS \ 294 zend_string *key; \ 295 zend_ulong num_key; \ 296 zval *struc; 297 298 #define PS_ENCODE_LOOP(code) do { \ 299 HashTable *_ht = Z_ARRVAL_P(Z_REFVAL(PS(http_session_vars))); \ 300 ZEND_HASH_FOREACH_KEY(_ht, num_key, key) { \ 301 if (key == NULL) { \ 302 php_error_docref(NULL, E_NOTICE, \ 303 "Skipping numeric key %pd", num_key); \ 304 continue; \ 305 } \ 306 if ((struc = php_get_session_var(key))) { \ 307 code; \ 308 } \ 309 } ZEND_HASH_FOREACH_END(); \ 310 } while(0) 311 312 PHPAPI ZEND_EXTERN_MODULE_GLOBALS(ps) 313 314 void php_session_auto_start(void *data); 315 316 #define PS_CLASS_NAME "SessionHandler" 317 extern zend_class_entry *php_session_class_entry; 318 319 #define PS_IFACE_NAME "SessionHandlerInterface" 320 extern zend_class_entry *php_session_iface_entry; 321 322 #define PS_SID_IFACE_NAME "SessionIdInterface" 323 extern zend_class_entry *php_session_id_iface_entry; 324 325 #define PS_UPDATE_TIMESTAMP_IFACE_NAME "SessionUpdateTimestampHandlerInterface" 326 extern zend_class_entry *php_session_update_timestamp_iface_entry; 327 328 extern PHP_METHOD(SessionHandler, open); 329 extern PHP_METHOD(SessionHandler, close); 330 extern PHP_METHOD(SessionHandler, read); 331 extern PHP_METHOD(SessionHandler, write); 332 extern PHP_METHOD(SessionHandler, destroy); 333 extern PHP_METHOD(SessionHandler, gc); 334 extern PHP_METHOD(SessionHandler, create_sid); 335 extern PHP_METHOD(SessionHandler, validateId); 336 extern PHP_METHOD(SessionHandler, updateTimestamp); 337 338 #endif 339
