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