quic_framer.h revision b2df76ea8fec9e32f6f3718986dba0d95315b29c
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) 362a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// Number of bytes reserved for stream id 372a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)const size_t kQuicStreamIdSize = 4; 382a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// Number of bytes reserved for fin flag in stream frame. 392a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)const size_t kQuicStreamFinSize = 1; 402a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// Number of bytes reserved for byte offset in stream frame. 412a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)const size_t kQuicStreamOffsetSize = 8; 422a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// Number of bytes reserved to store payload length in stream frame. 432a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)const size_t kQuicStreamPayloadLengthSize = 2; 442a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 452a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// Size in bytes of the entropy hash sent in ack frames. 462a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)const size_t kQuicEntropyHashSize = 1; 47c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// Size in bytes reserved for the delta time of the largest observed 48c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// sequence number in ack frames. 49c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)const size_t kQuicDeltaTimeLargestObservedSize = 4; 502a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// Size in bytes reserved for the number of missing packets in ack frames. 512a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)const size_t kNumberOfMissingPacketsSize = 1; 522a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 532a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// This class receives callbacks from the framer when packets 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// are processed. 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class NET_EXPORT_PRIVATE QuicFramerVisitorInterface { 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~QuicFramerVisitorInterface() {} 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called if an error is detected in the QUIC protocol. 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnError(QuicFramer* framer) = 0; 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 622a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Called only when |is_server_| is true and the the framer gets a packet with 632a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // version flag true and the version on the packet doesn't match 642a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // |quic_version_|. The visitor should return true after it updates the 652a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // version of the |framer_| to |received_version| or false to stop processing 662a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // this packet. 67b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) virtual bool OnProtocolVersionMismatch(QuicTag received_version) = 0; 682a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 692a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Called when a new packet has been received, before it 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // has been validated or processed. 712a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual void OnPacket() = 0; 722a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 732a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Called when a public reset packet has been parsed but has not yet 742a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // been validated. 752a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual void OnPublicResetPacket( 762a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicPublicResetPacket& packet) = 0; 772a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 782a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Called only when |is_server_| is false and a version negotiation packet has 792a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // been parsed. 802a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual void OnVersionNegotiationPacket( 812a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicVersionNegotiationPacket& packet) = 0; 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when a lost packet has been recovered via FEC, 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // before it has been processed. 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnRevivedPacket() = 0; 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 872a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Called when the complete header of a packet had been parsed. 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If OnPacketHeader returns false, framing for this packet will cease. 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool OnPacketHeader(const QuicPacketHeader& header) = 0; 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when a data packet is parsed that is part of an FEC group. 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |payload| is the non-encrypted FEC protected payload of the packet. 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnFecProtectedPayload(base::StringPiece payload) = 0; 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when a StreamFrame has been parsed. 96c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual bool OnStreamFrame(const QuicStreamFrame& frame) = 0; 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 98c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Called when a AckFrame has been parsed. If OnAckFrame returns false, 99c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // the framer will stop parsing the current packet. 100c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual bool OnAckFrame(const QuicAckFrame& frame) = 0; 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1022a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Called when a CongestionFeedbackFrame has been parsed. 103c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual bool OnCongestionFeedbackFrame( 1042a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicCongestionFeedbackFrame& frame) = 0; 1052a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when a RstStreamFrame has been parsed. 107c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual bool OnRstStreamFrame(const QuicRstStreamFrame& frame) = 0; 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when a ConnectionCloseFrame has been parsed. 110c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual bool OnConnectionCloseFrame( 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const QuicConnectionCloseFrame& frame) = 0; 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1132a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Called when a GoAwayFrame has been parsed. 114c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual bool OnGoAwayFrame(const QuicGoAwayFrame& frame) = 0; 1152a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when FEC data has been parsed. 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnFecData(const QuicFecData& fec) = 0; 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when a packet has been completely processed. 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnPacketComplete() = 0; 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class NET_EXPORT_PRIVATE QuicFecBuilderInterface { 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~QuicFecBuilderInterface() {} 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when a data packet is constructed that is part of an FEC group. 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |payload| is the non-encrypted FEC protected payload of the packet. 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnBuiltFecProtectedPayload(const QuicPacketHeader& header, 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::StringPiece payload) = 0; 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1332a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// This class calculates the received entropy of the ack packet being 1342a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// framed, should it get truncated. 1352a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class NET_EXPORT_PRIVATE QuicReceivedEntropyHashCalculatorInterface { 1362a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) public: 1372a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual ~QuicReceivedEntropyHashCalculatorInterface() {} 1382a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1392a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // When an ack frame gets truncated while being framed the received 1402a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // entropy of the ack frame needs to be calculated since the some of the 1412a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // missing packets are not added and the largest observed might be lowered. 1422a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // This should return the received entropy hash of the packets received up to 1432a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // and including |sequence_number|. 1442a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual QuicPacketEntropyHash ReceivedEntropyHash( 1452a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicPacketSequenceNumber sequence_number) const = 0; 1462a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)}; 1472a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1482a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// Class for parsing and constructing QUIC packets. It has a 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// QuicFramerVisitorInterface that is called when packets are parsed. 1502a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// It also has a QuicFecBuilder that is called when packets are constructed 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// in order to generate FEC data for subsequently building FEC packets. 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class NET_EXPORT_PRIVATE QuicFramer { 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 154c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Constructs a new framer that installs a kNULL QuicEncrypter and 155c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // QuicDecrypter for level ENCRYPTION_NONE. 156b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) QuicFramer(QuicTag quic_version, 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. 163b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) bool IsSupportedVersion(QuicTag version); 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) 187b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) QuicTag version() const { 1882a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) return quic_version_; 1892a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 1902a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 191b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) void set_version(QuicTag version) { 1922a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) DCHECK(IsSupportedVersion(version)); 1932a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) quic_version_ = version; 1942a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 1952a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1962a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Set entropy calculator to be called from the framer when it needs the 1972a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // entropy of a truncated ack frame. An entropy calculator must be set or else 1982a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // the framer will likely crash. If this is called multiple times, only the 1992a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // last visitor will be used. 2002a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) void set_entropy_calculator( 2012a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicReceivedEntropyHashCalculatorInterface* entropy_calculator) { 2022a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) entropy_calculator_ = entropy_calculator; 2032a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 2042a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 2055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) QuicErrorCode error() const { 2065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return error_; 2075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 2085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Pass a UDP packet into the framer for parsing. 2105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Return true if the packet was processed succesfully. |packet| must be a 2115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // single, complete UDP packet (not a frame of a packet). This packet 2125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // might be null padded past the end of the payload, which will be correctly 2135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ignored. 2142a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool ProcessPacket(const QuicEncryptedPacket& packet); 2155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Pass a data packet that was revived from FEC data into the framer 2175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // for parsing. 2185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Return true if the packet was processed succesfully. |payload| must be 2195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the complete DECRYPTED payload of the revived packet. 2202a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool ProcessRevivedPacket(QuicPacketHeader* header, 2215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::StringPiece payload); 2225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2232a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Size in bytes of all stream frame fields without the payload. 2242a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static size_t GetMinStreamFrameSize(); 2252a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Size in bytes of all ack frame fields without the missing packets. 2262a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static size_t GetMinAckFrameSize(); 2272a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Size in bytes of all reset stream frame without the error details. 2282a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static size_t GetMinRstStreamFrameSize(); 2292a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Size in bytes of all connection close frame fields without the error 2302a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // details and the missing packets from the enclosed ack frame. 2312a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static size_t GetMinConnectionCloseFrameSize(); 2322a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Size in bytes of all GoAway frame fields without the reason phrase. 2332a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static size_t GetMinGoAwayFrameSize(); 2342a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Size in bytes required for a serialized version negotiation packet 2352a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) size_t GetVersionNegotiationPacketSize(size_t number_versions); 2362a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 2372a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns the number of bytes added to the packet for the specified frame, 2382a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // and 0 if the frame doesn't fit. Includes the header size for the first 2392a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // frame. 2402a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) size_t GetSerializedFrameLength( 2412a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicFrame& frame, size_t free_bytes, bool first_frame); 2422a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 2432a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns the associated data from the encrypted packet |encrypted| as a 2442a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // stringpiece. 2452a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static base::StringPiece GetAssociatedDataFromEncryptedPacket( 2462a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicEncryptedPacket& encrypted, bool includes_version); 2472a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 2482a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns a SerializedPacket whose |packet| member is owned by the caller, 2492a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // and is populated with the fields in |header| and |frames|, or is NULL if 2502a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // the packet could not be created. 2512a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // TODO(ianswett): Used for testing only. 2522a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) SerializedPacket ConstructFrameDataPacket(const QuicPacketHeader& header, 2532a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicFrames& frames); 2542a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 2552a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns a SerializedPacket whose |packet| member is owned by the caller, 2562a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // is created from the first |num_frames| frames, or is NULL if the packet 2572a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // could not be created. The packet must be of size |packet_size|. 2582a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) SerializedPacket ConstructFrameDataPacket(const QuicPacketHeader& header, 2592a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicFrames& frames, 2602a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) size_t packet_size); 2612a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 2622a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns a SerializedPacket whose |packet| member is owned by the caller, 2632a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // and is populated with the fields in |header| and |fec|, or is NULL if the 2642a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // packet could not be created. 2652a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) SerializedPacket ConstructFecPacket(const QuicPacketHeader& header, 2662a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicFecData& fec); 2672a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 2682a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns a new public reset packet, owned by the caller. 2692a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static QuicEncryptedPacket* ConstructPublicResetPacket( 2702a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicPublicResetPacket& packet); 2712a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 2722a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicEncryptedPacket* ConstructVersionNegotiationPacket( 2732a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicPacketPublicHeader& header, 274b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) const QuicTagVector& supported_versions); 2755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 276c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // SetDecrypter sets the primary decrypter, replacing any that already exists, 277c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // and takes ownership. If an alternative decrypter is in place then the 278c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // function DCHECKs. This is intended for cases where one knows that future 279c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // packets will be using the new decrypter and the previous decrypter is not 280c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // obsolete. 281c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) void SetDecrypter(QuicDecrypter* decrypter); 282c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 283c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // SetAlternativeDecrypter sets a decrypter that may be used to decrypt 284c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // future packets and takes ownership of it. If |latch_once_used| is true, 285c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // then the first time that the decrypter is successful it will replace the 286c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // primary decrypter. Otherwise both decrypters will remain active and the 287c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // primary decrypter will be the one last used. 288c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) void SetAlternativeDecrypter(QuicDecrypter* decrypter, 289c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) bool latch_once_used); 290c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 291c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) const QuicDecrypter* decrypter() const; 292c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) const QuicDecrypter* alternative_decrypter() const; 293c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 294c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Changes the encrypter used for level |level| to |encrypter|. The function 295c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // takes ownership of |encrypter|. 296c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) void SetEncrypter(EncryptionLevel level, QuicEncrypter* encrypter); 297c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) const QuicEncrypter* encrypter(EncryptionLevel level) const; 298c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 299b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) // SwapCryptersForTest exchanges the state of the crypters with |other|. To 300b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) // be used in tests only. 301b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) void SwapCryptersForTest(QuicFramer* other); 302b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) 3035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns a new encrypted packet, owned by the caller. 304c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) QuicEncryptedPacket* EncryptPacket(EncryptionLevel level, 305c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) QuicPacketSequenceNumber sequence_number, 3062a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicPacket& packet); 3075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the maximum length of plaintext that can be encrypted 3095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // to ciphertext no larger than |ciphertext_size|. 3105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t GetMaxPlaintextSize(size_t ciphertext_size); 3115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& detailed_error() { return detailed_error_; } 3135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3142a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Read the guid from a packet header. 3152a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Return true on success, else false. 3162a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static bool ReadGuidFromPacket(const QuicEncryptedPacket& packet, 3172a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicGuid* guid); 3182a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 3195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 3202a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) friend class test::QuicFramerPeer; 3212a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 3222a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicPacketEntropyHash GetPacketEntropyHash( 3232a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicPacketHeader& header) const; 3242a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 3252a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool ProcessDataPacket(const QuicPacketPublicHeader& public_header, 3262a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicEncryptedPacket& packet); 3272a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 3282a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool ProcessPublicResetPacket(const QuicPacketPublicHeader& public_header); 3292a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 3302a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool ProcessVersionNegotiationPacket(QuicPacketPublicHeader* public_header); 3312a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 3325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool WritePacketHeader(const QuicPacketHeader& header, 3332a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicDataWriter* writer); 3342a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 3352a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool ProcessPublicHeader(QuicPacketPublicHeader* header); 3365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool ProcessPacketHeader(QuicPacketHeader* header, 3385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const QuicEncryptedPacket& packet); 3395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3402a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool ProcessPacketSequenceNumber(QuicPacketSequenceNumber* sequence_number); 3415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool ProcessFrameData(); 342c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) bool ProcessStreamFrame(QuicStreamFrame* frame); 3435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool ProcessAckFrame(QuicAckFrame* frame); 3442a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool ProcessReceivedInfo(ReceivedPacketInfo* received_info); 3452a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool ProcessSentInfo(SentPacketInfo* sent_info); 3462a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool ProcessQuicCongestionFeedbackFrame( 3472a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicCongestionFeedbackFrame* congestion_feedback); 348c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) bool ProcessRstStreamFrame(QuicRstStreamFrame* frame); 349c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) bool ProcessConnectionCloseFrame(QuicConnectionCloseFrame* frame); 350c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) bool ProcessGoAwayFrame(QuicGoAwayFrame* frame); 3515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3522a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool DecryptPayload(QuicPacketSequenceNumber packet_sequence_number, 3532a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool version_flag, 3542a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicEncryptedPacket& packet); 3552a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 3562a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns the full packet sequence number from the truncated 3572a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // wire format version and the last seen packet sequence number. 3582a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicPacketSequenceNumber CalculatePacketSequenceNumberFromWire( 3592a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicPacketSequenceNumber packet_sequence_number) const; 3605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Computes the wire size in bytes of the payload of |frame|. 3622a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) size_t ComputeFrameLength(const QuicFrame& frame); 3632a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 3642a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static bool AppendPacketSequenceNumber( 3652a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicPacketSequenceNumber packet_sequence_number, 3662a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicDataWriter* writer); 3675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool AppendStreamFramePayload(const QuicStreamFrame& frame, 3692a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicDataWriter* builder); 3705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool AppendAckFramePayload(const QuicAckFrame& frame, 3712a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicDataWriter* builder); 3722a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool AppendQuicCongestionFeedbackFramePayload( 3732a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const QuicCongestionFeedbackFrame& frame, 3745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) QuicDataWriter* builder); 3755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool AppendRstStreamFramePayload(const QuicRstStreamFrame& frame, 3762a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicDataWriter* builder); 3775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool AppendConnectionCloseFramePayload( 3785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const QuicConnectionCloseFrame& frame, 3795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) QuicDataWriter* builder); 3802a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool AppendGoAwayFramePayload(const QuicGoAwayFrame& frame, 3812a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicDataWriter* writer); 3825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool RaiseError(QuicErrorCode error); 3835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_error(QuicErrorCode error) { 3855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) error_ = error; 3865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_detailed_error(const char* error) { 3895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) detailed_error_ = error; 3905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 3915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string detailed_error_; 3935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<QuicDataReader> reader_; 3945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) QuicFramerVisitorInterface* visitor_; 3955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) QuicFecBuilderInterface* fec_builder_; 3962a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicReceivedEntropyHashCalculatorInterface* entropy_calculator_; 3975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) QuicErrorCode error_; 3982a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Updated by ProcessPacketHeader when it succeeds. 3992a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) QuicPacketSequenceNumber last_sequence_number_; 4005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Buffer containing decrypted payload data during parsing. 4015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<QuicData> decrypted_; 4022a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Version of the protocol being used. 403b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) QuicTag quic_version_; 404c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Primary decrypter used to decrypt packets during parsing. 4055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<QuicDecrypter> decrypter_; 406c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Alternative decrypter that can also be used to decrypt packets. 407c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) scoped_ptr<QuicDecrypter> alternative_decrypter_; 408c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // alternative_decrypter_latch_is true if, when |alternative_decrypter_| 409c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // successfully decrypts a packet, we should install it as the only 410c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // decrypter. 411c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) bool alternative_decrypter_latch_; 412c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Encrypters used to encrypt packets via EncryptPacket(). 413c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) scoped_ptr<QuicEncrypter> encrypter_[NUM_ENCRYPTION_LEVELS]; 4142a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Tracks if the framer is being used by the entity that received the 4152a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // connection or the entity that initiated it. 4162a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool is_server_; 417c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // The time this frames was created. Time written to the wire will be 418c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // written as a delta from this value. 419c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) QuicTime creation_time_; 4205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(QuicFramer); 4225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 4235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace net 4255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // NET_QUIC_QUIC_FRAMER_H_ 427