| // Copyright 2018 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 EXTENSIONS_BROWSER_API_WEB_REQUEST_WEB_REQUEST_PROXYING_URL_LOADER_FACTORY_H_ |
| #define EXTENSIONS_BROWSER_API_WEB_REQUEST_WEB_REQUEST_PROXYING_URL_LOADER_FACTORY_H_ |
| |
| #include <cstdint> |
| #include <map> |
| |
| #include "base/callback.h" |
| #include "base/macros.h" |
| #include "base/memory/ref_counted.h" |
| #include "base/memory/ref_counted_delete_on_sequence.h" |
| #include "base/memory/weak_ptr.h" |
| #include "base/optional.h" |
| #include "components/keyed_service/core/keyed_service_shutdown_notifier.h" |
| #include "content/public/browser/content_browser_client.h" |
| #include "extensions/browser/api/web_request/web_request_api.h" |
| #include "extensions/browser/api/web_request/web_request_info.h" |
| #include "mojo/public/cpp/bindings/binding.h" |
| #include "mojo/public/cpp/bindings/pending_receiver.h" |
| #include "mojo/public/cpp/bindings/receiver.h" |
| #include "mojo/public/cpp/bindings/receiver_set.h" |
| #include "net/base/completion_once_callback.h" |
| #include "net/traffic_annotation/network_traffic_annotation.h" |
| #include "services/network/public/cpp/resource_request.h" |
| #include "services/network/public/cpp/resource_response.h" |
| #include "services/network/public/mojom/url_loader.mojom.h" |
| #include "services/network/public/mojom/url_loader_factory.mojom.h" |
| #include "url/gurl.h" |
| |
| namespace extensions { |
| |
| class ExtensionNavigationUIData; |
| |
| // Owns URLLoaderFactory bindings for WebRequest proxies with the Network |
| // Service enabled. |
| class WebRequestProxyingURLLoaderFactory |
| : public WebRequestAPI::Proxy, |
| public network::mojom::URLLoaderFactory, |
| public network::mojom::TrustedURLLoaderHeaderClient { |
| public: |
| class InProgressRequest : public network::mojom::URLLoader, |
| public network::mojom::URLLoaderClient, |
| public network::mojom::TrustedHeaderClient { |
| public: |
| InProgressRequest( |
| WebRequestProxyingURLLoaderFactory* factory, |
| uint64_t request_id, |
| int32_t routing_id, |
| int32_t network_service_request_id, |
| uint32_t options, |
| const network::ResourceRequest& request, |
| const net::MutableNetworkTrafficAnnotationTag& traffic_annotation, |
| network::mojom::URLLoaderRequest loader_request, |
| network::mojom::URLLoaderClientPtr client); |
| ~InProgressRequest() override; |
| |
| void Restart(); |
| |
| // network::mojom::URLLoader: |
| void FollowRedirect(const std::vector<std::string>& removed_headers, |
| const net::HttpRequestHeaders& modified_headers, |
| const base::Optional<GURL>& new_url) override; |
| void SetPriority(net::RequestPriority priority, |
| int32_t intra_priority_value) override; |
| void PauseReadingBodyFromNet() override; |
| void ResumeReadingBodyFromNet() override; |
| |
| // network::mojom::URLLoaderClient: |
| void OnReceiveResponse(network::mojom::URLResponseHeadPtr head) override; |
| void OnReceiveRedirect(const net::RedirectInfo& redirect_info, |
| network::mojom::URLResponseHeadPtr head) override; |
| void OnUploadProgress(int64_t current_position, |
| int64_t total_size, |
| OnUploadProgressCallback callback) override; |
| void OnReceiveCachedMetadata(mojo_base::BigBuffer data) override; |
| void OnTransferSizeUpdated(int32_t transfer_size_diff) override; |
| void OnStartLoadingResponseBody( |
| mojo::ScopedDataPipeConsumerHandle body) override; |
| void OnComplete(const network::URLLoaderCompletionStatus& status) override; |
| |
| void HandleAuthRequest( |
| const net::AuthChallengeInfo& auth_info, |
| scoped_refptr<net::HttpResponseHeaders> response_headers, |
| WebRequestAPI::AuthRequestCallback callback); |
| |
| void OnLoaderCreated( |
| mojo::PendingReceiver<network::mojom::TrustedHeaderClient> receiver); |
| |
| // network::mojom::TrustedHeaderClient: |
| void OnBeforeSendHeaders(const net::HttpRequestHeaders& headers, |
| OnBeforeSendHeadersCallback callback) override; |
| void OnHeadersReceived(const std::string& headers, |
| OnHeadersReceivedCallback callback) override; |
| |
| private: |
| // These two methods combined form the implementation of Restart(). |
| void UpdateRequestInfo(); |
| void RestartInternal(); |
| |
| void ContinueToBeforeSendHeaders(int error_code); |
| void ContinueToSendHeaders(const std::set<std::string>& removed_headers, |
| const std::set<std::string>& set_headers, |
| int error_code); |
| void ContinueToStartRequest(int error_code); |
| void ContinueToHandleOverrideHeaders(int error_code); |
| void ContinueToResponseStarted(int error_code); |
| void ContinueAuthRequest(const net::AuthChallengeInfo& auth_info, |
| WebRequestAPI::AuthRequestCallback callback, |
| int error_code); |
| void OnAuthRequestHandled( |
| WebRequestAPI::AuthRequestCallback callback, |
| ExtensionWebRequestEventRouter::AuthRequiredResponse response); |
| void ContinueToBeforeRedirect(const net::RedirectInfo& redirect_info, |
| int error_code); |
| void HandleResponseOrRedirectHeaders( |
| net::CompletionOnceCallback continuation); |
| void OnRequestError(const network::URLLoaderCompletionStatus& status); |
| bool IsRedirectSafe(const GURL& from_url, const GURL& to_url); |
| void HandleBeforeRequestRedirect(); |
| |
| WebRequestProxyingURLLoaderFactory* const factory_; |
| network::ResourceRequest request_; |
| const base::Optional<url::Origin> original_initiator_; |
| const uint64_t request_id_; |
| const int32_t network_service_request_id_; |
| const int32_t routing_id_; |
| const uint32_t options_; |
| const net::MutableNetworkTrafficAnnotationTag traffic_annotation_; |
| mojo::Binding<network::mojom::URLLoader> proxied_loader_binding_; |
| network::mojom::URLLoaderClientPtr target_client_; |
| |
| base::Optional<WebRequestInfo> info_; |
| |
| mojo::Binding<network::mojom::URLLoaderClient> proxied_client_binding_; |
| network::mojom::URLLoaderPtr target_loader_; |
| |
| // NOTE: This is state which ExtensionWebRequestEventRouter needs to have |
| // persisted across some phases of this request -- namely between |
| // |OnHeadersReceived()| and request completion or restart. Pointers to |
| // these fields are stored in a |BlockedRequest| (created and owned by |
| // ExtensionWebRequestEventRouter) through much of the request's lifetime. |
| network::ResourceResponseHead current_response_; |
| scoped_refptr<net::HttpResponseHeaders> override_headers_; |
| GURL redirect_url_; |
| |
| // Holds any provided auth credentials through the extent of the request's |
| // lifetime. |
| base::Optional<net::AuthCredentials> auth_credentials_; |
| |
| bool request_completed_ = false; |
| |
| // If |has_any_extra_headers_listeners_| is set to true, the request will be |
| // sent with the network::mojom::kURLLoadOptionUseHeaderClient option, and |
| // we expect events to come through the |
| // network::mojom::TrustedURLLoaderHeaderClient binding on the factory. This |
| // is only set to true if there is a listener that needs to view or modify |
| // headers set in the network process. |
| bool has_any_extra_headers_listeners_ = false; |
| bool current_request_uses_header_client_ = false; |
| OnBeforeSendHeadersCallback on_before_send_headers_callback_; |
| OnHeadersReceivedCallback on_headers_received_callback_; |
| mojo::Receiver<network::mojom::TrustedHeaderClient> header_client_receiver_{ |
| this}; |
| |
| // If |has_any_extra_headers_listeners_| is set to false and a redirect is |
| // in progress, this stores the parameters to FollowRedirect that came from |
| // the client. That way we can combine it with any other changes that |
| // extensions made to headers in their callbacks. |
| struct FollowRedirectParams { |
| FollowRedirectParams(); |
| ~FollowRedirectParams(); |
| std::vector<std::string> removed_headers; |
| net::HttpRequestHeaders modified_headers; |
| base::Optional<GURL> new_url; |
| |
| DISALLOW_COPY_AND_ASSIGN(FollowRedirectParams); |
| }; |
| std::unique_ptr<FollowRedirectParams> pending_follow_redirect_params_; |
| |
| base::WeakPtrFactory<InProgressRequest> weak_factory_{this}; |
| |
| DISALLOW_COPY_AND_ASSIGN(InProgressRequest); |
| }; |
| |
| WebRequestProxyingURLLoaderFactory( |
| content::BrowserContext* browser_context, |
| int render_process_id, |
| scoped_refptr<WebRequestAPI::RequestIDGenerator> request_id_generator, |
| std::unique_ptr<ExtensionNavigationUIData> navigation_ui_data, |
| mojo::PendingReceiver<network::mojom::URLLoaderFactory> loader_receiver, |
| network::mojom::URLLoaderFactoryPtrInfo target_factory_info, |
| mojo::PendingReceiver<network::mojom::TrustedURLLoaderHeaderClient> |
| header_client_receiver, |
| WebRequestAPI::ProxySet* proxies, |
| content::ContentBrowserClient::URLLoaderFactoryType loader_factory_type); |
| |
| ~WebRequestProxyingURLLoaderFactory() override; |
| |
| static void StartProxying( |
| content::BrowserContext* browser_context, |
| int render_process_id, |
| scoped_refptr<WebRequestAPI::RequestIDGenerator> request_id_generator, |
| std::unique_ptr<ExtensionNavigationUIData> navigation_ui_data, |
| mojo::PendingReceiver<network::mojom::URLLoaderFactory> loader_receiver, |
| network::mojom::URLLoaderFactoryPtrInfo target_factory_info, |
| mojo::PendingReceiver<network::mojom::TrustedURLLoaderHeaderClient> |
| header_client_receiver, |
| WebRequestAPI::ProxySet* proxies, |
| content::ContentBrowserClient::URLLoaderFactoryType loader_factory_type); |
| |
| // network::mojom::URLLoaderFactory: |
| void CreateLoaderAndStart(network::mojom::URLLoaderRequest loader_request, |
| int32_t routing_id, |
| int32_t request_id, |
| uint32_t options, |
| const network::ResourceRequest& request, |
| network::mojom::URLLoaderClientPtr client, |
| const net::MutableNetworkTrafficAnnotationTag& |
| traffic_annotation) override; |
| void Clone(mojo::PendingReceiver<network::mojom::URLLoaderFactory> |
| loader_receiver) override; |
| |
| // network::mojom::TrustedURLLoaderHeaderClient: |
| void OnLoaderCreated( |
| int32_t request_id, |
| mojo::PendingReceiver<network::mojom::TrustedHeaderClient> receiver) |
| override; |
| |
| // WebRequestAPI::Proxy: |
| void HandleAuthRequest( |
| const net::AuthChallengeInfo& auth_info, |
| scoped_refptr<net::HttpResponseHeaders> response_headers, |
| int32_t request_id, |
| WebRequestAPI::AuthRequestCallback callback) override; |
| |
| content::ContentBrowserClient::URLLoaderFactoryType loader_factory_type() |
| const { |
| return loader_factory_type_; |
| } |
| |
| bool IsForServiceWorkerScript() const; |
| bool IsForDownload() const; |
| |
| private: |
| void OnTargetFactoryError(); |
| void OnProxyBindingError(); |
| void RemoveRequest(int32_t network_service_request_id, uint64_t request_id); |
| void MaybeRemoveProxy(); |
| |
| content::BrowserContext* const browser_context_; |
| const int render_process_id_; |
| scoped_refptr<WebRequestAPI::RequestIDGenerator> request_id_generator_; |
| std::unique_ptr<ExtensionNavigationUIData> navigation_ui_data_; |
| mojo::ReceiverSet<network::mojom::URLLoaderFactory> proxy_receivers_; |
| network::mojom::URLLoaderFactoryPtr target_factory_; |
| mojo::Receiver<network::mojom::TrustedURLLoaderHeaderClient> |
| url_loader_header_client_receiver_{this}; |
| // Owns |this|. |
| WebRequestAPI::ProxySet* const proxies_; |
| |
| const content::ContentBrowserClient::URLLoaderFactoryType |
| loader_factory_type_; |
| |
| // Mapping from our own internally generated request ID to an |
| // InProgressRequest instance. |
| std::map<uint64_t, std::unique_ptr<InProgressRequest>> requests_; |
| |
| // A mapping from the network stack's notion of request ID to our own |
| // internally generated request ID for the same request. |
| std::map<int32_t, uint64_t> network_request_id_to_web_request_id_; |
| |
| // Notifies the proxy that the browser context has been shutdown. |
| std::unique_ptr<KeyedServiceShutdownNotifier::Subscription> |
| shutdown_notifier_; |
| |
| base::WeakPtrFactory<WebRequestProxyingURLLoaderFactory> weak_factory_{this}; |
| |
| DISALLOW_COPY_AND_ASSIGN(WebRequestProxyingURLLoaderFactory); |
| }; |
| |
| } // namespace extensions |
| |
| #endif // EXTENSIONS_BROWSER_API_WEB_REQUEST_WEB_REQUEST_PROXYING_URL_LOADER_FACTORY_H_ |