History

David Garske 8601c14f1c Merge pull request #4297 from anhu/master Fix a race condition in the benchmark example and …		2021-08-12 13:51:43 -07:00
..
benchmark	Changes to make Jenkins happy and reduce verbosity.	2021-08-12 11:13:15 -04:00
client	Adding README.md to examples dir and links to wolfssl-examples github repo in client/server.c	2021-08-02 20:27:41 -06:00
configs	Added static ciphers and sniffer. Fixed spelling.	2021-06-17 15:19:45 -07:00
echoclient	Asynchronous support for TLS v1.3 TLSX ECC/DH key generation and key agreement	2021-06-11 14:12:12 -07:00
echoserver	Asynchronous support for TLS v1.3 TLSX ECC/DH key generation and key agreement	2021-06-11 14:12:12 -07:00
sctp	update copyright date	2021-03-11 13:42:46 +07:00
server	Adding README.md to examples dir and links to wolfssl-examples github repo in client/server.c	2021-08-02 20:27:41 -06:00
README.md	Fix broken link in examples/README.md	2021-08-11 10:49:38 -06:00
include.am	Adding README.md to examples dir and links to wolfssl-examples github repo in client/server.c	2021-08-02 20:27:41 -06:00

README.md

wolfSSL examples directory

client and server

These directories contain a client (client.c) and server (server.c) that utilize a variety of the wolfSSL library's capabilities. The manner in which both programs operate can depend on the configure or can be specified at run-time depending on the end goal. Both applications contain testing as well as benchmarking code.

Compile

 ./configure
 make

Usage

./examples/server/server

./examples/client/client

Run ./examples/server/server -h and ./examples/client/client -h for usage details.

For simpler wolfSSL TLS server/client examples, visit https://github.com/wolfSSL/wolfssl-examples/tree/master/tls

echoclient and echoserver

These directories contain a client (echoclient.c) and server (echoserver.c) that establish a connection encrypted by wolfSSL. Like the names indicate, once the connection has been established any messages entered into echoclient are sent to and displayed on the echoserver and are then echoed back to echoclient. The nature of the encryption, as well as additional behavior of the two programs, depends on how wolfSSL was configured ( DTLS enabled/disabled, Filesystem enabled/disabled, etc ... ).

Compile

./configure
make

Usage

./examples/echoserver/echoserver

./examples/echoclient/echoclient

benchmark

The benchmark directory offers an application that can help you grasp just how well wolfSSL's TLS functionality is performing on your local machine.

Compile

./configure
make

Usage

./examples/benchmark/tls_bench

The tls_bench executable can also be compiled separately with gcc -lwolfssl -lpthread -o tls_bench tls_bench.c.

Run ./examples/benchmark/tls_bench -? for usage details.

sctp

This directory contains servers and clients that demonstrate wolfSSL's DTLS-SCTP support.

Compile

./configure --enable-sctp
make

Usage

./examples/sctp/sctp-server

./examples/sctp/sctp-client

and

./examples/sctp/sctp-server-dtls

./examples/sctp/sctp-client-dtls

configs

This directory contains example wolfSSL configuration file templates for use when autoconf is not available, such as building with a custom IDE.

See configs/README.md for more details.