- Notifications
You must be signed in to change notification settings - Fork3
chore: add network extension manager#18
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
5 commits Select commitHold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
12 changes: 6 additions & 6 deletionsCoder Desktop/Coder Desktop.xcodeproj/project.pbxproj
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletionCoder Desktop/Coder Desktop/Preview Content/PreviewClient.swift
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -23,7 +23,7 @@ struct PreviewClient: Client { | ||
| roles: [] | ||
| ) | ||
| } catch { | ||
| throw .reqError(.explicitlyCancelled) | ||
| } | ||
| } | ||
| } | ||
8 changes: 4 additions & 4 deletionsCoder Desktop/Coder Desktop/SDK/Client.swift
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletionCoder Desktop/Coder Desktop/SDK/User.swift
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletionCoder Desktop/Coder Desktop/Views/LoginForm.swift
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletionCoder Desktop/Coder DesktopTests/Util.swift
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
193 changes: 190 additions & 3 deletionsCoder Desktop/VPN/Manager.swift
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -4,16 +4,203 @@ import VPNLib | ||
| actor Manager { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. I don't think this is worth unit testing, at least right now. We'd need to mock the PTP, the TunnelHandle, the validator, and eventually the XPC speaker, all for a relatively simple abstraction that's mostly error handling. | ||
| let ptp: PacketTunnelProvider | ||
| let cfg: ManagerConfig | ||
| let tunnelHandle: TunnelHandle | ||
| let speaker: Speaker<Vpn_ManagerMessage, Vpn_TunnelMessage> | ||
| var readLoop: Task<Void, any Error>! | ||
| // TODO: XPC Speaker | ||
| private let dest = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask) | ||
| .first!.appending(path: "coder-vpn.dylib") | ||
| private let logger = Logger(subsystem: Bundle.main.bundleIdentifier!, category: "manager") | ||
| init(with: PacketTunnelProvider, cfg: ManagerConfig) async throws(ManagerError) { | ||
| ptp = with | ||
| self.cfg = cfg | ||
| #if arch(arm64) | ||
| let dylibPath = cfg.serverUrl.appending(path: "bin/coder-vpn-arm64.dylib") | ||
| #elseif arch(x86_64) | ||
| let dylibPath = cfg.serverUrl.appending(path: "bin/coder-vpn-amd64.dylib") | ||
| #else | ||
| fatalError("unknown architecture") | ||
| #endif | ||
| do { | ||
| try await download(src: dylibPath, dest: dest) | ||
| } catch { | ||
| throw .download(error) | ||
| } | ||
| do { | ||
| try SignatureValidator.validate(path: dest) | ||
| } catch { | ||
| throw .validation(error) | ||
| } | ||
| do { | ||
| try tunnelHandle = TunnelHandle(dylibPath: dest) | ||
| } catch { | ||
| throw .tunnelSetup(error) | ||
| } | ||
| speaker = await Speaker<Vpn_ManagerMessage, Vpn_TunnelMessage>( | ||
| writeFD: tunnelHandle.writeHandle, | ||
| readFD: tunnelHandle.readHandle | ||
| ) | ||
| do { | ||
| try await speaker.handshake() | ||
| } catch { | ||
| throw .handshake(error) | ||
| } | ||
| readLoop = Task { try await run() } | ||
| } | ||
| func run() async throws { | ||
| do { | ||
| for try await m in speaker { | ||
| switch m { | ||
| case let .message(msg): | ||
| handleMessage(msg) | ||
| case let .RPC(rpc): | ||
| handleRPC(rpc) | ||
| } | ||
| } | ||
| } catch { | ||
| logger.error("tunnel read loop failed: \(error)") | ||
| try await tunnelHandle.close() | ||
| // TODO: Notify app over XPC | ||
| return | ||
| } | ||
| logger.info("tunnel read loop exited") | ||
| try await tunnelHandle.close() | ||
| // TODO: Notify app over XPC | ||
| } | ||
| func handleMessage(_ msg: Vpn_TunnelMessage) { | ||
| guard let msgType = msg.msg else { | ||
| logger.critical("received message with no type") | ||
| return | ||
| } | ||
| switch msgType { | ||
| case .peerUpdate: | ||
| {}() // TODO: Send over XPC | ||
| case let .log(logMsg): | ||
| writeVpnLog(logMsg) | ||
| case .networkSettings, .start, .stop: | ||
| logger.critical("received unexpected message: `\(String(describing: msgType))`") | ||
| } | ||
| } | ||
| func handleRPC(_ rpc: RPCRequest<Vpn_ManagerMessage, Vpn_TunnelMessage>) { | ||
| guard let msgType = rpc.msg.msg else { | ||
| logger.critical("received rpc with no type") | ||
| return | ||
| } | ||
| switch msgType { | ||
| case let .networkSettings(ns): | ||
| let neSettings = convertNetworkSettingsRequest(ns) | ||
| ptp.setTunnelNetworkSettings(neSettings) | ||
| case .log, .peerUpdate, .start, .stop: | ||
| logger.critical("received unexpected rpc: `\(String(describing: msgType))`") | ||
| } | ||
| } | ||
| // TODO: Call via XPC | ||
| func startVPN() async throws(ManagerError) { | ||
| logger.info("sending start rpc") | ||
| guard let tunFd = ptp.tunnelFileDescriptor else { | ||
| throw .noTunnelFileDescriptor | ||
| } | ||
| let resp: Vpn_TunnelMessage | ||
| do { | ||
| resp = try await speaker.unaryRPC(.with { msg in | ||
| msg.start = .with { req in | ||
| req.tunnelFileDescriptor = tunFd | ||
| req.apiToken = cfg.apiToken | ||
| req.coderURL = cfg.serverUrl.absoluteString | ||
| } | ||
| }) | ||
| } catch { | ||
| throw .failedRPC(error) | ||
| } | ||
| guard case let .start(startResp) = resp.msg else { | ||
| throw .incorrectResponse(resp) | ||
| } | ||
| if !startResp.success { | ||
| throw .errorResponse(msg: startResp.errorMessage) | ||
| } | ||
| // TODO: notify app over XPC | ||
| } | ||
| // TODO: Call via XPC | ||
| func stopVPN() async throws(ManagerError) { | ||
| logger.info("sending stop rpc") | ||
| let resp: Vpn_TunnelMessage | ||
| do { | ||
| resp = try await speaker.unaryRPC(.with { msg in | ||
| msg.stop = .init() | ||
| }) | ||
| } catch { | ||
| throw .failedRPC(error) | ||
| } | ||
| guard case let .stop(stopResp) = resp.msg else { | ||
| throw .incorrectResponse(resp) | ||
| } | ||
| if !stopResp.success { | ||
| throw .errorResponse(msg: stopResp.errorMessage) | ||
| } | ||
| // TODO: notify app over XPC | ||
| } | ||
| // TODO: Call via XPC | ||
| // Retrieves the current state of all peers, | ||
| // as required when starting the app whilst the network extension is already running | ||
| func getPeerInfo() async throws(ManagerError) { | ||
| logger.info("sending peer state request") | ||
| let resp: Vpn_TunnelMessage | ||
| do { | ||
| resp = try await speaker.unaryRPC(.with { msg in | ||
| msg.getPeerUpdate = .init() | ||
| }) | ||
| } catch { | ||
| throw .failedRPC(error) | ||
| } | ||
| guard case .peerUpdate = resp.msg else { | ||
| throw .incorrectResponse(resp) | ||
| } | ||
| // TODO: pass to app over XPC | ||
| } | ||
| } | ||
| public struct ManagerConfig { | ||
| let apiToken: String | ||
| let serverUrl: URL | ||
| } | ||
| enum ManagerError: Error { | ||
| case download(DownloadError) | ||
| case tunnelSetup(TunnelHandleError) | ||
| case handshake(HandshakeError) | ||
| case validation(ValidationError) | ||
| case incorrectResponse(Vpn_TunnelMessage) | ||
| case failedRPC(any Error) | ||
| case errorResponse(msg: String) | ||
| case noTunnelFileDescriptor | ||
| } | ||
| func writeVpnLog(_ log: Vpn_Log) { | ||
| let level: OSLogType = switch log.level { | ||
| case .info: .info | ||
| case .debug: .debug | ||
| // warn == error | ||
| case .warn: .error | ||
| case .error: .error | ||
| // critical == fatal == fault | ||
| case .critical: .fault | ||
| case .fatal: .fault | ||
| case .UNRECOGNIZED: .info | ||
| } | ||
| let logger = Logger( | ||
| subsystem: "\(Bundle.main.bundleIdentifier!).dylib", | ||
| category: log.loggerNames.joined(separator: ".") | ||
| ) | ||
| let fields = log.fields.map { "\($0.name): \($0.value)" }.joined(separator: ", ") | ||
| logger.log(level: level, "\(log.message): \(fields)") | ||
| } | ||
12 changes: 9 additions & 3 deletionsCoder Desktop/VPN/PacketTunnelProvider.swift
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.