1
0
mirror of https://github.com/danog/psalm.git synced 2024-11-27 12:55:26 +01:00
psalm/docs/security_analysis/annotations.md
Oliver Hader 546283b71a
Update documentation for taints and global configuration (#5098)
* [DOCS] Extend documentation on global variables configuration

* [DOCS] Synchronize meaning of @psalm-taint-source input with source code

* [DOCS] Add documentation for conditional @psalm-taint-escape

* [DOCS] Add documentation for @psalm-taint-unescape
2021-01-25 11:04:00 -05:00

22 lines
738 B
Markdown

# Security analysis annotations
## `@psalm-taint-source <taint-type>`
See [Custom taint sources](custom_taint_sources.md#taint-source-annotation).
## `@psalm-taint-sink <taint-type> <param-name>`
See [Custom taint sinks](custom_taint_sinks.md).
## `@psalm-taint-escape <taint-type #conditional>`
See [Escaping tainted output](avoiding_false_positives.md#escaping-tainted-output).
## `@psalm-taint-unescape <taint-type>`
See [Unescaping statements](avoiding_false_negatives.md#unescaping-statements).
## `@psalm-taint-specialize`
See [Specializing taints in functions](avoiding_false_positives.md#specializing-taints-in-functions) and [Specializing taints in classes](avoiding_false_positives.md#specializing-taints-in-classes).