Update README.md

pull/35/head
Kaleb Himes 2016-12-27 10:52:42 -07:00 committed by GitHub
parent 6fdf7ef3d4
commit 55861e82ec
1 changed files with 51 additions and 49 deletions

View File

@ -1,50 +1,52 @@
This is an example to demonstrate how the custom IO callbacks can be used to This is an example to demonstrate how the custom IO callbacks can be used to</br>
facilitate a TLS connection using any medium. Here we chose the medium of files. facilitate a TLS connection using any medium. Here we chose the medium: "File System".</br>
Other mediums might be: Other mediums might be: </br>
USB Serial connection USB Serial connection </br>
Bluetooth Bluetooth </br>
RFID RFID </br>
Wifi Wifi </br>
Ethernet Ethernet </br>
</br>
To name a few. Just to name a few.</br>
</br>
These examples use the wolfSSL Custom IO Callbacks to read and write to the file These examples use the wolfSSL Custom IO Callbacks to read and write to the file</br>
system and perform a successful handshake. system and perform a successful handshake.</br>
</br>
The configuration used for these examples was: The configuration used for these examples was:</br>
./configure --enable-debug ./configure --enable-debug</br>
</br>
Debug was enabled in case a user wishes to use the verbose flag to see what is Debug was enabled in case a user wishes to use the verbose flag to see what is</br>
happening in real time: happening in real time:</br>
</br>
Usage examples: Usage examples:</br>
</br>
From the file-server directory: From the file-server directory:</br>
./start-server ./start-server</br>
./start-server -v ./start-server -v</br>
./start-server -verbose ./start-server -verbose</br>
</br>
From the file-client directory: From the file-client directory:</br>
./start-client ./start-client</br>
./start-client -v ./start-client -v</br>
./start-client -verbose ./start-client -verbose</br>
</br>
(-v and -verbose accomplish the same thing) (-v and -verbose accomplish the same thing)</br>
</br>
</br>
SCRIPTS: The scripts provided attempt to make testing easier. SCRIPTS: The scripts provided attempt to make testing easier.</br>
</br>
file-server/check.sh file-server/check.sh</br>
- starts the server in a background shell and runs the client - starts the server in a background shell and runs the client </br>
USAGE: </br>
./check.sh USAGE:</br>
./check.sh -v ./check.sh</br>
./check.sh -verbose ./check.sh -v</br>
./check.sh -verbose</br>
file-client/clean-io-files.sh </br>
- If something happens and there is leftover junk in the io files run this file-client/clean-io-files.sh</br>
script to quickly cleanup before next round of testing. - If something happens and there is leftover junk in the io files run this</br>
USAGE: script to quickly cleanup before next round of testing.</br>
./clean-io-files.sh USAGE:</br>
./clean-io-files.sh</br>
</br>