Merge pull request #378 from tim-weller-wolfssl/example-updates

wolfSSL example updates based on testing with wolfSSL v5.5.4-stable

Author: JacobBarthelmeh

SE050/README.md

@@ -8,7 +8,7 @@ written for and tested on a Raspberry Pi with NXP SE050 EdgeLock development
 kit.
 
 For complete details on wolfSSL's support for NXP SE050, see
-[README_SE050.md](https://www.github.com/wolfssl/wolfssl/wolfcrypt/src/port/nxp/README_SE050.md).
+[README_SE050.md](https://www.github.com/wolfssl/wolfssl/tree/master/wolfcrypt/src/port/nxp/README_SE050.md).
 That document also describes how to download, build, and compile the SE05x
 Middleware. It should be followed first before moving on to installing and
 running these examples.

certgen/certgen_ca_example.c

@@ -30,14 +30,16 @@
 
 #ifdef WOLFSSL_CAAM
     #include <wolfssl/wolfcrypt/port/caam/wolfcaam.h>
+    static int devId = WOLFSSL_CAAM_DEVID;
+#else
+    static int devId = INVALID_DEVID;
 #endif
 
 #if defined(WOLFSSL_CERT_REQ) && defined(WOLFSSL_CERT_GEN) && \
     defined(WOLFSSL_KEY_GEN) && defined(HAVE_ECC)
 
 #define HEAP_HINT NULL
 #define LARGE_TEMP_SZ 4096
-static int devId = WOLFSSL_CAAM_DEVID;
 
 static int do_cagen(int argc, char** argv)
 {

certmanager/README.md

@@ -8,6 +8,7 @@ in a standalone manner, separate from an SSL/TLS connection.
 ## Compiling and Running the Example
 
 ```
+$ ./configure --enable-opensslextra
 $ make
 $ ./certverify
 ```

crypto/3des/README.md

@@ -5,7 +5,7 @@ How to use 3des-file-encrypt.c
    b. In the crypto/3des directory run the Makefile by typing 'make'.
 2)  Make a file to encode. Can be any file (ex. .txt .in .out .file etc.)
 3)  run the executable, for help run with -h flag. Basic command is as follows:
-        ./3des-file-encrypt <-option> <KeySize> <input.file> <output.file>
+        ./3des-file-encrypt <-option> <KeySize> -i <input.file> -o <output.file>
 
         KeySize examples: 56, 112, or 168
 

crypto/aes/README.md

@@ -6,7 +6,7 @@ How to use aes-file-encrypt.c
 2)  Make a file to encode. Can be any file (ex. .txt .in .out .file etc.)
 3)  run the executable, for help run with -h flag. Basic command is as follows:
 
-        ./aes-file-encrypt <-option> <KeySize> <input.file> <output.file>
+        ./aes-file-encrypt <-option> <KeySize> -i <input.file> -o <output.file>
 
         KeySize (in bits) allowed values: 128, 192, 256
 

crypto/camellia/README.md

@@ -6,7 +6,7 @@ How to use camellia-encrypt.c
 2)  Make a file to encode. Can be any file (ex. .txt .in .out .file etc.)
 3)  run the executable, for help run with -h flag. Basic command is as follows:
 
-        ./camellia-encrypt <-option> <input.file> <KeySize> <output.file>
+        ./camellia-encrypt <option> <KeySize> -i <input.file> -o <output.file>
 
         KeySize examples: 128, 192, 256
 

custom-io-callbacks/README.md

@@ -13,12 +13,26 @@ Other transports might be:
 These examples use the wolfSSL Custom IO Callbacks to read and write to the file
 system and perform a successful handshake.
 
-The configuration used for these examples:
+Building the examples:
 
-`./configure --enable-debug`
+From the wolfssl directory:
+```
+./configure --enable-debug
+sudo make install
+```
 
-Debug was enabled in case a user wishes to use the verbose flag to see what is
-happening in real time:
+**NOTE:** Debug was enabled in case a user wishes to use the verbose flag to see
+          what is happening in real time:
+
+From the file-server directory:
+```
+make
+```
+
+From the file-client directory:
+```
+make
+```
 
 Usage examples:
 

dtls/client-dtls.c

@@ -56,7 +56,7 @@ int main (int argc, char** argv)
 
     /* Program argument checking */
     if (argc != 2) {
-        printf("usage: udpcli <IP address>\n");
+        printf("usage: %s <IP address>\n", argv[0]);
         return 1;
     }
 

ecc/README.md

@@ -5,7 +5,7 @@
 ### Build and install wolfSSL
 
 ```
-./configure --enable-ecc --enable-ecccustcurves CFLAGS="-DWOLFSSL_TEST_CERT -DWOLFSSL_DER_TO_PEM -DHAVE_ECC_KOBLITZ" && make && sudo make install
+./configure --enable-ecc --enable-ecccustcurves CFLAGS="-DWOLFSSL_TEST_CERT -DWOLFSSL_DER_TO_PEM -DHAVE_ECC_KOBLITZ -DWOLFSSL_PUBLIC_MP" && make && sudo make install
 ```
 
 ### Build Example
@@ -119,7 +119,7 @@ This example demonstrates using a Koblitz (SECP256K1) curve.
 hash_firmware_verify: 0
 ```
 
-### `ecc-key-decode`
+### `ecc-key-export`
 
 This example shows exporting an ECC private key and public key.
 

ocsp/ocsp_nonblock/README.md

@@ -35,8 +35,12 @@ Ret = 1: success
 
 ## OCSP non-blocking Async example
 
-This uses your system certificate chain to demonstrate validating revocation status using an OCSP 
-public server with wolfSSL's Asynchronous crypto.
+This uses your system certificate chain to demonstrate validating revocation status using an OCSP
+public server with wolfSSL's Asynchronous cryptography support.  i
+
+**NOTE:** Before building this example the asynchronous support must be obtained from
+(https://github.com/wolfSSL/wolfAsyncCrypt) and installed into wolfSSL by following the
+instructions in the *README* file contained in the wolfAsyncCrypt repository.
 
 The example uses youtube.com as the public server.