# RFC: User defined session serializer

- Status: Declined
- Authors: Yasuo Ohgaki yohgaki@ohgaki.net
- Date: 2016-11-17
- Version: 1.0
- Original: https://wiki.php.net/rfc/user_defined_session_serializer
- Page: https://externals.io/rfc/user_defined_session_serializer
- More for agents: search with https://externals.io/search.md?q={query} · RFCs at https://externals.io/rfc.md · JSON API at https://externals.io/api · documentation at https://externals.io/llms.txt

## Votes

### Add user defined session serializer (closed)

Yes: 9 · No: 10

Voters: bwoebi (No), danack (No), guilhermeblanco (Yes), hywan (No), kalle (Yes), kguest (Yes), leigh (No), levim (No), lstrojny (Yes), mariano (Yes), mfischer (Yes), nikic (No), ocramius (No), peehaa (No), pierrick (No), remi (Yes), ryat (No), yohgaki (Yes), yunosh (Yes)

## Discussions on the mailing list

- [\[RFC DISCUSSION\] User defined session serializer](https://externals.io/message/96944.md) — started on 2016-11-17, 4 messages
- [\[RFC\]\[VOTE\] User defined session serializer](https://externals.io/message/97279.md) — started on 2016-12-05, 26 messages
- [\[RFC\]\[DISCUSSION\] Add clean and complete session save handler interface](https://externals.io/message/97343.md) — started on 2016-12-09, 1 messages

---

## Introduction

Currently, only C module can add additional session data serializer. With user defined session data serializer, users can

- Encrypt/decrypt session data transparently.
- Use any serialization format such as JSON/XML/etc.
- Add invisible data to session data for session data management purpose.
- Validate session data via hash\_hmac().

## Proposal

Add session serializer registration function.

```php
bool session_set_serializer(callable $serialize_func, callable $unserialize_func)
```

$serialize\_func and $unserialize\_func are:

```php
$serialize_func = function(array $session_data_array) {
  // User can add/encrypt data in this function
  // Returning anything other than string raises E_RECOVERABLE_ERROR
  return serialize($session_data_array); // Must return string
}
 
$unserialize_func = function(string $session_data_string) {
  // User can remove/decrypt/validate data in this function
  // Returning anything other than array raises E_RECOVERABLE_ERROR
  return unserialize($session_data_string); // Must return array
}
```

Add session serializer interface.

```php
interface SessionSerializerInterface {
  function encode(array $session_data_array):string;
  function decode(string $serialized_session_data_string):array;
}
```

session\_set\_serializer() accepts object implements SessionSerializerInterface.

```php
bool session_set_serializer(SessionSerializerInterface $handler)
```

These functions/methods are called before reading/writing session data to session data database.

Please refer to the pull request phpt files for usage details.

## Backward Incompatible Changes

None.

## Proposed PHP Version(s)

Next PHP. Currently 7.2.

## Future Scope

Current session modules OO user save handler uses internal save handler as its base object. This design caused many problems.

User defined session serializer can get rid of this design issue. There will be new and clean OO session save handler interface proposal. This RFC keeps extendability for new OO session save handler API.

## Proposed Voting Choices

2/3 majority is required to pass.

Vote starts: 2016-12-05 Vote ends: 2016-12-19 UTC 23:59:59

**Vote: Add user defined session serializer** — Yes: 9 · No: 10 (closed)

## Patches and Tests

- <https://github.com/php/php-src/pull/2205>

## Implementation

After the project is implemented, this section should contain

1. the version(s) it was merged to
2. a link to the git commit(s)
3. a link to the PHP manual entry for the feature
4. a link to the language specification section (if any)

## References

Links to external references, discussions or RFCs
