From e6f34daf28b3d8a411906828ea8d3d8fb8add7c2 Mon Sep 17 00:00:00 2001 From: PR Replica Date: Sat, 1 Jan 2000 00:00:00 +0000 Subject: [PATCH] Documentation Actions EnvironmentCheck Source PR: https://github.com/github/codeql/pull/22454 Source head: f82774b69b0a25d7eb9765f4980c1c19b2905e92 --- .../ql/lib/codeql/actions/security/ControlChecks.qll | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/actions/ql/lib/codeql/actions/security/ControlChecks.qll b/actions/ql/lib/codeql/actions/security/ControlChecks.qll index aea57fdc4b71..733c92559d70 100644 --- a/actions/ql/lib/codeql/actions/security/ControlChecks.qll +++ b/actions/ql/lib/codeql/actions/security/ControlChecks.qll @@ -276,9 +276,19 @@ abstract class LabelCheck extends ControlCheck { } } +/** + * A deployment environment that may serve as a sanitizer for + * various vulnerabilities. + * + * It is possible to customize which deployment environments apply. The default behavior + * of this model is for any environment to be considered a sanitizer. + * If values are provided then those names + * will be used to define the valid sanitizer set. + * To describe the situation where there is no acceptable sanitizer environment + * populate the predicate `enabledDeploymentEnvironmentDataModel` to contain a single empty string. + */ class EnvironmentCheck extends ControlCheck instanceof Environment { EnvironmentCheck() { - // if there are any custom tuples use those if enabledDeploymentEnvironmentDataModel(_) then enabledDeploymentEnvironmentDataModel(this.(Environment).getName()) else this instanceof Environment