-
Notifications
You must be signed in to change notification settings - Fork 630
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Copy the security paragraph to security.rst * Fix missing maintainer in docs/index.rst * Fix incorrect emphasis markup
- Loading branch information
Showing
4 changed files
with
35 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
Security considerations | ||
----------------------- | ||
|
||
Pygments provides no guarantees on execution time, which needs to be taken | ||
into consideration when using Pygments to process arbitrary user inputs. For | ||
example, if you have a web service which uses Pygments for highlighting, there | ||
may be inputs which will cause the Pygments process to run "forever" and/or use | ||
significant amounts of memory. This can subsequently be used to perform a | ||
remote denial-of-service attack on the server if the processes are not | ||
terminated quickly. | ||
|
||
Unfortunately, it's practically impossible to harden Pygments itself against | ||
those issues: Some regular expressions can result in "catastrophic | ||
backtracking", but other bugs like incorrect matchers can also | ||
cause similar problems, and there is no way to find them in an automated fashion | ||
(short of solving the halting problem.) Pygments has extensive unit tests, | ||
automated randomized testing, and is also tested by `OSS-Fuzz <https://github.com/google/oss-fuzz/tree/master/projects/pygments>`_, | ||
but we will never be able to eliminate all bugs in this area. | ||
|
||
Our recommendations are: | ||
|
||
* Ensure that the Pygments process is *terminated* after a reasonably short | ||
timeout. In general Pygments should take seconds at most for reasonably-sized | ||
input. | ||
* *Limit* the number of concurrent Pygments processes to avoid oversubscription | ||
of resources. | ||
|
||
The Pygments authors will treat any bug resulting in long processing times with | ||
high priority -- it's one of those things that will be fixed in a patch release. | ||
When reporting a bug where you suspect super-linear execution times, please make | ||
sure to attach an input to reproduce it. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters