Skip to main content

Ticket authentication system similar to mod_auth_tkt used by Apache

Project description

Simple library that provides a mod_auth_tkt like hashed tickets that can be used for storing user authentication details.

The library is not interchangable with the mod_auth_tkt format, as the mod_auth_tkt does not provide support for ipv6 addresses and different hash algorithms, whereas ticket_auth provides both.


The general format for using the library is to instantiate the ticket factory used to generate the tickets, and then create new tickets or validate existing tickets using that factory. For example:

# The ticket factory takes a bytes argument specifying the secret
# identifier, and a optional algorithm (defaults to sha512). Possible
# algorithms are those specified by the python hashlib library
factory = TicketFactory(b'secret', hashalg='md5')

# The new function returns a new ticket (as a string). It takes a user
# identifier as a argument, along with several optional arguments. The
# valid_until argument is the time at which the ticket expires.
valid_until = time.time() + 60
ticket ='test_id', valid_until=valid_until)

# A ticket can be validated with the validate function. It returns a
# TicketInfo value on success, or raises an error on failure
info = factory.validate(ticket)

Tickets can also be bound to a particular client ip address by passing a ip address like object (either string, or from module ip_address) as the client_ip argument when creating and validating the string. For example:

valid_until = time.time() + 60
ticket ='test_id', valid_until=valid_until,

info = factory.validate(ticket, client_ip='')

A sequence of tokens can also be passed, which will be added to the ticket. Note that these tokens (like the user id and user data) are stored in plain text format:

ticket ='test_id', valid_until=valid_until, tokens=('a', 'b'),
                     user_data='some data')

The TicketInfo object returned by the validate function is a named tuple with the following parameters: digest (hash function output), user_id, tokens, user_data, valid_until.


The library is licensed under a MIT license.

Project details

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
ticket_auth-0.1.4-py3-none-any.whl (6.8 kB) Copy SHA256 hash SHA256 Wheel 3.5 Feb 21, 2016
ticket_auth-0.1.4.tar.gz (4.2 kB) Copy SHA256 hash SHA256 Source None Feb 21, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page