removing all python2 support and py2/3 compat clauses.

Author: nthmost

CHANGES.txt

@@ -8,3 +8,4 @@
 0.1.0.3, 4/27/2014 -- Documentation of SecureString. setup.py now installs all required dependencies.
 0.1.0.4, 5/9/2014 -- removed SecureString from code examples, added Installation notes.
 0.1.1.0, 5/9/2014 -- fixes Issue #1 (pri:Major) in bitbucket issue tracker (HT @cariaso on bitbucket.org)
+0.2.0, 7/7/2020 -- Python3 compat issues, deprecated python2. Thanks to community submissions for the help!

README.rst

@@ -30,7 +30,8 @@ Config styles currently supported::
     Json (see SecureJson) -- whole-data encryption only.
     serialized dictionaries (see SecureConfig) -- whole-data encryption only.
 
-Please let the maintainer (@nthmost) know if you want to see another type supported.
+If you'd like to see another type supported, please file a feature request on GitHub
+at https://github.com/nthmost/python-secureconfig
 
 Purpose
 -------
@@ -47,9 +48,9 @@ for ConfigParser that allows us to keep 99% of the way we interact with
 config files, and simply wraps the decryption step.
 
 Of course, once you have decryption handled, you start to want simplified 
-ways of encrypting as well.
+ways of encrypting as well.  That's why secureconfig supports writing new
+config files.
 
-That's why secureconfig (as of 0.0.3) supports writing new config files.
 See "basic usage" sections below to see how you can easily turn a plaintext
 value or file into an encrypted value or file (depending on config style).
 
@@ -65,9 +66,8 @@ run.  (Turn this off using paranoid=False, if you must.)
 Finally, secureconfig contains a smattering of deployment utilities found in 
 secureconfig.utils.  Feel free to suggest new ones.
 
-This library can be found at https://bitbucket.org/nthmost/python-secureconfig 
-
 Contributions and code/documentation critiques are warmly welcomed.
+See the Contribution section below for information.
 
 
 How secureconfig Works
@@ -137,17 +137,14 @@ The following requirements form the backbone of secureconfig::
    cryptography
    configparser
    cffi
-   six
    pycparser
 
-If you have any problems installing these requirements, please let the 
-maintainer of this package know at https://bitbucket.com/nthmost/python-secureconfig
+If you have any problems installing these requirements, please let us know as a
+github issue at https://github.com/nthmost/python-secureconfig
 
 SecureConfigParser
 ------------------
 
-NEW SINCE 0.1.0:
-
 SecureConfigParser is a subclass of the configparser module's ConfigParser class.
 
 The difference is that, when instantiated via one of the standardized cryptkeeper 
@@ -308,20 +305,20 @@ Given the above, SecureString cannot at this time be implicity trusted as
 "secure", since so much depends upon how it's used.
 
 
-Future
-------
+Contributions
+-------------
 
-Planned features include::
+The home for SecureConfig is on github:
+https://github.com/nthmost/secureconfig
 
-- more automated-deployment-oriented utils
-- asymmetric key deployments (e.g. RSA public key encryption)
+If you'd like to contribute, please make sure you run the tests (I normally use pytest)
+found in the tests/ directory.  I might merge fixes into master but I won't update pypi
+with a new version unless ALL the tests pass.
 
+If you want to contribute a novel feature, please file it as an issue in the github repo
+so we can discuss it first!
 
-CONTACT
--------
-
-Look for @nthmost on bitbucket if you're interested and would like to contribute!
 Comments, critiques, and bug reports warmly welcomed.  Pull requests encouraged.
 
---Naomi Most, spring 2014.
+--Naomi Most, 2014-2020 and onward.
 

TODO.txt

@@ -1,4 +1,3 @@
-six
 pyasn1
 pycrypto
 cryptography

requirements.txt

@@ -1,5 +1,4 @@
 from __future__ import absolute_import
-import six
 from ast import literal_eval
 
 from .cryptkeeper import CryptKeeper, EnvCryptKeeper, FileCryptKeeper, cryptkeeper_access_methods
