From 4cb9d3a5e1331cfe9af13e0ce1d7499a1d42379a Mon Sep 17 00:00:00 2001 From: Aidan Hahn Date: Thu, 23 May 2019 19:40:46 -0700 Subject: [PATCH] more eloquent readme --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1ea23f0..1797e69 100644 --- a/README.md +++ b/README.md @@ -11,10 +11,12 @@ Simply run the folllowing command: ```shell $ ./buildwrapper.sh ``` -buildwrapper will ask you for details about the client and server, if you are testing this software both CNs can be set to localhost. -buildwrapper will then generate CAs for the Client and Server, and signed certs for the Client and Server. IN addition a seperate, third CA and cert will be generated for testing purposes. -Gradle will then generate protobuf source and compile it with the source for the client and server. -After gradle is completed buildwrapper will organize the sources with their respective certs in the staging folder. In addition to a server folder and a client folder, there will be a test folder which has a copy of all certs and both server and client functionality. The test CA is not trusted by the server or the client by default. As such, the test cert can be used to induce a mutual tls authentication failure. +Buildwrapper will ask you for details about the client and server. If you are testing this software both CNs can be set to localhost. +Buildwrapper will then generate CAs for and signed certs for the Client and Server. In addition a seperate, third CA and cert will be generated for testing purposes. +Gradle will then generate protobuf source and compile it with the java source for the client and server. +After gradle is finished compiling and running the junit tests, buildwrapper will organize the sources with their respective certs in the staging folder. +In addition to a server folder and a client folder, there will be a test folder which has a copy of all certs and both server and client functionality. +The test CA is not trusted by the server or the client by default. As such, the test cert can be used to induce a mutual tls authentication failure. # Running After build, the programs can be found in the staging folder.