remove DSS key references; upgrade paramiko dependency to version 4.0

.circleci/config.yml

@@ -2,7 +2,7 @@ params: &params
   parameters:
     version:
       description: Python docker image version
-      default: 3.9.16
+      default: "3.12"
       type: string
 
 job_defaults: &job_defaults
@@ -116,7 +116,7 @@ jobs:
       - run:
           name: Build artifact
           command: |
-            pipenv run python setup.py bdist_egg bdist_wheel sdist
+            pipenv run python -m build
       - run:
           name: Check artifacts
           command: pipenv run twine check dist/*
@@ -141,7 +141,7 @@ jobs:
       - run:
           name: Build artifact
           command: |
-            pipenv run python setup.py bdist_egg bdist_wheel sdist
+            pipenv run python -m build
       - run:
           name: Upload to PyPI
           command: >-
@@ -163,12 +163,10 @@ workflows:
           matrix:
             parameters:
               version:
-                - "2.7"
-                - "3.4"
-                - "3.5"
-                - "3.6"
-                - "3.7"
-                - "3.8"
+                - "3.9"
+                - "3.10"
+                - "3.11"
+                - "3.12"
       - testdeploy:
           requires:
             - tests

.github/workflows/database.yml

@@ -13,7 +13,7 @@ jobs:
 
     strategy:
       matrix:
-        python: [ python3, python2 ]
+        python: [ python3.9, python3.10, python3.11, python3.12 ]
 
     steps:
       - uses: actions/checkout@v2
@@ -26,18 +26,21 @@ jobs:
           chmod 600 ./e2e_tests/ssh-server-config/ssh_host_rsa_key
           cd e2e_tests && docker-compose up -d
 
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python }}
+
       - name: Install dependencies
         run: |
           id
           uname -a
           lsb_release -a
-          ${{ matrix.python }} -V
-          curl https://bootstrap.pypa.io/pip/2.7/get-pip.py -o get-pip.py
-          ${{ matrix.python }} get-pip.py
-          ${{ matrix.python }} -m pip install --upgrade pip
-          ${{ matrix.python }} -m pip install .
-          ${{ matrix.python }} -m pip install psycopg2-binary>=2.9.6 pymysql>=1.0.3 pymongo>=4.3.3
-          ${{ matrix.python }} -m pip install --upgrade pyopenssl
+          python -V
+          python -m pip install --upgrade pip
+          python -m pip install .
+          python -m pip install psycopg2-binary>=2.9.6 pymysql>=1.0.3 pymongo>=4.3.3
+          python -m pip install --upgrade pyopenssl
 
           ssh -o "StrictHostKeyChecking=no" linuxserver@127.0.0.1 -p 2223 -i ./e2e_tests/ssh-server-config/ssh_host_rsa_key -vvvvv "uname -a"
 
@@ -46,10 +49,10 @@ jobs:
           # docker exec openssh-server tail -f /config/logs/openssh/current
 
       - name: Run db tests ${{ matrix.python }}
-        run: ${{ matrix.python }} e2e_tests/run_docker_e2e_db_tests.py
+        run: python e2e_tests/run_docker_e2e_db_tests.py
 
       - name: Run hungs tests ${{ matrix.python }}
-        run: timeout 10s ${{ matrix.python }} e2e_tests/run_docker_e2e_hangs_tests.py
+        run: timeout 10s python e2e_tests/run_docker_e2e_hangs_tests.py
 
       - name: Collect openssh-server logs from docker container
         if: failure()

README.rst

@@ -14,7 +14,18 @@ See also: https://github.com/paramiko/paramiko/blob/master/demos/forward.py
 Requirements
 -------------
 
-* `paramiko`_
+* Python 3.9 or later
+* `paramiko`_ 4.0 or later
+
+**Note**: Version 0.5.0+ requires Python 3.9+ and paramiko 4.0+. If you need Python 2.x or Python 3.4-3.8 support, please use version 0.4.0.
+
+**Breaking Changes in 0.5.0**:
+
+- **DSA keys are no longer supported**. DSA was deprecated in OpenSSH 7.0 (2016) and removed from paramiko 4.0 due to security concerns. If you're using DSA keys, you'll need to:
+
+  - Generate new RSA, ECDSA, or Ed25519 keys
+  - Update your SSH server configuration to use the new keys
+  - Example: ``ssh-keygen -t rsa -b 4096`` or ``ssh-keygen -t ed25519``
 
 Installation
 ============
@@ -226,7 +237,7 @@ CLI usage
                      ssh_address
 
     Pure python ssh tunnel utils
-    Version 0.4.0
+    Version 0.5.0
 
     positional arguments:
       ssh_address           SSH server IP address (GW for SSH tunnels)
@@ -247,17 +258,17 @@ CLI usage
                             Example: -R 10.10.10.10: 10.10.10.10:5900
       -L [IP:PORT ...], --local_bind_address [IP:PORT ...]
                             Local bind address sequence: ip_1:port_1 ip_2:port_2 ... ip_n:port_n
-                            Elements may also be valid UNIX socket domains:
+                            Elements may also be valid UNIX socket domains: 
                             /tmp/foo.sock /tmp/bar.sock ... /tmp/baz.sock
                             Equivalent to ssh -LPORT:xxxxxxxxx:xxxx, being the local IP address optional.
                             By default it will listen in all interfaces (0.0.0.0) and choose a random port.
                             Example: -L :40000
       -k SSH_HOST_KEY, --ssh_host_key SSH_HOST_KEY
                             Gateway's host key
       -K KEY_FILE, --private_key_file KEY_FILE
-                            RSA/DSS/ECDSA private key file
+                            RSA/ECDSA private key file
       -S KEY_PASSWORD, --private_key_password KEY_PASSWORD
-                            RSA/DSS/ECDSA private key password
+                            RSA/ECDSA private key password
       -t, --threaded        Allow concurrent connections to each tunnel
       -v, --verbose         Increase output verbosity (default: ERROR)
       -V, --version         Show version number and quit

appveyor.yml

@@ -3,44 +3,36 @@ platform: x64
 environment:
 
   matrix:
-    - PYTHON: "C:\\Python27"
-      PYTHON_VERSION: "2.7.x"
+    - PYTHON: "C:\\Python39"
+      PYTHON_VERSION: "3.9.x"
       PYTHON_ARCH: "32"
 
-    - PYTHON: "C:\\Python27-x64"
-      PYTHON_VERSION: "2.7.x"
+    - PYTHON: "C:\\Python39-x64"
+      PYTHON_VERSION: "3.9.x"
       PYTHON_ARCH: "64"
 
-    - PYTHON: "C:\\Python35"
-      PYTHON_VERSION: "3.5.x"
+    - PYTHON: "C:\\Python310"
+      PYTHON_VERSION: "3.10.x"
       PYTHON_ARCH: "32"
 
-    - PYTHON: "C:\\Python35-x64"
-      PYTHON_VERSION: "3.5.x"
+    - PYTHON: "C:\\Python310-x64"
+      PYTHON_VERSION: "3.10.x"
       PYTHON_ARCH: "64"
 
-    - PYTHON: "C:\\Python36"
-      PYTHON_VERSION: "3.6.x"
+    - PYTHON: "C:\\Python311"
+      PYTHON_VERSION: "3.11.x"
       PYTHON_ARCH: "32"
 
-    - PYTHON: "C:\\Python36-x64"
-      PYTHON_VERSION: "3.6.x"
+    - PYTHON: "C:\\Python311-x64"
+      PYTHON_VERSION: "3.11.x"
       PYTHON_ARCH: "64"
 
-    - PYTHON: "C:\\Python37"
-      PYTHON_VERSION: "3.7.x"
+    - PYTHON: "C:\\Python312"
+      PYTHON_VERSION: "3.12.x"
       PYTHON_ARCH: "32"
 
-    - PYTHON: "C:\\Python37-x64"
-      PYTHON_VERSION: "3.7.x"
-      PYTHON_ARCH: "64"
-
-    - PYTHON: "C:\\Python38"
-      PYTHON_VERSION: "3.8.x"
-      PYTHON_ARCH: "32"
-
-    - PYTHON: "C:\\Python38-x64"
-      PYTHON_VERSION: "3.8.x"
+    - PYTHON: "C:\\Python312-x64"
+      PYTHON_VERSION: "3.12.x"
       PYTHON_ARCH: "64"
 init:
   - "ECHO %PYTHON% %PYTHON_VERSION% %PYTHON_ARCH%"
@@ -51,7 +43,7 @@ install:
   - pip install paramiko
   - pip install mock pytest pytest-cov pytest-xdist
 
-build: off
+build: false
 
 test_script:
   - python setup.py install

changelog.rst

@@ -22,6 +22,15 @@ CONTRIBUTORS
 CHANGELOG
 =========
 
+- v.0.5.0 (BREAKING CHANGES)
+    + **Drop Python 2.x and Python 3.4-3.8 support** - Now requires Python 3.9+
+    + **Drop DSA key support** - Removed support for DSA/DSS keys (deprecated in OpenSSH 7.0, removed in paramiko 4.0)
+    + **Update to paramiko>=4.0** - Now requires paramiko 4.0 or later
+    + **Remove Python 2 compatibility code** - Simplified imports and removed legacy code paths
+    + **Modernize build system** - Use PEP 517 build (`python -m build`) instead of deprecated `setup.py` commands
+    + **Update documentation build** - Use built-in `sphinx.ext.napoleon` instead of deprecated `sphinxcontrib-napoleon`
+    + **Update CI/CD** - Test on Python 3.9, 3.10, 3.11, 3.12
+
 - v.0.X.Y (`V0idk`_, `Bruno Inec`_, `alex3d`_)
     + Remove the potential deadlock that is associated with threading.Lock (`#231`_)
     + Remove the hidden modification of the logger in cases where a custom logger is used. (`#250`_)

docs/conf.py

@@ -44,7 +44,7 @@ def _warn_node(self, msg, node):
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',
-    'sphinxcontrib.napoleon',
+    'sphinx.ext.napoleon',
 ]
 
 # Add any paths that contain templates here, relative to this directory.

docs/requirements.txt

@@ -1,3 +1 @@
-docutils
-sphinx
-sphinxcontrib-napoleon
+sphinx>=4.0

pyproject.toml

@@ -1,3 +1,3 @@
 [build-system]
-requires = ["setuptools", "wheel"]
-build-backend = "setuptools.build_meta:__legacy__"
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"

setup.cfg

@@ -1,8 +1,6 @@
 [bdist_wheel]
-# This flag says that the code is written to work on both Python 2 and Python
-# 3. If at all possible, it is good practice to do this. If you cannot, you
-# will need to generate wheels for each Python version that you support.
-universal=1
+# Python 3 only
+universal=0
 
 [check-manifest]
 ignore =

setup.py

@@ -69,16 +69,15 @@
 
         # Specify the Python versions you support here. In particular, ensure
         # that you indicate whether you support Python 2, Python 3 or both.
-        'Programming Language :: Python :: 2',
-        'Programming Language :: Python :: 2.7',
         'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.4',
-        'Programming Language :: Python :: 3.5',
-        'Programming Language :: Python :: 3.6',
-        'Programming Language :: Python :: 3.7',
-        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
+        'Programming Language :: Python :: 3.12',
     ],
 
+    python_requires='>=3.9',
+
     platforms=['unix', 'macos', 'windows'],
 
     # What does your project relate to?
@@ -97,7 +96,7 @@
     # requirements files see:
     # https://packaging.python.org/en/latest/requirements.html
     install_requires=[
-        'paramiko>=2.7.2',
+        'paramiko>=4.0',
     ],
 
     # List additional groups of dependencies here (e.g. development
@@ -113,8 +112,7 @@
             'tox>=1.8.1',
         ],
         'build_sphinx': [
-            'sphinx',
-            'sphinxcontrib-napoleon',
+            'sphinx>=4.0',
         ],
     },
 

sshtunnel.py

@@ -25,20 +25,14 @@
 from binascii import hexlify
 
 import paramiko
+import queue
+import socketserver
 
-if sys.version_info[0] < 3:  # pragma: no cover
-    import Queue as queue
-    import SocketServer as socketserver
-    string_types = basestring,  # noqa
-    input_ = raw_input  # noqa
-else:  # pragma: no cover
-    import queue
-    import socketserver
-    string_types = str
-    input_ = input
+string_types = str
+input_ = input
 
 
-__version__ = '0.4.0'
+__version__ = '0.5.0'
 __author__ = 'pahaz'
 
 
@@ -208,7 +202,7 @@ def create_logger(logger=None,
     if add_paramiko_handler:
         _check_paramiko_handlers(logger=logger)
 
-    if capture_warnings and sys.version_info >= (2, 7):
+    if capture_warnings:
         logging.captureWarnings(True)
         pywarnings = logging.getLogger('py.warnings')
         pywarnings.handlers.extend(logger.handlers)
@@ -1090,7 +1084,6 @@ def get_keys(logger=None, host_pkey_directories=None, allow_agent=False):
             host_pkey_directories = [DEFAULT_SSH_DIRECTORY]
 
         paramiko_key_types = {'rsa': paramiko.RSAKey,
-                              'dsa': paramiko.DSSKey,
                               'ecdsa': paramiko.ECDSAKey}
         if hasattr(paramiko, 'Ed25519Key'):
             # NOQA: new in paramiko>=2.2: http://docs.paramiko.org/en/stable/api/keys.html#module-paramiko.ed25519key
@@ -1286,7 +1279,7 @@ def read_private_key_file(pkey_file,
 
         Arguments:
             pkey_file (str):
-                File containing a private key (RSA, DSS or ECDSA)
+                File containing a private key (RSA or ECDSA)
         Keyword Arguments:
             pkey_password (Optional[str]):
                 Password to decrypt the private key
@@ -1295,7 +1288,7 @@ def read_private_key_file(pkey_file,
             paramiko.Pkey
         """
         ssh_pkey = None
-        key_types = (paramiko.RSAKey, paramiko.DSSKey, paramiko.ECDSAKey)
+        key_types = (paramiko.RSAKey, paramiko.ECDSAKey)
         if hasattr(paramiko, 'Ed25519Key'):
             # NOQA: new in paramiko>=2.2: http://docs.paramiko.org/en/stable/api/keys.html#module-paramiko.ed25519key
             key_types += (paramiko.Ed25519Key, )
@@ -1806,15 +1799,15 @@ def _parse_arguments(args=None):
         dest='ssh_private_key',
         metavar='KEY_FILE',
         type=str,
-        help='RSA/DSS/ECDSA private key file'
+        help='RSA/ECDSA private key file'
     )
 
     parser.add_argument(
         '-S', '--private_key_password',
         dest='ssh_private_key_password',
         metavar='KEY_PASSWORD',
         type=str,
-        help='RSA/DSS/ECDSA private key password'
+        help='RSA/ECDSA private key password'
     )
 
     parser.add_argument(

tests/requirements-syntax.txt

@@ -1,4 +1,5 @@
 bashtest
+build
 check-manifest
 docutils
 flake8