viewstate 0.5.3

Install

$ pip install viewstate

Usage

The Viewstate decoder accepts Base64 encoded .NET viewstate data and returns the decoded output in the form of plain Python objects.

There are two main ways to use this package. First, it can be used as an imported library with the following typical use case:

>>> from viewstate import ViewState
>>> base64_encoded_viewstate = '/wEPBQVhYmNkZQ9nAgE='
>>> vs = ViewState(base64_encoded_viewstate)
>>> vs.decode()
('abcde', (True, 1))

It is also possible to feed the raw bytes directly:

>>> vs = ViewState(raw=b'\xff\x01....')

Alternatively, the library can be used via command line by directly executing the module:

$ cat data.base64 | python -m viewstate

Which will pretty-print the decoded data structure.

The command line usage can also accept raw bytes with the -r flag:

$ cat data.base64 | base64 -d | python -m viewstate -r

Viewstate HMAC signatures are also supported. In case there are any remaining bytes after parsing, they are assumed to be HMAC signatures, with the types estimated according to signature length.

>>> vs = ViewState(signed_view_state)
>>> vs.decode()
>>> vs.mac
'hmac_sha256'
>>> vs.signature
b'....'

Development

Development packages can be installed with pipenv. Unit tests and code formatting tasks can be run with the builtin scripts:

$ pipenv sync -d
$ pipenv run test
$ pipenv run format

For PyPI releases, follow the build, check and upload scripts.

$ pipenv run build
$ pipenv run check
$ pipenv run upload

Note that for uploading a new package version, a valid PyPI auth token should be defined in ~/.pypirc.

References

Since there is no publically available specification of how .NET viewstate is encoded, reverse engineering was based on prior work:

• https://github.com/mutantzombie/JavaScript-ViewState-Parser

• http://viewstatedecoder.azurewebsites.net/

• https://referencesource.microsoft.com/#System.Web/UI/ObjectStateFormatter.cs,45

• https://msdn.microsoft.com/en-us/library/ms972976.aspx

Any official documents would be gladly accepted to help improve the parsing logic.

License

MIT