#include <TeChunkedParser.h>

Inheritance diagram for Http::One::TeChunkedParser:
Collaboration diagram for Http::One::TeChunkedParser:

Public Types

typedef SBuf::size_type size_type
 

Public Member Functions

 TeChunkedParser ()
 
virtual ~TeChunkedParser ()
 
void setPayloadBuffer (MemBuf *parsedContent)
 set the buffer to be used to store decoded chunk data More...
 
bool needsMoreSpace () const
 
virtual void clear ()
 
virtual bool parse (const SBuf &)
 
virtual Parser::size_type firstLineSize () const
 size in bytes of the first line including CRLF terminator More...
 
bool needsMoreData () const
 
size_type headerBlockSize () const
 
size_type messageHeaderSize () const
 
SBuf mimeHeader () const
 buffer containing HTTP mime headers, excluding message first-line. More...
 
const AnyP::ProtocolVersionmessageProtocol () const
 the protocol label for this message More...
 
char * getHeaderField (const char *name)
 
const SBufremaining () const
 the remaining unprocessed section of buffer More...
 

Static Public Member Functions

static const CharacterSetWhitespaceCharacters ()
 
static const CharacterSetDelimiterCharacters ()
 

Public Attributes

int64_t useOriginBody
 
Http::StatusCode parseStatusCode = Http::scNone
 

Protected Member Functions

bool skipLineTerminator (Http1::Tokenizer &tok) const
 
bool grabMimeBlock (const char *which, const size_t limit)
 

Protected Attributes

SBuf buf_
 bytes remaining to be parsed More...
 
ParseState parsingStage_ = HTTP_PARSE_NONE
 what stage the parser is currently up to More...
 
AnyP::ProtocolVersion msgProtocol_
 what protocol label has been found in the first line (if any) More...
 
SBuf mimeHeaderBlock_
 buffer holding the mime headers (if any) More...
 
bool hackExpectsMime_ = false
 Whether the invalid HTTP as HTTP/0.9 hack expects a mime header block. More...
 

Static Protected Attributes

static const SBuf Http1magic
 RFC 7230 section 2.6 - 7 magic octets. More...
 

Private Member Functions

bool parseChunkSize (Http1::Tokenizer &tok)
 RFC 7230 section 4.1 chunk-size. More...
 
bool parseChunkExtension (Http1::Tokenizer &tok, bool skipKnown)
 
bool parseChunkBody (Http1::Tokenizer &tok)
 
bool parseChunkEnd (Http1::Tokenizer &tok)
 

Private Attributes

MemBuftheOut
 
uint64_t theChunkSize
 
uint64_t theLeftBodySize
 

Detailed Description

An incremental parser for chunked transfer coding defined in RFC 7230 section 4.1. http://tools.ietf.org/html/rfc7230#section-4.1

The parser shovels content bytes from the raw input buffer into the content output buffer, both caller-supplied. Ignores chunk extensions except for ICAP's ieof. Trailers are available via mimeHeader() if wanted.

Definition at line 31 of file TeChunkedParser.h.

Member Typedef Documentation

Definition at line 42 of file Parser.h.

Constructor & Destructor Documentation

Http::One::TeChunkedParser::TeChunkedParser ( )
virtual Http::One::TeChunkedParser::~TeChunkedParser ( )
inlinevirtual

Definition at line 35 of file TeChunkedParser.h.

References NULL, and theOut.

Member Function Documentation

void Http::One::TeChunkedParser::clear ( )
virtual

Set this parser back to a default state. Will DROP any reference to a buffer (does not free).

Implements Http::One::Parser.

Definition at line 28 of file TeChunkedParser.cc.

References Http::One::HTTP_PARSE_NONE, and NULL.

Referenced by TeChunkedParser().

const CharacterSet & Http::One::Parser::DelimiterCharacters ( )
staticinherited

Whitespace between protocol elements in restricted contexts like request line, status line, asctime-date, and credentials Seen in RFCs as SP but may be "relaxed" by us. See also: WhitespaceCharacters(). XXX: Misnamed and overused.

Definition at line 58 of file Parser.cc.

References Config, SquidConfig::onoff, SquidConfig::relaxed_header_parser, RelaxedDelimiterCharacters(), and CharacterSet::SP.

Referenced by Http::ContentLengthInterpreter::goodSuffix().

virtual Parser::size_type Http::One::TeChunkedParser::firstLineSize ( ) const
inlinevirtual

Implements Http::One::Parser.

Definition at line 45 of file TeChunkedParser.h.

char * Http::One::Parser::getHeaderField ( const char *  name)
inherited

Scan the mime header block (badly) for a header with the given name.

BUG: omits lines when searching for headers with obs-fold or multiple entries.

BUG: limits output to just 1KB when Squid accepts up to 64KB line length.

Returns
A pointer to a field-value of the first matching field-name, or NULL.

Definition at line 219 of file Parser.cc.

References SBuf::caseCmp(), SBuf::chop(), SBuf::consume(), Http::One::CrLf(), debugs, GET_HDR_SZ, CharacterSet::LF, LineCharacters(), LOCAL_ARRAY, NULL, p, Parser::Tokenizer::prefix(), Parser::Tokenizer::remaining(), SBufToCstring(), Parser::Tokenizer::skipAll(), Parser::Tokenizer::skipOne(), SBuf::substr(), SBuf::trim(), and CharacterSet::WSP.

bool Http::One::Parser::grabMimeBlock ( const char *  which,
const size_t  limit 
)
protectedinherited

Scan to find the mime headers block for current message.

Return values
trueIf mime block (or a blocks non-existence) has been identified accurately within limit characters. mimeHeaderBlock_ has been updated and buf_ consumed.
falseAn error occured, or no mime terminator found within limit.

Definition at line 163 of file Parser.cc.

References debugs, headersEnd(), Http::One::HTTP_PARSE_DONE, AnyP::PROTO_HTTP, AnyP::PROTO_ICY, and Http::scHeaderTooLarge.

size_type Http::One::Parser::headerBlockSize ( ) const
inlineinherited

size in bytes of the message headers including CRLF terminator(s) but excluding first-line bytes

Definition at line 71 of file Parser.h.

References SBuf::length(), and Http::One::Parser::mimeHeaderBlock_.

Referenced by Http::One::Parser::messageHeaderSize(), and Http::Message::parseHeader().

size_type Http::One::Parser::messageHeaderSize ( ) const
inlineinherited

size in bytes of HTTP message block, includes first-line and mime headers excludes any body/entity/payload bytes excludes any garbage prefix before the first-line

Definition at line 76 of file Parser.h.

References Http::One::Parser::firstLineSize(), and Http::One::Parser::headerBlockSize().

Referenced by Http::Message::parseHeader().

const AnyP::ProtocolVersion& Http::One::Parser::messageProtocol ( ) const
inlineinherited

Definition at line 82 of file Parser.h.

References Http::One::Parser::msgProtocol_.

SBuf Http::One::Parser::mimeHeader ( ) const
inlineinherited

Definition at line 79 of file Parser.h.

References Http::One::Parser::mimeHeaderBlock_.

Referenced by Http::Message::parseHeader().

bool Http::One::Parser::needsMoreData ( ) const
inlineinherited

Whether the parser is waiting on more data to complete parsing a message. Use to distinguish between incomplete data and error results when parse() returns false.

Definition at line 64 of file Parser.h.

References Http::One::HTTP_PARSE_DONE, and Http::One::Parser::parsingStage_.

Referenced by ConnStateData::handleChunkedRequestBody(), testHttp1Parser::testDripFeed(), testHttp1Parser::testParserConstruct(), and testResults().

bool Http::One::TeChunkedParser::needsMoreSpace ( ) const

Definition at line 75 of file TeChunkedParser.cc.

References assert, and Http::One::HTTP_PARSE_CHUNK.

Referenced by ConnStateData::handleChunkedRequestBody().

bool Http::One::TeChunkedParser::parse ( const SBuf aBuf)
virtual

attempt to parse a message from the buffer

Return values
trueif a full message was found and parsed
falseif incomplete, invalid or no message was found

Implements Http::One::Parser.

Definition at line 38 of file TeChunkedParser.cc.

References DBG_DATA, debugs, Http::One::HTTP_PARSE_CHUNK, Http::One::HTTP_PARSE_CHUNK_EXT, Http::One::HTTP_PARSE_CHUNK_SZ, Http::One::HTTP_PARSE_MIME, Http::One::HTTP_PARSE_NONE, SBuf::length(), and Must.

Referenced by HttpStateData::decodeAndWriteReplyBody(), and ConnStateData::handleChunkedRequestBody().

