For the list of current findings from pipelines see meta-sca report

As announced by this discussion at the end of April 2022 this layer will undergo a major change in support.

Support will be given only for master branch

A maintainers guide can be found here. Feel free to raise pull requests against not officially supported branches.

Support for these branches, including quality control, has to be done fully by the community

• Purpose
• Getting started
• Installation
  • Prerequisites
  • Use of containers
  • Use in CI
  • Setup
  • Kas
• Web monitor
• Support
  • Releases
  • Compatibility
• Licensing
• Zero impact
• Available tools
  • Overview of tools
• Further documentation
• Contributing
  • Get involved
  • Security Policy

Purpose of this layer is to provide a proper set of static analysis tools for your YOCTO build. All provided tools can be easily configured and integrated into any CI service (like e.g. Jenkins).

All results are stored to SCA_EXPORT_DIR (which defaults to ${DEPLOY_DIR_IMAGE}/sca). The results will be stored in the raw-format of the corresponding tool and in checkstyle-format.

For a quick start how to use this layer see getting started guide

You can also watch the following talk

I gave for YS2023.11 to get started.

To install clone the needed branch(es) to any path on your local system.

• You need the current standard poky-layer installed onto your local build environment.

It is recommended to use privkweihmann/yocto-sca-minimal:2004 docker container for building, which has all necessary requirements already installed.

When you're planing to use meta-sca in your CI/CD, it is advised to use the minified layer meta-sca-minified to save you from cloning this fairly large repository.

NOTE meta-sca-minified only offer releases of this layer for releases made after 03/2020

In your bblayers.conf-file add the following line

BBLAYERS  = "<full path to sca-layer>/meta-sca"

or with poky layer already setup run in shell

bitbake-layers add-layer "<full path to sca-layer>/meta-sca"

Alternatively you can use kas to setup the workspace. Use conf/kas/scatest-qemux86-64.yaml from this layer

If you're not quite convinced what this layer can do for you, have a look at the web monitor, where all findings from the layer CI pipelines are publically available.

Actively maintained branch is currently only master. Unmaintained branches will only receive package updates on demand. Support for unmaintained branches has to be done by the community.

Status of the branches is described at SECURITY.md.

It's advised to use the tagged source versions in productive environment.

See SECURITY.md for details

If there is a technical issue that might break backward compatibility it will be mentioned in release note of the corresponding milestone release.

This layer does only provide open source tools. The layer itself is licensed under BSD.

If individual files are licensed under different terms, terms and conditions can be found in the individual file header

This layer provides only -native tools, so actually none of the build binaries will be deployed to your target. Everything happens on the build machine.

The layer can check on a recipe-level or on an image-level.

• On image-level the whole root-filesystem could be taken into account, which in most cases can't be granted on a recipe-level.
• On the other hand some static code analysis does not make any sense on an image-level - so this layer does have different tools for both level available.

each tool does have it's own benefits and flaws so don't be mad if you have 10k findings on the initial run.

• Global Configuration
  • Blacklisting sources
  • Configuration wizard
  • Custom severity
  • Enable SCA locally/globally
  • Fatal findings
  • Filter findings
  • Filter out files to check
  • Output formats
  • Suppress findings
  • Trace source files
  • SDK support
  • Tools
    • bandit
    • bashate
    • bitbake
    • cbmc
    • checkbashism
    • cmake
    • cppcheck
    • cpplint
    • cvecheck
    • darglint
    • dennis
    • detectsecrets
    • flake8
    • flawfinder
    • flint
    • gcc
    • golint
    • it
    • jsonlint
    • kconfighard
    • licensecheck
    • looong
    • msgcheck
    • multimetric
    • mypy
    • oelint
    • perl
    • perlcritic
    • pkgqaenc
    • pscan
    • pylint
    • pysymcheck
    • rats
    • reuse
    • revive
    • ruff
    • scancode
    • setuptoolslint
    • shellcheck
    • slick
    • sparse
    • stank
    • systemdlint
    • tlv
    • tscancode
    • vulture
    • xmllint
    • yamllint
• Configuration Examples
  • C/C code while developing
  • Image monitoring
  • Image security/hardening monitor
  • Python code while developing
  • Shell code while developing
  • Webapps while developing
  • Recommended tools for software integration
• Results
• Build system integration
  • Control via command-line
  • SCA bot
  • Jenkins integration
    • Basic jenkins integration
    • Parameterized jenkins build
• Application notes
  • Recipe buildtime dependencies
  • How are the statistics of a tool calculated?
  • How to build your own module
  • build and version conflicts
  • maintaining your own branch
• Case studies
  • Regression on severe code issues
  • Idenfying hardening and security potential

Please see the detailed contribution guideline for details

To get involved following things can be done

• create an issue
• fix an issue and create a pull request
• see the pinned issues in the bugtracker

For the project's security policy please see here