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. 470f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles)const size_t kQuicDeltaTimeLargestObservedSize = 2; 481320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci// Size in bytes reserved for the number of received packets with timestamps. 491320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucciconst size_t kQuicNumTimestampsSize = 1; 502a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// Size in bytes reserved for the number of missing packets in ack frames. 51cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)const size_t kNumberOfNackRangesSize = 1; 52cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)// Maximum number of missing packet ranges that can fit within an ack frame. 53cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)const size_t kMaxNackRanges = 54cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) (1 << (kNumberOfNackRangesSize * 8)) - 1; 555d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)// Size in bytes reserved for the number of revived packets in ack frames. 565d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)const size_t kNumberOfRevivedPacketsSize = 1; 57cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)// Maximum number of revived packets that can fit within an ack frame. 58cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)const size_t kMaxRevivedPackets = 59cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) (1 << (kNumberOfRevivedPacketsSize * 8)) - 1; 602a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 612a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// This class receives callbacks from the framer when packets 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// are processed. 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class NET_EXPORT_PRIVATE QuicFramerVisitorInterface { 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~QuicFramerVisitorInterface() {} 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called if an error is detected in the QUIC protocol. 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnError(QuicFramer* framer) = 0; 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 702a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Called only when |is_server_| is true and the the framer gets a packet with 712a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // version flag true and the version on the packet doesn't match 722a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // |quic_version_|. The visitor should return true after it updates the 732a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // version of the |framer_| to |received_version| or false to stop processing 742a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // this packet. 75558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdoch virtual bool OnProtocolVersionMismatch(QuicVersion received_version) = 0; 762a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 772a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Called when a new packet has been received, before it 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // has been validated or processed. 792a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual void OnPacket() = 0; 802a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 812a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Called when a public reset packet has been parsed but has not yet 822a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // been validated. 832a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual void OnPublicResetPacket( 842a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicPublicResetPacket& packet) = 0; 852a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 862a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Called only when |is_server_| is false and a version negotiation packet has 872a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // been parsed. 882a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual void OnVersionNegotiationPacket( 892a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicVersionNegotiationPacket& packet) = 0; 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when a lost packet has been recovered via FEC, 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // before it has been processed. 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnRevivedPacket() = 0; 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 955d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Called when the public header has been parsed, but has not been 965d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // authenticated. If it returns false, framing for this packet will cease. 975d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) virtual bool OnUnauthenticatedPublicHeader( 985d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) const QuicPacketPublicHeader& header) = 0; 995d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 100f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // Called when the unauthenticated portion of the header has been parsed. 101f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // If OnUnauthenticatedHeader returns false, framing for this packet will 102f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // cease. 103f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) virtual bool OnUnauthenticatedHeader(const QuicPacketHeader& header) = 0; 104f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) 1055c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // Called when a packet has been decrypted. |level| is the encryption level 1065c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // of the packet. 1075c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu virtual void OnDecryptedPacket(EncryptionLevel level) = 0; 1085c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu 1092a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Called when the complete header of a packet had been parsed. 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If OnPacketHeader returns false, framing for this packet will cease. 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool OnPacketHeader(const QuicPacketHeader& header) = 0; 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when a data packet is parsed that is part of an FEC group. 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |payload| is the non-encrypted FEC protected payload of the packet. 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnFecProtectedPayload(base::StringPiece payload) = 0; 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when a StreamFrame has been parsed. 118c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual bool OnStreamFrame(const QuicStreamFrame& frame) = 0; 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 120c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Called when a AckFrame has been parsed. If OnAckFrame returns false, 121c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // the framer will stop parsing the current packet. 122c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual bool OnAckFrame(const QuicAckFrame& frame) = 0; 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1242a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Called when a CongestionFeedbackFrame has been parsed. 125c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual bool OnCongestionFeedbackFrame( 1262a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicCongestionFeedbackFrame& frame) = 0; 1272a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 128a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) // Called when a StopWaitingFrame has been parsed. 129a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) virtual bool OnStopWaitingFrame(const QuicStopWaitingFrame& frame) = 0; 130a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) 1310529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch // Called when a PingFrame has been parsed. 1320529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch virtual bool OnPingFrame(const QuicPingFrame& frame) = 0; 1330529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when a RstStreamFrame has been parsed. 135c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual bool OnRstStreamFrame(const QuicRstStreamFrame& frame) = 0; 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when a ConnectionCloseFrame has been parsed. 138c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual bool OnConnectionCloseFrame( 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const QuicConnectionCloseFrame& frame) = 0; 1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1412a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Called when a GoAwayFrame has been parsed. 142c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual bool OnGoAwayFrame(const QuicGoAwayFrame& frame) = 0; 1432a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1445d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Called when a WindowUpdateFrame has been parsed. 145a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) virtual bool OnWindowUpdateFrame(const QuicWindowUpdateFrame& frame) = 0; 1465d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1475d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Called when a BlockedFrame has been parsed. 148a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) virtual bool OnBlockedFrame(const QuicBlockedFrame& frame) = 0; 1495d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when FEC data has been parsed. 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnFecData(const QuicFecData& fec) = 0; 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when a packet has been completely processed. 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnPacketComplete() = 0; 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class NET_EXPORT_PRIVATE QuicFecBuilderInterface { 1585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 1595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~QuicFecBuilderInterface() {} 1605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when a data packet is constructed that is part of an FEC group. 1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |payload| is the non-encrypted FEC protected payload of the packet. 1635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnBuiltFecProtectedPayload(const QuicPacketHeader& header, 1645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::StringPiece payload) = 0; 1655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1672a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// This class calculates the received entropy of the ack packet being 1682a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// framed, should it get truncated. 1692a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class NET_EXPORT_PRIVATE QuicReceivedEntropyHashCalculatorInterface { 1702a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) public: 1712a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual ~QuicReceivedEntropyHashCalculatorInterface() {} 1722a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1732a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // When an ack frame gets truncated while being framed the received 1742a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // entropy of the ack frame needs to be calculated since the some of the 1752a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // missing packets are not added and the largest observed might be lowered. 1762a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // This should return the received entropy hash of the packets received up to 1772a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // and including |sequence_number|. 178558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdoch virtual QuicPacketEntropyHash EntropyHash( 1792a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicPacketSequenceNumber sequence_number) const = 0; 1802a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)}; 1812a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1822a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// Class for parsing and constructing QUIC packets. It has a 1835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// QuicFramerVisitorInterface that is called when packets are parsed. 1842a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// It also has a QuicFecBuilder that is called when packets are constructed 1855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// in order to generate FEC data for subsequently building FEC packets. 1865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class NET_EXPORT_PRIVATE QuicFramer { 1875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 188c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Constructs a new framer that installs a kNULL QuicEncrypter and 1891e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) // QuicDecrypter for level ENCRYPTION_NONE. |supported_versions| specifies the 1901e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) // list of supported QUIC versions. |quic_version_| is set to the maximum 1911e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) // version in |supported_versions|. 1921e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) QuicFramer(const QuicVersionVector& supported_versions, 193c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) QuicTime creation_time, 1942a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool is_server); 1955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~QuicFramer(); 1975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1982a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns true if |version| is a supported protocol version. 199558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdoch bool IsSupportedVersion(const QuicVersion version) const; 2002a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 2015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Set callbacks to be called from the framer. A visitor must be set, or 2025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // else the framer will likely crash. It is acceptable for the visitor 2035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // to do nothing. If this is called multiple times, only the last visitor 2045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // will be used. 2055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_visitor(QuicFramerVisitorInterface* visitor) { 2065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) visitor_ = visitor; 2075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 2085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Set a builder to be called from the framer when building FEC protected 2105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // packets. If this is called multiple times, only the last builder 2115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // will be used. The builder need not be set. 2125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_fec_builder(QuicFecBuilderInterface* builder) { 2135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) fec_builder_ = builder; 2145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 2155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2161e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) const QuicVersionVector& supported_versions() const { 2171e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) return supported_versions_; 2181e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) } 2191e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) 220558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdoch QuicVersion version() const { 2212a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) return quic_version_; 2222a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 2232a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 2244e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) void set_version(const QuicVersion version); 2252a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 226558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdoch // Does not DCHECK for supported version. Used by tests to set unsupported 227558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdoch // version to trigger version negotiation. 228558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdoch void set_version_for_tests(const QuicVersion version) { 229558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdoch quic_version_ = version; 230558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdoch } 231558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdoch 2322a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Set entropy calculator to be called from the framer when it needs the 2332a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // entropy of a truncated ack frame. An entropy calculator must be set or else 2342a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // the framer will likely crash. If this is called multiple times, only the 235558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdoch // last calculator will be used. 236558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdoch void set_received_entropy_calculator( 2372a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicReceivedEntropyHashCalculatorInterface* entropy_calculator) { 2382a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) entropy_calculator_ = entropy_calculator; 2392a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 2402a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 2415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) QuicErrorCode error() const { 2425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return error_; 2435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 2445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Pass a UDP packet into the framer for parsing. 2465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Return true if the packet was processed succesfully. |packet| must be a 2475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // single, complete UDP packet (not a frame of a packet). This packet 2485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // might be null padded past the end of the payload, which will be correctly 2495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ignored. 2502a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool ProcessPacket(const QuicEncryptedPacket& packet); 2515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Pass a data packet that was revived from FEC data into the framer 2535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // for parsing. 2545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Return true if the packet was processed succesfully. |payload| must be 2555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the complete DECRYPTED payload of the revived packet. 2562a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool ProcessRevivedPacket(QuicPacketHeader* header, 2575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::StringPiece payload); 2585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2592385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch // Largest size in bytes of all stream frame fields without the payload. 2605f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles) static size_t GetMinStreamFrameSize(QuicStreamId stream_id, 2617dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch QuicStreamOffset offset, 262c5cede9ae108bb15f6b7a8aea21c7e1fefa2834cBen Murdoch bool last_frame_in_packet, 263c5cede9ae108bb15f6b7a8aea21c7e1fefa2834cBen Murdoch InFecGroup is_in_fec_group); 2642a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Size in bytes of all ack frame fields without the missing packets. 2650f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) static size_t GetMinAckFrameSize( 2660f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) QuicSequenceNumberLength sequence_number_length, 2670f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) QuicSequenceNumberLength largest_observed_length); 268a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) // Size in bytes of a stop waiting frame. 269a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) static size_t GetStopWaitingFrameSize( 270a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) QuicSequenceNumberLength sequence_number_length); 2712a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Size in bytes of all reset stream frame without the error details. 2725f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles) static size_t GetMinRstStreamFrameSize(); 2732a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Size in bytes of all connection close frame fields without the error 2742a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // details and the missing packets from the enclosed ack frame. 2752a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static size_t GetMinConnectionCloseFrameSize(); 2762a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Size in bytes of all GoAway frame fields without the reason phrase. 2772a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static size_t GetMinGoAwayFrameSize(); 2785d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Size in bytes of all WindowUpdate frame fields. 2795d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) static size_t GetWindowUpdateFrameSize(); 2805d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Size in bytes of all Blocked frame fields. 2815d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) static size_t GetBlockedFrameSize(); 2827dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch // Size in bytes required to serialize the stream id. 2837dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch static size_t GetStreamIdSize(QuicStreamId stream_id); 2847dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch // Size in bytes required to serialize the stream offset. 2857dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch static size_t GetStreamOffsetSize(QuicStreamOffset offset); 2862a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Size in bytes required for a serialized version negotiation packet 2872385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch static size_t GetVersionNegotiationPacketSize(size_t number_versions); 2882385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch 2892a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns the number of bytes added to the packet for the specified frame, 2902a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // and 0 if the frame doesn't fit. Includes the header size for the first 2912a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // frame. 2920f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) size_t GetSerializedFrameLength( 2930f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) const QuicFrame& frame, 2940f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) size_t free_bytes, 295c5cede9ae108bb15f6b7a8aea21c7e1fefa2834cBen Murdoch bool first_frame_in_packet, 296c5cede9ae108bb15f6b7a8aea21c7e1fefa2834cBen Murdoch bool last_frame_in_packet, 297c5cede9ae108bb15f6b7a8aea21c7e1fefa2834cBen Murdoch InFecGroup is_in_fec_group, 2980f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) QuicSequenceNumberLength sequence_number_length); 2992a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 3002a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns the associated data from the encrypted packet |encrypted| as a 3012a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // stringpiece. 3022a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static base::StringPiece GetAssociatedDataFromEncryptedPacket( 303868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) const QuicEncryptedPacket& encrypted, 304a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) QuicConnectionIdLength connection_id_length, 305868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) bool includes_version, 306868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) QuicSequenceNumberLength sequence_number_length); 3072a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 3082a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns a SerializedPacket whose |packet| member is owned by the caller, 3092a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // is created from the first |num_frames| frames, or is NULL if the packet 3102a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // could not be created. The packet must be of size |packet_size|. 3112385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch SerializedPacket BuildDataPacket(const QuicPacketHeader& header, 3122385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch const QuicFrames& frames, 3132385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch size_t packet_size); 3142a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 3152a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns a SerializedPacket whose |packet| member is owned by the caller, 3162a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // and is populated with the fields in |header| and |fec|, or is NULL if the 3172a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // packet could not be created. 3182385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch SerializedPacket BuildFecPacket(const QuicPacketHeader& header, 3192385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch const QuicFecData& fec); 3202a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 3212a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns a new public reset packet, owned by the caller. 3222385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch static QuicEncryptedPacket* BuildPublicResetPacket( 3232a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicPublicResetPacket& packet); 3242a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 3252385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch QuicEncryptedPacket* BuildVersionNegotiationPacket( 3262a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicPacketPublicHeader& header, 327558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdoch const QuicVersionVector& supported_versions); 3285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 329c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // SetDecrypter sets the primary decrypter, replacing any that already exists, 330c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // and takes ownership. If an alternative decrypter is in place then the 331c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // function DCHECKs. This is intended for cases where one knows that future 3325c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // packets will be using the new decrypter and the previous decrypter is now 3335c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // obsolete. |level| indicates the encryption level of the new decrypter. 3345c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu void SetDecrypter(QuicDecrypter* decrypter, EncryptionLevel level); 335c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 336c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // SetAlternativeDecrypter sets a decrypter that may be used to decrypt 3375c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // future packets and takes ownership of it. |level| indicates the encryption 3385c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // level of the decrypter. If |latch_once_used| is true, then the first time 3395c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // that the decrypter is successful it will replace the primary decrypter. 3405c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // Otherwise both decrypters will remain active and the primary decrypter 3415c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // will be the one last used. 342c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) void SetAlternativeDecrypter(QuicDecrypter* decrypter, 3435c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu EncryptionLevel level, 344c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) bool latch_once_used); 345c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 346c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) const QuicDecrypter* decrypter() const; 347c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) const QuicDecrypter* alternative_decrypter() const; 348c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 349c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Changes the encrypter used for level |level| to |encrypter|. The function 350c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // takes ownership of |encrypter|. 351c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) void SetEncrypter(EncryptionLevel level, QuicEncrypter* encrypter); 352c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) const QuicEncrypter* encrypter(EncryptionLevel level) const; 353c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 3545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns a new encrypted packet, owned by the caller. 355c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) QuicEncryptedPacket* EncryptPacket(EncryptionLevel level, 356c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) QuicPacketSequenceNumber sequence_number, 3572a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicPacket& packet); 3585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the maximum length of plaintext that can be encrypted 3605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // to ciphertext no larger than |ciphertext_size|. 3615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t GetMaxPlaintextSize(size_t ciphertext_size); 3625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& detailed_error() { return detailed_error_; } 3645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3650f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) // The minimum sequence number length required to represent |sequence_number|. 3660f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) static QuicSequenceNumberLength GetMinSequenceNumberLength( 3670f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) QuicPacketSequenceNumber sequence_number); 3680f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) 3695d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) void SetSupportedVersions(const QuicVersionVector& versions) { 3705d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) supported_versions_ = versions; 3715d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) quic_version_ = versions[0]; 3725d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) } 3735d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 374e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch void set_validate_flags(bool value) { validate_flags_ = value; } 375e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch 376f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) bool is_server() const { return is_server_; } 377f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) 3785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 3792a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) friend class test::QuicFramerPeer; 3802a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 3810f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) typedef std::map<QuicPacketSequenceNumber, uint8> NackRangeMap; 3820f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) 383f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) struct AckFrameInfo { 3840f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) AckFrameInfo(); 385f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) ~AckFrameInfo(); 3860f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) 3870f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) // The maximum delta between ranges. 3880f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) QuicPacketSequenceNumber max_delta; 3890f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) // Nack ranges starting with start sequence numbers and lengths. 3900f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) NackRangeMap nack_ranges; 3910f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) }; 3920f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) 3932a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicPacketEntropyHash GetPacketEntropyHash( 3942a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicPacketHeader& header) const; 3952a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 3962a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool ProcessDataPacket(const QuicPacketPublicHeader& public_header, 3972a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicEncryptedPacket& packet); 3982a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 3992a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool ProcessPublicResetPacket(const QuicPacketPublicHeader& public_header); 4002a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 4012a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool ProcessVersionNegotiationPacket(QuicPacketPublicHeader* public_header); 4022a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 4032a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool ProcessPublicHeader(QuicPacketPublicHeader* header); 4045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool ProcessPacketHeader(QuicPacketHeader* header, 4065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const QuicEncryptedPacket& packet); 4075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 408868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) bool ProcessPacketSequenceNumber( 409868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) QuicSequenceNumberLength sequence_number_length, 410868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) QuicPacketSequenceNumber* sequence_number); 4110f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) bool ProcessFrameData(const QuicPacketHeader& header); 4122385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch bool ProcessStreamFrame(uint8 frame_type, QuicStreamFrame* frame); 4135f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles) bool ProcessAckFrame(uint8 frame_type, QuicAckFrame* frame); 4141320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci bool ProcessTimestampsInAckFrame(QuicAckFrame* frame); 415a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) bool ProcessStopWaitingFrame(const QuicPacketHeader& public_header, 416a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) QuicStopWaitingFrame* stop_waiting); 4171320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci bool ProcessCongestionFeedbackFrame( 4182a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicCongestionFeedbackFrame* congestion_feedback); 419c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) bool ProcessRstStreamFrame(QuicRstStreamFrame* frame); 420c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) bool ProcessConnectionCloseFrame(QuicConnectionCloseFrame* frame); 421c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) bool ProcessGoAwayFrame(QuicGoAwayFrame* frame); 4225d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) bool ProcessWindowUpdateFrame(QuicWindowUpdateFrame* frame); 4235d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) bool ProcessBlockedFrame(QuicBlockedFrame* frame); 4245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 425868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) bool DecryptPayload(const QuicPacketHeader& header, 4262a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicEncryptedPacket& packet); 4272a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 4282a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns the full packet sequence number from the truncated 4292a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // wire format version and the last seen packet sequence number. 4302a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicPacketSequenceNumber CalculatePacketSequenceNumberFromWire( 431868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) QuicSequenceNumberLength sequence_number_length, 4322a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicPacketSequenceNumber packet_sequence_number) const; 4335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4341320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci // Returns the QuicTime::Delta corresponding to the time from when the framer 4351320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci // was created. 4361320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci const QuicTime::Delta CalculateTimestampFromWire(uint32 time_delta_us); 4371320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci 4380f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) // Computes the wire size in bytes of the |ack| frame, assuming no truncation. 4390f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) size_t GetAckFrameSize(const QuicAckFrame& ack, 4400f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) QuicSequenceNumberLength sequence_number_length); 4410f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) 4425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Computes the wire size in bytes of the payload of |frame|. 4430f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) size_t ComputeFrameLength(const QuicFrame& frame, 4440f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) bool last_frame_in_packet, 445c5cede9ae108bb15f6b7a8aea21c7e1fefa2834cBen Murdoch InFecGroup is_in_fec_group, 4460f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) QuicSequenceNumberLength sequence_number_length); 4472a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 4482a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static bool AppendPacketSequenceNumber( 449868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) QuicSequenceNumberLength sequence_number_length, 4502a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicPacketSequenceNumber packet_sequence_number, 4512a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicDataWriter* writer); 4525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4530f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) static uint8 GetSequenceNumberFlags( 4540f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) QuicSequenceNumberLength sequence_number_length); 4550f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) 4560f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) static AckFrameInfo GetAckFrameInfo(const QuicAckFrame& frame); 4570f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) 4585d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // The Append* methods attempt to write the provided header or frame using the 4595d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // |writer|, and return true if successful. 4600f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) bool AppendPacketHeader(const QuicPacketHeader& header, 4610f1bc08d4cfcc34181b0b5cbf065c40f687bf740Torne (Richard Coles) QuicDataWriter* writer); 4622385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch bool AppendTypeByte(const QuicFrame& frame, 4632385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch bool last_frame_in_packet, 4642385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch QuicDataWriter* writer); 4655d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) bool AppendStreamFrame(const QuicStreamFrame& frame, 4665d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) bool last_frame_in_packet, 4675d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) QuicDataWriter* builder); 4685d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) bool AppendAckFrameAndTypeByte(const QuicPacketHeader& header, 4695d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) const QuicAckFrame& frame, 4705d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) QuicDataWriter* builder); 471a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) bool AppendCongestionFeedbackFrame(const QuicCongestionFeedbackFrame& frame, 472a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) QuicDataWriter* builder); 4731320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci bool AppendTimestampToAckFrame(const QuicAckFrame& frame, 4741320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci QuicDataWriter* builder); 475a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) bool AppendStopWaitingFrame(const QuicPacketHeader& header, 476a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) const QuicStopWaitingFrame& frame, 477a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) QuicDataWriter* builder); 4785d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) bool AppendRstStreamFrame(const QuicRstStreamFrame& frame, 4795d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) QuicDataWriter* builder); 4805d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) bool AppendConnectionCloseFrame(const QuicConnectionCloseFrame& frame, 4815d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) QuicDataWriter* builder); 4825d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) bool AppendGoAwayFrame(const QuicGoAwayFrame& frame, QuicDataWriter* writer); 4835d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) bool AppendWindowUpdateFrame(const QuicWindowUpdateFrame& frame, 4845d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) QuicDataWriter* writer); 4855d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) bool AppendBlockedFrame(const QuicBlockedFrame& frame, 4865d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) QuicDataWriter* writer); 4875d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 4885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool RaiseError(QuicErrorCode error); 4895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_error(QuicErrorCode error) { 4915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) error_ = error; 4925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 4935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_detailed_error(const char* error) { 4955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) detailed_error_ = error; 4965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 4975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string detailed_error_; 4995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<QuicDataReader> reader_; 5005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) QuicFramerVisitorInterface* visitor_; 5015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) QuicFecBuilderInterface* fec_builder_; 5022a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicReceivedEntropyHashCalculatorInterface* entropy_calculator_; 5035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) QuicErrorCode error_; 5042a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Updated by ProcessPacketHeader when it succeeds. 5052a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicPacketSequenceNumber last_sequence_number_; 506868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) // Updated by WritePacketHeader. 507a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) QuicConnectionId last_serialized_connection_id_; 5085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Buffer containing decrypted payload data during parsing. 5095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<QuicData> decrypted_; 5102a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Version of the protocol being used. 511558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdoch QuicVersion quic_version_; 5121e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) // This vector contains QUIC versions which we currently support. 5131e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) // This should be ordered such that the highest supported version is the first 5141e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) // element, with subsequent elements in descending order (versions can be 5151e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) // skipped as necessary). 5161e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) QuicVersionVector supported_versions_; 517c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Primary decrypter used to decrypt packets during parsing. 5185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<QuicDecrypter> decrypter_; 519c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Alternative decrypter that can also be used to decrypt packets. 520c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) scoped_ptr<QuicDecrypter> alternative_decrypter_; 5215c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // The encryption level of |decrypter_|. 5225c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu EncryptionLevel decrypter_level_; 5235c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // The encryption level of |alternative_decrypter_|. 5245c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu EncryptionLevel alternative_decrypter_level_; 5255c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // |alternative_decrypter_latch_| is true if, when |alternative_decrypter_| 526c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // successfully decrypts a packet, we should install it as the only 527c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // decrypter. 528c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) bool alternative_decrypter_latch_; 529c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Encrypters used to encrypt packets via EncryptPacket(). 530c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) scoped_ptr<QuicEncrypter> encrypter_[NUM_ENCRYPTION_LEVELS]; 5312a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Tracks if the framer is being used by the entity that received the 5322a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // connection or the entity that initiated it. 5332a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool is_server_; 534e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch // If false, skip validation that the public flags are set to legal values. 535e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch bool validate_flags_; 5366e8cce623b6e4fe0c9e4af605d675dd9d0338c38Torne (Richard Coles) // The time this framer was created. Time written to the wire will be 537c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // written as a delta from this value. 538c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) QuicTime creation_time_; 5391320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci // The time delta computed for the last timestamp frame. This is relative to 5401320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci // the creation_time. 5411320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci QuicTime::Delta last_timestamp_; 5425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(QuicFramer); 5445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 5455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace net 5475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // NET_QUIC_QUIC_FRAMER_H_ 549