1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/toolkit/system/osxproxy/nsOSXSystemProxySettings.mm Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,362 @@
1.4 +/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
1.5 +/* vim:set ts=2 sw=2 sts=2 et: */
1.6 +/* This Source Code Form is subject to the terms of the Mozilla Public
1.7 + * License, v. 2.0. If a copy of the MPL was not distributed with this
1.8 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
1.9 +
1.10 +#import <Cocoa/Cocoa.h>
1.11 +#import <SystemConfiguration/SystemConfiguration.h>
1.12 +
1.13 +#include "nsISystemProxySettings.h"
1.14 +#include "mozilla/ModuleUtils.h"
1.15 +#include "nsIServiceManager.h"
1.16 +#include "nsPrintfCString.h"
1.17 +#include "nsNetUtil.h"
1.18 +#include "nsISupportsPrimitives.h"
1.19 +#include "nsIURI.h"
1.20 +#include "nsObjCExceptions.h"
1.21 +#include "mozilla/Attributes.h"
1.22 +
1.23 +class nsOSXSystemProxySettings MOZ_FINAL : public nsISystemProxySettings {
1.24 +public:
1.25 + NS_DECL_THREADSAFE_ISUPPORTS
1.26 + NS_DECL_NSISYSTEMPROXYSETTINGS
1.27 +
1.28 + nsOSXSystemProxySettings();
1.29 + nsresult Init();
1.30 +
1.31 + // called by OSX when the proxy settings have changed
1.32 + void ProxyHasChanged();
1.33 +
1.34 + // is there a PAC url specified in the system configuration
1.35 + bool IsAutoconfigEnabled() const;
1.36 + // retrieve the pac url
1.37 + nsresult GetAutoconfigURL(nsAutoCString& aResult) const;
1.38 +
1.39 + // Find the SystemConfiguration proxy & port for a given URI
1.40 + nsresult FindSCProxyPort(const nsACString &aScheme, nsACString& aResultHost, int32_t& aResultPort, bool& aResultSocksProxy);
1.41 +
1.42 + // is host:port on the proxy exception list?
1.43 + bool IsInExceptionList(const nsACString& aHost) const;
1.44 +
1.45 +private:
1.46 + ~nsOSXSystemProxySettings();
1.47 +
1.48 + SCDynamicStoreContext mContext;
1.49 + SCDynamicStoreRef mSystemDynamicStore;
1.50 + NSDictionary* mProxyDict;
1.51 +
1.52 +
1.53 + // Mapping of URI schemes to SystemConfiguration keys
1.54 + struct SchemeMapping {
1.55 + const char* mScheme;
1.56 + CFStringRef mEnabled;
1.57 + CFStringRef mHost;
1.58 + CFStringRef mPort;
1.59 + bool mIsSocksProxy;
1.60 + };
1.61 + static const SchemeMapping gSchemeMappingList[];
1.62 +};
1.63 +
1.64 +NS_IMPL_ISUPPORTS(nsOSXSystemProxySettings, nsISystemProxySettings)
1.65 +
1.66 +NS_IMETHODIMP
1.67 +nsOSXSystemProxySettings::GetMainThreadOnly(bool *aMainThreadOnly)
1.68 +{
1.69 + *aMainThreadOnly = true;
1.70 + return NS_OK;
1.71 +}
1.72 +
1.73 +// Mapping of URI schemes to SystemConfiguration keys
1.74 +const nsOSXSystemProxySettings::SchemeMapping nsOSXSystemProxySettings::gSchemeMappingList[] = {
1.75 + {"http", kSCPropNetProxiesHTTPEnable, kSCPropNetProxiesHTTPProxy, kSCPropNetProxiesHTTPPort, false},
1.76 + {"https", kSCPropNetProxiesHTTPSEnable, kSCPropNetProxiesHTTPSProxy, kSCPropNetProxiesHTTPSPort, false},
1.77 + {"ftp", kSCPropNetProxiesFTPEnable, kSCPropNetProxiesFTPProxy, kSCPropNetProxiesFTPPort, false},
1.78 + {"socks", kSCPropNetProxiesSOCKSEnable, kSCPropNetProxiesSOCKSProxy, kSCPropNetProxiesSOCKSPort, true},
1.79 + {NULL, NULL, NULL, NULL, false},
1.80 +};
1.81 +
1.82 +static void
1.83 +ProxyHasChangedWrapper(SCDynamicStoreRef aStore, CFArrayRef aChangedKeys, void* aInfo)
1.84 +{
1.85 + static_cast<nsOSXSystemProxySettings*>(aInfo)->ProxyHasChanged();
1.86 +}
1.87 +
1.88 +
1.89 +nsOSXSystemProxySettings::nsOSXSystemProxySettings()
1.90 + : mSystemDynamicStore(NULL), mProxyDict(NULL)
1.91 +{
1.92 + mContext = (SCDynamicStoreContext){0, this, NULL, NULL, NULL};
1.93 +}
1.94 +
1.95 +nsresult
1.96 +nsOSXSystemProxySettings::Init()
1.97 +{
1.98 + NS_OBJC_BEGIN_TRY_ABORT_BLOCK_NSRESULT;
1.99 +
1.100 + // Register for notification of proxy setting changes
1.101 + // See: http://developer.apple.com/documentation/Networking/Conceptual/CFNetwork/CFStreamTasks/chapter_4_section_5.html
1.102 + mSystemDynamicStore = SCDynamicStoreCreate(NULL, CFSTR("Mozilla"), ProxyHasChangedWrapper, &mContext);
1.103 + if (!mSystemDynamicStore)
1.104 + return NS_ERROR_FAILURE;
1.105 +
1.106 + // Set up the store to monitor any changes to the proxies
1.107 + CFStringRef proxiesKey = SCDynamicStoreKeyCreateProxies(NULL);
1.108 + if (!proxiesKey)
1.109 + return NS_ERROR_FAILURE;
1.110 +
1.111 + CFArrayRef keyArray = CFArrayCreate(NULL, (const void**)(&proxiesKey), 1, &kCFTypeArrayCallBacks);
1.112 + CFRelease(proxiesKey);
1.113 + if (!keyArray)
1.114 + return NS_ERROR_FAILURE;
1.115 +
1.116 + SCDynamicStoreSetNotificationKeys(mSystemDynamicStore, keyArray, NULL);
1.117 + CFRelease(keyArray);
1.118 +
1.119 + // Add the dynamic store to the run loop
1.120 + CFRunLoopSourceRef storeRLSource = SCDynamicStoreCreateRunLoopSource(NULL, mSystemDynamicStore, 0);
1.121 + if (!storeRLSource)
1.122 + return NS_ERROR_FAILURE;
1.123 + CFRunLoopAddSource(CFRunLoopGetCurrent(), storeRLSource, kCFRunLoopCommonModes);
1.124 + CFRelease(storeRLSource);
1.125 +
1.126 + // Load the initial copy of proxy info
1.127 + mProxyDict = (NSDictionary*)SCDynamicStoreCopyProxies(mSystemDynamicStore);
1.128 + if (!mProxyDict)
1.129 + return NS_ERROR_FAILURE;
1.130 +
1.131 + return NS_OK;
1.132 +
1.133 + NS_OBJC_END_TRY_ABORT_BLOCK_NSRESULT;
1.134 +}
1.135 +
1.136 +nsOSXSystemProxySettings::~nsOSXSystemProxySettings()
1.137 +{
1.138 + NS_OBJC_BEGIN_TRY_ABORT_BLOCK;
1.139 +
1.140 + [mProxyDict release];
1.141 +
1.142 + if (mSystemDynamicStore) {
1.143 + // Invalidate the dynamic store's run loop source
1.144 + // to get the store out of the run loop
1.145 + CFRunLoopSourceRef rls = SCDynamicStoreCreateRunLoopSource(NULL, mSystemDynamicStore, 0);
1.146 + if (rls) {
1.147 + CFRunLoopSourceInvalidate(rls);
1.148 + CFRelease(rls);
1.149 + }
1.150 + CFRelease(mSystemDynamicStore);
1.151 + }
1.152 +
1.153 + NS_OBJC_END_TRY_ABORT_BLOCK;
1.154 +}
1.155 +
1.156 +
1.157 +void
1.158 +nsOSXSystemProxySettings::ProxyHasChanged()
1.159 +{
1.160 + NS_OBJC_BEGIN_TRY_ABORT_BLOCK;
1.161 +
1.162 + [mProxyDict release];
1.163 + mProxyDict = (NSDictionary*)SCDynamicStoreCopyProxies(mSystemDynamicStore);
1.164 +
1.165 + NS_OBJC_END_TRY_ABORT_BLOCK;
1.166 +}
1.167 +
1.168 +nsresult
1.169 +nsOSXSystemProxySettings::FindSCProxyPort(const nsACString &aScheme, nsACString& aResultHost, int32_t& aResultPort, bool& aResultSocksProxy)
1.170 +{
1.171 + NS_OBJC_BEGIN_TRY_ABORT_BLOCK_NSRESULT;
1.172 +
1.173 + NS_ENSURE_TRUE(mProxyDict != NULL, NS_ERROR_FAILURE);
1.174 +
1.175 + for (const SchemeMapping* keys = gSchemeMappingList; keys->mScheme != NULL; ++keys) {
1.176 + // Check for matching scheme (when appropriate)
1.177 + if (strcasecmp(keys->mScheme, PromiseFlatCString(aScheme).get()) &&
1.178 + !keys->mIsSocksProxy)
1.179 + continue;
1.180 +
1.181 + // Check the proxy is enabled
1.182 + NSNumber* enabled = [mProxyDict objectForKey:(NSString*)keys->mEnabled];
1.183 + NS_ENSURE_TRUE(enabled == NULL || [enabled isKindOfClass:[NSNumber class]], NS_ERROR_FAILURE);
1.184 + if ([enabled intValue] == 0)
1.185 + continue;
1.186 +
1.187 + // Get the proxy host
1.188 + NSString* host = [mProxyDict objectForKey:(NSString*)keys->mHost];
1.189 + if (host == NULL)
1.190 + break;
1.191 + NS_ENSURE_TRUE([host isKindOfClass:[NSString class]], NS_ERROR_FAILURE);
1.192 + aResultHost.Assign([host UTF8String]);
1.193 +
1.194 + // Get the proxy port
1.195 + NSNumber* port = [mProxyDict objectForKey:(NSString*)keys->mPort];
1.196 + NS_ENSURE_TRUE([port isKindOfClass:[NSNumber class]], NS_ERROR_FAILURE);
1.197 + aResultPort = [port intValue];
1.198 +
1.199 + aResultSocksProxy = keys->mIsSocksProxy;
1.200 +
1.201 + return NS_OK;
1.202 + }
1.203 +
1.204 + return NS_ERROR_FAILURE;
1.205 +
1.206 + NS_OBJC_END_TRY_ABORT_BLOCK_NSRESULT;
1.207 +}
1.208 +
1.209 +bool
1.210 +nsOSXSystemProxySettings::IsAutoconfigEnabled() const
1.211 +{
1.212 + NS_OBJC_BEGIN_TRY_ABORT_BLOCK_RETURN;
1.213 +
1.214 + NSNumber* value = [mProxyDict objectForKey:(NSString*)kSCPropNetProxiesProxyAutoConfigEnable];
1.215 + NS_ENSURE_TRUE(value == NULL || [value isKindOfClass:[NSNumber class]], false);
1.216 + return ([value intValue] != 0);
1.217 +
1.218 + NS_OBJC_END_TRY_ABORT_BLOCK_RETURN(false);
1.219 +}
1.220 +
1.221 +nsresult
1.222 +nsOSXSystemProxySettings::GetAutoconfigURL(nsAutoCString& aResult) const
1.223 +{
1.224 + NS_OBJC_BEGIN_TRY_ABORT_BLOCK_NSRESULT;
1.225 +
1.226 + NSString* value = [mProxyDict objectForKey:(NSString*)kSCPropNetProxiesProxyAutoConfigURLString];
1.227 + if (value != NULL) {
1.228 + NS_ENSURE_TRUE([value isKindOfClass:[NSString class]], NS_ERROR_FAILURE);
1.229 + aResult.Assign([value UTF8String]);
1.230 + return NS_OK;
1.231 + }
1.232 +
1.233 + return NS_ERROR_FAILURE;
1.234 +
1.235 + NS_OBJC_END_TRY_ABORT_BLOCK_NSRESULT;
1.236 +}
1.237 +
1.238 +static bool
1.239 +IsHostProxyEntry(const nsACString& aHost, const nsACString& aOverride)
1.240 +{
1.241 + nsAutoCString host(aHost);
1.242 + nsAutoCString override(aOverride);
1.243 +
1.244 + int32_t overrideLength = override.Length();
1.245 + int32_t tokenStart = 0;
1.246 + int32_t offset = 0;
1.247 + bool star = false;
1.248 +
1.249 + while (tokenStart < overrideLength) {
1.250 + int32_t tokenEnd = override.FindChar('*', tokenStart);
1.251 + if (tokenEnd == tokenStart) {
1.252 + // Star is the first character in the token.
1.253 + star = true;
1.254 + tokenStart++;
1.255 + // If the character following the '*' is a '.' character then skip
1.256 + // it so that "*.foo.com" allows "foo.com".
1.257 + if (override.FindChar('.', tokenStart) == tokenStart)
1.258 + tokenStart++;
1.259 + } else {
1.260 + if (tokenEnd == -1)
1.261 + tokenEnd = overrideLength; // no '*' char, match rest of string
1.262 + nsAutoCString token(Substring(override, tokenStart, tokenEnd - tokenStart));
1.263 + offset = host.Find(token, offset);
1.264 + if (offset == -1 || (!star && offset))
1.265 + return false;
1.266 + star = false;
1.267 + tokenStart = tokenEnd;
1.268 + offset += token.Length();
1.269 + }
1.270 + }
1.271 +
1.272 + return (star || (offset == static_cast<int32_t>(host.Length())));
1.273 +}
1.274 +
1.275 +bool
1.276 +nsOSXSystemProxySettings::IsInExceptionList(const nsACString& aHost) const
1.277 +{
1.278 + NS_OBJC_BEGIN_TRY_ABORT_BLOCK_RETURN;
1.279 +
1.280 + NS_ENSURE_TRUE(mProxyDict != NULL, false);
1.281 +
1.282 + NSArray* exceptionList = [mProxyDict objectForKey:(NSString*)kSCPropNetProxiesExceptionsList];
1.283 + NS_ENSURE_TRUE(exceptionList == NULL || [exceptionList isKindOfClass:[NSArray class]], false);
1.284 +
1.285 + NSEnumerator* exceptionEnumerator = [exceptionList objectEnumerator];
1.286 + NSString* currentValue = NULL;
1.287 + while ((currentValue = [exceptionEnumerator nextObject])) {
1.288 + NS_ENSURE_TRUE([currentValue isKindOfClass:[NSString class]], false);
1.289 + nsAutoCString overrideStr([currentValue UTF8String]);
1.290 + if (IsHostProxyEntry(aHost, overrideStr))
1.291 + return true;
1.292 + }
1.293 +
1.294 + NS_OBJC_END_TRY_ABORT_BLOCK_RETURN(false);
1.295 +}
1.296 +
1.297 +nsresult
1.298 +nsOSXSystemProxySettings::GetPACURI(nsACString& aResult)
1.299 +{
1.300 + NS_OBJC_BEGIN_TRY_ABORT_BLOCK_NSRESULT;
1.301 +
1.302 + NS_ENSURE_TRUE(mProxyDict != NULL, NS_ERROR_FAILURE);
1.303 +
1.304 + nsAutoCString pacUrl;
1.305 + if (IsAutoconfigEnabled() && NS_SUCCEEDED(GetAutoconfigURL(pacUrl))) {
1.306 + aResult.Assign(pacUrl);
1.307 + return NS_OK;
1.308 + }
1.309 +
1.310 + return NS_ERROR_FAILURE;
1.311 +
1.312 + NS_OBJC_END_TRY_ABORT_BLOCK_NSRESULT;
1.313 +}
1.314 +
1.315 +nsresult
1.316 +nsOSXSystemProxySettings::GetProxyForURI(const nsACString & aSpec,
1.317 + const nsACString & aScheme,
1.318 + const nsACString & aHost,
1.319 + const int32_t aPort,
1.320 + nsACString & aResult)
1.321 +{
1.322 + NS_OBJC_BEGIN_TRY_ABORT_BLOCK_NSRESULT;
1.323 +
1.324 + int32_t proxyPort;
1.325 + nsAutoCString proxyHost;
1.326 + bool proxySocks;
1.327 + nsresult rv = FindSCProxyPort(aScheme, proxyHost, proxyPort, proxySocks);
1.328 +
1.329 + if (NS_FAILED(rv) || IsInExceptionList(aHost)) {
1.330 + aResult.AssignLiteral("DIRECT");
1.331 + } else if (proxySocks) {
1.332 + aResult.Assign(NS_LITERAL_CSTRING("SOCKS ") + proxyHost + nsPrintfCString(":%d", proxyPort));
1.333 + } else {
1.334 + aResult.Assign(NS_LITERAL_CSTRING("PROXY ") + proxyHost + nsPrintfCString(":%d", proxyPort));
1.335 + }
1.336 +
1.337 + return NS_OK;
1.338 +
1.339 + NS_OBJC_END_TRY_ABORT_BLOCK_NSRESULT;
1.340 +}
1.341 +
1.342 +#define NS_OSXSYSTEMPROXYSERVICE_CID /* 9afcd4b8-2e0f-41f4-8f1f-3bf0d3cf67de */\
1.343 + { 0x9afcd4b8, 0x2e0f, 0x41f4, \
1.344 + { 0x8f, 0x1f, 0x3b, 0xf0, 0xd3, 0xcf, 0x67, 0xde } }
1.345 +
1.346 +NS_GENERIC_FACTORY_CONSTRUCTOR_INIT(nsOSXSystemProxySettings, Init);
1.347 +NS_DEFINE_NAMED_CID(NS_OSXSYSTEMPROXYSERVICE_CID);
1.348 +
1.349 +static const mozilla::Module::CIDEntry kOSXSysProxyCIDs[] = {
1.350 + { &kNS_OSXSYSTEMPROXYSERVICE_CID, false, NULL, nsOSXSystemProxySettingsConstructor },
1.351 + { NULL }
1.352 +};
1.353 +
1.354 +static const mozilla::Module::ContractIDEntry kOSXSysProxyContracts[] = {
1.355 + { NS_SYSTEMPROXYSETTINGS_CONTRACTID, &kNS_OSXSYSTEMPROXYSERVICE_CID },
1.356 + { NULL }
1.357 +};
1.358 +
1.359 +static const mozilla::Module kOSXSysProxyModule = {
1.360 + mozilla::Module::kVersion,
1.361 + kOSXSysProxyCIDs,
1.362 + kOSXSysProxyContracts
1.363 +};
1.364 +
1.365 +NSMODULE_DEFN(nsOSXProxyModule) = &kOSXSysProxyModule;
