Newer
Older
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
// Copyright 2019 Parity Technologies (UK) Ltd.
//
// Permission is hereby granted, free of charge, to any
// person obtaining a copy of this software and associated
// documentation files (the "Software"), to deal in the
// Software without restriction, including without
// limitation the rights to use, copy, modify, merge,
// publish, distribute, sublicense, and/or sell copies of
// the Software, and to permit persons to whom the Software
// is furnished to do so, subject to the following
// conditions:
//
// The above copyright notice and this permission notice
// shall be included in all copies or substantial portions
// of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
// ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
// TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
// PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
// SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
// IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//! Utility methods relying on hyper
use futures::StreamExt;
use jsonrpsee_types::{error::GenericTransportError, http::HttpConfig};
/// Read a hyper response with configured `HTTP` settings.
///
/// Returns `Ok(bytes)` if the body was in valid size range.
/// Returns `Err` if the body was too large or the body couldn't be read.
pub async fn read_response_to_body(
headers: &hyper::HeaderMap,
mut body: hyper::Body,
config: HttpConfig,
) -> Result<Vec<u8>, GenericTransportError<hyper::Error>> {
// NOTE(niklasad1): Values bigger than `u32::MAX` will be turned into zero here. This is unlikely to occur in practise
// and for that case we fallback to allocating in the while-loop below instead of pre-allocating.
let body_size = read_header_content_length(&headers).unwrap_or(0);
if body_size > config.max_request_body_size {
return Err(GenericTransportError::TooLarge);
}
let mut received_data = Vec::with_capacity(body_size as usize);
while let Some(chunk) = body.next().await {
let chunk = chunk.map_err(GenericTransportError::Inner)?;
let body_length = chunk.len() + received_data.len();
if body_length > config.max_request_body_size as usize {
return Err(GenericTransportError::TooLarge);
}
received_data.extend_from_slice(&chunk);
}
Ok(received_data)
}
/// Read the `Content-Length` HTTP Header. Must fit into a `u32`; returns `None` otherwise.
///
/// NOTE: There's no specific hard limit on `Content_length` in HTTP specification.
/// Thus this method might reject valid `content_length`
fn read_header_content_length(headers: &hyper::header::HeaderMap) -> Option<u32> {
let length = read_header_value(headers, "content-length")?;
// HTTP Content-Length indicates number of bytes in decimal.
length.parse::<u32>().ok()
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
}
/// Returns a string value when there is exactly one value for the given header.
pub fn read_header_value<'a>(headers: &'a hyper::header::HeaderMap, header_name: &str) -> Option<&'a str> {
let mut values = headers.get_all(header_name).iter();
let val = values.next()?;
if values.next().is_none() {
val.to_str().ok()
} else {
None
}
}
/// Returns an iterator of all values for a given a header name
pub fn read_header_values<'a>(
headers: &'a hyper::header::HeaderMap,
header_name: &str,
) -> hyper::header::ValueIter<'a, hyper::header::HeaderValue> {
headers.get_all(header_name).iter()
}
#[cfg(test)]
mod tests {
use super::{read_header_content_length, read_response_to_body, HttpConfig};
use jsonrpsee_types::jsonrpc;
#[tokio::test]
async fn body_to_request_works() {
let s = r#"[{"a":"hello"}]"#;
let expected: jsonrpc::Request = serde_json::from_str(s).unwrap();
let body = hyper::Body::from(s.to_owned());
let headers = hyper::header::HeaderMap::new();
let bytes = read_response_to_body(&headers, body, HttpConfig::default()).await.unwrap();
let req: jsonrpc::Request = serde_json::from_slice(&bytes).unwrap();
assert_eq!(req, expected);
}
#[tokio::test]
async fn body_to_bytes_size_limit_works() {
let headers = hyper::header::HeaderMap::new();
let body = hyper::Body::from(vec![0; 128]);
assert!(read_response_to_body(&headers, body, HttpConfig { max_request_body_size: 127 }).await.is_err());
}
#[test]
fn read_content_length_works() {
let mut headers = hyper::header::HeaderMap::new();
headers.insert(hyper::header::CONTENT_LENGTH, "177".parse().unwrap());
assert_eq!(read_header_content_length(&headers), Some(177));
headers.append(hyper::header::CONTENT_LENGTH, "999".parse().unwrap());
assert_eq!(read_header_content_length(&headers), None);
}
#[test]
fn read_content_length_too_big_value() {
let mut headers = hyper::header::HeaderMap::new();
headers.insert(hyper::header::CONTENT_LENGTH, "18446744073709551616".parse().unwrap());
assert_eq!(read_header_content_length(&headers), None);
}
}