Skip to main content

WebSSH

Build Status codecov PyPI - Python Version PyPI

Introduction

A simple web application to be used as an ssh client to connect to your ssh servers. It is written in Python, base on tornado and paramiko.

+---------+     http     +--------+    ssh    +-----------+
| browser | <==========> | webssh | <=======> | ssh server|
+---------+   websocket  +--------+    ssh    +-----------+

Features

  • SSH password authentication supported, including empty password.

  • SSH public-key authentication supported, including DSA RSA ECDSA Ed25519 keys.

  • Encrypted keys supported.

  • Fullscreen terminal supported.

  • Terminal window resizable.

  • Auto detect the ssh server’s default encoding.

Preview

Login Terminal

Requirement

  • Python 2.7/3.4+

Instructions

pip install webssh
wssh

Options

# listen address and port
wssh --address='0.0.0.0' --port=8000

# missing host key policy
wssh --policy=reject

# logging level
wssh --logging=debug

# log to file
wssh --log-file-prefix=main.log

# more options
wssh --help

Tests

Use unittest to run all tests

python -m unittest discover tests

Use pytest to run all tests

python -m pytest tests

An example of config for running this app behind an Nginx server

location / {
    proxy_pass http://127.0.0.1:8888;
    proxy_http_version 1.1;
    proxy_read_timeout 300;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "upgrade";
    proxy_set_header Host $http_host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Real-PORT $remote_port;
}

Tips

  • Try to use Nginx as a front web server (see config example above) and enable SSL, this will prevent your ssh credentials from being uncovered. Also afterwards the communication between your browser and the web server will be encrypted as they use secured websockets.

  • Try to use reject policy as the missing host key policy along with your verified known_hosts, this will prevent man-in-the-middle attacks. The idea is that it checks the system host keys file(“~/.ssh/known_hosts”) and the application host keys file(“./known_hosts”) in order, if the ssh server’s hostname is not found or the key is not matched, the connection will be aborted.

Metadata

Release files for webssh 0.3.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for webssh 0.3.3
File Size Uploaded
webssh-0.3.3.tar.gz 126.7 kB Details

Release files / webssh-0.3.3.tar.gz

Download URL webssh-0.3.3.tar.gz
Size 126.7 kB
Tags Source
SHA-256 checksum
How to use checksums
06d86d5dc2cbbd71e2b236c7d65f3826da227f39028771056da7a2874a1bc2ce
BLAKE2b-256 checksum
How to use checksums
3b4d64d554bf4cc894dd72111f4884175578e40d80935cfc2e436665cad85259
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Python-urllib/3.6

Release history Release notifications | RSS feed

1.6.3

1 release file

1.6.2

1 release file

1.6.1

1 release file

1.6.0

1 release file

1.5.3

1 release file

1.5.2

1 release file

1.5.1

1 release file

1.5.0

1 release file

1.4.5

1 release file

1.4.3

1 release file

1.4.2

1 release file

1.4.0

1 release file

1.3.0

1 release file

1.2.0

1 release file

1.1.1

1 release file

1.1.0

1 release file

1.0.3

1 release file

1.0.2

1 release file

1.0.1

1 release file

1.0.0

1 release file

0.9.0

1 release file

0.8.0

1 release file

0.7.3

1 release file

0.7.2

1 release file

0.7.1

1 release file

0.7.0

1 release file

0.6.1

1 release file

0.6.0

1 release file

0.5.0

1 release file

0.4.6

1 release file

0.4.1

1 release file

0.4.0

1 release file

0.3.9

1 release file

0.3.5

1 release file

This release

0.3.3 This release

1 release file

0.3.2

1 release file

0.3.1

1 release file

0.3.0

1 release file

0.2.6

1 release file

0.2.5

1 release file

0.2.3

1 release file

0.2.2

1 release file

0.2.1

1 release file

0.2.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page