urda / django-letsencrypt

A simple Django app to handle Let's Encrypt ACME challenges

Let's Encrypt App for Django

django-letsencrypt will allow you to add, remove, and update any ACME challenge objects you may need through your Django admin interface. Simply add the ACME challenge and response for your app to serve up the necessary information for Let's Encrypt validation.

This project strives to make installation, configuration, and usage a snap! From high levels of code coverage, multiple compatible python versions, multiple versions of Django supported, even multiple databases too!

And of course all wrapped up and published to PyPI for standard installation!

Supported Configurations

django-letsencrypt is tested across a number of configurations, here's what's supported so far:

• Python Versions Supported:
  • 3.10 (Django 4.0 and 3.2 only)
  • 3.9 (Django 4.0 and 3.2 only)
  • 3.8
  • 3.7 (Django 3.2 and 2.2 only)
• Django Versions Supported:
  • 4.0 minimum version 4.0
  • 3.2 minimum version 3.2.10
  • 2.2 minimum version 2.2.25
• Databases Supported:
  • mysql
  • postgres
  • sqlite

Recent Build Status Badges

• 
• 
• 
• 
• 

Installation & Configuration

1. pip install django-letsencrypt

2. Add letsencrypt to your INSTALLED_APPS

INSTALLED_APPS = [
   ... ,
   'letsencrypt',
   ... ,
]

3. Include the letsencrypt in your project's urls.py, or where applicable (usually your root urls.py).

re_path(r'^\.well-known/', include('letsencrypt.urls'))

4. Run manage.py migrate to create the required table for the letsencrypt model

5. Create your ACME Challenge objects in your Django admin interface

6. Test your ACME Challenge objects and their responses by visiting them:

{Django Site}/.well-known/acme-challenge/challenge_text

7. Enjoy your easy to manage ACME Challenges inside your Django project!

Example Project

If you would like a demo of how to use this application simply clone this project's git repository from GitHub, take a moment to read the README.md file within the example_project directory, and follow the directions. That will spin up a small sample django application already configured for you to try out.

django-letsencrypt's Issues

Minimum requirements

django-letsencrypt forces django to update when installing. Can you set a minimum requirement?

Investigate getting Codecov to fail builds on coverage percentage

Investigate (and possibly integrate) tox into the project.

During work on PR #59 , it was discovered that the make test that is ran locally on a developer's machine will never report full coverage due to a recent import change required in Django 2.0.

It looks like it is time to start using / integrate tox into the project to handle all the different Django and python versions that Travis CI is targeting.

Support final version of 2.1

With the release of Django 2.2, Django 2.1 has reached the end of mainstream support. The final minor bug fix release, 2.1.8, was issued today. Django 2.1 will receive security and data loss fixes until December 2019. All users are encouraged to upgrade before then to continue receiving fixes for security issues.

README.rst rendering issues on PyPi

The numbered steps are "restarting" over on PyPi, but look ok here on GitHub. This should be corrected for documentation purposes.

References:

http://stackoverflow.com/a/29371701/169153

Sunset Python 2

This project will be dropping support for python 2 sometime soon. This will result in a "version bump" of the project, with support for python 2 removed.

How can i get ACME challenge objects

How can i get ACME challenge objects?

BR Hexxter

Support Django 2.2

See also: Django 2.2 released @ djangoproject.com.

With the release of Django 2.2, Django 2.1 has reached the end of mainstream support. The final minor bug fix release, 2.1.8, was issued today. Django 2.1 will receive security and data loss fixes until December 2019. All users are encouraged to upgrade before then to continue receiving fixes for security issues.

Sunset Django 1.8

Problem

Django 1.8 support ended on April 1, 2018. This project will be dropping support for that version.

Current

Future

Support Django 3.0

https://docs.djangoproject.com/en/3.0/releases/3.0/

Verify databases are being tested correctly

Once issue #10 is rounded off, we will want to make sure that our database types are actually being tested (object CRUD basically).

