Adding Remote Access (#305)

Author: leogdion

Sources/BushelHarvestCore/CommandPayload.swift

@@ -0,0 +1,46 @@
+//
+//  CommandPayload.swift
+//  BushelKit
+//
+//  Created by Leo Dion.
+//  Copyright © 2024 BrightDigit.
+//
+//  Permission is hereby granted, free of charge, to any person
+//  obtaining a copy of this software and associated documentation
+//  files (the "Software"), to deal in the Software without
+//  restriction, including without limitation the rights to use,
+//  copy, modify, merge, publish, distribute, sublicense, and/or
+//  sell copies of the Software, and to permit persons to whom the
+//  Software is furnished to do so, subject to the following
+//  conditions:
+//
+//  The above copyright notice and this permission notice shall be
+//  included in all copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+//  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+//  OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+//  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+//  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+//  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+//  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+//  OTHER DEALINGS IN THE SOFTWARE.
+//
+
+public import Foundation
+
+/// Command payload types
+public enum CommandPayload: Codable, Sendable {
+  /// System command payload
+  case system(SystemCommand)
+  /// Remote access command payload
+  case remote(RemoteAccessCommand)
+  /// Security command payload
+  case security(SecurityCommand)
+  /// File operation payload (placeholder for future use)
+  case file(String)
+  /// Network operation payload (placeholder for future use)
+  case network(String)
+  /// Clipboard operation payload (placeholder for future use)
+  case clipboard(String)
+}

Sources/BushelHarvestCore/CommandProtocol.swift

@@ -88,6 +88,7 @@ public protocol HarvestCommandProtocol: Codable, Sendable {
 /// - `.network` - Network operations like connection management and data transfer
 /// - `.clipboard` - Clipboard operations for copy/paste functionality between host and guest
 /// - `.remote` - Remote debugging and development tools operations
+/// - `.security` - Security operations like authentication, authorization, and access control
 public enum CommandCategory: String, Codable, Sendable {
   /// System-level operations (shutdown, status, configuration, etc.)
   case system
@@ -103,4 +104,7 @@ public enum CommandCategory: String, Codable, Sendable {
 
   /// Remote debugging and development operations (SSH, debugging tools, etc.)
   case remote
+  
+  /// Security operations (authentication, authorization, access control, etc.)
+  case security
 }

Sources/BushelHarvestCore/HarvestCommand.swift

@@ -33,18 +33,15 @@ public import Foundation
 ///
 /// Represents a concrete command that can be executed as part of the Harvest
 /// protocol. This is the standard implementation of `HarvestCommandProtocol`
-/// that provides basic command functionality with an ID and category.
+/// that provides complete command functionality with ID, category, payload, and metadata.
 ///
 /// ## Usage
 /// ```swift
-/// // Create a system command
-/// let systemCommand = HarvestCommand(category: .system)
+/// // Create a system ping command
+/// let pingCommand = HarvestCommand.system(.ping)
 ///
-/// // Create a file command with custom ID
-/// let fileCommand = HarvestCommand(
-///   id: UUID(),
-///   category: .file
-/// )
+/// // Create an SSH enable command  
+/// let sshCommand = HarvestCommand.remote(.ssh(.enable))
 /// ```
 ///
 /// ## Command Categories
@@ -54,6 +51,7 @@ public import Foundation
 /// - `.network` - Network operations (connect, transfer, etc.)
 /// - `.clipboard` - Clipboard operations (copy, paste, etc.)
 /// - `.remote` - Remote debugging and development operations
+/// - `.security` - Security operations (authentication, authorization, etc.)
 ///
 /// For custom command implementations, consider extending `HarvestCommandProtocol`
 /// directly rather than subclassing this struct.
@@ -66,17 +64,144 @@ public struct HarvestCommand: HarvestCommandProtocol {
 
   /// Category that this command belongs to
   ///
-  /// Used for organizing commands and potentially implementing
+  /// Used for organizing commands and implementing
   /// category-specific authorization or routing logic.
   public let category: CommandCategory
+  
+  /// Command payload containing the specific command data
+  public let payload: CommandPayload
+  
+  /// Target machine identifier (optional)
+  public let machineID: UInt64?
+  
+  /// Timestamp when the command was created
+  public let timestamp: Date
+  
+  /// Command version for compatibility checking
+  public let version: Int
+  
+  /// Additional metadata for command processing
+  public var metadata: [String: String]?
+  
+  /// Human-readable name of the command
+  public var name: String {
+    switch payload {
+    case .system(let systemCmd):
+      switch systemCmd {
+      case .ping: return "system.ping"
+      case .status: return "system.status" 
+      case .shutdown: return "system.shutdown"
+      case .restart: return "system.restart"
+      }
+    case .remote(let remoteCmd):
+      switch remoteCmd {
+      case .ssh(let sshCmd):
+        switch sshCmd {
+        case .enable: return "remote.ssh.enable"
+        case .disable: return "remote.ssh.disable"
+        case .status: return "remote.ssh.status"
+        }
+      case .status: return "remote.status"
+      }
+    case .security(let securityCmd):
+      switch securityCmd {
+      case .authenticate: return "security.authenticate"
+      case .authorize: return "security.authorize"
+      case .status: return "security.status"
+      }
+    case .file: return "file.operation"
+    case .network: return "network.operation"
+    case .clipboard: return "clipboard.operation"
+    }
+  }
 
   /// Creates a new Harvest command
   ///
   /// - Parameters:
   ///   - id: Unique identifier for the command. Defaults to a new UUID.
   ///   - category: The category this command belongs to
-  public init(id: UUID = UUID(), category: CommandCategory) {
+  ///   - payload: The command payload data
+  ///   - machineID: Optional target machine identifier
+  ///   - timestamp: Creation timestamp. Defaults to current time.
+  ///   - version: Command version for compatibility checking. Defaults to 1.
+  ///   - metadata: Additional metadata for command processing. Defaults to nil.
+  public init(
+    id: UUID = UUID(),
+    category: CommandCategory,
+    payload: CommandPayload,
+    machineID: UInt64? = nil,
+    timestamp: Date = Date(),
+    version: Int = 1,
+    metadata: [String: String]? = nil
+  ) {
     self.id = id
     self.category = category
+    self.payload = payload
+    self.machineID = machineID
+    self.timestamp = timestamp
+    self.version = version
+    self.metadata = metadata
+  }
+  
+  // MARK: - Static Factory Methods
+  
+  /// Creates a system command
+  /// - Parameter command: The system command to create
+  /// - Returns: A new HarvestCommand with system category
+  public static func system(_ command: SystemCommand) -> HarvestCommand {
+    return HarvestCommand(
+      category: .system,
+      payload: .system(command)
+    )
+  }
+  
+  /// Creates a remote access command
+  /// - Parameter command: The remote access command to create
+  /// - Returns: A new HarvestCommand with remote category
+  public static func remote(_ command: RemoteAccessCommand) -> HarvestCommand {
+    return HarvestCommand(
+      category: .remote,
+      payload: .remote(command)
+    )
+  }
+  
+  /// Creates a security command
+  /// - Parameter command: The security command to create
+  /// - Returns: A new HarvestCommand with security category
+  public static func security(_ command: SecurityCommand) -> HarvestCommand {
+    return HarvestCommand(
+      category: .security,
+      payload: .security(command)
+    )
+  }
+  
+  /// Creates a file operation command
+  /// - Parameter operation: The file operation description
+  /// - Returns: A new HarvestCommand with file category
+  public static func file(_ operation: String) -> HarvestCommand {
+    return HarvestCommand(
+      category: .file,
+      payload: .file(operation)
+    )
+  }
+  
+  /// Creates a network operation command
+  /// - Parameter operation: The network operation description
+  /// - Returns: A new HarvestCommand with network category
+  public static func network(_ operation: String) -> HarvestCommand {
+    return HarvestCommand(
+      category: .network,
+      payload: .network(operation)
+    )
+  }
+  
+  /// Creates a clipboard operation command
+  /// - Parameter operation: The clipboard operation description
+  /// - Returns: A new HarvestCommand with clipboard category
+  public static func clipboard(_ operation: String) -> HarvestCommand {
+    return HarvestCommand(
+      category: .clipboard,
+      payload: .clipboard(operation)
+    )
   }
-}
+}

Sources/BushelHarvestCore/HarvestResponse.swift

@@ -78,15 +78,20 @@ public struct HarvestResponse: Codable, Sendable {
   /// structure with additional error fields in future iterations.
   public let success: Bool
 
+  /// Response payload containing the result data
+  public let payload: ResponsePayload?
+
   /// Creates a new Harvest response
   ///
   /// - Parameters:
   ///   - requestId: The ID of the request this response corresponds to
   ///   - timestamp: When the response was created. Defaults to current time.
   ///   - success: Whether the request processing was successful
-  public init(requestId: UUID, timestamp: Date = Date(), success: Bool) {
+  ///   - payload: Optional response payload data
+  public init(requestId: UUID, timestamp: Date = Date(), success: Bool, payload: ResponsePayload? = nil) {
     self.requestId = requestId
     self.timestamp = timestamp
     self.success = success
+    self.payload = payload
   }
 }

Sources/BushelHarvestCore/RemoteAccess.swift

@@ -0,0 +1,39 @@
+//
+//  RemoteAccess.swift
+//  BushelKit
+//
+//  Created by Leo Dion.
+//  Copyright © 2024 BrightDigit.
+//
+//  Permission is hereby granted, free of charge, to any person
+//  obtaining a copy of this software and associated documentation
+//  files (the "Software"), to deal in the Software without
+//  restriction, including without limitation the rights to use,
+//  copy, modify, merge, publish, distribute, sublicense, and/or
+//  sell copies of the Software, and to permit persons to whom the
+//  Software is furnished to do so, subject to the following
+//  conditions:
+//
+//  The above copyright notice and this permission notice shall be
+//  included in all copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+//  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+//  OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+//  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+//  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+//  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+//  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+//  OTHER DEALINGS IN THE SOFTWARE.
+//
+
+public import Foundation
+
+/// Remote access information
+public struct RemoteAccess: Codable, Sendable {
+  public let ssh: SSHStatus
+
+  public init(ssh: SSHStatus) {
+    self.ssh = ssh
+  }
+}

Sources/BushelHarvestCore/RemoteAccessCommand.swift

@@ -0,0 +1,38 @@
+//
+//  RemoteAccessCommand.swift
+//  BushelKit
+//
+//  Created by Leo Dion.
+//  Copyright © 2024 BrightDigit.
+//
+//  Permission is hereby granted, free of charge, to any person
+//  obtaining a copy of this software and associated documentation
+//  files (the "Software"), to deal in the Software without
+//  restriction, including without limitation the rights to use,
+//  copy, modify, merge, publish, distribute, sublicense, and/or
+//  sell copies of the Software, and to permit persons to whom the
+//  Software is furnished to do so, subject to the following
+//  conditions:
+//
+//  The above copyright notice and this permission notice shall be
+//  included in all copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+//  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+//  OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+//  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+//  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+//  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+//  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+//  OTHER DEALINGS IN THE SOFTWARE.
+//
+
+public import Foundation
+
+/// Remote access command operations
+public enum RemoteAccessCommand: Codable, Sendable {
+  /// SSH-related commands
+  case ssh(SSHCommand)
+  /// Remote access status request
+  case status
+}

Sources/BushelHarvestCore/RemoteStatusData.swift

@@ -0,0 +1,39 @@
+//
+//  RemoteStatusData.swift
+//  BushelKit
+//
+//  Created by Leo Dion.
+//  Copyright © 2024 BrightDigit.
+//
+//  Permission is hereby granted, free of charge, to any person
+//  obtaining a copy of this software and associated documentation
+//  files (the "Software"), to deal in the Software without
+//  restriction, including without limitation the rights to use,
+//  copy, modify, merge, publish, distribute, sublicense, and/or
+//  sell copies of the Software, and to permit persons to whom the
+//  Software is furnished to do so, subject to the following
+//  conditions:
+//
+//  The above copyright notice and this permission notice shall be
+//  included in all copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+//  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+//  OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+//  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+//  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+//  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+//  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+//  OTHER DEALINGS IN THE SOFTWARE.
+//
+
+public import Foundation
+
+/// Remote status response data
+public struct RemoteStatusData: Codable, Sendable {
+  public let access: RemoteAccess
+
+  public init(access: RemoteAccess) {
+    self.access = access
+  }
+}