Skip to content

Commit

Permalink
Updated some Readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
tfn18001 committed Apr 22, 2022
1 parent 60b6261 commit 6e4cca9
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 5 deletions.
16 changes: 16 additions & 0 deletions CTng/Readme.md
Original file line number Diff line number Diff line change
@@ -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.
10 changes: 5 additions & 5 deletions CTng/monitor/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 6e4cca9

Please sign in to comment.