SPB Git

Repository Public

SSHHost.swift 9.2 KB 184 lines swift

1import Foundation23/// A host the user may connect to. Discovered from `~/.ssh/config` (never invented) or added by hand.4/// Labels, groups and tags are user data; `source` says where the entry came from.5public struct SSHHost: Codable, Sendable, Hashable, Identifiable {6    public enum Source: String, Codable, Sendable { case sshConfig = "ssh_config", manual }78    public var id: UUID9    /// The `Host` alias as passed to `ssh`.10    public var alias: String11    public var hostName: String?12    public var user: String?13    public var port: Int?14    public var identityFile: String?15    public var proxyJump: String?16    public var label: String?17    public var group: String?18    public var tags: [String]19    public var tmuxSession: String?20    public var remoteDirectory: String?21    public var favorite: Bool22    public var source: Source2324    public init(id: UUID = UUID(), alias: String, hostName: String? = nil, user: String? = nil, port: Int? = nil, identityFile: String? = nil,25                proxyJump: String? = nil, label: String? = nil, group: String? = nil, tags: [String] = [], tmuxSession: String? = nil,26                remoteDirectory: String? = nil, favorite: Bool = false, source: Source = .sshConfig) {27        self.id = id; self.alias = alias; self.hostName = hostName; self.user = user; self.port = port; self.identityFile = identityFile28        self.proxyJump = proxyJump; self.label = label; self.group = group; self.tags = tags; self.tmuxSession = tmuxSession29        self.remoteDirectory = remoteDirectory; self.favorite = favorite; self.source = source30    }3132    public var displayName: String { label?.isEmpty == false ? label! : alias }3334    /// "user@hostname:port" for the inspector; nil parts omitted.35    public var endpointDescription: String {36        var s = ""37        if let user { s += user + "@" }38        s += hostName ?? alias39        if let port, port != 22 { s += ":\(port)" }40        return s41    }42}4344/// Parses OpenSSH client configuration. Only concrete `Host` aliases are returned (no `*`/`?`45/// patterns, no negations); `Match` blocks are skipped; `Include` directives are followed.46public enum SSHConfigParser {47    public static func parse(_ text: String, includeResolver: ((String) -> [String])? = nil) -> [SSHHost] {48        var hosts: [SSHHost] = []49        var current: [SSHHost] = []   // one `Host a b c` line can declare several aliases50        var skipping = false5152        func flush() {53            hosts.append(contentsOf: current)54            current = []55        }5657        for rawLine in text.components(separatedBy: .newlines) {58            var line = rawLine.trimmingCharacters(in: .whitespaces)59            if let hash = line.firstIndex(of: "#") { line = String(line[..<hash]).trimmingCharacters(in: .whitespaces) }60            guard !line.isEmpty else { continue }61            let parts = splitKeyValue(line)62            guard let keyword = parts.key?.lowercased() else { continue }63            let value = parts.value64            switch keyword {65            case "host":66                flush()67                skipping = false68                let aliases = value.split(separator: " ").map(String.init)69                let concrete = aliases.filter { !$0.contains("*") && !$0.contains("?") && !$0.hasPrefix("!") }70                current = concrete.map { SSHHost(alias: $0) }71                if current.isEmpty { skipping = true }72            case "match":73                flush()74                skipping = true75            case "include":76                flush()77                skipping = false78                if let includeResolver {79                    for included in includeResolver(value) { hosts.append(contentsOf: parse(included, includeResolver: includeResolver)) }80                }81            default:82                guard !skipping, !current.isEmpty else { continue }83                for i in current.indices {84                    switch keyword {85                    case "hostname": current[i].hostName = value86                    case "user": current[i].user = value87                    case "port": current[i].port = Int(value)88                    case "identityfile": current[i].identityFile = value89                    case "proxyjump": current[i].proxyJump = value90                    default: break91                    }92                }93            }94        }95        flush()96        // Keep the first declaration of an alias (OpenSSH semantics: first match wins).97        var seen = Set<String>()98        return hosts.filter { seen.insert($0.alias).inserted }99    }100101    private static func splitKeyValue(_ line: String) -> (key: String?, value: String) {102        if let eq = line.firstIndex(of: "="), !line[..<eq].contains(" ") {103            return (String(line[..<eq]).trimmingCharacters(in: .whitespaces), String(line[line.index(after: eq)...]).trimmingCharacters(in: .whitespaces))104        }105        guard let space = line.firstIndex(where: { $0 == " " || $0 == "\t" }) else { return (line, "") }106        return (String(line[..<space]), String(line[space...]).trimmingCharacters(in: .whitespaces))107    }108109    /// Reads `~/.ssh/config`, following `Include` globs relative to `~/.ssh`.110    public static func loadUserConfig(home: String = FileManager.default.homeDirectoryForCurrentUser.path) -> [SSHHost] {111        let sshDir = (home as NSString).appendingPathComponent(".ssh")112        let configPath = (sshDir as NSString).appendingPathComponent("config")113        guard let text = try? String(contentsOfFile: configPath, encoding: .utf8) else { return [] }114        let resolver: (String) -> [String] = { pattern in115            let expanded = pattern.hasPrefix("~") ? (home + pattern.dropFirst()) : (pattern.hasPrefix("/") ? pattern : (sshDir as NSString).appendingPathComponent(pattern))116            return glob(expanded).compactMap { try? String(contentsOfFile: $0, encoding: .utf8) }117        }118        return parse(text, includeResolver: resolver)119    }120121    static func glob(_ pattern: String) -> [String] {122        var g = glob_t()123        defer { globfree(&g) }124        guard Darwin.glob(pattern, 0, nil, &g) == 0 else { return [] }125        return (0..<Int(g.gl_matchc)).compactMap { g.gl_pathv[$0].map { String(cString: $0) } }126    }127}128129/// Builds `ssh` argument arrays. Host-key verification is always left to OpenSSH (`StrictHostKeyChecking=ask`130/// means unknown hosts prompt in the terminal and changed keys are refused); nothing here can bypass it.131public enum SSHCommandBuilder {132    public static let executable = "/usr/bin/ssh"133134    public static func arguments(for host: SSHHost, tmuxSession: String? = nil, remoteDirectory: String? = nil, keepAliveSeconds: Int = 15) -> [String] {135        var args: [String] = [136            "-o", "StrictHostKeyChecking=ask",137            "-o", "ServerAliveInterval=\(max(5, keepAliveSeconds))",138            "-o", "ServerAliveCountMax=3",139            "-o", "ConnectTimeout=20",140        ]141        if let port = host.port, host.source == .manual { args += ["-p", String(port)] }142        if let user = host.user, host.source == .manual { args += ["-l", user] }143        let session = tmuxSession ?? host.tmuxSession144        let directory = remoteDirectory ?? host.remoteDirectory145        if session != nil || directory != nil { args.append("-t") }146        args.append("--")147        args.append(host.source == .manual ? (host.hostName ?? host.alias) : host.alias)148        if let remote = remoteCommand(tmuxSession: session, directory: directory) { args.append(remote) }149        return args150    }151152    /// The remote side has to be a shell string; every user value is single-quoted.153    static func remoteCommand(tmuxSession: String?, directory: String?) -> String? {154        var parts: [String] = []155        if let directory, !directory.isEmpty { parts.append("cd \(shellQuote(directory))") }156        if let tmuxSession, !tmuxSession.isEmpty {157            parts.append("exec tmux new-session -A -s \(shellQuote(tmuxSession))")158        } else if !parts.isEmpty {159            parts.append("exec \"${SHELL:-/bin/sh}\" -l")160        }161        return parts.isEmpty ? nil : parts.joined(separator: " && ")162    }163164    /// POSIX single-quote escaping; control characters are stripped so they can never terminate the quote.165    public static func shellQuote(_ value: String) -> String {166        let cleaned = value.unicodeScalars.filter { $0.value >= 0x20 && $0.value != 0x7f }.map(String.init).joined()167        return "'" + cleaned.replacingOccurrences(of: "'", with: "'\\''") + "'"168    }169170    /// OpenSSH exit status 255 = connection/protocol failure (as opposed to the remote command's status).171    public static func isConnectionFailure(exitCode: Int32?) -> Bool { exitCode == 255 }172}173174/// Local tmux commands (argument arrays).175public enum TmuxCommandBuilder {176    public static func attachOrCreate(session: String) -> [String] { ["new-session", "-A", "-s", session] }177    public static func listSessions() -> [String] { ["list-sessions", "-F", "#{session_name}\t#{session_windows}\t#{session_attached}\t#{session_created}"] }178179    /// Session names may only contain safe characters (tmux itself rejects "." and ":").180    public static func isValidSessionName(_ name: String) -> Bool {181        !name.isEmpty && name.count <= 64 && name.unicodeScalars.allSatisfy { CharacterSet.alphanumerics.contains($0) || "-_".unicodeScalars.contains($0) }182    }183}184
Files main
Menu

Theme