Skip to content

wsssh
wsssh
Commit c9aa989e authored by Stefy Lanza (nextime / spora )'s avatar Stefy Lanza (nextime / spora )
Browse files
Options

Update documentation for C implementation transition 

- README.md: Updated installation, architecture, and build instructions for C implementation
- CHANGELOG.md: Added v1.7.0 entry documenting major transition from Python to C
- DOCUMENTATION.md: Updated project structure, dependencies, and build instructions
- TODO.md: Added v1.7.0 completion status and updated roadmap

All documentation now reflects the new C-based architecture with SQLite database and embedded web interface.
parent 6f98ad7e
Hide whitespace changes
Inline Side-by-side
Showing with 213 additions and 52 deletions
CHANGELOG.md
View file @ c9aa989e
......@@ -5,6 +5,80 @@ All notable changes to this project 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).
## [1.7.0] - 2025-09-21
### Major Changes
- **Complete Architecture Transition**: Migrated from Python/PyInstaller to native C implementation
- Replaced Python wssshd with high-performance C daemon (`wssshd2/`)
- Eliminated Python runtime dependencies for server component
- Maintained full backward compatibility for client tools
- Improved performance and reduced resource usage
### Added
- **SQLite Database Integration**: Persistent user management with secure storage
- Automatic database creation and schema management
- User authentication with password hashing
- Admin user role management
- Security warnings for default credentials
- Database-backed session management
- **Embedded Web Interface**: Self-contained web server with no external dependencies
- HTML/CSS/JavaScript assets embedded in binary
- User management interface with add/edit/delete functionality
- Real-time terminal interface with fullscreen support
- Responsive Bootstrap-based design
- AJAX-powered dynamic content updates
- **Enhanced Security Features**:
- Automatic security warnings for default admin credentials
- Proper session management with configurable timeouts
- Input validation and bounds checking
- Secure password storage with hashing
- Admin role-based access control
- **Professional ASCII Art**: Startup banner with project branding
- **Comprehensive Debug Options**: Database, web, and general debug logging
- **Smart Directory Selection**: Automatic root vs user directory detection
### Changed
- **Build System**: Complete overhaul for C implementation
- Updated build.sh to compile C binaries
- Modified Debian packaging for C dependencies
- Added SQLite3 and SSL library dependencies
- Removed Python/PyInstaller build process
- **Package Architecture**: Updated wsssh-server package for C binary
- Changed from PyInstaller bundle to native C executable
- Updated dependencies to include libsqlite3-0 and libssl3
- Modified package description and metadata
- Updated man pages for C version options
- **Documentation**: Comprehensive updates for C implementation
- Updated README.md with new architecture details
- Modified installation instructions for C build process
- Updated project structure documentation
- Removed Python-specific references
### Removed
- **Python Server Implementation**: Complete removal of Python wssshd
- Deleted wssshd.py entry point
- Removed wsssd/ Python server directory
- Eliminated templates/ directory (now embedded)
- Cleaned up Python-specific build artifacts
### Technical Details
- **Performance Improvements**: Native C implementation with direct system calls
- **Memory Efficiency**: Reduced memory footprint compared to Python runtime
- **Startup Time**: Faster daemon initialization and connection handling
- **Security**: Enhanced with proper bounds checking and input validation
- **Maintainability**: Cleaner C codebase with modular architecture
### Migration Notes
- **Backward Compatibility**: All existing client functionality preserved
- **Configuration**: Existing config files remain compatible
- **API Compatibility**: WebSocket protocol unchanged for client connections
- **Database Migration**: Automatic creation of new SQLite database on first run
## [1.6.7] - 2025-09-21
### Fixed
......
DOCUMENTATION.md
View file @ c9aa989e
......@@ -15,15 +15,16 @@
## Overview
WSSSH is a universal tunneling system that provides secure access to remote machines through various transport protocols. The system consists of multiple components implemented in both Python and C, offering high performance and flexibility for different deployment scenarios.
WSSSH is a universal tunneling system that provides secure access to remote machines through various transport protocols. The system consists of multiple components implemented in C, offering high performance, minimal dependencies, and enterprise-grade reliability.
### Key Components
#### Server Component
- **wssshd**: Universal tunneling daemon (Python) with web interface
- **wssshd2**: High-performance C daemon with embedded SQLite database and web interface
- **WebSocket/Transport Support**: Multiple transport protocol implementations
- **Client Management**: Registration and authentication system
- **Client Management**: Registration and authentication system with persistent storage
- **Tunnel Routing**: Intelligent request routing to registered clients
- **Embedded Web UI**: Self-contained web interface with user management
#### C Implementation (Primary)
- **wssshc**: Lightweight C client for registration (OpenSSL-based)
......@@ -566,20 +567,23 @@ Enable debug output for detailed troubleshooting:
```
wsssh/
├── wssshd.py # Universal tunneling daemon
├── build.sh # Build script
├── build.sh # Build script for all components
├── clean.sh # Clean script
├── requirements.txt # Python dependencies
├── cert.pem # SSL certificate
├── key.pem # SSL private key
├── templates/ # Web interface templates
│ ├── base.html # Base template
│ ├── index.html # Dashboard
│ ├── login.html # Authentication
│ ├── terminal.html # HTML5 terminal
│ └── users.html # User management
├── wssshtools/ # C implementation
│ ├── wssshc.c # Client registration
├── wssshd2/ # C server implementation
│ ├── main.c # Server main entry point
│ ├── web.c # Embedded web interface with SQLite
│ ├── config.c # Configuration handling
│ ├── terminal.c # Terminal session management
│ ├── websocket.c # WebSocket protocol handling
│ ├── ssl.c # SSL/TLS encryption
│ ├── tunnel.c # Tunnel management
│ ├── assets.c # Embedded web assets
│ ├── html_pages/ # Embedded HTML templates
│ ├── configure.sh # Build configuration
│ ├── Makefile # Build system
│ └── assets.o # Compiled embedded assets
├── wssshtools/ # C client tools
│ ├── wssshc.c # Client registration tool
│ ├── wsssh.c # SSH wrapper
│ ├── wsscp.c # SCP wrapper
│ ├── wsssht.c # Tunnel setup tool
......@@ -594,46 +598,50 @@ wsssh/
│ │ └── wssshlib.h/c # Core library
│ ├── configure.sh # Build configuration
│ ├── Makefile # Build system
│ ├── man/ # Manual pages
│ └── debian/ # Debian packaging
├── wsssh-server/ # Server package
└── CHANGELOG.md # Version history
├── wsssh-server/ # Server Debian package
├── CHANGELOG.md # Version history
├── DOCUMENTATION.md # Technical documentation
├── TODO.md # Development tasks
├── README.md # Project overview
└── BRIDGE_MODE_TESTING.md # Testing documentation
```
### Dependencies
#### Server Dependencies (wssshd)
- **Python 3.7+**
- **websockets**: WebSocket client/server library
- **Flask**: Web framework for admin interface
- **Flask-Login**: User authentication
- **Flask-SQLAlchemy**: Database support
- **ssl**: SSL/TLS support (built-in)
#### Server Dependencies (wssshd2)
- **GCC**: GNU C Compiler (4.8+)
- **Make**: GNU Make build system
- **SQLite3**: Database library (libsqlite3-dev)
- **OpenSSL**: SSL/TLS library (libssl-dev)
- **pkg-config**: Build configuration tool
#### C Implementation
- **GCC**: GNU C Compiler
#### Client Tools Dependencies (wssshtools)
- **GCC**: GNU C Compiler (4.8+)
- **Make**: GNU Make build system
- **OpenSSL**: SSL/TLS library (libssl-dev)
- **pkg-config**: Build configuration tool
### Building from Source
#### Server Build
#### Server Build (C Implementation)
```bash
# Install Python dependencies
pip3 install -r requirements.txt
# Build server binary
# Build server binary with embedded web interface
./build.sh --server-only
# Or build everything
./build.sh
```
#### C Implementation
#### Client Tools Build
```bash
# Configure and build C tools
cd wssshtools
./configure.sh
make
# Install system-wide
# Install system-wide (optional)
sudo make install
```
......@@ -661,6 +669,39 @@ python3 -m pytest tests/integration/
## Recent Updates
### Version 1.7.0 - Major C Implementation Transition
- **Complete Architecture Migration**: Transitioned from Python/PyInstaller to native C implementation
- Replaced Python wssshd with high-performance C daemon (`wssshd2/`)
- Eliminated Python runtime dependencies for server component
- Maintained full backward compatibility for client tools
- Improved performance and reduced resource usage
- **SQLite Database Integration**: Persistent user management with secure storage
- Automatic database creation and schema management
- User authentication with password hashing
- Admin user role management
- Security warnings for default credentials
- Database-backed session management
- **Embedded Web Interface**: Self-contained web server with no external dependencies
- HTML/CSS/JavaScript assets embedded in binary
- User management interface with add/edit/delete functionality
- Real-time terminal interface with fullscreen support
- Responsive Bootstrap-based design
- AJAX-powered dynamic content updates
- **Enhanced Security Features**:
- Automatic security warnings for default admin credentials
- Proper session management with configurable timeouts
- Input validation and bounds checking
- Secure password storage with hashing
- Admin role-based access control
- **Professional ASCII Art**: Startup banner with project branding
- **Comprehensive Debug Options**: Database, web, and general debug logging
- **Smart Directory Selection**: Automatic root vs user directory detection
- **Updated Debian Packaging**: Modified for C binary with proper dependencies
### Version 1.6.5
- **Flexible Data Encoding Support**: New `--enc` option for wsssht with multiple encoding modes
- `--enc hex`: Hexadecimal encoding of binary data (default, backward compatible)
......
README.md
View file @ c9aa989e
......@@ -26,11 +26,14 @@
### Core Components
#### Server Component (`wssshd`)
- **C Implementation**: High-performance native C daemon with embedded web interface
- **SQLite Database**: Persistent user management with secure password storage
- **Universal Daemon**: Central server managing connections with multiple transport protocols
- **Client Registration**: Handles client authentication with password-based registration
- **Tunnel Routing**: Routes tunnel requests to appropriate registered clients
- **Web Management Interface**: Professional admin panel with user management and HTML5 terminal
- **Session Management**: Maintains persistent connections and handles reconnection logic
- **Security Features**: Automatic warnings for default credentials and secure session handling
#### Client Tools (`wssshtools/`)
......@@ -71,10 +74,7 @@
git clone https://git.nexlab.net/nexlab/wsssh.git
cd wsssh
# Install Python dependencies for the server
pip3 install -r requirements.txt
# Build all components
# Build all components (C implementation with embedded web interface)
./build.sh
```
......@@ -353,37 +353,49 @@ openssl x509 -in cert.pem -text -noout
### Building from Source
```bash
# Install dependencies
pip3 install -r requirements.txt
# Build all components
# Build all components (C implementation)
./build.sh
# Run tests
python3 -m pytest tests/
# Clean build artifacts
./clean.sh
```
### C Implementation Details
The server component (`wssshd2/`) is implemented in C for maximum performance and minimal dependencies:
- **SQLite Database**: Persistent user management
- **Embedded Web Interface**: No external web server required
- **Native SSL/TLS**: Direct OpenSSL integration
- **Cross-platform**: Linux, macOS, Windows support
### Project Structure
```
wsssh/
├── wssshd.py # Universal tunneling daemon
├── build.sh # Build script
├── build.sh # Build script for all components
├── clean.sh # Clean script
├── requirements.txt # Python dependencies
├── wssshtools/ # C implementation directory
├── wssshd2/ # C server implementation
│ ├── main.c # Server main entry point
│ ├── web.c # Embedded web interface with SQLite
│ ├── config.c # Configuration handling
│ ├── terminal.c # Terminal session management
│ ├── websocket.c # WebSocket protocol handling
│ ├── ssl.c # SSL/TLS encryption
│ ├── tunnel.c # Tunnel management
│ ├── assets.c # Embedded web assets
│ ├── html_pages/ # Embedded HTML templates
│ └── Makefile # Build configuration
├── wssshtools/ # C client tools
│ ├── wssshc.c # Client registration tool
│ ├── wsssh.c # SSH wrapper
│ ├── wsscp.c # SCP wrapper
│ ├── wsssht.c # Tunnel setup tool
│ ├── libwsssht/ # Shared libraries
│ ├── man/ # Manual pages
│ └── debian/ # Debian packaging
├── wsssh-server/ # Server Debian package
├── templates/ # Web interface templates
├── static/ # Web assets
└── CHANGELOG.md # Version history
├── CHANGELOG.md # Version history
├── DOCUMENTATION.md # Technical documentation
├── TODO.md # Development tasks
└── README.md # This file
```
## Support
......
TODO.md
View file @ c9aa989e
# WSSSH: Warp-Powered Stefy's Spatial Secure Hyperdrive - Future Enhancements Roadmap
## Recently Completed (v1.7.0) - Major C Implementation Transition
- [x] **Complete Architecture Migration**: Transitioned from Python/PyInstaller to native C implementation
- Replaced Python wssshd with high-performance C daemon (`wssshd2/`)
- Eliminated Python runtime dependencies for server component
- Maintained full backward compatibility for client tools
- Improved performance and reduced resource usage
- [x] **SQLite Database Integration**: Persistent user management with secure storage
- Automatic database creation and schema management
- User authentication with password hashing
- Admin user role management
- Security warnings for default credentials
- Database-backed session management
- [x] **Embedded Web Interface**: Self-contained web server with no external dependencies
- HTML/CSS/JavaScript assets embedded in binary
- User management interface with add/edit/delete functionality
- Real-time terminal interface with fullscreen support
- Responsive Bootstrap-based design
- AJAX-powered dynamic content updates
- [x] **Enhanced Security Features**:
- Automatic security warnings for default admin credentials
- Proper session management with configurable timeouts
- Input validation and bounds checking
- Secure password storage with hashing
- Admin role-based access control
- [x] **Professional ASCII Art**: Startup banner with project branding
- [x] **Comprehensive Debug Options**: Database, web, and general debug logging
- [x] **Smart Directory Selection**: Automatic root vs user directory detection
- [x] **Updated Debian Packaging**: Modified for C binary with proper dependencies
- [x] **Documentation Updates**: Comprehensive updates for C implementation
## Recently Completed (v1.6.5)
- [x] **Flexible Data Encoding Support**: New `--enc` option for wsssht with multiple encoding modes
- `--enc hex`: Hexadecimal encoding of binary data (default, backward compatible)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment