Revise the Taint extension documentation - #5802
Merged
Merged
Conversation
Rewrite all taint reference pages against the current extension source (3.x) and README: - book.xml: rewrite the introduction to explain the model (user input marked tainted at request start, mark tracked through string ops, warning at dangerous sinks) and that taint is a dev/audit tool, not a runtime defense; update the example output to the actual "main() [echo]: ..." warning format - detail.xml: rebuild as "Propagation and Checked Sinks"; correct the propagation-function list and the full sink list (output, filesystem, SQL, command, header/cookie, unserialize/mail); remove the obsolete "functions which untaint" table (escaping helpers no longer clear the mark in 3.x); move basename/dirname/pathinfo from sinks to propagation - functions/: document real signatures (taint/untaint take variadic by-reference strings, is_tainted takes a value), always-true/false return semantics, notes and runnable examples - ini.xml: fix taint.error_level default to 512 (E_USER_WARNING) and expand both directives' descriptions - setup.xml/configure.xml: split installation into configure.xml, add PECL/source-build instructions and the GitHub repository, add requirements and resources sections Facts verified against taint.c (arginfo, zend_parse_parameters, php_taint_fcall_check) and live reflection/warning output.
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
2 participants
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.
Summary
propagation semantics (
detail.xml), the function pages (taint,untaint,is_tainted), and the book/setup/installation/INI pages.propagate the taint mark, and the full list of checked sinks
(output, filesystem, SQL, command execution, headers/cookies,
unserialize,mail), each with what argument is inspected.docs (
pecl installplus agit clone+phpizebuild snippet).doc-base/configure.php(libxml validation passes),PhD xhtml rendering, and
docbook-cs(no violations).Test plan
php doc-base/configure.phppasses without errorsphp phd/render.php -P PHP -f xhtmlrenders all 13 taint pagesdocbook-cs reference/taint/reports no violations