Apache
/
httpcomponents-client
mirror of https://github.com/apache/httpcomponents-client.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixed problem with the default HTTP response parser failing to handle garbage preceding a valid HTTP response 

git-svn-id: https://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk@765294 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Oleg Kalnichevski 2009-04-15 18:19:53 +00:00
parent ccfc5de212
commit 0b5dd9c3a5
4 changed files with 300 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
RELEASE_NOTES.txt
View File

@ -1,6 +1,10 @@
Changes since 4.0 beta 2 Changes since 4.0 beta 2
------------------- -------------------
* Fixed problem with the default HTTP response parser failing to handle garbage
preceding a valid HTTP response.
Contributed by Oleg Kalnichevski <olegk at apache.org>
* NonRepeatableRequestExceptions now include the cause that the original * NonRepeatableRequestExceptions now include the cause that the original
request failed. request failed.
Contributed by Sam Berlin <sberlin at apache.org> Contributed by Sam Berlin <sberlin at apache.org>

11
httpclient/src/main/java/org/apache/http/impl/conn/DefaultResponseParser.java
View File

@ -35,6 +35,8 @@ import java.io.IOException;
import net.jcip.annotations.ThreadSafe; import net.jcip.annotations.ThreadSafe;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.http.HttpException; import org.apache.http.HttpException;
import org.apache.http.HttpMessage; import org.apache.http.HttpMessage;
import org.apache.http.HttpResponseFactory; import org.apache.http.HttpResponseFactory;
@ -56,6 +58,8 @@ import org.apache.http.util.CharArrayBuffer;
@ThreadSafe // no public methods @ThreadSafe // no public methods
public class DefaultResponseParser extends AbstractMessageParser { public class DefaultResponseParser extends AbstractMessageParser {
private final Log log = LogFactory.getLog(getClass());
private final HttpResponseFactory responseFactory; private final HttpResponseFactory responseFactory;
private final CharArrayBuffer lineBuf; private final CharArrayBuffer lineBuf;
private final int maxGarbageLines; private final int maxGarbageLines;
@ -80,12 +84,12 @@ public class DefaultResponseParser extends AbstractMessageParser {
@Override @Override
protected HttpMessage parseHead( protected HttpMessage parseHead(
final SessionInputBuffer sessionBuffer) throws IOException, HttpException { final SessionInputBuffer sessionBuffer) throws IOException, HttpException {
// clear the buffer
this.lineBuf.clear();
//read out the HTTP status string //read out the HTTP status string
int count = 0; int count = 0;
ParserCursor cursor = null; ParserCursor cursor = null;
do { do {
// clear the buffer
this.lineBuf.clear();
int i = sessionBuffer.readLine(this.lineBuf); int i = sessionBuffer.readLine(this.lineBuf);
if (i == -1 && count == 0) { if (i == -1 && count == 0) {
// The server just dropped connection on us // The server just dropped connection on us
@ -100,6 +104,9 @@ public class DefaultResponseParser extends AbstractMessageParser {
throw new ProtocolException("The server failed to respond with a " + throw new ProtocolException("The server failed to respond with a " +
"valid HTTP response"); "valid HTTP response");
} }
if (this.log.isDebugEnabled()) {
this.log.debug("Garbage in response: " + this.lineBuf.toString());
}
count++; count++;
} while(true); } while(true);
//create the status line from the status string //create the status line from the status string

162
httpclient/src/test/java/org/apache/http/impl/conn/TestDefaultResponseParser.java Normal file
View File

@ -0,0 +1,162 @@
/*
* $HeadURL$
* $Revision$
* $Date$
* ====================================================================
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
*/
package org.apache.http.impl.conn;
import org.apache.http.Header;
import org.apache.http.HttpResponse;
import org.apache.http.HttpVersion;
import org.apache.http.NoHttpResponseException;
import org.apache.http.ProtocolException;
import org.apache.http.conn.params.ConnConnectionPNames;
import org.apache.http.impl.DefaultHttpResponseFactory;
import org.apache.http.io.HttpMessageParser;
import org.apache.http.io.SessionInputBuffer;
import org.apache.http.message.BasicLineParser;
import org.apache.http.mockup.SessionInputBufferMockup;
import org.apache.http.params.BasicHttpParams;
import org.apache.http.params.HttpParams;
import junit.framework.Test;
import junit.framework.TestCase;
import junit.framework.TestSuite;
/**
* Tests for <code>DefaultResponseParser</code>.
*/
public class TestDefaultResponseParser extends TestCase {
public TestDefaultResponseParser(String testName) {
super(testName);
}
public static void main(String args[]) {
String[] testCaseName = { TestDefaultResponseParser.class.getName() };
junit.textui.TestRunner.main(testCaseName);
}
public static Test suite() {
return new TestSuite(TestDefaultResponseParser.class);
}
public void testResponseParsingWithSomeGarbage() throws Exception {
String s =
"garbage\r\n" +
"garbage\r\n" +
"more garbage\r\n" +
"HTTP/1.1 200 OK\r\n" +
"header1: value1\r\n" +
"header2: value2\r\n" +
"\r\n";
HttpParams params = new BasicHttpParams();
SessionInputBuffer inbuffer = new SessionInputBufferMockup(s, "US-ASCII", params);
HttpMessageParser parser = new DefaultResponseParser(
inbuffer,
BasicLineParser.DEFAULT,
new DefaultHttpResponseFactory(),
params);
HttpResponse response = (HttpResponse) parser.parse();
assertNotNull(response);
assertEquals(HttpVersion.HTTP_1_1, response.getProtocolVersion());
assertEquals(200, response.getStatusLine().getStatusCode());
Header[] headers = response.getAllHeaders();
assertNotNull(headers);
assertEquals(2, headers.length);
assertEquals("header1", headers[0].getName());
assertEquals("header2", headers[1].getName());
}
public void testResponseParsingWithTooMuchGarbage() throws Exception {
String s =
"garbage\r\n" +
"garbage\r\n" +
"more garbage\r\n" +
"HTTP/1.1 200 OK\r\n" +
"header1: value1\r\n" +
"header2: value2\r\n" +
"\r\n";
HttpParams params = new BasicHttpParams();
params.setParameter(ConnConnectionPNames.MAX_STATUS_LINE_GARBAGE, 2);
SessionInputBuffer inbuffer = new SessionInputBufferMockup(s, "US-ASCII", params);
HttpMessageParser parser = new DefaultResponseParser(
inbuffer,
BasicLineParser.DEFAULT,
new DefaultHttpResponseFactory(),
params);
try {
parser.parse();
fail("ProtocolException should have been thrown");
} catch (ProtocolException ex) {
}
}
public void testResponseParsingNoResponse() throws Exception {
HttpParams params = new BasicHttpParams();
SessionInputBuffer inbuffer = new SessionInputBufferMockup("", "US-ASCII", params);
HttpMessageParser parser = new DefaultResponseParser(
inbuffer,
BasicLineParser.DEFAULT,
new DefaultHttpResponseFactory(),
params);
try {
parser.parse();
fail("NoHttpResponseException should have been thrown");
} catch (NoHttpResponseException ex) {
}
}
public void testResponseParsingOnlyGarbage() throws Exception {
String s =
"garbage\r\n" +
"garbage\r\n" +
"more garbage\r\n" +
"a lot more garbage\r\n";
HttpParams params = new BasicHttpParams();
SessionInputBuffer inbuffer = new SessionInputBufferMockup(s, "US-ASCII", params);
HttpMessageParser parser = new DefaultResponseParser(
inbuffer,
BasicLineParser.DEFAULT,
new DefaultHttpResponseFactory(),
params);
try {
parser.parse();
fail("ProtocolException should have been thrown");
} catch (ProtocolException ex) {
}
}
}

125
httpclient/src/test/java/org/apache/http/mockup/SessionInputBufferMockup.java Normal file
View File

@ -0,0 +1,125 @@
/*
* $HeadURL$
* $Revision$
* $Date$
*
* ====================================================================
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
*/
package org.apache.http.mockup;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.UnsupportedEncodingException;
import org.apache.http.impl.io.AbstractSessionInputBuffer;
import org.apache.http.params.BasicHttpParams;
import org.apache.http.params.HttpParams;
/**
* {@link org.apache.http.io.SessionInputBuffer} mockup implementation.
*/
public class SessionInputBufferMockup extends AbstractSessionInputBuffer {
public static final int BUFFER_SIZE = 16;
public SessionInputBufferMockup(
final InputStream instream,
int buffersize,
final HttpParams params) {
super();
init(instream, buffersize, params);
}
public SessionInputBufferMockup(
final InputStream instream,
int buffersize) {
this(instream, buffersize, new BasicHttpParams());
}
public SessionInputBufferMockup(
final byte[] bytes,
final HttpParams params) {
this(bytes, BUFFER_SIZE, params);
}
public SessionInputBufferMockup(
final byte[] bytes) {
this(bytes, BUFFER_SIZE, new BasicHttpParams());
}
public SessionInputBufferMockup(
final byte[] bytes,
int buffersize,
final HttpParams params) {
this(new ByteArrayInputStream(bytes), buffersize, params);
}
public SessionInputBufferMockup(
final byte[] bytes,
int buffersize) {
this(new ByteArrayInputStream(bytes), buffersize, new BasicHttpParams());
}
public SessionInputBufferMockup(
final String s,
final String charset,
int buffersize,
final HttpParams params)
throws UnsupportedEncodingException {
this(s.getBytes(charset), buffersize, params);
}
public SessionInputBufferMockup(
final String s,
final String charset,
int buffersize)
throws UnsupportedEncodingException {
this(s.getBytes(charset), buffersize, new BasicHttpParams());
}
public SessionInputBufferMockup(
final String s,
final String charset,
final HttpParams params)
throws UnsupportedEncodingException {
this(s.getBytes(charset), params);
}
public SessionInputBufferMockup(
final String s,
final String charset)
throws UnsupportedEncodingException {
this(s.getBytes(charset), new BasicHttpParams());
}
public boolean isDataAvailable(int timeout) throws IOException {
return true;
}
}