org.eclipse.jetty.http2.parser.HeadersBodyParser Maven / Gradle / Ivy
The newest version!
//
// ========================================================================
// Copyright (c) 1995 Mort Bay Consulting Pty Ltd and others.
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License v. 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
// which is available at https://www.apache.org/licenses/LICENSE-2.0.
//
// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
// ========================================================================
//
package org.eclipse.jetty.http2.parser;
import java.nio.ByteBuffer;
import org.eclipse.jetty.http.MetaData;
import org.eclipse.jetty.http2.ErrorCode;
import org.eclipse.jetty.http2.Flags;
import org.eclipse.jetty.http2.frames.FrameType;
import org.eclipse.jetty.http2.frames.HeadersFrame;
import org.eclipse.jetty.http2.frames.PriorityFrame;
import org.eclipse.jetty.util.BufferUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class HeadersBodyParser extends BodyParser
{
private static final Logger LOG = LoggerFactory.getLogger(HeadersBodyParser.class);
private final HeaderBlockParser headerBlockParser;
private final HeaderBlockFragments headerBlockFragments;
private State state = State.PREPARE;
private int cursor;
private int length;
private int paddingLength;
private boolean exclusive;
private int parentStreamId;
private int weight;
public HeadersBodyParser(HeaderParser headerParser, Parser.Listener listener, HeaderBlockParser headerBlockParser, HeaderBlockFragments headerBlockFragments)
{
super(headerParser, listener);
this.headerBlockParser = headerBlockParser;
this.headerBlockFragments = headerBlockFragments;
}
private void reset()
{
state = State.PREPARE;
cursor = 0;
length = 0;
paddingLength = 0;
exclusive = false;
parentStreamId = 0;
weight = 0;
}
@Override
protected void emptyBody(ByteBuffer buffer)
{
if (hasFlag(Flags.PRIORITY))
{
connectionFailure(buffer, ErrorCode.PROTOCOL_ERROR.code, "invalid_headers_priority_frame");
}
else if (hasFlag(Flags.END_HEADERS))
{
MetaData metaData = headerBlockParser.parse(BufferUtil.EMPTY_BUFFER, 0);
HeadersFrame frame = new HeadersFrame(getStreamId(), metaData, null, isEndStream());
if (!rateControlOnEvent(frame))
connectionFailure(buffer, ErrorCode.ENHANCE_YOUR_CALM_ERROR.code, "invalid_headers_frame_rate");
else
onHeaders(frame);
}
else
{
if (headerBlockFragments.getStreamId() != 0)
{
connectionFailure(buffer, ErrorCode.PROTOCOL_ERROR.code, "invalid_headers_frame");
}
else
{
headerBlockFragments.setStreamId(getStreamId());
headerBlockFragments.setEndStream(isEndStream());
}
}
}
@Override
public boolean parse(ByteBuffer buffer)
{
boolean loop = false;
while (buffer.hasRemaining() || loop)
{
switch (state)
{
case PREPARE:
{
// SPEC: wrong streamId is treated as connection error.
if (getStreamId() == 0)
return connectionFailure(buffer, ErrorCode.PROTOCOL_ERROR.code, "invalid_headers_frame");
length = getBodyLength();
if (isPadding())
state = State.PADDING_LENGTH;
else if (hasFlag(Flags.PRIORITY))
state = State.EXCLUSIVE;
else
state = State.HEADERS;
break;
}
case PADDING_LENGTH:
{
if (length < 1)
return connectionFailure(buffer, ErrorCode.FRAME_SIZE_ERROR.code, "invalid_headers_frame_padding");
paddingLength = buffer.get() & 0xFF;
--length;
length -= paddingLength;
state = hasFlag(Flags.PRIORITY) ? State.EXCLUSIVE : State.HEADERS;
loop = length == 0;
break;
}
case EXCLUSIVE:
{
if (length < 5)
return connectionFailure(buffer, ErrorCode.FRAME_SIZE_ERROR.code, "invalid_headers_frame");
// We must only peek the first byte and not advance the buffer
// because the 31 least significant bits represent the stream id.
int currByte = buffer.get(buffer.position());
exclusive = (currByte & 0x80) == 0x80;
state = State.PARENT_STREAM_ID;
break;
}
case PARENT_STREAM_ID:
{
if (buffer.remaining() >= 4)
{
parentStreamId = buffer.getInt();
parentStreamId &= 0x7F_FF_FF_FF;
length -= 4;
state = State.WEIGHT;
}
else
{
state = State.PARENT_STREAM_ID_BYTES;
cursor = 4;
}
break;
}
case PARENT_STREAM_ID_BYTES:
{
int currByte = buffer.get() & 0xFF;
--cursor;
parentStreamId += currByte << (8 * cursor);
--length;
if (cursor == 0)
{
parentStreamId &= 0x7F_FF_FF_FF;
state = State.WEIGHT;
}
break;
}
case WEIGHT:
{
// SPEC: stream cannot depend on itself.
if (getStreamId() == parentStreamId)
return connectionFailure(buffer, ErrorCode.PROTOCOL_ERROR.code, "invalid_priority_frame");
// SPEC: for RFC 7540 weight is 1..256, for RFC 9113 is an unused value.
weight = (buffer.get() & 0xFF) + 1;
--length;
state = State.HEADERS;
loop = length == 0;
break;
}
case HEADERS:
{
if (!hasFlag(Flags.END_HEADERS))
{
headerBlockFragments.setStreamId(getStreamId());
headerBlockFragments.setEndStream(isEndStream());
if (hasFlag(Flags.PRIORITY))
headerBlockFragments.setPriorityFrame(new PriorityFrame(getStreamId(), parentStreamId, weight, exclusive));
}
state = State.HEADER_BLOCK;
break;
}
case HEADER_BLOCK:
{
if (hasFlag(Flags.END_HEADERS))
{
int maxLength = headerBlockParser.getMaxHeaderListSize();
if (maxLength > 0 && length > maxLength)
return connectionFailure(buffer, ErrorCode.REFUSED_STREAM_ERROR.code, "invalid_headers_frame");
MetaData metaData = headerBlockParser.parse(buffer, length);
if (metaData == HeaderBlockParser.SESSION_FAILURE)
return false;
if (metaData != null)
{
if (LOG.isDebugEnabled())
LOG.debug("Parsed {} frame hpack from {}", FrameType.HEADERS, buffer);
state = State.PADDING;
loop = paddingLength == 0;
if (metaData != HeaderBlockParser.STREAM_FAILURE)
{
onHeaders(parentStreamId, weight, exclusive, metaData);
}
else
{
HeadersFrame frame = new HeadersFrame(getStreamId(), metaData, null, isEndStream());
if (!rateControlOnEvent(frame))
return connectionFailure(buffer, ErrorCode.ENHANCE_YOUR_CALM_ERROR.code, "invalid_headers_frame_rate");
}
}
}
else
{
int remaining = buffer.remaining();
if (remaining < length)
{
if (!headerBlockFragments.storeFragment(buffer, remaining, false))
return connectionFailure(buffer, ErrorCode.PROTOCOL_ERROR.code, "invalid_headers_frame");
length -= remaining;
}
else
{
if (!headerBlockFragments.storeFragment(buffer, length, false))
return connectionFailure(buffer, ErrorCode.PROTOCOL_ERROR.code, "invalid_headers_frame");
state = State.PADDING;
loop = paddingLength == 0;
}
}
break;
}
case PADDING:
{
int size = Math.min(buffer.remaining(), paddingLength);
buffer.position(buffer.position() + size);
paddingLength -= size;
if (paddingLength == 0)
{
reset();
return true;
}
break;
}
default:
{
throw new IllegalStateException();
}
}
}
return false;
}
private void onHeaders(int parentStreamId, int weight, boolean exclusive, MetaData metaData)
{
PriorityFrame priorityFrame = null;
if (hasFlag(Flags.PRIORITY))
priorityFrame = new PriorityFrame(getStreamId(), parentStreamId, weight, exclusive);
HeadersFrame frame = new HeadersFrame(getStreamId(), metaData, priorityFrame, isEndStream());
onHeaders(frame);
}
private void onHeaders(HeadersFrame frame)
{
notifyHeaders(frame);
}
private enum State
{
PREPARE, PADDING_LENGTH, EXCLUSIVE, PARENT_STREAM_ID, PARENT_STREAM_ID_BYTES, WEIGHT, HEADERS, HEADER_BLOCK, PADDING
}
}