akka/akka-http

Akka HTTP configuration details exposed to client on EntityStreamSizeException

Open

#1015 opened on Apr 6, 2017

View on GitHub
 (7 comments) (0 reactions) (1 assignee)Scala (1,311 stars) (598 forks)batch import
3 - in progressbughelp wantedt:core

Description

Hi,

The current implementation of the EntityStreamSizeException handling exposes a detailed message about which Akka settings to use (to allow bigger contents in requests) to the client, even though verbose-error-messages is set to off.

I changed the Class to extend ExceptionWithErrorInfo to distinguish between a summary and a detailed message. There is a check for the verbosity setting in HttpServerBluePrint:459 but it seems like it is never called and the ErrorInfo.formatPretty result is returned to the client (which may also just be the result of RuntimeException.getMessage as ExceptionWithErrorInfo extends RuntimeException).

Do you have an idea why or what to change to only display the summary in that case? The mentioned classes are in the akka-http-core module.

You can trigger it by setting akka.http.server.parsing.max-content-length to 1 and send some data with your request.

I pushed my current changes to https://github.com/makubi/akka-http/commit/546af4fa4ac4c5c7e78df2c8b3ba083aa64b3c2e.

Thanks in advance.

Contributor guide

Tech stack
scala
Domain
backendsecurity
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
ScalaAkka HTTP error handling
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Investigate the current implementation of EntityStreamSizeException in ErrorInfo.scala (line 83) and its usage in HttpServerBluePrint.scala (line 459). The reporter has proposed modifying EntityStreamSizeException to extend ExceptionWithErrorInfo to separate summary and detail. Check why the verbosity check in HttpServerBluePrint is not triggered and ensure that only the summary is exposed when verbose error messages is off. Review the linked commit (546af4fa4ac4c5c7e78df2c8b3ba083aa64b3c2e) for reference.