| // Copyright 2014 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. |
| |
| #ifndef COMPONENTS_CRONET_URL_REQUEST_CONTEXT_CONFIG_H_ |
| #define COMPONENTS_CRONET_URL_REQUEST_CONTEXT_CONFIG_H_ |
| |
| #include <memory> |
| #include <string> |
| #include <vector> |
| |
| #include "base/macros.h" |
| #include "base/memory/ref_counted.h" |
| #include "base/optional.h" |
| #include "base/time/time.h" |
| #include "base/values.h" |
| #include "net/base/hash_value.h" |
| #include "net/cert/cert_verifier.h" |
| #include "net/http/http_network_session.h" |
| #include "net/nqe/effective_connection_type.h" |
| |
| namespace base { |
| class SequencedTaskRunner; |
| } // namespace base |
| |
| namespace net { |
| class CertVerifier; |
| class NetLog; |
| class URLRequestContextBuilder; |
| } // namespace net |
| |
| namespace cronet { |
| |
| // Common configuration parameters used by Cronet to configure |
| // URLRequestContext. |
| // TODO(mgersh): This shouldn't be a struct, and experimental option parsing |
| // should be kept more separate from applying the configuration. |
| struct URLRequestContextConfig { |
| // Type of HTTP cache. |
| // GENERATED_JAVA_ENUM_PACKAGE: org.chromium.net.impl |
| enum HttpCacheType { |
| // No HTTP cache. |
| DISABLED, |
| // HTTP cache persisted to disk. |
| DISK, |
| // HTTP cache kept in memory. |
| MEMORY, |
| }; |
| |
| // App-provided hint that server supports QUIC. |
| struct QuicHint { |
| QuicHint(const std::string& host, int port, int alternate_port); |
| ~QuicHint(); |
| |
| // Host name of the server that supports QUIC. |
| const std::string host; |
| // Port of the server that supports QUIC. |
| const int port; |
| // Alternate protocol port. |
| const int alternate_port; |
| |
| private: |
| DISALLOW_COPY_AND_ASSIGN(QuicHint); |
| }; |
| |
| // Public-Key-Pinning configuration structure. |
| struct Pkp { |
| Pkp(const std::string& host, |
| bool include_subdomains, |
| const base::Time& expiration_date); |
| ~Pkp(); |
| |
| // Host name. |
| const std::string host; |
| // Pin hashes (currently SHA256 only). |
| net::HashValueVector pin_hashes; |
| // Indicates whether the pinning should apply to the pinned host subdomains. |
| const bool include_subdomains; |
| // Expiration date for the pins. |
| const base::Time expiration_date; |
| |
| private: |
| DISALLOW_COPY_AND_ASSIGN(Pkp); |
| }; |
| |
| URLRequestContextConfig( |
| // Enable QUIC. |
| bool enable_quic, |
| // QUIC User Agent ID. |
| const std::string& quic_user_agent_id, |
| // Enable SPDY. |
| bool enable_spdy, |
| // Enable SDCH. |
| bool enable_sdch, |
| // Enable Brotli. |
| bool enable_brotli, |
| // Type of http cache. |
| HttpCacheType http_cache, |
| // Max size of http cache in bytes. |
| int http_cache_max_size, |
| // Disable caching for HTTP responses. Other information may be stored in |
| // the cache. |
| bool load_disable_cache, |
| // Storage path for http cache and cookie storage. |
| const std::string& storage_path, |
| // User-Agent request header field. |
| const std::string& user_agent, |
| // JSON encoded experimental options. |
| const std::string& experimental_options, |
| // MockCertVerifier to use for testing purposes. |
| std::unique_ptr<net::CertVerifier> mock_cert_verifier, |
| // Enable network quality estimator. |
| bool enable_network_quality_estimator, |
| // Enable bypassing of public key pinning for local trust anchors |
| bool bypass_public_key_pinning_for_local_trust_anchors, |
| // Certificate verifier cache data. |
| const std::string& cert_verifier_data); |
| ~URLRequestContextConfig(); |
| |
| // Configures |context_builder| based on |this|. |
| void ConfigureURLRequestContextBuilder( |
| net::URLRequestContextBuilder* context_builder, |
| net::NetLog* net_log, |
| const scoped_refptr<base::SequencedTaskRunner>& file_task_runner); |
| |
| // Enable QUIC. |
| const bool enable_quic; |
| // QUIC User Agent ID. |
| const std::string quic_user_agent_id; |
| // Enable SPDY. |
| const bool enable_spdy; |
| // Enable SDCH. |
| const bool enable_sdch; |
| // Enable Brotli. |
| const bool enable_brotli; |
| // Type of http cache. |
| const HttpCacheType http_cache; |
| // Max size of http cache in bytes. |
| const int http_cache_max_size; |
| // Disable caching for HTTP responses. Other information may be stored in |
| // the cache. |
| const bool load_disable_cache; |
| // Storage path for http cache and cookie storage. |
| const std::string storage_path; |
| // User-Agent request header field. |
| const std::string user_agent; |
| |
| // Certificate verifier for testing. |
| std::unique_ptr<net::CertVerifier> mock_cert_verifier; |
| |
| // Enable Network Quality Estimator (NQE). |
| const bool enable_network_quality_estimator; |
| |
| // Enable public key pinning bypass for local trust anchors. |
| const bool bypass_public_key_pinning_for_local_trust_anchors; |
| |
| // Data to populte CertVerifierCache. |
| const std::string cert_verifier_data; |
| |
| // App-provided list of servers that support QUIC. |
| std::vector<std::unique_ptr<QuicHint>> quic_hints; |
| |
| // The list of public key pins. |
| std::vector<std::unique_ptr<Pkp>> pkp_list; |
| |
| // Enable DNS cache persistence. |
| bool enable_host_cache_persistence = false; |
| |
| // Minimum time in milliseconds between writing the HostCache contents to |
| // prefs. Only relevant when |enable_host_cache_persistence| is true. |
| int host_cache_persistence_delay_ms = 60000; |
| |
| // Experimental options that are recognized by the config parser. |
| std::unique_ptr<base::DictionaryValue> effective_experimental_options = |
| nullptr; |
| |
| // Enable reading of the network quality from the prefs. |
| bool nqe_persistent_caching_enabled; |
| |
| // If set, forces NQE to return the set value as the effective connection |
| // type. |
| base::Optional<net::EffectiveConnectionType> |
| nqe_forced_effective_connection_type; |
| |
| private: |
| // Parses experimental options and makes appropriate changes to settings in |
| // the URLRequestContextConfig and URLRequestContextBuilder. |
| void ParseAndSetExperimentalOptions( |
| net::URLRequestContextBuilder* context_builder, |
| net::HttpNetworkSession::Params* session_params, |
| net::NetLog* net_log, |
| const scoped_refptr<base::SequencedTaskRunner>& file_task_runner); |
| |
| // Experimental options encoded as a string in a JSON format containing |
| // experiments and their corresponding configuration options. The format |
| // is a JSON object with the name of the experiment as the key, and the |
| // configuration options as the value. An example: |
| // {"experiment1": {"option1": "option_value1", "option2": |
| // "option_value2", |
| // ...}, "experiment2: {"option3", "option_value3", ...}, ...} |
| const std::string experimental_options; |
| |
| DISALLOW_COPY_AND_ASSIGN(URLRequestContextConfig); |
| }; |
| |
| // Stores intermediate state for URLRequestContextConfig. Initializes with |
| // (mostly) sane defaults, then the appropriate member variables can be |
| // modified, and it can be finalized with Build(). |
| struct URLRequestContextConfigBuilder { |
| URLRequestContextConfigBuilder(); |
| ~URLRequestContextConfigBuilder(); |
| |
| // Finalize state into a URLRequestContextConfig. Must only be called once, |
| // as once |mock_cert_verifier| is moved into a URLRequestContextConfig, it |
| // cannot be used again. |
| std::unique_ptr<URLRequestContextConfig> Build(); |
| |
| // Enable QUIC. |
| bool enable_quic = false; |
| // QUIC User Agent ID. |
| std::string quic_user_agent_id = ""; |
| // Enable SPDY. |
| bool enable_spdy = true; |
| // Enable SDCH. |
| bool enable_sdch = false; |
| // Enable Brotli. |
| bool enable_brotli = false; |
| // Type of http cache. |
| URLRequestContextConfig::HttpCacheType http_cache = |
| URLRequestContextConfig::DISABLED; |
| // Max size of http cache in bytes. |
| int http_cache_max_size = 0; |
| // Disable caching for HTTP responses. Other information may be stored in |
| // the cache. |
| bool load_disable_cache = false; |
| // Storage path for http cache and cookie storage. |
| std::string storage_path = ""; |
| // User-Agent request header field. |
| std::string user_agent = ""; |
| // Experimental options encoded as a string in a JSON format containing |
| // experiments and their corresponding configuration options. The format |
| // is a JSON object with the name of the experiment as the key, and the |
| // configuration options as the value. An example: |
| // {"experiment1": {"option1": "option_value1", "option2": "option_value2", |
| // ...}, "experiment2: {"option3", "option_value3", ...}, ...} |
| std::string experimental_options = "{}"; |
| |
| // Certificate verifier for testing. |
| std::unique_ptr<net::CertVerifier> mock_cert_verifier = nullptr; |
| |
| // Enable network quality estimator. |
| bool enable_network_quality_estimator = false; |
| |
| // Enable public key pinning bypass for local trust anchors. |
| bool bypass_public_key_pinning_for_local_trust_anchors = true; |
| |
| // Data to populate CertVerifierCache. |
| std::string cert_verifier_data = ""; |
| |
| private: |
| DISALLOW_COPY_AND_ASSIGN(URLRequestContextConfigBuilder); |
| }; |
| |
| } // namespace cronet |
| |
| #endif // COMPONENTS_CRONET_URL_REQUEST_CONTEXT_CONFIG_H_ |