├── .bumpversion.cfg
├── .coveragerc
├── .flake8
├── .github
    └── workflows
    │   └── test.yaml
├── .gitignore
├── .hgignore
├── .readthedocs.yaml
├── CHANGES.rst
├── LICENSE
├── README.rst
├── docs
    ├── Makefile
    ├── ext
    │   └── otpdocs.py
    └── source
    │   ├── changes.rst
    │   ├── conf.py
    │   └── index.rst
├── pyproject.toml
├── src
    └── otp_twilio
    │   ├── __init__.py
    │   ├── admin.py
    │   ├── apps.py
    │   ├── conf.py
    │   ├── migrations
    │       ├── 0001_initial.py
    │       ├── 0002_last_t.py
    │       ├── 0003_longer_number.py
    │       ├── 0004_sidechanneldevice.py
    │       └── __init__.py
    │   ├── models.py
    │   └── tests.py
└── test
    └── test_project
        ├── __init__.py
        ├── settings.py
        ├── templates
            └── registration
            │   └── logged_out.html
        └── urls.py


/.bumpversion.cfg:
--------------------------------------------------------------------------------
 1 | [bumpversion]
 2 | current_version = 1.0.5
 3 | commit = true
 4 | message = Version {new_version}
 5 | tag = true
 6 | 
 7 | [bumpversion:file:CHANGES.rst]
 8 | search = Unreleased
 9 | replace = v{new_version} - {now:%B %d, %Y}
10 | 
11 | [bumpversion:file:pyproject.toml]
12 | search = version = "{current_version}"
13 | replace = version = "{new_version}"
14 | 
15 | [bumpversion:file:docs/source/conf.py]
16 | search = release = '{current_version}'
17 | replace = release = '{new_version}'
18 | 


--------------------------------------------------------------------------------
/.coveragerc:
--------------------------------------------------------------------------------
1 | [run]
2 | source = otp_twilio


--------------------------------------------------------------------------------
/.flake8:
--------------------------------------------------------------------------------
1 | [flake8]
2 | ignore =
3 |        # line break before binary operator
4 |        W503
5 |        # line break after binary operator
6 |        W504
7 |        # line too long
8 |        E501
9 | 


--------------------------------------------------------------------------------
/.github/workflows/test.yaml:
--------------------------------------------------------------------------------
 1 | name: Run tests
 2 | 
 3 | on:
 4 |   pull_request:
 5 |     branches: [ master ]
 6 | 
 7 | jobs:
 8 |   test:
 9 |     runs-on: ubuntu-latest
10 |     steps:
11 |       - uses: actions/checkout@v3
12 | 
13 |       - uses: actions/setup-python@v4
14 |         with:
15 |           python-version: |
16 |             3.9
17 |             3.11
18 |             3.13
19 | 
20 |       - name: Install hatch
21 |         run: pipx install hatch
22 | 
23 |       - name: Run tests
24 |         run: hatch run test:run
25 | 
26 |       - name: Build docs
27 |         run: hatch run docs:make
28 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | # Python
 2 | __pycache__/
 3 | 
 4 | # setuptools
 5 | /MANIFEST
 6 | /build/
 7 | /dist/
 8 | /docs/build/
 9 | *.egg-info/
10 | 
11 | # Other tools
12 | /.tox/
13 | /.coverage
14 | 


--------------------------------------------------------------------------------
/.hgignore:
--------------------------------------------------------------------------------
1 | # Don't remove this file.
2 | #
3 | # When hatch builds an sdist, it includes any .gitignore and .hgignore it can
4 | # find here or in parent directories. To avoid information leakage, this file
5 | # masks any .hgignore one might have in their home directory.
6 | 


--------------------------------------------------------------------------------
/.readthedocs.yaml:
--------------------------------------------------------------------------------
 1 | version: 2
 2 | 
 3 | build:
 4 |   os: ubuntu-22.04
 5 |   tools:
 6 |     python: '3.12'
 7 | 
 8 | sphinx:
 9 |   configuration: docs/source/conf.py
10 | 
11 | python:
12 |   install:
13 |     - method: pip
14 |       path: .
15 | 


--------------------------------------------------------------------------------
/CHANGES.rst:
--------------------------------------------------------------------------------
  1 | v1.0.5 - March 25, 2024 - Fix config validation
  2 | --------------------------------------------------------------------------------
  3 | 
  4 | Fix `#10`_: Messaging Service Does Not Work Without OTP_TWILIO_FROM Setting
  5 | 
  6 | .. _#10: https://github.com/django-otp/django-otp-twilio/pull/10
  7 | 
  8 | 
  9 | v1.0.4 - July 20, 2023 - Add OTP_TWILIO_MESSAGING_SERVICE_SID setting
 10 | --------------------------------------------------------------------------------
 11 | 
 12 | This project is now managed with `hatch`_, which replaces setuptools, pipenv,
 13 | and tox. Users of the package should not be impacted. Developers can refer to
 14 | the readme for details. If you're packaging this project from source, I suggest
 15 | relying on pip's isolated builds rather than using hatch directly.
 16 | 
 17 | `#9`_: OTP_TWILIO_MESSAGING_SERVICE_SID setting
 18 | 
 19 | .. _hatch: https://hatch.pypa.io/
 20 | .. _#9: https://github.com/django-otp/django-otp-twilio/pull/9
 21 | 
 22 | 
 23 | v1.0.3 - April 25, 2023 - Fix API key handling
 24 | --------------------------------------------------------------------------------
 25 | 
 26 | Fix `#6`_: Code uses "TWILIO_API_KEY" instead of "OTP_TWILIO_API_KEY"
 27 | 
 28 | .. _#6: https://github.com/django-otp/django-otp-twilio/pull/6
 29 | 
 30 | 
 31 | v1.0.2 - April 11, 2023 - New configuration options
 32 | --------------------------------------------------------------------------------
 33 | 
 34 | - Allow configuration of API URL and API key.
 35 | 
 36 | 
 37 | v1.0.1 - November 29, 2021 - Forward compatibility
 38 | --------------------------------------------------------------------------------
 39 | 
 40 | Default to AutoField to avoid spurious migrations.
 41 | 
 42 | 
 43 | v1.0.0 - August 13, 2020 - Update test matrix
 44 | --------------------------------------------------------------------------------
 45 | 
 46 | - Added Django 3.1 to the test environments and fixed deprecation warnings.
 47 | 
 48 | - Version bumped to align with the core django-otp project.
 49 | 
 50 | 
 51 | v0.6.0 - May 06, 2020 - ThrottlingMixin and SideChannelDevice
 52 | --------------------------------------------------------------------------------
 53 | 
 54 | TwilioSMSDevice is now a :class:`~django_otp.models.SideChannelDevice` and
 55 | implements :class:`~django_otp.models.ThrottlingMixin`.
 56 | 
 57 | This also drops support for old versions of Python (2.7) and Django (1.11,
 58 | 2.1).
 59 | 
 60 | Note that this version includes migrations that will invalidate any in-flight
 61 | tokens.
 62 | 
 63 | 
 64 | v0.5.1 - August 26, 2019 - Housekeeping
 65 | --------------------------------------------------------------------------------
 66 | 
 67 | Build, test, and documentation cleanup.
 68 | 
 69 | 
 70 | v0.5.0 - August 14, 2018 - Django 2.1 support
 71 | --------------------------------------------------------------------------------
 72 | 
 73 | - Drop support for Django < 1.11.
 74 | 
 75 | 
 76 | v0.4.2 - October 18, 2017 - Fix migration
 77 | --------------------------------------------------------------------------------
 78 | 
 79 | - Fix a spurious migration offered by makemigrations.
 80 | 
 81 | 
 82 | v0.4.1 - August 29, 2017 - Default keys
 83 | --------------------------------------------------------------------------------
 84 | 
 85 | - Fix `#25`_: make sure default keys are unicode values.
 86 | 
 87 | .. _#25: https://bitbucket.org/psagers/django-otp/issues/25/attributeerror-bytes-object-has-no
 88 | 
 89 | 
 90 | v0.4.0 - July 19, 2017 - Update support matrix
 91 | --------------------------------------------------------------------------------
 92 | 
 93 | - Drop support for versions of Django that are past EOL.
 94 | 
 95 | 
 96 | v0.3.6 - November 27, 2016 - Forward compatbility for Django 2.0
 97 | --------------------------------------------------------------------------------
 98 | 
 99 | - Treat :attr:`~django.contrib.auth.models.User.is_authenticated` and
