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](https://travis-ci.org/ClearcodeHQ/querystringsafe_base64.svg?branch=master)](https://travis-ci.org/ClearcodeHQ/querystringsafe_base64) [![Coverage Status](https://img.shields.io/coveralls/ClearcodeHQ/querystringsafe_base64.svg)](https://coveralls.io/r/ClearcodeHQ/querystringsafe_base64)

# 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'
    
  2. 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.

Files for querystringsafe-base64, version 0.1.5
Filename, size File type Python version Upload date Hashes
Filename, size querystringsafe_base64-0.1.5.tar.gz (4.0 kB) File type Source Python version None Upload date Hashes View
Filename, size querystringsafe_base64-0.1.5-py2.7.egg (4.2 kB) File type Egg Python version 2.7 Upload date Hashes View
Filename, size querystringsafe_base64-0.1.5-py2.6.egg (4.2 kB) File type Egg Python version 2.6 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page