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
- Web monitor
- Support
- Licensing
- Zero impact
- Available tools
- Further documentation
- Contributing
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.
| Module | Description | Homepage | Requires | Requires inet | Run on image | Run on recipe | Available in SDK | C | C++ | Python | Shell | Javascript | PHP | Go | Images | LUA | Spelling | Metrics | Binaries | Packages | Other formats | Security scope | Functional scope | Style scope |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| bandit | Scan python code for insecurities | https://github.com/PyCQA/bandit | x | x | x | x | x | |||||||||||||||||
| bashate | Shell script linter | http://docs.openstack.org/developer/bashate/ | x | x | x | x | x | x | ||||||||||||||||
| bitbake | Bitbake issue handling | x | x | x | x | x | ||||||||||||||||||
| cbmc | C Bounded Model Checker | https://github.com/diffblue/cbmc/ | x | x | x | x | ||||||||||||||||||
| checkbashisms | Shell script linter | https://manpages.debian.org/jessie/devscripts/checkbashisms.1.en.html | x | x | x | x | x | x | ||||||||||||||||
| cmake | Get cmake errors and warnings | x | x | x | x | |||||||||||||||||||
| cppcheck | C/C++ linter | https://github.com/danmar/cppcheck | x | x | x | x | x | x | x | |||||||||||||||
| cpplint | C/C++ linter | https://github.com/cpplint/cpplint | x | x | x | x | x | x | x | |||||||||||||||
| cvecheck | Check for unpatched CVEs | https://github.com/clearlinux/cve-check-tool | manual enable | x | x | x | x | |||||||||||||||||
| darglint | Python docstring linter | https://github.com/terrencepreilly/darglint | x | x | x | x | ||||||||||||||||||
| dennis | I18N linter | https://github.com/willkg/dennis/ | x | x | x | x | x | |||||||||||||||||
| detectsecrets | Detect hardcoded secrets in code | https://github.com/Yelp/detect-secrets | x | x | x | x | x | x | ||||||||||||||||
| flake8 | Python linter | http://flake8.pycqa.org/en/latest/ | x | x | x | x | x | x | ||||||||||||||||
| flawfinder | C/C++ security linter | https://github.com/david-a-wheeler/flawfinder | x | x | x | x | x | |||||||||||||||||
| flint | C/C++ linter | https://github.com/JossWhittle/FlintPlusPlus | x | x | x | x | x | |||||||||||||||||
| gcc | GCC compiler issues and hardening | x | x | x | x | x | ||||||||||||||||||
| golint | GO linter | https://github.com/golang/lint | x | x | x | x | ||||||||||||||||||
| it | Python linter | https://github.com/thg-consulting/it | x | x | x | x | ||||||||||||||||||
| jsonlint | JSON file linter | x | x | x | x | x | ||||||||||||||||||
| kconfighard | Kernel config hardening checker | https://github.com/a13xp0p0v/kconfig-hardened-check | x | x | x | x | ||||||||||||||||||
| licensecheck | Scan code for license information | https://github.com/boyter/lc | x | x | x | |||||||||||||||||||
| looong | Find functions with too long arglists | https://github.com/anapaulagomes/looong | x | x | x | x | ||||||||||||||||||
| msgcheck | I18n linter | https://github.com/codingjoe/msgcheck | x | x | x | x | ||||||||||||||||||
| multimetric | Coding metrics | https://github.com/priv-kweihmann/multimetric | manual enable | x | x | x | x | x | x | x | x | x | x | x | x | |||||||||
| mypy | Python linter | https://github.com/python/mypy | x | x | x | x | x | |||||||||||||||||
| oelint | Bitbake recipe linter | https://github.com/priv-kweihmann/oelint-adv | x | x | x | x | ||||||||||||||||||
| perl | Perl warnings check | x | x | x | x | |||||||||||||||||||
| perlcritic | Perl linter | https://metacpan.org/pod/perlcritic | x | x | x | x | ||||||||||||||||||
| pkgqaenc | Enhanced package QA | x | x | x | ||||||||||||||||||||
| pscan | Find insecure printfs | http://deployingradius.com/pscan/ | x | x | x | x | ||||||||||||||||||
| pylint | Python linter | https://github.com/PyCQA/pylint | x | x | x | x | x | x | ||||||||||||||||
| pysymcheck | Check binaries for forbidden function usage | https://github.com/priv-kweihmann/pysymbolcheck | x | x | x | |||||||||||||||||||
| rats | Check on insecurities in several languages | https://github.com/redNixon/rats | x | x | x | x | x | x | x | |||||||||||||||
| reuse | Scan code for license information | https://github.com/fsfe/reuse-tool | x | x | x | |||||||||||||||||||
| revive | GO linter | https://github.com/mgechev/revive | x | x | x | x | x | |||||||||||||||||
| ruff | Extremely fast python linter | https://github.com/astral-sh/ruff | x | x | x | x | x | |||||||||||||||||
| scancode | Scan code for license information | https://github.com/nexB/scancode-toolkit | x | x | x | |||||||||||||||||||
| setuptoolslint | Lint python-setup.py | https://github.com/johnnoone/setuptools-pylint | x | x | x | x | ||||||||||||||||||
| shellcheck | Shell script linter | https://github.com/koalaman/shellcheck | x | x | x | x | x | x | ||||||||||||||||
| slick | Shell script linter | https://github.com/mcandre/slick | x | x | x | x | x | |||||||||||||||||
| sparse | C linter | https://sparse.wiki.kernel.org/index.php/Main_Page | x | x | x | x | ||||||||||||||||||
| stank | Shell script linter | https://github.com/mcandre/stank | x | x | x | x | x | x | ||||||||||||||||
| systemdlint | Systemd unit linter | https://github.com/priv-kweihmann/systemdlint | x | x | x | x | x | x | x | |||||||||||||||
| tlv | Find duplicate code | https://github.com/priv-kweihmann/tlv | manual enable | x | x | x | x | x | x | x | x | x | x | x | ||||||||||
| tscancode | C and lua linter | https://github.com/Tencent/TscanCode | x | x | x | x | ||||||||||||||||||
| vulture | Find dead python code | https://github.com/jendrikseipp/vulture | x | x | x | x | x | |||||||||||||||||
| xmllint | XML linter | http://xmlsoft.org/xmllint.html | x | x | x | x | x | |||||||||||||||||
| yamllint | YAML linter | https://github.com/adrienverge/yamllint | x | x | x | x | x |
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
- Results
- Build system integration
- Control via command-line
- SCA bot
- Jenkins integration
- Application notes
- Case studies
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