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 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
//! The module contains the implementation of the `DATA` frame and associated flags. use std::io; use std::borrow::Cow; use http::StreamId; use http::frame::{FrameBuilder, FrameIR, Flag, Frame, FrameHeader, RawFrame, parse_padded_payload}; /// An enum representing the flags that a `DataFrame` can have. /// The integer representation associated to each variant is that flag's /// bitmask. /// /// HTTP/2 spec, section 6.1. #[derive(Clone)] #[derive(PartialEq)] #[derive(Debug)] #[derive(Copy)] pub enum DataFlag { EndStream = 0x1, Padded = 0x8, } impl Flag for DataFlag { #[inline] fn bitmask(&self) -> u8 { *self as u8 } } /// A helper struct that allows the chunk to be either borrowed or owned. Used to provide the /// `From` implementations that allow us to implement generic methods that accept any type that can /// be converted into a `DataChunk` (given that the native `Cow` type does not have these /// implementations and we cannot add them). pub struct DataChunk<'a>(Cow<'a, [u8]>); impl<'a> From<Vec<u8>> for DataChunk<'a> { fn from(vec: Vec<u8>) -> DataChunk<'a> { DataChunk(Cow::Owned(vec)) } } impl<'a> From<&'a [u8]> for DataChunk<'a> { fn from(buf: &'a [u8]) -> DataChunk<'a> { DataChunk(Cow::Borrowed(buf)) } } /// A struct representing the DATA frames of HTTP/2, as defined in the HTTP/2 /// spec, section 6.1. #[derive(PartialEq)] #[derive(Debug)] #[derive(Clone)] pub struct DataFrame<'a> { /// The data found in the frame as an opaque byte sequence. It never /// includes padding bytes. pub data: Cow<'a, [u8]>, /// Represents the flags currently set on the `DataFrame`, packed into a /// single byte. flags: u8, /// The ID of the stream with which the frame is associated. stream_id: StreamId, /// The length of the padding applied to the data. Since the spec defines /// that the padding length is at most an unsigned integer value, we also /// keep a `u8`, instead of a `usize`. padding_len: Option<u8>, } impl<'a> DataFrame<'a> { /// Creates a new empty `DataFrame`, associated to the stream with the /// given ID. pub fn new(stream_id: StreamId) -> DataFrame<'a> { DataFrame { stream_id: stream_id, // All flags unset by default flags: 0, // No data stored in the frame yet data: Cow::Borrowed(&[]), // No padding padding_len: None, } } /// Creates a new `DataFrame` with the given `DataChunk`. /// /// The chunk can be any type that can be converted into a `DataChunk` instance and, as such, /// can either pass ownership of the buffer to the DataFrame or provide a temporary borrow. pub fn with_data<D: Into<DataChunk<'a>>>(stream_id: StreamId, data: D) -> DataFrame<'a> { DataFrame { stream_id: stream_id, flags: 0, data: data.into().0, padding_len: None, } } /// Returns `true` if the DATA frame is padded, otherwise false. pub fn is_padded(&self) -> bool { self.is_set(DataFlag::Padded) } /// Returns whther this frame ends the stream it is associated with. pub fn is_end_of_stream(&self) -> bool { self.is_set(DataFlag::EndStream) } /// Sets the number of bytes that should be used as padding for this /// frame. pub fn set_padding(&mut self, pad_len: u8) { self.set_flag(DataFlag::Padded); self.padding_len = Some(pad_len); } /// Returns the total length of the payload, taking into account possible /// padding. pub fn payload_len(&self) -> u32 { if self.is_padded() { 1 + (self.data.len() as u32) + (self.padding_len.unwrap_or(0) as u32) } else { // Downcasting here is all right, because the HTTP/2 frames cannot // have a length larger than a 32 bit unsigned integer. self.data.len() as u32 } } /// Parses the given slice as a DATA frame's payload. Depending on the /// `padded` flag, it will treat the given bytes as a data frame with /// padding or without. /// /// # Returns /// /// A tuple wrapped in the `Some` variant, representing the true data and /// the original padding length. /// If there was no padding, returns `None` for the second tuple member. /// /// If the payload was invalid for a DATA frame, returns `None` fn parse_payload(payload: &[u8], padded: bool) -> Option<(&[u8], Option<u8>)> { let (data, pad_len) = if padded { match parse_padded_payload(payload) { Some((data, pad_len)) => (data, Some(pad_len)), None => return None, } } else { (payload, None) }; Some((data, pad_len)) } /// Sets the given flag for the frame. pub fn set_flag(&mut self, flag: DataFlag) { self.flags |= flag.bitmask(); } } impl<'a> Frame<'a> for DataFrame<'a> { type FlagType = DataFlag; /// Creates a new `DataFrame` from the given `RawFrame` (i.e. header and /// payload), if possible. Returns `None` if a valid `DataFrame` cannot be /// constructed from the given `RawFrame`. fn from_raw(raw_frame: &'a RawFrame<'a>) -> Option<DataFrame<'a>> { // Unpack the header let (len, frame_type, flags, stream_id) = raw_frame.header(); // Check that the frame type is correct for this frame implementation if frame_type != 0x0 { return None; } // Check that the length given in the header matches the payload // length; if not, something went wrong and we do not consider this a // valid frame. if (len as usize) != raw_frame.payload().len() { return None; } // A DATA frame cannot be associated to the connection itself. if stream_id == 0x0 { return None; } // No validation is required for the flags, since according to the spec, // unknown flags MUST be ignored. // Everything has been validated so far: try to extract the data from // the payload. let padded = (flags & DataFlag::Padded.bitmask()) != 0; match DataFrame::parse_payload(raw_frame.payload(), padded) { Some((data, Some(padding_len))) => { // The data got extracted (from a padded frame) Some(DataFrame { stream_id: stream_id, flags: flags, data: Cow::Borrowed(data), padding_len: Some(padding_len), }) } Some((data, None)) => { // The data got extracted (from a no-padding frame) Some(DataFrame { stream_id: stream_id, flags: flags, data: Cow::Borrowed(data), padding_len: None, }) } None => None, } } /// Tests if the given flag is set for the frame. fn is_set(&self, flag: DataFlag) -> bool { (self.flags & flag.bitmask()) != 0 } /// Returns the `StreamId` of the stream to which the frame is associated. fn get_stream_id(&self) -> StreamId { self.stream_id } /// Returns a `FrameHeader` based on the current state of the frame. fn get_header(&self) -> FrameHeader { (self.payload_len(), 0x0, self.flags, self.stream_id) } } impl<'a> FrameIR for DataFrame<'a> { fn serialize_into<B: FrameBuilder>(self, b: &mut B) -> io::Result<()> { try!(b.write_header(self.get_header())); if self.is_padded() { let pad_len = self.padding_len.unwrap_or(0); try!(b.write_all(&[pad_len])); try!(b.write_all(&self.data)); try!(b.write_padding(pad_len)); } else { try!(b.write_all(&self.data)); } Ok(()) } } #[cfg(test)] mod tests { use super::{DataFlag, DataFrame}; use http::frame::tests::build_padded_frame_payload; use http::tests::common::{raw_frame_from_parts, serialize_frame}; use http::frame::{pack_header, Frame}; /// Tests that the `DataFrame` struct correctly interprets a DATA frame /// with no padding set. #[test] fn test_data_frame_parse_no_padding() { let data = b"asdf"; let payload = data.to_vec(); // A header with the flag indicating no padding let header = (payload.len() as u32, 0u8, 0u8, 1u32); let raw = raw_frame_from_parts(header.clone(), payload.to_vec()); let frame: DataFrame = Frame::from_raw(&raw).unwrap(); // The frame correctly returns the data? assert_eq!(&frame.data[..], &data[..]); // ...and the headers? assert_eq!(frame.get_header(), header); } /// Tests that the `DataFrame` struct correctly knows when it represents the end of the /// corresponding stream. #[test] fn test_data_frame_is_end_of_stream() { let mut frame = DataFrame::new(1); assert!(!frame.is_end_of_stream()); frame.set_flag(DataFlag::EndStream); assert!(frame.is_end_of_stream()); } /// Tests that the `DataFrame` struct correctly interprets a DATA frame /// with a number of padding bytes set. #[test] fn test_data_frame_padded() { let data = b"asdf"; let payload = build_padded_frame_payload(data, 5); // A header with the flag indicating padding let header = (payload.len() as u32, 0u8, 8u8, 1u32); let raw = raw_frame_from_parts(header.clone(), payload.to_vec()); let frame: DataFrame = Frame::from_raw(&raw).unwrap(); // The frame correctly returns the data? assert_eq!(&frame.data[..], &data[..]); // ...and the headers? assert_eq!(frame.get_header(), header); } /// Tests that a DATA frame with a zero-length payload is still considered /// valid. /// /// There doesn't seem to be anything in the spec that would make it invalid. /// The spec says that frames are considered invalid if their size is too /// small to contain all the mandatory parts of the frame of a particular /// type. Since the DATA frame does not have any mandatory fields (of size /// greater than 1), a zero-len payload should be all right. #[test] fn test_data_frame_zero_len_payload() { let data = b""; let payload = data.to_vec(); // A header with the flag indicating no padding let header = (payload.len() as u32, 0u8, 0u8, 1u32); let raw = raw_frame_from_parts(header.clone(), payload.to_vec()); let frame: DataFrame = Frame::from_raw(&raw).unwrap(); // The frame correctly returns the data? assert_eq!(&frame.data[..], &data[..]); // ...and the headers? assert_eq!(frame.get_header(), header); } /// Tests that the `DataFrame` struct correctly handles the case where the /// padding is invalid: the size of the padding given is greater than or /// equal to the total size of the frame. #[test] fn test_data_frame_padding_invalid() { let payload = vec![5, b'a', b's', b'd', b'f']; // A header with the flag indicating padding let header = (payload.len() as u32, 0u8, 8u8, 1u32); let raw = raw_frame_from_parts(header, payload); let frame: Option<DataFrame> = Frame::from_raw(&raw); // The frame was not even created since the raw bytes are invalid assert!(frame.is_none()) } /// Tests that if a frame that should be parsed has a stream ID of 0, it is /// not considered a valid DATA frame. #[test] fn test_data_frame_stream_zero() { let data = b"asdf"; let payload = data.to_vec(); // Stream 0 let header = (payload.len() as u32, 0u8, 0u8, 0u32); let raw = raw_frame_from_parts(header, payload.to_vec()); let frame: Option<DataFrame> = Frame::from_raw(&raw); // The frame is not valid. assert!(frame.is_none()); } /// Tests that the `DataFrame` struct correctly interprets a DATA frame /// with no padding and no data. #[test] fn test_data_frame_no_padding_empty() { let payload = []; let header = (payload.len() as u32, 0u8, 0u8, 1u32); let raw = raw_frame_from_parts(header.clone(), payload.to_vec()); let frame: DataFrame = Frame::from_raw(&raw).unwrap(); // The frame correctly returns the data -- i.e. an empty array? assert_eq!(&frame.data[..], &[][..]); // ...and the headers? assert_eq!(frame.get_header(), header); } /// Tests that the `DataFrame` struct correctly interprets a DATA frame /// with padding, but an empty payload. #[test] fn test_data_frame_padding_empty_payload() { let payload = vec![]; let header = (payload.len() as u32, 0u8, 8u8, 1u32); let raw = raw_frame_from_parts(header, payload); let frame: Option<DataFrame> = Frame::from_raw(&raw); // In this case, we cannot receive a frame, since the payload did not // contain even the first byte, necessary to find the padding length. assert!(frame.is_none()); } /// Tests that the `DataFrame` struct correctly interprets a DATA frame /// with padding of size 0. #[test] fn test_data_frame_null_padding() { let data = b"test string"; let payload = build_padded_frame_payload(data, 0); // A header with the flag indicating padding let header = (payload.len() as u32, 0u8, 8u8, 1u32); let raw = raw_frame_from_parts(header.clone(), payload.to_vec()); let frame: DataFrame = Frame::from_raw(&raw).unwrap(); // The frame correctly returns the data? assert_eq!(&frame.data[..], &data[..]); // ...and the headers? assert_eq!(frame.get_header(), header); } /// Tests that the `DataFrame` struct correctly handles the situation /// where the header does not contain a frame type corresponding to the /// DATA frame type. #[test] fn test_data_frame_invalid_type() { let data = b"dummy"; let payload = build_padded_frame_payload(data, 0); // The header has an invalid type (0x1 instead of 0x0). let header = (payload.len() as u32, 1u8, 8u8, 1u32); let raw = raw_frame_from_parts(header, payload); let frame: Option<DataFrame> = Frame::from_raw(&raw); assert!(frame.is_none()); } /// Tests that `DataFrame`s get correctly serialized when created with no /// padding and with no data. #[test] fn test_data_frame_serialize_no_padding_empty() { let frame = DataFrame::new(1); let expected = { let headers = pack_header(&(0, 0, 0, 1)); let mut res: Vec<u8> = Vec::new(); res.extend(headers.to_vec()); res }; let serialized = serialize_frame(&frame); assert_eq!(serialized, expected); } /// Tests that `DataFrame`s get correctly serialized when created with no /// padding and with some amount of data. #[test] fn test_data_frame_serialize_no_padding() { let data = vec![1, 2, 3, 4, 5, 100]; let frame = DataFrame::with_data(1, &data[..]); let expected = { let headers = pack_header(&(6, 0, 0, 1)); let mut res: Vec<u8> = Vec::new(); res.extend(headers.to_vec()); res.extend(data.clone()); res }; let serialized = serialize_frame(&frame); assert_eq!(serialized, expected); } /// Tests that `DataFrame`s get correctly serialized when created with /// some amount of padding and some data. #[test] fn test_data_frame_serialize_padding() { let data = vec![1, 2, 3, 4, 5, 100]; let mut frame = DataFrame::with_data(1, &data[..]); frame.set_padding(5); let expected = { let headers = pack_header(&(6 + 1 + 5, 0, 8, 1)); let mut res: Vec<u8> = Vec::new(); // Headers res.extend(headers.to_vec()); // Padding len res.push(5); // Data res.extend(data.clone()); // Actual padding for _ in 0..5 { res.push(0); } res }; let serialized = serialize_frame(&frame); assert_eq!(serialized, expected); } /// Tests that `DataFrame`s get correctly serialized when created with /// 0 padding. This is a distinct case from having *no padding*. #[test] fn test_data_frame_serialize_null_padding() { let data = vec![1, 2, 3, 4, 5, 100]; let cloned = data.clone(); let mut frame = DataFrame::with_data(1, data); frame.set_flag(DataFlag::Padded); let expected = { let headers = pack_header(&(6 + 1, 0, 8, 1)); let mut res: Vec<u8> = Vec::new(); // Headers res.extend(headers.to_vec()); // Padding len res.push(0); // Data res.extend(cloned); res }; let serialized = serialize_frame(&frame); assert_eq!(serialized, expected); } }