Lors de la création du premier namespace de session, Zend_Session va automatiquement démarrer la session PHP, sauf si celle-ci a été démarrée avec Zend_Session::start() auparavant. La session PHP résultante utilisera les options de configuration par défaut de Zend_Session, sauf si ceux-ci ont été modifiés à l'aide de Zend_Session::setOptions().

Pour assigner une option de configuration, passez son nom (la partie qui suit "session." dans les options de configuration de ext/session) comme clé au tableau passé à Zend_Session::setOptions(). La valeur correspondante dans le tableau sera alors utilisée comme valeur de l'option. Si vous omettez une option, alors celles par défaut recommandées par Zend_Session seront utilisées, sinon si elles n'existent pas, les valeurs par défaut de php.ini. Les retours et les idées quant aux "options recommandées" sont appréciées et peuvent être envoyées à fw-auth@lists.zend.com.

; Paramètres de production
[production]
; bug_compat_42
; bug_compat_warn
; cache_expire
; cache_limiter
; cookie_domain
; cookie_lifetime
; cookie_path
; cookie_secure
; entropy_file
; entropy_length
; gc_divisor
; gc_maxlifetime
; gc_probability
; hash_bits_per_character
; hash_function
; name doit être unique pour chaque application partageant le même nom de domaine
name = UNIQUE_NAME
; referer_check
; save_handler
; save_path
; serialize_handler
; use_cookies
; use_only_cookies
; use_trans_sid

; remember_me_seconds = <integer seconds>
; strict = on|off

; Development hérite de production, mais redéfinit certaines valeurs
[development : production]
; N'oubliez pas de créer ce dossier et d'attribuer à PHP les droits 'rwx'.
save_path = /home/myaccount/zend_sessions/myapp
use_only_cookies = on
; Le cookie de session durera 10 jours
remember_me_seconds = 864000

$config = new Zend_Config_Ini('myapp.ini', 'development');

require_once 'Zend/Session.php';
Zend_Session::setOptions($config->toArray());

La plupart des options ne nécessitent pas d'explications étant donné qu'elles font parti des options de ext/session, documentées dans le manuel officiel de PHP, cependant les options particulières méritent une description:

Si vous voyez l'erreur, "Cannot modify header information - headers already sent", ou, "You must call ... before any output has been sent to the browser; output started in ...", analysez tout de suite d'où vient la fuite grâce au message d'erreur. Toute action entraînant un envoi d'en-têtes HTTP, comme envoyer un cookie, doit être effectuée avant d'envoyer du contenu standard (non bufferisé), sauf si le buffer de sortie de PHP est activé.

Les bonnes pratiques d'utilisation des sessions avec Zend Framework passent par un cookie, plutôt que se reporter à l'URL concernant l'identifiant de session. Par défaut, le composant Zend_Session est bloqué sur l'utilisation unique du cookie comme moyen de propagation de l'identifiant de session. La session PHP va alors utiliser cet identifiant de manière à identifier de manière unique chaque client (navigateur) qui s'y connecte, et maintenir un état entre leurs transactions, donnant l'impression de conservation de données. Zend_Session_* utilise alors le tableau ($_SESSION) et vous y donne accès d'une manière objet élégante. Attention, si un attaquant arrive à accéder au cookie de session d'une victime, il pourra alors tromper le serveur, et se faire passer pour la victime. Ce comportement n'est pas unique à PHP, ni à Zend Framework, mais au Web en général, et au protocole HTTP. La méthode regenerateId() permet de changer l'identifiant de session stocké dans le cookie du client, par un autre, en théorie imprévisible. Notez que par la suite, nous confondons les termes 'client' et 'navigateur', même si ceci n'est pas tout à fait juste.

Changer l'identifiant de session permet d'aider contre le vol de données. Si un attaquant possède l'identifiant d'une victime, le changer ne changera rien pour la victime, mais provoquera une invalidation de la session de l'attaquant, qui ne connaît alors pas la nouvelle valeur de l'identifiant de session. Non seulement regenerateId() change l'identifiant de session, mais en plus il migre les données de l'ancien identifiant vers le nouveau, invalidant totalement l'ancien.

