Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
161 changes: 161 additions & 0 deletions FEATURES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
# SSH Installation & Key Management Tools - Features

## Overview
This repository now includes comprehensive SSH installation and key management automation scripts for Windows, Linux, and macOS platforms.

## What's Been Added

### 1. Windows Installation Script (ssh-install.bat)
A powerful batch file with PowerShell integration that provides:

#### Features:
- **Auto-elevation**: Automatically requests administrator privileges
- **OpenSSH Installation**: Detects and installs OpenSSH if not present
- **Interactive Key Generation**:
- Prompts for email and optional comment
- Choose number of keys (1-10)
- Select key type and bit length for each key
- **Supported Key Types**:
- RSA: 2048, 4096, 8192 bits
- Ed25519: Modern elliptic curve
- ECDSA: 256, 384, 521 bits
- **Key Backup**:
- Optional backup to user-selected location
- Visual folder browser for selection
- Automatic copying of both private and public keys
- **GPG/PGP Support**:
- Optional GPG key generation (4096-bit RSA)
- Automatic backup of GPG keys
- Batch generation for automation
- **User Experience**:
- Clear, formatted output
- Helpful usage instructions after generation
- Option to open SSH directory in Explorer

### 2. Linux/macOS Installation Script (ssh-install.sh)
An equivalent bash script with enhanced features:

#### Features:
- **Color-coded Output**: Visual feedback with colored messages
- **Cross-platform**: Works on Linux and macOS
- **Interactive Key Generation**: Same options as Windows script
- **Supported Key Types**: Identical to Windows version
- **Key Backup**: File path selection with tab completion
- **GPG/PGP Support**: Same functionality as Windows
- **Proper Permissions**: Automatically sets correct Unix permissions
- **User Experience**:
- Success/error indicators with symbols
- Helpful usage instructions
- Option to open SSH directory

### 3. Static HTML Webpage (index.html)
Professional webpage with:

#### Features:
- **Responsive Design**: Works on desktop and mobile
- **Ionity Branding**: Comprehensive branding throughout
- **License Information**:
- Full CC-BY-NC-SA-4.0 license text
- License badge
- Attribution requirements
- **Download Links**: Direct downloads for both scripts
- **Documentation**:
- Feature overview
- Installation instructions
- Usage examples
- Troubleshooting guide
- **Metadata**:
- SEO optimized
- Open Graph tags
- Twitter Card support
- CC license metadata

### 4. Installer Package Structure

#### installer/README.md
Comprehensive installation guide covering:
- What's included
- Installation instructions for all platforms
- Usage after installation
- Best practices
- File locations
- Troubleshooting
- Requirements
- License information

#### installer/config/
Configuration files and templates:
- `installer.conf`: Default settings and preferences
- `README.md`: Configuration documentation

#### installer/templates/
SSH configuration templates:
- `ssh_config_template`: Client SSH config with examples
- `authorized_keys_template`: Server-side public key setup
- `known_hosts_example`: Host fingerprint examples
- `README.md`: Template usage guide

### 5. Updated Main README
Enhanced documentation including:
- Quick start section for SSH tools
- Feature highlights
- Links to detailed documentation
- License information for new tools
- Credits section

## Technical Highlights

### Security Features
- ✅ **No hardcoded passwords**: All keys generated without passwords for automation
- ✅ **Proper permissions**: Unix permissions set correctly (700 for .ssh, 600 for keys)
- ✅ **Security warnings**: Explicit warnings when backing up private keys
- ✅ **No insecure practices**: Uses OpenSSH and GPG best practices

### Automation Features
- ✅ **Zero-touch installation**: Scripts handle all setup
- ✅ **Batch generation**: Create multiple keys in one session
- ✅ **Auto-elevation**: Windows script handles admin rights automatically
- ✅ **Dependency checking**: Scripts verify required tools are installed

### User Experience
- ✅ **Interactive prompts**: Clear, guided setup process
- ✅ **Visual feedback**: Colors, symbols, and clear messages
- ✅ **File browser integration**: Visual selection for backup locations
- ✅ **Help text**: Instructions displayed after generation
- ✅ **Error handling**: Clear error messages and troubleshooting hints

## How to Use

### Windows
1. Download `ssh-install.bat`
2. Double-click or run from command prompt
3. Follow interactive prompts
4. Keys saved to `%USERPROFILE%\.ssh`

### Linux/macOS
1. Download `ssh-install.sh`
2. Make executable: `chmod +x ssh-install.sh`
3. Run: `./ssh-install.sh`
4. Follow interactive prompts
5. Keys saved to `~/.ssh`

## Files Created

Total files added: 11
- 2 installation scripts
- 1 HTML webpage
- 1 main installer README
- 2 config files (+ 1 README)
- 4 template files (+ 1 README)
- 1 features document (this file)

## License

All SSH Installation & Key Management Tools are licensed under:
**CC-BY-NC-SA-4.0** (Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International)

Copyright © 2025 Ionity - All Rights Reserved

## Credits

Developed by Ionity as part of the Antwerp Designs Ionity organization.
52 changes: 52 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,38 @@

CLI tool that decrypts and decodes session replay files captured by Cloudflare's Audit SSH proxy.

## 🔐 SSH Installation & Key Management Tools

**NEW!** This repository now includes comprehensive automated SSH and GPG/PGP key generation and management tools.

### Quick Start - SSH Key Generation

#### Windows
```batch
# Download and run ssh-install.bat
# It will auto-elevate to administrator and guide you through key generation
ssh-install.bat
```

#### Linux/macOS
```bash
# Download and run ssh-install.sh
chmod +x ssh-install.sh
./ssh-install.sh
```

### Features
- 🔧 **Auto-elevation** to administrator/root when needed
- 🔑 **Multiple key types**: RSA (2048/4096/8192), Ed25519, ECDSA (256/384/521)
- 💾 **Automatic backup** with file browser integration
- 🔐 **GPG/PGP support** for email encryption and code signing
- 📝 **Interactive setup** with guided prompts
- 🌍 **Cross-platform** support (Windows, Linux, macOS)

For detailed documentation, see the [installer README](installer/README.md) or visit [index.html](index.html) for the web interface.

---

## Installation

### Build from source
Expand Down Expand Up @@ -50,3 +82,23 @@ You can then extract it and either open term_data.txt and analyse it on your own
### Non-PTY Sessions
If the encrypted file has a valid non-PTY session capture, then the output ZIP will contain 2 files:
`data_from_client.txt` and `data_from_server.txt`. These contain upstream and downstream traffic, respectively.

---

## License

The SSH Installation & Key Management Tools are licensed under **CC-BY-NC-SA-4.0** (Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International).

Copyright © 2025 **Ionity** - All Rights Reserved

The core SSH Log CLI tool retains its original license.

## Contributing

Contributions are welcome! Please feel free to submit issues or pull requests.

## Credits

- SSH Installation Tools developed by **Ionity**
- Part of the **Antwerp Designs Ionity** organization
- Original SSH Log CLI by Cloudflare
Loading