scorecard/probes/hasBinaryArtifacts/def.yml

# Copyright 2023 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: hasBinaryArtifacts
lifecycle: stable
short: Checks if the project has any binary files in its source tree.
motivation: >
  Binary files are not human readable so users and reviewers can't easily see what they do.
implementation: >
  The implementation looks for the presence of binary files. This is a more restrictive probe than "hasUnverifiedBinaryArtifacts" which excludes verified binary files.
outcome:
  - If the probe finds binary files, it returns one OutcomeTrue for each binary file found.
  - If the probe finds no binary files, it returns a single OutcomeFalse.
remediation:
  onOutcome: True
  effort: Medium
  text:
    - Remove the generated executable artifacts from the repository.
    - Build from source.
ecosystem:
  languages:
    - all
  clients:
    - github
    - gitlab
    - localdir