psalm/docs/security_analysis/annotations.md

# 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).
Fix #3610 - add security analysis documeentation 2020-06-22 06:18:15 +02:00			`# Security analysis annotations`

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 17:04:00 +01:00			## `@psalm-taint-source <taint-type>`
Fix #3610 - add security analysis documeentation 2020-06-22 06:18:15 +02:00
			`See [Custom taint sources](custom_taint_sources.md#taint-source-annotation).`

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 17:04:00 +01:00			## `@psalm-taint-sink <taint-type> <param-name>`
Fix #3610 - add security analysis documeentation 2020-06-22 06:18:15 +02:00
			`See [Custom taint sinks](custom_taint_sinks.md).`

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 17:04:00 +01:00			## `@psalm-taint-escape <taint-type #conditional>`
Fix #3610 - add security analysis documeentation 2020-06-22 06:18:15 +02:00
			`See [Escaping tainted output](avoiding_false_positives.md#escaping-tainted-output).`

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 17:04:00 +01:00			## `@psalm-taint-unescape <taint-type>`

			`See [Unescaping statements](avoiding_false_negatives.md#unescaping-statements).`

Fix #3610 - add security analysis documeentation 2020-06-22 06:18:15 +02:00			## `@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).`