XoopsSessionHandler::validateId() - Code Metrics - Inspection of "Merge pull request #1589 from mambax7/feature/sess..." - XOOPS/XoopsCore25 - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 99fcf4...ecd419 )

by Michael
created 2025-12-29 13:40 UTC
XoopsSessionHandler::validateId() A

↳ Parent: Project
Complexity

Conditions	5
Paths	4
Size

Total Lines	22
Code Lines	14
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	1	Features	0
Metric	Value
cc	5
eloc	14
c	1
b	1
f	0
nc	4
nop	1
dl	0
loc	22
rs	9.4888
<?php
/**
 * XOOPS session handler
 *
 * You may not change or alter any portion of this comment or credits
 * of supporting developers from this source code or any supporting source code
 * which is considered copyrighted (c) material of the original comment or credit authors.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 * @copyright       (c) 2000-2025 XOOPS Project (https://xoops.org)
 * @license             GNU GPL 2 (https://www.gnu.org/licenses/gpl-2.0.html)
 * @package             kernel
 * @since               2.0.0
 * @author              Kazumi Ono (AKA onokazu) http://www.myweb.ne.jp/, http://jp.xoops.org/
 * @author              Taiwen Jiang <[email protected]>
 */

defined('XOOPS_ROOT_PATH') || exit('Restricted access');

/**
 * XOOPS session handler (PHP 8.0+ with full types and lazy timestamp updates)
 * @package             kernel
 *
 * @author              Kazumi Ono    <[email protected]>
 * @author              Taiwen Jiang <[email protected]>
 * @author              XOOPS Development Team
 * @copyright       (c) 2000-2025 XOOPS Project (https://xoops.org)
 */
class XoopsSessionHandler implements
    \SessionHandlerInterface,
    \SessionUpdateTimestampHandlerInterface
{
    /** @var XoopsDatabase */
    public $db;

    /** @var int */
    public $securityLevel = 3;

    protected array $bitMasks = [
        2 => ['v4' => 16, 'v6' => 64],
        3 => ['v4' => 24, 'v6' => 56],
        4 => ['v4' => 32, 'v6' => 128],
    ];

    public bool $enableRegenerateId = true;

    public function __construct(XoopsDatabase $db)
    {
        global $xoopsConfig;
        $this->db = $db;

        $lifetime = ($xoopsConfig['use_mysession'] && $xoopsConfig['session_name'] != '')
            ? $xoopsConfig['session_expire'] * 60
            : ini_get('session.cookie_lifetime');

        $secure = (XOOPS_PROT === 'https://');

        $host = parse_url(XOOPS_URL, PHP_URL_HOST);
        if (!is_string($host)) {

            $host = '';
        }
        $cookieDomain = XOOPS_COOKIE_DOMAIN;
        if (class_exists('\Xoops\RegDom\RegisteredDomain')) {
            if (!\Xoops\RegDom\RegisteredDomain::domainMatches($host, $cookieDomain)) {
                $cookieDomain = '';
            }
        }

        $options = [
            'lifetime' => $lifetime,
            'path'     => '/',
            'domain'   => $cookieDomain,
            'secure'   => $secure,
            'httponly' => true,
            'samesite' => 'Lax',
        ];
        session_set_cookie_params($options);
    }

    // --- SessionHandlerInterface (typed) ---

    public function open(string $savePath, string $sessionName): bool
    {
        return true;
    }

    public function close(): bool
    {
        $this->gc_force();
        return true;
    }

    public function read(string $sessionId): string|false
    {
        $ip = \Xmf\IPAddress::fromRequest();
        $sql = sprintf(
            'SELECT sess_data, sess_ip FROM %s WHERE sess_id = %s',
            $this->db->prefix('session'),
            $this->db->quote($sessionId)
        );

        $result = $this->db->queryF($sql);
        $result = /** @scrutinizer ignore-deprecated */ $this->db->queryF($sql);
        if (!$this->db->isResultSet($result)) {
            return false; // storage failure
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
        }

        $row = $this->db->fetchRow($result);
        $row = $this->db->fetchRow($result);
        if ($row === false) {
            return ''; // not found → empty string
        }

        [$sess_data, $sess_ip] = $row;

        if ($this->securityLevel > 1) {
            if (false === $ip->sameSubnet(
                    $sess_ip,
                    $this->bitMasks[$this->securityLevel]['v4'],
                    $this->bitMasks[$this->securityLevel]['v6']
                )) {
                return ''; // IP mismatch → treat as no data
            }
        }

        return $sess_data;
    }

    public function write(string $sessionId, string $data): bool
    {
        $remoteAddress = \Xmf\IPAddress::fromRequest()->asReadable();
        $sid = $this->db->quote($sessionId);
        $now = time();

        $sql = sprintf(
            'INSERT INTO %s (sess_id, sess_updated, sess_ip, sess_data)
             VALUES (%s, %u, %s, %s)
             ON DUPLICATE KEY UPDATE
             sess_updated = %u, sess_data = %s, sess_ip = %s',
            $this->db->prefix('session'),
            $sid,
            $now,
            $this->db->quote($remoteAddress),
            $this->db->quote($data),
            $now,
            $this->db->quote($data),
            $this->db->quote($remoteAddress)
        );

        $ok = $this->db->exec($sql);
        // update_cookie() only affects PHP versions with PHP_VERSION_ID < 70300 (see session74.php); on PHP 8+ it is effectively a no-op
        $this->update_cookie();
        return (bool)$ok;
    }

    public function destroy(string $sessionId): bool
    {
        $sql = sprintf(
            'DELETE FROM %s WHERE sess_id = %s',
            $this->db->prefix('session'),
            $this->db->quote($sessionId)
        );
        return (bool)$this->db->exec($sql);
    }

    public function gc(int $max_lifetime): int|false
    {
        if ($max_lifetime <= 0) {
            return 0;
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
        }
        $mintime = time() - $max_lifetime;
        $sql = sprintf(
            'DELETE FROM %s WHERE sess_updated < %u',
            $this->db->prefix('session'),
            $mintime
        );
        if ($this->db->exec($sql)) {
            return (int)$this->db->getAffectedRows();
            return (int)$this->db->/** @scrutinizer ignore-call */ getAffectedRows();
        }
        return false;
    }

    // --- SessionUpdateTimestampHandlerInterface (8.0+) ---

    /**
     * Validate that the stored session IP matches the current client IP
     * according to the configured security level and bit masks.
     */
    private function validateSessionIp(?string $storedIp): bool
    {
        // Low security levels or missing configuration do not enforce IP checks
        if ($this->securityLevel <= 1) {
            return true;
        }

        if (empty($storedIp) || !isset($_SERVER['REMOTE_ADDR'])) {
            // If we cannot reliably determine either side, keep previous behavior
            return true;
        }

        $clientIp = (string)$_SERVER['REMOTE_ADDR'];

        $levelMasks = $this->bitMasks[$this->securityLevel] ?? null;
        if ($levelMasks === null) {
            return true;
        }

        // Determine IP version and ensure both addresses are of the same family
        $isClientV4 = filter_var($clientIp, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4) !== false;
        $isClientV6 = filter_var($clientIp, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6) !== false;
        $isStoredV4 = filter_var($storedIp, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4) !== false;
        $isStoredV6 = filter_var($storedIp, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6) !== false;

        if ($isClientV4 && $isStoredV4) {
            $version = 'v4';
        } elseif ($isClientV6 && $isStoredV6) {
            $version = 'v6';
        } else {
            // Mixed or invalid IP families - do not enforce IP binding
            return true;
        }

        $bits = $levelMasks[$version] ?? null;
        if ($bits === null) {
            return true;
        }

        $clientBin = @inet_pton($clientIp);
        $storedBin = @inet_pton($storedIp);
        if ($clientBin === false || $storedBin === false || $clientBin === null || $storedBin === null) {
            // If binary conversion fails, fall back to previous permissive behavior
            return true;
        }

        return $this->applyIpMask($clientBin, $bits) === $this->applyIpMask($storedBin, $bits);
        return $this->/** @scrutinizer ignore-call */ applyIpMask($clientBin, $bits) === $this->applyIpMask($storedBin, $bits);
    }

    /**
     * Apply an N-bit network mask to a binary IP address.
     */
    private function applyIpMask(string $ipBin, int $bits): string
    {
        $bytes      = strlen($ipBin);
        $masked     = '';
        $fullBytes  = intdiv($bits, 8);
        $remaining  = $bits % 8;

        for ($i = 0; $i < $bytes; $i++) {
            $byte = ord($ipBin[$i]);
            if ($i < $fullBytes) {
                // Completely within the network portion
                $masked .= chr($byte);
            } elseif ($i === $fullBytes && $remaining > 0) {
                // Partially masked byte
                $mask   = (0xFF << (8 - $remaining)) & 0xFF;
                $masked .= chr($byte & $mask);
            } else {
                // Host portion is zeroed
                $masked .= chr(0);
            }
        }

        return $masked;
    }

    public function validateId(string $id): bool
    {
        $sql = sprintf(
            'SELECT sess_ip FROM %s WHERE sess_id = %s',
            $this->db->prefix('session'),
            $this->db->quote($id)
        );
        $res = $this->db->queryF($sql, 1, 0);
        $res = /** @scrutinizer ignore-deprecated */ $this->db->queryF($sql, 1, 0);
        if (!$this->db->isResultSet($res)) {
            return false;
        }
        $row = $this->db->fetchRow($res);
        if ($row === false) {
            return false;
        }

        $storedIp = $row[0] ?? null;
        if (!$this->validateSessionIp(is_string($storedIp) ? $storedIp : null)) {
        if (!$this->/** @scrutinizer ignore-call */ validateSessionIp(is_string($storedIp) ? $storedIp : null)) {
            return false;
        }

        return true;
    }

    public function updateTimestamp(string $id, string $data): bool
    {
        $sql = sprintf(
            'UPDATE %s SET sess_updated = %u WHERE sess_id = %s',
            $this->db->prefix('session'),
            time(),
            $this->db->quote($id)
        );
        return (bool)$this->db->exec($sql);
    }

    // --- Helpers (same behavior as your current code) ---

    public function gc_force(): void
    {
        /*
         * Probabilistic garbage collection:
         * - We run GC with approximately 10% probability on each call.
         * - \random_int() is used instead of mt_rand() for modern, secure randomness.
         *   The range [1, 100] and threshold < 11 are chosen to preserve the
         *   original ~10% behavior from the mt_rand()-based implementation.
         * - Any failure of \random_int() is ignored so that session handling
         *   is not disrupted if a random source is temporarily unavailable.
         */
        try {
            if (\random_int(1, 100) < 11) {
                $expire = (int) @ini_get('session.gc_maxlifetime');
                if ($expire <= 0) {
                    $expire = 900;
                }
                $this->gc($expire);
            }
        } catch (\Throwable $e) {
            // ignore
        }
    }

    public function regenerate_id(bool $delete_old_session = false): bool
    {
        $success = $this->enableRegenerateId
            ? session_regenerate_id($delete_old_session)
            : true;

        if ($success) {
            $this->update_cookie();
        }
        return $success;
    }

    public function update_cookie($sess_id = null, $expire = null): void
    public function update_cookie($sess_id = null, /** @scrutinizer ignore-unused */ $expire = null): void
    {
        // no-op for 8.0+; retained for parity with 7.4 implementation
    }
}

XOOPS / XoopsCore25

Push — master ( 99fcf4...ecd419 )

XoopsSessionHandler::validateId() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
