TerminalTelemetry 0.9.3

Terminal Telemetry - A PyQt6 Terminal Emulator with Device Telemetry

TerminalTelemetry

A modern, cyberpunk-inspired terminal emulator with integrated network device monitoring capabilities. This application combines terminal functionality with real-time network telemetry in a highly customizable interface.

Installation

From PyPI

pip install TerminalTelemetry

From GitHub

git clone https://github.com/scottpeterman/termtel.git
cd termtel
pip install -r requirements.txt

to launch

python -m termtel.termtel
# or
termtel

Features

• Modern Terminal Emulator

  • Multi-session support with tabbed interface
  • Customizable themes (Cyberpunk, Dark Mode, Light Mode, Retro Green, Retro Amber, Neon Blue)
  • Session management and quick connect functionality
  • Secure credential storage

• Network Device Telemetry

  • Real-time interface utilization monitoring with graphs
  • Automatic device type detection
  • LLDP/CDP neighbor discovery
  • ARP table visualization
  • Routing table analysis with prefix lookup
  • Support for multiple network operating systems (Cisco IOS, Arista EOS, Cisco NXOS)

• Security Features

  • PBKDF2-HMAC-SHA256 key derivation (480,000 iterations)
  • Fernet (AES-128-CBC) encryption with HMAC authentication
  • Platform-specific secure storage locations
  • Machine-specific binding
  • Rate-limited authentication
  • Cross-platform secure credential management
  • Zero plaintext storage of sensitive data

flowchart TB
    subgraph FileSystem ["File System Structure"]
        direction TB
        ConfigDir["Config Directory\n(.config/Termtel)"] --> SaltFile[".salt file\n(16 bytes random salt)"]
        ConfigDir --> CredsFile["credentials.yaml"]
        ConfigDir --> KeyringFile["System Keyring\n(machine_id)"]

        subgraph CredsYAML ["credentials.yaml structure"]
            direction TB
            Root["Root"] --> LastMod["last_modified: ISO timestamp"]
            Root --> CredsList["credentials: []"]
            CredsList --> Cred1["Credential 1\n- host\n- port\n- username\n- encrypted_password\n- display_name\n- uuid"]
            CredsList --> Cred2["Credential 2\n..."]
        end
    end

    subgraph Encryption ["Encryption Process"]
        direction TB
        SaveCred["Save Credentials"] --> CheckLock{"Is Unlocked?"}
        CheckLock -->|No| Error["Raise Error"]
        CheckLock -->|Yes| Process["Process Each Credential"]
        Process --> CopyDict["Create Copy of Credential Dict"]
        CopyDict --> CheckPW{"Has Password?"}
        CheckPW -->|No| AddToList["Add to Encrypted List"]
        CheckPW -->|Yes| EncryptPW["Encrypt Password\n(Fernet)"]
        EncryptPW --> Store["Store as UTF-8"]
        Store --> AddToList
        AddToList --> DumpYAML["Dump to YAML"]
    end

    subgraph Decryption ["Decryption Process"]
        direction TB
        LoadCred["Load Credentials"] --> VerifyLock{"Is Unlocked?"}
        VerifyLock -->|No| LoadError["Raise Error"]
        VerifyLock -->|Yes| ReadYAML["Read YAML File"]
        ReadYAML --> ProcessCreds["Process Each Credential"]
        ProcessCreds --> CopyCred["Create Copy of Credential"]
        CopyCred --> CheckEncPW{"Has Encrypted\nPassword?"}
        CheckEncPW -->|No| AddDecList["Add to Decrypted List"]
        CheckEncPW -->|Yes| DecryptPW["Decrypt Password\n(Fernet)"]
        DecryptPW --> UTF8["Convert to UTF-8"]
        UTF8 --> AddDecList
    end

    subgraph KeyManagement ["Key Management"]
        direction TB
        MasterPW["Master Password"] --> PBKDF2["PBKDF2-HMAC-SHA256\n(480000 iterations)"]
        Salt[".salt file"] --> PBKDF2
        PBKDF2 --> DerivedKey["32-byte Derived Key"]
        DerivedKey --> FernetKey["Fernet Instance"]
    end

    KeyManagement -.-> Encryption
    KeyManagement -.-> Decryption
    Encryption --> FileSystem
    FileSystem --> Decryption

Requirements

• Python 3.9 or higher
• PyQt6
• Additional dependencies will be automatically installed

Usage

After installation, you can launch TerminalTelemetry using either of these commands:

# Launch with console
termtel

First Time Setup

1. When first launched, you'll be prompted to create a master password for secure credential storage

   • The master password is used with PBKDF2 key derivation
   • A unique salt is generated and stored securely
   • Credentials are encrypted using Fernet (AES-128-CBC)

2. Credentials are stored securely based on your platform:

   • Windows: Uses APPDATA directory and MachineGuid
   • macOS: Uses Application Support directory and hardware serial
   • Linux: Uses .config directory and machine-id

3. Connect to devices using the connection panel

   • Credentials are encrypted at rest
   • Session data is protected in memory
   • Machine-specific binding prevents credential theft

Theme Selection

The application supports multiple themes which can be selected from the menu:

• Cyberpunk (Default)
• Dark Mode
• Light Mode
• Retro Green
• Retro Amber
• Neon Blue

Development

To set up a development environment:

git clone https://github.com/scottpeterman/termtel.git
cd termtel
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -e .[dev]

Security Considerations for Development

When contributing, ensure:

1. All cryptographic operations use approved algorithms
2. Platform-specific code is properly isolated
3. Error handling follows security best practices
4. Regular security audits are performed
5. Dependencies are kept updated

Configuration

The application stores its configuration in platform-specific locations:

Windows: %APPDATA%/TerminalTelemetry/
macOS: ~/Library/Application Support/TerminalTelemetry/
Linux: ~/.config/TerminalTelemetry/

License

This project is licensed under the GNU General Public License v3 (GPLv3).

Author

Scott Peterman (github.com/scottpeterman)

Acknowledgments

• PyQt6 for the GUI framework
• NAPALM for network device interaction
• paramiko for all things SSH
• TextFSM, thanks for the templates
• The open-source community for various supporting libraries