2014-06-23 12:07:57 -05:00
|
|
|
wolfssh
|
|
|
|
=======
|
|
|
|
|
2016-03-31 16:12:18 -05:00
|
|
|
wolfSSL's Embeddable SSH Server
|
|
|
|
|
2016-10-23 18:00:40 -05:00
|
|
|
dependencies
|
|
|
|
------------
|
|
|
|
|
|
|
|
wolfSSH is dependent on wolfCrypt. The simplest configuration of wolfSSL
|
|
|
|
required for wolfSSH is the default build.
|
|
|
|
|
|
|
|
$ cd wolfssl
|
|
|
|
$ ./configure [OPTIONS]
|
|
|
|
$ make check
|
|
|
|
$ sudo make install
|
|
|
|
|
|
|
|
To use the key generation function in wolfSSH, wolfSSL will need to be
|
|
|
|
configured with keygen: `--enable-keygen`.
|
|
|
|
|
|
|
|
If the bulk of wolfSSL code isn't desired, wolfSSL can be configured with
|
|
|
|
the crypto only option: `--enable-cryptonly`.
|
|
|
|
|
|
|
|
|
2016-03-31 16:12:18 -05:00
|
|
|
building
|
|
|
|
--------
|
|
|
|
|
|
|
|
From the source directory run:
|
|
|
|
|
|
|
|
$ ./autogen.sh
|
|
|
|
$ ./configure
|
|
|
|
$ make
|
|
|
|
$ make check
|
|
|
|
|
|
|
|
The `autogen.sh` script only has to be run the first time after cloning the
|
|
|
|
repository. If you have already run it or are using code from a source
|
|
|
|
archive, you should skip it.
|
|
|
|
|
2016-10-23 18:00:40 -05:00
|
|
|
|
2016-03-31 16:12:18 -05:00
|
|
|
examples
|
|
|
|
--------
|
|
|
|
|
|
|
|
The directory `examples` contains an echoserver that any client should be able
|
|
|
|
to connect to. From the terminal run:
|
|
|
|
|
|
|
|
$ ./examples/echoserver/echoserver
|
|
|
|
|
|
|
|
From another terminal run:
|
|
|
|
|
|
|
|
$ ssh_client localhost -p 22222
|
|
|
|
|
|
|
|
The server will send a canned banner to the client:
|
|
|
|
|
|
|
|
CANNED BANNER
|
|
|
|
This server is an example test server. It should have its own banner, but
|
|
|
|
it is currently using a canned one in the library. Be happy or not.
|
|
|
|
|
|
|
|
Characters typed into the client will be echoed to the screen by the server.
|
|
|
|
If the characters are echoed twice, the client has local echo enabled.
|
2016-06-16 17:50:11 -05:00
|
|
|
|
2016-10-23 18:00:40 -05:00
|
|
|
|
2016-06-16 17:50:11 -05:00
|
|
|
testing notes
|
|
|
|
-------------
|
|
|
|
|
2016-06-23 12:46:32 -05:00
|
|
|
After cloning the repository, be sure to make the testing private keys read-
|
|
|
|
only for the user, otherwise ssh_client will tell you to do it.
|
|
|
|
|
2016-10-24 17:10:22 -05:00
|
|
|
$ chmod 0600 ./keys/key-gretel.pem ./keys/key-hansel.pem
|
2016-06-23 12:46:32 -05:00
|
|
|
|
2016-06-16 17:50:11 -05:00
|
|
|
Authentication against the example echoserver can be done with a password or
|
|
|
|
public key. To use a password the command line:
|
|
|
|
|
|
|
|
$ ssh_client -p 22222 USER@localhost
|
|
|
|
|
|
|
|
Where the `USER` and password pairs are:
|
|
|
|
|
|
|
|
jill:upthehill
|
|
|
|
jack:fetchapail
|
|
|
|
|
|
|
|
To use public key authentication use the command line:
|
|
|
|
|
2016-10-24 17:10:22 -05:00
|
|
|
$ ssh_client -i ./keys/key-USER.pem -p 22222 USER@localhost
|
2016-06-16 17:50:11 -05:00
|
|
|
|
|
|
|
Where the user can be `gretel` or `hansel`.
|
2016-07-06 13:12:07 -05:00
|
|
|
|
|
|
|
|
2016-10-23 18:00:40 -05:00
|
|
|
release notes
|
|
|
|
-------------
|
2016-07-06 13:12:07 -05:00
|
|
|
|
2016-10-23 18:00:40 -05:00
|
|
|
### wolfSSH v1.0.0 (10/24/2016)
|
2016-07-06 13:12:07 -05:00
|
|
|
|
2016-10-23 18:00:40 -05:00
|
|
|
Initial release.
|