passepartoutvpn
/
tunnelkit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'refactor-shutdown-code'

This commit is contained in:
Davide De Rosa 2018-10-24 12:22:27 +02:00
parent e3a5302e06 d829247e6e
commit 3f3a712bac
4 changed files with 46 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
TunnelKit/Sources/AppExtension/GenericSocket.swift
View File

@ -44,8 +44,6 @@ protocol LinkProducer {
protocol GenericSocketDelegate: class {
func socketDidTimeout(_ socket: GenericSocket)
func socketShouldChangeProtocol(_ socket: GenericSocket) -> Bool
func socketDidBecomeActive(_ socket: GenericSocket)
func socket(_ socket: GenericSocket, didShutdownWithFailure failure: Bool)

1
TunnelKit/Sources/AppExtension/Transport/NETCPInterface.swift
View File

@ -79,7 +79,6 @@ class NETCPSocket: NSObject, GenericSocket {
return
}
guard _self.isActive else {
_ = _self.delegate?.socketShouldChangeProtocol(_self)
_self.delegate?.socketDidTimeout(_self)
return
}

35
TunnelKit/Sources/AppExtension/TunnelKitProvider+Configuration.swift
View File

@ -56,7 +56,7 @@ extension TunnelKitProvider {
}
/// Defines the communication protocol of an endpoint.
public struct EndpointProtocol: Equatable, CustomStringConvertible {
public struct EndpointProtocol: RawRepresentable, Equatable, CustomStringConvertible {
/// The socket type.
public let socketType: SocketType
@ -70,23 +70,25 @@ extension TunnelKitProvider {
self.port = port
}
// MARK: RawRepresentable
/// :nodoc:
public static func deserialized(_ string: String) throws -> EndpointProtocol {
let components = string.components(separatedBy: ":")
public init?(rawValue: String) {
let components = rawValue.components(separatedBy: ":")
guard components.count == 2 else {
throw ProviderConfigurationError.parameter(name: "endpointProtocol")
return nil
}
guard let socketType = SocketType(rawValue: components[0]) else {
throw ProviderConfigurationError.parameter(name: "endpointProtocol.socketType")
return nil
}
guard let port = UInt16(components[1]) else {
throw ProviderConfigurationError.parameter(name: "endpointProtocol.port")
return nil
}
return EndpointProtocol(socketType, port)
self.init(socketType, port)
}
/// :nodoc:
public func serialized() -> String {
public var rawValue: String {
return "\(socketType.rawValue):\(port)"
}
@ -101,7 +103,7 @@ extension TunnelKitProvider {
/// :nodoc:
public var description: String {
return serialized()
return rawValue
}
}
@ -229,7 +231,12 @@ extension TunnelKitProvider {
guard let endpointProtocolsStrings = providerConfiguration[S.endpointProtocols] as? [String], !endpointProtocolsStrings.isEmpty else {
throw ProviderConfigurationError.parameter(name: "protocolConfiguration.providerConfiguration[\(S.endpointProtocols)] is nil or empty")
}
endpointProtocols = try endpointProtocolsStrings.map { try EndpointProtocol.deserialized($0) }
endpointProtocols = try endpointProtocolsStrings.map {
guard let ep = EndpointProtocol(rawValue: $0) else {
throw ProviderConfigurationError.parameter(name: "protocolConfiguration.providerConfiguration[\(S.endpointProtocols)] has a badly formed element")
}
return ep
}
self.cipher = cipher
self.digest = digest
@ -444,7 +451,7 @@ extension TunnelKitProvider {
var dict: [String: Any] = [
S.appGroup: appGroup,
S.prefersResolvedAddresses: prefersResolvedAddresses,
S.endpointProtocols: endpointProtocols.map { $0.serialized() },
S.endpointProtocols: endpointProtocols.map { $0.rawValue },
S.cipherAlgorithm: cipher.rawValue,
S.digestAlgorithm: digest.rawValue,
S.ca: ca.pem,
@ -602,12 +609,14 @@ extension TunnelKitProvider.Configuration: Equatable {
extension TunnelKitProvider.EndpointProtocol: Codable {
public init(from decoder: Decoder) throws {
let container = try decoder.singleValueContainer()
let proto = try TunnelKitProvider.EndpointProtocol.deserialized(container.decode(String.self))
guard let proto = try TunnelKitProvider.EndpointProtocol(rawValue: container.decode(String.self)) else {
throw TunnelKitProvider.ProviderConfigurationError.parameter(name: "endpointProtocol.decodable")
}
self.init(proto.socketType, proto.port)
}
public func encode(to encoder: Encoder) throws {
var container = encoder.singleValueContainer()
try container.encode(serialized())
try container.encode(rawValue)
}
}

49
TunnelKit/Sources/AppExtension/TunnelKitProvider.swift
View File

@ -106,8 +106,6 @@ open class TunnelKitProvider: NEPacketTunnelProvider {
private var socket: GenericSocket?
private var linkFailures = 0
private var pendingStartHandler: ((Error?) -> Void)?
private var pendingStopHandler: (() -> Void)?
@ -400,14 +398,14 @@ extension TunnelKitProvider: GenericSocketDelegate {
log.debug("Socket timed out waiting for activity, cancelling...")
reasserting = true
socket.shutdown()
}
func socketShouldChangeProtocol(_ socket: GenericSocket) -> Bool {
guard strategy.tryNextProtocol() else {
disposeTunnel(error: ProviderError.exhaustedProtocols)
return false
// fallback: TCP connection timeout suggests falling back
if let _ = socket as? NETCPSocket {
guard tryNextProtocol() else {
// disposeTunnel
return
}
}
return true
}
func socketDidBecomeActive(_ socket: GenericSocket) {
@ -428,19 +426,17 @@ extension TunnelKitProvider: GenericSocketDelegate {
}
var shutdownError: Error?
if !failure {
shutdownError = proxy.stopError
} else {
shutdownError = proxy.stopError ?? ProviderError.linkError
linkFailures += 1
log.debug("Link failures so far: \(linkFailures) (max = \(maxLinkFailures))")
}
let didTimeoutNegotiation: Bool
var upgradedSocket: GenericSocket?
// neg timeout?
let didTimeoutNegotiation = (proxy.stopError as? SessionError == .negotiationTimeout)
// look for error causing shutdown
shutdownError = proxy.stopError
if failure && (shutdownError == nil) {
shutdownError = ProviderError.linkError
}
didTimeoutNegotiation = (shutdownError as? SessionError == .negotiationTimeout)
// only try upgrade on network errors
var upgradedSocket: GenericSocket? = nil
if shutdownError as? SessionError == nil {
upgradedSocket = socket.upgraded()
}
@ -448,9 +444,9 @@ extension TunnelKitProvider: GenericSocketDelegate {
// clean up
finishTunnelDisconnection(error: shutdownError)
// treat negotiation timeout as socket timeout, UDP is connection-less
// fallback: UDP is connection-less, treat negotiation timeout as socket timeout
if didTimeoutNegotiation {
guard socketShouldChangeProtocol(socket) else {
guard tryNextProtocol() else {
// disposeTunnel
return
}
@ -458,12 +454,6 @@ extension TunnelKitProvider: GenericSocketDelegate {
// reconnect?
if reasserting {
guard (linkFailures < maxLinkFailures) else {
log.debug("Too many link failures (\(linkFailures)), tunnel will die now")
reasserting = false
disposeTunnel(error: shutdownError)
return
}
log.debug("Disconnection is recoverable, tunnel will reconnect in \(reconnectionDelay) milliseconds...")
tunnelQueue.schedule(after: .milliseconds(reconnectionDelay)) {
self.connectTunnel(upgradedSocket: upgradedSocket, preferredAddress: socket.remoteAddress)
@ -574,6 +564,13 @@ extension TunnelKitProvider: SessionProxyDelegate {
}
extension TunnelKitProvider {
private func tryNextProtocol() -> Bool {
guard strategy.tryNextProtocol() else {
disposeTunnel(error: ProviderError.exhaustedProtocols)
return false
}
return true
}
// MARK: Logging