COVID RE-Plan

Good lord 2020 is awful isn't it?

I've got a list of housekeeping, build changes, and updates to do. Taking this odd time in history to close those linger issues, and start a re-plan.

Once I have work in motion on that, I'll close this out.

Sunset Django 1.10

Problem

Django 1.10 support will be ending December 2017. At that time, this project will be dropping support for those versions.

Current

Future

multi site configuration

This is a question rather than a bug. We are hosting multiple domains from our website. If I understand correctly, our app needs to generate challenge / response tokens (or manually through the backend) so that letsencrypt can validate. How does one go about requesting the certificate? Via the commandline tool? I would like to think there is an automated way of generating and renewing these through Django somehow.

django-letsencrypt allows multiple, equal challenge values -- MultipleObjectsReturned

MultipleObjectsReturned at /.well-known/acme-challenge/CHALLENGE_TEXT

get() returned more than one AcmeChallenge -- it returned 2!

Model class letsencrypt.models.AcmeChallenge doesn't declare an explicit app_label and isn't in an application in INSTALLED_APPS.

RuntimeError at /admin/
Model class letsencrypt.models.AcmeChallenge doesn't declare an explicit app_label and isn't in an application in INSTALLED_APPS.

Hello How to fix it, I can't login admin

How to migrate from 1.0.8 to 2.0.0?

I am getting:

Applying letsencrypt.0001_squashed_0004_squash_for_mysql_support...Traceback (most recent call last):
  File "./manage.py", line 11, in <module>
    execute_from_command_line(sys.argv)
  File "/usr/local/lib/python2.7/site-packages/django/core/management/__init__.py", line 363, in execute_from_command_line
    utility.execute()
  File "/usr/local/lib/python2.7/site-packages/django/core/management/__init__.py", line 355, in execute
    self.fetch_command(subcommand).run_from_argv(self.argv)
  File "/usr/local/lib/python2.7/site-packages/django/core/management/base.py", line 283, in run_from_argv
    self.execute(*args, **cmd_options)
  File "/usr/local/lib/python2.7/site-packages/django/core/management/base.py", line 330, in execute
    output = self.handle(*args, **options)
  File "/usr/local/lib/python2.7/site-packages/django/core/management/commands/migrate.py", line 204, in handle
    fake_initial=fake_initial,
  File "/usr/local/lib/python2.7/site-packages/django/db/migrations/executor.py", line 115, in migrate
    state = self._migrate_all_forwards(state, plan, full_plan, fake=fake, fake_initial=fake_initial)
  File "/usr/local/lib/python2.7/site-packages/django/db/migrations/executor.py", line 145, in _migrate_all_forwards
    state = self.apply_migration(state, migration, fake=fake, fake_initial=fake_initial)
  File "/usr/local/lib/python2.7/site-packages/django/db/migrations/executor.py", line 244, in apply_migration
    state = migration.apply(state, schema_editor)
  File "/usr/local/lib/python2.7/site-packages/django/db/migrations/migration.py", line 129, in apply
    operation.database_forwards(self.app_label, schema_editor, old_state, project_state)
  File "/usr/local/lib/python2.7/site-packages/django/db/migrations/operations/models.py", line 97, in database_forwards
    schema_editor.create_model(model)
  File "/usr/local/lib/python2.7/site-packages/django/db/backends/base/schema.py", line 303, in create_model
    self.execute(sql, params or None)
  File "/usr/local/lib/python2.7/site-packages/django/db/backends/base/schema.py", line 120, in execute
    cursor.execute(sql, params)
  File "/usr/local/lib/python2.7/site-packages/django/db/backends/utils.py", line 80, in execute
    return super(CursorDebugWrapper, self).execute(sql, params)
  File "/usr/local/lib/python2.7/site-packages/raven/contrib/django/client.py", line 114, in execute
    return real_execute(self, sql, params)
  File "/usr/local/lib/python2.7/site-packages/django/db/backends/utils.py", line 65, in execute
    return self.cursor.execute(sql, params)
  File "/usr/local/lib/python2.7/site-packages/django/db/utils.py", line 94, in __exit__
    six.reraise(dj_exc_type, dj_exc_value, traceback)
  File "/usr/local/lib/python2.7/site-packages/django/db/backends/utils.py", line 63, in execute
    return self.cursor.execute(sql)
