spindlex 0.1.0__tar.gz

spindlex-0.1.0/CHANGELOG.md

@@ -0,0 +1,60 @@
+# Changelog
+
+All notable changes to SpindleX will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- Comprehensive API documentation with Sphinx
+- Advanced usage examples and tutorials
+- Performance optimization guide
+- Security best practices documentation
+- Async SSH client implementation
+- Custom protocol subsystem support
+- High-performance file transfer optimizations
+- Connection pooling and management
+- Built-in performance monitoring
+- Extensive logging and debugging capabilities
+
+### Changed
+- Improved error handling and exception hierarchy
+- Enhanced SFTP client with advanced features
+- Optimized cryptographic operations
+- Better memory management for large transfers
+
+### Fixed
+- Various bug fixes and stability improvements
+- Memory leaks in long-running connections
+- Race conditions in concurrent operations
+
+### Security
+- Enhanced host key verification
+- Improved authentication security
+- Secure random number generation
+- Constant-time cryptographic comparisons
+
+## [0.1.0] - 2024-01-15
+
+### Added
+- Initial release of SpindleX
+- Complete SSHv2 protocol implementation
+- SSH client with all major authentication methods
+- SFTP client for secure file transfers
+- SSH server implementation
+- SFTP server implementation
+- Modern cryptographic algorithms (Ed25519, ChaCha20-Poly1305)
+- Comprehensive test suite
+- Documentation and examples
+
+### Features
+- **SSH Client**: Password, public key, keyboard-interactive, GSSAPI authentication
+- **SFTP Client**: File upload/download, directory operations, attribute management
+- **SSH Server**: Custom server implementation with authentication hooks
+- **SFTP Server**: File system operations with access control
+- **Port Forwarding**: Local and remote port forwarding
+- **Cryptography**: Ed25519, ECDSA, RSA keys; ChaCha20-Poly1305, AES-GCM ciphers
+- **Security**: Host key verification, secure defaults, audit logging
+- **Performance**: Optimized for high throughput and low latency

spindlex-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 SpindleX Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

spindlex-0.1.0/MANIFEST.in

@@ -0,0 +1,31 @@
+# Include the README and license files
+include README.md
+include LICENSE
+include CHANGELOG.md
+
+# Include the typed marker
+include ssh_library/py.typed
+
+# Include version file
+include ssh_library/_version.py
+
+# Include all Python files
+recursive-include ssh_library *.py
+
+# Exclude test files from distribution
+recursive-exclude tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+# Exclude development files
+exclude .gitignore
+exclude .pre-commit-config.yaml
+exclude pyproject.toml.bak
+exclude tox.ini
+exclude .coverage
+exclude .pytest_cache
+
+# Exclude build artifacts
+global-exclude *.so
+global-exclude *.dylib
+global-exclude *.dll

spindlex-0.1.0/PKG-INFO

