Make lcl cli be able to bind to device and various improvements (#1)

Author: johnnzhou

Package.swift

@@ -9,31 +9,29 @@ let package = Package(
         .macOS(.v11)
     ],
     dependencies: [
-        .package(url: "https://github.com/Local-Connectivity-Lab/lcl-ping.git", from: "1.0.0"),
+        .package(url: "https://github.com/Local-Connectivity-Lab/lcl-ping.git", from: "1.0.3"),
         .package(url: "https://github.com/apple/swift-argument-parser.git", from: "1.2.3"),
-        .package(url: "https://github.com/jpsim/Yams.git", from: "5.0.6"),
         .package(url: "https://github.com/scottrhoyt/SwiftyTextTable.git", from: "0.9.0"),
-        .package(url: "https://github.com/johnnzhou/lcl-auth.git", branch: "main"),
-        .package(url: "https://github.com/apple/swift-nio.git", from: "2.63.0"),
+        .package(url: "https://github.com/Local-Connectivity-Lab/lcl-auth.git", branch: "main"),
+        .package(url: "https://github.com/apple/swift-nio.git", from: "2.73.0"),
         .package(url: "https://github.com/apple/swift-nio-ssl.git", from: "2.25.0"),
-        .package(url: "https://github.com/johnnzhou/lcl-speedtest.git", branch: "main"),
-        .package(url: "https://github.com/pakLebah/ANSITerminal", from: "0.0.3")
+        .package(url: "https://github.com/Local-Connectivity-Lab/lcl-speedtest.git", from: "1.0.4"),
+        .package(url: "https://github.com/johnnzhou/ANSITerminal.git", from: "0.0.4"),
     ],
     targets: [
         .executableTarget(
             name: "lcl",
             dependencies: [
                 .product(name: "ArgumentParser", package: "swift-argument-parser"),
                 .product(name: "LCLPing", package: "lcl-ping"),
-                .product(name: "Yams", package: "Yams"),
                 .product(name: "SwiftyTextTable", package: "SwiftyTextTable"),
                 .product(name: "LCLAuth", package: "lcl-auth"),
                 .product(name: "NIO", package: "swift-nio"),
                 .product(name: "NIOPosix", package: "swift-nio"),
                 .product(name: "NIOCore", package: "swift-nio"),
                 .product(name: "NIOHTTP1", package: "swift-nio"),
                 .product(name: "NIOSSL", package: "swift-nio-ssl"),
-                .product(name: "LCLSpeedTest", package: "lcl-speedtest"),
+                .product(name: "LCLSpeedtest", package: "lcl-speedtest"),
                 .product(name: "ANSITerminal", package: "ANSITerminal")
             ],
             path: "Sources")

README.md

@@ -3,4 +3,42 @@
 </div>
 
 ---
-# lcl CLI
+# LCL CLI
+LCL CLI is a cross-platform cli tool written in Swift. It is designed to measure the network performance and latency through LCL's cellular network measurement testbed. While this tool is design for Local Connectivity Lab researchers and Seattle Community Network volunteers and users, everyone is welcome to use this tool to measure their network performance.
+
+## Usage
+
+```
+OVERVIEW: A command-line tool from Local Connectivity Lab @UWCSE
+
+USAGE: lcl <subcommand>
+
+OPTIONS:
+  -h, --help              Show help information.
+
+SUBCOMMANDS:
+  register                Register with SCN server to report test data.
+  ping                    Run Ping Latency and Reachability Test.
+  speedtest               Run speedtest using the NDT test infrastructure.
+  measure                 Run SCN test suite and optionally report the measurement result to SCN.
+  interfaces              List available network interfaces on the machine.
+  cellular-sites          Get info on SCN cellular sites
+
+  See 'lcl help <subcommand>' for detailed help.
+``` 
+
+## Features
+- ICMP and HTTP test with `Server-Timing` support.
+- Speedtest on top of NDT7 protocol with TCP-level and Application-level measurement
+- Automatically upload test result to SCN's backend server (this option is available to SCN users and volunteers).
+- Check available interfaces on the machine.
+
+## Platform Support
+LCL CLI is designed to support various platforms that Swift supports, including Linux (Debian and Ubuntu), macOS. Those who are interested in other platforms can download and compile the binary from the source. 
+
+
+## Contributing
+Any contribution and pull requests are welcome! However, before you plan to implement some features or try to fix an uncertain issue, it is recommended to open a discussion first. You can also join our [Discord channel](https://discord.com/invite/gn4DKF83bP), or visit our [website](https://seattlecommunitynetwork.org/).
+
+## License
+LCL CLI is released under Apache License. See [LICENSE](/LICENSE) for more details.

Sources/Command/Interfaces.swift

@@ -11,7 +11,7 @@
 //
 
 import ArgumentParser
-import LCLPing
+import NIOCore
 
 struct NetworkInterfaceCommand: AsyncParsableCommand {
     static var configuration: CommandConfiguration = CommandConfiguration(
@@ -24,7 +24,7 @@ struct NetworkInterfaceCommand: AsyncParsableCommand {
         for interface in availableInterfaces {
             let sortedHostNames = interface.value.sorted()
             let interfaceName = interface.key
-            print("\(interfaceName)      \(sortedHostNames)")
+            print("\(interfaceName)\t\(sortedHostNames)")
         }
     }
 }

Sources/Command/Measure.swift

@@ -15,10 +15,14 @@ import ArgumentParser
 import LCLPing
 import LCLAuth
 import Crypto
+import LCLSpeedtest
 
 extension LCLCLI {
     struct MeasureCommand: AsyncParsableCommand {
 
+        @Option(name: .long, help: "Specify the device name to which the data will be sent.")
+        var deviceName: String?
+
         @Option(name: .shortAndLong, help: "Show datapoint on SCN's public visualization. Your contribution will help others better understand our coverage.")
         var showData: Bool = false
 
@@ -36,6 +40,7 @@ extension LCLCLI {
             let result: Result<[CellularSite]?, CLIError> = await NetworkingAPI.get(from: NetworkingAPI.Endpoint.site.url)
             switch result {
             case .failure(let error):
+
                 throw error
             case .success(let cs):
                 if let s = cs {
@@ -47,24 +52,16 @@ extension LCLCLI {
             }
             var picker = Picker<CellularSite>(title: "Choose the cellular site you are currently at.", options: sites)
 
-            let homeURL = FileIO.default.home.appendingPathComponent(".lcl")
+            let homeURL = FileIO.default.home.appendingPathComponent(Constants.cliDirectory)
             let skURL = homeURL.appendingPathComponent("sk")
             let sigURL = homeURL.appendingPathComponent("sig")
             let rURL = homeURL.appendingPathComponent("r")
             let hpkrURL = homeURL.appendingPathComponent("hpkr")
-            let keyURL = homeURL.appendingPathComponent("key")
-            let keyData = try loadData(keyURL)
-
-            let symmetricKeyRecovered = SymmetricKey(data: keyData)
-
-            let skDataEncrypted = try loadData(skURL)
-            let skData = try decrypt(cipher: skDataEncrypted, key: symmetricKeyRecovered)
-            let sigDataEncrypted = try loadData(sigURL)
-            let sigData = try decrypt(cipher: sigDataEncrypted, key: symmetricKeyRecovered)
-            let rDataEncrypted = try loadData(rURL)
-            let rData = try decrypt(cipher: rDataEncrypted, key: symmetricKeyRecovered)
-            let hpkrDataEncrypted = try loadData(hpkrURL)
-            let hpkrData = try decrypt(cipher: hpkrDataEncrypted, key: symmetricKeyRecovered)
+
+            let skData = try loadData(skURL)
+            let sigData = try loadData(sigURL)
+            let rData = try loadData(rURL)
+            let hpkrData = try loadData(hpkrURL)
             let validationResultJSON = try encoder.encode(ValidationResult(R: rData, skT: skData, hPKR: hpkrData))
 
             let ecPrivateKey = try ECDSA.deserializePrivateKey(raw: skData)
@@ -73,7 +70,7 @@ extension LCLCLI {
                 throw CLIError.contentCorrupted
             }
 
-            let pingConfig = try ICMPPingClient.Configuration(endpoint: .ipv4("google.com", 0))
+            let pingConfig = try ICMPPingClient.Configuration(endpoint: .ipv4("google.com", 0), deviceName: deviceName)
             let outputFormats: Set<OutputFormat> = [.default]
 
             let client = ICMPPingClient(configuration: pingConfig)
@@ -98,9 +95,12 @@ extension LCLCLI {
 
             let summary = try await client.start().get()
 
-            let speedTestResults = try await speedTest.run()
-            let downloadSummary = prepareSpeedTestSummary(data: speedTestResults.download, unit: .Mbps)
-            let uploadSummary = prepareSpeedTestSummary(data: speedTestResults.upload, unit: .Mbps)
+            let speedTestResults = try await speedTest.run(deviceName: deviceName)
+            let downloadMeasurement = computeLatencyAndRetransmission(speedTestResults.downloadTCPMeasurement, for: .download)
+            let uploadMeasurement = computeLatencyAndRetransmission(speedTestResults.uploadTCPMeasurement, for: .upload)
+
+            let downloadSummary = prepareSpeedTestSummary(data: speedTestResults.downloadSpeed, tcpInfos: speedTestResults.downloadTCPMeasurement, for: .download, unit: .Mbps)
+            let uploadSummary = prepareSpeedTestSummary(data: speedTestResults.uploadSpeed, tcpInfos: speedTestResults.uploadTCPMeasurement, for: .upload, unit: .Mbps)
 
             generatePingSummary(summary, for: .icmp, formats: outputFormats)
             generateSpeedTestSummary(downloadSummary, kind: .download, formats: outputFormats, unit: .Mbps)
@@ -116,10 +116,10 @@ extension LCLCLI {
                     uploadSpeed: uploadSummary.avg,
                     latitude: selectedSite.latitude,
                     longitude: selectedSite.longitude,
-                    packetLoss: Double(summary.timeout.count) / Double(summary.totalCount),
-                    ping: summary.avg,
+                    packetLoss: (downloadMeasurement.retransmit + uploadMeasurement.retransmit) / 2,
+                    ping: (downloadMeasurement.latency + uploadMeasurement.latency) / 2,
                     timestamp: Date.getCurrentTime(),
-                    jitter: summary.jitter
+                    jitter: (downloadMeasurement.variance + uploadMeasurement.variance) / 2
                 )
                 let serialized = try encoder.encode(report)
                 let sig_m = try ECDSA.sign(message: serialized, privateKey: ECDSA.deserializePrivateKey(raw: skData))

Sources/Command/PingCommand.swift

@@ -49,9 +49,6 @@ extension LCLCLI {
         @Flag(help: "Export the Ping result in JSON format.")
         var json: Bool = false
 
-        @Flag(help: "Export the Ping result in YAML format.")
-        var yaml: Bool = false
-
         static var configuration: CommandConfiguration = CommandConfiguration(
             commandName: "icmp",
             abstract: "Run ICMP Ping Latency and Reachability Test."
@@ -78,10 +75,6 @@ extension LCLCLI {
                     outputFormats.insert(.json)
                 }
 
-                if yaml {
-                    outputFormats.insert(.yaml)
-                }
-
                 if outputFormats.isEmpty {
                     outputFormats.insert(.default)
                 }
@@ -131,19 +124,19 @@ extension LCLCLI {
         @Flag(help: "Use URLSession on Apple platform for underlying networking and measurement. This flag has no effect on Linux platform.")
         var useURLSession: Bool = false
 
+        @Option(name: .long, help: "Specify the device name to which the data will be sent.")
+        var deviceName: String?
+
         @Flag(help: "Export the Ping result in JSON format.")
         var json: Bool = false
 
-        @Flag(help: "Export the Ping result in YAML format.")
-        var yaml: Bool = false
-
         static var configuration: CommandConfiguration = CommandConfiguration(
             commandName: "http",
             abstract: "Run ICMP Ping Latency and Reachability Test."
         )
 
         func run() throws {
-            var config = try HTTPPingClient.Configuration(url: url)
+            var config = try HTTPPingClient.Configuration(url: url, deviceName: deviceName)
             if let count = count {
                 config.count = Int(count)
             }
@@ -177,10 +170,6 @@ extension LCLCLI {
                 outputFormats.insert(.json)
             }
 
-            if yaml {
-                outputFormats.insert(.yaml)
-            }
-
             if outputFormats.isEmpty {
                 outputFormats.insert(.default)
             }

Sources/Command/RegisterCommand.swift

@@ -21,16 +21,15 @@ extension LCLCLI {
         @Option(name: .shortAndLong, help: "Path to the SCN credential file given by the SCN administrator.")
         var filePath: String
 
-        static let configuration = CommandConfiguration(
-                                                            commandName: "register",
-                                                            abstract: "Register with SCN server to report test data."
-                                                        )
+        static let configuration = CommandConfiguration(commandName: "register",
+                                                        abstract: "Register with SCN server to report test data.")
 
         func run() async throws {
             guard let filePathURL = URL(string: filePath), let credentialCode = try FileIO.default.loadFrom(filePathURL) else {
                 throw CLIError.failedToReadFile("Fail to read content from path '\(filePath)'. Exit.")
             }
-            let homeURL = FileIO.default.home.appendingPathComponent(".lcl")
+            
+            let homeURL = FileIO.default.home.appendingPathComponent(Constants.cliDirectory)
             let skURL = homeURL.appendingPathComponent("sk")
             let sigURL = homeURL.appendingPathComponent("sig")
             let rURL = homeURL.appendingPathComponent("r")
@@ -79,14 +78,14 @@ extension LCLCLI {
             let sk_t = try ECDSA.deserializePrivateKey(raw: validationResult.skT)
             let pk_t = ECDSA.derivePublicKey(from: sk_t)
             outputData.append(pk_t.derRepresentation)
-            let h_sec = digest(data: outputData, algorithm: .SHA256)
+            var h_sec = digest(data: outputData, algorithm: .SHA256)
             outputData.removeAll()
             outputData.append(validationResult.hPKR)
             outputData.append(h_sec)
-            let h_concat = Data(outputData)
-            let sigma_r = try ECDSA.sign(message: h_concat, privateKey: sk_t)
+            var h_concat = Data(outputData)
+            var sigma_r = try ECDSA.sign(message: h_concat, privateKey: sk_t)
             let registration = RegistrationModel(sigmaR: sigma_r.hex, h: h_concat.hex, R: validationResult.R.hex)
-            let registrationJson = try encoder.encode(registration)
+            var registrationJson = try encoder.encode(registration)
             switch await NetworkingAPI.send(to: NetworkingAPI.Endpoint.register.url, using: registrationJson) {
             case .success:
                 print("Registration complete!")
@@ -97,24 +96,18 @@ extension LCLCLI {
             let validationJson = try encoder.encode(validationResult)
             let privateKey = try ECDSA.deserializePrivateKey(raw: validationResult.skT)
             let signature = try ECDSA.sign(message: validationJson, privateKey: privateKey)
-
-            let symmetricKey = SymmetricKey(size: .bits256)
-            try encryptAndWriteData(validationResult.R, to: rURL, using: symmetricKey)
-            try encryptAndWriteData(validationResult.hPKR, to: hpkrURL, using: symmetricKey)
-            try encryptAndWriteData(validationResult.skT, to: skURL, using: symmetricKey)
-            try encryptAndWriteData(signature, to: sigURL, using: symmetricKey)
-
-            let symmetricKeyData = symmetricKey.withUnsafeBytes { pointer in
-                return Data(pointer)
-            }
-
-            try FileIO.default.write(data: symmetricKeyData, to: keyURL)
-        }
-
-        private func encryptAndWriteData(_ data: Data, to fileURL: URL, using key: SymmetricKey) throws {
-            var encrypted = try LCLAuth.encrypt(plainText: data, key: key)
-            try FileIO.default.write(data: encrypted, to: fileURL)
-            encrypted.removeAll()
+            
+            try FileIO.default.write(data: validationResult.R, to: rURL)
+            try FileIO.default.write(data: validationResult.hPKR, to: hpkrURL)
+            try FileIO.default.write(data: validationResult.skT, to: skURL)
+            try FileIO.default.write(data: signature, to: sigURL)
+            
+            // cleanup
+            outputData.removeAll()
+            h_concat.removeAll()
+            sigma_r.removeAll()
+            h_sec.removeAll()
+            registrationJson.removeAll()
         }
     }
 }

Sources/Command/SpeedTestCommand.swift

@@ -12,7 +12,7 @@
 
 import Foundation
 import ArgumentParser
-import LCLSpeedTest
+import LCLSpeedtest
 
 extension LCLCLI {
     struct SpeedTestCommand: AsyncParsableCommand {
@@ -23,12 +23,12 @@ extension LCLCLI {
         @Option(name: .shortAndLong, help: "Specify the direction of the test. A test can be of three types: download, upload or downloadAndUpload")
         var type: TestType
 
+        @Option(name: .long, help: "Specify the device name to which the data will be sent.")
+        var deviceName: String?
+
         @Flag(help: "Export the Speed Test result in JSON format.")
         var json: Bool = false
 
-        @Flag(help: "Export the Speed Test result in YAML format.")
-        var yaml: Bool = false
-
         static let configuration = CommandConfiguration(commandName: "speedtest", abstract: "Run speedtest using the NDT test infrastructure.")
 
         func run() async throws {
@@ -47,27 +47,23 @@ extension LCLCLI {
             signal(SIGINT, SIG_IGN)
             let stopSignal = DispatchSource.makeSignalSource(signal: SIGINT, queue: .main)
             stopSignal.setEventHandler {
-                print("Exit from Speed Test")
+                print("Exit from Speedtest")
                 speedTest.stop()
                 return
             }
 
             stopSignal.resume()
 
-            let speedTestResults = try await speedTest.run()
+            let speedTestResults = try await speedTest.run(deviceName: deviceName)
 
-            let downloadSummary = prepareSpeedTestSummary(data: speedTestResults.download, unit: speedTestUnit)
-            let uploadSummary = prepareSpeedTestSummary(data: speedTestResults.upload, unit: speedTestUnit)
+            let downloadSummary = prepareSpeedTestSummary(data: speedTestResults.downloadSpeed, tcpInfos: speedTestResults.downloadTCPMeasurement, for: .download, unit: speedTestUnit)
+            let uploadSummary = prepareSpeedTestSummary(data: speedTestResults.uploadSpeed, tcpInfos: speedTestResults.uploadTCPMeasurement, for: .upload, unit: speedTestUnit)
 
             var outputFormats: Set<OutputFormat> = []
             if json {
                 outputFormats.insert(.json)
             }
 
-            if yaml {
-                outputFormats.insert(.yaml)
-            }
-
             if outputFormats.isEmpty {
                 outputFormats.insert(.default)
             }