django.db.utils.ProgrammingError: relation "letsencrypt_acmechallenge" already exists

Any way to fix it without reapplying all migrations?

ValueError during pip install

Starting with django-letsencrypt version 2.0.0, a pip install fails where version 1.1.1 doesn't fail

OS : Linux version 3.16.0-4-amd64 ([email protected]) (gcc version 4.8.4 (Debian 4.8.4-1) ) #1 SMP Debian 3.16.43-2+deb8u5 (2017-09-19)

Error:
ValueError: ("Expected ',' or end-of-list in", 'Django >=1.8.18,!=1.9.', 'at', '')
This is on a fresh VM with python 2.7 and Django 1.11.7 installed immediately prior

CHANGELOG.md

This project needs one.

Investigate getting Codecov to fail builds on coverage percentage

As shown in PR #68 , a coverage drop wasn't marked as a build failure. I need to investigate configuring Codecov to fail any loss of test coverage automatically.

Sync 'pytz' versions in project

It's time to sync pytz to the following:

• 2017.2

Installed according to directions and still got 404

Installed according to directions and still got a 404
Ubuntu20, Apahce2, Django 3.1.4

Version Sync for 2020

Django 3.0 came out, and this project needs to sync up with versions and verify things are still working as expected.

I'll be using this issue to track the overall progress of this task.

Pytz needs a version bump

https://pypi.org/project/pytz/#history

Just released this month: 2018.4

Project Sync and Housekeeping 2020

This issue will serve as the common issue for the sync and housekeeping for the year 2020 here.

Sync with Django Roadmap

The project should sync with the current Django roadmap and make sure the latest versions are being targeted as expected.

Add Django 1.11 LTS Support

The Django project will be releasing 1.11 LTS in April of 2017. It is in the project's best interest to have the 2.x release support this new version, regardless if 1.9 support is dropped in the project.

Sources

• https://www.djangoproject.com/download/#supported-versions

Support Python 3.7

Support for python 3.7 should be verified and added to the project.

Sync 'patch' versions in project

It's time to sync the following versions with their latest release:

• 1.8.x
• 1.10.x
• 1.11.x

Investigate using Docker for example_project

Instead of standing up a virtualenv and configuring a local environment just to checkout the example_project, it may be worthwhile to investigate moving to a docker based solution.

Drop support for all Django versions prior to 2.2

https://docs.djangoproject.com/en/3.0/releases/3.0/#third-party-library-support-for-older-version-of-django

Third-party library support for older version of Django

Following the release of Django 3.0, we suggest that third-party app authors drop support for all versions of Django prior to 2.2. At that time, you should be able to run your package’s tests using python -Wd so that deprecation warnings appear. After making the deprecation warning fixes, your app should be compatible with Django 3.0.

Drop Django 1.9 Support

The Django project will be ending 1.9 support in April 2017 and releasing 1.11 LTS. It may be in the project's best interest to have the 2.x release support those versions going forward. Basically, 2.x will not support the Django 1.9 releases. Since a 2.x release is around the corner, now would be a great time to plan for dropping it.

Sources

• https://www.djangoproject.com/download/#supported-versions

Where can I find the acme challenge response for ACME V2?

I'm trying to set this up and I'm able to find the challenge but unable to find the proper response to use. Where can I find the response? I'm using acme V2

Nothing in admin interface

How this really works? I mean I don't see anything related to letsencrypt inside admin.

Django 1.11

UPDATE:
I did migrate and got this -