@@ -0,0 +1,160 @@
+Metadata-Version: 2.4
+Name: spindlex
+Version: 0.1.0
+Summary: A pure-Python SSHv2 client/server library
+Home-page: https://github.com/spindle-dev/spindle
+Author: Spindle Team
+Author-email: SpindleX Team <team@spindlex.org>
+Maintainer-email: SpindleX Team <team@spindlex.org>
+License: MIT
+Project-URL: Homepage, https://gitlab.com/daveops.world/development/python/spindlex
+Project-URL: Documentation, https://spindlex.readthedocs.io/
+Project-URL: Repository, https://gitlab.com/daveops.world/development/python/spindlex.git
+Project-URL: Issues, https://gitlab.com/daveops.world/development/python/spindlex/-/issues
+Project-URL: Changelog, https://gitlab.com/daveops.world/development/python/spindlex/-/blob/main/CHANGELOG.md
+Keywords: ssh,sftp,client,server,cryptography,security
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet
+Classifier: Topic :: Security :: Cryptography
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cryptography>=3.0
+Requires-Dist: typing-extensions>=4.0; python_version < "3.10"
+Provides-Extra: async
+Requires-Dist: asyncio-dgram>=2.0; extra == "async"
+Provides-Extra: gssapi
+Requires-Dist: gssapi>=1.6.0; sys_platform != "win32" and extra == "gssapi"
+Provides-Extra: dev
+Requires-Dist: black>=22.0; extra == "dev"
+Requires-Dist: isort>=5.0; extra == "dev"
+Requires-Dist: flake8>=4.0; extra == "dev"
+Requires-Dist: mypy>=0.900; extra == "dev"
+Requires-Dist: pre-commit>=2.15; extra == "dev"
+Requires-Dist: pytest>=6.0; extra == "dev"
+Requires-Dist: pytest-cov>=3.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.18; extra == "dev"
+Requires-Dist: pytest-xdist>=2.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx>=5.0; extra == "docs"
+Requires-Dist: sphinx-rtd-theme>=1.0; extra == "docs"
+Requires-Dist: myst-parser>=0.18; extra == "docs"
+Requires-Dist: sphinx-autobuild>=2021.3.14; extra == "docs"
+Requires-Dist: sphinxcontrib-spelling>=7.6; extra == "docs"
+Provides-Extra: test
+Requires-Dist: pytest>=6.0; extra == "test"
+Requires-Dist: pytest-cov>=3.0; extra == "test"
+Requires-Dist: pytest-asyncio>=0.18; extra == "test"
+Requires-Dist: pytest-xdist>=2.0; extra == "test"
+Requires-Dist: coverage>=6.0; extra == "test"
+Dynamic: license-file
+
+# SpindleX
+
+A pure-Python SSHv2 client/server library that provides secure, high-performance SSH and SFTP operations without GPL/LGPL dependencies.
+
+## Features
+
+- **Pure Python**: No C extensions or system dependencies
+- **Modern Security**: Ed25519, ECDSA, ChaCha20-Poly1305, and other modern algorithms
+- **Full SSH Support**: Client and server implementations with all major features
+- **SFTP Support**: Complete SFTP client and server functionality
+- **Async Support**: Optional asyncio support for high-performance applications
+- **Comprehensive**: Port forwarding, authentication methods, host key policies
+- **Well-Tested**: Extensive test suite with high code coverage
+- **Type Hints**: Fully typed codebase for better development experience
+
+## Quick Start
+
+### Installation
+
+```bash
+pip install spindlex
+```
+
+### Basic Usage
+
+```python
+from spindlex import SSHClient
+
+# Create client and connect
+client = SSHClient()
+client.connect('example.com', username='user', password='password')
+
+# Execute a command
+stdin, stdout, stderr = client.exec_command('ls -la')
+print(stdout.read().decode())
+
+# Use SFTP
+sftp = client.open_sftp()
+sftp.get('/remote/file.txt', '/local/file.txt')
+sftp.close()
+
+# Clean up
+client.close()
+```
+
+### Key-based Authentication
+
+```python
+from spindlex import SSHClient
+from spindlex.crypto.pkey import Ed25519Key
+
+# Load private key
+private_key = Ed25519Key.from_private_key_file('/path/to/private_key')
+
+client = SSHClient()
+client.connect(
+    hostname='example.com',
+    username='user',
+    pkey=private_key
+)
+```
+
+## Documentation
+
+- [Quick Start Guide](https://spindlex.readthedocs.io/en/latest/quickstart.html)
+- [User Guide](https://spindlex.readthedocs.io/en/latest/user_guide/)
+- [API Reference](https://spindlex.readthedocs.io/en/latest/api_reference/)
+- [Examples](https://spindlex.readthedocs.io/en/latest/examples/)
+- [Security Guide](https://spindlex.readthedocs.io/en/latest/security.html)
+
+## Requirements
+
+- Python 3.8+
+- cryptography >= 3.0
+
+## Optional Dependencies
+
+- `asyncio` support: `pip install spindlex[async]`
+- Development tools: `pip install spindlex[dev]`
+- GSSAPI authentication: `pip install spindlex[gssapi]` (Unix only)
+
+## Contributing
+
+We welcome contributions! Please see our [Contributing Guide](https://spindlex.readthedocs.io/en/latest/contributing.html) for details.
+
+## Security
+
+For security issues, please email security@spindlex.org instead of creating a public issue.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Acknowledgments
+
+- Built with modern Python cryptography
+- Inspired by the need for a pure-Python SSH library
+- Thanks to all contributors and the Python community

spindlex-0.1.0/README.md

@@ -0,0 +1,98 @@
+# SpindleX
+
+A pure-Python SSHv2 client/server library that provides secure, high-performance SSH and SFTP operations without GPL/LGPL dependencies.
+
+## Features
+
+- **Pure Python**: No C extensions or system dependencies
+- **Modern Security**: Ed25519, ECDSA, ChaCha20-Poly1305, and other modern algorithms
+- **Full SSH Support**: Client and server implementations with all major features
+- **SFTP Support**: Complete SFTP client and server functionality
+- **Async Support**: Optional asyncio support for high-performance applications
+- **Comprehensive**: Port forwarding, authentication methods, host key policies
+- **Well-Tested**: Extensive test suite with high code coverage
+- **Type Hints**: Fully typed codebase for better development experience
+
+## Quick Start
+
+### Installation
+
+```bash
+pip install spindlex
+```
+
+### Basic Usage
+
+```python
+from spindlex import SSHClient
+
+# Create client and connect
+client = SSHClient()
+client.connect('example.com', username='user', password='password')
+
+# Execute a command
+stdin, stdout, stderr = client.exec_command('ls -la')
+print(stdout.read().decode())
+
+# Use SFTP
+sftp = client.open_sftp()
+sftp.get('/remote/file.txt', '/local/file.txt')
+sftp.close()
+
+# Clean up
+client.close()
+```
+
+### Key-based Authentication
+
+```python
+from spindlex import SSHClient
+from spindlex.crypto.pkey import Ed25519Key
+
+# Load private key
+private_key = Ed25519Key.from_private_key_file('/path/to/private_key')
+
+client = SSHClient()
+client.connect(
+    hostname='example.com',
+    username='user',
+    pkey=private_key
+)
+```
+
+## Documentation
+
+- [Quick Start Guide](https://spindlex.readthedocs.io/en/latest/quickstart.html)
+- [User Guide](https://spindlex.readthedocs.io/en/latest/user_guide/)
+- [API Reference](https://spindlex.readthedocs.io/en/latest/api_reference/)
+- [Examples](https://spindlex.readthedocs.io/en/latest/examples/)
+- [Security Guide](https://spindlex.readthedocs.io/en/latest/security.html)
+
+## Requirements
+
+- Python 3.8+
+- cryptography >= 3.0
+
+## Optional Dependencies
+
+- `asyncio` support: `pip install spindlex[async]`
+- Development tools: `pip install spindlex[dev]`
+- GSSAPI authentication: `pip install spindlex[gssapi]` (Unix only)
+
+## Contributing
+
+We welcome contributions! Please see our [Contributing Guide](https://spindlex.readthedocs.io/en/latest/contributing.html) for details.
+
+## Security
+
+For security issues, please email security@spindlex.org instead of creating a public issue.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Acknowledgments
+
+- Built with modern Python cryptography
+- Inspired by the need for a pure-Python SSH library
+- Thanks to all contributors and the Python community

spindlex-0.1.0/pyproject.toml

@@ -0,0 +1,169 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "spindlex"
+version = "0.1.0"
+description = "A pure-Python SSHv2 client/server library"
+readme = "README.md"
+license = {text = "MIT"}
+authors = [
+    {name = "SpindleX Team", email = "team@spindlex.org"}
+]
+maintainers = [
+    {name = "SpindleX Team", email = "team@spindlex.org"}
+]
+keywords = ["ssh", "sftp", "client", "server", "cryptography", "security"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "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",
+    "Topic :: Internet",
+    "Topic :: Security :: Cryptography",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: System :: Networking",
+]
+requires-python = ">=3.8"
+dependencies = [
+    "cryptography>=3.0",
+    "typing-extensions>=4.0; python_version<'3.10'",
+]
+
+[project.optional-dependencies]
+async = [
+    "asyncio-dgram>=2.0",
+]
+gssapi = [
+    "gssapi>=1.6.0; sys_platform!='win32'",
+]
+dev = [
+    "black>=22.0",
+    "isort>=5.0",
+    "flake8>=4.0",
+    "mypy>=0.900",
+    "pre-commit>=2.15",
+    "pytest>=6.0",
+    "pytest-cov>=3.0",
+    "pytest-asyncio>=0.18",
+    "pytest-xdist>=2.0",
+]
+docs = [
+    "sphinx>=5.0",
+    "sphinx-rtd-theme>=1.0",
+    "myst-parser>=0.18",
+    "sphinx-autobuild>=2021.3.14",
+    "sphinxcontrib-spelling>=7.6",
+]
+test = [
+    "pytest>=6.0",
+    "pytest-cov>=3.0",
+    "pytest-asyncio>=0.18",
+    "pytest-xdist>=2.0",
+    "coverage>=6.0",
+]
+
+[project.urls]
+Homepage = "https://gitlab.com/daveops.world/development/python/spindlex"
+Documentation = "https://spindlex.readthedocs.io/"
+Repository = "https://gitlab.com/daveops.world/development/python/spindlex.git"
+Issues = "https://gitlab.com/daveops.world/development/python/spindlex/-/issues"
+Changelog = "https://gitlab.com/daveops.world/development/python/spindlex/-/blob/main/CHANGELOG.md"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["spindlex*"]
+exclude = ["tests*", "docs*"]
+
+[tool.setuptools.package-data]
+spindlex = ["py.typed"]
+
+[tool.black]
+line-length = 88
+target-version = ['py38']
+include = '\.pyi?$'
+extend-exclude = '''
+/(
+  # directories
+  \.eggs
+  | \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | build
+  | dist
+)/
+'''
+
+[tool.isort]
+profile = "black"
+multi_line_output = 3
+line_length = 88
+known_first_party = ["spindlex"]
+
+[tool.mypy]
+python_version = "3.8"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+disallow_incomplete_defs = true
+check_untyped_defs = true
+disallow_untyped_decorators = true
+no_implicit_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_no_return = true
+warn_unreachable = true
+strict_equality = true
+
+[[tool.mypy.overrides]]
+module = "tests.*"
+disallow_untyped_defs = false
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]
+addopts = [
+    "--strict-markers",
+    "--strict-config",
+    "--tb=short",
+]
+markers = [
+    "unit: Unit tests",
+    "integration: Integration tests requiring external services",
+    "performance: Performance and benchmark tests",
+    "security: Security-focused tests",
+    "slow: Tests that take a long time to run",
+]
+
+[tool.coverage.run]
+source = ["spindlex"]
+omit = [
+    "*/tests/*",
+    "*/test_*",
+    "setup.py",
+]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "if self.debug:",
+    "if settings.DEBUG",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if 0:",
+    "if __name__ == .__main__.:",
+    "class .*\\bProtocol\\):",
+    "@(abc\\.)?abstractmethod",
+]

spindlex-0.1.0/setup.cfg

@@ -0,0 +1,98 @@
+[metadata]
+name = spindle
+description = Spindle - A pure-Python SSHv2 client/server library with modern security
+long_description = file: README.md
+long_description_content_type = text/markdown
+url = https://github.com/spindle-dev/spindle
+author = Spindle Team
+author_email = team@spindle.dev
+license = Apache-2.0
+license_files = LICENSE
+classifiers = 
+	Development Status :: 4 - Beta
+	Intended Audience :: Developers
+	Intended Audience :: System Administrators
+	License :: OSI Approved :: Apache Software License
+	Operating System :: OS Independent
+	Programming Language :: Python :: 3
+	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
+	Programming Language :: Python :: 3 :: Only
+	Topic :: Internet
+	Topic :: Security :: Cryptography
+	Topic :: Software Development :: Libraries :: Python Modules
+	Topic :: System :: Networking
+	Typing :: Typed
+
+[options]
+packages = find:
+python_requires = >=3.8
+install_requires = 
+	cryptography>=41.0.0
+	typing-extensions>=4.0.0; python_version<"3.10"
+
+[options.packages.find]
+include = ssh_library*
+
+[options.extras_require]
+dev = 
+	pytest>=7.0.0
+	pytest-cov>=4.0.0
+	pytest-asyncio>=0.21.0
+	black>=23.0.0
+	isort>=5.12.0
+	mypy>=1.0.0
+	flake8>=6.0.0
+	pre-commit>=3.0.0
+docs = 
+	sphinx>=6.0.0
+	sphinx-rtd-theme>=1.2.0
+	myst-parser>=1.0.0
+gssapi = 
+	gssapi>=1.8.0; sys_platform!="win32"
+async = 
+	asyncio-dgram>=2.1.0
+
+[options.entry_points]
+console_scripts = 
+	spindle-keygen = ssh_library.tools.keygen:main
+	spindle-benchmark = ssh_library.tools.benchmark:main
+
+[flake8]
+max-line-length = 88
+extend-ignore = E203, W503
+exclude = 
+	.git,
+	__pycache__,
+	build,
+	dist,
+	.eggs,
+	*.egg-info,
+	.venv,
+	.tox
+
+[mypy]
+python_version = 3.8
+warn_return_any = True
+warn_unused_configs = True
+disallow_untyped_defs = True
+disallow_incomplete_defs = True
+check_untyped_defs = True
+disallow_untyped_decorators = True
+no_implicit_optional = True
+warn_redundant_casts = True
+warn_unused_ignores = True
+warn_no_return = True
+warn_unreachable = True
+strict_equality = True
+
+[mypy-tests.*]
+disallow_untyped_defs = False
+
+[egg_info]
+tag_build = 
+tag_date = 0
+