Skip to main content

Encoding and decoding arbitrary strings into strings that are safe to put into a URL query param.

Project description

Build Status Coverage Status

Query string safe Base64

Encoding and decoding arbitrary strings into strings that are safe to put into a URL query param.

The problem

urlsafe_b64encode and urlsafe_b64decode from base64 are not enough because they leave = chars unquoted:

>>> import base64

>>> base64.urlsafe_b64encode('a')
>>> 'YQ=='

And there are 2 problems with that

  1. = sign gets quoted:

>>> import urllib

>>> urllib.quote('=')
'%3D'
  1. Some libraries tolerate the = in query string values:

    from urlparse import urlsplit, parse_qs

    parse_qs(urlsplit(’http://aaa.com/asa?q=AAAA=BBBB=CCCC’).query) {‘q’: [‘AAAA=BBBB=CCCC’]}

but the RFC 3986 underspecifies the query string so we cannot rely on = chars being handled by all web applications as it is done by urlparse.

Therefore we consider chars: ['+', '/', '='] unsafe and we replace them with ['-', '_', '.']. Characters + and / are already handled by urlsafe_* functions from base64 so only = is left for us. The . character has been chosen because it often appears in real world query strings and it is not used by base64.

The solution

>>> import querystringsafe_base64

>>> querystringsafe_base64.encode('foo-bar')
>>> 'Zm9vLWJhcg..'

>>> querystringsafe_base64.decode('Zm9vLWJhcg..')
>>> 'foo-bar'

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

querystringsafe_base64-1.0.0.tar.gz (4.3 kB view details)

Uploaded Source

File details

Details for the file querystringsafe_base64-1.0.0.tar.gz.

File metadata

File hashes

Hashes for querystringsafe_base64-1.0.0.tar.gz
Algorithm Hash digest
SHA256 46b4152bb4233c9850fe9cf5309356c7a3dfb43306f46fd124c96b4955c04643
MD5 92c82116d6d4f8f72e1c2b76d4475ce3
BLAKE2b-256 cde725318a71322ec2c8bf3beeb58ad9fb8e0b72297818299e948bb166b07ab3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page