[Sync-EN] Revise the Taint extension documentation - #1805
Open
lacatoire wants to merge 1 commit into
Open
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Syncs the nine
reference/taint/files with php/doc-en#5802.book.xml: the introduction explains what taint actually does, that the mark is applied to$_GET,$_POSTand$_COOKIEat request startup and tracked through string operations, and states plainly that taint is a development and auditing tool that reports rather than blocks, may over-report, and must not be enabled in production. The example is replaced by one that shows all four warning kinds.detail.xmlis rewritten as "Propagation and checked sinks": the operators and the fixed list of functions that carry the mark, the fact that unknown functions (includinghtmlspecialchars()andmysqli_real_escape_string()) return an unmarked string by design, and complete tables of the output, filesystem, SQL, command execution, header/cookie and other sinks, plus the warning format.setup.xml: adds the version requirements (taint 3.x needs PHP 8.0+, 2.1.x for PHP 7.x, 1.x for PHP 5.x) and a resources section stating the extension defines no resource types.configure.xml: documents installing from PECL and building from source, enablingextension=taint.soandtaint.enable, plus the production warning.ini.xml: both directives are described,taint.enableas a php.ini-only master switch incompatible with the OPcache JIT, andtaint.error_levelwith its default and the runtimeini_set()example.is_tainted(),taint()anduntaint()get real descriptions, parameters, return values, examples and notes, including that the mark lives on the string rather than the variable and that interned strings can never carry it.reference.xml: EN-Revision bump only.EN-Revision bumped to befe2b9fbe37b0925498f336632742651386b151 on the nine files.
Fixes: #1704