EncryptedCookieSession Class Reference

Inheritance diagram for EncryptedCookieSession:

Public Member Functions
	__construct ($key)
	open ($save_path, $session_name)
	close ()
	destroy ($session_id)
	gc ($maxlifetime)
	read ($session_id)
	write ($session_id, $session_data)

Private Attributes
	$save_path
	$session_name
	$session_key
	$last_read

Detailed Description

Definition at line 5052 of file grima-lib.php.

Constructor & Destructor Documentation

__construct()

EncryptedCookieSession::__construct

(

$key

)

Definition at line 5061 of file grima-lib.php.

    {

        $this->session_key = $key;

        $this->last_read = "Not This";

    }

Member Function Documentation

close()

EncryptedCookieSession::close

(

)

Definition at line 5075 of file grima-lib.php.

    {

        //error_log("session_close()");


        return true;

    }

destroy()

EncryptedCookieSession::destroy

(

$session_id

)

Definition at line 5081 of file grima-lib.php.

    {

        //error_log("sessionDestroy($session_id)");


        $params = session_get_cookie_params();

        $params['expires'] = time() - 42000;

        unset($params['lifetime']);

        setcookie($this->session_name, '', $params);

        return true;

    }

gc()

EncryptedCookieSession::gc

(

$maxlifetime

)

Definition at line 5091 of file grima-lib.php.

    {

        //error_log("session_gc($maxlifetime)");


        return true;

    }

open()

EncryptedCookieSession::open	(		$save_path,
			$session_name
	)

Definition at line 5067 of file grima-lib.php.

    {

        $this->save_path = $save_path;

        $this->session_name = $session_name;

        //error_log("session_open($save_path,$session_name)");


        return true;

    }

References $save_path, and $session_name.

read()

EncryptedCookieSession::read

(

$session_id

)

Definition at line 5097 of file grima-lib.php.

    {

        //error_log("session_read($session_id)");


        $nonce_ciphertext_b64 = isset($_COOKIE[$this->session_name]) ? $_COOKIE[$this->session_name] : "";

        if ($nonce_ciphertext_b64) {

            $nonce_ciphertext = base64_decode($nonce_ciphertext_b64);

            if (strlen($nonce_ciphertext)>24+16) {

                $nonce = substr($nonce_ciphertext, 0, 24);

                $ciphertext = substr($nonce_ciphertext, 24);

                $plaintext = sodium_crypto_secretbox_open($ciphertext, $nonce, $this->session_key);

                // error_log("session_read -> $plaintext");


                $this->last_read = $plaintext;

                return $plaintext ?: "";

            } else {

                error_log("cookie too short: $nonce_ciphertext_b64");

            }

        } else {

            //error_log("cookie not set or empty");


        }

        return "";

    }

References $session_name.

write()

EncryptedCookieSession::write	(		$session_id,
			$session_data
	)

Definition at line 5119 of file grima-lib.php.

    {

        // error_log("session_write($session_id,$session_data)");


        if (!$session_data) { return true;

        }

        if ($this->last_read == $session_data) { return true;

        }

        $nonce = random_bytes(24);

        $ciphertext = sodium_crypto_secretbox($session_data, $nonce, $this->session_key);

        $nonce_ciphertext = $nonce.$ciphertext;

        $nonce_ciphertext_b64 = base64_encode($nonce_ciphertext);

        $options = session_get_cookie_params();

        if (isset($options['expires']) && $options['expires']) {

            $options['expires'] += time();

        }

        unset($options['lifetime']);

        setcookie($this->session_name, $nonce_ciphertext_b64, $options);

        return true;

    }

Member Data Documentation

$last_read

EncryptedCookieSession::$last_read

private

Definition at line 5059 of file grima-lib.php.

$save_path

EncryptedCookieSession::$save_path

private

Definition at line 5056 of file grima-lib.php.

Referenced by open().

$session_key

EncryptedCookieSession::$session_key

private

Definition at line 5058 of file grima-lib.php.

$session_name

EncryptedCookieSession::$session_name

private

Definition at line 5057 of file grima-lib.php.

Referenced by open(), and read().

---

The documentation for this class was generated from the following file:

• grimas/grima-lib.php