search

fpoirotte / pssht

SSH server written in PHP
https://pssht.readthedocs.io
MIT License
40 stars 9 forks source link

readme

pssht

pssht is a PHP library that provides an SSH server that can be embedded in other applications.

What we're aiming for:

What we're not specifically aiming for, but still interested in:

Disclaimer

This should be obvious from the get-go, but DO NOT USE pssht in production. This project merely exists for two reasons:

The implementation did not pass any specific security audit. In addition, no attempt has been made to avoid some common classes of vulnerabilities, eg. timing attacks <http://blog.ircmaxell.com/2014/11/its-all-about-time.html>_. Not to mention that the PHP interpreter itself is known to be frequently subject to vulnerabilities of its own <http://www.cvedetails.com/product/128/PHP-PHP.html?vendor_id=74>_.

If you are looking for an SSH daemon with thorough testing and code audits to integrate with your PHP code, we recommend that you look into the OpenSSH project <http://www.openssh.com/>_.

If you still aren't convinced that you shouldn't use this code in production, see this reddit page <http://www.reddit.com/r/lolphp/comments/1yvm6v/php_can_do_anything_what_about_some_ssh_mtgox>_ which relates part of the story of a project similar to pssht by MtGox's CEO.

In no event shall the authors of pssht be liable for anything that happens while using this library. Please read the license_ for the full disclaimer.

Installation

The requirements for pssht are quite basic:

Moreover, you may be interested in enable the following PHP extensions to get additional features:

First things first, download the composer.phar <https://getcomposer.org/composer.phar>_ executable or use the installer:

.. sourcecode:: console

$ curl -sS https://getcomposer.org/installer | php

Now, you can either install pssht:

Standalone installation


To install pssht as a standalone SSH server, clone this repository
and then run Composer on it:

..  sourcecode:: console

    $ git clone https://github.com/fpoirotte/pssht.git
    $ cd pssht
    $ php /path/to/composer.phar update --no-dev

Embedded installation

To install pssht as an embedded library in your application, create or update a composer.json file in your project's root directory with a requirement on pssht.

For example, for a new empty project, your composer.json file would look somewhat like this:

.. sourcecode:: json

{
    "require": {
        "fpoirotte/pssht": "*"
    }
}

Run Composer:

.. sourcecode:: console

$ php /path/to/composer.phar install --no-dev

Finally, copy pssht.xml to your project's root directory:

.. sourcecode:: console

$ cp -a vendor/fpoirotte/pssht/pssht.xml ./

Basic usage

Start the server:

.. sourcecode:: console

$ php bin/pssht         # for standalone installations
$                       # ...or...
$ php vendor/bin/pssht  # for embedded installations

.. note::

When run like that, pssht will just act as a basic echo server,
responding with the exact same data that was sent to it.

pssht will display various debugging messages while initializing. When ready, you will see something like this in the console:

.. sourcecode::

[Fri, 08 May 2015 20:23:21 +0200] INFO: Listening for new connections on 0.0.0.0:22222

You can now connect to the server with the same user that was used to start pssht by using your regular SSH client (eg. OpenSSH/PuTTy). For example, using the OpenSSH client and assuming pssht was run by clicky:

.. sourcecode:: console

$ ssh -T -p 22222 clicky@localhost
Hello world!
clicky@localhost's password: pssht

The default pssht.xml configuration file automatically loads the public keys stored in ~/.ssh/authorized_keys. You can thus connect with the matching private key. It will also accept password-based authentication using "pssht" as the password.

.. note::

