Update documentation for wsssht refactoring

- Updated README.md project structure to reflect new libwsssht/ modular organization
- Updated DOCUMENTATION.md with new modular component descriptions
- Added CHANGELOG.md entry for version 1.6.1 with refactoring details
- Added TODO.md entry documenting the completed refactoring work

All documentation now reflects the new modular architecture with improved maintainability.
parent 698acaa3
...@@ -5,6 +5,25 @@ All notable changes to this project will be documented in this file. ...@@ -5,6 +5,25 @@ 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/), 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). and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [1.6.1] - 2025-09-18
### Changed
- **Major Code Refactoring**: Complete modularization of `wsssht.c` for improved maintainability
- Split monolithic 2769-line `wsssht.c` into modular components in `libwsssht/` directory
- Created `utils.h/c`: Utility functions (print_usage, parse_connection_string, parse_args)
- Created `modes.h/c`: Mode-specific functions (bridge, script, daemon modes)
- Created `threads.h/c`: Thread-related functions and structures
- Created `wsssht.h`: Main header with includes and declarations
- Reduced main `wsssht.c` to 674 lines (75% size reduction)
- Maintained 100% backward compatibility and functionality
### Technical Details
- **Modular Architecture**: Clean separation of concerns with focused, single-responsibility modules
- **Build System Updates**: Updated `configure.sh` and `Makefile` to handle new modular structure
- **Code Organization**: Improved developer experience with logical code grouping
- **Maintainability**: Easier debugging, testing, and feature development
- **Documentation**: Updated build system documentation for new structure
## [1.6.0] - 2025-09-18 ## [1.6.0] - 2025-09-18
### Added ### Added
......
...@@ -797,7 +797,7 @@ wsssh/ ...@@ -797,7 +797,7 @@ wsssh/
├── static/ # Web assets ├── static/ # Web assets
├── wssshtools/ # C implementation directory ├── wssshtools/ # C implementation directory
│ ├── wssshc.c # C client for registration │ ├── wssshc.c # C client for registration
│ ├── wsssh.c # C SSH wrapper │ ├── wsssh.c # C SSH wrapper (main function only)
│ ├── wsscp.c # C SCP wrapper │ ├── wsscp.c # C SCP wrapper
│ ├── wssshlib.h # Shared utilities library header │ ├── wssshlib.h # Shared utilities library header
│ ├── wssshlib.c # Shared utilities library implementation │ ├── wssshlib.c # Shared utilities library implementation
...@@ -807,8 +807,16 @@ wsssh/ ...@@ -807,8 +807,16 @@ wsssh/
│ ├── wssh_ssl.c # SSL functions library implementation │ ├── wssh_ssl.c # SSL functions library implementation
│ ├── tunnel.h # Tunnel management library header │ ├── tunnel.h # Tunnel management library header
│ ├── tunnel.c # Tunnel management library implementation │ ├── tunnel.c # Tunnel management library implementation
│ ├── configure.sh # Build configuration │ ├── libwsssht/ # Modular wsssht components (v1.6.1)
│ ├── Makefile # GNU Make build system │ │ ├── wsssht.h # Main wsssht header with declarations
│ │ ├── utils.h # Utility functions header
│ │ ├── utils.c # Utility implementations (print_usage, parse_args)
│ │ ├── modes.h # Operating mode functions header
│ │ ├── modes.c # Mode implementations (bridge, script, daemon)
│ │ ├── threads.h # Thread functions header
│ │ └── threads.c # Thread implementations and structures
│ ├── configure.sh # Build configuration (updated for modular structure)
│ ├── Makefile # GNU Make build system (updated for modular structure)
│ ├── common.c # Common utilities │ ├── common.c # Common utilities
│ └── debian/ # Debian packaging for wsssh-tools │ └── debian/ # Debian packaging for wsssh-tools
│ ├── control # Package metadata │ ├── control # Package metadata
......
...@@ -564,7 +564,7 @@ wsssh/ ...@@ -564,7 +564,7 @@ wsssh/
├── static/ # Static web assets ├── static/ # Static web assets
├── wssshtools/ # C implementation directory ├── wssshtools/ # C implementation directory
│ ├── wssshc.c # C client for registration │ ├── wssshc.c # C client for registration
│ ├── wsssh.c # C SSH wrapper │ ├── wsssh.c # C SSH wrapper (main function only)
│ ├── wsscp.c # C SCP wrapper │ ├── wsscp.c # C SCP wrapper
│ ├── wssshlib.h # Shared utilities library header │ ├── wssshlib.h # Shared utilities library header
│ ├── wssshlib.c # Shared utilities library implementation │ ├── wssshlib.c # Shared utilities library implementation
...@@ -574,9 +574,17 @@ wsssh/ ...@@ -574,9 +574,17 @@ wsssh/
│ ├── wssh_ssl.c # SSL functions library implementation │ ├── wssh_ssl.c # SSL functions library implementation
│ ├── tunnel.h # Tunnel management library header │ ├── tunnel.h # Tunnel management library header
│ ├── tunnel.c # Tunnel management library implementation │ ├── tunnel.c # Tunnel management library implementation
│ ├── libwsssht/ # Modular wsssht components (v1.6.1)
│ │ ├── wsssht.h # Main wsssht header with declarations
│ │ ├── utils.h # Utility functions header
│ │ ├── utils.c # Utility implementations (print_usage, parse_args)
│ │ ├── modes.h # Operating mode functions header
│ │ ├── modes.c # Mode implementations (bridge, script, daemon)
│ │ ├── threads.h # Thread functions header
│ │ └── threads.c # Thread implementations and structures
│ ├── common.c # Common utilities │ ├── common.c # Common utilities
│ ├── configure.sh # C build configuration │ ├── configure.sh # C build configuration (updated for modular structure)
│ ├── Makefile # C build system │ ├── Makefile # C build system (updated for modular structure)
│ └── debian/ # Debian packaging │ └── debian/ # Debian packaging
│ ├── control # Package metadata │ ├── control # Package metadata
│ ├── rules # Build rules │ ├── rules # Build rules
......
# WebSocket SSH - Future Enhancements Roadmap # WebSocket SSH - Future Enhancements Roadmap
## Recently Completed (v1.6.1)
- [x] **Major Code Refactoring**: Complete modularization of `wsssht.c` for improved maintainability
- Split monolithic 2769-line `wsssht.c` into modular components in `libwsssht/` directory
- Created `utils.h/c`: Utility functions (print_usage, parse_connection_string, parse_args)
- Created `modes.h/c`: Mode-specific functions (bridge, script, daemon modes)
- Created `threads.h/c`: Thread-related functions and structures
- Created `wsssht.h`: Main header with includes and declarations
- Reduced main `wsssht.c` to 674 lines (75% size reduction)
- Updated `configure.sh` and `Makefile` to handle new modular structure
- Maintained 100% backward compatibility and functionality
- Improved developer experience with logical code grouping
- Easier debugging, testing, and feature development
## Recently Completed (v1.6.0) ## Recently Completed (v1.6.0)
- [x] **Multiple Operating Modes**: Complete implementation of various operating modes for wsssht - [x] **Multiple Operating Modes**: Complete implementation of various operating modes for wsssht
- **Interactive Mode**: Standard interactive SSH/SCP sessions (default) - **Interactive Mode**: Standard interactive SSH/SCP sessions (default)
......
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