From 6e4cca9a4eda00c40fda615c185a4929a658a5ba Mon Sep 17 00:00:00 2001 From: tfn18001 Date: Fri, 22 Apr 2022 00:22:22 -0400 Subject: [PATCH] Updated some Readmes --- CTng/Readme.md | 16 ++++++++++++++++ CTng/monitor/Readme.md | 10 +++++----- 2 files changed, 21 insertions(+), 5 deletions(-) create mode 100644 CTng/Readme.md diff --git a/CTng/Readme.md b/CTng/Readme.md new file mode 100644 index 0000000..9d2619f --- /dev/null +++ b/CTng/Readme.md @@ -0,0 +1,16 @@ + +## Running the code +___ +Run `go install .` before continuing! + +To run a single Monitor or gossiper, run +`go run . [gossiper|monitor|] [public_config_path] [private_config_path] [crypto_config_path]` + +The `testData` folder contains configurations for testing, but configs can be generated using the functions in `config`. + + +## Function Documentation +___ +Documentation + Function descriptions exist in each file/subfolder. + +To view this this info + documentation in a formal documentation setting, utilize GoDoc. \ No newline at end of file diff --git a/CTng/monitor/Readme.md b/CTng/monitor/Readme.md index ca8dbbd..b5cf9ca 100644 --- a/CTng/monitor/Readme.md +++ b/CTng/monitor/Readme.md @@ -2,24 +2,24 @@ ## Contents - `types.go`: type declarations for monitor context and some basic monitor methods definitions -- `monitor.go`: implementation of some monitor functions that will be used by monitor_server in the server folder -- `monitor_process.go`: contains only the process valid gossip object function +- `monitor.go`: implementation of clientside monitor functions that will be used by monitor_server in the server folder +- `monitor_process.go`: contains only process valid gossip object functions ## types.go --`Monitor_context`: monitor context is a object that contains all the configuration and storage information about the monitor +-`Monitor_context`: monitor context is an object that contains all the configuration and storage information about the monitor - `methods`: internal methods defined in this file includes savestorage, loadstorage, getobject, isduplicate, and storeobject ## monitor.go - `Queryloggers`: send HTTP get request to loggers - `QueryAuthorities`: send HTTP get request to CAs - `Check_entity_pom`: check if there is a pom against the provided URL -- `Islogger`: check if the entities is in the Loggers list from the public config file +- `isLogger`: check if the entities is in the Loggers list from the public config file - `IsAuthority`: check if the entities is in the CAs list from the public config file - `AccuseEntity`: accuses the entity if its URL is provided - `Send_to_gossiper`: send the input gossip object to the gossiper ## monitor_process.go - `Process_valid_object`: - if the monitor receives a valid sth from a logger or valid revocation information from a CA (both needs to be in the form of a gossip object), + If the monitor receives a valid sth from a logger or valid revocation information from a CA (both need to be in the form of a gossip object), this function will send the raw version of the gossip object to the gossiper, wait for gossip_wait_time, check updated local PoM database, if there is no PoM against the signer of this sth/revocation information, threshold sign this sth/revocation information and send it to the gossiper