affine/jobserv
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

updated README.md

Browse source
This commit is contained in:
Aidan Hahn 2019-05-19 14:39:41 -07:00
parent 8982353f0a
commit 75c3dcda61
No known key found for this signature in database
GPG key ID: 327711E983899316
2 changed files with 26 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -3,21 +3,33 @@ Remote Procedure Calls over the protobuf API
# Requirements
- openssl
- tar
# Building
Gradle will manage dependencies, generate code, compile the java, and package the code.
Simply run the folllowing command:
```shell
$ gradle clean build
$ ./buildwrapper.sh
```
Gradle will package both the client and server into both a zip and a tarball.
The tarball is located in build/distributions. After extracting one of the archives on a target machine the following commands will run JobServ.
Make sure you are in the directory you extracted the archive to.
```shell
$ ./bin/jobserv-server
$ ./bin/jobserv-client (host) (port)
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.
# Running
After build, the programs can be found in the staging folder.
After changing directory to the 'staging/client' folder or the 'staging/server' folder, either program can be run as follows:
```
$ ./JobServ/bin/jobserv-server (port) server.crt private.pem ca.crt
$ ./JobServ/bin/jobserv-client private.pem client.crt ca.crt (hostname) (port) (command) (arguments)
```
alternatively, for guidance:
```
$ ./JobServ/bin/jobserv-server
$ ./JobServ/bin/jobserv-client help
```
(TODO: seperate archives for client and server)
# Testing
(TODO: tests for mtls, job control module)
(TODO: job control module)