Merge pull request #47 from maykinmedia/feature/46-use-django-simple-…

…certmanager-library Feature/46 use django simple certmanager library
maykinmedia · Aug 31, 2022 · 3fcc230 · 3fcc230
2 parents 6cd56ba + f5ada3c
commit 3fcc230
Show file tree

Hide file tree

Showing 29 changed files with 146 additions and 950 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,7 +1,12 @@
 Changes
 =======
 
-0.20.0 (2022-08-23)
+0.21.0 (2022-8-30)
+-------------------
+
+* Moving TLS certificate management to another library called``django-simple-certmanager``. Managing Certificates with this library remains possible for now, but please consider to update your project.
+
+0.20.0 (2022-8-22)
 -------------------
 
 * Added database field ServiceUrlField

diff --git a/README.rst b/README.rst
@@ -24,7 +24,6 @@ Features
 ========
 
 * Store services with their configuration in the database
-* Manage (mutual) TLS certificates
 * Integrate with OpenAPI 3.0 specifications
 * NLX support
 * Declare data/domain objects as modern Python dataclasses

diff --git a/docs/commands.rst b/docs/commands.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -11,7 +11,6 @@ Features
 --------
 
 * Store services with their configuration in the database
-* Manage (mutual) TLS certificates
 * Integrate with OpenAPI 3.0 specifications
 * NLX support
 * Declare data/domain objects as modern Python dataclasses
@@ -20,7 +19,7 @@ Developed for use in Dutch government software where data exchange with external
 services is run of the mill, this library provides flexibility in configuring your
 environment(s).
 
-ZGW Consumers allows you to centralize the location, credentials, TLS certificate... to
+ZGW Consumers allows you to centralize the location, credentials, API schema information... to
 connect to HTTP-based services. There is first class support for OpenAPI 3
 specifications, but you are not limited to "modern" RESTful services! SOAP/XML services
 can still leverage the utilities offered by ZGW Consumers.
@@ -33,7 +32,6 @@ can still leverage the utilities offered by ZGW Consumers.
    settings
    models
    model_fields
-   commands
    drf
    testing
 

diff --git a/docs/models.rst b/docs/models.rst
@@ -25,16 +25,6 @@ specification. It supports:
    .. automethod:: get_auth_header
 
 
-**Certificate**
-
-The ``Certificate`` model holds your TLS certificates. Files on disk are deleted when
-model instances are deleted.
-
-.. autoclass:: zgw_consumers.models.Certificate
-   :members:
-   :exclude-members: DoesNotExist, MultipleObjectsReturned, clean, save
-
-
 Abstract
 --------
 

diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -17,9 +17,8 @@ Installation
 
 2. Add ``zgw_consumers`` to the ``INSTALLED_APPS`` setting.
 3. Run ``python src/manage.py migrate`` to create the necessary database tables
-4. Configure `django-privates <https://django-privates.readthedocs.io/en/latest/quickstart.html>`_
-   correctly - the TLS certificates and keys are stored outside of ``settings.MEDIA_ROOT``
-   for security reasons.
+4. Configure `django-simple-certmanager <https://django-simple-certmanager.readthedocs.io/en/latest/quickstart.html>`_
+   correctly
 
 
 Usage
@@ -28,7 +27,6 @@ Usage
 In the Django admin, you can create:
 
 * ``Service`` instances to define your external APIs.
-* ``Certificate`` instances to (re-)use (mutual) TLS configuration
 * ``NLXConfig`` configuration for your `NLX <https://nlx.io/>`_ outway.
 
 Constructing an OpenAPI 3 client

diff --git a/setup.cfg b/setup.cfg
@@ -37,10 +37,10 @@ packages = find:
 install_requires =
     django
     django-choices
-    django-privates
     django-relativedelta
     django-solo
     gemma-zds-client>=0.14.0
+    django-simple-certmanager
     requests
     pyopenssl
     # test package

diff --git a/testapp/settings.py b/testapp/settings.py
@@ -45,6 +45,7 @@
     "django.contrib.messages",
     "django.contrib.admin",
     "zgw_consumers",
+    "simple_certmanager",
     "testapp",
 ]
 

diff --git a/tests/data/Readme.md b/tests/data/Readme.md
diff --git a/tests/data/invalid.certificate b/tests/data/invalid.certificate
diff --git a/tests/data/test.certificate b/tests/data/test.certificate
diff --git a/tests/data/test.key b/tests/data/test.key
diff --git a/tests/data/test2.certificate b/tests/data/test2.certificate
diff --git a/tests/data/test2.key b/tests/data/test2.key