|
|
@@ -0,0 +1,323 @@
|
|
|
+/*
|
|
|
+ * Copyright (c) 2021, Psiphon Inc.
|
|
|
+ * All rights reserved.
|
|
|
+ *
|
|
|
+ * This program is free software: you can redistribute it and/or modify
|
|
|
+ * it under the terms of the GNU General Public License as published by
|
|
|
+ * the Free Software Foundation, either version 3 of the License, or
|
|
|
+ * (at your option) any later version.
|
|
|
+ *
|
|
|
+ * This program is distributed in the hope that it will be useful,
|
|
|
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
+ * GNU General Public License for more details.
|
|
|
+ *
|
|
|
+ * You should have received a copy of the GNU General Public License
|
|
|
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
+ *
|
|
|
+ */
|
|
|
+
|
|
|
+#import "DefaultRouteMonitor.h"
|
|
|
+#import "NetworkInterface.h"
|
|
|
+#import <Network/path.h>
|
|
|
+#import <net/if.h>
|
|
|
+#import <ifaddrs.h>
|
|
|
+
|
|
|
+@interface ReachabilityChangedNotification ()
|
|
|
+/// See comment in DefaultRouteMonitor.h
|
|
|
+@property (nonatomic) NetworkReachability reachabilityStatus;
|
|
|
+/// See comment in DefaultRouteMonitor.h
|
|
|
+@property (nonatomic, nullable) NSString *curDefaultActiveInterfaceName;
|
|
|
+/// See comment in DefaultRouteMonitor.h
|
|
|
+@property (nonatomic, nullable) NSString *prevDefaultActiveInterfaceName;
|
|
|
+@end
|
|
|
+
|
|
|
+@implementation ReachabilityChangedNotification
|
|
|
+
|
|
|
+- (instancetype)initWithReachabilityStatus:(NetworkReachability)networkReachability
|
|
|
+ curDefaultActiveInterfaceName:(NSString*)curDefaultActiveInterfaceName
|
|
|
+ prevDefaultActiveInterfaceName:(NSString*)prevDefaultActiveInterfaceName {
|
|
|
+ self = [super init];
|
|
|
+ if (self) {
|
|
|
+ self->_reachabilityStatus = networkReachability;
|
|
|
+ self->_curDefaultActiveInterfaceName = curDefaultActiveInterfaceName;
|
|
|
+ self->_prevDefaultActiveInterfaceName = prevDefaultActiveInterfaceName;
|
|
|
+ }
|
|
|
+ return self;
|
|
|
+}
|
|
|
+
|
|
|
+@end
|
|
|
+
|
|
|
+@implementation DefaultRouteMonitor {
|
|
|
+ nw_path_monitor_t monitor;
|
|
|
+ dispatch_queue_t workQueue;
|
|
|
+ NetworkReachability status;
|
|
|
+ NetworkPathState* state;
|
|
|
+
|
|
|
+ void (^logger) (NSString *_Nonnull);
|
|
|
+}
|
|
|
+
|
|
|
+- (void)initialize {
|
|
|
+ self->state = nil;
|
|
|
+ self->status = NetworkReachabilityNotReachable;
|
|
|
+ self->workQueue = dispatch_queue_create("com.psiphon3.library.NWInterfaceNWPathMonitorQueue", DISPATCH_QUEUE_SERIAL);
|
|
|
+}
|
|
|
+
|
|
|
+- (instancetype)init {
|
|
|
+ self = [super init];
|
|
|
+ if (self) {
|
|
|
+ [self initialize];
|
|
|
+ }
|
|
|
+ return self;
|
|
|
+}
|
|
|
+
|
|
|
+- (instancetype)initWithLogger:(void (^__nonnull)(NSString *_Nonnull))logger {
|
|
|
+ self = [super init];
|
|
|
+ if (self) {
|
|
|
+ [self initialize];
|
|
|
+ self->logger = logger;
|
|
|
+ }
|
|
|
+ return self;
|
|
|
+}
|
|
|
+
|
|
|
+- (NetworkPathState*)pathState {
|
|
|
+ return self->state;
|
|
|
+}
|
|
|
+
|
|
|
+- (void)log:(NSString*)notice {
|
|
|
+ if (self->logger != nil) {
|
|
|
+ self->logger(notice);
|
|
|
+ }
|
|
|
+}
|
|
|
+
|
|
|
+- (void)start API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0)) {
|
|
|
+ @synchronized (self) {
|
|
|
+ // Ensure previous monitor cancelled
|
|
|
+ if (self->monitor != nil) {
|
|
|
+ nw_path_monitor_cancel(self->monitor);
|
|
|
+ }
|
|
|
+
|
|
|
+ self->monitor = nw_path_monitor_create();
|
|
|
+ nw_path_monitor_set_queue(self->monitor, self->workQueue);
|
|
|
+
|
|
|
+ nw_path_monitor_set_update_handler(self->monitor, ^(nw_path_t _Nonnull path) {
|
|
|
+ [self log:[NSString stringWithFormat:@"new path: %@",
|
|
|
+ [DefaultRouteMonitor pathDebugInfo:path]]];
|
|
|
+
|
|
|
+ NetworkPathState *newPathState = [[NetworkPathState alloc] init];
|
|
|
+ newPathState.path = path;
|
|
|
+ NSString *prevDefaultActiveInterfaceName = nil;
|
|
|
+ if (self->state != nil) {
|
|
|
+ prevDefaultActiveInterfaceName = self->state.defaultActiveInterfaceName;
|
|
|
+ }
|
|
|
+
|
|
|
+ nw_path_status_t status = nw_path_get_status(path);
|
|
|
+ if (status == nw_path_status_invalid) {
|
|
|
+ self->status = NetworkReachabilityNotReachable;
|
|
|
+ } else if (status == nw_path_status_unsatisfied) {
|
|
|
+ self->status = NetworkReachabilityNotReachable;
|
|
|
+ } else if (status == nw_path_status_satisfied || status == nw_path_status_satisfiable) {
|
|
|
+ if (nw_path_uses_interface_type(path, nw_interface_type_wifi)) {
|
|
|
+ self->status = NetworkReachabilityReachableViaWiFi;
|
|
|
+ } else if (nw_path_uses_interface_type(path, nw_interface_type_cellular)) {
|
|
|
+ self->status = NetworkReachabilityReachableViaCellular;
|
|
|
+ } else if (nw_path_uses_interface_type(path, nw_interface_type_wired)) {
|
|
|
+ self->status = NetworkReachabilityReachableViaWired;
|
|
|
+ } else if (nw_path_uses_interface_type(path, nw_interface_type_loopback)) {
|
|
|
+ self->status = NetworkReachabilityReachableViaLoopback;
|
|
|
+ } else {
|
|
|
+ self->status = NetworkReachabilityReachableViaUnknown;
|
|
|
+ }
|
|
|
+
|
|
|
+ // Discover active interface type. Follows: https://developer.apple.com/forums/thread/105822?answerId=322343022#322343022.
|
|
|
+ nw_interface_type_t active_interface_type = nw_interface_type_other;
|
|
|
+ if (nw_path_uses_interface_type(path, nw_interface_type_wifi)) {
|
|
|
+ active_interface_type = nw_interface_type_wifi;
|
|
|
+ } else if (nw_path_uses_interface_type(path, nw_interface_type_cellular)) {
|
|
|
+ active_interface_type = nw_interface_type_cellular;
|
|
|
+ } else if (nw_path_uses_interface_type(path, nw_interface_type_wired)) {
|
|
|
+ active_interface_type = nw_interface_type_wired;
|
|
|
+ } else if (nw_path_uses_interface_type(path, nw_interface_type_loopback)) {
|
|
|
+ active_interface_type = nw_interface_type_loopback;
|
|
|
+ } else {
|
|
|
+ active_interface_type = nw_interface_type_other;
|
|
|
+ }
|
|
|
+
|
|
|
+ NSSet<NSString*>* activeInterfaces = [NetworkInterface activeInterfaces];
|
|
|
+ [self log:[NSString stringWithFormat:@"active interfaces %@", activeInterfaces]];
|
|
|
+
|
|
|
+ NSMutableArray<NSString*> *candidateInterfaces = [[NSMutableArray alloc] init];
|
|
|
+ // Map the active interface type to the interface itself
|
|
|
+ nw_path_enumerate_interfaces(path, ^bool(nw_interface_t _Nonnull interface) {
|
|
|
+ nw_interface_type_t interfaceType = nw_interface_get_type(interface);
|
|
|
+ [self log:[NSString stringWithFormat:@"enumerated interface %@ with type %d",
|
|
|
+ [NSString stringWithUTF8String:nw_interface_get_name(interface)], interfaceType]];
|
|
|
+
|
|
|
+ if (interfaceType == active_interface_type) {
|
|
|
+ NSString *interfaceName = [NSString stringWithUTF8String:nw_interface_get_name(interface)];
|
|
|
+ if ([activeInterfaces containsObject:interfaceName]) {
|
|
|
+ [candidateInterfaces addObject:interfaceName];
|
|
|
+ // Note: could return false here to end enumeration and choose first
|
|
|
+ // candidate interface.
|
|
|
+ return true;
|
|
|
+ }
|
|
|
+ }
|
|
|
+ // Continue searching
|
|
|
+ return true;
|
|
|
+ });
|
|
|
+ [self log:[NSString stringWithFormat:@"%lu candidate interfaces",
|
|
|
+ (unsigned long)[candidateInterfaces count]]];
|
|
|
+ if ([candidateInterfaces count] > 0) {
|
|
|
+ // Arbitrarily choose first interface
|
|
|
+ NSString *interfaceName = [candidateInterfaces objectAtIndex:0];
|
|
|
+ newPathState.defaultActiveInterfaceName = interfaceName;
|
|
|
+ [self log:[NSString stringWithFormat:@"active interface %@", interfaceName]];
|
|
|
+ } else {
|
|
|
+ // This should never happen
|
|
|
+ }
|
|
|
+ } else {
|
|
|
+ // Unhandled case. Should never happen.
|
|
|
+ }
|
|
|
+ self->state = newPathState;
|
|
|
+
|
|
|
+ // Backwards compatibility with Reachability
|
|
|
+ ReachabilityChangedNotification *notif =
|
|
|
+ [[ReachabilityChangedNotification alloc]
|
|
|
+ initWithReachabilityStatus:self->status
|
|
|
+ curDefaultActiveInterfaceName:newPathState.defaultActiveInterfaceName
|
|
|
+ prevDefaultActiveInterfaceName:prevDefaultActiveInterfaceName];
|
|
|
+ [[NSNotificationCenter defaultCenter]
|
|
|
+ postNotificationName:[DefaultRouteMonitor reachabilityChangedNotification]
|
|
|
+ object:notif];
|
|
|
+ });
|
|
|
+ nw_path_monitor_start(self->monitor);
|
|
|
+ }
|
|
|
+}
|
|
|
+
|
|
|
+- (void)stop API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0)) {
|
|
|
+ @synchronized (self) {
|
|
|
+ // Note: this monitor cannot be used after being cancelled. Its update handler will not
|
|
|
+ // fire again and cannot be restarted with nw_path_monitor_start. A new monitor must be
|
|
|
+ // created and started.
|
|
|
+ nw_path_monitor_cancel(self->monitor);
|
|
|
+ self->monitor = nil;
|
|
|
+ }
|
|
|
+}
|
|
|
+
|
|
|
++ (NSString*)pathDebugInfo:(nw_path_t)path API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0)) {
|
|
|
+ NSString *constrained = @"UNAVAILABLE";
|
|
|
+ if (@available(iOS 13.0, *)) {
|
|
|
+ constrained = [NSString stringWithFormat:@"%d", nw_path_is_constrained(path)];
|
|
|
+ }
|
|
|
+
|
|
|
+ NSString *unsatisfiedReason = @"UNAVAILABLE";
|
|
|
+ if (@available(iOS 14.2, *)) {
|
|
|
+ nw_path_unsatisfied_reason_t reason = nw_path_get_unsatisfied_reason(path);
|
|
|
+ if (reason == nw_path_unsatisfied_reason_wifi_denied) {
|
|
|
+ unsatisfiedReason = @"WIFI_DENIED";
|
|
|
+ } else if (reason == nw_path_unsatisfied_reason_cellular_denied) {
|
|
|
+ unsatisfiedReason = @"CELLULAR_DENIED";
|
|
|
+ } else if (reason == nw_path_unsatisfied_reason_local_network_denied) {
|
|
|
+ unsatisfiedReason = @"LOCAL_NETWORK_DENIED";
|
|
|
+ } else if (reason == nw_path_unsatisfied_reason_not_available) {
|
|
|
+ unsatisfiedReason = @"NOT_AVAILABLE";
|
|
|
+ } else {
|
|
|
+ unsatisfiedReason = @"UNKNOWN";
|
|
|
+ }
|
|
|
+ }
|
|
|
+
|
|
|
+ nw_interface_type_t active_interface_type = nw_interface_type_other;
|
|
|
+ if (nw_path_uses_interface_type(path, nw_interface_type_wifi)) {
|
|
|
+ active_interface_type = nw_interface_type_wifi;
|
|
|
+ } else if (nw_path_uses_interface_type(path, nw_interface_type_cellular)) {
|
|
|
+ active_interface_type = nw_interface_type_cellular;
|
|
|
+ } else if (nw_path_uses_interface_type(path, nw_interface_type_wired)) {
|
|
|
+ active_interface_type = nw_interface_type_wired;
|
|
|
+ } else if (nw_path_uses_interface_type(path, nw_interface_type_loopback)) {
|
|
|
+ active_interface_type = nw_interface_type_loopback;
|
|
|
+ } else {
|
|
|
+ active_interface_type = nw_interface_type_other;
|
|
|
+ }
|
|
|
+
|
|
|
+ // Note: could log nw_endpoint_t information with
|
|
|
+ // nw_path_copy_effective_local_endpoint and nw_path_enumerate_gateways
|
|
|
+ // but could contain PII — more investigation required, but logging
|
|
|
+ // endpoint type may be safe.
|
|
|
+ NSString *s = [NSString stringWithFormat:
|
|
|
+ @"status %@, "
|
|
|
+ "active_interface_type %@, "
|
|
|
+ "path_is_expensive %d, "
|
|
|
+ "path_is_constrained %@, "
|
|
|
+ "path_has_ipv4 %d, "
|
|
|
+ "path_has_ipv6 %d, "
|
|
|
+ "path_has_dns %d, "
|
|
|
+ "unsatisfied_reason %@",
|
|
|
+ [DefaultRouteMonitor pathStatusToString:nw_path_get_status(path)],
|
|
|
+ [DefaultRouteMonitor interfaceTypeToString:active_interface_type],
|
|
|
+ nw_path_is_expensive(path), constrained, nw_path_has_ipv4(path),
|
|
|
+ nw_path_has_ipv6(path), nw_path_has_dns(path), unsatisfiedReason];
|
|
|
+ return s;
|
|
|
+}
|
|
|
+
|
|
|
+#pragma mark ReachabilityProtocol
|
|
|
+
|
|
|
++ (NSString*)reachabilityChangedNotification {
|
|
|
+ return @"kNetworkReachabilityChangedNotification";
|
|
|
+}
|
|
|
+
|
|
|
+- (BOOL)startNotifier {
|
|
|
+ [self log:@"starting NWPathMonitor"];
|
|
|
+ [self start];
|
|
|
+ return TRUE;
|
|
|
+}
|
|
|
+
|
|
|
+- (void)stopNotifier {
|
|
|
+ [self log:@"stopping NWPathMonitor"];
|
|
|
+ [self stop];
|
|
|
+}
|
|
|
+
|
|
|
+- (NetworkReachability)reachabilityStatus {
|
|
|
+ return self->status;
|
|
|
+}
|
|
|
+
|
|
|
+- (NSString*)reachabilityStatusDebugInfo {
|
|
|
+ if (self->state == nil) {
|
|
|
+ return @"state nil";
|
|
|
+ }
|
|
|
+ nw_path_t path = self->state.path;
|
|
|
+ return [DefaultRouteMonitor pathDebugInfo:path];
|
|
|
+}
|
|
|
+
|
|
|
+#pragma mark Helpers (private)
|
|
|
+
|
|
|
++ (NSString*)interfaceTypeToString:(nw_interface_type_t)type {
|
|
|
+ if (type == nw_interface_type_wifi) {
|
|
|
+ return @"WIFI";
|
|
|
+ } else if (type == nw_interface_type_cellular) {
|
|
|
+ return @"CELLULAR";
|
|
|
+ } else if (type == nw_interface_type_wired) {
|
|
|
+ return @"WIRED";
|
|
|
+ } else if (type == nw_interface_type_loopback) {
|
|
|
+ return @"LOOPBACK";
|
|
|
+ } else if (type == nw_interface_type_other) {
|
|
|
+ return @"OTHER";
|
|
|
+ } else {
|
|
|
+ return @"UNKNOWN";
|
|
|
+ }
|
|
|
+}
|
|
|
+
|
|
|
++ (NSString*)pathStatusToString:(nw_path_status_t)status {
|
|
|
+ if (status == nw_path_status_satisfied) {
|
|
|
+ return @"SATISFIED";
|
|
|
+ } else if (status == nw_path_status_satisfiable) {
|
|
|
+ return @"SATISFIABLE";
|
|
|
+ } else if (status == nw_path_status_unsatisfied) {
|
|
|
+ return @"UNSATISFIED";
|
|
|
+ } else if (status == nw_path_status_invalid) {
|
|
|
+ return @"INVALID";
|
|
|
+ } else {
|
|
|
+ return @"UNKNOWN";
|
|
|
+ }
|
|
|
+}
|
|
|
+
|
|
|
+@end
|
mirokuratczyk