CodeQL library for GitHub Actions
codeql/actions-all 0.4.12 (changelog, source)
Search

Module actions

Import path

import actions

Predicates

actionsPermissionsDataModel

MaD models for permissions needed by actions Fields: - action: action name, e.g. actions/checkout - permission: permission name, e.g. contents: read

argumentInjectionSinksDataModel

MaD models for arguments to commands that execute the given argument. Fields: - regexp: Regular expression for matching argument injections. - command_group: capture group for the command. - argument_group: capture group for the argument.

contextTriggerDataModel

MaD models for context/trigger mapping Fields: - trigger: Trigger for the workflow - context_prefix: Prefix for the context

defaultBranchNames
externallyTriggerableEventsDataModel

MaD models for externally triggerable events Fields: - event: Event name

getRepoRoot
immutableActionsDataModel

MaD models for immutable actions Fields: - action: action name

inNonPrivilegedContext
inPrivilegedContext
isSubpath

Holds if the path cache_path is a subpath of the path untrusted_path.

normalizeExpr
normalizePath
poisonableActionsDataModel

MaD models for poisonable actions Fields: - action: action name

poisonableCommandsDataModel

MaD models for poisonable commands Fields: - regexp: Regular expression for matching poisonable commands

poisonableLocalScriptsDataModel

MaD models for poisonable local scripts Fields: - regexp: Regular expression for matching poisonable local scripts - group: Script capture group number for the regular expression

repositoryDataModel

MaD models for repository details Fields: - visibility: Visibility of the repository - default_branch_name: Default branch name

trimQuotes
trustedActionsOwnerDataModel

MaD models for trusted actions owners Fields: - owner: owner name

untrustedEventPropertiesDataModel

MaD models for event properties that can be user-controlled. Fields: - property: event property - kind: property kind

untrustedGhCommandDataModel

MaD models for untrusted gh commands Fields: - cmd_regex: Regular expression for matching untrusted gh commands - flag: Flag for the command

untrustedGitCommandDataModel

MaD models for untrusted git commands Fields: - cmd_regex: Regular expression for matching untrusted git commands - flag: Flag for the command

vulnerableActionsDataModel

MaD models for vulnerable actions Fields: - action: action name - vulnerable_version: vulnerable version - vulnerable_sha: vulnerable sha - fixed_version: fixed version

workflowDataModel

MaD models for workflow details Fields: - path: Path to the workflow file - trigger: Trigger for the workflow - job: Job name - secrets_source: Source of secrets - permissions: Permissions for the workflow - runner: Runner info for the workflow

wrapJsonRegexp
wrapRegexp

Classes

AstNode
BashShellScript
CompositeAction

A custom composite action. This is a mapping at the top level of an Actions YAML action file. See https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions.

Default
Env

An env in workflow, job or step.

EnvExpression
Environment

An Environemnt node representing a deployment environment.

Event
Expression
ExternalJob
GitHubExpression
If

An If node representing a conditional statement.

Input
InputsExpression
Job

An Actions job within a workflow. See https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobs.

JobsExpression
JsonReferenceExpression
LocalJob

An Actions job within a workflow which is composed of steps. See https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobs.

MatrixExpression
Needs

https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idneeds

NeedsExpression
On
Outputs
Permissions
PowerShellScript
ReusableWorkflow
Run

A run field within an Actions job step, which runs command-line programs using an operating system shell. See https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsrun.

Runs

An runs mapping in a custom composite action YAML. See https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runs

ScalarValue
SecretsExpression
ShellScript
SimpleReferenceExpression
Step

A step within an Actions job. See https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idsteps.

StepsContainer
StepsExpression
Strategy
Uses
UsesStep
Workflow

An Actions workflow. This is a mapping at the top level of an Actions YAML workflow file. See https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions.

Modules

Aliases

Extensions

This module provides extensible predicates for defining MaD models.