A serialized PHP value, in the format used by PHP's built-in serialize and
unserialize functions. This format closely mirrors PHP's data model:
it supports all of PHP's scalar types (NULL, booleans, numbers, strings),
associative arrays, objects, and recursive data structures using references.
The only PHP values not supported by this format are resources,
which usually correspond to native file or connection handles and cannot be
meaningfully serialized.
There is no official documentation for this data format;
this spec was created based on the PHP source code and the behavior of
serialize/unserialize. PHP makes no guarantees about compatibility of
serialized data between PHP versions, but in practice, the format has
remained fully backwards-compatible - values serialized by an older
PHP version can be unserialized on any newer PHP version.
This spec supports serialized values from PHP 7.3 or any earlier version.
This page hosts a formal specification of Serialized PHP value using Kaitai Struct. This specification can be automatically translated into a variety of programming languages to get a parsing library.
All parsing code for Python generated by Kaitai Struct depends on the Python runtime library. You have to install it before you can parse data.
The Python runtime library can be installed from PyPI:
python3 -m pip install kaitaistructParse a local file and get structure in memory:
data = PhpSerializedValue.from_file("path/to/local/file.bin")
Or parse structure from a bytes:
from kaitaistruct import KaitaiStream, BytesIO
raw = b"\x00\x01\x02..."
data = PhpSerializedValue(KaitaiStream(BytesIO(raw)))
After that, one can get various attributes from the structure by invoking getter methods like:
data.type # => A single-character code indicating the type of the serialized value.
# This is a generated file! Please edit source .ksy file and use kaitai-struct-compiler to rebuild
import kaitaistruct
from kaitaistruct import KaitaiStruct, KaitaiStream, BytesIO
from enum import Enum
if getattr(kaitaistruct, 'API_VERSION', (0, 9)) < (0, 9):
raise Exception("Incompatible Kaitai Struct Python API: 0.9 or later is required, but you have %s" % (kaitaistruct.__version__))
class PhpSerializedValue(KaitaiStruct):
"""A serialized PHP value, in the format used by PHP's built-in `serialize` and
`unserialize` functions. This format closely mirrors PHP's data model:
it supports all of PHP's scalar types (`NULL`, booleans, numbers, strings),
associative arrays, objects, and recursive data structures using references.
The only PHP values not supported by this format are *resources*,
which usually correspond to native file or connection handles and cannot be
meaningfully serialized.
There is no official documentation for this data format;
this spec was created based on the PHP source code and the behavior of
`serialize`/`unserialize`. PHP makes no guarantees about compatibility of
serialized data between PHP versions, but in practice, the format has
remained fully backwards-compatible - values serialized by an older
PHP version can be unserialized on any newer PHP version.
This spec supports serialized values from PHP 7.3 or any earlier version.
.. seealso::
Source - https://www.php.net/manual/en/function.serialize.php
.. seealso::
Source - https://www.php.net/manual/en/function.serialize.php#66147
.. seealso::
Source - https://www.php.net/manual/en/function.unserialize.php
.. seealso::
Source - https://github.com/php/php-src/blob/php-7.3.5/ext/standard/var_unserializer.re
.. seealso::
Source - https://github.com/php/php-src/blob/php-7.3.5/ext/standard/var.c#L822
"""
class ValueType(Enum):
custom_serialized_object = 67
null = 78
object = 79
variable_reference = 82
php_6_string = 83
array = 97
bool = 98
float = 100
int = 105
php_3_object = 111
object_reference = 114
string = 115
class BoolValue(Enum):
false = 48
true = 49
def __init__(self, _io, _parent=None, _root=None):
self._io = _io
self._parent = _parent
self._root = _root if _root else self
self._read()
def _read(self):
self.type = KaitaiStream.resolve_enum(PhpSerializedValue.ValueType, self._io.read_u1())
_on = self.type
if _on == PhpSerializedValue.ValueType.custom_serialized_object:
self.contents = PhpSerializedValue.CustomSerializedObjectContents(self._io, self, self._root)
elif _on == PhpSerializedValue.ValueType.php_3_object:
self.contents = PhpSerializedValue.Php3ObjectContents(self._io, self, self._root)
elif _on == PhpSerializedValue.ValueType.object:
self.contents = PhpSerializedValue.ObjectContents(self._io, self, self._root)
elif _on == PhpSerializedValue.ValueType.variable_reference:
self.contents = PhpSerializedValue.IntContents(self._io, self, self._root)
elif _on == PhpSerializedValue.ValueType.php_6_string:
self.contents = PhpSerializedValue.StringContents(self._io, self, self._root)
elif _on == PhpSerializedValue.ValueType.float:
self.contents = PhpSerializedValue.FloatContents(self._io, self, self._root)
elif _on == PhpSerializedValue.ValueType.object_reference:
self.contents = PhpSerializedValue.IntContents(self._io, self, self._root)
elif _on == PhpSerializedValue.ValueType.null:
self.contents = PhpSerializedValue.NullContents(self._io, self, self._root)
elif _on == PhpSerializedValue.ValueType.bool:
self.contents = PhpSerializedValue.BoolContents(self._io, self, self._root)
elif _on == PhpSerializedValue.ValueType.int:
self.contents = PhpSerializedValue.IntContents(self._io, self, self._root)
elif _on == PhpSerializedValue.ValueType.array:
self.contents = PhpSerializedValue.ArrayContents(self._io, self, self._root)
elif _on == PhpSerializedValue.ValueType.string:
self.contents = PhpSerializedValue.StringContents(self._io, self, self._root)
class CountPrefixedMapping(KaitaiStruct):
"""A mapping (a sequence of key-value pairs) prefixed with its size."""
def __init__(self, _io, _parent=None, _root=None):
self._io = _io
self._parent = _parent
self._root = _root if _root else self
self._read()
def _read(self):
self.num_entries_dec = (self._io.read_bytes_term(58, False, True, True)).decode(u"ASCII")
self.opening_brace = self._io.read_bytes(1)
if not self.opening_brace == b"\x7B":
raise kaitaistruct.ValidationNotEqualError(b"\x7B", self.opening_brace, self._io, u"/types/count_prefixed_mapping/seq/1")
self.entries = []
for i in range(self.num_entries):
self.entries.append(PhpSerializedValue.MappingEntry(self._io, self, self._root))
self.closing_brace = self._io.read_bytes(1)
if not self.closing_brace == b"\x7D":
raise kaitaistruct.ValidationNotEqualError(b"\x7D", self.closing_brace, self._io, u"/types/count_prefixed_mapping/seq/3")
@property
def num_entries(self):
"""The number of key-value pairs in the mapping, parsed as an integer.
"""
if hasattr(self, '_m_num_entries'):
return self._m_num_entries
self._m_num_entries = int(self.num_entries_dec)
return getattr(self, '_m_num_entries', None)
class FloatContents(KaitaiStruct):
"""The contents of a floating-point value."""
def __init__(self, _io, _parent=None, _root=None):
self._io = _io
self._parent = _parent
self._root = _root if _root else self
self._read()
def _read(self):
self.colon = self._io.read_bytes(1)
if not self.colon == b"\x3A":
raise kaitaistruct.ValidationNotEqualError(b"\x3A", self.colon, self._io, u"/types/float_contents/seq/0")
self.value_dec = (self._io.read_bytes_term(59, False, True, True)).decode(u"ASCII")
class LengthPrefixedQuotedString(KaitaiStruct):
"""A quoted string prefixed with its length.
Despite the quotes surrounding the string data, it can contain
arbitrary bytes, which are never escaped in any way.
This does not cause any ambiguities when parsing - the bounds of
the string are determined only by the length field, not by the quotes.
"""
def __init__(self, _io, _parent=None, _root=None):
self._io = _io
self._parent = _parent
self._root = _root if _root else self
self._read()
def _read(self):
self.len_data_dec = (self._io.read_bytes_term(58, False, True, True)).decode(u"ASCII")
self.opening_quote = self._io.read_bytes(1)
if not self.opening_quote == b"\x22":
raise kaitaistruct.ValidationNotEqualError(b"\x22", self.opening_quote, self._io, u"/types/length_prefixed_quoted_string/seq/1")
self.data = self._io.read_bytes(self.len_data)
self.closing_quote = self._io.read_bytes(1)
if not self.closing_quote == b"\x22":
raise kaitaistruct.ValidationNotEqualError(b"\x22", self.closing_quote, self._io, u"/types/length_prefixed_quoted_string/seq/3")
@property
def len_data(self):
"""The length of the string's contents in bytes, parsed as an integer.
The quotes are not counted in this size number.
"""
if hasattr(self, '_m_len_data'):
return self._m_len_data
self._m_len_data = int(self.len_data_dec)
return getattr(self, '_m_len_data', None)
class ObjectContents(KaitaiStruct):
"""The contents of an object value serialized in the default format.
Unlike its PHP 3 counterpart, it contains a class name.
"""
def __init__(self, _io, _parent=None, _root=None):
self._io = _io
self._parent = _parent
self._root = _root if _root else self
self._read()
def _read(self):
self.colon1 = self._io.read_bytes(1)
if not self.colon1 == b"\x3A":
raise kaitaistruct.ValidationNotEqualError(b"\x3A", self.colon1, self._io, u"/types/object_contents/seq/0")
self.class_name = PhpSerializedValue.LengthPrefixedQuotedString(self._io, self, self._root)
self.colon2 = self._io.read_bytes(1)
if not self.colon2 == b"\x3A":
raise kaitaistruct.ValidationNotEqualError(b"\x3A", self.colon2, self._io, u"/types/object_contents/seq/2")
self.properties = PhpSerializedValue.CountPrefixedMapping(self._io, self, self._root)
class ArrayContents(KaitaiStruct):
"""The contents of an array value."""
def __init__(self, _io, _parent=None, _root=None):
self._io = _io
self._parent = _parent
self._root = _root if _root else self
self._read()
def _read(self):
self.colon = self._io.read_bytes(1)
if not self.colon == b"\x3A":
raise kaitaistruct.ValidationNotEqualError(b"\x3A", self.colon, self._io, u"/types/array_contents/seq/0")
self.elements = PhpSerializedValue.CountPrefixedMapping(self._io, self, self._root)
class CustomSerializedObjectContents(KaitaiStruct):
"""The contents of an object value that implements a custom
serialized format using `Serializable`.
"""
def __init__(self, _io, _parent=None, _root=None):
self._io = _io
self._parent = _parent
self._root = _root if _root else self
self._read()
def _read(self):
self.colon1 = self._io.read_bytes(1)
if not self.colon1 == b"\x3A":
raise kaitaistruct.ValidationNotEqualError(b"\x3A", self.colon1, self._io, u"/types/custom_serialized_object_contents/seq/0")
self.class_name = PhpSerializedValue.LengthPrefixedQuotedString(self._io, self, self._root)
self.colon2 = self._io.read_bytes(1)
if not self.colon2 == b"\x3A":
raise kaitaistruct.ValidationNotEqualError(b"\x3A", self.colon2, self._io, u"/types/custom_serialized_object_contents/seq/2")
self.len_data_dec = (self._io.read_bytes_term(58, False, True, True)).decode(u"ASCII")
self.opening_brace = self._io.read_bytes(1)
if not self.opening_brace == b"\x7B":
raise kaitaistruct.ValidationNotEqualError(b"\x7B", self.opening_brace, self._io, u"/types/custom_serialized_object_contents/seq/4")
self.data = self._io.read_bytes(self.len_data)
self.closing_quote = self._io.read_bytes(1)
if not self.closing_quote == b"\x7D":
raise kaitaistruct.ValidationNotEqualError(b"\x7D", self.closing_quote, self._io, u"/types/custom_serialized_object_contents/seq/6")
@property
def len_data(self):
"""The length of the serialized data in bytes, parsed as an integer.
The braces are not counted in this length number.
"""
if hasattr(self, '_m_len_data'):
return self._m_len_data
self._m_len_data = int(self.len_data_dec)
return getattr(self, '_m_len_data', None)
class NullContents(KaitaiStruct):
"""The contents of a null value (`value_type::null`). This structure
contains no actual data, since there is only a single `NULL` value.
"""
def __init__(self, _io, _parent=None, _root=None):
self._io = _io
self._parent = _parent
self._root = _root if _root else self
self._read()
def _read(self):
self.semicolon = self._io.read_bytes(1)
if not self.semicolon == b"\x3B":
raise kaitaistruct.ValidationNotEqualError(b"\x3B", self.semicolon, self._io, u"/types/null_contents/seq/0")
class Php3ObjectContents(KaitaiStruct):
"""The contents of a PHP 3 object value. Unlike its counterpart in PHP 4
and above, it does not contain a class name.
"""
def __init__(self, _io, _parent=None, _root=None):
self._io = _io
self._parent = _parent
self._root = _root if _root else self
self._read()
def _read(self):
self.colon = self._io.read_bytes(1)
if not self.colon == b"\x3A":
raise kaitaistruct.ValidationNotEqualError(b"\x3A", self.colon, self._io, u"/types/php_3_object_contents/seq/0")
self.properties = PhpSerializedValue.CountPrefixedMapping(self._io, self, self._root)
class BoolContents(KaitaiStruct):
"""The contents of a boolean value (`value_type::bool`)."""
def __init__(self, _io, _parent=None, _root=None):
self._io = _io
self._parent = _parent
self._root = _root if _root else self
self._read()
def _read(self):
self.colon = self._io.read_bytes(1)
if not self.colon == b"\x3A":
raise kaitaistruct.ValidationNotEqualError(b"\x3A", self.colon, self._io, u"/types/bool_contents/seq/0")
self.value_dec = KaitaiStream.resolve_enum(PhpSerializedValue.BoolValue, self._io.read_u1())
self.semicolon = self._io.read_bytes(1)
if not self.semicolon == b"\x3B":
raise kaitaistruct.ValidationNotEqualError(b"\x3B", self.semicolon, self._io, u"/types/bool_contents/seq/2")
@property
def value(self):
"""The value of the `bool`, parsed as a boolean."""
if hasattr(self, '_m_value'):
return self._m_value
self._m_value = self.value_dec == PhpSerializedValue.BoolValue.true
return getattr(self, '_m_value', None)
class StringContents(KaitaiStruct):
"""The contents of a string value.
Note: PHP strings can contain arbitrary byte sequences.
They are not necessarily valid text in any specific encoding.
"""
def __init__(self, _io, _parent=None, _root=None):
self._io = _io
self._parent = _parent
self._root = _root if _root else self
self._read()
def _read(self):
self.colon = self._io.read_bytes(1)
if not self.colon == b"\x3A":
raise kaitaistruct.ValidationNotEqualError(b"\x3A", self.colon, self._io, u"/types/string_contents/seq/0")
self.string = PhpSerializedValue.LengthPrefixedQuotedString(self._io, self, self._root)
self.semicolon = self._io.read_bytes(1)
if not self.semicolon == b"\x3B":
raise kaitaistruct.ValidationNotEqualError(b"\x3B", self.semicolon, self._io, u"/types/string_contents/seq/2")
@property
def value(self):
"""The value of the string, as a byte array."""
if hasattr(self, '_m_value'):
return self._m_value
self._m_value = self.string.data
return getattr(self, '_m_value', None)
class IntContents(KaitaiStruct):
"""The contents of an integer-like value:
either an actual integer (`value_type::int`) or a reference
(`value_type::variable_reference`, `value_type::object_reference`).
"""
def __init__(self, _io, _parent=None, _root=None):
self._io = _io
self._parent = _parent
self._root = _root if _root else self
self._read()
def _read(self):
self.colon = self._io.read_bytes(1)
if not self.colon == b"\x3A":
raise kaitaistruct.ValidationNotEqualError(b"\x3A", self.colon, self._io, u"/types/int_contents/seq/0")
self.value_dec = (self._io.read_bytes_term(59, False, True, True)).decode(u"ASCII")
@property
def value(self):
"""The value of the `int`, parsed as an integer."""
if hasattr(self, '_m_value'):
return self._m_value
self._m_value = int(self.value_dec)
return getattr(self, '_m_value', None)
class MappingEntry(KaitaiStruct):
"""A mapping entry consisting of a key and a value."""
def __init__(self, _io, _parent=None, _root=None):
self._io = _io
self._parent = _parent
self._root = _root if _root else self
self._read()
def _read(self):
self.key = PhpSerializedValue(self._io)
self.value = PhpSerializedValue(self._io)