Merge branch 'main' of https://github.com/OperatorFoundation/CanaryiOS

Author: bragelbytes

CanaryiOS/CanaryiOS.xcodeproj/project.pbxproj

@@ -24,14 +24,14 @@
 /* End PBXBuildFile section */
 
 /* Begin PBXCopyFilesBuildPhase section */
-		E15FA8A1288748BC002E5E04 /* Embed App Extensions */ = {
+		E15FA8A1288748BC002E5E04 /* Embed Foundation Extensions */ = {
 			isa = PBXCopyFilesBuildPhase;
 			buildActionMask = 2147483647;
 			dstPath = "";
 			dstSubfolderSpec = 13;
 			files = (
 			);
-			name = "Embed App Extensions";
+			name = "Embed Foundation Extensions";
 			runOnlyForDeploymentPostprocessing = 0;
 		};
 /* End PBXCopyFilesBuildPhase section */
@@ -137,7 +137,7 @@
 				E19C17142835826100B29794 /* Sources */,
 				E19C17152835826100B29794 /* Frameworks */,
 				E19C17162835826100B29794 /* Resources */,
-				E15FA8A1288748BC002E5E04 /* Embed App Extensions */,
+				E15FA8A1288748BC002E5E04 /* Embed Foundation Extensions */,
 			);
 			buildRules = (
 			);
@@ -161,7 +161,7 @@
 			attributes = {
 				BuildIndependentTargetsInParallel = 1;
 				LastSwiftUpdateCheck = 1340;
-				LastUpgradeCheck = 1340;
+				LastUpgradeCheck = 1400;
 				TargetAttributes = {
 					E19C17172835826100B29794 = {
 						CreatedOnToolsVersion = 13.4;

CanaryiOS/CanaryiOS.xcodeproj/xcshareddata/xcschemes/CanaryiOS.xcscheme

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1340"
+   LastUpgradeVersion = "1400"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"

CanaryiOS/CanaryiOS/Models/CanaryResults.swift

@@ -38,6 +38,8 @@ struct ResultDocument: Transferable
     }
 }
 
+
+// MARK: In an actual app you should not use this to display results as the backing library could change the way the results file is formatted in the future which would break this struct and any views using it to display results.
 struct Results: Identifiable
 {
     let id: UUID

readme.md

@@ -1,3 +1,23 @@
+# CanaryiOS
+
+An iOS library designed to power iOS apps. Based on the [original project](https://github.com/OperatorFoundation/CanaryLibrary.git) written in Swift.
+
+Canary is a tool for testing transport connections and gathering the packets for analysis.
+
+Canary will run a series of transport tests based on the configs that you provide. It is possible to test each transport on a different transport server based on what host information is provided in the transport config files.
+
+Currently only [Shadow](https://github.com/OperatorFoundation/ShapeshifterAndroidKotlin.git) tests are supported. Replicant support is underway, and will be capable of mimicking other transports when it is complete.
+
+## Generate Shadow config files
+-Go to: [ShadowSwift](https://github.com/OperatorFoundation/ShadowSwift.git).
+
+## Running Canary
+- Transport configs should include their transport server IP and port, and should include the transport name in the name of the file.
+- Canary client config files must be saved in the file management system of the device. Config files must conform to the following convention:
+
+{"serverIP":"127.0.0.1","password":"enterYourClientConfigPassword","cipherName":"DarkStar","port":1234}
+
+-Once configured, Canary iOS allows users to run tests, view results, and share results.
 
 Dependencies:
 https://github.com/marmelroy/FileBrowser