Skip to content

fix: pass configured http headers to network extension #52

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 19, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions Coder Desktop/Coder Desktop/State.swift
Original file line number Diff line number Diff line change
@@ -31,13 +31,15 @@ class AppState: ObservableObject {

@Published var useLiteralHeaders: Bool = UserDefaults.standard.bool(forKey: Keys.useLiteralHeaders) {
didSet {
if let onChange { onChange(tunnelProviderProtocol()) }
guard persistent else { return }
UserDefaults.standard.set(useLiteralHeaders, forKey: Keys.useLiteralHeaders)
}
}

@Published var literalHeaders: [LiteralHeader] {
didSet {
if let onChange { onChange(tunnelProviderProtocol()) }
guard persistent else { return }
try? UserDefaults.standard.set(JSONEncoder().encode(literalHeaders), forKey: Keys.literalHeaders)
}
@@ -57,13 +59,17 @@ class AppState: ObservableObject {
// HACK: We can't write to the system keychain, and the user keychain
// isn't accessible, so we'll use providerConfiguration, which is over XPC.
proto.providerConfiguration = ["token": sessionToken!]
if useLiteralHeaders, let headers = try? JSONEncoder().encode(literalHeaders) {
proto.providerConfiguration?["literalHeaders"] = headers
}
proto.serverAddress = baseAccessURL!.absoluteString
return proto
}

private let keychain: Keychain
private let persistent: Bool

// This closure must be called when any property used to configure the VPN changes
let onChange: ((NETunnelProviderProtocol?) -> Void)?

public init(onChange: ((NETunnelProviderProtocol?) -> Void)? = nil,
@@ -125,20 +131,20 @@ class AppState: ObservableObject {
}

struct LiteralHeader: Hashable, Identifiable, Equatable, Codable {
var header: String
var name: String
var value: String
var id: String {
"\(header):\(value)"
"\(name):\(value)"
}

init(header: String, value: String) {
self.header = header
init(name: String, value: String) {
self.name = name
self.value = value
}
}

extension LiteralHeader {
func toSDKHeader() -> HTTPHeader {
.init(header: header, value: value)
.init(name: name, value: value)
}
}
Original file line number Diff line number Diff line change
@@ -26,7 +26,7 @@ struct LiteralHeaderModal: View {
}.padding(20)
}.onAppear {
if let existingHeader {
header = existingHeader.header
header = existingHeader.name
value = existingHeader.value
}
}
@@ -37,7 +37,7 @@ struct LiteralHeaderModal: View {
if let existingHeader {
state.literalHeaders.removeAll { $0 == existingHeader }
}
let newHeader = LiteralHeader(header: header, value: value)
let newHeader = LiteralHeader(name: header, value: value)
if !state.literalHeaders.contains(newHeader) {
state.literalHeaders.append(newHeader)
}
Original file line number Diff line number Diff line change
@@ -20,7 +20,7 @@ struct LiteralHeadersSection<VPN: VPNService>: View {
.controlSize(.large)

Table(state.literalHeaders, selection: $selectedHeader) {
TableColumn("Header", value: \.header)
TableColumn("Header", value: \.name)
TableColumn("Value", value: \.value)
}.opacity(state.useLiteralHeaders ? 1 : 0.5)
.frame(minWidth: 400, minHeight: 200)
2 changes: 1 addition & 1 deletion Coder Desktop/CoderSDK/Client.swift
Original file line number Diff line number Diff line change
@@ -33,7 +33,7 @@ public struct Client {
if let token { req.addValue(token, forHTTPHeaderField: Headers.sessionToken) }
req.httpMethod = method.rawValue
for header in headers {
req.addValue(header.value, forHTTPHeaderField: header.header)
req.addValue(header.value, forHTTPHeaderField: header.name)
}
req.httpBody = body
let data: Data
8 changes: 4 additions & 4 deletions Coder Desktop/CoderSDK/HTTP.swift
Original file line number Diff line number Diff line change
@@ -6,11 +6,11 @@ public struct HTTPResponse {
let req: URLRequest
}

public struct HTTPHeader: Sendable {
public let header: String
public struct HTTPHeader: Sendable, Codable {
public let name: String
public let value: String
public init(header: String, value: String) {
self.header = header
public init(name: String, value: String) {
self.name = name
self.value = value
}
}
2 changes: 1 addition & 1 deletion Coder Desktop/CoderSDKTests/CoderSDKTests.swift
Original file line number Diff line number Diff line change
@@ -28,7 +28,7 @@ struct CoderSDKTests {

let url = URL(string: "https://example.com")!
let token = "fake-token"
let client = Client(url: url, token: token, headers: [.init(header: "X-Test-Header", value: "foo")])
let client = Client(url: url, token: token, headers: [.init(name: "X-Test-Header", value: "foo")])
var mock = try Mock(
url: url.appending(path: "api/v2/users/johndoe"),
contentType: .json,
8 changes: 7 additions & 1 deletion Coder Desktop/VPN/Manager.swift
Original file line number Diff line number Diff line change
@@ -54,7 +54,6 @@ actor Manager {
do {
try tunnelHandle = TunnelHandle(dylibPath: dest)
} catch {
logger.error("couldn't open dylib \(error, privacy: .public)")
throw .tunnelSetup(error)
}
speaker = await Speaker<Vpn_ManagerMessage, Vpn_TunnelMessage>(
@@ -164,6 +163,12 @@ actor Manager {
req.tunnelFileDescriptor = tunFd
req.apiToken = cfg.apiToken
req.coderURL = cfg.serverUrl.absoluteString
req.headers = cfg.literalHeaders.map { header in
.with { req in
req.name = header.name
req.value = header.value
}
}
}
})
} catch {
@@ -223,6 +228,7 @@ actor Manager {
struct ManagerConfig {
let apiToken: String
let serverUrl: URL
let literalHeaders: [HTTPHeader]
}

enum ManagerError: Error {
6 changes: 5 additions & 1 deletion Coder Desktop/VPN/PacketTunnelProvider.swift
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import CoderSDK
import NetworkExtension
import os
import VPNLib
@@ -65,6 +66,8 @@ class PacketTunnelProvider: NEPacketTunnelProvider, @unchecked Sendable {
completionHandler(makeNSError(suffix: "PTP", desc: "Missing Token"))
return
}
let headers: [HTTPHeader] = (proto.providerConfiguration?["literalHeaders"] as? Data)
.flatMap { try? JSONDecoder().decode([HTTPHeader].self, from: $0) } ?? []
logger.debug("retrieved token & access URL")
let completionHandler = CallbackWrapper(completionHandler)
Task {
@@ -73,7 +76,8 @@ class PacketTunnelProvider: NEPacketTunnelProvider, @unchecked Sendable {
let manager = try await Manager(
with: self,
cfg: .init(
apiToken: token, serverUrl: .init(string: baseAccessURL)!
apiToken: token, serverUrl: .init(string: baseAccessURL)!,
literalHeaders: headers
)
)
globalXPCListenerDelegate.vpnXPCInterface.manager = manager