quic_framer.h revision 1e9bf3e0803691d0a228da41fc608347b6db4340
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef NET_QUIC_QUIC_FRAMER_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define NET_QUIC_QUIC_FRAMER_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <vector> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/logging.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/scoped_ptr.h" 13c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "base/strings/string_piece.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "net/base/net_export.h" 152a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "net/quic/quic_protocol.h" 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace net { 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 192a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)namespace test { 202a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class QuicFramerPeer; 212a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)} // namespace test 222a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class QuicDataReader; 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class QuicDataWriter; 252a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class QuicDecrypter; 262a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class QuicEncrypter; 272a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class QuicFramer; 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 292a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// Number of bytes reserved for the frame type preceding each frame. 302a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)const size_t kQuicFrameTypeSize = 1; 312a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// Number of bytes reserved for error code. 322a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)const size_t kQuicErrorCodeSize = 4; 332a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// Number of bytes reserved to denote the length of error details field. 342a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)const size_t kQuicErrorDetailsLengthSize = 2; 352a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 362385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch// Maximum number of bytes reserved for stream id. 372385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdochconst size_t kQuicMaxStreamIdSize = 4; 382385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch// Maximum number of bytes reserved for byte offset in stream frame. 392385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdochconst size_t kQuicMaxStreamOffsetSize = 8; 402a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// Number of bytes reserved to store payload length in stream frame. 412a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)const size_t kQuicStreamPayloadLengthSize = 2; 422a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 432a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// Size in bytes of the entropy hash sent in ack frames. 442a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)const size_t kQuicEntropyHashSize = 1; 45c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// Size in bytes reserved for the delta time of the largest observed 46c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// sequence number in ack frames. 47c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)const size_t kQuicDeltaTimeLargestObservedSize = 4; 482a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// Size in bytes reserved for the number of missing packets in ack frames. 492a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)const size_t kNumberOfMissingPacketsSize = 1; 502a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 512a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// This class receives callbacks from the framer when packets 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// are processed. 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class NET_EXPORT_PRIVATE QuicFramerVisitorInterface { 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~QuicFramerVisitorInterface() {} 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called if an error is detected in the QUIC protocol. 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnError(QuicFramer* framer) = 0; 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 602a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Called only when |is_server_| is true and the the framer gets a packet with 612a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // version flag true and the version on the packet doesn't match 622a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // |quic_version_|. The visitor should return true after it updates the 632a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // version of the |framer_| to |received_version| or false to stop processing 642a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // this packet. 65558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdoch virtual bool OnProtocolVersionMismatch(QuicVersion received_version) = 0; 662a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 672a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Called when a new packet has been received, before it 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // has been validated or processed. 692a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual void OnPacket() = 0; 702a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 712a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Called when a public reset packet has been parsed but has not yet 722a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // been validated. 732a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual void OnPublicResetPacket( 742a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicPublicResetPacket& packet) = 0; 752a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 762a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Called only when |is_server_| is false and a version negotiation packet has 772a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // been parsed. 782a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual void OnVersionNegotiationPacket( 792a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicVersionNegotiationPacket& packet) = 0; 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when a lost packet has been recovered via FEC, 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // before it has been processed. 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnRevivedPacket() = 0; 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 852a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Called when the complete header of a packet had been parsed. 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If OnPacketHeader returns false, framing for this packet will cease. 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool OnPacketHeader(const QuicPacketHeader& header) = 0; 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when a data packet is parsed that is part of an FEC group. 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |payload| is the non-encrypted FEC protected payload of the packet. 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnFecProtectedPayload(base::StringPiece payload) = 0; 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when a StreamFrame has been parsed. 94c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual bool OnStreamFrame(const QuicStreamFrame& frame) = 0; 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 96c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Called when a AckFrame has been parsed. If OnAckFrame returns false, 97c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // the framer will stop parsing the current packet. 98c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual bool OnAckFrame(const QuicAckFrame& frame) = 0; 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1002a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Called when a CongestionFeedbackFrame has been parsed. 101c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual bool OnCongestionFeedbackFrame( 1022a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicCongestionFeedbackFrame& frame) = 0; 1032a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when a RstStreamFrame has been parsed. 105c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual bool OnRstStreamFrame(const QuicRstStreamFrame& frame) = 0; 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when a ConnectionCloseFrame has been parsed. 108c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual bool OnConnectionCloseFrame( 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const QuicConnectionCloseFrame& frame) = 0; 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1112a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Called when a GoAwayFrame has been parsed. 112c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual bool OnGoAwayFrame(const QuicGoAwayFrame& frame) = 0; 1132a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when FEC data has been parsed. 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnFecData(const QuicFecData& fec) = 0; 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when a packet has been completely processed. 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnPacketComplete() = 0; 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class NET_EXPORT_PRIVATE QuicFecBuilderInterface { 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~QuicFecBuilderInterface() {} 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when a data packet is constructed that is part of an FEC group. 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |payload| is the non-encrypted FEC protected payload of the packet. 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnBuiltFecProtectedPayload(const QuicPacketHeader& header, 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::StringPiece payload) = 0; 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1312a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// This class calculates the received entropy of the ack packet being 1322a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// framed, should it get truncated. 1332a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class NET_EXPORT_PRIVATE QuicReceivedEntropyHashCalculatorInterface { 1342a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) public: 1352a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual ~QuicReceivedEntropyHashCalculatorInterface() {} 1362a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1372a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // When an ack frame gets truncated while being framed the received 1382a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // entropy of the ack frame needs to be calculated since the some of the 1392a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // missing packets are not added and the largest observed might be lowered. 1402a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // This should return the received entropy hash of the packets received up to 1412a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // and including |sequence_number|. 142558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdoch virtual QuicPacketEntropyHash EntropyHash( 1432a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicPacketSequenceNumber sequence_number) const = 0; 1442a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)}; 1452a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1462a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// Class for parsing and constructing QUIC packets. It has a 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// QuicFramerVisitorInterface that is called when packets are parsed. 1482a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// It also has a QuicFecBuilder that is called when packets are constructed 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// in order to generate FEC data for subsequently building FEC packets. 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class NET_EXPORT_PRIVATE QuicFramer { 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 152c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Constructs a new framer that installs a kNULL QuicEncrypter and 1531e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) // QuicDecrypter for level ENCRYPTION_NONE. |supported_versions| specifies the 1541e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) // list of supported QUIC versions. |quic_version_| is set to the maximum 1551e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) // version in |supported_versions|. 1561e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) QuicFramer(const QuicVersionVector& supported_versions, 157c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) QuicTime creation_time, 1582a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool is_server); 1595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~QuicFramer(); 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1622a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns true if |version| is a supported protocol version. 163558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdoch bool IsSupportedVersion(const QuicVersion version) const; 1642a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1652a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Calculates the largest observed packet to advertise in the case an Ack 1662a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Frame was truncated. last_written in this case is the iterator for the 1672a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // last missing packet which fit in the outgoing ack. 1682a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static QuicPacketSequenceNumber CalculateLargestObserved( 1692a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const SequenceNumberSet& missing_packets, 1702a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) SequenceNumberSet::const_iterator last_written); 1712a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Set callbacks to be called from the framer. A visitor must be set, or 1735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // else the framer will likely crash. It is acceptable for the visitor 1745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // to do nothing. If this is called multiple times, only the last visitor 1755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // will be used. 1765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_visitor(QuicFramerVisitorInterface* visitor) { 1775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) visitor_ = visitor; 1785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Set a builder to be called from the framer when building FEC protected 1815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // packets. If this is called multiple times, only the last builder 1825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // will be used. The builder need not be set. 1835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_fec_builder(QuicFecBuilderInterface* builder) { 1845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) fec_builder_ = builder; 1855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1871e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) const QuicVersionVector& supported_versions() const { 1881e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) return supported_versions_; 1891e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) } 1901e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) 191558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdoch QuicVersion version() const { 1922a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) return quic_version_; 1932a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 1942a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1954e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) void set_version(const QuicVersion version); 1962a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 197558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdoch // Does not DCHECK for supported version. Used by tests to set unsupported 198558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdoch // version to trigger version negotiation. 199558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdoch void set_version_for_tests(const QuicVersion version) { 200558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdoch quic_version_ = version; 201558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdoch } 202558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdoch 2032a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Set entropy calculator to be called from the framer when it needs the 2042a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // entropy of a truncated ack frame. An entropy calculator must be set or else 2052a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // the framer will likely crash. If this is called multiple times, only the 206558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdoch // last calculator will be used. 207558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdoch void set_received_entropy_calculator( 2082a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicReceivedEntropyHashCalculatorInterface* entropy_calculator) { 2092a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) entropy_calculator_ = entropy_calculator; 2102a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 2112a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 2125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) QuicErrorCode error() const { 2135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return error_; 2145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 2155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Pass a UDP packet into the framer for parsing. 2175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Return true if the packet was processed succesfully. |packet| must be a 2185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // single, complete UDP packet (not a frame of a packet). This packet 2195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // might be null padded past the end of the payload, which will be correctly 2205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ignored. 2212a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool ProcessPacket(const QuicEncryptedPacket& packet); 2225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Pass a data packet that was revived from FEC data into the framer 2245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // for parsing. 2255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Return true if the packet was processed succesfully. |payload| must be 2265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the complete DECRYPTED payload of the revived packet. 2272a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool ProcessRevivedPacket(QuicPacketHeader* header, 2285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::StringPiece payload); 2295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2302385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch // Largest size in bytes of all stream frame fields without the payload. 2312385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch static size_t GetMinStreamFrameSize(QuicVersion version, 2322385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch QuicStreamId stream_id, 2337dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch QuicStreamOffset offset, 2342385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch bool last_frame_in_packet); 2352a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Size in bytes of all ack frame fields without the missing packets. 2362a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static size_t GetMinAckFrameSize(); 2372a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Size in bytes of all reset stream frame without the error details. 2382a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static size_t GetMinRstStreamFrameSize(); 2392a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Size in bytes of all connection close frame fields without the error 2402a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // details and the missing packets from the enclosed ack frame. 2412a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static size_t GetMinConnectionCloseFrameSize(); 2422a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Size in bytes of all GoAway frame fields without the reason phrase. 2432a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static size_t GetMinGoAwayFrameSize(); 24490dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) // The maximum number of nacks which can be transmitted in a single ack packet 24590dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) // without exceeding kMaxPacketSize. 246868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) static size_t GetMaxUnackedPackets(QuicPacketHeader header); 2477dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch // Size in bytes required to serialize the stream id. 2487dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch static size_t GetStreamIdSize(QuicStreamId stream_id); 2497dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch // Size in bytes required to serialize the stream offset. 2507dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch static size_t GetStreamOffsetSize(QuicStreamOffset offset); 2512a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Size in bytes required for a serialized version negotiation packet 2522385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch static size_t GetVersionNegotiationPacketSize(size_t number_versions); 2532385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch 2542385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch 2552385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch static bool CanTruncate(const QuicFrame& frame, size_t free_bytes); 2562a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 2572a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns the number of bytes added to the packet for the specified frame, 2582a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // and 0 if the frame doesn't fit. Includes the header size for the first 2592a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // frame. 2601e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) size_t GetSerializedFrameLength(const QuicFrame& frame, 2611e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) size_t free_bytes, 2621e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) bool first_frame, 2631e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) bool last_frame); 2642a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 2652a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns the associated data from the encrypted packet |encrypted| as a 2662a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // stringpiece. 2672a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static base::StringPiece GetAssociatedDataFromEncryptedPacket( 268868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) const QuicEncryptedPacket& encrypted, 269868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) QuicGuidLength guid_length, 270868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) bool includes_version, 271868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) QuicSequenceNumberLength sequence_number_length); 2722a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 2732a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns a SerializedPacket whose |packet| member is owned by the caller, 2742a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // and is populated with the fields in |header| and |frames|, or is NULL if 2752a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // the packet could not be created. 2762a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // TODO(ianswett): Used for testing only. 2772385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch SerializedPacket BuildUnsizedDataPacket(const QuicPacketHeader& header, 2782385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch const QuicFrames& frames); 2792a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 2802a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns a SerializedPacket whose |packet| member is owned by the caller, 2812a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // is created from the first |num_frames| frames, or is NULL if the packet 2822a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // could not be created. The packet must be of size |packet_size|. 2832385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch SerializedPacket BuildDataPacket(const QuicPacketHeader& header, 2842385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch const QuicFrames& frames, 2852385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch size_t packet_size); 2862a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 2872a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns a SerializedPacket whose |packet| member is owned by the caller, 2882a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // and is populated with the fields in |header| and |fec|, or is NULL if the 2892a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // packet could not be created. 2902385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch SerializedPacket BuildFecPacket(const QuicPacketHeader& header, 2912385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch const QuicFecData& fec); 2922a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 2932a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns a new public reset packet, owned by the caller. 2942385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch static QuicEncryptedPacket* BuildPublicResetPacket( 2952a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicPublicResetPacket& packet); 2962a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 2972385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch QuicEncryptedPacket* BuildVersionNegotiationPacket( 2982a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicPacketPublicHeader& header, 299558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdoch const QuicVersionVector& supported_versions); 3005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 301c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // SetDecrypter sets the primary decrypter, replacing any that already exists, 302c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // and takes ownership. If an alternative decrypter is in place then the 303c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // function DCHECKs. This is intended for cases where one knows that future 304c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // packets will be using the new decrypter and the previous decrypter is not 305c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // obsolete. 306c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) void SetDecrypter(QuicDecrypter* decrypter); 307c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 308c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // SetAlternativeDecrypter sets a decrypter that may be used to decrypt 309c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // future packets and takes ownership of it. If |latch_once_used| is true, 310c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // then the first time that the decrypter is successful it will replace the 311c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // primary decrypter. Otherwise both decrypters will remain active and the 312c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // primary decrypter will be the one last used. 313c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) void SetAlternativeDecrypter(QuicDecrypter* decrypter, 314c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) bool latch_once_used); 315c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 316c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) const QuicDecrypter* decrypter() const; 317c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) const QuicDecrypter* alternative_decrypter() const; 318c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 319c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Changes the encrypter used for level |level| to |encrypter|. The function 320c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // takes ownership of |encrypter|. 321c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) void SetEncrypter(EncryptionLevel level, QuicEncrypter* encrypter); 322c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) const QuicEncrypter* encrypter(EncryptionLevel level) const; 323c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 324b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) // SwapCryptersForTest exchanges the state of the crypters with |other|. To 325b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) // be used in tests only. 326b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) void SwapCryptersForTest(QuicFramer* other); 327b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) 3285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns a new encrypted packet, owned by the caller. 329c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) QuicEncryptedPacket* EncryptPacket(EncryptionLevel level, 330c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) QuicPacketSequenceNumber sequence_number, 3312a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicPacket& packet); 3325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the maximum length of plaintext that can be encrypted 3345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // to ciphertext no larger than |ciphertext_size|. 3355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t GetMaxPlaintextSize(size_t ciphertext_size); 3365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& detailed_error() { return detailed_error_; } 3385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 33990dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) // Read the full 8 byte guid from a packet header. 3402a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Return true on success, else false. 3412a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static bool ReadGuidFromPacket(const QuicEncryptedPacket& packet, 3422a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicGuid* guid); 3432a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 3445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 3452a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) friend class test::QuicFramerPeer; 3462a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 3472a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicPacketEntropyHash GetPacketEntropyHash( 3482a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicPacketHeader& header) const; 3492a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 3502a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool ProcessDataPacket(const QuicPacketPublicHeader& public_header, 3512a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicEncryptedPacket& packet); 3522a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 3532a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool ProcessPublicResetPacket(const QuicPacketPublicHeader& public_header); 3542a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 3552a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool ProcessVersionNegotiationPacket(QuicPacketPublicHeader* public_header); 3562a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 3575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool WritePacketHeader(const QuicPacketHeader& header, 3582a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicDataWriter* writer); 3592a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 3602a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool ProcessPublicHeader(QuicPacketPublicHeader* header); 3615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool ProcessPacketHeader(QuicPacketHeader* header, 3635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const QuicEncryptedPacket& packet); 3645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 365868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) bool ProcessPacketSequenceNumber( 366868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) QuicSequenceNumberLength sequence_number_length, 367868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) QuicPacketSequenceNumber* sequence_number); 3685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool ProcessFrameData(); 3692385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch bool ProcessStreamFrame(uint8 frame_type, QuicStreamFrame* frame); 3705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool ProcessAckFrame(QuicAckFrame* frame); 3712a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool ProcessReceivedInfo(ReceivedPacketInfo* received_info); 3722a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool ProcessSentInfo(SentPacketInfo* sent_info); 3732a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool ProcessQuicCongestionFeedbackFrame( 3742a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicCongestionFeedbackFrame* congestion_feedback); 375c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) bool ProcessRstStreamFrame(QuicRstStreamFrame* frame); 376c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) bool ProcessConnectionCloseFrame(QuicConnectionCloseFrame* frame); 377c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) bool ProcessGoAwayFrame(QuicGoAwayFrame* frame); 3785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 379868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) bool DecryptPayload(const QuicPacketHeader& header, 3802a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicEncryptedPacket& packet); 3812a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 3822a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns the full packet sequence number from the truncated 3832a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // wire format version and the last seen packet sequence number. 3842a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicPacketSequenceNumber CalculatePacketSequenceNumberFromWire( 385868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) QuicSequenceNumberLength sequence_number_length, 3862a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicPacketSequenceNumber packet_sequence_number) const; 3875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Computes the wire size in bytes of the payload of |frame|. 3892385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch size_t ComputeFrameLength(const QuicFrame& frame, bool last_frame_in_packet); 3902a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 3912a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static bool AppendPacketSequenceNumber( 392868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) QuicSequenceNumberLength sequence_number_length, 3932a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicPacketSequenceNumber packet_sequence_number, 3942a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicDataWriter* writer); 3955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3962385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch bool AppendTypeByte(const QuicFrame& frame, 3972385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch bool last_frame_in_packet, 3982385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch QuicDataWriter* writer); 3995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool AppendStreamFramePayload(const QuicStreamFrame& frame, 4002385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch bool last_frame_in_packet, 4012a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicDataWriter* builder); 4025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool AppendAckFramePayload(const QuicAckFrame& frame, 4032a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicDataWriter* builder); 4042a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool AppendQuicCongestionFeedbackFramePayload( 4052a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicCongestionFeedbackFrame& frame, 4065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) QuicDataWriter* builder); 4075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool AppendRstStreamFramePayload(const QuicRstStreamFrame& frame, 4082a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicDataWriter* builder); 4095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool AppendConnectionCloseFramePayload( 4105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const QuicConnectionCloseFrame& frame, 4115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) QuicDataWriter* builder); 4122a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool AppendGoAwayFramePayload(const QuicGoAwayFrame& frame, 4132a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicDataWriter* writer); 4145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool RaiseError(QuicErrorCode error); 4155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_error(QuicErrorCode error) { 4175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) error_ = error; 4185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 4195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_detailed_error(const char* error) { 4215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) detailed_error_ = error; 4225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 4235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string detailed_error_; 4255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<QuicDataReader> reader_; 4265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) QuicFramerVisitorInterface* visitor_; 4275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) QuicFecBuilderInterface* fec_builder_; 4282a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicReceivedEntropyHashCalculatorInterface* entropy_calculator_; 4295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) QuicErrorCode error_; 4302a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Updated by ProcessPacketHeader when it succeeds. 4312a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicPacketSequenceNumber last_sequence_number_; 432868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) // Updated by WritePacketHeader. 433868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) QuicGuid last_serialized_guid_; 4345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Buffer containing decrypted payload data during parsing. 4355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<QuicData> decrypted_; 4362a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Version of the protocol being used. 437558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdoch QuicVersion quic_version_; 4381e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) // This vector contains QUIC versions which we currently support. 4391e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) // This should be ordered such that the highest supported version is the first 4401e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) // element, with subsequent elements in descending order (versions can be 4411e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) // skipped as necessary). 4421e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) QuicVersionVector supported_versions_; 443c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Primary decrypter used to decrypt packets during parsing. 4445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<QuicDecrypter> decrypter_; 445c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Alternative decrypter that can also be used to decrypt packets. 446c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) scoped_ptr<QuicDecrypter> alternative_decrypter_; 447c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // alternative_decrypter_latch_is true if, when |alternative_decrypter_| 448c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // successfully decrypts a packet, we should install it as the only 449c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // decrypter. 450c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) bool alternative_decrypter_latch_; 451c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Encrypters used to encrypt packets via EncryptPacket(). 452c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) scoped_ptr<QuicEncrypter> encrypter_[NUM_ENCRYPTION_LEVELS]; 4532a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Tracks if the framer is being used by the entity that received the 4542a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // connection or the entity that initiated it. 4552a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool is_server_; 456c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // The time this frames was created. Time written to the wire will be 457c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // written as a delta from this value. 458c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) QuicTime creation_time_; 4595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(QuicFramer); 4615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 4625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace net 4645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // NET_QUIC_QUIC_FRAMER_H_ 466