SessionHandler sınıfı

(PHP 5 >= 5.4.0, PHP 7, PHP 8)

Giriş

SessionHandler, mevcut dahili PHP oturum kaydetme işleyicisini kalıtım yoluyla oluşturmak için kullanılabilecek özel bir sınıftır. Yedi dahili oturum kaydetme işleyicisi geriçağırımlarını sarmalayan yedi yöntemi vardır (open, close, read, write, destroy, gc ve create_sid). Öntanımlı olarak, bu sınıf, genellikle öntanımlı değeri files olan session.save_handler yapılandırma yönergesi tarafından tanımlandığı gibi dahili kaydetme işleyicisine ne atanmışsa onu sarmalar. Diğer dahili oturum kaydetme işleyicileri, SQLite (sqlite olarak), Memcache (memcache olarak) ve Memcached (memcached olarak) gibi PHP eklentileri tarafından sağlanır.

SessionHandler sınıfının düz bir örneği session_set_save_handler() kullanılarak kaydetme işleyicisi olarak atandığında, geçerli kaydetme işleyicilerini sarmalar. SessionHandler sınıfından genişletilen sınıf, ebeveynin yöntemlerini geçersiz kılmanıza veya dahili PHP oturum işleyicilerini sarmalayan ebeveyn sınıfın yöntemlerini çağırarak genişletilen sınıfın yöntemlerini engellemenize veya filtrelemenize olanak tanır.

Bu, örneğin, oturum verilerini şifrelemek/şifresini çözmek için read ve write yöntemlerini engellemenize ve ardından sonucu ebeveyn sınıfa ve ebeveyn sınıftan iletmenize olanak tanır. Bundan başka, gc çöp toplama geriçağırımı gibi bir yöntemi tamamen geçersiz kılmayı da seçebilirsiniz.

SessionHandler mevcut dahili kaydetme işleyicisi yöntemlerini sarmaladığından, yukarıdaki şifreleme örneği, işleyicilerin iç yapısını bilmek zorunda kalmadan herhangi bir dahili kaydetme işleyicisine uygulanabilir.

Bu sınıfı kullanmak için, önce session.save_handler ini yönergesini kullanarak oluşturmak istediğiniz kaydetme işleyicisini atayın ve ardından SessionHandler nesnesini veya işleyiciyi session_set_save_handler() işlevine genişleten bir nesneyi aktarın.

Bu sınıfın geriçağırım yöntemlerinin PHP tarafından dahili olarak çağrılmak üzere tasarlandığı, kullanıcı tarafından kod içinde kullanılmak üzere tasarlanmadığı unutulmamalıdır. Dönüş değerleri PHP tarafından dahili olarak işlenir. Oturum iş akışı hakkında daha fazla bilgi için session_set_save_handler() belgesine bakılabilir.

Sınıf Sözdizimi

class SessionHandler implements SessionHandlerInterface, SessionIdInterface {

/* Yöntemler */

public close(): bool

public create_sid(): string

public destroy(string $kimlik): bool

public gc(int $azami_ömür): int|false

public open(string $yol, string $isim): bool

public read(string $kimlik): string|false

public write(string $kimlik, string $veri): bool

}

Notlar

Uyarı

Bu sınıf, mevcut dahili PHP oturum kaydetme işleyicisini oluşturmak için tasarlanmıştır, eğer kendi özel kaydetme işleyicilerinizi yazmak istiyorsanız, SessionHandler sınıfını genişletmek yerine SessionHandlerInterface arayüzünü gerçekleyin.

Örnekler

Örnek 1 - Dahili PHP oturum kaydetme işleyicilere şifreleme eklemek için SessionHandler kullanımı

<?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; // anahtar uzunluğuna bağlı
    $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) {
    // random_bytes() kullanarak kriptografik olarak güvenli rastgele tuz üret
    $tuz = random_bytes(16);

    $salted = '';
    $dx = '';
    // key(32) ve iv(16) = 48 tuz
    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);
    }
}

// yerel 'files' işleyicisini alıkoyacağız, ancak PHP eklentileri tarafından
// sağlanan 'sqlite', 'memcache' veya 'memcached' gibi diğer dahili yerel
// işleyicilerle eşit şekilde çalışacak.
ini_set('session.save_handler', 'files');

$key = 'secret_string';
$handler = new EncryptedSessionHandler($key);
session_set_save_handler($handler, true);
session_start();

// $_SESSION'daki anahtarla değerleri atamaya ve almaya devam et

Bilginize:
Bu sınıfın yöntemleri, normal oturum iş akışının bir parçası olarak PHP tarafından dahili olarak çağrılacak şekilde tasarlandığından, ebeveyn yöntemlere (yani gerçek dahili yerel işleyiciler) yapılan çocuk sınıf çağrıları, oturum gerçekten başlatılmadığı sürece (otomatik olarak veya doğrudan session_start() çağrısıyla) false döndürür. Sınıf yöntemlerinin kodunuzun içinden çağrılabileceği birim denemelerini "yaparken bunun dikkate alınması önemlidir.

İçindekiler

SessionHandler::close — Oturumu kapatır
SessionHandler::create_sid — Yeni oturum kimliğini döndürür
SessionHandler::destroy — Oturumu siler
SessionHandler::gc — Eski oturumu çöpe atar
SessionHandler::open — Oturumu ilklendirir
SessionHandler::read — Oturum verisini okur
SessionHandler::write — Oturum verisini yazar

Improve This Page

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 8 notes

down

rasmus at mindplay dot dk ¶

9 years ago

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 :-)

down

tuncdan dot ozdemir dot peng at gmail dot com ¶

1 year ago

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).

down

tony at marston-home dot demon dot co dot uk ¶

6 years ago

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.

down

tuncdan dot ozdemir dot peng at gmail dot com ¶

1 year ago

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)

down

saccani dot francesco dot NOSPAM at gmail dot com ¶

4 years ago

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.

down

RomanV ¶

6 months ago

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!

down

-3

jeremie dot legrand at komori-chambon dot fr ¶

8 years ago

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);

down

-3

wei dot kavin at gmail dot com ¶

5 years ago

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)

＋add a note