(PHP 5 >= 5.4.0, PHP 7, PHP 8)
SessionHandler es una clase especial que puede usarse
para exponer el gestor de almacenamiento de sesiones interno actual de PHP por herencia.
Existen siete métodos que envuelven las sietes retrollamadas del gestor de almacenamiento
de sesiones (open, close,
read, write,
destroy, gc y
create_sid). Por defecto, esta clase envolverá
cualquier gestor de almacenamiento que esté establecido como está definido por la
directiva de configuración session.save_handler,
el cual normalmente es files por
omisión. Otros gestores de almacenamiento de sesión internos son proporcionados por
extensiones de PHP tales como SQLite (como sqlite), Memcache (como
memcache), y Memcached (como
Memcached).
Cuando se establece una simple instancia de SessionHandler como el gestor de almacenamiento usando session_set_save_handler(), envolverá los gestores de almacenamiento actuales. Una clase que extienda de SessionHandler permite sobrescribir los métodos o interceptarlos o filtrarlos llamando a los métodos de la clase madre, los cuales en última instancia envolverán los gestores de sesiones de PHP internos.
Esto permite, por ejemplo, interceptar los métodos read y write
para encriptar/desencriptar la información de sesión y luego pasar el resultado hacia y desde la clase madre.
De forma alternativa se podría elegir sobrescribir por completo un método como la llamada de retorno del recolector de basura
gc.
Ya que SessionHandler envuelve los métodos del gestor de almacenamiento interno actual, el ejemplo de arriba de encriptación puede aplicarse a cualquier gestor de almacenamiento interno sin tener que conocer los entresijos de los gestores.
Para usar esta clase, primero establezca el gestor de almacenamiento que desee exponer usando session.save_handler y luego pasar una instancia de SessionHandler o una que la extienda a session_set_save_handler().
Observe que los métodos de llamda de retorno de esta clase están diseñados para ser llamados internamente por PHP y no para ser llamados desde código de espacio de usuario. Los valores devueltos son igualmente procesados internamente por PHP. Para más información sobre el flujo de trabajo de sesiones consulte session_set_save_handler().
Esta clase está diseñada para exponer el gestor de almacenamiento de sesiones interno de PHP, si quiere escribir sus propios gestores de almacenamiento, implemente la interfaz SessionHandlerInterface en lugar de extender desde SessionHandler.
Ejemplo #1 Usar SessionHandler para añadir encriptación a los gestores de almacenamiento internos de PHP.
<?php
/**
* decrypt AES 256
*
* @param data $edata
* @param string $password
* @return decrypted data
*/
function decrypt($edata, $password) {
$data = base64_decode($edata);
$salt = substr($data, 0, 16);
$ct = substr($data, 16);
$rounds = 3; // depends on key length
$data00 = $password.$salt;
$hash = array();
$hash[0] = hash('sha256', $data00, true);
$result = $hash[0];
for ($i = 1; $i < $rounds; $i++) {
$hash[$i] = hash('sha256', $hash[$i - 1].$data00, true);
$result .= $hash[$i];
}
$key = substr($result, 0, 32);
$iv = substr($result, 32,16);
return openssl_decrypt($ct, 'AES-256-CBC', $key, true, $iv);
}
/**
* crypt AES 256
*
* @param data $data
* @param string $password
* @return base64 encrypted data
*/
function encrypt($data, $password) {
// Set a random salt
$salt = openssl_random_pseudo_bytes(16);
$salted = '';
$dx = '';
// Salt the key(32) and iv(16) = 48
while (strlen($salted) < 48) {
$dx = hash('sha256', $dx.$password.$salt, true);
$salted .= $dx;
}
$key = substr($salted, 0, 32);
$iv = substr($salted, 32,16);
$encrypted_data = openssl_encrypt($data, 'AES-256-CBC', $key, true, $iv);
return base64_encode($salt . $encrypted_data);
}
class EncryptedSessionHandler extends SessionHandler
{
private $key;
public function __construct($key)
{
$this->key = $key;
}
public function read($id)
{
$data = parent::read($id);
if (!$data) {
return "";
} else {
return decrypt($data, $this->key);
}
}
public function write($id, $data)
{
$data = encrypt($data, $this->key);
return parent::write($id, $data);
}
}
// interceptaremos el manejador nativo 'files', pero funcionaría igualmente
// con otros manejadores nativos internos como 'sqlite', 'memcache' o 'memcached'
// que son proporcionados por extensiones de PHP.
ini_set('session.save_handler', 'files');
$key = 'secret_string';
$handler = new EncryptedSessionHandler($key);
session_set_save_handler($handler, true);
session_start();
// proceder para establecer y recuperar valores por clave desde $_SESSIONNota:
Ya que los métodos de esta clase están diseñados para se llamados internamente por PHP como parte del flujo de trabajo normal, las llamadas de las clases hijas a los métodos padre (es decir, los gestores nativos internos reales) devolverán
falsea menos que la sesión haya sido iniciada realmente (automáticamente o explícitamente mediante session_start()). Es importante considerar esto cuando se escriben unidades de pruebas donde los métodos de la clase podrían ser invocados manualmente.
As the life-cycle of a session handler is fairly complex, I found it difficult to understand when explained using just words - so I traced the function calls made to a custom SessionHandler, and created this overview of precisely what happens when you call various session methods:
https://gist.github.com/mindplay-dk/623bdd50c1b4c0553cd3
I hope this makes it considerably easier to implement a custom SessionHandler and get it right the first time :-)Those who are planning to implement your own SessionHandler, let's say using a Database system, please make sure your 'create_sid' method creates a new record in your database with empty string '' as your 'data' using the new session ID created, otherwise when 'read' method is called (which is always called no matter if it is a brand new session or not), you will get an error because there is no record with that session ID yet. The funny part is that the error you get will sound like PHP is trying open the session on your local drive (coming from your .ini file).Your custom session handler should not contain calls to any of the session functions, such as session_name() or session_id(), as the relevant values are passed as arguments on various handler methods. Attempting to obtain values from alternative sources may not work as expected.The best way to set up your own session handler is to extend the native SessionHandler (override the 7 methods + constructor as per your need, keeping the same signatures). Optionally, you can also implement SessionUpdateTimestampHandlerInterface if you plan to use 'lazy_write':
Option 1:
class MyOwnSessionHandler extends \SessionHandler { ..... }
Option 2:
class MyOwnSessionHandler extends \SessionHandler implements \SessionUpdateTimestampHandlerInterface { ..... }
I would NOT recommend to do this:
class MyOwnSessionHandler implements \SessionHandlerInterface, \SessionIdInterface, \SessionUpdateTimestampHandlerInterface { ... }
If you are curious, here are the methods called in the order (using PHP 8.2 with XAMPP v3.3.0 on Windows 11 64-bit):
- open (always called)
- validateId and/or create_sid:
validateId is called if you implement SessionUpdateTimestampHandlerInterface. If validation fails, create_sid is called.
create_sid is called if a new session ID is needed: new session, etc.
- read (always called)
- write OR updateTimestamp OR destroy:
if you call 'destroy', neither 'write' or 'updateTimestamp' is called,
if you have the 'lazy_write' on AND implemented SessionUpdateTimestampHandlerInterface,
then 'updateTimestamp' is called instead of 'write' if nothing changes.
- close (always called)I made this gist to provide a complete overview of the PHP session handler life cycle updated to version 7.0 or above. In particular, I wanted to emphasize what methods and in what order are called when the native PHP functions are used for session management.
https://gist.github.com/franksacco/d6e943c41189f8ee306c182bf8f07654
I hope this analysis will help all the developers interested in understanding in detail the native session management performed by PHP and what a custom session handler should do.
Any comment or suggestion is appreciated.Be aware that when you inherit from \SessionHandler you implicitly disable session strict mode because it doesn't implement SessionUpdateTimestampHandlerInterface (see: https://www.php.net/manual/en/session.configuration.php#ini.session.use-strict-mode) thus validateId() is not called.
It's CRUCIAL to call the session_regenerate_id() function whenever any privilege level is changed (i.e. during authentication, password/permission/user role change) to mitigate the session fixation attack!Here is a wrapper to log in a file each session's operations. Useful to investigate sessions locks (which prevent PHP to serve simultaneous requests for a same client).
Just change the file name at the end to dump logs where you want.
class DumpSessionHandler extends SessionHandler {
private $fich;
public function __construct($fich) {
$this->fich = $fich;
}
public function close() {
$this->log('close');
return parent::close();
}
public function create_sid() {
$this->log('create_sid');
return parent::create_sid();
}
public function destroy($session_id) {
$this->log('destroy('.$session_id.')');
return parent::destroy($session_id);
}
public function gc($maxlifetime) {
$this->log('close('.$maxlifetime.')');
return parent::gc($maxlifetime);
}
public function open($save_path, $session_name) {
$this->log('open('.$save_path.', '.$session_name.')');
return parent::open($save_path, $session_name);
}
public function read($session_id) {
$this->log('read('.$session_id.')');
return parent::read($session_id);
}
public function write($session_id, $session_data) {
$this->log('write('.$session_id.', '.$session_data.')');
return parent::write($session_id, $session_data);
}
private function log($action) {
$base_uri = explode('?', $_SERVER['REQUEST_URI'], 2)[0];
$hdl = fopen($this->fich, 'a');
fwrite($hdl, date('Y-m-d h:i:s').' '.$base_uri.' : '.$action."\n");
fclose($hdl);
}
}
ini_set('session.save_handler', 'files');
$handler = new DumpSessionHandler('/path/to/dump_sessions.log');
session_set_save_handler($handler, true);php -S localhost:8000 -t foo/
touch index.php
vi index.php
============================================================
class NativeSessionHandler extends \SessionHandler
{
public function __construct($savePath = null)
{
if (null === $savePath) {
$savePath = ini_get('session.save_path');
}
$baseDir = $savePath;
if ($count = substr_count($savePath, ';')) {
if ($count > 2) {
throw new \InvalidArgumentException(sprintf('Invalid argument $savePath \'%s\'', $savePath));
}
// characters after last ';' are the path
$baseDir = ltrim(strrchr($savePath, ';'), ';');
}
if ($baseDir && !is_dir($baseDir) && !@mkdir($baseDir, 0777, true) && !is_dir($baseDir)) {
throw new \RuntimeException(sprintf('Session Storage was not able to create directory "%s"', $baseDir));
}
ini_set('session.save_path', $savePath);
ini_set('session.save_handler', 'files');
}
}
$handler = new NativeSessionHandler("/var/www/foo");
session_set_save_handler($handler, true);
session_start();
$a = $handler->write("aaa","bbbb");var_dump($a);exit;
============================================================
output：bool(false)