Operations to perform:
  Apply all migrations: admin, auth, contenttypes, letsencrypt, sessions
Running migrations:
  Applying letsencrypt.0001_squashed_0004_squash_for_mysql_support... OK

Does it work with postgresql?

Add an `example` django project that uses library

• Makes it easier to create migrations, work on project
• Makes it easier for visitors, interested users to try the project out

Investigate leaving Travis CI

I'm losing confidence in Travis CI. Considering moving to another host (like CricleCI)

See also:

• https://news.ycombinator.com/item?id=25003387
• https://news.ycombinator.com/item?id=24964601
• https://news.ycombinator.com/item?id=19218036
• https://news.ycombinator.com/item?id=18978251

how to configure requests and response?

Admin interface seems working now. But how to configure it?

CMD:
sudo letsencrypt certonly -a webroot --webroot-path=/var/www/html -d example.net -d www.example.net -d ins.example.net

Admin interface

console print

IMPORTANT NOTES:

• The following errors were reported by the server:

  Domain: www.example.net
  Type: unauthorized
  Detail: Invalid response from
  http://www.example.net/.well-known/acme-challenge/j7IoGk-28pxqO1Jwj7NX2ILcaBRg_VHsP4X5t3invMM:
  "

  <title>Page not"

  Domain: ins.doask.net
  Type: unauthorized
  Detail: Invalid response from
  http://ins.example.net/.well-known/acme-challenge/wbey1tDSg1K09qsfLYLTIhLuE09jqlC_qmJkY6vfx5w:
  "

  <title>Page not"

  Domain: doask.net
  Type: unauthorized
  Detail: Invalid response from
  http://example.net/.well-known/acme-challenge/KYgmodeitfS769zHRLy018JfFYw5e2i07qGMm9dwBUY:
  "

  <title>Page not"

  To fix these errors, please make sure that your domain name was
  entered correctly and the DNS A record(s) for that domain
  contain(s) the right IP address.

README link needs updated

Currently, we link to https://letsencrypt.github.io/acme-spec/ in README.rst, but that displays the following when opened:

NOTE: This Repository is Deprecated

This repository is not active and does not accurately reflect what Let's Encrypt currently implements. It's retained only for history.

All new work happens here: https://github.com/ietf-wg-acme/acme/ 

The README file should be updated in reference to this notice.

Thank you to @michaelfrance for reporting this issue.

Investigate switching to Markdown for the README

It looks like Pypi might support Markdown! If so, let's switch to it.

Django 1.10 - sys.modules issue

When following the installation instructions on pypi and using Gunicorn to run my Django app, my urls.py reference to letsencrypt.urls fails.

Having a look at __init__py, this line seems strange

sys.modules['letsencrypt'] = certbot

I haven't been able to make sense of this. Since certbot is installed as a dependency, the certbot binary is available in the pip context on the command line. So now, letsencrypt and certbot point to the same module as far as sys is concerned.

As a result, it seems that Gunicorn picks up letsencrypt as certbot and can't find a urls module linked to the letsencrypt package. So, it's failing the import.

Why set the letsencrypt sys.module equal to certbot? Wouldn't it be better just to leave it as is and have people access certbot directly?

Drop support for 2.1

installed followed instructions but not able to get ssl certification

what's my next step? I am not able to get the ssl certification.. I followed the directives but it's incomplete and there's no example...

MySQL support problems

Looks like we need to see about moving from TextField to CharField on the model.

Strategy to deal with this:

