scorecard/probes/sastToolConfigured/def.yml

# Copyright 2024 OpenSSF Scorecard Authors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

id: sastToolConfigured
lifecycle: stable
short: Check that the project uses a SAST tool
motivation: >
  SAST is testing run on source code before the application is run. Using SAST tools can prevent known classes of bugs from being inadvertently introduced in the codebase.
implementation: >
  The implementation checks for evidence of various SAST tools. This includes configuration files, GitHub Action workflows, and GitHub PR check annotations.
outcome:
  - If the project uses a SAST tool we can detect, the probe returns one finding per tool with OutcomeTrue.
  - If the project does not use a SAST tool, or uses a tool we dont currently detect, the probe returns one finding with OutcomeFalse.
remediation:
  onOutcome: False
  effort: Medium
  text:
    - Setup one of tools we currently detect https://github.com/ossf/scorecard/blob/main/docs/checks/sast/README.md.
  markdown:
    - Setup one of [tools we currently detect](https://github.com/ossf/scorecard/blob/main/docs/checks/sast/README.md).
ecosystem:
  languages:
    - all
  clients:
    - github
    - gitlab