Session Proxy Examples

The session proxy mechanism has a variety of uses and this article demonstrates two common uses. Rather than using the regular session handler, you can create a custom save handler by defining a class that extends the SessionHandlerProxy class.

セッション プロキシ メカニズムにはさまざまな用途がありますが、この記事では 2 つの一般的な用途を示します。通常のセッション ハンドラーを使用する代わりに、SessionHandlerProxy クラスを拡張するクラスを定義することにより、カスタムの保存ハンドラーを作成できます。

Then, define the class as a service. If you're using the default services.yaml configuration, that happens automatically.

次に、クラスをサービスとして定義します。デフォルトの services.yaml 構成を使用している場合、これは自動的に行われます。

Finally, use the framework.session.handler_id configuration option to tell Symfony to use your session handler instead of the default one:

最後に、framework.session.handler_id 設定オプションを使用して、Symfony にデフォルトのセッション ハンドラーの代わりに独自のセッション ハンドラーを使用するように指示します。
  • YAML
    YAML
  • XML
    XML
  • PHP
    PHP
1
2
3
4
5
 
# config/packages/framework.yaml
framework:
    session:
        # ...
        handler_id: App\Session\CustomSessionHandler

Keep reading the next sections to learn how to use the session handlers in practice to solve two common use cases: encrypt session information and define read-only guest sessions.

次のセクションを読み続けて、セッション ハンドラーを実際に使用して、セッション情報の暗号化と読み取り専用ゲスト セッションの定義という 2 つの一般的なユース ケースを解決する方法を学習してください。

Encryption of Session Data

If you want to encrypt the session data, you can use the proxy to encrypt and decrypt the session as required. The following example uses the php-encryption library, but you can adapt it to any other library that you may be using:

セッション データを暗号化する場合は、必要に応じてプロキシを使用してセッションを暗号化および復号化できます。次の例では php-encryptionlibrary を使用していますが、使用している可能性のある他のライブラリに適応させることができます。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
// src/Session/EncryptedSessionProxy.php
namespace App\Session;

use Defuse\Crypto\Crypto;
use Defuse\Crypto\Key;
use Symfony\Component\HttpFoundation\Session\Storage\Proxy\SessionHandlerProxy;

class EncryptedSessionProxy extends SessionHandlerProxy
{
    private $key;

    public function __construct(\SessionHandlerInterface $handler, Key $key)
    {
        $this->key = $key;

        parent::__construct($handler);
    }

    public function read($id)
    {
        $data = parent::read($id);

        return Crypto::decrypt($data, $this->key);
    }

    public function write($id, $data)
    {
        $data = Crypto::encrypt($data, $this->key);

        return parent::write($id, $data);
    }
}

Read-only Guest Sessions

There are some applications where a session is required for guest users, but where there is no particular need to persist the session. In this case you can intercept the session before it is written:

一部のアプリケーションでは、ゲスト ユーザーにセッションが必要ですが、セッションを永続化する必要は特にありません。この場合、書き込まれる前にセッションをインターセプトできます。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
// src/Session/ReadOnlySessionProxy.php
namespace App\Session;

use App\Entity\User;
use Symfony\Bundle\SecurityBundle\Security;
use Symfony\Component\HttpFoundation\Session\Storage\Proxy\SessionHandlerProxy;

class ReadOnlySessionProxy extends SessionHandlerProxy
{
    private $security;

    public function __construct(\SessionHandlerInterface $handler, Security $security)
    {
        $this->security = $security;

        parent::__construct($handler);
    }

    public function write($id, $data)
    {
        if ($this->getUser() && $this->getUser()->isGuest()) {
            return;
        }

        return parent::write($id, $data);
    }

    private function getUser()
    {
        $user = $this->security->getUser();
        if (is_object($user)) {
            return $user;
        }
    }
}