From ed257adba0d64bda7d258af7c1625c5b37516ae1 Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Sun, 24 Apr 2016 15:49:52 +0200 Subject: [PATCH 1/8] python setup.py install to find sub-packages --- .gitignore | 3 +++ setup.py | 9 +++++---- 2 files changed, 8 insertions(+), 4 deletions(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b5a6f88 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +*pyc +*egg-info +*egg diff --git a/setup.py b/setup.py index bc28ef4..96ba0ee 100644 --- a/setup.py +++ b/setup.py @@ -1,11 +1,12 @@ -from distutils.core import setup -from distutils.command.install import INSTALL_SCHEMES import os +from distutils.command.install import INSTALL_SCHEMES +from setuptools import setup, find_packages + root = os.path.dirname(os.path.abspath(__file__)) os.chdir(root) -VERSION = '0.1.1' +VERSION = '0.1.2' # Make data go to the right place. # http://groups.google.com/group/comp.lang.python/browse_thread/thread/35ec7b2fed36eaec/2105ee4d9e8042cb @@ -23,7 +24,7 @@ url="http://github.com/codasus/django-sqlcipher", license="Creative Commons Attribution-ShareAlike 3.0 Unported License", platforms=["any"], - packages=['sqlcipher'], + packages=find_packages(), classifiers=[ "Development Status :: 3 - Alpha", "Framework :: Django", From f7c30bca55c0fed998349155c7dbe61e8e580d49 Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Sun, 24 Apr 2016 16:32:42 +0200 Subject: [PATCH 2/8] management commands for cli pragma key --- sqlcipher/management/__init__.py | 0 sqlcipher/management/commands/__init__.py | 0 sqlcipher/management/commands/_mixins.py | 19 +++++++++++++++++++ sqlcipher/management/commands/migrate.py | 12 ++++++++++++ sqlcipher/management/commands/runserver.py | 6 ++++++ 5 files changed, 37 insertions(+) create mode 100644 sqlcipher/management/__init__.py create mode 100644 sqlcipher/management/commands/__init__.py create mode 100644 sqlcipher/management/commands/_mixins.py create mode 100644 sqlcipher/management/commands/migrate.py create mode 100644 sqlcipher/management/commands/runserver.py diff --git a/sqlcipher/management/__init__.py b/sqlcipher/management/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/sqlcipher/management/commands/__init__.py b/sqlcipher/management/commands/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/sqlcipher/management/commands/_mixins.py b/sqlcipher/management/commands/_mixins.py new file mode 100644 index 0000000..994c4e1 --- /dev/null +++ b/sqlcipher/management/commands/_mixins.py @@ -0,0 +1,19 @@ +# -*- coding: utf-8 -*- +from __future__ import unicode_literals +from __future__ import print_function +from django.conf import settings +from getpass import getpass + + +class PromptForPragmaKeyMixin(object): + """"" + This is a universal command that you can have other management commands + inherit from in case they need database access. + """ + + def handle(self, *args, **options): + if not hasattr(settings, 'PRAGMA_KEY') or not settings.PRAGMA_KEY: + print("There is no SQL Cipher key defined, it's unsafe to store in your settings. Please input your key") + key = getpass("Key: ") + settings.PRAGMA_KEY = key + super(PromptForPragmaKeyMixin, self).handle(*args, **options) diff --git a/sqlcipher/management/commands/migrate.py b/sqlcipher/management/commands/migrate.py new file mode 100644 index 0000000..51d1a5b --- /dev/null +++ b/sqlcipher/management/commands/migrate.py @@ -0,0 +1,12 @@ + +from django.core.management.commands.migrate import Command as BaseCommand + +from ._mixins import PromptForPragmaKeyMixin + + +class Command(PromptForPragmaKeyMixin, BaseCommand): + """ + Before migrating, we need to know the pragma key to access the database. If + it does not exist, retrieve it from command line input. + """ + pass diff --git a/sqlcipher/management/commands/runserver.py b/sqlcipher/management/commands/runserver.py new file mode 100644 index 0000000..080ef48 --- /dev/null +++ b/sqlcipher/management/commands/runserver.py @@ -0,0 +1,6 @@ +from django.core.management.commands.runserver import Command as RunserverCommand + +from ._mixins import PromptForPragmaKeyMixin + +class Command(PromptForPragmaKeyMixin, RunserverCommand): + pass From 058e3b8034ad4439cab376881eec7088ca8202af Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Sun, 24 Apr 2016 16:44:09 +0200 Subject: [PATCH 3/8] Add readme stuff about CLI and setting key at runtime --- README.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 7a649c6..39c7373 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -**django-sqlcipher** +# django-sqlcipher SQLCipher is an SQLite extension that provides transparent 256-bit AES encryption of database files. @@ -8,7 +8,7 @@ This app does it for you. You only need to specify the database key in your proj For more about SQLCipher take a look at [http://sqlcipher.net/](http://sqlcipher.net/). -**Requirements** +## Requirements * python-sqlcipher (Python compiled with SQLCipher support) @@ -16,13 +16,13 @@ For more about python-sqlcipher take a look at: [https://code.launchpad.net/~jplacerda/+junk/python-sqlcipher](https://code.launchpad.net/~jplacerda/+junk/python-sqlcipher) -**Installation** +## Installation `pip install git+http://github.com/codasus/django-sqlcipher#egg=sqlcipher` Or manually place it on your `PYTHON_PATH`. -**Configuration** +## Configuration Open your project's `settings.py` file and: @@ -30,11 +30,18 @@ Open your project's `settings.py` file and: 2. Set your database engine to `sqlcipher.backend`. -3. Put the following line where you want: +3. Optionally, type your key into your settings file (**unsafe**): `PRAGMA_KEY = "YOUR DATABASE KEY"` -**MIT License** +You may not wish to expose your encryption key in a file. +django-sqlcipher ships with custom management commands that will prompt +for the key when invoking `runserver` and `migrate`, however you +should consider how you want to set `django.conf.settings.PRAGMA_KEY` +at runtime in your production environment. + + +## MIT License
Copyright (c) 2011 Caio Ariede and Codasus Technologies.
 

From baeafc5043120c904f30d25226db0afdcf2e8d26 Mon Sep 17 00:00:00 2001
From: Benjamin Bach 
Date: Sun, 24 Apr 2016 16:53:28 +0200
Subject: [PATCH 4/8] add loaddata and dumpdata support

---
 sqlcipher/management/commands/dumpdata.py | 6 ++++++
 sqlcipher/management/commands/loaddata.py | 6 ++++++
 2 files changed, 12 insertions(+)
 create mode 100644 sqlcipher/management/commands/dumpdata.py
 create mode 100644 sqlcipher/management/commands/loaddata.py

diff --git a/sqlcipher/management/commands/dumpdata.py b/sqlcipher/management/commands/dumpdata.py
new file mode 100644
index 0000000..fe675b0
--- /dev/null
+++ b/sqlcipher/management/commands/dumpdata.py
@@ -0,0 +1,6 @@
+from django.core.management.commands.dumpdata import Command as DumpdataCommand
+
+from ._mixins import PromptForPragmaKeyMixin
+
+class Command(PromptForPragmaKeyMixin, DumpdataCommand):
+    pass
diff --git a/sqlcipher/management/commands/loaddata.py b/sqlcipher/management/commands/loaddata.py
new file mode 100644
index 0000000..31ad8b8
--- /dev/null
+++ b/sqlcipher/management/commands/loaddata.py
@@ -0,0 +1,6 @@
+from django.core.management.commands.loaddata import Command as LoaddataCommand
+
+from ._mixins import PromptForPragmaKeyMixin
+
+class Command(PromptForPragmaKeyMixin, LoaddataCommand):
+    pass

From 40e4810048ab3d31f619946c195d985ce7098be5 Mon Sep 17 00:00:00 2001
From: Benjamin Bach 
Date: Sun, 24 Apr 2016 17:06:00 +0200
Subject: [PATCH 5/8] Only prompt once during first runserver (auto-reload of
 runserver will also prompt still)

---
 sqlcipher/management/commands/_mixins.py   | 12 ++++++++----
 sqlcipher/management/commands/runserver.py | 10 +++++++---
 2 files changed, 15 insertions(+), 7 deletions(-)

diff --git a/sqlcipher/management/commands/_mixins.py b/sqlcipher/management/commands/_mixins.py
index 994c4e1..a99f189 100644
--- a/sqlcipher/management/commands/_mixins.py
+++ b/sqlcipher/management/commands/_mixins.py
@@ -5,6 +5,13 @@
 from getpass import getpass
 
 
+def ensure_pragma_key():
+    if not hasattr(settings, 'PRAGMA_KEY') or not settings.PRAGMA_KEY:
+        print("There is no SQL Cipher key defined, it's unsafe to store in your settings. Please input your key")
+        key = getpass("Key: ")
+        settings.PRAGMA_KEY = key
+
+
 class PromptForPragmaKeyMixin(object):
     """""
     This is a universal command that you can have other management commands
@@ -12,8 +19,5 @@ class PromptForPragmaKeyMixin(object):
     """
 
     def handle(self, *args, **options):
-        if not hasattr(settings, 'PRAGMA_KEY') or not settings.PRAGMA_KEY:
-            print("There is no SQL Cipher key defined, it's unsafe to store in your settings. Please input your key")
-            key = getpass("Key: ")
-            settings.PRAGMA_KEY = key
+        ensure_pragma_key()
         super(PromptForPragmaKeyMixin, self).handle(*args, **options)
diff --git a/sqlcipher/management/commands/runserver.py b/sqlcipher/management/commands/runserver.py
index 080ef48..7f20613 100644
--- a/sqlcipher/management/commands/runserver.py
+++ b/sqlcipher/management/commands/runserver.py
@@ -1,6 +1,10 @@
 from django.core.management.commands.runserver import Command as RunserverCommand
 
-from ._mixins import PromptForPragmaKeyMixin
+from ._mixins import ensure_pragma_key
 
-class Command(PromptForPragmaKeyMixin, RunserverCommand):
-    pass
+
+class Command(RunserverCommand):
+
+    def inner_run(self, *args, **options):
+        ensure_pragma_key()
+        RunserverCommand.inner_run(self, *args, **options)

From b2b726243416e1bdf106bbbd86c4d1d90486fda5 Mon Sep 17 00:00:00 2001
From: Benjamin Bach 
Date: Sun, 24 Apr 2016 17:49:23 +0200
Subject: [PATCH 6/8] do not pollute stdout (dumpdata produces illegal output
 then)

---
 sqlcipher/management/commands/_mixins.py | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/sqlcipher/management/commands/_mixins.py b/sqlcipher/management/commands/_mixins.py
index a99f189..3d0333c 100644
--- a/sqlcipher/management/commands/_mixins.py
+++ b/sqlcipher/management/commands/_mixins.py
@@ -1,13 +1,16 @@
 # -*- coding: utf-8 -*-
 from __future__ import unicode_literals
 from __future__ import print_function
+
+import sys
+
 from django.conf import settings
 from getpass import getpass
 
 
 def ensure_pragma_key():
     if not hasattr(settings, 'PRAGMA_KEY') or not settings.PRAGMA_KEY:
-        print("There is no SQL Cipher key defined, it's unsafe to store in your settings. Please input your key")
+        sys.stderr.write("There is no SQL Cipher key defined, it's unsafe to store in your settings. Please input your key.\n\n")
         key = getpass("Key: ")
         settings.PRAGMA_KEY = key
 

From 74599fd5254733b9a2480b4742231b0dbb1323c9 Mon Sep 17 00:00:00 2001
From: Benjamin Bach 
Date: Sun, 24 Apr 2016 21:42:42 +0200
Subject: [PATCH 7/8] locate ensure_pragman_key more conveniently

---
 sqlcipher/management/commands/_mixins.py | 11 +----------
 sqlcipher/utils.py                       | 15 +++++++++++++++
 2 files changed, 16 insertions(+), 10 deletions(-)
 create mode 100644 sqlcipher/utils.py

diff --git a/sqlcipher/management/commands/_mixins.py b/sqlcipher/management/commands/_mixins.py
index 3d0333c..f0a60ab 100644
--- a/sqlcipher/management/commands/_mixins.py
+++ b/sqlcipher/management/commands/_mixins.py
@@ -2,17 +2,8 @@
 from __future__ import unicode_literals
 from __future__ import print_function
 
-import sys
 
-from django.conf import settings
-from getpass import getpass
-
-
-def ensure_pragma_key():
-    if not hasattr(settings, 'PRAGMA_KEY') or not settings.PRAGMA_KEY:
-        sys.stderr.write("There is no SQL Cipher key defined, it's unsafe to store in your settings. Please input your key.\n\n")
-        key = getpass("Key: ")
-        settings.PRAGMA_KEY = key
+from sqlcipher.utils import ensure_pragma_key
 
 
 class PromptForPragmaKeyMixin(object):
diff --git a/sqlcipher/utils.py b/sqlcipher/utils.py
new file mode 100644
index 0000000..a2aa74f
--- /dev/null
+++ b/sqlcipher/utils.py
@@ -0,0 +1,15 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+from __future__ import print_function
+
+import sys
+
+from django.conf import settings
+from getpass import getpass
+
+
+def ensure_pragma_key():
+    if not hasattr(settings, 'PRAGMA_KEY') or not settings.PRAGMA_KEY:
+        sys.stderr.write("There is no SQL Cipher key defined, it's unsafe to store in your settings. Please input your key.\n\n")
+        key = getpass("Key: ")
+        settings.PRAGMA_KEY = key

From c5e0b07b96767fdd2b8d26cd38b7f53204bc2fed Mon Sep 17 00:00:00 2001
From: Benjamin Bach 
Date: Sun, 24 Apr 2016 23:49:52 +0200
Subject: [PATCH 8/8] decode cli input

---
 sqlcipher/utils.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/sqlcipher/utils.py b/sqlcipher/utils.py
index a2aa74f..5883b33 100644
--- a/sqlcipher/utils.py
+++ b/sqlcipher/utils.py
@@ -12,4 +12,4 @@ def ensure_pragma_key():
     if not hasattr(settings, 'PRAGMA_KEY') or not settings.PRAGMA_KEY:
         sys.stderr.write("There is no SQL Cipher key defined, it's unsafe to store in your settings. Please input your key.\n\n")
         key = getpass("Key: ")
-        settings.PRAGMA_KEY = key
+        settings.PRAGMA_KEY = key.decode("utf-8")