The ``-T`` option is used to disable pseudo-tty allocation as it is
not yet supported (see #21). Without it, OpenSSH displays a warning
in the console (``PTY allocation request failed on channel 0``).

Configuration

pssht uses the Dependency Injection component <http://symfony.com/doc/current/components/dependency_injection/>_ from the Symfony2 framework for its configuration.

Have a look at the default pssht.xml <https://github.com/fpoirotte/pssht/blob/master/pssht.xml>_ configuration file for ways to customize pssht. The file contains numerous comments and the options should thus be very straightforward.

Compatibility

pssht supports the mechanisms and algorithms defined in the following documents for compatibility with other Secure Shell implementations:

The rest of this section describes precisely which algorithms and features are supported.

TL;DR here's a feature chart for comparison with OpenSSH 6.7p1:

.. [#null] The "none" algorithm has been excluded from those counts.

Services


The following services are supported:

-   ``ssh-userauth``
-   ``ssh-connection``

Authentication methods

The following authentication methods are supported:

Key exchange methods


The following key exchange methods are supported:

-   ``curve25519-sha256@libssh.org``
-   ``diffie-hellman-group1-sha1``
-   ``diffie-hellman-group14-sha1``
-   ``ecdh-sha2-nistp256``
-   ``ecdh-sha2-nistp384``
-   ``ecdh-sha2-nistp521``

The PHP ``hash`` extension must be installed for
``curve25519-sha256@libssh.org`` and the ``ecdsa-sha2-*`` family
of algorithms to work properly.
Also, elliptic curve points encoded using point compression
are **not** accepted or generated.

Encryption algorithms

The following encryption algorithms are supported:

MAC algorithms


The following MAC algorithms are supported:

-   ``hmac-md5``
-   ``hmac-md5-etm@openssh.com``
-   ``hmac-md5-96``
-   ``hmac-md5-96-etm@openssh.com``
-   ``hmac-ripemd160``
-   ``hmac-ripemd160@openssh.com`` (as an alias for ``hmac-ripemd160``)
-   ``hmac-ripemd160-etm@openssh.com``
-   ``hmac-sha1``
-   ``hmac-sha1-etm@openssh.com``
-   ``hmac-sha1-96``
-   ``hmac-sha1-96-etm@openssh.com``
-   ``hmac-sha2-256``
-   ``hmac-sha2-256-etm@openssh.com``
-   ``hmac-sha2-512``
-   ``hmac-sha2-512-etm@openssh.com``
-   ``none``
-   ``ripemd160`` (as an alias for ``hmac-ripemd160``)
-   ``umac-64@openssh.com``
-   ``umac-64-etm@openssh.com``
-   ``umac-128@openssh.com``
-   ``umac-128-etm@openssh.com``

All these algorithms except for the ``umac-*`` family require
the PHP ``hash`` extension in order to work properly.

Public key algorithms

The following public key algorithms are supported:

The PHP hash extension must be installed for the ssh-ed25519 and ecdsa-sha2-* family of algorithms to work properly. Also, elliptic curve points encoded using point compression are not accepted or generated.

Compression algorithms


The following compression algorithms are supported:

-   ``none``
-   ``zlib``
-   ``zlib@openssh.com``

The PHP ``http`` extension must be installed for the ``zlib`` and
``zlib@openssh.com`` algorithms to work properly.

Integration
-----------

pssht is mainly intended to be used as an embedded SSH server for PHP applications.
By default, only the bare structure for an SSH server is provided.
The application using pssht is responsible for adding it's own logic on top
of this structure.

Contributions
-------------

Want to contribute back to the project?

-   `Fork the code <https://github.com/fpoirotte/pssht/fork_select>`_
    to your own account.
-   Create a new branch.
-   Hack around.
-   Create a pull request with your changes.

License
-------

The MIT License (MIT)

Copyright (c) 2014 François Poirotte

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Changelog
---------

v0.1.1

v0.1.0



*   Initial release with lots of features already.

..  _`draft-miller-secsh-umac-01`:
    https://tools.ietf.org/html/draft-miller-secsh-umac-01

..  _`draft-miller-secsh-compression-delayed-00`:
    https://tools.ietf.org/html/draft-miller-secsh-compression-delayed-00

..  _`OpenSSH PROTOCOL`:
    http://cvsweb.openbsd.org/cgi-bin/cvsweb/src/usr.bin/ssh/PROTOCOL?rev=HEAD

..  _`OpenSSH private key format`:
    http://cvsweb.openbsd.org/cgi-bin/cvsweb/src/usr.bin/ssh/PROTOCOL.key?rev=HEAD

..  _`ChaCha20-Poly1305`:
    http://cvsweb.openbsd.org/cgi-bin/cvsweb/src/usr.bin/ssh/PROTOCOL.chacha20poly1305?rev=HEAD

..  _`Ed25519 curve`:
    http://ed25519.cr.yp.to/software.html

..  _`Curve25519 curve`:
    http://git.libssh.org/projects/libssh.git/plain/doc/curve25519-sha256@libssh.org.txt

..  |[ ]| unicode:: U+2610 .. ballot box
..  |[x]| unicode:: U+2611 .. ballot box with check
..  |---| unicode:: U+2014 .. em dash
    :trim: