FlightPHP Session - Gestionnaire de sessions léger basé sur des fichiers

Ceci est un gestionnaire de sessions léger basé sur des fichiers, plugin pour le Flight PHP Framework. Il fournit une solution simple mais puissante pour gérer les sessions, avec des fonctionnalités comme des lectures de sessions non bloquantes, un chiffrement optionnel, une fonctionnalité d'auto-commit et un mode test pour le développement. Les données de session sont stockées dans des fichiers, ce qui en fait un choix idéal pour les applications qui n'ont pas besoin d'une base de données.

Si vous souhaitez utiliser une base de données, consultez le plugin ghostff/session qui propose de nombreuses fonctionnalités similaires mais avec un backend de base de données.

Visitez le dépôt Github pour le code source complet et les détails.

Installez le plugin via Composer :

composer require flightphp/session

Voici un exemple simple de l'utilisation du plugin flightphp/session dans votre application Flight :

require 'vendor/autoload.php';

use flight\Session;

$app = Flight::app();

// Enregistrer le service de session
$app->register('session', Session::class);

// Exemple de route avec utilisation de session
Flight::route('/login', function() {
    $session = Flight::session();
    $session->set('user_id', 123);
    $session->set('username', 'johndoe');
    $session->set('is_admin', false);

    echo $session->get('username'); // Affiche : johndoe
    echo $session->get('preferences', 'default_theme'); // Affiche : default_theme

    if ($session->get('user_id')) {
        Flight::json(['message' => 'L\'utilisateur est connecté !', 'user_id' => $session->get('user_id')]);
    }
});

Flight::route('/logout', function() {
    $session = Flight::session();
    $session->clear(); // Effacer toutes les données de session
    Flight::json(['message' => 'Déconnexion réussie']);
});

Flight::start();

Points clés

• Non-Blocking : Utilise read_and_close pour le démarrage de session par défaut, évitant les problèmes de verrouillage de session.
• Auto-Commit : Activé par défaut, les modifications sont enregistrées automatiquement à l'arrêt, sauf si désactivé.
• Stockage de fichiers : Les sessions sont stockées dans le répertoire temporaire du système sous /flight_sessions par défaut.

Vous pouvez personnaliser le gestionnaire de sessions en passant un tableau d'options lors de l'enregistrement :

// Oui, c'est un double tableau :)
$app->register('session', Session::class, [ [
    'save_path' => '/custom/path/to/sessions',         // Répertoire pour les fichiers de session
    'prefix' => 'myapp_',                              // Préfixe pour les fichiers de session
    'encryption_key' => 'a-secure-32-byte-key-here',   // Activer le chiffrement (32 octets recommandés pour AES-256-CBC)
    'auto_commit' => false,                            // Désactiver l'auto-commit pour un contrôle manuel
    'start_session' => true,                           // Démarrer la session automatiquement (par défaut : true)
    'test_mode' => false,                              // Activer le mode test pour le développement
    'serialization' => 'json',                         // Méthode de sérialisation : 'json' (par défaut) ou 'php' (léguée)
] ]);

Options de configuration

Par défaut, cette bibliothèque utilise la sérialisation JSON pour les données de session, ce qui est sécurisé et empêche les vulnérabilités d'injection d'objets PHP. Si vous devez stocker des objets PHP dans la session (non recommandé pour la plupart des applications), vous pouvez choisir la sérialisation PHP léguée :

• 'serialization' => 'json' (par défaut) :
  • Seuls les tableaux et les primitives sont autorisés dans les données de session.
  • Plus sécurisé : immunisé contre l'injection d'objets PHP.
  • Les fichiers sont préfixés avec J (JSON pur) ou F (JSON chiffré).
• 'serialization' => 'php' :
  • Permet de stocker des objets PHP (à utiliser avec précaution).
  • Les fichiers sont préfixés avec P (sérialisation PHP pure) ou E (sérialisation PHP chiffrée).

Note : Si vous utilisez la sérialisation JSON, tenter de stocker un objet lèvera une exception.

Commit manuel

Si vous désactivez l'auto-commit, vous devez manuellement enregistrer les modifications :

$app->register('session', Session::class, ['auto_commit' => false]);

Flight::route('/update', function() {
    $session = Flight::session();
    $session->set('key', 'value');
    $session->commit(); // Enregistrer explicitement les modifications
});

Sécurité des sessions avec chiffrement

Activez le chiffrement pour les données sensibles :

$app->register('session', Session::class, [
    'encryption_key' => 'your-32-byte-secret-key-here'
]);

Flight::route('/secure', function() {
    $session = Flight::session();
    $session->set('credit_card', '4111-1111-1111-1111'); // Chiffré automatiquement
    echo $session->get('credit_card'); // Déchiffré lors de la récupération
});

Régénération de session

Régénérez l'ID de session pour des raisons de sécurité (par exemple, après la connexion) :

Flight::route('/post-login', function() {
    $session = Flight::session();
    $session->regenerate(); // Nouvel ID, conserver les données
    // OU
    $session->regenerate(true); // Nouvel ID, supprimer les anciennes données
});

Exemple de middleware

Protégez les routes avec une authentification basée sur les sessions :

Flight::route('/admin', function() {
    Flight::json(['message' => 'Bienvenue sur le panneau d\'administration']);
})->addMiddleware(function() {
    $session = Flight::session();
    if (!$session->get('is_admin')) {
        Flight::halt(403, 'Accès refusé');
    }
});

Ceci est juste un exemple simple de l'utilisation dans un middleware. Pour un exemple plus approfondi, consultez la documentation sur le middleware.

La classe Session fournit ces méthodes :

• set(string $key, $value): Stocke une valeur dans la session.
• get(string $key, $default = null): Récupère une valeur, avec une valeur par défaut optionnelle si la clé n'existe pas.
• delete(string $key): Supprime une clé spécifique de la session.
• clear(): Supprime toutes les données de session, mais conserve le même nom de fichier pour la session.
• commit(): Enregistre les données de session actuelles sur le système de fichiers.
• id(): Retourne l'ID de session actuel.
• regenerate(bool $deleteOldFile = false): Régénère l'ID de session, y compris la création d'un nouveau fichier de session, en conservant toutes les anciennes données et le ancien fichier reste sur le système. Si $deleteOldFile est true, l'ancien fichier de session est supprimé.
• destroy(string $id): Détruit une session par ID et supprime le fichier de session du système. Ceci fait partie de l'interface SessionHandlerInterface et $id est requis. L'utilisation typique serait $session->destroy($session->id()).
• getAll() : Retourne toutes les données de la session actuelle.

Toutes les méthodes sauf get() et id() renvoient l'instance Session pour la chaîne.

Les contributions sont les bienvenues ! Forkez le dépôt, apportez vos modifications et soumettez une pull request. Signalez les bogues ou suggérez des fonctionnalités via le tracker d'issues Github.

Ce plugin est sous licence MIT. Consultez le dépôt Github pour plus de détails.