From 293c3c8b4fa62339dabf77da1b4153446c05189c Mon Sep 17 00:00:00 2001 From: Chris Conlon Date: Tue, 17 May 2022 16:10:12 -0600 Subject: [PATCH] update README/README_JCE with notes about examples --- README.md | 7 +++++++ README_JCE.md | 28 +++++++++++++++++++++++++--- 2 files changed, 32 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 79ac8c2..da99ba1 100644 --- a/README.md +++ b/README.md @@ -128,6 +128,13 @@ the root wolfcrypt-jni directory. The test source code is located at: `wolfcrypt-jni/src/test/com/wolfssl/wolfcrypt` +JCE-specific examples can be found in the `examples/provider` sub-directory. +These examples will only be compiled with either `ant build-jce-debug` or +`ant build-jce-release` are used. Since these are JCE/provider-only examples, +they are not built for JNI-only builds (`ant build-jni-debug/release`). + +For more details, see the [README_JCE.md](./README_JCE.md). + ### JAR Code Signing --------- diff --git a/README_JCE.md b/README_JCE.md index 8299c15..4fe3941 100644 --- a/README_JCE.md +++ b/README_JCE.md @@ -71,9 +71,31 @@ The JCE provider currently supports the following algorithms: ### Example / Test Code --------- -Example code will be added in the near future. JUnit test code is located -under the "./src/test/java/com/wolfssl/provider/jce/test/" directory for -each wolfJCE engine class. +JUnit test code can act as a good usage reference, and is located under the +`./src/test/java/com/wolfssl/provider/jce/test/` directory for each wolfJCE +engine class. + +There are some JCE examples located under the `examples/provider` directory, +including: + +**ProviderTest** + +This is an example that prints out all Security providers that are registered +in the system. It then programatically registers wolfJCE as the highest-level +provider and prints out the list again. + +This example will be built when using the following ant targets: + +``` +$ ant build-jce-debug +$ ant build-jce-release +``` + +The example can then be run using: + +``` +$ ./examples/provider/ProviderTest.sh +``` ### JAR Code Signing ---------