1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_SAFE_BROWSING_CLOUD_CONTENT_SCANNING_MULTIPART_UPLOADER_H_
#define CHROME_BROWSER_SAFE_BROWSING_CLOUD_CONTENT_SCANNING_MULTIPART_UPLOADER_H_
#include <memory>
#include <string>
#include "base/files/file_path.h"
#include "base/functional/callback.h"
#include "base/gtest_prod_util.h"
#include "base/memory/scoped_refptr.h"
#include "base/memory/weak_ptr.h"
#include "base/time/time.h"
#include "chrome/browser/safe_browsing/cloud_content_scanning/connector_upload_request.h"
#include "net/traffic_annotation/network_traffic_annotation.h"
#include "services/network/public/cpp/resource_request.h"
#include "url/gurl.h"
namespace safe_browsing {
// This class encapsulates the upload of a file with metadata using the
// multipart protocol. This class is neither movable nor copyable.
class MultipartUploadRequest : public ConnectorUploadRequest {
public:
// Creates a MultipartUploadRequest, which will upload `data` to the given
// `base_url` with `metadata` attached.
MultipartUploadRequest(
scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory,
const GURL& base_url,
const std::string& metadata,
const std::string& data,
const std::string& histogram_suffix,
const net::NetworkTrafficAnnotationTag& traffic_annotation,
Callback callback);
// Creates a MultipartUploadRequest, which will upload the file corresponding
// to `path` to the given `base_url` with `metadata` attached.
MultipartUploadRequest(
scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory,
const GURL& base_url,
const std::string& metadata,
const base::FilePath& path,
uint64_t file_size,
bool is_obfuscated,
const std::string& histogram_suffix,
const net::NetworkTrafficAnnotationTag& traffic_annotation,
Callback callback);
// Creates a MultipartUploadRequest, which will upload the page in
// `page_region` to the given `base_url` with `metadata` attached.
MultipartUploadRequest(
scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory,
const GURL& base_url,
const std::string& metadata,
base::ReadOnlySharedMemoryRegion page_region,
const std::string& histogram_suffix,
const net::NetworkTrafficAnnotationTag& traffic_annotation,
Callback callback);
MultipartUploadRequest(const MultipartUploadRequest&) = delete;
MultipartUploadRequest& operator=(const MultipartUploadRequest&) = delete;
MultipartUploadRequest(MultipartUploadRequest&&) = delete;
MultipartUploadRequest& operator=(MultipartUploadRequest&&) = delete;
~MultipartUploadRequest() override;
// Start the upload. This must be called on the UI thread. When complete, this
// will call `callback_` on the UI thread.
void Start() override;
std::string GetUploadInfo() override;
static std::unique_ptr<ConnectorUploadRequest> CreateStringRequest(
scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory,
const GURL& base_url,
const std::string& metadata,
const std::string& data,
const std::string& histogram_suffix,
const net::NetworkTrafficAnnotationTag& traffic_annotation,
MultipartUploadRequest::Callback callback);
static std::unique_ptr<ConnectorUploadRequest> CreateFileRequest(
scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory,
const GURL& base_url,
const std::string& metadata,
const base::FilePath& file,
uint64_t file_size,
bool is_obfuscated,
const std::string& histogram_suffix,
const net::NetworkTrafficAnnotationTag& traffic_annotation,
MultipartUploadRequest::Callback callback);
static std::unique_ptr<ConnectorUploadRequest> CreatePageRequest(
scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory,
const GURL& base_url,
const std::string& metadata,
base::ReadOnlySharedMemoryRegion page_region,
const std::string& histogram_suffix,
const net::NetworkTrafficAnnotationTag& traffic_annotation,
MultipartUploadRequest::Callback callback);
void SetRequestHeaders(network::ResourceRequest* request);
// Update `scan_type_` to be CONTENT to indicate that the content scan is
// successful. Used in testing only.
void MarkScanAsCompleteForTesting();
private:
FRIEND_TEST_ALL_PREFIXES(MultipartUploadRequestTest, GeneratesCorrectBody);
FRIEND_TEST_ALL_PREFIXES(MultipartUploadRequestTest, RetriesCorrectly);
FRIEND_TEST_ALL_PREFIXES(MultipartUploadRequestTest,
EmitsNetworkRequestResponseCodeOrErrorHistogram);
FRIEND_TEST_ALL_PREFIXES(MultipartUploadRequestTest,
EmitsUploadSuccessHistogram);
FRIEND_TEST_ALL_PREFIXES(MultipartUploadRequestTest,
EmitsRetriesNeededHistogram);
FRIEND_TEST_ALL_PREFIXES(MultipartUploadDataPipeRequestTest, Retries);
FRIEND_TEST_ALL_PREFIXES(MultipartUploadDataPipeRequestTest, DataControls);
FRIEND_TEST_ALL_PREFIXES(MultipartUploadDataPipeRequestTest,
EquivalentToStringRequest);
// Set the boundary between parts.
void set_boundary(const std::string& boundary) { boundary_ = boundary; }
// Helper method to create the multipart request body.
std::string GenerateRequestBody(const std::string& metadata,
const std::string& data);
// Called whenever a net request finishes (on success or failure).
void OnURLLoaderComplete(std::optional<std::string> response_body);
// Called whenever a net request finishes (on success or failure).
void RetryOrFinish(int net_error,
int response_code,
std::optional<std::string> response_body);
// Called to send a single request. Is overridden in tests.
virtual void SendRequest();
void SendStringRequest(std::unique_ptr<network::ResourceRequest> request);
void SendFileRequest(std::unique_ptr<network::ResourceRequest> request);
void SendPageRequest(std::unique_ptr<network::ResourceRequest> request);
// Called after `data_pipe_getter_` has been initialized.
void DataPipeCreatedCallback(
std::unique_ptr<network::ResourceRequest> request,
std::unique_ptr<ConnectorDataPipeGetter> data_pipe_getter);
// Called by SendFileRequest and SendPageRequest after `data_pipe_getter_`
// is known to be initialized to a correct state.
virtual void CompleteSendRequest(
std::unique_ptr<network::ResourceRequest> request);
void CreateDatapipe(std::unique_ptr<network::ResourceRequest> request,
file_access::ScopedFileAccess file_access);
std::string boundary_;
base::TimeDelta current_backoff_;
int retry_count_;
base::Time start_time_;
bool scan_complete_ = false;
bool is_obfuscated_ = false;
base::WeakPtrFactory<MultipartUploadRequest> weak_factory_{this};
};
} // namespace safe_browsing
#endif // CHROME_BROWSER_SAFE_BROWSING_CLOUD_CONTENT_SCANNING_MULTIPART_UPLOADER_H_
|