@@ -79,16 +78,10 @@ def __init__(self, filepath='', rawtxt='', readonly=False, **kwargs):
             self.cfg = {}
 
     def _decrypt(self, buf):
-        if six.PY3:
-            return self.ck.crypter.decrypt(buf).decode()
-        else:
-            return self.ck.crypter.decrypt(buf)
+        return self.ck.crypter.decrypt(buf).decode()
 
     def _encrypt(self, buf):
-        if six.PY3:
-            return self.ck.crypter.encrypt(buf.encode()).decode()
-        else:
-            return self.ck.crypter.encrypt(buf)
+        return self.ck.crypter.encrypt(buf.encode()).decode()
 
     def _fill(self, txt=''):
         self.cfg = literal_eval(txt)

secureconfig/baseclass.py

@@ -1,7 +1,4 @@
-from __future__ import print_function, absolute_import
-
 import os
-import six
 
 from cryptography.fernet import Fernet, InvalidToken
 
@@ -150,12 +147,8 @@ def _key_exists(self):
 
     def store(self):
         """store currently active key into environment variable"""
-        if six.PY3:
-            os.environ[self.env] = self.key.decode()
-            os.putenv(self.env, self.key.decode())
-        else:
-            os.environ[self.env] = self.key
-            os.putenv(self.env, self.key)
+        os.environ[self.env] = self.key.decode()
+        os.putenv(self.env, self.key.decode())
 
     def load(self):
         """retrieve key from environment variable"""

secureconfig/cryptkeeper.py

@@ -1,20 +1,14 @@
-from __future__ import print_function, absolute_import
-
 import sys
-import six
 
 import cryptography
 
 from .baseclass import cryptkeeper_access_methods
 
-if six.PY3:
-    try:
-        # New style
-        from configparser import ConfigParser, NoSectionError, NoOptionError
-    except ImportError:
-        # Old style
-        from ConfigParser import ConfigParser, NoSectionError, NoOptionError
-else:
+try:
+    # New style
+    from configparser import ConfigParser, NoSectionError, NoOptionError
+except ImportError:
+    # Old style
     from ConfigParser import ConfigParser, NoSectionError, NoOptionError
 
 
@@ -72,18 +66,12 @@ def raw_set(self, sec, key, val):
 
     def raw_items(self, sec):
         """Return the items in a section without decrypting the values."""
-        if six.PY3:
-            return ConfigParser.items(self, sec, raw=True)
-        else:
-            return ConfigParser.items(self, sec)
+        return ConfigParser.items(self, sec, raw=True)
 
     def val_decrypt(self, raw_val, **kwargs):
         """Decrypt supplied value if it appears to be encrypted."""
         if self.ck and raw_val.startswith(self.ck.sigil):
-            if six.PY3:
-                return self.ck.crypter.decrypt(raw_val.split(self.ck.sigil)[1].encode()).decode()
-            else:
-                return self.ck.crypter.decrypt(raw_val.split(self.ck.sigil)[1])
+            return self.ck.crypter.decrypt(raw_val.split(self.ck.sigil)[1].encode()).decode()
         else:
             return raw_val
 