100 |   :attr:`~django.contrib.auth.models.User.is_anonymous` as properties in Django
101 |   1.10 and later.
102 | 
103 | - Add explict on_delete behavior for all foreign keys.
104 | 
105 | 
106 | v0.3.5 - October 9, 2016 - Longer numbers
107 | --------------------------------------------------------------------------------
108 | 
109 | - Support longer phone numbers.
110 | 
111 | 
112 | v0.3.4 - January 10, 2016 - Python 3 cleanup
113 | --------------------------------------------------------------------------------
114 | 
115 | - All modules include all four Python 3 __future__ imports for consistency.
116 | 
117 | - Migrations no longer have byte strings in them.
118 | 
119 | 
120 | v0.3.3 - October 11, 2015 - Django 1.8
121 | --------------------------------------------------------------------------------
122 | 
123 | - Use ModelAdmin.raw_id_fields for foreign keys to users.
124 | 
125 | - General cleanup and compatibility with Django 1.9a1.
126 | 
127 | 
128 | v0.3.1 - March 1, 2015 - Token validity
129 | --------------------------------------------------------------------------------
130 | 
131 | - The length of time that tokens are valid can now be configured with
132 |   :setting:`OTP_TWILIO_TOKEN_VALIDITY`.
133 | 
134 | - Tokens now become invalid as soon as they have been verified.
135 | 
136 | 
137 | v0.3.0 - February 7, 2015 - Support Django migrations
138 | --------------------------------------------------------------------------------
139 | 
140 | - otp_twilio now has both Django and South migrations. Please see the `upgrade
141 |   notes`_ for details on upgrading from previous versions.
142 | 
143 | .. _upgrade notes: https://pythonhosted.org/django-otp/overview.html#upgrading
144 | 
145 | 
146 | v0.2.2 - Aug 20, 2014 - Challenge template
147 | --------------------------------------------------------------------------------
148 | 
149 | - :setting:`OTP_TWILIO_CHALLENGE_MESSAGE` allows you to customize the string
150 |   returned to the user after the SMS is sent. It also accepts the {token}
151 |   placeholder as a convenience for development.
152 | 
153 | - Fixes for unit tests under the latest pre-release version of Django 1.7.
154 | 
155 | 
156 | v0.2.1 - May 8, 2014 - Message template
157 | --------------------------------------------------------------------------------
158 | 
159 | - :setting:`OTP_TWILIO_TOKEN_TEMPLATE` allows you to customize the message that
160 |   is sent by SMS.
161 | 
162 | 
163 | v0.2.0 - November 10, 2013 - Django 1.6
164 | --------------------------------------------------------------------------------
165 | 
166 | - Now supports Django 1.4 to 1.6 on Python 2.6, 2.7, 3.2, and 3.3. This is the
167 |   first release for Python 3.
168 | 
169 | 
170 | v0.1.3 - May 9, 2013 - Unit test improvements
171 | --------------------------------------------------------------------------------
172 | 
173 | Major unit test cleanup. Tests should pass or be skipped under all supported
174 | versions of Django, with or without custom users and timzeone support.
175 | 
176 | 
177 | v0.1.2 - March 24, 2013 - Bug fix
178 | --------------------------------------------------------------------------------
179 | 
180 | - Fix for requests integration.
181 | 
182 | 
183 | v0.1.1 - October 8, 2012 - Bug fix
184 | --------------------------------------------------------------------------------
185 | 
186 | - Fix exception with an empty token form.
187 | 
188 | 
189 | v0.1.0 - August 20, 2012 - Initial Release
190 | --------------------------------------------------------------------------------
191 | 
192 | Initial release.
193 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | This is free and unencumbered software released into the public domain.
 2 | 
 3 | Anyone is free to copy, modify, publish, use, compile, sell, or distribute this
 4 | software, either in source code form or as a compiled binary, for any purpose,
 5 | commercial or non-commercial, and by any means.
 6 | 
 7 | In jurisdictions that recognize copyright laws, the author or authors of this
 8 | software dedicate any and all copyright interest in the software to the public
 9 | domain. We make this dedication for the benefit of the public at large and to
10 | the detriment of our heirs and successors. We intend this dedication to be an
11 | overt act of relinquishment in perpetuity of all present and future rights to
12 | this software under copyright law.
13 | 
14 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 | AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
18 | ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
19 | WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
20 | 
21 | For more information, please refer to <https://unlicense.org/>
22 | 


--------------------------------------------------------------------------------
/README.rst:
--------------------------------------------------------------------------------
 1 | .. image:: https://img.shields.io/pypi/v/django-otp-twilio?color=blue
 2 |    :target: https://pypi.org/project/django-otp-twilio/
 3 |    :alt: PyPI
 4 | .. image:: https://img.shields.io/readthedocs/django-otp-twilio
 5 |    :target: https://django-otp-twilio.readthedocs.io/
 6 |    :alt: Documentation
 7 | .. image:: https://img.shields.io/badge/github-django--otp--twilio-green
 8 |    :target: https://github.com/django-otp/django-otp-twilio
 9 |    :alt: Source
10 | 
11 | This is a django-otp plugin that delivers tokens via Twilio's `SMS
12 | <https://www.twilio.com/sms>`_ service.
13 | 
14 | See `django-otp <https://pypi.org/project/django-otp>`_ for more information
15 | on the OTP framework.
16 | 
17 | .. end-of-doc-intro
18 | 
19 | 
20 | Development
21 | -----------
22 | 
23 | This project is built and managed with `hatch`_. If you don't have hatch, I
24 | recommend installing it with `pipx`_: ``pipx install hatch``.
25 | 
26 | ``pyproject.toml`` defines several useful scripts for development and testing.
27 | The default environment includes all dev and test dependencies for quickly
28 | running tests. The ``test`` environment defines the test matrix for running the
29 | full validation suite. Everything is executed in the context of the Django
30 | project in test/test\_project.
31 | 
32 | As a quick primer, hatch scripts can be run with ``hatch run [<env>:]<script>``.
33 | To run linters and tests in the default environment, just run
34 | ``hatch run check``. This should run tests with your default Python version and
35 | the latest Django. Other scripts include:
36 | 
37 | * **manage**: Run a management command via the test project. This can be used to
38 |   generate migrations.
39 | * **lint**: Run all linters.
40 | * **fix**: Run all fixers to address linting issues. This may not fix every
41 |   issue reported by lint.
42 | * **test**: Run all tests.
43 | * **check**: Run linters and tests.
44 | * **warn**: Run tests with all warnings enabled. This is especially useful for
45 |   seeing deprecation warnings in new versions of Django.
46 | * **cov**: Run tests and print a code coverage report.
47 | 
48 | To run the full test matrix, run ``hatch run test:run``. You will need multiple
49 | specific Python versions installed for this.
50 | 
51 | You can clean up the hatch environments with ``hatch env prune``, for example to
52 | force dependency updates.
53 | 
54 | 
55 | .. _hatch: https://hatch.pypa.io/
56 | .. _pipx: https://pypa.github.io/pipx/
57 | 


