Working

Author: robotdan

README.md

@@ -231,6 +231,8 @@ The general requirements and roadmap are as follows:
 ### Server tasks
 
 * [x] Basic HTTP 1.1
+* [x] Support Accept-Encoding (gzip, deflate)
+* [x] Support Content-Encoding (gzip, deflate)
 * [x] Support Keep-Alive
 * [x] Support Expect-Continue 100
 * [x] Support chunked request

src/main/java/io/fusionauth/http/server/HTTPRequest.java

@@ -150,6 +150,14 @@ public void addAcceptEncodings(List<String> encodings) {
     this.acceptEncodings.addAll(encodings);
   }
 
+  public void addContentEncoding(String encoding) {
+    this.contentEncodings.add(encoding);
+  }
+
+  public void addContentEncodings(List<String> encodings) {
+    this.contentEncodings.addAll(encodings);
+  }
+
   public void addCookies(Cookie... cookies) {
     for (Cookie cookie : cookies) {
       this.cookies.put(cookie.name, cookie);
@@ -232,10 +240,7 @@ public List<String> getAcceptEncodings() {
 
   public void setAcceptEncodings(List<String> encodings) {
     this.acceptEncodings.clear();
-    // TODO : ? Maybe not worth being defensive here since we likely have many methods on this object that are not null safe?
-    if (encodings != null) {
-      this.acceptEncodings.addAll(encodings);
-    }
+    this.acceptEncodings.addAll(encodings);
   }
 
   /**
@@ -306,13 +311,9 @@ public List<String> getContentEncodings() {
     return contentEncodings;
   }
 
-  // TODO : Note : Should I add 'addContentEncodings' and 'addContentEncoding' to match 'accept*' ?
   public void setContentEncodings(List<String> encodings) {
     this.contentEncodings.clear();
-    // TODO : ? Maybe not worth being defensive here since we likely have many methods on this object that are not null safe?
-    if (encodings != null) {
-      this.contentEncodings.addAll(encodings);
-    }
+    this.contentEncodings.addAll(encodings);
   }
 
   public Long getContentLength() {
@@ -751,9 +752,7 @@ private void decodeHeader(String name, String value) {
             weight = Double.parseDouble(weightText);
           }
 
-          // Content-Encoding values are not case-sensitive
-          // TODO : Ok to lc here? We are currently just always using equalsIgnoreCase
-          WeightedString ws = new WeightedString(parsed.value().toLowerCase(), weight, index);
+          WeightedString ws = new WeightedString(parsed.value(), weight, index);
           weightedStrings.add(ws);
           index++;
         }
@@ -778,15 +777,11 @@ private void decodeHeader(String name, String value) {
         }
         break;
       case Headers.ContentEncodingLower:
-        // TODO : Note that we don't expect more than one Content-Encoding header. We could take the last one we find,
-        //        or try and combine the values. MDN and other places indicate combining may be preferred even though
-        //        it isn't ideal to send multiple headers like this. I tend to think we should just accept the last one.
         String[] encodings = value.split(",");
         List<String> contentEncodings = new ArrayList<>(1);
         int encodingIndex = 0;
         for (String encoding : encodings) {
-          // TODO : Ok to lc here? We are currently just always using equalsIgnoreCase
-          encoding = encoding.trim().toLowerCase();
+          encoding = encoding.trim();
           if (encoding.isEmpty()) {
             continue;
           }

src/main/java/io/fusionauth/http/server/internal/HTTPWorker.java

@@ -145,13 +145,6 @@ public void run() {
           instrumenter.acceptedRequest();
         }
 
-        // TODO : Content-Encoding, we are currently keeping the PushbackInputStream for the entire keep-alive session.
-        //        Ideally we'd set the InputStream for gzip, deflate, etc lower.
-        //        Also... with Pushback bytes... the bytes may be compressed for the next request. So we'll need to be able to
-        //        read handle this. So perhaps this should all be handled at a high level?
-
-        // HTTPInputStream > Pushback > Decompression > Throughput > Socket
-
         httpInputStream = new HTTPInputStream(configuration, request, inputStream);
         request.setInputStream(httpInputStream);
 
@@ -452,21 +445,19 @@ private Integer validatePreamble(HTTPRequest request) {
       request.removeHeader(Headers.ContentLength);
     }
 
-    // TODO : Note that some indicate you can return a 415 based upon the Accept-Encoding header as well if you do not support the request.
-    //        But I don't know that I agree- to me that is just telling the server here are encoding values I support, and you can tell me what you did.
-    //        The spec even says you can ignore the Accept-Encoding header if you want based upon CPU load, or other reasons.
-    //        Not planning to add any validation for Accept-Encoding.
-
     // Content-Encoding
     var contentEncodings = request.getContentEncodings();
     // TODO : If provided, I think we can safely remove the Content-Length header if present?
     //        Although, I suppose as long as we decompress early, we should still be able to use the Content-Length header as long as
     //        it represents the un-compressed payload.
+    //        Maybe write a test to prove that we can compress with a fixed-length w/ a Content-Length header?
+    // Current support is for gzip and deflate.
     for (var encoding : contentEncodings) {
-      // We only support gzip and deflate.
-      // TODO : Ensure we use the same equals check here as other places, I think we should lowercase during parse, and then expect these to be lc.
-      if (!encoding.equals(ContentEncodings.Gzip) && !encoding.equals(ContentEncodings.Deflate)) {
-        // TODO : Add log statement
+      if (!encoding.equalsIgnoreCase(ContentEncodings.Gzip) && !encoding.equalsIgnoreCase(ContentEncodings.Deflate)) {
+        // Note that while we do not expect multiple Content-Encoding headers, the last one will be used. For good measure,
+        // use the last one in the debug message as well.
+        var contentEncodingHeader = request.getHeaders(Headers.ContentEncoding).getLast();
+        logger.debug("Invalid request. The Content-Type header contains an un-supported value. [{}]", contentEncodingHeader);
         return Status.UnsupportedMediaType;
       }
     }
@@ -489,10 +480,10 @@ private enum CloseSocketReason {
   private static class Status {
     public static final int BadRequest = 400;
 
-    public static final int UnsupportedMediaType = 415;
-
     public static final int HTTPVersionNotSupported = 505;
 
     public static final int InternalServerError = 500;
+
+    public static final int UnsupportedMediaType = 415;
   }
 }

src/main/java/io/fusionauth/http/server/io/HTTPInputStream.java

@@ -54,7 +54,7 @@ public class HTTPInputStream extends InputStream {
 
   private boolean closed;
 
-  private boolean committed;
+  private boolean initialized;
 
   private InputStream delegate;
 
@@ -141,8 +141,8 @@ public int read(byte[] b, int off, int len) throws IOException {
       return -1;
     }
 
-    if (!committed) {
-      commit();
+    if (!initialized) {
+      initialize();
     }
 
     // When we have a fixed length request, read beyond the remainingBytes if possible.
@@ -164,8 +164,8 @@ public int read(byte[] b, int off, int len) throws IOException {
     return read;
   }
 
-  private void commit() throws IOException {
-    committed = true;
+  private void initialize() throws IOException {
+    initialized = true;
 
     Long contentLength = request.getContentLength();
     boolean hasBody = (contentLength != null && contentLength > 0) || request.isChunked();
@@ -201,6 +201,17 @@ private void commit() throws IOException {
       logger.trace("Client indicated it was NOT sending an entity-body in the request");
     }
 
+    // Those who push back:
+    // HTTPInputStream when fixed
+    // ChunkedInputStream when chunked
+    // Preamble parser
+
+    // HTTPInputStream (this) > Pushback (delegate) > Throughput > Socket
+    // HTTPInputStream (this) > Chunked (delegate) > Pushback > Throughput > Socket
+
+    // HTTPInputStream (this) > Pushback > Decompress > Throughput > Socket
+    // HTTPInputStream (this) > Pushback > Decompress > Chunked > Throughput > Socket
+
     // TODO : Note I could leave this alone, but when we parse the header we can lower case these values and then remove the equalsIgnoreCase here?
     //        Seems like ideally we would normalize them to lowercase earlier.
     if (hasBody) {

src/main/java/io/fusionauth/http/server/io/HTTPOutputStream.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2024, FusionAuth, All Rights Reserved
+ * Copyright (c) 2024-2025, FusionAuth, All Rights Reserved
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -128,9 +128,6 @@ public void reset() {
    */
   public boolean willCompress() {
     if (compress) {
-      // TODO : Note I could leave this alone, but when we parse the header we can lower case these values and then remove the equalsIgnoreCase here?
-      //        Seems like ideally we would normalize them to lowercase earlier.
-      //        Hmm.. sems like we have to in theory since someone could call setAcceptEncodings later, or addAcceptEncodings?
       for (String encoding : acceptEncodings) {
         if (encoding.equalsIgnoreCase(ContentEncodings.Gzip)) {
           return true;
@@ -196,9 +193,6 @@ private void commit(boolean closing) throws IOException {
       // 204 status is specifically "No Content" so we shouldn't write the content-encoding and vary headers if the status is 204
       // TODO : Compress by default is on by default. But it looks like we don't actually compress unless you also send in an Accept-Encoding header?
       if (compress && !twoOhFour) {
-        // TODO : Note I could leave this alone, but when we parse the header we can lower case these values and then remove the equalsIgnoreCase here?
-        //        Seems like ideally we would normalize them to lowercase earlier.
-        //        Hmm.. sems like we have to in theory since someone could call setAcceptEncodings later, or addAcceptEncodings?
         for (String encoding : acceptEncodings) {
           if (encoding.equalsIgnoreCase(ContentEncodings.Gzip)) {
             response.setHeader(Headers.ContentEncoding, ContentEncodings.Gzip);