// Copyright (c) 2015 GitHub, Inc. // Use of this source code is governed by the MIT license that can be // found in the LICENSE file. #include "shell/browser/api/electron_api_session.h" #include #include #include #include #include #include #include "base/command_line.h" #include "base/files/file_enumerator.h" #include "base/files/file_path.h" #include "base/files/file_util.h" #include "base/memory/raw_ptr.h" #include "base/strings/string_number_conversions.h" #include "base/strings/string_util.h" #include "base/strings/stringprintf.h" #include "base/uuid.h" #include "chrome/browser/browser_process.h" #include "chrome/common/chrome_switches.h" #include "chrome/common/pref_names.h" #include "components/download/public/common/download_danger_type.h" #include "components/download/public/common/download_url_parameters.h" #include "components/prefs/pref_service.h" #include "components/prefs/value_map_pref_store.h" #include "components/proxy_config/proxy_config_dictionary.h" #include "components/proxy_config/proxy_config_pref_names.h" #include "components/proxy_config/proxy_prefs.h" #include "content/browser/code_cache/generated_code_cache_context.h" // nogncheck #include "content/public/browser/browser_task_traits.h" #include "content/public/browser/browser_thread.h" #include "content/public/browser/download_item_utils.h" #include "content/public/browser/download_manager_delegate.h" #include "content/public/browser/network_service_instance.h" #include "content/public/browser/storage_partition.h" #include "gin/arguments.h" #include "mojo/public/cpp/bindings/pending_remote.h" #include "mojo/public/cpp/bindings/self_owned_receiver.h" #include "net/base/completion_repeating_callback.h" #include "net/base/load_flags.h" #include "net/base/network_anonymization_key.h" #include "net/http/http_auth_handler_factory.h" #include "net/http/http_auth_preferences.h" #include "net/http/http_cache.h" #include "net/http/http_util.h" #include "services/network/network_service.h" #include "services/network/public/cpp/features.h" #include "services/network/public/mojom/clear_data_filter.mojom.h" #include "shell/browser/api/electron_api_app.h" #include "shell/browser/api/electron_api_cookies.h" #include "shell/browser/api/electron_api_data_pipe_holder.h" #include "shell/browser/api/electron_api_download_item.h" #include "shell/browser/api/electron_api_net_log.h" #include "shell/browser/api/electron_api_protocol.h" #include "shell/browser/api/electron_api_service_worker_context.h" #include "shell/browser/api/electron_api_web_frame_main.h" #include "shell/browser/api/electron_api_web_request.h" #include "shell/browser/browser.h" #include "shell/browser/electron_browser_context.h" #include "shell/browser/electron_browser_main_parts.h" #include "shell/browser/electron_permission_manager.h" #include "shell/browser/javascript_environment.h" #include "shell/browser/media/media_device_id_salt.h" #include "shell/browser/net/cert_verifier_client.h" #include "shell/browser/net/resolve_host_function.h" #include "shell/browser/session_preferences.h" #include "shell/common/gin_converters/callback_converter.h" #include "shell/common/gin_converters/content_converter.h" #include "shell/common/gin_converters/file_path_converter.h" #include "shell/common/gin_converters/gurl_converter.h" #include "shell/common/gin_converters/media_converter.h" #include "shell/common/gin_converters/net_converter.h" #include "shell/common/gin_converters/usb_protected_classes_converter.h" #include "shell/common/gin_converters/value_converter.h" #include "shell/common/gin_helper/dictionary.h" #include "shell/common/gin_helper/object_template_builder.h" #include "shell/common/node_includes.h" #include "shell/common/options_switches.h" #include "shell/common/process_util.h" #include "third_party/blink/public/common/storage_key/storage_key.h" #include "third_party/blink/public/mojom/mediastream/media_stream.mojom.h" #include "ui/base/l10n/l10n_util.h" #if BUILDFLAG(ENABLE_ELECTRON_EXTENSIONS) #include "extensions/browser/extension_registry.h" #include "shell/browser/extensions/electron_extension_system.h" #include "shell/common/gin_converters/extension_converter.h" #endif #if BUILDFLAG(ENABLE_BUILTIN_SPELLCHECKER) #include "chrome/browser/spellchecker/spellcheck_factory.h" // nogncheck #include "chrome/browser/spellchecker/spellcheck_service.h" // nogncheck #include "components/spellcheck/browser/pref_names.h" #include "components/spellcheck/common/spellcheck_common.h" #if BUILDFLAG(USE_BROWSER_SPELLCHECKER) #include "components/spellcheck/browser/spellcheck_platform.h" #include "components/spellcheck/common/spellcheck_features.h" #endif #endif using content::BrowserThread; using content::StoragePartition; namespace { struct ClearStorageDataOptions { blink::StorageKey storage_key; uint32_t storage_types = StoragePartition::REMOVE_DATA_MASK_ALL; uint32_t quota_types = StoragePartition::QUOTA_MANAGED_STORAGE_MASK_ALL; }; uint32_t GetStorageMask(const std::vector& storage_types) { uint32_t storage_mask = 0; for (const auto& it : storage_types) { auto type = base::ToLowerASCII(it); if (type == "cookies") storage_mask |= StoragePartition::REMOVE_DATA_MASK_COOKIES; else if (type == "filesystem") storage_mask |= StoragePartition::REMOVE_DATA_MASK_FILE_SYSTEMS; else if (type == "indexdb") storage_mask |= StoragePartition::REMOVE_DATA_MASK_INDEXEDDB; else if (type == "localstorage") storage_mask |= StoragePartition::REMOVE_DATA_MASK_LOCAL_STORAGE; else if (type == "shadercache") storage_mask |= StoragePartition::REMOVE_DATA_MASK_SHADER_CACHE; else if (type == "websql") storage_mask |= StoragePartition::REMOVE_DATA_MASK_WEBSQL; else if (type == "serviceworkers") storage_mask |= StoragePartition::REMOVE_DATA_MASK_SERVICE_WORKERS; else if (type == "cachestorage") storage_mask |= StoragePartition::REMOVE_DATA_MASK_CACHE_STORAGE; } return storage_mask; } uint32_t GetQuotaMask(const std::vector& quota_types) { uint32_t quota_mask = 0; for (const auto& it : quota_types) { auto type = base::ToLowerASCII(it); if (type == "temporary") quota_mask |= StoragePartition::QUOTA_MANAGED_STORAGE_MASK_TEMPORARY; else if (type == "syncable") quota_mask |= StoragePartition::QUOTA_MANAGED_STORAGE_MASK_SYNCABLE; } return quota_mask; } base::Value::Dict createProxyConfig(ProxyPrefs::ProxyMode proxy_mode, std::string const& pac_url, std::string const& proxy_server, std::string const& bypass_list) { if (proxy_mode == ProxyPrefs::MODE_DIRECT) { return ProxyConfigDictionary::CreateDirect(); } if (proxy_mode == ProxyPrefs::MODE_SYSTEM) { return ProxyConfigDictionary::CreateSystem(); } if (proxy_mode == ProxyPrefs::MODE_AUTO_DETECT) { return ProxyConfigDictionary::CreateAutoDetect(); } if (proxy_mode == ProxyPrefs::MODE_PAC_SCRIPT) { const bool pac_mandatory = true; return ProxyConfigDictionary::CreatePacScript(pac_url, pac_mandatory); } return ProxyConfigDictionary::CreateFixedServers(proxy_server, bypass_list); } } // namespace namespace gin { template <> struct Converter { static bool FromV8(v8::Isolate* isolate, v8::Local val, ClearStorageDataOptions* out) { gin_helper::Dictionary options; if (!ConvertFromV8(isolate, val, &options)) return false; if (GURL storage_origin; options.Get("origin", &storage_origin)) out->storage_key = blink::StorageKey::CreateFirstParty( url::Origin::Create(storage_origin)); std::vector types; if (options.Get("storages", &types)) out->storage_types = GetStorageMask(types); if (options.Get("quotas", &types)) out->quota_types = GetQuotaMask(types); return true; } }; bool SSLProtocolVersionFromString(const std::string& version_str, network::mojom::SSLVersion* version) { if (version_str == switches::kSSLVersionTLSv12) { *version = network::mojom::SSLVersion::kTLS12; return true; } if (version_str == switches::kSSLVersionTLSv13) { *version = network::mojom::SSLVersion::kTLS13; return true; } return false; } template <> struct Converter { static bool FromV8(v8::Isolate* isolate, v8::Local val, uint16_t* out) { auto maybe = val->IntegerValue(isolate->GetCurrentContext()); if (maybe.IsNothing()) return false; *out = maybe.FromJust(); return true; } }; template <> struct Converter { static bool FromV8(v8::Isolate* isolate, v8::Local val, network::mojom::SSLConfigPtr* out) { gin_helper::Dictionary options; if (!ConvertFromV8(isolate, val, &options)) return false; *out = network::mojom::SSLConfig::New(); std::string version_min_str; if (options.Get("minVersion", &version_min_str)) { if (!SSLProtocolVersionFromString(version_min_str, &(*out)->version_min)) return false; } std::string version_max_str; if (options.Get("maxVersion", &version_max_str)) { if (!SSLProtocolVersionFromString(version_max_str, &(*out)->version_max) || (*out)->version_max < network::mojom::SSLVersion::kTLS12) return false; } if (options.Has("disabledCipherSuites") && !options.Get("disabledCipherSuites", &(*out)->disabled_cipher_suites)) { return false; } std::sort((*out)->disabled_cipher_suites.begin(), (*out)->disabled_cipher_suites.end()); // TODO(nornagon): also support other SSLConfig properties? return true; } }; } // namespace gin namespace electron::api { namespace { const char kPersistPrefix[] = "persist:"; void DownloadIdCallback(content::DownloadManager* download_manager, const base::FilePath& path, const std::vector& url_chain, const std::string& mime_type, int64_t offset, int64_t length, const std::string& last_modified, const std::string& etag, const base::Time& start_time, uint32_t id) { download_manager->CreateDownloadItem( base::Uuid::GenerateRandomV4().AsLowercaseString(), id, path, path, url_chain, GURL(), content::StoragePartitionConfig::CreateDefault( download_manager->GetBrowserContext()), GURL(), GURL(), absl::nullopt, mime_type, mime_type, start_time, base::Time(), etag, last_modified, offset, length, std::string(), download::DownloadItem::INTERRUPTED, download::DOWNLOAD_DANGER_TYPE_NOT_DANGEROUS, download::DOWNLOAD_INTERRUPT_REASON_NETWORK_TIMEOUT, false, base::Time(), false, std::vector()); } #if BUILDFLAG(ENABLE_BUILTIN_SPELLCHECKER) class DictionaryObserver final : public SpellcheckCustomDictionary::Observer { private: std::unique_ptr>> promise_; base::WeakPtr spellcheck_; public: DictionaryObserver(gin_helper::Promise> promise, base::WeakPtr spellcheck) : spellcheck_(spellcheck) { promise_ = std::make_unique>>( std::move(promise)); if (spellcheck_) spellcheck_->GetCustomDictionary()->AddObserver(this); } ~DictionaryObserver() { if (spellcheck_) spellcheck_->GetCustomDictionary()->RemoveObserver(this); } void OnCustomDictionaryLoaded() override { if (spellcheck_) { promise_->Resolve(spellcheck_->GetCustomDictionary()->GetWords()); } else { promise_->RejectWithErrorMessage( "Spellcheck in unexpected state: failed to load custom dictionary."); } delete this; } void OnCustomDictionaryChanged( const SpellcheckCustomDictionary::Change& dictionary_change) override { // noop } }; #endif // BUILDFLAG(ENABLE_BUILTIN_SPELLCHECKER) struct UserDataLink : base::SupportsUserData::Data { explicit UserDataLink(Session* ses) : session(ses) {} raw_ptr session; }; const void* kElectronApiSessionKey = &kElectronApiSessionKey; } // namespace gin::WrapperInfo Session::kWrapperInfo = {gin::kEmbedderNativeGin}; Session::Session(v8::Isolate* isolate, ElectronBrowserContext* browser_context) : isolate_(isolate), network_emulation_token_(base::UnguessableToken::Create()), browser_context_(browser_context) { // Observe DownloadManager to get download notifications. browser_context->GetDownloadManager()->AddObserver(this); SessionPreferences::CreateForBrowserContext(browser_context); protocol_.Reset(isolate, Protocol::Create(isolate, browser_context).ToV8()); browser_context->SetUserData(kElectronApiSessionKey, std::make_unique(this)); #if BUILDFLAG(ENABLE_BUILTIN_SPELLCHECKER) SpellcheckService* service = SpellcheckServiceFactory::GetForContext(browser_context_); if (service) { service->SetHunspellObserver(this); } #endif #if BUILDFLAG(ENABLE_ELECTRON_EXTENSIONS) extensions::ExtensionRegistry::Get(browser_context)->AddObserver(this); #endif } Session::~Session() { browser_context()->GetDownloadManager()->RemoveObserver(this); #if BUILDFLAG(ENABLE_BUILTIN_SPELLCHECKER) SpellcheckService* service = SpellcheckServiceFactory::GetForContext(browser_context_); if (service) { service->SetHunspellObserver(nullptr); } #endif #if BUILDFLAG(ENABLE_ELECTRON_EXTENSIONS) extensions::ExtensionRegistry::Get(browser_context())->RemoveObserver(this); #endif } void Session::OnDownloadCreated(content::DownloadManager* manager, download::DownloadItem* item) { if (item->IsSavePackageDownload()) return; v8::HandleScope handle_scope(isolate_); auto handle = DownloadItem::FromOrCreate(isolate_, item); if (item->GetState() == download::DownloadItem::INTERRUPTED) handle->SetSavePath(item->GetTargetFilePath()); content::WebContents* web_contents = content::DownloadItemUtils::GetWebContents(item); bool prevent_default = Emit("will-download", handle, web_contents); if (prevent_default) { item->Cancel(true); item->Remove(); } } #if BUILDFLAG(ENABLE_BUILTIN_SPELLCHECKER) void Session::OnHunspellDictionaryInitialized(const std::string& language) { Emit("spellcheck-dictionary-initialized", language); } void Session::OnHunspellDictionaryDownloadBegin(const std::string& language) { Emit("spellcheck-dictionary-download-begin", language); } void Session::OnHunspellDictionaryDownloadSuccess(const std::string& language) { Emit("spellcheck-dictionary-download-success", language); } void Session::OnHunspellDictionaryDownloadFailure(const std::string& language) { Emit("spellcheck-dictionary-download-failure", language); } #endif v8::Local Session::ResolveProxy(gin::Arguments* args) { v8::Isolate* isolate = args->isolate(); gin_helper::Promise promise(isolate); v8::Local handle = promise.GetHandle(); GURL url; args->GetNext(&url); browser_context_->GetResolveProxyHelper()->ResolveProxy( url, base::BindOnce(gin_helper::Promise::ResolvePromise, std::move(promise))); return handle; } v8::Local Session::ResolveHost( std::string host, absl::optional params) { gin_helper::Promise promise(isolate_); v8::Local handle = promise.GetHandle(); auto fn = base::MakeRefCounted( browser_context_, std::move(host), params ? std::move(params.value()) : nullptr, base::BindOnce( [](gin_helper::Promise promise, int64_t net_error, const absl::optional& addrs) { if (net_error < 0) { promise.RejectWithErrorMessage(net::ErrorToString(net_error)); } else { DCHECK(addrs.has_value() && !addrs->empty()); v8::HandleScope handle_scope(promise.isolate()); auto dict = gin_helper::Dictionary::CreateEmpty(promise.isolate()); dict.Set("endpoints", addrs->endpoints()); promise.Resolve(dict); } }, std::move(promise))); fn->Run(); return handle; } v8::Local Session::GetCacheSize() { gin_helper::Promise promise(isolate_); auto handle = promise.GetHandle(); browser_context_->GetDefaultStoragePartition() ->GetNetworkContext() ->ComputeHttpCacheSize( base::Time(), base::Time::Max(), base::BindOnce( [](gin_helper::Promise promise, bool is_upper_bound, int64_t size_or_error) { if (size_or_error < 0) { promise.RejectWithErrorMessage( net::ErrorToString(size_or_error)); } else { promise.Resolve(size_or_error); } }, std::move(promise))); return handle; } v8::Local Session::ClearCache() { gin_helper::Promise promise(isolate_); auto handle = promise.GetHandle(); browser_context_->GetDefaultStoragePartition() ->GetNetworkContext() ->ClearHttpCache(base::Time(), base::Time::Max(), nullptr, base::BindOnce(gin_helper::Promise::ResolvePromise, std::move(promise))); return handle; } v8::Local Session::ClearStorageData(gin::Arguments* args) { v8::Isolate* isolate = args->isolate(); gin_helper::Promise promise(isolate); v8::Local handle = promise.GetHandle(); ClearStorageDataOptions options; args->GetNext(&options); auto* storage_partition = browser_context()->GetStoragePartition(nullptr); if (options.storage_types & StoragePartition::REMOVE_DATA_MASK_COOKIES) { // Reset media device id salt when cookies are cleared. // https://w3c.github.io/mediacapture-main/#dom-mediadeviceinfo-deviceid MediaDeviceIDSalt::Reset(browser_context()->prefs()); } storage_partition->ClearData( options.storage_types, options.quota_types, options.storage_key, base::Time(), base::Time::Max(), base::BindOnce(gin_helper::Promise::ResolvePromise, std::move(promise))); return handle; } void Session::FlushStorageData() { auto* storage_partition = browser_context()->GetStoragePartition(nullptr); storage_partition->Flush(); } v8::Local Session::SetProxy(gin::Arguments* args) { v8::Isolate* isolate = args->isolate(); gin_helper::Promise promise(isolate); v8::Local handle = promise.GetHandle(); gin_helper::Dictionary options; args->GetNext(&options); if (!browser_context_->in_memory_pref_store()) { promise.Resolve(); return handle; } std::string mode, proxy_rules, bypass_list, pac_url; options.Get("pacScript", &pac_url); options.Get("proxyRules", &proxy_rules); options.Get("proxyBypassRules", &bypass_list); ProxyPrefs::ProxyMode proxy_mode = ProxyPrefs::MODE_FIXED_SERVERS; if (!options.Get("mode", &mode)) { // pacScript takes precedence over proxyRules. if (!pac_url.empty()) { proxy_mode = ProxyPrefs::MODE_PAC_SCRIPT; } else { proxy_mode = ProxyPrefs::MODE_FIXED_SERVERS; } } else { if (!ProxyPrefs::StringToProxyMode(mode, &proxy_mode)) { promise.RejectWithErrorMessage( "Invalid mode, must be one of direct, auto_detect, pac_script, " "fixed_servers or system"); return handle; } } browser_context_->in_memory_pref_store()->SetValue( proxy_config::prefs::kProxy, base::Value{ createProxyConfig(proxy_mode, pac_url, proxy_rules, bypass_list)}, WriteablePrefStore::DEFAULT_PREF_WRITE_FLAGS); base::SingleThreadTaskRunner::GetCurrentDefault()->PostTask( FROM_HERE, base::BindOnce(gin_helper::Promise::ResolvePromise, std::move(promise))); return handle; } v8::Local Session::ForceReloadProxyConfig() { gin_helper::Promise promise(isolate_); auto handle = promise.GetHandle(); browser_context_->GetDefaultStoragePartition() ->GetNetworkContext() ->ForceReloadProxyConfig(base::BindOnce( gin_helper::Promise::ResolvePromise, std::move(promise))); return handle; } void Session::SetDownloadPath(const base::FilePath& path) { browser_context_->prefs()->SetFilePath(prefs::kDownloadDefaultDirectory, path); } void Session::EnableNetworkEmulation(const gin_helper::Dictionary& options) { auto conditions = network::mojom::NetworkConditions::New(); options.Get("offline", &conditions->offline); options.Get("downloadThroughput", &conditions->download_throughput); options.Get("uploadThroughput", &conditions->upload_throughput); double latency = 0.0; if (options.Get("latency", &latency) && latency) { conditions->latency = base::Milliseconds(latency); } auto* network_context = browser_context_->GetDefaultStoragePartition()->GetNetworkContext(); network_context->SetNetworkConditions(network_emulation_token_, std::move(conditions)); } void Session::DisableNetworkEmulation() { auto* network_context = browser_context_->GetDefaultStoragePartition()->GetNetworkContext(); network_context->SetNetworkConditions( network_emulation_token_, network::mojom::NetworkConditions::New()); } void Session::SetCertVerifyProc(v8::Local val, gin::Arguments* args) { CertVerifierClient::CertVerifyProc proc; if (!(val->IsNull() || gin::ConvertFromV8(args->isolate(), val, &proc))) { args->ThrowTypeError("Must pass null or function"); return; } mojo::PendingRemote cert_verifier_client_remote; if (proc) { mojo::MakeSelfOwnedReceiver( std::make_unique(proc), cert_verifier_client_remote.InitWithNewPipeAndPassReceiver()); } browser_context_->GetDefaultStoragePartition() ->GetNetworkContext() ->SetCertVerifierClient(std::move(cert_verifier_client_remote)); } void Session::SetPermissionRequestHandler(v8::Local val, gin::Arguments* args) { auto* permission_manager = static_cast( browser_context()->GetPermissionControllerDelegate()); if (val->IsNull()) { permission_manager->SetPermissionRequestHandler( ElectronPermissionManager::RequestHandler()); return; } auto handler = std::make_unique(); if (!gin::ConvertFromV8(args->isolate(), val, handler.get())) { args->ThrowTypeError("Must pass null or function"); return; } permission_manager->SetPermissionRequestHandler(base::BindRepeating( [](ElectronPermissionManager::RequestHandler* handler, content::WebContents* web_contents, blink::PermissionType permission_type, ElectronPermissionManager::StatusCallback callback, const base::Value& details) { handler->Run(web_contents, permission_type, std::move(callback), details); }, base::Owned(std::move(handler)))); } void Session::SetPermissionCheckHandler(v8::Local val, gin::Arguments* args) { ElectronPermissionManager::CheckHandler handler; if (!(val->IsNull() || gin::ConvertFromV8(args->isolate(), val, &handler))) { args->ThrowTypeError("Must pass null or function"); return; } auto* permission_manager = static_cast( browser_context()->GetPermissionControllerDelegate()); permission_manager->SetPermissionCheckHandler(handler); } void Session::SetDisplayMediaRequestHandler(v8::Isolate* isolate, v8::Local val) { if (val->IsNull()) { browser_context_->SetDisplayMediaRequestHandler( DisplayMediaRequestHandler()); return; } DisplayMediaRequestHandler handler; if (!gin::ConvertFromV8(isolate, val, &handler)) { gin_helper::ErrorThrower(isolate).ThrowTypeError( "Display media request handler must be null or a function"); return; } browser_context_->SetDisplayMediaRequestHandler(handler); } void Session::SetDevicePermissionHandler(v8::Local val, gin::Arguments* args) { ElectronPermissionManager::DeviceCheckHandler handler; if (!(val->IsNull() || gin::ConvertFromV8(args->isolate(), val, &handler))) { args->ThrowTypeError("Must pass null or function"); return; } auto* permission_manager = static_cast( browser_context()->GetPermissionControllerDelegate()); permission_manager->SetDevicePermissionHandler(handler); } void Session::SetUSBProtectedClassesHandler(v8::Local val, gin::Arguments* args) { ElectronPermissionManager::ProtectedUSBHandler handler; if (!(val->IsNull() || gin::ConvertFromV8(args->isolate(), val, &handler))) { args->ThrowTypeError("Must pass null or function"); return; } auto* permission_manager = static_cast( browser_context()->GetPermissionControllerDelegate()); permission_manager->SetProtectedUSBHandler(handler); } void Session::SetBluetoothPairingHandler(v8::Local val, gin::Arguments* args) { ElectronPermissionManager::BluetoothPairingHandler handler; if (!(val->IsNull() || gin::ConvertFromV8(args->isolate(), val, &handler))) { args->ThrowTypeError("Must pass null or function"); return; } auto* permission_manager = static_cast( browser_context()->GetPermissionControllerDelegate()); permission_manager->SetBluetoothPairingHandler(handler); } v8::Local Session::ClearHostResolverCache(gin::Arguments* args) { v8::Isolate* isolate = args->isolate(); gin_helper::Promise promise(isolate); v8::Local handle = promise.GetHandle(); browser_context_->GetDefaultStoragePartition() ->GetNetworkContext() ->ClearHostCache(nullptr, base::BindOnce(gin_helper::Promise::ResolvePromise, std::move(promise))); return handle; } v8::Local Session::ClearAuthCache() { gin_helper::Promise promise(isolate_); v8::Local handle = promise.GetHandle(); browser_context_->GetDefaultStoragePartition() ->GetNetworkContext() ->ClearHttpAuthCache( base::Time(), base::Time::Max(), base::BindOnce(gin_helper::Promise::ResolvePromise, std::move(promise))); return handle; } void Session::AllowNTLMCredentialsForDomains(const std::string& domains) { auto* command_line = base::CommandLine::ForCurrentProcess(); network::mojom::HttpAuthDynamicParamsPtr auth_dynamic_params = network::mojom::HttpAuthDynamicParams::New(); auth_dynamic_params->server_allowlist = domains; auth_dynamic_params->enable_negotiate_port = command_line->HasSwitch(electron::switches::kEnableAuthNegotiatePort); auth_dynamic_params->ntlm_v2_enabled = !command_line->HasSwitch(electron::switches::kDisableNTLMv2); content::GetNetworkService()->ConfigureHttpAuthPrefs( std::move(auth_dynamic_params)); } void Session::SetUserAgent(const std::string& user_agent, gin::Arguments* args) { browser_context_->SetUserAgent(user_agent); auto* network_context = browser_context_->GetDefaultStoragePartition()->GetNetworkContext(); network_context->SetUserAgent(user_agent); std::string accept_lang; if (args->GetNext(&accept_lang)) { network_context->SetAcceptLanguage( net::HttpUtil::GenerateAcceptLanguageHeader(accept_lang)); } } std::string Session::GetUserAgent() { return browser_context_->GetUserAgent(); } void Session::SetSSLConfig(network::mojom::SSLConfigPtr config) { browser_context_->SetSSLConfig(std::move(config)); } bool Session::IsPersistent() { return !browser_context_->IsOffTheRecord(); } v8::Local Session::GetBlobData(v8::Isolate* isolate, const std::string& uuid) { gin::Handle holder = DataPipeHolder::From(isolate, uuid); if (holder.IsEmpty()) { gin_helper::Promise> promise(isolate); promise.RejectWithErrorMessage("Could not get blob data handle"); return promise.GetHandle(); } return holder->ReadAll(isolate); } void Session::DownloadURL(const GURL& url, gin::Arguments* args) { std::map headers; gin_helper::Dictionary options; if (args->GetNext(&options)) { if (options.Has("headers") && !options.Get("headers", &headers)) { args->ThrowTypeError("Invalid value for headers - must be an object"); return; } } auto download_params = std::make_unique( url, MISSING_TRAFFIC_ANNOTATION); for (const auto& [name, value] : headers) { download_params->add_request_header(name, value); } auto* download_manager = browser_context()->GetDownloadManager(); download_manager->DownloadUrl(std::move(download_params)); } void Session::CreateInterruptedDownload(const gin_helper::Dictionary& options) { int64_t offset = 0, length = 0; double start_time = base::Time::Now().ToDoubleT(); std::string mime_type, last_modified, etag; base::FilePath path; std::vector url_chain; options.Get("path", &path); options.Get("urlChain", &url_chain); options.Get("mimeType", &mime_type); options.Get("offset", &offset); options.Get("length", &length); options.Get("lastModified", &last_modified); options.Get("eTag", &etag); options.Get("startTime", &start_time); if (path.empty() || url_chain.empty() || length == 0) { isolate_->ThrowException(v8::Exception::Error(gin::StringToV8( isolate_, "Must pass non-empty path, urlChain and length."))); return; } if (offset >= length) { isolate_->ThrowException(v8::Exception::Error(gin::StringToV8( isolate_, "Must pass an offset value less than length."))); return; } auto* download_manager = browser_context()->GetDownloadManager(); download_manager->GetNextId(base::BindRepeating( &DownloadIdCallback, download_manager, path, url_chain, mime_type, offset, length, last_modified, etag, base::Time::FromDoubleT(start_time))); } void Session::SetPreloads(const std::vector& preloads) { auto* prefs = SessionPreferences::FromBrowserContext(browser_context()); DCHECK(prefs); prefs->set_preloads(preloads); } std::vector Session::GetPreloads() const { auto* prefs = SessionPreferences::FromBrowserContext(browser_context()); DCHECK(prefs); return prefs->preloads(); } #if BUILDFLAG(ENABLE_ELECTRON_EXTENSIONS) v8::Local Session::LoadExtension( const base::FilePath& extension_path, gin::Arguments* args) { gin_helper::Promise promise(isolate_); v8::Local handle = promise.GetHandle(); if (!extension_path.IsAbsolute()) { promise.RejectWithErrorMessage( "The path to the extension in 'loadExtension' must be absolute"); return handle; } if (browser_context()->IsOffTheRecord()) { promise.RejectWithErrorMessage( "Extensions cannot be loaded in a temporary session"); return handle; } int load_flags = extensions::Extension::FOLLOW_SYMLINKS_ANYWHERE; gin_helper::Dictionary options; if (args->GetNext(&options)) { bool allowFileAccess = false; options.Get("allowFileAccess", &allowFileAccess); if (allowFileAccess) load_flags |= extensions::Extension::ALLOW_FILE_ACCESS; } auto* extension_system = static_cast( extensions::ExtensionSystem::Get(browser_context())); extension_system->LoadExtension( extension_path, load_flags, base::BindOnce( [](gin_helper::Promise promise, const extensions::Extension* extension, const std::string& error_msg) { if (extension) { if (!error_msg.empty()) { node::Environment* env = node::Environment::GetCurrent(promise.isolate()); EmitWarning(env, error_msg, "ExtensionLoadWarning"); } promise.Resolve(extension); } else { promise.RejectWithErrorMessage(error_msg); } }, std::move(promise))); return handle; } void Session::RemoveExtension(const std::string& extension_id) { auto* extension_system = static_cast( extensions::ExtensionSystem::Get(browser_context())); extension_system->RemoveExtension(extension_id); } v8::Local Session::GetExtension(const std::string& extension_id) { auto* registry = extensions::ExtensionRegistry::Get(browser_context()); const extensions::Extension* extension = registry->GetInstalledExtension(extension_id); if (extension) { return gin::ConvertToV8(isolate_, extension); } else { return v8::Null(isolate_); } } v8::Local Session::GetAllExtensions() { auto* registry = extensions::ExtensionRegistry::Get(browser_context()); const extensions::ExtensionSet extensions = registry->GenerateInstalledExtensionsSet(); std::vector extensions_vector; for (const auto& extension : extensions) { if (extension->location() != extensions::mojom::ManifestLocation::kComponent) extensions_vector.emplace_back(extension.get()); } return gin::ConvertToV8(isolate_, extensions_vector); } void Session::OnExtensionLoaded(content::BrowserContext* browser_context, const extensions::Extension* extension) { Emit("extension-loaded", extension); } void Session::OnExtensionUnloaded(content::BrowserContext* browser_context, const extensions::Extension* extension, extensions::UnloadedExtensionReason reason) { Emit("extension-unloaded", extension); } void Session::OnExtensionReady(content::BrowserContext* browser_context, const extensions::Extension* extension) { Emit("extension-ready", extension); } #endif v8::Local Session::Cookies(v8::Isolate* isolate) { if (cookies_.IsEmpty()) { auto handle = Cookies::Create(isolate, browser_context()); cookies_.Reset(isolate, handle.ToV8()); } return cookies_.Get(isolate); } v8::Local Session::Protocol(v8::Isolate* isolate) { return protocol_.Get(isolate); } v8::Local Session::ServiceWorkerContext(v8::Isolate* isolate) { if (service_worker_context_.IsEmpty()) { v8::Local handle; handle = ServiceWorkerContext::Create(isolate, browser_context()).ToV8(); service_worker_context_.Reset(isolate, handle); } return service_worker_context_.Get(isolate); } v8::Local Session::WebRequest(v8::Isolate* isolate) { if (web_request_.IsEmpty()) { auto handle = WebRequest::Create(isolate, browser_context()); web_request_.Reset(isolate, handle.ToV8()); } return web_request_.Get(isolate); } v8::Local Session::NetLog(v8::Isolate* isolate) { if (net_log_.IsEmpty()) { auto handle = NetLog::Create(isolate, browser_context()); net_log_.Reset(isolate, handle.ToV8()); } return net_log_.Get(isolate); } static void StartPreconnectOnUI(ElectronBrowserContext* browser_context, const GURL& url, int num_sockets_to_preconnect) { url::Origin origin = url::Origin::Create(url); std::vector requests = { {url::Origin::Create(url), num_sockets_to_preconnect, net::NetworkAnonymizationKey::CreateSameSite( net::SchemefulSite(origin))}}; browser_context->GetPreconnectManager()->Start(url, requests); } void Session::Preconnect(const gin_helper::Dictionary& options, gin::Arguments* args) { GURL url; if (!options.Get("url", &url) || !url.is_valid()) { args->ThrowTypeError( "Must pass non-empty valid url to session.preconnect."); return; } int num_sockets_to_preconnect = 1; if (options.Get("numSockets", &num_sockets_to_preconnect)) { const int kMinSocketsToPreconnect = 1; const int kMaxSocketsToPreconnect = 6; if (num_sockets_to_preconnect < kMinSocketsToPreconnect || num_sockets_to_preconnect > kMaxSocketsToPreconnect) { args->ThrowTypeError( base::StringPrintf("numSocketsToPreconnect is outside range [%d,%d]", kMinSocketsToPreconnect, kMaxSocketsToPreconnect)); return; } } DCHECK_GT(num_sockets_to_preconnect, 0); content::GetUIThreadTaskRunner({})->PostTask( FROM_HERE, base::BindOnce(&StartPreconnectOnUI, base::Unretained(browser_context_), url, num_sockets_to_preconnect)); } v8::Local Session::CloseAllConnections() { gin_helper::Promise promise(isolate_); auto handle = promise.GetHandle(); browser_context_->GetDefaultStoragePartition() ->GetNetworkContext() ->CloseAllConnections(base::BindOnce( gin_helper::Promise::ResolvePromise, std::move(promise))); return handle; } v8::Local Session::GetPath(v8::Isolate* isolate) { if (browser_context_->IsOffTheRecord()) { return v8::Null(isolate); } return gin::ConvertToV8(isolate, browser_context_->GetPath()); } void Session::SetCodeCachePath(gin::Arguments* args) { base::FilePath code_cache_path; auto* storage_partition = browser_context_->GetDefaultStoragePartition(); auto* code_cache_context = storage_partition->GetGeneratedCodeCacheContext(); if (code_cache_context) { if (!args->GetNext(&code_cache_path) || !code_cache_path.IsAbsolute()) { args->ThrowTypeError( "Absolute path must be provided to store code cache."); return; } code_cache_context->Initialize( code_cache_path, 0 /* allows disk_cache to choose the size */); } } v8::Local Session::ClearCodeCaches( const gin_helper::Dictionary& options) { auto* isolate = JavascriptEnvironment::GetIsolate(); gin_helper::Promise promise(isolate); v8::Local handle = promise.GetHandle(); std::set url_list; base::RepeatingCallback url_matcher = base::NullCallback(); if (options.Get("urls", &url_list) && !url_list.empty()) { url_matcher = base::BindRepeating( [](const std::set& url_list, const GURL& url) { return base::Contains(url_list, url); }, url_list); } browser_context_->GetDefaultStoragePartition()->ClearCodeCaches( base::Time(), base::Time::Max(), url_matcher, base::BindOnce(gin_helper::Promise::ResolvePromise, std::move(promise))); return handle; } #if BUILDFLAG(ENABLE_BUILTIN_SPELLCHECKER) base::Value Session::GetSpellCheckerLanguages() { return browser_context_->prefs() ->GetValue(spellcheck::prefs::kSpellCheckDictionaries) .Clone(); } void Session::SetSpellCheckerLanguages( gin_helper::ErrorThrower thrower, const std::vector& languages) { #if !BUILDFLAG(IS_MAC) base::Value::List language_codes; for (const std::string& lang : languages) { std::string code = spellcheck::GetCorrespondingSpellCheckLanguage(lang); if (code.empty()) { thrower.ThrowError("Invalid language code provided: \"" + lang + "\" is not a valid language code"); return; } language_codes.Append(code); } browser_context_->prefs()->Set(spellcheck::prefs::kSpellCheckDictionaries, base::Value(std::move(language_codes))); // Enable spellcheck if > 0 languages, disable if no languages set browser_context_->prefs()->SetBoolean(spellcheck::prefs::kSpellCheckEnable, !languages.empty()); #endif } void SetSpellCheckerDictionaryDownloadURL(gin_helper::ErrorThrower thrower, const GURL& url) { #if !BUILDFLAG(IS_MAC) if (!url.is_valid()) { thrower.ThrowError( "The URL you provided to setSpellCheckerDictionaryDownloadURL is not a " "valid URL"); return; } SpellcheckHunspellDictionary::SetBaseDownloadURL(url); #endif } v8::Local Session::ListWordsInSpellCheckerDictionary() { gin_helper::Promise> promise(isolate_); v8::Local handle = promise.GetHandle(); SpellcheckService* spellcheck = SpellcheckServiceFactory::GetForContext(browser_context_); if (!spellcheck) { promise.RejectWithErrorMessage( "Spellcheck in unexpected state: failed to load custom dictionary."); return handle; } if (spellcheck->GetCustomDictionary()->IsLoaded()) { promise.Resolve(spellcheck->GetCustomDictionary()->GetWords()); } else { new DictionaryObserver(std::move(promise), spellcheck->GetWeakPtr()); // Dictionary loads by default asynchronously, // call the load function anyways just to be sure. spellcheck->GetCustomDictionary()->Load(); } return handle; } bool Session::AddWordToSpellCheckerDictionary(const std::string& word) { // don't let in-memory sessions add spellchecker words // because files will persist unintentionally bool is_in_memory = browser_context_->IsOffTheRecord(); if (is_in_memory) return false; SpellcheckService* service = SpellcheckServiceFactory::GetForContext(browser_context_); if (!service) return false; #if BUILDFLAG(USE_BROWSER_SPELLCHECKER) if (spellcheck::UseBrowserSpellChecker()) { spellcheck_platform::AddWord(service->platform_spell_checker(), base::UTF8ToUTF16(word)); } #endif return service->GetCustomDictionary()->AddWord(word); } bool Session::RemoveWordFromSpellCheckerDictionary(const std::string& word) { // don't let in-memory sessions remove spellchecker words // because files will persist unintentionally bool is_in_memory = browser_context_->IsOffTheRecord(); if (is_in_memory) return false; SpellcheckService* service = SpellcheckServiceFactory::GetForContext(browser_context_); if (!service) return false; #if BUILDFLAG(USE_BROWSER_SPELLCHECKER) if (spellcheck::UseBrowserSpellChecker()) { spellcheck_platform::RemoveWord(service->platform_spell_checker(), base::UTF8ToUTF16(word)); } #endif return service->GetCustomDictionary()->RemoveWord(word); } void Session::SetSpellCheckerEnabled(bool b) { browser_context_->prefs()->SetBoolean(spellcheck::prefs::kSpellCheckEnable, b); } bool Session::IsSpellCheckerEnabled() const { return browser_context_->prefs()->GetBoolean( spellcheck::prefs::kSpellCheckEnable); } #endif // BUILDFLAG(ENABLE_BUILTIN_SPELLCHECKER) // static Session* Session::FromBrowserContext(content::BrowserContext* context) { auto* data = static_cast(context->GetUserData(kElectronApiSessionKey)); return data ? data->session : nullptr; } // static gin::Handle Session::CreateFrom( v8::Isolate* isolate, ElectronBrowserContext* browser_context) { Session* existing = FromBrowserContext(browser_context); if (existing) return gin::CreateHandle(isolate, existing); auto handle = gin::CreateHandle(isolate, new Session(isolate, browser_context)); // The Sessions should never be garbage collected, since the common pattern is // to use partition strings, instead of using the Session object directly. handle->Pin(isolate); App::Get()->EmitWithoutEvent("session-created", handle); return handle; } // static gin::Handle Session::FromPartition(v8::Isolate* isolate, const std::string& partition, base::Value::Dict options) { ElectronBrowserContext* browser_context; if (partition.empty()) { browser_context = ElectronBrowserContext::From("", false, std::move(options)); } else if (base::StartsWith(partition, kPersistPrefix, base::CompareCase::SENSITIVE)) { std::string name = partition.substr(8); browser_context = ElectronBrowserContext::From(name, false, std::move(options)); } else { browser_context = ElectronBrowserContext::From(partition, true, std::move(options)); } return CreateFrom(isolate, browser_context); } // static absl::optional> Session::FromPath( v8::Isolate* isolate, const base::FilePath& path, base::Value::Dict options) { ElectronBrowserContext* browser_context; if (path.empty()) { gin_helper::Promise> promise(isolate); promise.RejectWithErrorMessage("An empty path was specified"); return absl::nullopt; } if (!path.IsAbsolute()) { gin_helper::Promise> promise(isolate); promise.RejectWithErrorMessage("An absolute path was not provided"); return absl::nullopt; } browser_context = ElectronBrowserContext::FromPath(std::move(path), std::move(options)); return CreateFrom(isolate, browser_context); } // static gin::Handle Session::New() { gin_helper::ErrorThrower(JavascriptEnvironment::GetIsolate()) .ThrowError("Session objects cannot be created with 'new'"); return gin::Handle(); } void Session::FillObjectTemplate(v8::Isolate* isolate, v8::Local templ) { gin::ObjectTemplateBuilder(isolate, GetClassName(), templ) .SetMethod("resolveHost", &Session::ResolveHost) .SetMethod("resolveProxy", &Session::ResolveProxy) .SetMethod("getCacheSize", &Session::GetCacheSize) .SetMethod("clearCache", &Session::ClearCache) .SetMethod("clearStorageData", &Session::ClearStorageData) .SetMethod("flushStorageData", &Session::FlushStorageData) .SetMethod("setProxy", &Session::SetProxy) .SetMethod("forceReloadProxyConfig", &Session::ForceReloadProxyConfig) .SetMethod("setDownloadPath", &Session::SetDownloadPath) .SetMethod("enableNetworkEmulation", &Session::EnableNetworkEmulation) .SetMethod("disableNetworkEmulation", &Session::DisableNetworkEmulation) .SetMethod("setCertificateVerifyProc", &Session::SetCertVerifyProc) .SetMethod("setPermissionRequestHandler", &Session::SetPermissionRequestHandler) .SetMethod("setPermissionCheckHandler", &Session::SetPermissionCheckHandler) .SetMethod("setDisplayMediaRequestHandler", &Session::SetDisplayMediaRequestHandler) .SetMethod("setDevicePermissionHandler", &Session::SetDevicePermissionHandler) .SetMethod("setUSBProtectedClassesHandler", &Session::SetUSBProtectedClassesHandler) .SetMethod("setBluetoothPairingHandler", &Session::SetBluetoothPairingHandler) .SetMethod("clearHostResolverCache", &Session::ClearHostResolverCache) .SetMethod("clearAuthCache", &Session::ClearAuthCache) .SetMethod("allowNTLMCredentialsForDomains", &Session::AllowNTLMCredentialsForDomains) .SetMethod("isPersistent", &Session::IsPersistent) .SetMethod("setUserAgent", &Session::SetUserAgent) .SetMethod("getUserAgent", &Session::GetUserAgent) .SetMethod("setSSLConfig", &Session::SetSSLConfig) .SetMethod("getBlobData", &Session::GetBlobData) .SetMethod("downloadURL", &Session::DownloadURL) .SetMethod("createInterruptedDownload", &Session::CreateInterruptedDownload) .SetMethod("setPreloads", &Session::SetPreloads) .SetMethod("getPreloads", &Session::GetPreloads) #if BUILDFLAG(ENABLE_ELECTRON_EXTENSIONS) .SetMethod("loadExtension", &Session::LoadExtension) .SetMethod("removeExtension", &Session::RemoveExtension) .SetMethod("getExtension", &Session::GetExtension) .SetMethod("getAllExtensions", &Session::GetAllExtensions) #endif #if BUILDFLAG(ENABLE_BUILTIN_SPELLCHECKER) .SetMethod("getSpellCheckerLanguages", &Session::GetSpellCheckerLanguages) .SetMethod("setSpellCheckerLanguages", &Session::SetSpellCheckerLanguages) .SetProperty("availableSpellCheckerLanguages", &spellcheck::SpellCheckLanguages) .SetMethod("setSpellCheckerDictionaryDownloadURL", &SetSpellCheckerDictionaryDownloadURL) .SetMethod("listWordsInSpellCheckerDictionary", &Session::ListWordsInSpellCheckerDictionary) .SetMethod("addWordToSpellCheckerDictionary", &Session::AddWordToSpellCheckerDictionary) .SetMethod("removeWordFromSpellCheckerDictionary", &Session::RemoveWordFromSpellCheckerDictionary) .SetMethod("setSpellCheckerEnabled", &Session::SetSpellCheckerEnabled) .SetMethod("isSpellCheckerEnabled", &Session::IsSpellCheckerEnabled) .SetProperty("spellCheckerEnabled", &Session::IsSpellCheckerEnabled, &Session::SetSpellCheckerEnabled) #endif .SetMethod("preconnect", &Session::Preconnect) .SetMethod("closeAllConnections", &Session::CloseAllConnections) .SetMethod("getStoragePath", &Session::GetPath) .SetMethod("setCodeCachePath", &Session::SetCodeCachePath) .SetMethod("clearCodeCaches", &Session::ClearCodeCaches) .SetProperty("cookies", &Session::Cookies) .SetProperty("netLog", &Session::NetLog) .SetProperty("protocol", &Session::Protocol) .SetProperty("serviceWorkers", &Session::ServiceWorkerContext) .SetProperty("webRequest", &Session::WebRequest) .SetProperty("storagePath", &Session::GetPath) .Build(); } const char* Session::GetTypeName() { return GetClassName(); } } // namespace electron::api namespace { using electron::api::Session; v8::Local FromPartition(const std::string& partition, gin::Arguments* args) { if (!electron::Browser::Get()->is_ready()) { args->ThrowTypeError("Session can only be received when app is ready"); return v8::Null(args->isolate()); } base::Value::Dict options; args->GetNext(&options); return Session::FromPartition(args->isolate(), partition, std::move(options)) .ToV8(); } v8::Local FromPath(const base::FilePath& path, gin::Arguments* args) { if (!electron::Browser::Get()->is_ready()) { args->ThrowTypeError("Session can only be received when app is ready"); return v8::Null(args->isolate()); } base::Value::Dict options; args->GetNext(&options); absl::optional> session_handle = Session::FromPath(args->isolate(), path, std::move(options)); if (session_handle) return session_handle.value().ToV8(); else return v8::Null(args->isolate()); } void Initialize(v8::Local exports, v8::Local unused, v8::Local context, void* priv) { v8::Isolate* isolate = context->GetIsolate(); gin_helper::Dictionary dict(isolate, exports); dict.Set("Session", Session::GetConstructor(context)); dict.SetMethod("fromPartition", &FromPartition); dict.SetMethod("fromPath", &FromPath); } } // namespace NODE_LINKED_BINDING_CONTEXT_AWARE(electron_browser_session, Initialize)