first commit

jamstooks · Apr 19, 2016 · 501c17d · 501c17d
commit 501c17d
Show file tree

Hide file tree

Showing 13 changed files with 182 additions and 0 deletions.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,27 @@
+Copyright (c) Benjamin W Stookey and individual contributors.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    1. Redistributions of source code must retain the above copyright notice, 
+       this list of conditions and the following disclaimer.
+
+    2. 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.
+
+    3. Neither the name of Benjamin W Stookey nor the names of its contributors may 
+       be used to endorse or promote products derived from this software 
+       without specific prior written permission.
+
+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 OWNER 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.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0 +1,4 @@
+include LICENSE
+include README.md
+recursive-include acme_challenge/templates *
+recursive-include acme_challenge/tests *
diff --git a/README.md b/README.md
@@ -0,0 +1,25 @@
+# django-acme-challenge
+
+A quick tool to serve the acme-challenge verification page. When creating an SSL certificate with Let's Encrypt, you need to serve a page that they request to confirm you own the site:
+
+    Make sure your web server displays the following content at
+    http://your-domain-name/.well-known/acme-challenge/l9msb_LONG_STRING before continuing:
+
+    l9msb_LONG_STRING.LONG_STRING
+
+This app provides a quick way to serve that page.
+
+## Installation
+
+Add `'acme_challenge',` to your installed apps and update your urls.py:
+
+    url(r'^.well-known/acme-challenge/', include('acme_challenge.urls')),
+
+### Settings
+
+Just set two variables:
+
+  - `ACME_CHALLENGE_URL_SLUG`
+  - `ACME_CHALLENGE_TEMPLATE_CONTENT`
+
+`http://your-domain-name/.well-known/acme-challenge/ACME_CHALLENGE_URL_SLUG` will then serve the value of `ACME_CHALLENGE_TEMPLATE_CONTENT` for validation.
diff --git a/acme_challenge/__init__.py b/acme_challenge/__init__.py
diff --git a/acme_challenge/models.py b/acme_challenge/models.py
diff --git a/acme_challenge/templates/acme_challenge/default.txt b/acme_challenge/templates/acme_challenge/default.txt
@@ -0,0 +1 @@
+{{ ACME_CHALLENGE_TEMPLATE_CONTENT }}
diff --git a/acme_challenge/tests/__init__.py b/acme_challenge/tests/__init__.py
diff --git a/acme_challenge/tests/test_view.py b/acme_challenge/tests/test_view.py
@@ -0,0 +1,26 @@
+"""
+    Simple test to confirm that the view shows what it should when it should
+"""
+
+from django.test import TestCase, Client
+from django.conf import settings
+
+__all__ = (
+    'ViewTest',
+)
+
+class ViewTest(TestCase):
+
+    def setUp(self):
+        """
+            Set the settings variables
+        """
+        settings.ACME_CHALLENGE_URL_SLUG = "test"
+        settings.ACME_CHALLENGE_TEMPLATE_CONTENT = "test content"
+
+    def testView(self):
+        c = Client()
+        response = c.get("/test")
+        self.assertEqual(response.content, "test content")
+        response = c.get("/test2")
+        self.assertEqual(response.status_code, 404)
diff --git a/acme_challenge/urls.py b/acme_challenge/urls.py
@@ -0,0 +1,10 @@
+from django.conf.urls import url
+from views import ACMEChallengeView
+
+urlpatterns = [
+    url(
+        r'^(?P<challenge_slug>[\w\-]+)$',
+        ACMEChallengeView.as_view(),
+        name='acme-challenge'
+    ),
+]
diff --git a/acme_challenge/views.py b/acme_challenge/views.py
@@ -0,0 +1,19 @@
+from django.views.generic import TemplateView
+from django.conf import settings
+from django.http import Http404
+
+
+class ACMEChallengeView(TemplateView):
+    """
+        If the appropriate settings vars are set and the slug matches the url,
+        then serve the ACME Challenge value
+    """
+    template_name = "acme_challenge/default.txt"
+
+    def get_context_data(self, **kwargs):
+        if settings.ACME_CHALLENGE_URL_SLUG and settings.ACME_CHALLENGE_TEMPLATE_CONTENT:
+            if self.kwargs['challenge_slug'] == settings.ACME_CHALLENGE_URL_SLUG:
+                context = super(ACMEChallengeView, self).get_context_data(**kwargs)
+                context['ACME_CHALLENGE_TEMPLATE_CONTENT'] = settings.ACME_CHALLENGE_TEMPLATE_CONTENT
+                return context
+        raise Http404
diff --git a/requirements.txt b/requirements.txt
diff --git a/setup.py b/setup.py
@@ -0,0 +1,34 @@
+#!/usr/bin/env python
+from setuptools import setup, find_packages
+import os
+
+
+# Utility function to read README file
+def read(fname):
+    return open(os.path.join(os.path.dirname(__file__), fname)).read()
+
+setup(
+    name='django-acme-challenge',
+    version='0.1',
+    description="A quick tool to serve the acme-challenge verification page.",
+    author='Benjamin W Stookey',
+    author_email='ben.stookey@gmail.com',
+    url='https://github.com/jamstooks/django-acme-challenge',
+    long_description=read("README.md"),
+    packages=[
+        'acme_challenge',
+        'acme_challenge.tests'
+        ],
+    include_package_data=True,
+    classifiers=[
+        'Environment :: Web Environment',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: BSD License',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python :: 2.6',
+        'Programming Language :: Python :: 2.7',
+        'Framework :: Django',
+    ],
+    test_suite='tests.main',
+    install_requires=['Django',],
+)
diff --git a/tests.py b/tests.py
@@ -0,0 +1,36 @@
+import django
+from django.conf import settings
+
+
+def main():
+    settings.configure(
+        DATABASES={
+            'default': {
+                'ENGINE': 'django.db.backends.sqlite3',
+            }
+        },
+        ROOT_URLCONF='acme_challenge.urls',
+        INSTALLED_APPS=(
+            'django.contrib.auth',
+            'django.contrib.contenttypes',
+            'django.contrib.sessions',
+            'django.contrib.admin',
+            'acme_challenge',)
+    )
+
+    django.setup()
+    try:
+        # Django <= 1.8
+        from django.test.simple import DjangoTestSuiteRunner
+        test_runner = DjangoTestSuiteRunner(verbosity=1)
+    except ImportError:
+        # Django >= 1.8
+        from django.test.runner import DiscoverRunner
+        test_runner = DiscoverRunner(verbosity=1)
+
+    failures = test_runner.run_tests(['acme_challenge'])
+    if failures:
+        sys.exit(failures)
+
+if __name__ == '__main__':
+    main()