mirror of https://github.com/wolfSSL/wolfssh.git
Prep for v1.0.0
1. Bump version number. 2. Update readme. 3. Move the coding standard to a notes file.pull/22/head
John Safranek
parent
bc9eff91d6
commit
184182d152
54
README.md
54
README.md
|
|
@ -3,6 +3,24 @@ wolfssh
|
|||
|
||||
wolfSSL's Embeddable SSH Server
|
||||
|
||||
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`.
|
||||
|
||||
|
||||
building
|
||||
--------
|
||||
|
||||
|
|
@ -17,6 +35,7 @@ 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.
|
||||
|
||||
|
||||
examples
|
||||
--------
|
||||
|
||||
|
|
@ -38,6 +57,7 @@ The server will send a canned banner to the client:
|
|||
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.
|
||||
|
||||
|
||||
testing notes
|
||||
-------------
|
||||
|
||||
|
|
@ -63,35 +83,9 @@ To use public key authentication use the command line:
|
|||
Where the user can be `gretel` or `hansel`.
|
||||
|
||||
|
||||
coding standard
|
||||
---------------
|
||||
|
||||
1. Exceptions are allowed with good reason.
|
||||
|
||||
2. Follow the existing style.
|
||||
|
||||
3. Try not to shorthand variables, except for ijk as indicies.
|
||||
|
||||
4. Lengths of arrays should have the array name followed by Sz.
|
||||
|
||||
5. Single return per function.
|
||||
|
||||
6. Check all incoming parameters.
|
||||
|
||||
7. No gotos.
|
||||
|
||||
8. Check all return codes. It feels a little tedious, but the preferred method
|
||||
is running checks against success. This way if a function returns an error, the
|
||||
code will drop to the end.
|
||||
|
||||
```
|
||||
ret = functionCall(parameter);
|
||||
if (ret == SUCCESS)
|
||||
ret = secondFunctionCall(otherParameter);
|
||||
if (ret == SUCCESS)
|
||||
ret = thirdFunctionCall(aParameter, anotherParameter);
|
||||
cleanUp();
|
||||
return ret;
|
||||
```
|
||||
release notes
|
||||
-------------
|
||||
|
||||
### wolfSSH v1.0.0 (10/24/2016)
|
||||
|
||||
Initial release.
|
||||
|
|
|
|||
26
configure.ac
26
configure.ac
|
|
@ -2,7 +2,7 @@
|
|||
# Copyright (C) 2014-2016 wolfSSL Inc.
|
||||
# All right reserved.
|
||||
|
||||
AC_INIT([wolfssh], [0.2.0], [http://wolfssl.com], [wolfssh])
|
||||
AC_INIT([wolfssh], [1.0.0], [http://wolfssl.com], [wolfssh])
|
||||
AC_PREREQ([2.63])
|
||||
AC_CONFIG_AUX_DIR([build-aux])
|
||||
|
||||
|
|
@ -17,18 +17,18 @@ AC_ARG_PROGRAM
|
|||
AC_CONFIG_MACRO_DIR([m4])
|
||||
AC_CONFIG_HEADERS([src/config.h])
|
||||
|
||||
WOLFSSH_LIBRARY_VERSION=1:2:0
|
||||
# | | |
|
||||
# +------+ | +---+
|
||||
# | | |
|
||||
# current:revision:age
|
||||
# | | |
|
||||
# | | +- increment if interfaces have been added
|
||||
# | | set to zero if interfaces have been removed
|
||||
# | | or changed
|
||||
# | +- increment if source code has changed
|
||||
# | set to zero if current is incremented
|
||||
# +- increment if interfaces have been added, removed or changed
|
||||
WOLFSSH_LIBRARY_VERSION=2:0:1
|
||||
# | | |
|
||||
# +------+ | +---+
|
||||
# | | |
|
||||
# current:revision:age
|
||||
# | | |
|
||||
# | | +- increment if interfaces have been added
|
||||
# | | set to zero if interfaces have been removed
|
||||
# | | or changed
|
||||
# | +- increment if source code has changed
|
||||
# | set to zero if current is incremented
|
||||
# +- increment if interfaces have been added, removed or changed
|
||||
AC_SUBST([WOLFSSH_LIBRARY_VERSION])
|
||||
|
||||
LT_PREREQ([2.2])
|
||||
|
|
|
|||
|
|
@ -0,0 +1,35 @@
|
|||
wolfssh notes
|
||||
=============
|
||||
|
||||
coding standard
|
||||
---------------
|
||||
|
||||
1. Exceptions are allowed with good reason.
|
||||
|
||||
2. Follow the existing style.
|
||||
|
||||
3. Try not to shorthand variables, except for ijk as indicies.
|
||||
|
||||
4. Lengths of arrays should have the array name followed by Sz.
|
||||
|
||||
5. Single return per function.
|
||||
|
||||
6. Check all incoming parameters.
|
||||
|
||||
7. No gotos.
|
||||
|
||||
8. Check all return codes. It feels a little tedious, but the preferred method
|
||||
is running checks against success. This way if a function returns an error, the
|
||||
code will drop to the end.
|
||||
|
||||
```
|
||||
ret = functionCall(parameter);
|
||||
if (ret == SUCCESS)
|
||||
ret = secondFunctionCall(otherParameter);
|
||||
if (ret == SUCCESS)
|
||||
ret = thirdFunctionCall(aParameter, anotherParameter);
|
||||
cleanUp();
|
||||
return ret;
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -33,8 +33,8 @@
|
|||
extern "C" {
|
||||
#endif
|
||||
|
||||
#define LIBWOLFSSH_VERSION_STRING "0.2.0"
|
||||
#define LIBWOLFSSH_VERSION_HEX 0x00002000
|
||||
#define LIBWOLFSSH_VERSION_STRING "1.0.0"
|
||||
#define LIBWOLFSSH_VERSION_HEX 0x01000000
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in New Issue