django-otp-twilio

PyPI Documentation Source

This is a django-otp plugin that delivers tokens via Twilio’s SMS service.

See django-otp for more information on the OTP framework.

Installation

django-otp-twilio can be installed via pip:

pip install django-otp-twilio

Once installed it should be added to INSTALLED_APPS after django_otp core:

INSTALLED_APPS = [
    ...
    'django_otp',
    'django_otp.plugins.otp_totp',
    'django_otp.plugins.otp_hotp',
    'django_otp.plugins.otp_static',

    'otp_twilio',
]

Twilio SMS Devices

class otp_twilio.models.TwilioSMSDevice(*args, **kwargs)[source]

A SideChannelDevice that delivers a token via the Twilio SMS service.

The tokens are valid for OTP_TWILIO_TOKEN_VALIDITY seconds. Once a token has been accepted, it is no longer valid.

number

CharField: The mobile phone number to deliver to. Twilio recommends using the E.164 format. For US numbers, this would look like ‘+15555555555’. At the time of writing, Twilio will try to infer the correct E.164 format if it is not used, but this should not be relied upon.

exception DoesNotExist
exception MultipleObjectsReturned
generate_challenge()[source]

Sends the current TOTP token to self.number.

Returns:OTP_TWILIO_CHALLENGE_MESSAGE on success.
Raises:Exception if delivery fails.
verify_token(token)[source]

Verifies a token by content and expiry.

On success, the token is cleared and the device saved.

Parameters:token (string) – The OTP token provided by the user.
Return type:bool

Admin

The following ModelAdmin subclass is registered with the default admin site. We recommend its use with custom admin sites as well:

class otp_twilio.admin.TwilioSMSDeviceAdmin(model, admin_site)[source]

ModelAdmin for TwilioSMSDevice.

Settings

OTP_TWILIO_ACCOUNT

Default: None

Your Twilio account ID.

OTP_TWILIO_AUTH

Default: None

Your Twilio auth token.

OTP_TWILIO_CHALLENGE_MESSAGE

Default: "Sent by SMS"

The message returned by generate_challenge(). This may contain '{token}', which will be replaced by the token. This completely negates any security benefit to the device, but it’s handy for development, especially in combination with OTP_TWILIO_NO_DELIVERY.

OTP_TWILIO_FROM

Default: None

The phone number to send SMS messages from. This must be one of your Twilio numbers.

OTP_TWILIO_NO_DELIVERY

Default: False

Send tokens to the ‘otp_twilio.models’ logger instead of delivering them by SMS. Useful for development.

OTP_TWILIO_THROTTLE_FACTOR

Default: 1

This controls the rate of throttling. The sequence of 1, 2, 4, 8… seconds is multiplied by this factor to define the delay imposed after 1, 2, 3, 4… successive failures. Set to 0 to disable throttling completely.

OTP_TWILIO_TOKEN_TEMPLATE

Default: "{token}"

A string template for generating the token message. By default, this is just the token itself, but you can customize it. The template will be rendered with Python string formatting (template.format(token=token)).

OTP_TWILIO_TOKEN_VALIDITY

Default: 30

The number of seconds for which a delivered token will be valid.

Changes

Change Log

License

Copyright (c) 2012, Peter Sagerson All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.