123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467 |
- // Copyright (c) 2012 The Chromium Authors. All rights reserved.
- // Use of this source code is governed by a BSD-style license that can be
- // found in the LICENSE file.
- // This class is useful for building a simple URLRequestContext. Most creators
- // of new URLRequestContexts should use this helper class to construct it. Call
- // any configuration params, and when done, invoke Build() to construct the
- // URLRequestContext. This URLRequestContext will own all its own storage.
- //
- // URLRequestContextBuilder and its associated params classes are initially
- // populated with "sane" default values. Read through the comments to figure out
- // what these are.
- #ifndef NET_URL_REQUEST_URL_REQUEST_CONTEXT_BUILDER_H_
- #define NET_URL_REQUEST_URL_REQUEST_CONTEXT_BUILDER_H_
- #include <stdint.h>
- #include <map>
- #include <memory>
- #include <string>
- #include <utility>
- #include <vector>
- #include "base/callback.h"
- #include "base/files/file_path.h"
- #include "base/memory/raw_ptr.h"
- #include "base/memory/ref_counted.h"
- #include "base/task/task_traits.h"
- #include "build/build_config.h"
- #include "build/buildflag.h"
- #include "net/base/net_export.h"
- #include "net/base/network_delegate.h"
- #include "net/base/network_handle.h"
- #include "net/base/proxy_delegate.h"
- #include "net/disk_cache/disk_cache.h"
- #include "net/dns/host_resolver.h"
- #include "net/http/http_network_session.h"
- #include "net/net_buildflags.h"
- #include "net/network_error_logging/network_error_logging_service.h"
- #include "net/proxy_resolution/proxy_config_service.h"
- #include "net/proxy_resolution/proxy_resolution_service.h"
- #include "net/socket/client_socket_factory.h"
- #include "net/ssl/ssl_config_service.h"
- #include "net/third_party/quiche/src/quiche/quic/core/quic_packets.h"
- #include "net/url_request/url_request_job_factory.h"
- namespace base::android {
- class ApplicationStatusListener;
- } // namespace base::android
- namespace net {
- class CertVerifier;
- class ClientSocketFactory;
- class CookieStore;
- class CTPolicyEnforcer;
- class HttpAuthHandlerFactory;
- class HttpTransactionFactory;
- class HttpUserAgentSettings;
- class HttpServerProperties;
- class HostResolverManager;
- class NetworkQualityEstimator;
- class ProxyConfigService;
- class URLRequestContext;
- #if BUILDFLAG(ENABLE_REPORTING)
- struct ReportingPolicy;
- class PersistentReportingAndNelStore;
- #endif // BUILDFLAG(ENABLE_REPORTING)
- // A URLRequestContextBuilder creates a single URLRequestContext. It provides
- // methods to manage various URLRequestContext components which should be called
- // before creating the Context. Once configuration is complete, calling Build()
- // will create a URLRequestContext with the specified configuration. Components
- // that are not explicitly configured will use reasonable in-memory defaults.
- //
- // The returned URLRequestContext is self-contained: Deleting it will safely
- // shut down all of the URLRequests owned by its internal components, and then
- // tear down those components. The only exception to this are objects not owned
- // by URLRequestContext. This includes components passed in to the methods that
- // take raw pointers, and objects that components passed in to the Builder have
- // raw pointers to.
- //
- // A Builder should be destroyed after calling Build, and there is no need to
- // keep it around for the lifetime of the created URLRequestContext. Each
- // Builder may be used to create only a single URLRequestContext.
- class NET_EXPORT URLRequestContextBuilder {
- public:
- // Creates an HttpNetworkTransactionFactory given an HttpNetworkSession. Does
- // not take ownership of the session.
- using CreateHttpTransactionFactoryCallback =
- base::OnceCallback<std::unique_ptr<HttpTransactionFactory>(
- HttpNetworkSession* session)>;
- struct NET_EXPORT HttpCacheParams {
- enum Type {
- // In-memory cache.
- IN_MEMORY,
- // Disk cache using "default" backend.
- DISK,
- // Disk cache using "blockfile" backend (BackendImpl).
- DISK_BLOCKFILE,
- // Disk cache using "simple" backend (SimpleBackendImpl).
- DISK_SIMPLE,
- };
- HttpCacheParams();
- ~HttpCacheParams();
- // The type of HTTP cache. Default is IN_MEMORY.
- Type type = IN_MEMORY;
- // The max size of the cache in bytes. Default is algorithmically determined
- // based off available disk space.
- int max_size = 0;
- // Whether or not we need to reset the cache due to an experiment change.
- bool reset_cache = false;
- // The cache path (when type is DISK).
- base::FilePath path;
- // A factory to broker file operations. This is needed for network process
- // sandboxing in some platforms.
- scoped_refptr<disk_cache::BackendFileOperationsFactory>
- file_operations_factory;
- #if BUILDFLAG(IS_ANDROID)
- // If this is set, will override the default ApplicationStatusListener. This
- // is useful if the cache will not be in the main process.
- raw_ptr<base::android::ApplicationStatusListener> app_status_listener =
- nullptr;
- #endif
- };
- URLRequestContextBuilder();
- URLRequestContextBuilder(const URLRequestContextBuilder&) = delete;
- URLRequestContextBuilder& operator=(const URLRequestContextBuilder&) = delete;
- virtual ~URLRequestContextBuilder();
- // Sets whether Brotli compression is enabled. Disabled by default;
- void set_enable_brotli(bool enable_brotli) { enable_brotli_ = enable_brotli; }
- // Sets the |check_cleartext_permitted| flag, which controls whether to check
- // system policy before allowing a cleartext http or ws request.
- void set_check_cleartext_permitted(bool value) {
- check_cleartext_permitted_ = value;
- }
- void set_require_network_isolation_key(bool value) {
- require_network_isolation_key_ = value;
- }
- // Unlike most other setters, the builder does not take ownership of the
- // NetworkQualityEstimator.
- void set_network_quality_estimator(
- NetworkQualityEstimator* network_quality_estimator) {
- network_quality_estimator_ = network_quality_estimator;
- }
- // These functions are mutually exclusive. The ProxyConfigService, if
- // set, will be used to construct a ConfiguredProxyResolutionService.
- void set_proxy_config_service(
- std::unique_ptr<ProxyConfigService> proxy_config_service) {
- proxy_config_service_ = std::move(proxy_config_service);
- }
- // Sets whether quick PAC checks are enabled. Defaults to true. Ignored if
- // a ConfiguredProxyResolutionService is set directly.
- void set_pac_quick_check_enabled(bool pac_quick_check_enabled) {
- pac_quick_check_enabled_ = pac_quick_check_enabled;
- }
- // Sets the proxy service. If one is not provided, by default, uses system
- // libraries to evaluate PAC scripts, if available (And if not, skips PAC
- // resolution). Subclasses may override CreateProxyResolutionService for
- // different default behavior.
- void set_proxy_resolution_service(
- std::unique_ptr<ProxyResolutionService> proxy_resolution_service) {
- proxy_resolution_service_ = std::move(proxy_resolution_service);
- }
- void set_ssl_config_service(
- std::unique_ptr<SSLConfigService> ssl_config_service) {
- ssl_config_service_ = std::move(ssl_config_service);
- }
- // Call these functions to specify hard-coded Accept-Language
- // or User-Agent header values for all requests that don't
- // have the headers already set.
- void set_accept_language(const std::string& accept_language);
- void set_user_agent(const std::string& user_agent);
- // Makes the created URLRequestContext use a particular HttpUserAgentSettings
- // object. Not compatible with set_accept_language() / set_user_agent().
- //
- // The object will be live until the URLRequestContext is destroyed.
- void set_http_user_agent_settings(
- std::unique_ptr<HttpUserAgentSettings> http_user_agent_settings);
- // Sets a valid ProtocolHandler for a scheme.
- // A ProtocolHandler already exists for |scheme| will be overwritten.
- void SetProtocolHandler(
- const std::string& scheme,
- std::unique_ptr<URLRequestJobFactory::ProtocolHandler> protocol_handler);
- // Unlike the other setters, the builder does not take ownership of the
- // NetLog.
- // TODO(mmenke): Probably makes sense to get rid of this, and have consumers
- // set their own NetLog::Observers instead.
- void set_net_log(NetLog* net_log) { net_log_ = net_log; }
- // Sets a HostResolver instance to be used instead of default construction.
- // Should not be used if set_host_resolver_manager(),
- // set_host_mapping_rules(), or set_host_resolver_factory() are used. On
- // building the context, will call HostResolver::SetRequestContext, so
- // |host_resolver| may not already be associated with a context.
- void set_host_resolver(std::unique_ptr<HostResolver> host_resolver);
- // If set to non-empty, the mapping rules will be applied to requests to the
- // created host resolver. See MappedHostResolver for details. Should not be
- // used if set_host_resolver() is used.
- void set_host_mapping_rules(std::string host_mapping_rules);
- // Sets a shared HostResolverManager to be used for created HostResolvers.
- // Should not be used if set_host_resolver() is used. The consumer must ensure
- // |manager| outlives the URLRequestContext returned by the builder.
- void set_host_resolver_manager(HostResolverManager* manager);
- // Sets the factory used for any HostResolverCreation. By default, a default
- // implementation will be used. Should not be used if set_host_resolver() is
- // used.
- void set_host_resolver_factory(HostResolver::Factory* factory);
- // Uses NetworkDelegateImpl by default. Note that calling Build will unset
- // any custom delegate in builder, so this must be called each time before
- // Build is called.
- // Returns a raw pointer to the set delegate.
- template <typename T>
- T* set_network_delegate(std::unique_ptr<T> delegate) {
- network_delegate_ = std::move(delegate);
- return static_cast<T*>(network_delegate_.get());
- }
- // Sets the ProxyDelegate.
- void set_proxy_delegate(std::unique_ptr<ProxyDelegate> proxy_delegate);
- // Sets a specific HttpAuthHandlerFactory to be used by the URLRequestContext
- // rather than the default |HttpAuthHandlerRegistryFactory|. The builder
- // takes ownership of the factory and will eventually transfer it to the new
- // URLRequestContext.
- void SetHttpAuthHandlerFactory(
- std::unique_ptr<HttpAuthHandlerFactory> factory);
- // By default HttpCache is enabled with a default constructed HttpCacheParams.
- void EnableHttpCache(const HttpCacheParams& params);
- void DisableHttpCache();
- // Override default HttpNetworkSessionParams settings.
- void set_http_network_session_params(
- const HttpNetworkSessionParams& http_network_session_params) {
- http_network_session_params_ = http_network_session_params;
- }
- void set_transport_security_persister_file_path(
- const base::FilePath& transport_security_persister_file_path) {
- transport_security_persister_file_path_ =
- transport_security_persister_file_path;
- }
- void set_hsts_policy_bypass_list(
- const std::vector<std::string>& hsts_policy_bypass_list) {
- hsts_policy_bypass_list_ = hsts_policy_bypass_list;
- }
- void SetSpdyAndQuicEnabled(bool spdy_enabled, bool quic_enabled);
- void set_throttling_enabled(bool throttling_enabled) {
- throttling_enabled_ = throttling_enabled;
- }
- void set_first_party_sets_enabled(bool enabled) {
- first_party_sets_enabled_ = enabled;
- }
- void set_ct_policy_enforcer(
- std::unique_ptr<CTPolicyEnforcer> ct_policy_enforcer);
- void set_sct_auditing_delegate(
- std::unique_ptr<SCTAuditingDelegate> sct_auditing_delegate);
- void set_quic_context(std::unique_ptr<QuicContext> quic_context);
- void SetCertVerifier(std::unique_ptr<CertVerifier> cert_verifier);
- #if BUILDFLAG(ENABLE_REPORTING)
- void set_reporting_service(
- std::unique_ptr<ReportingService> reporting_service);
- void set_reporting_policy(std::unique_ptr<ReportingPolicy> reporting_policy);
- void set_network_error_logging_enabled(bool network_error_logging_enabled) {
- network_error_logging_enabled_ = network_error_logging_enabled;
- }
- template <typename T>
- T* SetNetworkErrorLoggingServiceForTesting(std::unique_ptr<T> service) {
- network_error_logging_service_ = std::move(service);
- return static_cast<T*>(network_error_logging_service_.get());
- }
- void set_persistent_reporting_and_nel_store(
- std::unique_ptr<PersistentReportingAndNelStore>
- persistent_reporting_and_nel_store);
- #endif // BUILDFLAG(ENABLE_REPORTING)
- // Override the default in-memory cookie store. If |cookie_store| is NULL,
- // CookieStore will be disabled for this context.
- void SetCookieStore(std::unique_ptr<CookieStore> cookie_store);
- // Sets a specific HttpServerProperties for use in the
- // URLRequestContext rather than creating a default HttpServerPropertiesImpl.
- void SetHttpServerProperties(
- std::unique_ptr<HttpServerProperties> http_server_properties);
- // Sets a callback that will be used to create the
- // HttpNetworkTransactionFactory. If a cache is enabled, the cache's
- // HttpTransactionFactory will wrap the one this creates.
- // TODO(mmenke): Get rid of this. See https://crbug.com/721408
- void SetCreateHttpTransactionFactoryCallback(
- CreateHttpTransactionFactoryCallback
- create_http_network_transaction_factory);
- template <typename T>
- T* SetHttpTransactionFactoryForTesting(std::unique_ptr<T> factory) {
- create_http_network_transaction_factory_.Reset();
- http_transaction_factory_ = std::move(factory);
- return static_cast<T*>(http_transaction_factory_.get());
- }
- // Sets a ClientSocketFactory so a test can mock out sockets. This must
- // outlive the URLRequestContext that will be built.
- void set_client_socket_factory_for_testing(
- ClientSocketFactory* client_socket_factory_for_testing) {
- set_client_socket_factory(client_socket_factory_for_testing);
- }
- // Sets a ClientSocketFactory when the network service sandbox is enabled. The
- // unique_ptr is moved to a URLRequestContextStorage once Build() is called.
- void set_client_socket_factory(
- std::unique_ptr<ClientSocketFactory> client_socket_factory) {
- set_client_socket_factory(client_socket_factory.get());
- client_socket_factory_ = std::move(client_socket_factory);
- }
- // Binds the context to `network`. All requests scheduled through the context
- // built by this builder will be sent using `network`. Requests will fail if
- // `network` disconnects. `options` allows to specify the ManagerOptions that
- // will be passed to the special purpose HostResolver created internally.
- // This also imposes some limitations on the context capabilities:
- // * By design, QUIC connection migration will be turned off.
- // Only implemented for Android (API level > 23).
- void BindToNetwork(
- handles::NetworkHandle network,
- absl::optional<HostResolver::ManagerOptions> options = absl::nullopt);
- // Creates a mostly self-contained URLRequestContext. May only be called once
- // per URLRequestContextBuilder. After this is called, the Builder can be
- // safely destroyed.
- std::unique_ptr<URLRequestContext> Build();
- void SuppressSettingSocketPerformanceWatcherFactoryForTesting() {
- suppress_setting_socket_performance_watcher_factory_for_testing_ = true;
- }
- protected:
- // Lets subclasses override ProxyResolutionService creation, using a
- // ProxyResolutionService that uses the URLRequestContext itself to get PAC
- // scripts. When this method is invoked, the URLRequestContext is not yet
- // ready to service requests.
- virtual std::unique_ptr<ProxyResolutionService> CreateProxyResolutionService(
- std::unique_ptr<ProxyConfigService> proxy_config_service,
- URLRequestContext* url_request_context,
- HostResolver* host_resolver,
- NetworkDelegate* network_delegate,
- NetLog* net_log,
- bool pac_quick_check_enabled);
- private:
- // Extracts the component pointers required to construct an HttpNetworkSession
- // and copies them into the HttpNetworkSession::Context used to create the
- // session. This function should be used to ensure that a context and its
- // associated HttpNetworkSession are consistent.
- static void SetHttpNetworkSessionComponents(
- const URLRequestContext* request_context,
- HttpNetworkSessionContext* session_context,
- bool suppress_setting_socket_performance_watcher_factory = false,
- ClientSocketFactory* client_socket_factory = nullptr);
- // Factory that will be used to create all client sockets used by the
- // URLRequestContext that will be built.
- // `client_socket_factory` must outlive the context.
- void set_client_socket_factory(ClientSocketFactory* client_socket_factory) {
- client_socket_factory_raw_ = client_socket_factory;
- }
- bool enable_brotli_ = false;
- bool check_cleartext_permitted_ = false;
- bool require_network_isolation_key_ = false;
- raw_ptr<NetworkQualityEstimator> network_quality_estimator_ = nullptr;
- std::string accept_language_;
- std::string user_agent_;
- std::unique_ptr<HttpUserAgentSettings> http_user_agent_settings_;
- bool http_cache_enabled_ = true;
- bool throttling_enabled_ = false;
- bool cookie_store_set_by_client_ = false;
- bool suppress_setting_socket_performance_watcher_factory_for_testing_ = false;
- bool first_party_sets_enabled_ = false;
- handles::NetworkHandle bound_network_ = handles::kInvalidNetworkHandle;
- // Used only if the context is bound to a network to customize the
- // HostResolver created internally.
- HostResolver::ManagerOptions manager_options_;
- HttpCacheParams http_cache_params_;
- HttpNetworkSessionParams http_network_session_params_;
- CreateHttpTransactionFactoryCallback create_http_network_transaction_factory_;
- std::unique_ptr<HttpTransactionFactory> http_transaction_factory_;
- base::FilePath transport_security_persister_file_path_;
- std::vector<std::string> hsts_policy_bypass_list_;
- raw_ptr<NetLog> net_log_ = nullptr;
- std::unique_ptr<HostResolver> host_resolver_;
- std::string host_mapping_rules_;
- raw_ptr<HostResolverManager> host_resolver_manager_ = nullptr;
- raw_ptr<HostResolver::Factory> host_resolver_factory_ = nullptr;
- std::unique_ptr<ProxyConfigService> proxy_config_service_;
- bool pac_quick_check_enabled_ = true;
- std::unique_ptr<ProxyResolutionService> proxy_resolution_service_;
- std::unique_ptr<SSLConfigService> ssl_config_service_;
- std::unique_ptr<NetworkDelegate> network_delegate_;
- std::unique_ptr<ProxyDelegate> proxy_delegate_;
- std::unique_ptr<CookieStore> cookie_store_;
- std::unique_ptr<HttpAuthHandlerFactory> http_auth_handler_factory_;
- std::unique_ptr<CertVerifier> cert_verifier_;
- std::unique_ptr<CTPolicyEnforcer> ct_policy_enforcer_;
- std::unique_ptr<SCTAuditingDelegate> sct_auditing_delegate_;
- std::unique_ptr<QuicContext> quic_context_;
- std::unique_ptr<ClientSocketFactory> client_socket_factory_ = nullptr;
- #if BUILDFLAG(ENABLE_REPORTING)
- std::unique_ptr<ReportingService> reporting_service_;
- std::unique_ptr<ReportingPolicy> reporting_policy_;
- bool network_error_logging_enabled_ = false;
- std::unique_ptr<NetworkErrorLoggingService> network_error_logging_service_;
- std::unique_ptr<PersistentReportingAndNelStore>
- persistent_reporting_and_nel_store_;
- #endif // BUILDFLAG(ENABLE_REPORTING)
- std::unique_ptr<HttpServerProperties> http_server_properties_;
- std::map<std::string, std::unique_ptr<URLRequestJobFactory::ProtocolHandler>>
- protocol_handlers_;
- raw_ptr<ClientSocketFactory> client_socket_factory_raw_ = nullptr;
- };
- } // namespace net
- #endif // NET_URL_REQUEST_URL_REQUEST_CONTEXT_BUILDER_H_
|