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