Quand régénérer cet identifiant ? En théorie, mettre Zend_Session::regenerateId() en bootstrap est la manière la plus adaptée pour sécuriser une session. Cependant, ceci a un coût non négligeable, car il faut alors à chaque fois régénérer un identifiant, et renvoyer un nouveau cookie au client. Il est alors nécessaire de déterminer les situations 'à risque', et régénérer alors l'identifiant de session dans de telles situations. Ces situations peuvent être par exemple l'authentification d'un client, ou encore son élévation de privilèges. Si vous appelez rememberMe(), n'appelez alors pas regenerateId(), car elle sera appelée de manière automatique.

$defaultNamespace = new Zend_Session_Namespace();

if (!isset($defaultNamespace->initialized)) {
    Zend_Session::regenerateId();
    $defaultNamespace->initialized = true;
}

Par défaut, la session se termine lorsque le client ferme son navigateur. Il peut cependant être nécessaire de faire en sorte que même après la fermeture, le cookie de session persiste un certain temps dans le navigateur. Utilisez Zend_Session::rememberMe() avant tout démarrage de la session, afin de spécifier à celle-ci qu'elle devra utiliser un cookie persistant du coté du client. Ce cookie persistera alors $seconds secondes. Si vous ne précisez pas de temps, remember_me_seconds, sera utilisé. Cette valeur se paramètre d'ailleurs au moyen de Zend_Session::setOptions().

Cette fonction est analogue à rememberMe() sauf qu'elle demande au cookie de session du navigateur client d'être détruit à la fermeture de celui-ci (et non éventuellement après X temps).

Utilisez cette méthode afin de savoir si une session existe pour le client (la requête) actuel. Ceci doit être utilisé avant le démarrage de la session.

Zend_Session::destroy() détruit la session et toutes les données la concernant. Cependant, aucune variable dans PHP n'est affectée, donc vos namespaces de session (instances de Zend_Session_Namespace) restent lisibles. Pour compléter la "déconnexion", laissez le premier paramètre à TRUE (par défaut), demandant l'expiration du cookie de session du client. $readonly permet d'empêcher la future création de namespaces (new Zend_Session_Namespace) ou des opérations d'écriture via Zend_Session.

Si vous voyez le message d'erreur "Cannot modify header information - headers already sent", alors tentez de ne pas utiliser TRUE comme valeur du premier argument (ceci demande l'expiration du cookie de session, ou voyez cette section. Ainsi, Zend_Session::destroy(true) doit être appelé avant tout envoi d'en-tête HTTP par PHP, ou alors la bufferisation de sortie doit être activée (sans que celui-ci ne déborde).

Cette méthode ne fait rien d'autre que de verrouiller la session en écriture. Tout appel futur d'écriture via des instances de Zend_Session_Namespace ou Zend_Session lèvera une exception.

Ferme la session coté serveur, soit enregistre les variables de session dans le support, et détache $_SESSION de son support de stockage. Le paramètre optionnel $readonly empêche alors toute future écriture via Zend_Session ou Zend_Session_Namespace. Ces écritures lèveront une exception.

Cette méthode envoie un cookie d'identifiant de session périmé au client. Quelque fois cette technique est utilisée pour déconnecter le client de sa session.

Cette méthode propose une correspondance orientée objet de session_set_save_handler().

Cette méthode permet de déterminer si un namespace existe dans la session.

Utilisez Zend_Session::namespaceUnset($namespace) pour détruire un namespace entier de la session. Comme pour les tableaux PHP, si le tableau est détruit, les objets à l'intérieur ne le sont pas s'il reste des références vers eux dans d'autres tableaux ou objets toujours accessibles. Ainsi namespaceUnset() ne détruit pas "en profondeur" la variable de session associée au namespace. Voyez les références en PHP pour plus d'infos.

Déprécié: Utilisez getIterator() dans Zend_Session_Namespace. Cette méthode retourne un tableau du contenu du namespace $namespace. Si vous avez une raison de conserver cette méthode, faites nous part de vos remarques à fw-auth@lists.zend.com.

getIterator() retourne un ArrayObject contenant tous les noms des namespaces de session.