bool Http::One::TeChunkedParser::parseChunkBody ( Http1::Tokenizer tok)
private
bool Http::One::TeChunkedParser::parseChunkEnd ( Http1::Tokenizer tok)
private
bool Http::One::TeChunkedParser::parseChunkExtension ( Http1::Tokenizer tok,
bool  skipKnown 
)
private

Parses chunk metadata suffix, looking for interesting extensions and/or getting to the line terminator. RFC 7230 section 4.1.1 and its Errata #4667:

chunk-ext = *( BWS ";" BWS chunk-ext-name [ BWS "=" BWS chunk-ext-val ] ) chunk-ext-name = token chunk-ext-val = token / quoted-string

ICAP 'use-original-body=N' extension is supported.

Definition at line 118 of file TeChunkedParser.cc.

References Parser::Tokenizer::atEnd(), SBuf::cmp(), debugs, Http::One::HTTP_PARSE_CHUNK, Http::One::HTTP_PARSE_MIME, Parser::Tokenizer::int64(), Http::One::ParseBws(), Parser::Tokenizer::prefix(), Http::One::Tokenizer::quotedStringOrToken(), Parser::Tokenizer::remaining(), Parser::Tokenizer::skip(), and CharacterSet::TCHAR.

bool Http::One::TeChunkedParser::parseChunkSize ( Http1::Tokenizer tok)
private
const SBuf& Http::One::Parser::remaining ( ) const
inlineinherited
void Http::One::TeChunkedParser::setPayloadBuffer ( MemBuf parsedContent)
inline
bool Http::One::Parser::skipLineTerminator ( Http1::Tokenizer tok) const
protectedinherited

detect and skip the CRLF or (if tolerant) LF line terminator consume from the tokenizer.

throws if non-terminator is detected.

Return values
trueonly if line terminator found.
falseincomplete or missing line terminator, need more data.

Definition at line 65 of file Parser.cc.

References SBuf::at(), Parser::Tokenizer::atEnd(), Config, Http::One::CrLf(), SBuf::length(), CharacterSet::LF, SquidConfig::onoff, SquidConfig::relaxed_header_parser, Parser::Tokenizer::remaining(), Parser::Tokenizer::skip(), Parser::Tokenizer::skipOne(), and TexcHere.

const CharacterSet & Http::One::Parser::WhitespaceCharacters ( )
staticinherited

Whitespace between regular protocol elements. Seen in RFCs as OWS, RWS, BWS, SP/HTAB but may be "relaxed" by us. See also: DelimiterCharacters().

Definition at line 51 of file Parser.cc.

References Config, SquidConfig::onoff, SquidConfig::relaxed_header_parser, RelaxedDelimiterCharacters(), and CharacterSet::WSP.

Referenced by Http::One::ParseBws().

Member Data Documentation

SBuf Http::One::Parser::buf_
protectedinherited
bool Http::One::Parser::hackExpectsMime_ = false
protectedinherited

Definition at line 158 of file Parser.h.

const SBuf Http::One::Parser::Http1magic
staticprotectedinherited

Definition at line 143 of file Parser.h.

Referenced by Http::One::ResponseParser::firstLineSize().

SBuf Http::One::Parser::mimeHeaderBlock_
protectedinherited
Http::StatusCode Http::One::Parser::parseStatusCode = Http::scNone
inherited

HTTP status code resulting from the parse process. to be used on the invalid message handling.

Http::scNone indicates incomplete parse, Http::scOkay indicates no error, other codes represent a parse error.

Definition at line 106 of file Parser.h.

Referenced by testHttp1Parser::testParserConstruct(), and testResults().

ParseState Http::One::Parser::parsingStage_ = HTTP_PARSE_NONE
protectedinherited
uint64_t Http::One::TeChunkedParser::theChunkSize
private

Definition at line 54 of file TeChunkedParser.h.

uint64_t Http::One::TeChunkedParser::theLeftBodySize
private

Definition at line 55 of file TeChunkedParser.h.

MemBuf* Http::One::TeChunkedParser::theOut
private

Definition at line 53 of file TeChunkedParser.h.

Referenced by setPayloadBuffer(), and ~TeChunkedParser().

int64_t Http::One::TeChunkedParser::useOriginBody

Definition at line 58 of file TeChunkedParser.h.


The documentation for this class was generated from the following files:

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors