Renaming + main class (#2)

* Renaming + main class

---------

Co-authored-by: Tilmann Zäschke <[email protected]>

Author: tzaeschke

CHANGELOG.md

@@ -14,6 +14,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Added CHANGELOG
 - EchoResponder
 
+### Changed
+- CHanged pretty much all names and created an executable main class.
+  [#2](https://github.com/netsec-ethz/scion-java-multiping/pull/2)
+
 ## [0.1.0] - 2024-09-16
 
 ### Added

EchoRepeatDestinations-long.csv

@@ -4,28 +4,49 @@ A tool that allows pinging / trace route) all known ASes in one run.
 
 MultiPing provides several tools:
 
-* `DownloadAssignmentList` for downloading a list of known ISD/AS assignment
-* `EchoAll` for sending a single traceroute to all known ASes along the shortest path (default behaviour)
-* `EchoRepeat` for repeatedly probing (traceroute) multiple paths to multiple ASes.
-* `EchoResponder` for responding to incoming echo requests.
+* `Download Assignments` for downloading a list of known ISD/AS assignment
+* `Ping All` for sending a single traceroute to all known ASes along the shortest path (default
+  behaviour)
+* `Ping Repeat` for repeatedly probing (traceroute) multiple paths to multiple ASes.
+* `Ping Responder` for responding to incoming echo requests.
 
-# `DownloadAssignmentList`
+## Execution
+
+All tools can be run from the executable jar file which is available in
+the [GitHub Releases section](https://github.com/netsec-ethz/scion-java-multiping/releases/download/v0.1.0/scion-multiping-0.1.0-shaded.jar).
+It can be executed with:
 
-The tool parses [Anapayas ISD/AS assignment website](https://docs.anapaya.net/en/latest/resources/isd-as-assignments/)
-and writes the result to a local file 'EchoRepeatDestinations-new.csv'.
+```
+java -jar scion-multiping-0.1.0-shaded.jar [tool-command]
+```
+
+Some tools require configuration files, see below in the tool description sections.   
+See also the troubleshooting section below in case of issues.
 
-# `EchoAll`
+# Download Assignments
 
-The tool parses [Anapayas ISD/AS assignment website](https://docs.anapaya.net/en/latest/resources/isd-as-assignments/),
+The tool
+parses [Anapayas ISD/AS assignment website](https://docs.anapaya.net/en/latest/resources/isd-as-assignments/)
+and writes the result to a local file `isd-as-assignments.csv`.
+Note: the `isd-as-assignments.csv` output file can be directly used as input file for the PingRepeat
+
+# Ping All
+
+The tool
+parses [Anapayas ISD/AS assignment website](https://docs.anapaya.net/en/latest/resources/isd-as-assignments/),
 identifies the shortest path to each AS and sends a traceroute to each AS.
-It reports the number of paths to each AS as well as the shortest path with latency, remote IP, hop count and remote IP.
+It reports the number of paths to each AS as well as the shortest path with latency, remote IP, hop
+count and remote IP.
 
 It also provides a summary of its findings.
 
-# `EchoRepeat`
+# Ping Repeat
 
-The tool reads a list if ISD/AS codes from a csv file (`isdAsFile`), repeatedly sends traceroute
-SCMP requests to each AS and writes the results to an output file (`outputFile`).
+The tool reads a list if ISD/AS codes from a csv file (
+`isdAsInputFile`, [example](/ping-repeat-destinations.json)), repeatedly sends
+traceroute
+SCMP requests to each AS and writes the results to an output file (
+`outputFile`, [example](/ping-repeat-output.csv)).
 
 SCMP request are sent in several rounds, each round consisting of several attempts.
 In the default configuration (see below) it will:
@@ -41,7 +62,9 @@ In the default configuration (see below) it will:
 
 ## Configuration
 
-The tool uses a configuration file `EchoRepeatConfig.json` that can contain the following arguments:
+The tool uses a configuration file `ping-repeat-config.json` ([example](/ping-repeat-config.json))
+that can contain the following
+arguments:
 
 ```json
 {
@@ -51,42 +74,37 @@ The tool uses a configuration file `EchoRepeatConfig.json` that can contain the
   "roundDelaySec": 600,
   "maxPathsPerDestination": 20,
   "tryICMP": false,
-  "isdAsFile": "EchoRepeatDestinations-short.csv",
-  "outputFile": "EchoOutput.csv",
+  "isdAsInputFile": "ping-repeat-destinations.csv",
+  "outputFile": "ping-repeat-output.csv",
   "localPort": 30041,
   "consoleOutput": true
 }
 ```
 
 ## Input
 
-The input file is a csv file with ISD/AS, label and IP (optional). The ISD/AS can optionally be enclosed in `"`.
-When an IP is given then the tool will execute an `echo` requerst to the IP, otherwise it will execute a `traceroute` request to the border router of the destination AS. Example:
+The input file is a csv file with ISD/AS, label and IP (optional). The ISD/AS can optionally be
+enclosed in `"`.
+When an IP is given then the tool will execute an `echo` request to the IP, otherwise it will
+execute a `traceroute` request to the border router of the destination
+AS. [Example](/ping-repeat-destinations.csv):
 
 ```
 64-2:0:9,"ETH Zurich (ETHZ)"
 "64-2:0:4c","AWS PoC Anapaya",192.168.0.1
 ```
 
-This will result in a traceroute request to th ETH border router of `64-2:0:9` and a echo request
-to `64-2:0:4c,192.168.0.1 `.
+This will result in a `traceroute` request to th ETH border router of `64-2:0:9` and a `echo`
+request to `64-2:0:4c,192.168.0.1`.
 
 ## Execution
 
-To run, the tool requires a configuration file (see above or [here](/EchoRepeatConfig.json)) and an input file
-(see [here](/EchoRepeatDestinations-short.csv)).
-
-An executable jar file is available in
-the [GitHub Releases section](https://github.com/netsec-ethz/scion-java-multiping/releases/download/v0.1.0/scion-multiping-0.1.0-shaded.jar).
-It can be executed
-with:
+THe tool can be executed with:
 
 ```
-java -jar scion-multiping-0.1.0-shaded.jar
+java -jar scion-multiping-0.1.0-shaded.jar ping-repeat
 ```
 
-See also the troubleshooting section below in case of issues.
-
 ## Output
 
 The output file is a csv file with one row per round/path.
@@ -117,9 +135,10 @@ This shows a LOCAL_AS and a NO_PATH event:
 71-2:0:4a,,2024-09-13T15:46:16.554705200Z,NO_PATH,0,[]
 ```
 
-# `EchoResponder`
+# Ping Responder
 
-The `EchoResponder` can be configured with a configuration file `EchoResponderConfig.json`, it has two options:
+The `PingResponder` can be configured with a configuration file `ping-responder-config.json`, it has
+two options:
 
 ```json
 {
@@ -132,9 +151,10 @@ The `EchoResponder` can be configured with a configuration file `EchoResponderCo
 
 ## No DNS search domain found. Please check your /etc/resolv.conf or similar.
 
-This happens, for example, on Windows when using a VPN. One solution is to execute the jar with the following property (
+This happens, for example, on Windows when using a VPN. One solution is to execute the jar with the
+following property (
 the example works only for `ethz.ch`):
 
 ```
-java -Dorg.scion.dnsSearchDomains=ethz.ch. -jar target/scion-multiping-0.0.1-ALPHA-SNAPSHOT-shaded.jar
+java -Dorg.scion.dnsSearchDomains=ethz.ch. -jar target/scion-multiping-0.1.0-shaded.jar
 ```

EchoRepeatOutput.csv

@@ -37,7 +37,6 @@
 64-2:0:2c,"Armasuisse Thun"
 64-2:0:2d,"Armasuisse Lausanne"
 64-2:0:30,"AWK Group AG"
-64-2:0:34,"BNC"
 64-2:0:36,"RUAG"
 64-2:0:37,"UBS"
 64-2:0:38,"UBS"
@@ -63,8 +62,9 @@
 64-2:0:70,"Anapaya Azure Test AS"
 64-2:0:74,"Anapaya Germany GATE Service from Switzerland"
 64-2:0:75,"Anapaya France GATE Service from Switzerland"
-64-2:0:81,"SUVA"
+64-2:0:81,"SUVA Lugano"
 64-2:0:82,"Anapaya GlobalConnect from Switzerland"
+64-2:0:83,"SUVA Luzern"
 65-0:0:e26d,"International Committee of the Red Cross"
 65-2:0:f,"Anapaya CONNECT Frankfurt"
 65-2:0:13,"Anapaya Zurich"
@@ -114,6 +114,7 @@
 71-0:0:9f2,"NCSR Demokritos SCION AS"
 71-0:0:103e,"City University of Hong Kong (CityUHK)"
 71-0:0:51e5,"GEANT"
+71-0:3:1a2f,"NATO Cooperative Cyber Defence Centre of Excellence (CCDCoE)"
 71-2:0:35,"BRIDGES"
 71-2:0:3b,"KREONET Seoul"
 71-2:0:3c,"KREONET Hong Kong"

README.md

@@ -5,6 +5,6 @@
   "roundDelaySec": 600,
   "maxPathsPerDestination": 20,
   "tryICMP": false,
-  "isdAsFile": "EchoRepeatDestinations-short.csv",
-  "outputFile": "EchoRepeatOutput.csv"
+  "isdAsInputFile": "ping-repeat-destinations.csv",
+  "outputFile": "ping-repeat-output.csv"
 }