• Accept merge, with mysql as an allowed failure (PR #9)
• Update Model for mysql (PR #10):
  • Create new columns, copy data
  • Change primary key column
  • Remove old columns
• Enable mysql testing (PR #10)

Traceback

Travis Build

Creating test database for alias 'default'...
Traceback (most recent call last):
  File "runtests.py", line 72, in <module>
    failures = test_runner.run_tests(['letsencrypt'])
  File "/home/travis/virtualenv/python2.7.9/lib/python2.7/site-packages/django/test/runner.py", line 210, in run_tests
    old_config = self.setup_databases()
  File "/home/travis/virtualenv/python2.7.9/lib/python2.7/site-packages/django/test/runner.py", line 166, in setup_databases
    **kwargs
  File "/home/travis/virtualenv/python2.7.9/lib/python2.7/site-packages/django/test/runner.py", line 370, in setup_databases
    serialize=connection.settings_dict.get("TEST", {}).get("SERIALIZE", True),
  File "/home/travis/virtualenv/python2.7.9/lib/python2.7/site-packages/django/db/backends/base/creation.py", line 368, in create_test_db
    test_flush=not keepdb,
  File "/home/travis/virtualenv/python2.7.9/lib/python2.7/site-packages/django/core/management/__init__.py", line 120, in call_command
    return command.execute(*args, **defaults)
  File "/home/travis/virtualenv/python2.7.9/lib/python2.7/site-packages/django/core/management/base.py", line 445, in execute
    output = self.handle(*args, **options)
  File "/home/travis/virtualenv/python2.7.9/lib/python2.7/site-packages/django/core/management/commands/migrate.py", line 222, in handle
    executor.migrate(targets, plan, fake=fake, fake_initial=fake_initial)
  File "/home/travis/virtualenv/python2.7.9/lib/python2.7/site-packages/django/db/migrations/executor.py", line 110, in migrate
    self.apply_migration(states[migration], migration, fake=fake, fake_initial=fake_initial)
  File "/home/travis/virtualenv/python2.7.9/lib/python2.7/site-packages/django/db/migrations/executor.py", line 148, in apply_migration
    state = migration.apply(state, schema_editor)
  File "/home/travis/virtualenv/python2.7.9/lib/python2.7/site-packages/django/db/migrations/migration.py", line 115, in apply
    operation.database_forwards(self.app_label, schema_editor, old_state, project_state)
  File "/home/travis/virtualenv/python2.7.9/lib/python2.7/site-packages/django/db/migrations/operations/fields.py", line 201, in database_forwards
    schema_editor.alter_field(from_model, from_field, to_field)
  File "/home/travis/virtualenv/python2.7.9/lib/python2.7/site-packages/django/db/backends/base/schema.py", line 484, in alter_field
    old_db_params, new_db_params, strict)
  File "/home/travis/virtualenv/python2.7.9/lib/python2.7/site-packages/django/db/backends/base/schema.py", line 665, in _alter_field
    self.execute(self._create_unique_sql(model, [new_field.column]))
  File "/home/travis/virtualenv/python2.7.9/lib/python2.7/site-packages/django/db/backends/base/schema.py", line 111, in execute
    cursor.execute(sql, params)
  File "/home/travis/virtualenv/python2.7.9/lib/python2.7/site-packages/django/db/backends/utils.py", line 64, in execute
    return self.cursor.execute(sql, params)
  File "/home/travis/virtualenv/python2.7.9/lib/python2.7/site-packages/django/db/utils.py", line 98, in __exit__
    six.reraise(dj_exc_type, dj_exc_value, traceback)
  File "/home/travis/virtualenv/python2.7.9/lib/python2.7/site-packages/django/db/backends/utils.py", line 64, in execute
    return self.cursor.execute(sql, params)
  File "/home/travis/virtualenv/python2.7.9/lib/python2.7/site-packages/django/db/backends/mysql/base.py", line 124, in execute
    return self.cursor.execute(query, args)
  File "/home/travis/virtualenv/python2.7.9/lib/python2.7/site-packages/MySQLdb/cursors.py", line 250, in execute
    self.errorhandler(self, exc, value)
  File "/home/travis/virtualenv/python2.7.9/lib/python2.7/site-packages/MySQLdb/connections.py", line 42, in defaulterrorhandler
    raise errorvalue
django.db.utils.OperationalError: (1170, "BLOB/TEXT column 'challenge' used in key specification without a key length")