Metadata-Version: 1.1
Name: webssh
Version: 0.7.2
Summary: Web based ssh client
Home-page: https://github.com/huashengdun/webssh
Author: Shengdun Hua
Author-email: webmaster0115@gmail.com
License: MIT
Description: 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, paramiko and
        xterm.js.
        
        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.
        -  Modern browsers including Chrome, Firefox, Safari, Edge, Opera
           supported.
        
        Preview
        -------
        
        |Login| |Terminal|
        
        How it works
        ~~~~~~~~~~~~
        
        ::
        
            +---------+     http     +--------+    ssh    +-----------+
            | browser | <==========> | webssh | <=======> | ssh server|
            +---------+   websocket  +--------+    ssh    +-----------+
        
        Requirements
        ~~~~~~~~~~~~
        
        -  Python 2.7/3.4+
        
        Quickstart
        ~~~~~~~~~~
        
        1. Install this app, run command ``pip install webssh``
        2. Start a webserver, run command ``wssh``
        3. Open your browser, navigate to ``127.0.0.1:8888``
        4. Input your data, submit the form.
        
        Server options
        ~~~~~~~~~~~~~~
        
        .. code:: bash
        
            # start a http server with specified listen address and listen port
            wssh --address='0.0.0.0' --port=8000
        
            # start a https server
            wssh --certfile='cert.crt' --keyfile='cert.key'
        
            # 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
        
        Use console
        ~~~~~~~~~~~
        
        .. code:: javascript
        
            // connect to your ssh server
            wssh.connect(hostname, port, username, password, privatekey);
        
            // pass an object to wssh.connect
            var opts = {
              hostname: 'hostname',
              port: 'port',
              username: 'username',
              password: 'password',
              privatekey: 'the private key text'
            };
            wssh.connect(opts);
        
            // without an argument, wssh will use the form data to connect
            wssh.connect();
        
            // set a new encoding for client to use
            wssh.set_encoding(encoding);
        
            // reset encoding to use the default one
            wssh.reset_encoding();
        
            // send a command to the server
            wssh.send('ls -l');
        
        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
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        .. code:: nginx
        
            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.
        
        .. |Build Status| image:: https://travis-ci.org/huashengdun/webssh.svg?branch=master
           :target: https://travis-ci.org/huashengdun/webssh
        .. |codecov| image:: https://codecov.io/gh/huashengdun/webssh/branch/master/graph/badge.svg
           :target: https://codecov.io/gh/huashengdun/webssh
        .. |PyPI - Python Version| image:: https://img.shields.io/pypi/pyversions/webssh.svg
        .. |PyPI| image:: https://img.shields.io/pypi/v/webssh.svg
        .. |Login| image:: https://github.com/huashengdun/webssh/raw/master/preview/login.png
        .. |Terminal| image:: https://github.com/huashengdun/webssh/raw/master/preview/terminal.png
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