--------------------------------------------------------------------------------
/docs/Makefile:
--------------------------------------------------------------------------------
  1 | # Makefile for Sphinx documentation
  2 | #
  3 | 
  4 | # You can set these variables from the command line.
  5 | SPHINXOPTS    =
  6 | SPHINXBUILD   = sphinx-build
  7 | PAPER         =
  8 | BUILDDIR      = build
  9 | 
 10 | # Internal variables.
 11 | PAPEROPT_a4     = -D latex_paper_size=a4
 12 | PAPEROPT_letter = -D latex_paper_size=letter
 13 | ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
 14 | # the i18n builder cannot share the environment and doctrees with the others
 15 | I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
 16 | 
 17 | .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
 18 | 
 19 | help:
 20 | 	@echo "Please use \`make <target>' where <target> is one of"
 21 | 	@echo "  html       to make standalone HTML files"
 22 | 	@echo "  dirhtml    to make HTML files named index.html in directories"
 23 | 	@echo "  singlehtml to make a single large HTML file"
 24 | 	@echo "  pickle     to make pickle files"
 25 | 	@echo "  json       to make JSON files"
 26 | 	@echo "  htmlhelp   to make HTML files and a HTML help project"
 27 | 	@echo "  qthelp     to make HTML files and a qthelp project"
 28 | 	@echo "  devhelp    to make HTML files and a Devhelp project"
 29 | 	@echo "  epub       to make an epub"
 30 | 	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
 31 | 	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
 32 | 	@echo "  text       to make text files"
 33 | 	@echo "  man        to make manual pages"
 34 | 	@echo "  texinfo    to make Texinfo files"
 35 | 	@echo "  info       to make Texinfo files and run them through makeinfo"
 36 | 	@echo "  gettext    to make PO message catalogs"
 37 | 	@echo "  changes    to make an overview of all changed/added/deprecated items"
 38 | 	@echo "  linkcheck  to check all external links for integrity"
 39 | 	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
 40 | 
 41 | clean:
 42 | 	-rm -rf $(BUILDDIR)/*
 43 | 
 44 | html:
 45 | 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 46 | 	@echo
 47 | 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 48 | 
 49 | dirhtml:
 50 | 	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
 51 | 	@echo
 52 | 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
 53 | 
 54 | singlehtml:
 55 | 	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
 56 | 	@echo
 57 | 	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
 58 | 
 59 | pickle:
 60 | 	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
 61 | 	@echo
 62 | 	@echo "Build finished; now you can process the pickle files."
 63 | 
 64 | json:
 65 | 	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
 66 | 	@echo
 67 | 	@echo "Build finished; now you can process the JSON files."
 68 | 
 69 | htmlhelp:
 70 | 	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
 71 | 	@echo
 72 | 	@echo "Build finished; now you can run HTML Help Workshop with the" \
 73 | 	      ".hhp project file in $(BUILDDIR)/htmlhelp."
 74 | 
 75 | qthelp:
 76 | 	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
 77 | 	@echo
 78 | 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 79 | 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
 80 | 	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/django-otp-sns.qhcp"
 81 | 	@echo "To view the help file:"
 82 | 	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/django-otp-sns.qhc"
 83 | 
 84 | devhelp:
 85 | 	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
 86 | 	@echo
 87 | 	@echo "Build finished."
 88 | 	@echo "To view the help file:"
 89 | 	@echo "# mkdir -p $$HOME/.local/share/devhelp/django-otp-sns"
 90 | 	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/django-otp-sns"
 91 | 	@echo "# devhelp"
 92 | 
 93 | epub:
 94 | 	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
 95 | 	@echo
 96 | 	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
 97 | 
 98 | latex:
 99 | 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
100 | 	@echo
101 | 	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
102 | 	@echo "Run \`make' in that directory to run these through (pdf)latex" \
103 | 	      "(use \`make latexpdf' here to do that automatically)."
104 | 
105 | latexpdf:
106 | 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
107 | 	@echo "Running LaTeX files through pdflatex..."
108 | 	$(MAKE) -C $(BUILDDIR)/latex all-pdf
109 | 	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
110 | 
111 | text:
112 | 	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
113 | 	@echo
114 | 	@echo "Build finished. The text files are in $(BUILDDIR)/text."
115 | 
116 | man:
117 | 	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
118 | 	@echo
119 | 	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
120 | 
121 | texinfo:
122 | 	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
123 | 	@echo
124 | 	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
125 | 	@echo "Run \`make' in that directory to run these through makeinfo" \
126 | 	      "(use \`make info' here to do that automatically)."
127 | 
128 | info:
129 | 	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
130 | 	@echo "Running Texinfo files through makeinfo..."
131 | 	make -C $(BUILDDIR)/texinfo info
132 | 	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
133 | 
134 | gettext:
135 | 	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
136 | 	@echo
137 | 	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
138 | 
139 | changes:
140 | 	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
141 | 	@echo
142 | 	@echo "The overview file is in $(BUILDDIR)/changes."
143 | 
144 | linkcheck:
145 | 	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
146 | 	@echo
147 | 	@echo "Link check complete; look for any errors in the above output " \
148 | 	      "or in $(BUILDDIR)/linkcheck/output.txt."
149 | 
150 | doctest:
151 | 	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
152 | 	@echo "Testing of doctests in the sources finished, look at the " \
153 | 	      "results in $(BUILDDIR)/doctest/output.txt."
154 | 
155 | zip:
156 | 	rm build/html.zip || true
157 | 	cd build/html && zip -R ../html.zip '*' -x .buildinfo -x '_sources/*'
158 | 


--------------------------------------------------------------------------------
/docs/ext/otpdocs.py:
--------------------------------------------------------------------------------
 1 | """
 2 | Extra stuff for the django-otp Sphinx docs.
 3 | """
 4 | 
 5 | def setup(app):
 6 |     app.add_crossref_type(
 7 |         directivename = "setting",
 8 |         rolename      = "setting",
 9 |         indextemplate = "pair: %s; setting",
10 |     )
11 | 


--------------------------------------------------------------------------------
/docs/source/changes.rst:
--------------------------------------------------------------------------------
1 | Change Log
2 | ==========
3 | 
4 | .. include:: ../../CHANGES.rst
5 | 


--------------------------------------------------------------------------------
/docs/source/conf.py:
--------------------------------------------------------------------------------
  1 | # -*- coding: utf-8 -*-
  2 | #
  3 | # django-otp-twilio documentation build configuration file, created by
  4 | # sphinx-quickstart on Wed Jul 25 13:46:24 2012.
  5 | #
  6 | # This file is execfile()d with the current directory set to its containing dir.
  7 | #
  8 | # Note that not all possible configuration values are present in this
  9 | # autogenerated file.
 10 | #
 11 | # All configuration values have a default; values that are commented out
 12 | # serve to show the default.
 13 | 
 14 | import os
 15 | import sys
 16 | 
 17 | # autodoc and viewcode need valid settings in order to process Django modules.
 18 | import django
 19 | import django.conf
 20 | 
 21 | # If extensions (or modules to document with autodoc) are in another directory,
 22 | # add these directories to sys.path here. If the directory is relative to the
 23 | # documentation root, use os.path.abspath to make it absolute, like shown here.
 24 | sys.path.insert(0, os.path.abspath('../ext'))
 25 | 
 26 | # -- General configuration -----------------------------------------------------
 27 | 
 28 | # If your documentation needs a minimal Sphinx version, state it here.
 29 | # needs_sphinx = '1.0'
 30 | 
 31 | # Add any Sphinx extension module names here, as strings. They can be extensions
 32 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 33 | extensions = [
 34 |     'sphinx.ext.autodoc',
 35 |     'sphinx.ext.intersphinx',
 36 |     'sphinx.ext.viewcode',
 37 |     'otpdocs',
 38 | ]
 39 | 
 40 | 
 41 | django.conf.settings.configure(
 42 |     DATABASES={
 43 |         'default': {
 44 |             'ENGINE': 'django.db.backends.sqlite3',
 45 |         }
 46 |     },
 47 |     INSTALLED_APPS=[
 48 |         'django.contrib.admin',
 49 |         'django.contrib.auth',
 50 |         'django.contrib.contenttypes',
 51 |         'django.contrib.sessions',
 52 |         'django.contrib.messages',
 53 |         'django_otp',
 54 |         'otp_twilio',
 55 |     ],
 56 |     SECRET_KEY='properly-configured',
 57 | )
 58 | django.setup()
 59 | 
 60 | intersphinx_mapping = {
 61 |     'python': ('https://docs.python.org/3/', None),
 62 |     'django': (
 63 |         'https://docs.djangoproject.com/en/4.2/',
 64 |         'https://docs.djangoproject.com/en/4.2/_objects/',
 65 |     ),
 66 |     'django-otp': ('http://django-otp-official.readthedocs.io/en/latest/', None),
 67 | }
 68 | 
 69 | # Add any paths that contain templates here, relative to this directory.
 70 | templates_path = ['_templates']
 71 | 
 72 | # The suffix of source filenames.
 73 | source_suffix = '.rst'
 74 | 
 75 | # The encoding of source files.
 76 | # source_encoding = 'utf-8-sig'
 77 | 
 78 | # The master toctree document.
 79 | master_doc = 'index'
 80 | 
 81 | # General information about the project.
 82 | project = u'django-otp-twilio'
 83 | copyright = u'2012, Peter Sagerson'
 84 | 
 85 | # The version info for the project you're documenting, acts as replacement for
 86 | # |version| and |release|, also used in various other places throughout the
 87 | # built documents.
 88 | #
 89 | # The full version, including alpha/beta/rc tags.
 90 | release = '1.0.5'
 91 | 
 92 | # The short X.Y version.
 93 | version = '.'.join(release.split('.')[:2])
 94 | 
 95 | # The language for content autogenerated by Sphinx. Refer to documentation
 96 | # for a list of supported languages.
 97 | # language = None
 98 | 
 99 | # There are two options for replacing |today|: either, you set today to some
100 | # non-false value, then it is used:
101 | # today = ''
102 | # Else, today_fmt is used as the format for a strftime call.
103 | # today_fmt = '%B %d, %Y'
104 | 
105 | # List of patterns, relative to source directory, that match files and
106 | # directories to ignore when looking for source files.
107 | exclude_patterns = []
108 | 
109 | # The reST default role (used for this markup: `text`) to use for all documents.
110 | # default_role = None
111 | 
112 | # If true, '()' will be appended to :func: etc. cross-reference text.
113 | # add_function_parentheses = True
114 | 
115 | # If true, the current module name will be prepended to all description
116 | # unit titles (such as .. function::).
117 | # add_module_names = True
118 | 
119 | # If true, sectionauthor and moduleauthor directives will be shown in the
120 | # output. They are ignored by default.
121 | # show_authors = False
122 | 
123 | # The name of the Pygments (syntax highlighting) style to use.
124 | pygments_style = 'sphinx'
125 | 
126 | # A list of ignored prefixes for module index sorting.
127 | # modindex_common_prefix = []
128 | 
129 | 
130 | # -- Options for HTML output ---------------------------------------------------
131 | 
132 | # The theme to use for HTML and HTML Help pages.  See the documentation for
133 | # a list of builtin themes.
134 | html_theme = 'default'
135 | 
136 | # Theme options are theme-specific and customize the look and feel of a theme
137 | # further.  For a list of options available for each theme, see the
138 | # documentation.
139 | # html_theme_options = {}
140 | 
141 | # Add any paths that contain custom themes here, relative to this directory.
142 | # html_theme_path = []
143 | 
144 | # The name for this set of Sphinx documents.  If None, it defaults to
145 | # "<project> v<release> documentation".
146 | # html_title = None
147 | 
148 | # A shorter title for the navigation bar.  Default is the same as html_title.
149 | # html_short_title = None
150 | 
151 | # The name of an image file (relative to this directory) to place at the top
152 | # of the sidebar.
153 | # html_logo = None
154 | 
155 | # The name of an image file (within the static path) to use as favicon of the
156 | # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
157 | # pixels large.
158 | # html_favicon = None
159 | 
160 | # Add any paths that contain custom static files (such as style sheets) here,
161 | # relative to this directory. They are copied after the builtin static files,
162 | # so a file named "default.css" will overwrite the builtin "default.css".
163 | # html_static_path = ['_static']
164 | 
165 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
166 | # using the given strftime format.
167 | # html_last_updated_fmt = '%b %d, %Y'
168 | 
169 | # If true, SmartyPants will be used to convert quotes and dashes to
170 | # typographically correct entities.
171 | # html_use_smartypants = True
172 | 
173 | # Custom sidebar templates, maps document names to template names.
174 | # html_sidebars = {}
175 | 
176 | # Additional templates that should be rendered to pages, maps page names to
177 | # template names.
178 | # html_additional_pages = {}
179 | 
180 | # If false, no module index is generated.
181 | # html_domain_indices = True
182 | 
183 | # If false, no index is generated.
184 | # html_use_index = True
185 | 
186 | # If true, the index is split into individual pages for each letter.
187 | # html_split_index = False
188 | 
189 | # If true, links to the reST sources are added to the pages.
190 | # html_show_sourcelink = True
191 | 
192 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
193 | # html_show_sphinx = True
194 | 
195 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
196 | # html_show_copyright = True
197 | 
198 | # If true, an OpenSearch description file will be output, and all pages will
199 | # contain a <link> tag referring to it.  The value of this option must be the
200 | # base URL from which the finished HTML is served.
201 | # html_use_opensearch = ''
202 | 
203 | # This is the file name suffix for HTML files (e.g. ".xhtml").
204 | # html_file_suffix = None
205 | 
206 | # Output file base name for HTML help builder.
207 | htmlhelp_basename = 'django-otp-twiliodoc'
208 | 
209 | 
210 | # -- Options for LaTeX output --------------------------------------------------
211 | 
212 | latex_elements = {
213 |     # The paper size ('letterpaper' or 'a4paper').
214 |     # 'papersize': 'letterpaper',
215 |     # The font size ('10pt', '11pt' or '12pt').
216 |     # 'pointsize': '10pt',
217 |     # Additional stuff for the LaTeX preamble.
218 |     # 'preamble': '',
219 | }
220 | 
221 | # Grouping the document tree into LaTeX files. List of tuples
222 | # (source start file, target name, title, author, documentclass [howto/manual]).
223 | latex_documents = [
224 |     (
225 |         'index',
226 |         'django-otp-twilio.tex',
227 |         u'django-otp-twilio Documentation',
228 |         'Peter Sagerson',
229 |         'manual',
230 |     ),
231 | ]
232 | 
233 | # The name of an image file (relative to this directory) to place at the top of
234 | # the title page.
235 | # latex_logo = None
236 | 
237 | # For "manual" documents, if this is true, then toplevel headings are parts,
238 | # not chapters.
239 | # latex_use_parts = False
240 | 
241 | # If true, show page references after internal links.
242 | # latex_show_pagerefs = False
243 | 
244 | # If true, show URL addresses after external links.
245 | # latex_show_urls = False
246 | 
247 | # Documents to append as an appendix to all manuals.
248 | # latex_appendices = []
249 | 
250 | # If false, no module index is generated.
251 | # latex_domain_indices = True
252 | 
253 | 
254 | # -- Options for manual page output --------------------------------------------
255 | 
256 | # One entry per manual page. List of tuples
257 | # (source start file, name, description, authors, manual section).
258 | man_pages = [
259 |     (
260 |         'index',
261 |         'django-otp-twilio',
262 |         u'django-otp-twilio Documentation',
263 |         [u'Peter Sagerson'],
264 |         1,
265 |     )
266 | ]
267 | 
268 | # If true, show URL addresses after external links.
269 | # man_show_urls = False
270 | 
271 | 
272 | # -- Options for Texinfo output ------------------------------------------------
273 | 
274 | # Grouping the document tree into Texinfo files. List of tuples
275 | # (source start file, target name, title, author,
276 | #  dir menu entry, description, category)
277 | texinfo_documents = [
278 |     (
279 |         'index',
280 |         'django-otp-twilio',
281 |         u'django-otp-twilio Documentation',
282 |         'Peter Sagerson',
283 |         'django-otp-twilio',
284 |         'One line description of project.',
285 |         'Miscellaneous',
286 |     ),
287 | ]
288 | 
289 | # Documents to append as an appendix to all manuals.
290 | # texinfo_appendices = []
291 | 
292 | # If false, no module index is generated.
293 | # texinfo_domain_indices = True
294 | 
295 | # How to display URL addresses: 'footnote', 'no', or 'inline'.
296 | # texinfo_show_urls = 'footnote'
297 | 


--------------------------------------------------------------------------------
/docs/source/index.rst:
--------------------------------------------------------------------------------
  1 | django-otp-twilio
  2 | =================
  3 | 
  4 | .. include:: ../../README.rst
  5 |    :end-before: .. end-of-doc-intro
  6 | 
  7 | 
  8 | Installation
  9 | ------------
 10 | 
 11 | django-otp-twilio can be installed via pip::
 12 | 
 13 |     pip install django-otp-twilio
 14 | 
 15 | 
 16 | Once installed it should be added to INSTALLED_APPS after django_otp core::
 17 | 
 18 |     INSTALLED_APPS = [
 19 |         ...
 20 |         'django_otp',
 21 |         'django_otp.plugins.otp_totp',
 22 |         'django_otp.plugins.otp_hotp',
 23 |         'django_otp.plugins.otp_static',
 24 | 
 25 |         'otp_twilio',
 26 |     ]
 27 | 
 28 | 
 29 | Twilio SMS Devices
 30 | ------------------
 31 | 
 32 | .. autoclass:: otp_twilio.models.TwilioSMSDevice
 33 |    :members:
 34 | 
 35 | 
 36 | Admin
 37 | -----
 38 | 
 39 | The following :class:`~django.contrib.admin.ModelAdmin` subclass is registered
 40 | with the default admin site. We recommend its use with custom admin sites as
 41 | well:
 42 | 
 43 | .. autoclass:: otp_twilio.admin.TwilioSMSDeviceAdmin
 44 | 
 45 | 
 46 | Settings
 47 | --------
 48 | 
 49 | .. setting:: OTP_TWILIO_URL
 50 | 
 51 | **OTP_TWILIO_URL**
 52 | 
 53 | Default: ``"https://api.twilio.com""``
 54 | 
 55 | Twilio API URL. This can be used to change edge location
 56 | 
 57 | .. setting:: OTP_TWILIO_ACCOUNT
 58 | 
 59 | **OTP_TWILIO_ACCOUNT**
 60 | 
 61 | Default: ``None``
 62 | 
 63 | Your Twilio account ID.
 64 | 
 65 | .. setting:: OTP_TWILIO_API_KEY
 66 | 
 67 | **OTP_TWILIO_API_KEY**
 68 | 
 69 | Default: ``None``
 70 | 
 71 | Your Twilio API key, if no API key is specified requests are made using the Twilio Account ID.
 72 | 
 73 | 
 74 | .. setting:: OTP_TWILIO_AUTH
 75 | 
 76 | **OTP_TWILIO_AUTH**
 77 | 
 78 | Default: ``None``
 79 | 
 80 | Your Twilio auth token used for API requests. (Either API Key token or account auth token)
 81 | 
 82 | 
 83 | .. setting:: OTP_TWILIO_CHALLENGE_MESSAGE
 84 | 
 85 | **OTP_TWILIO_CHALLENGE_MESSAGE**
 86 | 
 87 | Default: ``"Sent by SMS"``
 88 | 
 89 | The message returned by
 90 | :meth:`~otp_twilio.models.TwilioSMSDevice.generate_challenge`. This may contain
 91 | ``'{token}'``, which will be replaced by the token. This completely negates any
 92 | security benefit to the device, but it's handy for development, especially in
 93 | combination with :setting:`OTP_TWILIO_NO_DELIVERY`.
 94 | 
 95 | 
 96 | .. setting:: OTP_TWILIO_FROM
 97 | 
 98 | **OTP_TWILIO_FROM**
 99 | 
100 | Default: ``None``
101 | 
102 | The phone number to send SMS messages from. This must be one of your Twilio
103 | numbers.
104 | 
105 | 
106 | .. setting:: OTP_TWILIO_MESSAGING_SERVICE_SID
107 | 
108 | **OTP_TWILIO_MESSAGING_SERVICE_SID**
109 | 
110 | Default: ``None``
111 | 
112 | The Twilio messaging service SID to send SMS messages from. This must be one of
113 | your Twilio messaging services. If supplied, this takes precedence over
114 | ``OTP_TWILIO_FROM``.
115 | 
116 | 
117 | .. setting:: OTP_TWILIO_NO_DELIVERY
118 | 
119 | **OTP_TWILIO_NO_DELIVERY**
120 | 
121 | Default: ``False``
122 | 
123 | Send tokens to the 'otp_twilio.models' logger instead of delivering them by SMS.
124 | Useful for development.
125 | 
126 | 
127 | .. setting:: OTP_TWILIO_THROTTLE_FACTOR
128 | 
129 | **OTP_TWILIO_THROTTLE_FACTOR**
130 | 
131 | Default: ``1``
132 | 
133 | This controls the rate of throttling. The sequence of 1, 2, 4, 8... seconds is
134 | multiplied by this factor to define the delay imposed after 1, 2, 3, 4...
135 | successive failures. Set to ``0`` to disable throttling completely.
136 | 
137 | 
138 | .. setting:: OTP_TWILIO_TOKEN_TEMPLATE
139 | 
140 | **OTP_TWILIO_TOKEN_TEMPLATE**
141 | 
142 | Default: ``"{token}"``
143 | 
144 | A string template for generating the token message. By default, this is just the
145 | token itself, but you can customize it. The template will be rendered with
146 | Python string formatting (``template.format(token=token)``).
147 | 
148 | 
149 | .. setting:: OTP_TWILIO_TOKEN_VALIDITY
150 | 
151 | **OTP_TWILIO_TOKEN_VALIDITY**
152 | 
153 | Default: ``30``
154 | 
155 | The number of seconds for which a delivered token will be valid.
156 | 
157 | 
158 | Changes
159 | -------
160 | 
161 | :doc:`changes`
162 | 
163 | 
164 | License
165 | -------
166 | 
167 | .. include:: ../../LICENSE
168 | 


--------------------------------------------------------------------------------
/pyproject.toml:
--------------------------------------------------------------------------------
  1 | [project]
  2 | name = "django-otp-twilio"
  3 | version = "1.0.5"
  4 | description = "A django-otp plugin that delivers tokens via Twilio's SMS service."
  5 | readme = "README.rst"
  6 | requires-python = ">=3.7"
  7 | license = "Unlicense"
  8 | authors = [
  9 |     { name = "Peter Sagerson", email = "psagers@ignorare.net" },
 10 | ]
 11 | classifiers = [
 12 |     "Development Status :: 5 - Production/Stable",
 13 |     "Framework :: Django",
 14 |     "Framework :: Django :: 4.2",
 15 |     "Framework :: Django :: 5.1",
 16 |     "Framework :: Django :: 5.2",
 17 |     "Intended Audience :: Developers",
 18 |     "License :: OSI Approved :: The Unlicense (Unlicense)",
 19 |     "Programming Language :: Python :: 3",
 20 |     "Programming Language :: Python :: 3 :: Only",
 21 |     "Topic :: Security",
 22 |     "Topic :: Software Development :: Libraries :: Python Modules",
 23 | ]
 24 | dependencies = [
 25 |     "django-otp~=1.0",
 26 |     "requests",
 27 | ]
 28 | 
 29 | [project.urls]
 30 | Homepage = "https://github.com/django-otp/django-otp-twilio"
 31 | Documentation = "https://django-otp-twilio.readthedocs.io/"
 32 | 
 33 | 
 34 | #
 35 | # Development
 36 | #
 37 | 
 38 | [tool.hatch.envs.default]
 39 | dependencies = [
 40 |     "black ~= 25.1",
 41 |     "bumpversion ~= 0.6.0",
 42 |     "coverage ~= 7.8.0",
 43 |     "flake8 ~= 7.2.0",
 44 |     "freezegun ~= 1.5.1",
 45 |     "isort ~= 6.0.1",
 46 | ]
 47 | 
 48 | [tool.hatch.envs.default.env-vars]
 49 | PYTHONPATH = "test"
 50 | DJANGO_SETTINGS_MODULE = "test_project.settings"
 51 | 
 52 | [tool.hatch.envs.default.scripts]
 53 | manage = "python -m django {args}"
 54 | 
 55 | lint = [
 56 |     "flake8 src",
 57 |     "isort --check src",
 58 |     "black --check src",
 59 | ]
 60 | fix = [
 61 |     "isort src",
 62 |     "black src",
 63 | ]
 64 | 
 65 | test = "python -s -m django test {args:otp_twilio}"
 66 | check = ["lint", "test"]
 67 | 
 68 | warn = "python -Wd -s -m django test {args:otp_twilio}"
 69 | cov = [
 70 |     "coverage run -m django test {args:otp_twilio}",
 71 |     "coverage report",
 72 | ]
 73 | 
 74 | 
 75 | [tool.hatch.envs.test.scripts]
 76 | run = "test"
 77 | 
 78 | [tool.hatch.envs.test.overrides]
 79 | matrix.django.dependencies = [
 80 |     { value = "django ~= 4.2.0", if = ["4.2"] },
 81 |     { value = "django ~= 5.1.0", if = ["5.1"] },
 82 |     { value = "django ~= 5.2.0", if = ["5.2"] },
 83 | ]
 84 | matrix.mode.scripts = [
 85 |     { key = "run", value = "lint", if = ["lint"] },
 86 |     { key = "run", value = "cov", if = ["coverage"] },
 87 | ]
 88 | 
 89 | [[tool.hatch.envs.test.matrix]]
 90 | mode = ["lint"]
 91 | 
 92 | # WARNING: When you update the Python versions, make sure to update
 93 | # .github/workflows/* as well.
 94 | [[tool.hatch.envs.test.matrix]]
 95 | python = ["3.9"]
 96 | django = ["4.2"]
 97 | 
 98 | [[tool.hatch.envs.test.matrix]]
 99 | python = ["3.11"]
100 | django = ["5.1"]
101 | 
102 | [[tool.hatch.envs.test.matrix]]
103 | python = ["3.13"]
104 | django = ["5.2"]
105 | 
106 | [[tool.hatch.envs.test.matrix]]
107 | mode = ["coverage"]
108 | 
109 | 
110 | [tool.hatch.envs.docs]
111 | template = "docs"
112 | dependencies = [
113 |     "sphinx"
114 | ]
115 | 
116 | [tool.hatch.envs.docs.scripts]
117 | make = "command make -C docs {args:html}"
118 | open = "command xdg-open docs/build/html/index.html"
119 | 
120 | 
121 | #
122 | # Build
123 | #
124 | 
125 | [build-system]
126 | requires = ["hatchling"]
127 | build-backend = "hatchling.build"
128 | 
129 | [tool.hatch.build.targets.wheel]
130 | packages = ["src/otp_twilio"]
131 | 
132 | [tool.hatch.build.targets.sdist]
133 | include = [
134 |     "/src",
135 |     "/docs",
136 |     "/test",
137 |     "/CHANGES.rst",
138 | ]
139 | 
140 | 
141 | #
142 | # Other tools
143 | #
144 | 
145 | [tool.isort]
146 | profile = "black"
147 | force_sort_within_sections = true
148 | 
149 | sections = ["FUTURE", "STDLIB", "THIRDPARTY", "DJANGO", "FIRSTPARTY", "LOCALFOLDER"]
150 | known_django = ["django"]
151 | skip_glob = ["**/migrations/*.py"]
152 | 
153 | [tool.black]
154 | skip-string-normalization = true
155 | exclude = 'migrations/.*\.py'
156 | 


--------------------------------------------------------------------------------
/src/otp_twilio/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/django-otp/django-otp-twilio/91160690da131f813c0dff79c73e3faead32cb53/src/otp_twilio/__init__.py


--------------------------------------------------------------------------------
/src/otp_twilio/admin.py:
--------------------------------------------------------------------------------
 1 | from django.contrib import admin
 2 | from django.contrib.admin.sites import AlreadyRegistered
 3 | 
 4 | from .models import TwilioSMSDevice
 5 | 
 6 | 
 7 | class TwilioSMSDeviceAdmin(admin.ModelAdmin):
 8 |     """
 9 |     :class:`~django.contrib.admin.ModelAdmin` for
10 |     :class:`~otp_twilio.models.TwilioSMSDevice`.
11 |     """
12 | 
13 |     fieldsets = [
14 |         (
15 |             'Identity',
16 |             {
17 |                 'fields': ['user', 'name', 'confirmed'],
18 |             },
19 |         ),
20 |         (
21 |             'Configuration',
22 |             {
23 |                 'fields': ['number'],
24 |             },
25 |         ),
26 |     ]
27 |     raw_id_fields = ['user']
28 | 
29 | 
30 | try:
31 |     admin.site.register(TwilioSMSDevice, TwilioSMSDeviceAdmin)
32 | except AlreadyRegistered:
33 |     # Ignore the useless exception from multiple imports
34 |     pass
35 | 


--------------------------------------------------------------------------------
/src/otp_twilio/apps.py:
--------------------------------------------------------------------------------
1 | from django.apps import AppConfig
2 | 
3 | 
4 | class DefaultConfig(AppConfig):
5 |     name = 'otp_twilio'
6 |     default_auto_field = 'django.db.models.AutoField'
7 | 


--------------------------------------------------------------------------------
/src/otp_twilio/conf.py:
--------------------------------------------------------------------------------
 1 | import django.conf
 2 | import django.test.utils
 3 | 
 4 | 
 5 | class Settings(object):
 6 |     """
 7 |     This is a simple class to take the place of the global settings object. An
 8 |     instance will contain all of our settings as attributes, with default
 9 |     values if they are not specified by the configuration.
10 |     """
11 | 
12 |     _defaults = {
13 |         'OTP_TWILIO_URL': "https://api.twilio.com",
14 |         'OTP_TWILIO_ACCOUNT': None,
15 |         'OTP_TWILIO_API_KEY': None,
16 |         'OTP_TWILIO_AUTH': None,
17 |         'OTP_TWILIO_CHALLENGE_MESSAGE': "Sent by SMS",
18 |         'OTP_TWILIO_FROM': None,
19 |         'OTP_TWILIO_MESSAGING_SERVICE_SID': None,
20 |         'OTP_TWILIO_NO_DELIVERY': False,
21 |         'OTP_TWILIO_THROTTLE_FACTOR': 1,
22 |         'OTP_TWILIO_TOKEN_TEMPLATE': '{token}',
23 |         'OTP_TWILIO_TOKEN_VALIDITY': 30,
24 |     }
25 | 
26 |     def __getattr__(self, name):
27 |         if hasattr(django.conf.settings, name):
28 |             value = getattr(django.conf.settings, name)
29 |         elif name in self._defaults:
30 |             value = self._defaults[name]
31 |         else:
32 |             raise AttributeError(name)
33 | 
34 |         return value
35 | 
36 | 
37 | settings = Settings()
38 | 


--------------------------------------------------------------------------------
/src/otp_twilio/migrations/0001_initial.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | from __future__ import unicode_literals
 3 | 
 4 | from django.conf import settings
 5 | from django.db import migrations, models
 6 | 
 7 | import otp_twilio.models
 8 | 
 9 | 
10 | class Migration(migrations.Migration):
11 | 
12 |     dependencies = [
13 |         migrations.swappable_dependency(settings.AUTH_USER_MODEL),
14 |     ]
15 | 
16 |     operations = [
17 |         migrations.CreateModel(
18 |             name='TwilioSMSDevice',
19 |             fields=[
20 |                 ('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)),
21 |                 ('name', models.CharField(help_text='The human-readable name of this device.', max_length=64)),
22 |                 ('confirmed', models.BooleanField(default=True, help_text='Is this device ready for use?')),
23 |                 ('number', models.CharField(help_text='The mobile number to deliver tokens to.', max_length=16)),
24 |                 ('key', models.CharField(default=otp_twilio.models.default_key, help_text='A random key used to generate tokens (hex-encoded).', max_length=40, validators=[otp_twilio.models.key_validator])),
25 |                 ('user', models.ForeignKey(help_text='The user that this device belongs to.', to=settings.AUTH_USER_MODEL, on_delete=models.CASCADE)),
26 |             ],
27 |             options={
28 |                 'abstract': False,
29 |                 'verbose_name': 'Twilio SMS Device',
30 |             },
31 |             bases=(models.Model,),
32 |         ),
33 |     ]
34 | 


--------------------------------------------------------------------------------
/src/otp_twilio/migrations/0002_last_t.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | from __future__ import unicode_literals
 3 | 
 4 | from django.db import migrations, models
 5 | 
 6 | 
 7 | class Migration(migrations.Migration):
 8 | 
 9 |     dependencies = [
10 |         ('otp_twilio', '0001_initial'),
11 |     ]
12 | 
13 |     operations = [
14 |         migrations.AddField(
15 |             model_name='twiliosmsdevice',
16 |             name='last_t',
17 |             field=models.BigIntegerField(default=-1, help_text='The t value of the latest verified token. The next token must be at a higher time step.'),
18 |             preserve_default=True,
19 |         ),
20 |     ]
21 | 


--------------------------------------------------------------------------------
/src/otp_twilio/migrations/0003_longer_number.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | from __future__ import unicode_literals
 3 | 
 4 | from django.db import migrations, models
 5 | 
 6 | 
 7 | class Migration(migrations.Migration):
 8 | 
 9 |     dependencies = [
10 |         ('otp_twilio', '0002_last_t'),
11 |     ]
12 | 
13 |     operations = [
14 |         migrations.AlterField(
15 |             model_name='twiliosmsdevice',
16 |             name='number',
17 |             field=models.CharField(help_text='The mobile number to deliver tokens to (E.164).', max_length=30),
18 |         ),
19 |     ]
20 | 


--------------------------------------------------------------------------------
/src/otp_twilio/migrations/0004_sidechanneldevice.py:
--------------------------------------------------------------------------------
 1 | # Generated by Django 3.0.6 on 2020-05-06 12:59
 2 | 
 3 | from django.db import migrations, models
 4 | import django.utils.timezone
 5 | 
 6 | 
 7 | class Migration(migrations.Migration):
 8 | 
 9 |     dependencies = [
10 |         ('otp_twilio', '0003_longer_number'),
11 |     ]
12 | 
13 |     operations = [
14 |         migrations.RemoveField(
15 |             model_name='twiliosmsdevice',
16 |             name='key',
17 |         ),
18 |         migrations.RemoveField(
19 |             model_name='twiliosmsdevice',
20 |             name='last_t',
21 |         ),
22 |         migrations.AddField(
23 |             model_name='twiliosmsdevice',
24 |             name='throttling_failure_count',
25 |             field=models.PositiveIntegerField(default=0, help_text='Number of successive failed attempts.'),
26 |         ),
27 |         migrations.AddField(
28 |             model_name='twiliosmsdevice',
29 |             name='throttling_failure_timestamp',
30 |             field=models.DateTimeField(blank=True, default=None, help_text='A timestamp of the last failed verification attempt. Null if last attempt succeeded.', null=True),
31 |         ),
32 |         migrations.AddField(
33 |             model_name='twiliosmsdevice',
34 |             name='token',
35 |             field=models.CharField(blank=True, max_length=16, null=True),
36 |         ),
37 |         migrations.AddField(
38 |             model_name='twiliosmsdevice',
39 |             name='valid_until',
40 |             field=models.DateTimeField(default=django.utils.timezone.now, help_text='The timestamp of the moment of expiry of the saved token.'),
41 |         ),
42 |     ]
43 | 


--------------------------------------------------------------------------------
/src/otp_twilio/migrations/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/django-otp/django-otp-twilio/91160690da131f813c0dff79c73e3faead32cb53/src/otp_twilio/migrations/__init__.py


--------------------------------------------------------------------------------
/src/otp_twilio/models.py:
--------------------------------------------------------------------------------
  1 | import logging
  2 | 
  3 | from django_otp.models import SideChannelDevice, ThrottlingMixin
  4 | from django_otp.util import hex_validator, random_hex
  5 | import requests
  6 | 
  7 | from django.core.exceptions import ImproperlyConfigured
  8 | from django.db import models
  9 | from django.utils.encoding import force_str
 10 | 
 11 | from .conf import settings
 12 | 
 13 | logger = logging.getLogger(__name__)
 14 | 
 15 | 
 16 | def default_key():  # pragma: no cover
 17 |     """Obsolete code here for migrations."""
 18 |     return force_str(random_hex(20))
 19 | 
 20 | 
 21 | def key_validator(value):  # pragma: no cover
 22 |     """Obsolete code here for migrations."""
 23 |     return hex_validator(20)(value)
 24 | 
 25 | 
 26 | class TwilioSMSDevice(ThrottlingMixin, SideChannelDevice):
 27 |     """
 28 |     A :class:`~django_otp.models.SideChannelDevice` that delivers a token via
 29 |     the Twilio SMS service.
 30 | 
 31 |     The tokens are valid for :setting:`OTP_TWILIO_TOKEN_VALIDITY` seconds. Once
 32 |     a token has been accepted, it is no longer valid.
 33 | 
 34 |     .. attribute:: number
 35 | 
 36 |         *CharField*: The mobile phone number to deliver to. `Twilio recommends
 37 |         <https://www.twilio.com/docs/api/rest/sending-messages>`_ using the
 38 |         `E.164 <http://en.wikipedia.org/wiki/E.164>`_ format. For US numbers,
 39 |         this would look like '+15555555555'. At the time of writing, Twilio
 40 |         will try to infer the correct E.164 format if it is not used, but this
 41 |         should not be relied upon.
 42 | 
 43 |     """
 44 | 
 45 |     number = models.CharField(
 46 |         max_length=30, help_text="The mobile number to deliver tokens to (E.164)."
 47 |     )
 48 | 
 49 |     class Meta(SideChannelDevice.Meta):
 50 |         verbose_name = "Twilio SMS Device"
 51 | 
 52 |     def get_throttle_factor(self):
 53 |         return settings.OTP_TWILIO_THROTTLE_FACTOR
 54 | 
 55 |     def generate_challenge(self):
 56 |         """
 57 |         Sends the current TOTP token to ``self.number``.
 58 | 
 59 |         :returns: :setting:`OTP_TWILIO_CHALLENGE_MESSAGE` on success.
 60 |         :raises: Exception if delivery fails.
 61 | 
 62 |         """
 63 |         self.generate_token(valid_secs=settings.OTP_TWILIO_TOKEN_VALIDITY)
 64 | 
 65 |         message = settings.OTP_TWILIO_TOKEN_TEMPLATE.format(token=self.token)
 66 | 
 67 |         if settings.OTP_TWILIO_NO_DELIVERY:
 68 |             logger.info(message)
 69 |         else:
 70 |             self._deliver_token(message)
 71 | 
 72 |         challenge = settings.OTP_TWILIO_CHALLENGE_MESSAGE.format(token=self.token)
 73 | 
 74 |         return challenge
 75 | 
 76 |     def _deliver_token(self, token):
 77 |         self._validate_config()
 78 | 
 79 |         url = '{0}/2010-04-01/Accounts/{1}/Messages.json'.format(
 80 |             settings.OTP_TWILIO_URL, settings.OTP_TWILIO_ACCOUNT
 81 |         )
 82 |         data = {
 83 |             'To': self.number,
 84 |             'Body': str(token),
 85 |         }
 86 |         if settings.OTP_TWILIO_MESSAGING_SERVICE_SID:
 87 |             data['MessagingServiceSid'] = settings.OTP_TWILIO_MESSAGING_SERVICE_SID
 88 |         elif settings.OTP_TWILIO_FROM:
 89 |             data['From'] = settings.OTP_TWILIO_FROM
 90 |         else:
 91 |             raise ImproperlyConfigured(
 92 |                 'Either OTP_TWILIO_FROM or OTP_TWILIO_MESSAGING_SERVICE_SID must be set.'
 93 |             )
 94 | 
 95 |         response = requests.post(
 96 |             url,
 97 |             data=data,
 98 |             auth=(
 99 |                 (
100 |                     settings.OTP_TWILIO_API_KEY
101 |                     if settings.OTP_TWILIO_API_KEY
102 |                     else settings.OTP_TWILIO_ACCOUNT
103 |                 ),
104 |                 settings.OTP_TWILIO_AUTH,
105 |             ),
106 |         )
107 | 
108 |         try:
109 |             response.raise_for_status()
110 |         except Exception as e:
111 |             logger.exception('Error sending token by Twilio SMS: {0}'.format(e))
112 |             raise
113 | 
114 |         if 'sid' not in response.json():
115 |             message = response.json().get('message')
116 |             logger.error('Error sending token by Twilio SMS: {0}'.format(message))
117 |             raise Exception(message)
118 | 
119 |     def _validate_config(self):
120 |         if settings.OTP_TWILIO_ACCOUNT is None:
121 |             raise ImproperlyConfigured(
122 |                 'OTP_TWILIO_ACCOUNT must be set to your Twilio account identifier'
123 |             )
124 | 
125 |         if settings.OTP_TWILIO_AUTH is None:
126 |             raise ImproperlyConfigured(
127 |                 'OTP_TWILIO_AUTH must be set to your Twilio auth token'
128 |             )
129 | 
130 |     def verify_token(self, token):
131 |         verify_allowed, _ = self.verify_is_allowed()
132 |         if verify_allowed:
133 |             verified = super().verify_token(token)
134 | 
135 |             if verified:
136 |                 self.throttle_reset()
137 |             else:
138 |                 self.throttle_increment()
139 |         else:
140 |             verified = False
141 | 
142 |         return verified
143 | 


--------------------------------------------------------------------------------
/src/otp_twilio/tests.py:
--------------------------------------------------------------------------------
  1 | from unittest import mock
  2 | 
  3 | from django_otp.tests import TestCase, ThrottlingTestMixin
  4 | from freezegun import freeze_time
  5 | 
  6 | from django.db import IntegrityError
  7 | from django.test.utils import override_settings
  8 | 
  9 | from .conf import settings
 10 | 
 11 | 
 12 | class TwilioDeviceMixin:
 13 |     def setUp(self):
 14 |         try:
 15 |             alice = self.create_user('alice', 'password')
 16 |             bob = self.create_user('bob', 'password')
 17 |         except IntegrityError:
 18 |             self.skipTest("Unable to create test users.")
 19 |         else:
 20 |             self.device = alice.twiliosmsdevice_set.create(number='test')
 21 |             self.device2 = bob.twiliosmsdevice_set.create(number='test')
 22 | 
 23 | 
 24 | @override_settings(
 25 |     OTP_TWILIO_NO_DELIVERY=True,
 26 |     OTP_TWILIO_CHALLENGE_MESSAGE='{token}',
 27 |     OTP_TWILIO_THROTTLE_FACTOR=0,
 28 | )
 29 | class TestTwilioSMS(TwilioDeviceMixin, TestCase):
 30 |     def setUp(self):
 31 |         super().setUp()
 32 | 
 33 |         self._delivered = None
 34 | 
 35 |     def test_instant(self):
 36 |         """Verify a code the instant it was generated."""
 37 |         with freeze_time():
 38 |             token = self.device.generate_challenge()
 39 |             ok = self.device.verify_token(token)
 40 | 
 41 |         self.assertTrue(ok)
 42 | 
 43 |     def test_barely_made_it(self):
 44 |         """Verify a code at the last possible second."""
 45 |         with freeze_time() as frozen_time:
 46 |             token = self.device.generate_challenge()
 47 |             frozen_time.tick(delta=(settings.OTP_TWILIO_TOKEN_VALIDITY - 1))
 48 |             ok = self.device.verify_token(token)
 49 | 
 50 |         self.assertTrue(ok)
 51 | 
 52 |     def test_too_late(self):
 53 |         """Try to verify a code one second after it expires."""
 54 |         with freeze_time() as frozen_time:
 55 |             token = self.device.generate_challenge()
 56 |             frozen_time.tick(delta=(settings.OTP_TWILIO_TOKEN_VALIDITY + 1))
 57 |             ok = self.device.verify_token(token)
 58 | 
 59 |         self.assertFalse(ok)
 60 | 
 61 |     def test_code_reuse(self):
 62 |         """Try to verify the same code twice."""
 63 |         with freeze_time():
 64 |             token = self.device.generate_challenge()
 65 |             ok1 = self.device.verify_token(token)
 66 |             ok2 = self.device.verify_token(token)
 67 | 
 68 |         self.assertTrue(ok1)
 69 |         self.assertFalse(ok2)
 70 | 
 71 |     def test_cross_user(self):
 72 |         with freeze_time():
 73 |             token = self.device.generate_challenge()
 74 |             ok = self.device2.verify_token(token)
 75 | 
 76 |         self.assertFalse(ok)
 77 | 
 78 |     @override_settings(
 79 |         OTP_TWILIO_NO_DELIVERY=False,
 80 |         OTP_TWILIO_TOKEN_TEMPLATE='Token is {token}',
 81 |     )
 82 |     def test_format(self):
 83 |         with mock.patch(
 84 |             'otp_twilio.models.TwilioSMSDevice._deliver_token', self._deliver_token
 85 |         ):
 86 |             self.device.generate_challenge()
 87 | 
 88 |         self.assertEqual('Token is {}'.format(self.device.token), self._delivered)
 89 | 
 90 |     #
 91 |     # Utilities
 92 |     #
 93 | 
 94 |     def _deliver_token(self, token):
 95 |         self._delivered = token
 96 | 
 97 | 
 98 | @override_settings(
 99 |     OTP_TWILIO_NO_DELIVERY=True,
100 |     OTP_TWILIO_THROTTLE_FACTOR=1,
101 | )
102 | class ThrottlingTestCase(TwilioDeviceMixin, ThrottlingTestMixin, TestCase):
103 |     def valid_token(self):
104 |         if self.device.token is None:
105 |             self.device.generate_token()
106 | 
107 |         return self.device.token
108 | 
109 |     def invalid_token(self):
110 |         return -1
111 | 


--------------------------------------------------------------------------------
/test/test_project/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/django-otp/django-otp-twilio/91160690da131f813c0dff79c73e3faead32cb53/test/test_project/__init__.py


--------------------------------------------------------------------------------
/test/test_project/settings.py:
--------------------------------------------------------------------------------
 1 | # django-otp-twilio test project
 2 | 
 3 | from os.path import abspath, dirname, join
 4 | 
 5 | 
 6 | def project_path(path):
 7 |     return abspath(join(dirname(__file__), path))
 8 | 
 9 | 
10 | DEBUG = True
11 | 
12 | DATABASES = {
13 |     'default': {
14 |         'ENGINE': 'django.db.backends.sqlite3',
15 |         'NAME': ':memory:',
16 |     }
17 | }
18 | 
19 | DEFAULT_AUTO_FIELD = 'django.db.models.AutoField'
20 | 
21 | INSTALLED_APPS = [
22 |     'django.contrib.admin',
23 |     'django.contrib.auth',
24 |     'django.contrib.contenttypes',
25 |     'django.contrib.sessions',
26 |     'django.contrib.messages',
27 | 
28 |     'django_otp',
29 |     'otp_twilio',
30 | ]
31 | 
32 | MIDDLEWARE = [
33 |     'django.middleware.security.SecurityMiddleware',
34 |     'django.contrib.sessions.middleware.SessionMiddleware',
35 |     'django.middleware.common.CommonMiddleware',
36 |     'django.middleware.csrf.CsrfViewMiddleware',
37 |     'django.contrib.auth.middleware.AuthenticationMiddleware',
38 |     'django_agent_trust.middleware.AgentMiddleware',
39 |     'django_otp.middleware.OTPMiddleware',
40 |     'django.contrib.messages.middleware.MessageMiddleware',
41 |     'django.middleware.clickjacking.XFrameOptionsMiddleware',
42 | ]
43 | 
44 | TEMPLATES = [
45 |     {
46 |         'BACKEND': 'django.template.backends.django.DjangoTemplates',
47 |         'APP_DIRS': True,
48 |         'DIRS': [
49 |             project_path('templates'),
50 |         ],
51 |         'OPTIONS': {
52 |             'context_processors': [
53 |                 'django.template.context_processors.debug',
54 |                 'django.template.context_processors.request',
55 |                 'django.contrib.auth.context_processors.auth',
56 |                 'django.contrib.messages.context_processors.messages',
57 |             ],
58 |         },
59 |     },
60 | ]
61 | 
62 | SECRET_KEY = 'PWuluw4x48GkT7JDPzlDQsBJC8pjIIiqodW9MuMYcU315YEkGJL41i5qooJsg3Tt'
63 | 
64 | ROOT_URLCONF = 'test_project.urls'
65 | 
66 | USE_TZ = True
67 | 


--------------------------------------------------------------------------------
/test/test_project/templates/registration/logged_out.html:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/django-otp/django-otp-twilio/91160690da131f813c0dff79c73e3faead32cb53/test/test_project/templates/registration/logged_out.html


--------------------------------------------------------------------------------
/test/test_project/urls.py:
--------------------------------------------------------------------------------
 1 | from django.contrib import admin
 2 | import django.contrib.auth.views
 3 | from django.urls import path
 4 | 
 5 | 
 6 | urlpatterns = [
 7 |     path('login/', django.contrib.auth.views.LoginView.as_view()),
 8 |     path('logout/', django.contrib.auth.views.LogoutView.as_view()),
 9 |     path('admin/', admin.site.urls),
10 | ]
11 | 


--------------------------------------------------------------------------------