@@ -103,10 +91,7 @@ def set(self, sec, key, new_val, encrypt=False):
         """
         if not self.has_option(sec, key):
             if encrypt:
-                if six.PY3:
-                    new_val = self.ck.sigil + self.ck.encrypt(new_val.encode()).decode()
-                else:
-                    new_val = self.ck.sigil + self.ck.encrypt(new_val)
+                new_val = self.ck.sigil + self.ck.encrypt(new_val.encode()).decode()
             return self.raw_set(sec, key, new_val)
 
         old_raw_val = self.raw_get(sec, key)

secureconfig/secureconfigparser.py

@@ -1,5 +1,3 @@
-from __future__ import print_function, absolute_import
-import six
 from .zeromem import zeromem
 
 
@@ -8,10 +6,7 @@ class SecureString(str):
 
     def __init__(self, anystring):
         super().__init__()
-        if six.PY3:
-            self._string = bytes(anystring, 'utf-8')
-        else:
-            self._string = anystring
+        self._string = bytes(anystring, 'utf-8')
 
     def burn(self):
         zeromem(self._string)

secureconfig/securestring.py

@@ -71,7 +71,6 @@ def run(self):
     install_requires=[
         'cryptography',
         'configparser',
-        'six',
         'pycrypto',
         'pyasn1'
     ],

setup.py

@@ -0,0 +1,6 @@
+[database]
+username = some_user
+password = CK_FERNET::gAAAAABfBNjwZy9k7BM-Jw_sxniUluQqQEd24B1SdeMXkeIdn5pj2GBdeDkPtayWl9pTBp8AFmuqXMrJK9JBrwUJCbfsoZrCPA==
+hostname = some_hostname
+port = 3306
+

tests/cfg_test_out.ini

@@ -1,5 +1,3 @@
-from __future__ import print_function
-import six
 import unittest
 import cryptography
 
@@ -41,38 +39,26 @@ def setUp(self):
 
     def test_FileCK_creates_keyfile(self):
         assert(os.path.exists(TEST_KEYFILE_PATH))
-        if six.PY3:
-            with open(TEST_KEYFILE_PATH, 'r') as fh:
-                tmp = fh.read().strip().encode()
-                fh.close()
-            assert(self.file_ck.key == tmp)
-        else:
-            assert(self.file_ck.key == open(TEST_KEYFILE_PATH, 'r').read().strip())
+        with open(TEST_KEYFILE_PATH, 'r') as fh:
+            tmp = fh.read().strip().encode()
+            fh.close()
+        assert(self.file_ck.key == tmp)
 
     def test_EnvCK_creates_env(self):
         assert(os.environ.get(TEST_KEYENV_NAME, False))
-        if six.PY3:
-            assert(os.environ.get(TEST_KEYENV_NAME).encode() == self.env_ck.key)
-        else:
-            assert(os.environ.get(TEST_KEYENV_NAME) == self.env_ck.key)
+        assert(os.environ.get(TEST_KEYENV_NAME).encode() == self.env_ck.key)
 
     def test_EnvCK_from_env(self):
         os.putenv('ARBITRARY_ENV_NAME', TEST_KEYSTRING)
         env_ck = EnvCryptKeeper('ARBITRARY_ENV_NAME')
-        if six.PY3:
-            assert(env_ck.key == os.environ['ARBITRARY_ENV_NAME'].encode())
-        else:
-            assert(env_ck.key == os.environ['ARBITRARY_ENV_NAME'])
+        assert(env_ck.key == os.environ['ARBITRARY_ENV_NAME'].encode())
 
     def test_FileCK_from_file(self):
         file_ck = FileCryptKeeper(TEST_KEYFILE_PATH)
-        if six.PY3:
-            with open(TEST_KEYFILE_PATH, 'r') as fh:
-                tmp = fh.read().strip().encode()
-                fh.close()
-            assert(file_ck.key == tmp)
-        else:
-            assert(file_ck.key == open(TEST_KEYFILE_PATH, 'r').read().strip())
+        with open(TEST_KEYFILE_PATH, 'r') as fh:
+            tmp = fh.read().strip().encode()
+            fh.close()
+        assert(file_ck.key == tmp)
 
     def test_StringCK_key_eq_key(self):
         self.assertEqual(self.string_ck.key, TEST_KEYSTRING)

tests/test_cryptkeeper.py

@@ -1,17 +1,11 @@
-from __future__ import print_function
-
 import unittest
 import cryptography
-import six
-if six.PY3:
-    try:
-        # New style
-        from configparser import ConfigParser
-    except ImportError:
-        # Old style
-        from ConfigParser import ConfigParser, NoSectionError, NoOptionError
-else:
-    from ConfigParser import ConfigParser
+try:
+    # New style
+    from configparser import ConfigParser
+except ImportError:
+    # Old style
+    from ConfigParser import ConfigParser, NoSectionError, NoOptionError
 
 
 from cryptography.fernet import InvalidToken