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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.
use glean::net::{PingUploadRequest, PingUploader, UploadResult};
use once_cell::sync::OnceCell;
use std::sync::Once;
use url::Url;
use viaduct::{Error::*, Request};
extern "C" {
fn FOG_TooLateToSend() -> bool;
}
/// An uploader that uses [Viaduct](https://github.com/mozilla/application-services/tree/main/components/viaduct).
#[derive(Debug)]
pub(crate) struct ViaductUploader;
impl PingUploader for ViaductUploader {
/// Uploads a ping to a server.
///
/// # Arguments
///
/// * `upload_request` - the ping and its metadata to upload.
fn upload(&self, upload_request: PingUploadRequest) -> UploadResult {
log::trace!("FOG Ping Uploader uploading to {}", upload_request.url);
// SAFETY NOTE: Safe because it returns a primitive by value.
if unsafe { FOG_TooLateToSend() } {
log::trace!("Attempted to send ping too late into shutdown.");
return UploadResult::done();
}
let debug_tagged = upload_request
.headers
.iter()
.any(|(name, _)| name == "X-Debug-ID");
let localhost_port = static_prefs::pref!("telemetry.fog.test.localhost_port");
if localhost_port < 0
|| (localhost_port == 0 && !debug_tagged && cfg!(feature = "disable_upload"))
{
log::info!("FOG Ping uploader faking success");
return UploadResult::http_status(200);
}
// Localhost-destined pings are sent without OHTTP,
// even if configured to use OHTTP.
let result = if localhost_port == 0 && should_ohttp_upload(&upload_request) {
ohttp_upload(upload_request)
} else {
viaduct_upload(upload_request)
};
log::trace!(
"FOG Ping Uploader completed uploading (Result {:?})",
result
);
match result {
Ok(result) => result,
Err(ViaductUploaderError::Viaduct(ve)) => match ve {
NonTlsUrl | UrlError(_) => UploadResult::unrecoverable_failure(),
RequestHeaderError(_)
| BackendError(_)
| NetworkError(_)
| BackendNotInitialized
| SetBackendError => UploadResult::recoverable_failure(),
},
Err(
ViaductUploaderError::Bhttp(_)
| ViaductUploaderError::Ohttp(_)
| ViaductUploaderError::Fatal,
) => UploadResult::unrecoverable_failure(),
}
}
}
fn viaduct_upload(upload_request: PingUploadRequest) -> Result<UploadResult, ViaductUploaderError> {
let parsed_url = Url::parse(&upload_request.url)?;
log::info!("FOG viaduct uploader uploading to {:?}", parsed_url);
let mut req = Request::post(parsed_url.clone()).body(upload_request.body);
for (header_key, header_value) in &upload_request.headers {
req = req.header(header_key.to_owned(), header_value)?;
}
log::trace!("FOG viaduct uploader sending ping to {:?}", parsed_url);
let res = req.send()?;
Ok(UploadResult::http_status(res.status as i32))
}
fn should_ohttp_upload(upload_request: &PingUploadRequest) -> bool {
crate::ohttp_pings::uses_ohttp(&upload_request.ping_name)
&& !upload_request.body_has_info_sections
}
fn ohttp_upload(upload_request: PingUploadRequest) -> Result<UploadResult, ViaductUploaderError> {
static CELL: OnceCell<Vec<u8>> = once_cell::sync::OnceCell::new();
let config = CELL.get_or_try_init(|| get_config())?;
let binary_request = bhttp_encode(upload_request)?;
static OHTTP_INIT: Once = Once::new();
OHTTP_INIT.call_once(|| {
ohttp::init();
});
let ohttp_request = ohttp::ClientRequest::new(config)?;
let (capsule, ohttp_response) = ohttp_request.encapsulate(&binary_request)?;
const OHTTP_RELAY_URL: &str = "https://mozilla-ohttp.fastly-edge.com/";
let parsed_relay_url = Url::parse(OHTTP_RELAY_URL)?;
log::trace!("FOG ohttp uploader uploading to {}", parsed_relay_url);
const OHTTP_MESSAGE_CONTENT_TYPE: &str = "message/ohttp-req";
let req = Request::post(parsed_relay_url)
.header(
viaduct::header_names::CONTENT_TYPE,
OHTTP_MESSAGE_CONTENT_TYPE,
)?
.body(capsule);
let res = req.send()?;
if res.status == 200 {
// This just tells us the HTTP went well. Check OHTTP's status.
let binary_response = ohttp_response.decapsulate(&res.body)?;
let mut cursor = std::io::Cursor::new(binary_response);
let bhttp_message = bhttp::Message::read_bhttp(&mut cursor)?;
let res = bhttp_message
.control()
.status()
.ok_or(ViaductUploaderError::Fatal)?;
Ok(UploadResult::http_status(res as i32))
} else {
Ok(UploadResult::http_status(res.status as i32))
}
}
fn get_config() -> Result<Vec<u8>, ViaductUploaderError> {
const OHTTP_CONFIG_URL: &str =
"https://prod.ohttp-gateway.prod.webservices.mozgcp.net/ohttp-configs";
log::trace!("Getting OHTTP config from {}", OHTTP_CONFIG_URL);
let parsed_config_url = Url::parse(OHTTP_CONFIG_URL)?;
Ok(Request::get(parsed_config_url).send()?.body)
}
/// Encode the ping upload request in binary HTTP.
/// (draft-ietf-httpbis-binary-message)
fn bhttp_encode(upload_request: PingUploadRequest) -> Result<Vec<u8>, ViaductUploaderError> {
let parsed_url = Url::parse(&upload_request.url)?;
let mut message = bhttp::Message::request(
"POST".into(),
parsed_url.scheme().into(),
parsed_url
.host_str()
.ok_or(ViaductUploaderError::Fatal)?
.into(),
parsed_url.path().into(),
);
upload_request
.headers
.into_iter()
.for_each(|(k, v)| message.put_header(k, v));
message.write_content(upload_request.body);
let mut encoded = vec![];
message.write_bhttp(bhttp::Mode::KnownLength, &mut encoded)?;
Ok(encoded)
}
/// Unioned error across upload backends.
#[derive(Debug, thiserror::Error)]
enum ViaductUploaderError {
#[error("bhttp::Error {0}")]
Bhttp(#[from] bhttp::Error),
#[error("ohttp::Error {0}")]
Ohttp(#[from] ohttp::Error),
#[error("viaduct::Error {0}")]
Viaduct(#[from] viaduct::Error),
#[error("Fatal upload error")]
Fatal,
}
impl From<url::ParseError> for ViaductUploaderError {
fn from(e: url::ParseError) -> Self {
ViaductUploaderError::Viaduct(viaduct::Error::from(e))
}
}
|
