Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

HTML Report does not correctly escape statistics data #2126

Closed
herrmanntom opened this issue Jul 4, 2022 · 3 comments
Closed

HTML Report does not correctly escape statistics data #2126

herrmanntom opened this issue Jul 4, 2022 · 3 comments
Labels
bug

Comments

@herrmanntom
Copy link
Contributor

herrmanntom commented Jul 4, 2022 •
edited
Loading

Describe the bug

In case your statistics include html, or html-like content, then the html report breaks in various ways.
For example, one could:

  • include "place holders" in custom names for requests that happen to have angle brackets in them (name="/api/user/<userId>/info")
  • custom error messages might contain (parts of) the request text, which then might contain html (response.failure("failed with payload: ' + response.text))

Expected behavior

all html entities within user controlled parts of the statistics must be properly encoded, so that report can be viewed correctly with such data inside

Actual behavior

data is not encoded, report breaks

Steps to reproduce

Mark a response as failed with this message:
response.failure("<title>")
then generate html report
Look at "failure" table. It will break after this entry. Also remaining content after this line is broken (so graphs are missing etc)

Environment

  • OS: Fedora 36
  • Python version: 3.9
  • Locust version: 2.10.1
  • Locust command line that you ran: locust -f testcases.py
  • Locust file contents (anonymized if necessary): (see above for relevant parts)
@herrmanntom herrmanntom added the bug label Jul 4, 2022
@cyberw
Copy link
Collaborator

cyberw commented Jul 4, 2022 •
edited
Loading

Sounds annoying. PRs welcome.

@herrmanntom
Copy link
Contributor Author

Should be a matter of putting
https://docs.python.org/3/library/html.html#html.escape
in the right places.

herrmanntom pushed a commit to herrmanntom/locust that referenced this issue Jul 5, 2022
Escape user supplied data in html report (locustio#2126)
286339e
@herrmanntom herrmanntom mentioned this issue Jul 5, 2022
Merged
cyberw pushed a commit that referenced this issue Jul 5, 2022
@herrmanntom
Escape user supplied data in html report (#2126) (#2127)
0be56b3 
* Escape user supplied data in html report (#2126)

authored-by: Tom Herrmann <[email protected]>
@herrmanntom
Copy link
Contributor Author

herrmanntom commented Jul 11, 2022 •
edited
Loading

turns out, the exception display in the web UI also does not escape the traceback correctly... I added another PR for this

herrmanntom pushed a commit to herrmanntom/locust that referenced this issue Jul 11, 2022
Fix escaping for exceptions in normal web ui (related to locustio#2126)
19a18ae
herrmanntom pushed a commit to herrmanntom/locust that referenced this issue Jul 11, 2022
Fix escaping for exceptions in normal web ui (related to locustio#2126)
a367c3b
cyberw added a commit that referenced this issue Jul 11, 2022
@cyberw
Merge pull request #2131 from herrmanntom/fix-exception-escaping
fff90fd 
Fix escaping for exceptions in normal web ui (related to #2126)
@cyberw cyberw closed this as completed Jul 18, 2022
danigoland added a commit to danigoland/locust that referenced this issue Aug 9, 2022
@danigoland @solowalker27
@cyberw @herrmanntom @RenanGBarreto @Likqez @DmytroLitvinov @sosna @andybyrne @gdm85 @Pactortester @mikenester @mboutet
Sync with LocusIO Repo (#1)
b7b5284 
* More robust handling of ZMQ/RPC errors (locustio#2120)

* More robust RPC error handling on msg from worker

* Use dedicated exceptions, fewer nested try blocks

* Fix test_zmqrpc.py

* Undo function split since added new exceptions

* Fix more tests

* Fix some tests

* Fix typo

* Fix scoping of variables

* Add tests for RPC/ZMQ changes

* flake and black fixes

* Remove debug print line

Co-authored-by: Ryan Warner <[email protected]>

* Remove timeout parameter from FastHttpUser unit tests

* Update changelog for 2.10

* Increase CONNECT_RETRY_COUNT to avoid workers giving up too soon if master is not up yet

* Escape user supplied data in html report (locustio#2126) (locustio#2127)

* Escape user supplied data in html report (locustio#2126)

authored-by: Tom Herrmann <[email protected]>

* Replace the MD5 usage by SHA256

MD5 is old, insecure, and can create problems for people using this package when they are trying to pass some compliance requirements (for example, FIPS).

* Fix escaping for exceptions in normal web ui (related to locustio#2126)

* implement table-sorting in report.html

* fix: Fix typo at user/wait_time.py

* improve report sorting

* enabled sorting of error messages as well as stacktraces

* Minor edits to the documentation

* Small documentation correction

* Minor edits to the documentation

* Log an error for every failed attempt to connect to master

The connection timeout and number of attempts are hardcoded, so a failure will take very long
These log lines will allow to troubleshoot issues with the connection to master

* Minor edits to the documentation

* Minor edits to the documentation

* Minor edits to the documentation

* Stop calling attributes 'properties' in some places.

* Give a better error message when someone accidentally sets User.task instead of User.tasks

* Fix detection of accidental TaskSet.task attribute

* fix spelling in comment

* style: add a report favicon

* Removed cache_timeout kwarg from request_stats_full_history_csv for flask 2.2.0

* temporary change to see logs for py38

* restored resource warning masking

* enabled tracemalloc temporarily

* removed tracemalloc

* Ensure no caching of stats history csv (replaces cache_timeout=None which was removed in locustio#2148)

* Update changelog for 2.10.2 (automatic changelog generation is broken, so CHANGELOG.md is incomplete)

* test: Implement failing test for issue locustio#2135

* fix: Set users_dispatcher to None when test is stopped

* chore: Remove misleading docstring in test

* chore: Do not use intermediate variable for one-use

* perf(test): Decrease test runtime

Co-authored-by: solowalker27 <[email protected]>
Co-authored-by: Ryan Warner <[email protected]>
Co-authored-by: Lars Holmberg <[email protected]>
Co-authored-by: Tom Herrmann <[email protected]>
Co-authored-by: Renan Gomes Barreto <[email protected]>
Co-authored-by: Tom Herrmann <[email protected]>
Co-authored-by: Lukas Lanzner <[email protected]>
Co-authored-by: Dmytro Litvinov <[email protected]>
Co-authored-by: Xavier Sosnovsky <[email protected]>
Co-authored-by: Andy Byrne <[email protected]>
Co-authored-by: gdm85 <[email protected]>
Co-authored-by: Xavier Sosnovsky <[email protected]>
Co-authored-by: Lars Holmberg <[email protected]>
Co-authored-by: Lijiawei <[email protected]>
Co-authored-by: Michael Nester <[email protected]>
Co-authored-by: Maxence Boutet <[email protected]>
Co-authored-by: Maxence Boutet <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@cyberw @herrmanntom