pixie

Projects that follow the best practices below can voluntarily self-certify and show that they've achieved an Open Source Security Foundation (OpenSSF) best practices badge.

If this is your project, please show your badge status on your project page! The badge status looks like this: Badge level for project 5027 is silver Here is how to embed it:

These are the Silver level criteria. You can also view the Passing or Gold level criteria.

        

 Basics 17/17 ●

  • Identification

    Pixie is an open source observability tool for Kubernetes applications. Using Pixie, developers can view the high-level state of their cluster (service maps, cluster resources, application traffic) and also drill-down into more detailed views (pod state, flame graphs, individual application requests). Pixie uses eBPF to automatically capture its telemetry data without the need for manual instrumentation.

  • Prerequisites


    Enough for a badge!

    The project MUST achieve a passing level badge. [achieve_passing]

  • Basic project website content


    Enough for a badge!

    The information on how to contribute MUST include the requirements for acceptable contributions (e.g., a reference to any required coding standard). (URL required) [contribution_requirements]

    https://github.com/pixie-io/pixie/blob/main/CONTRIBUTING.md Asks users to refer to our style guide (https://github.com/pixie-io/pixie/tree/main/styleguide)


  • Project oversight


    Enough for a badge!

    The project SHOULD have a legal mechanism where all developers of non-trivial amounts of project software assert that they are legally authorized to make these contributions. The most common and easily-implemented approach for doing this is by using a Developer Certificate of Origin (DCO), where users add "signed-off-by" in their commits and the project links to the DCO website. However, this MAY be implemented as a Contributor License Agreement (CLA), or other legal mechanism. (URL required) [dco]

    Located here: https://github.com/pixie-io/pixie/blob/main/CONTRIBUTING.md#sign-your-commits

    DCO check enabled for repo.


    Enough for a badge!

    The project MUST clearly define and document its project governance model (the way it makes decisions, including key roles). (URL required) [governance]

    https://github.com/pixie-io/pixie/blob/main/GOVERNANCE.md


    Enough for a badge!

    The project MUST adopt a code of conduct and post it in a standard location. (URL required) [code_of_conduct]

    https://github.com/pixie-io/pixie/blob/main/CODE_OF_CONDUCT.md


    Enough for a badge!

    The project MUST clearly define and publicly document the key roles in the project and their responsibilities, including any tasks those roles must perform. It MUST be clear who has which role(s), though this might not be documented in the same way. (URL required) [roles_responsibilities]

    https://github.com/pixie-io/pixie/blob/main/GOVERNANCE.md


    Enough for a badge!

    The project MUST be able to continue with minimal interruption if any one person dies, is incapacitated, or is otherwise unable or unwilling to continue support of the project. In particular, the project MUST be able to create and close issues, accept proposed changes, and release versions of software, within a week of confirmation of the loss of support from any one individual. This MAY be done by ensuring someone else has any necessary keys, passwords, and legal rights to continue the project. Individuals who run a FLOSS project MAY do this by providing keys in a lockbox and a will providing any needed legal rights (e.g., for DNS names). (URL required) [access_continuity]

    https://github.com/pixie-io/pixie/blob/main/GOVERNANCE.md

    We also have multiple maintainers.


    Enough for a badge!

    The project SHOULD have a "bus factor" of 2 or more. (URL required) [bus_factor]

    We have > 2 admins and maintainers.

    https://github.com/pixie-io/pixie/people


  • Documentation


    Enough for a badge!

    The project MUST have a documented roadmap that describes what the project intends to do and not do for at least the next year. (URL required) [documentation_roadmap]

    https://docs.px.dev/about-pixie/roadmap Roadmap: https://docs.google.com/spreadsheets/d/1tS9BxGaiu8P2Iq-ucxhicyteOH2hjVDRR80jCrsBANw/edit


    Enough for a badge!

    The project MUST include documentation of the architecture (aka high-level design) of the software produced by the project. If the project does not produce software, select "not applicable" (N/A). (URL required) [documentation_architecture]

    https://docs.px.dev/about-pixie/what-is-pixie/


    Enough for a badge!

    The project MUST document what the user can and cannot expect in terms of security from the software produced by the project (its "security requirements"). (URL required) [documentation_security]

    We publish our security guidelines at https://github.com/pixie-io/pixie/blob/main/SECURITY.md


    Enough for a badge!

    The project MUST provide a "quick start" guide for new users to help them quickly do something with the software. (URL required) [documentation_quick_start]

    https://docs.px.dev/installing-pixie/install-guides


    Enough for a badge!

    The project MUST make an effort to keep the documentation consistent with the current version of the project results (including software produced by the project). Any known documentation defects making it inconsistent MUST be fixed. If the documentation is generally current, but erroneously includes some older information that is no longer true, just treat that as a defect, then track and fix as usual. [documentation_current]

    A large part of our documentation is generated from code : https://docs.px.dev/reference/pxl/


    Enough for a badge!

    The project repository front page and/or website MUST identify and hyperlink to any achievements, including this best practices badge, within 48 hours of public recognition that the achievement has been attained. (URL required) [documentation_achievements]

    We list badges on our github front page including the SSF badge: https://github.com/pixie-io/pixie


  • Accessibility and internationalization


    Enough for a badge!

    The project (both project sites and project results) SHOULD follow accessibility best practices so that persons with disabilities can still participate in the project and use the project results where it is reasonable to do so. [accessibility_best_practices]

    For the Pixie UI: we use Google Chrome Lighthouse to audit our accessibility and try to improve it whenever possible. Pixie also has a CLI, an API and a plugin system that allows users to interact with Pixie and the data collected by Pixie in a system of their choice. This means that users can use other tools that meet their accessibility needs while also benefiting from the data collected by Pixie.


    Enough for a badge!

    The software produced by the project SHOULD be internationalized to enable easy localization for the target audience's culture, region, or language. If internationalization (i18n) does not apply (e.g., the software doesn't generate text intended for end-users and doesn't sort human-readable text), select "not applicable" (N/A). [internationalization]

    The data collected by Pixie such as the request/response body etc is simply the data on the wire and supports any encoding, language etc. The PxL scripts provided by Pixie, and the BPF/BCC scripts only support English but there hasn't been any demand for l10n/i18n support in those areas.


  • Other


    Enough for a badge!

    If the project sites (website, repository, and download URLs) store passwords for authentication of external users, the passwords MUST be stored as iterated hashes with a per-user salt by using a key stretching (iterated) algorithm (e.g., Argon2id, Bcrypt, Scrypt, or PBKDF2). If the project sites do not store passwords for this purpose, select "not applicable" (N/A). [sites_password_security]

    We use SOPS for all our keys.


  • Previous versions


    Enough for a badge!

    The project MUST maintain the most often used older versions of the product or provide an upgrade path to newer versions. If the upgrade path is difficult, the project MUST document how to perform the upgrade (e.g., the interfaces that have changed and detailed suggested steps to help upgrade). [maintenance_or_update]

    We support auto-upgrades various versions and follow semantic versioning.


  • Bug-reporting process


    Enough for a badge!

    The project MUST use an issue tracker for tracking individual issues. [report_tracker]

    https://github.com/pixie-io/pixie/issues


  • Vulnerability report process


    Enough for a badge!

    The project MUST give credit to the reporter(s) of all vulnerability reports resolved in the last 12 months, except for the reporter(s) who request anonymity. If there have been no vulnerabilities resolved in the last 12 months, select "not applicable" (N/A). (URL required) [vulnerability_report_credit]

    We have not received any vulnerability reports in the last 12 months.


    Enough for a badge!

    The project MUST have a documented process for responding to vulnerability reports. (URL required) [vulnerability_response_process]

    https://github.com/pixie-io/pixie/blob/main/SECURITY.md


  • Coding standards


    Enough for a badge!

    The project MUST identify the specific coding style guides for the primary languages it uses, and require that contributions generally comply with it. (URL required) [coding_standards]

    https://github.com/pixie-io/pixie/tree/main/styleguide


    Enough for a badge!

    The project MUST automatically enforce its selected coding style(s) if there is at least one FLOSS tool that can do so in the selected language(s). [coding_standards_enforced]

    We run many linters to ensure that code adheres to the styleguide above: https://github.com/pixie-io/pixie/blob/main/.arclint


  • Working build system


    Enough for a badge!

    Build systems for native binaries MUST honor the relevant compiler and linker (environment) variables passed in to them (e.g., CC, CFLAGS, CXX, CXXFLAGS, and LDFLAGS) and pass them to compiler and linker invocations. A build system MAY extend them with additional flags; it MUST NOT simply replace provided values with its own. If no native binaries are being generated, select "not applicable" (N/A). [build_standard_variables]

    We use Bazel for the build system which supports compiler and linker variables passed in.


    Enough for a badge!

    The build and installation system SHOULD preserve debugging information if they are requested in the relevant flags (e.g., "install -s" is not used). If there is no build or installation system (e.g., typical JavaScript libraries), select "not applicable" (N/A). [build_preserve_debug]

    We use bazel for our builds. Bazel supports various compilation modes which include debug, opt and fastbuild. https://bazel.build/docs/user-manual#compilation-mode The binaries and images we ship are compiled with opt, but users may chose to build and deploy debug versions of pixie if they so choose.


    Enough for a badge!

    The build system for the software produced by the project MUST NOT recursively build subdirectories if there are cross-dependencies in the subdirectories. If there is no build or installation system (e.g., typical JavaScript libraries), select "not applicable" (N/A). [build_non_recursive]

    We use Bazel for our build system which does not recursively build subdirectories.


    Enough for a badge!

    The project MUST be able to repeat the process of generating information from source files and get exactly the same bit-for-bit result. If no building occurs (e.g., scripting languages where the source code is used directly instead of being compiled), select "not applicable" (N/A). [build_repeatable]

    Bazel builds inside a sandbox, so generating information from source files will get the same bit-for-bit result.


  • Installation system


    Enough for a badge!

    The project MUST provide a way to easily install and uninstall the software produced by the project using a commonly-used convention. [installation_common]

    We provide a CLI which users can use to deploy and delete Pixie. We also offer other popular installation methods such as Helm and manifest. https://docs.px.dev/installing-pixie/install-schemes/


    Enough for a badge!

    The installation system for end-users MUST honor standard conventions for selecting the location where built artifacts are written to at installation time. For example, if it installs files on a POSIX system it MUST honor the DESTDIR environment variable. If there is no installation system or no standard convention, select "not applicable" (N/A). [installation_standard_variables]

    Deploying Pixie to your cluster follows the conventions in Kubernetes, for example, deploying to a specified namespace.


    Enough for a badge!

    The project MUST provide a way for potential developers to quickly install all the project results and support environment necessary to make changes, including the tests and test environment. This MUST be performed with a commonly-used convention. [installation_development_quick]

    We provide a docker image which users can use to instantly get into a functioning dev environment. This is documented in https://github.com/pixie-io/pixie/blob/main/DEVELOPMENT.md


  • Externally-maintained components


    Enough for a badge!

    The project MUST list external dependencies in a computer-processable way. (URL required) [external_dependencies]

    https://storage.googleapis.com/pixie-dev-public/oss-licenses/latest.json


    Enough for a badge!

    Projects MUST monitor or periodically check their external dependencies (including convenience copies) to detect known vulnerabilities, and fix exploitable vulnerabilities or verify them as unexploitable. [dependency_monitoring]

    We use snyk + dependabot.


    Enough for a badge!

    The project MUST either:
    1. make it easy to identify and update reused externally-maintained components; or
    2. use the standard components provided by the system or programming language.
    Then, if a vulnerability is found in a reused component, it will be easy to update that component. [updateable_reused_components]

    We use bazel for managing and pulling in dependencies.


    Enough for a badge!

    The project SHOULD avoid using deprecated or obsolete functions and APIs where FLOSS alternatives are available in the set of technology it uses (its "technology stack") and to a supermajority of the users the project supports (so that users have ready access to the alternative). [interfaces_current]

    Pixie uses linters and other static analysis rules to enforce that all the code meets a high standard and doesn't rely on deprecated APIs.


  • Automated test suite


    Enough for a badge!

    An automated test suite MUST be applied on each check-in to a shared repository for at least one branch. This test suite MUST produce a report on test success or failure. [automated_integration_testing]

    We run automated tests before merging each PR, and after each PR is merged: https://github.com/pixie-io/pixie/actions/workflows/build_and_test.yaml


    Enough for a badge!

    The project MUST add regression tests to an automated test suite for at least 50% of the bugs fixed within the last six months. [regression_tests_added50]

    It is a requirement to add new automated tests when fixing bugs. This is a part of our contribution checklist: https://github.com/pixie-io/pixie/blob/main/CONTRIBUTING.md#contribution-checklist


    Enough for a badge!

    The project MUST have FLOSS automated test suite(s) that provide at least 80% statement coverage if there is at least one FLOSS tool that can measure this criterion in the selected language. [test_statement_coverage80]

    We have 80% coverage for large parts of our codebase. There are a few components that don't have coverage that is reported at 80%, here's why: - Our BPF tests require root/QEMU to run and as a result it's extremely challenging to gather coverage info for those tests. Hence the coverage reported for stirling is underreported. - Our operator and CLI components are difficult to test in an automated fashion since they rely on a lot of external dependencies and user input. Their functionality is covered via manual testing.


  • New functionality testing


    Enough for a badge!

    The project MUST have a formal written policy that as major new functionality is added, tests for the new functionality MUST be added to an automated test suite. [test_policy_mandated]

    This is a requirement as a part of our contribution checklist: https://github.com/pixie-io/pixie/blob/main/CONTRIBUTING.md#contribution-checklist


    Enough for a badge!

    The project MUST include, in its documented instructions for change proposals, the policy that tests are to be added for major new functionality. [tests_documented_added]

    Test are required part of changes, though exemptions are allowed under certain circumstances. Code coverage is tracked.


  • Warning flags


    Enough for a badge!

    Projects MUST be maximally strict with warnings in the software produced by the project, where practical. [warnings_strict]

    We try to always address warnings. Any exceptions are noted with comments for why the exception is necessary.


  • Secure development knowledge


    Enough for a badge!

    The project MUST implement secure design principles (from "know_secure_design"), where applicable. If the project is not producing software, select "not applicable" (N/A). [implement_secure_design]

    We default to using mTLS in our services and TLS with client communication. We use end-to-end encryption for mitigating any MITM leaks. We run security scanners to look for know vulnerabilities on every commit.


  • Use basic good cryptographic practices

    Note that some software does not need to use cryptographic mechanisms. If your project produces software that (1) includes, activates, or enables encryption functionality, and (2) might be released from the United States (US) to outside the US or to a non-US-citizen, you may be legally required to take a few extra steps. Typically this just involves sending an email. For more information, see the encryption section of Understanding Open Source Technology & US Export Controls.

    Enough for a badge!

    The default security mechanisms within the software produced by the project MUST NOT depend on cryptographic algorithms or modes with known serious weaknesses (e.g., the SHA-1 cryptographic hash algorithm or the CBC mode in SSH). [crypto_weaknesses]

    Code reviews are put in place to ensure that the project does not depend on algorithms or modes with known serious weaknesses.


    Enough for a badge!

    The project SHOULD support multiple cryptographic algorithms, so users can quickly switch if one is broken. Common symmetric key algorithms include AES, Twofish, and Serpent. Common cryptographic hash algorithm alternatives include SHA-2 (including SHA-224, SHA-256, SHA-384 AND SHA-512) and SHA-3. [crypto_algorithm_agility]

    Enough for a badge!

    The project MUST support storing authentication credentials (such as passwords and dynamic tokens) and private cryptographic keys in files that are separate from other information (such as configuration files, databases, and logs), and permit users to update and replace them without code recompilation. If the project never processes authentication credentials and private cryptographic keys, select "not applicable" (N/A). [crypto_credential_agility]

    We rely on Kubernetes secrets, which is the accepted convention for applications running on Kubernetes.


    Enough for a badge!

    The software produced by the project SHOULD support secure protocols for all of its network communications, such as SSHv2 or later, TLS1.2 or later (HTTPS), IPsec, SFTP, and SNMPv3. Insecure protocols such as FTP, HTTP, telnet, SSLv3 or earlier, and SSHv1 SHOULD be disabled by default, and only enabled if the user specifically configures it. If the software produced by the project does not support network communications, select "not applicable" (N/A). [crypto_used_network]

    We use TLS1.2 for all network communications.


    Enough for a badge!

    The software produced by the project SHOULD, if it supports or uses TLS, support at least TLS version 1.2. Note that the predecessor of TLS was called SSL. If the software does not use TLS, select "not applicable" (N/A). [crypto_tls12]

    We use TLS 1.2+, and the dependencies we use also use TLS 1.2+.


    Enough for a badge!

    The software produced by the project MUST, if it supports TLS, perform TLS certificate verification by default when using TLS, including on subresources. If the software does not use TLS, select "not applicable" (N/A). [crypto_certificate_verification]

    Default deploys of Pixie will deploy Pixie with TLS and TLS certificate verification.


    Enough for a badge!

    The software produced by the project MUST, if it supports TLS, perform certificate verification before sending HTTP headers with private information (such as secure cookies). If the software does not use TLS, select "not applicable" (N/A). [crypto_verification_private]

    TLS verification is done at the Cloud ingress layer and non TLS requests are completely blocked. We also use mTLS for communication between our services.


  • Secure release


    Enough for a badge!

    The project MUST cryptographically sign releases of the project results intended for widespread use, and there MUST be a documented process explaining to users how they can obtain the public signing keys and verify the signature(s). The private key for these signature(s) MUST NOT be on site(s) used to directly distribute the software to the public. If releases are not intended for widespread use, select "not applicable" (N/A). [signed_releases]

    We RSA sign all our release artifacts published on github. The detached signatures are published and can be verified against our GPG key available at https://px.dev/buildbot_public_key.asc

    We use cosign to sign all our container images. They signature for those can be verified by using cosign and checking against our public key https://px.dev/cosign.pub For example: cosign verify --key=https://px.dev/cosign.pub gcr.io/pixie-oss/pixie-prod/vizier/pem_image:0.13.6 verifies the signature for that image against our public key.


    Enough for a badge!

    It is SUGGESTED that in the version control system, each important version tag (a tag that is part of a major release, minor release, or fixes publicly noted vulnerabilities) be cryptographically signed and verifiable as described in signed_releases. [version_tags_signed]

    Our release are signed as a part of the release build: https://github.com/pixie-io/pixie/releases


  • Other security issues


    Enough for a badge!

    The project results MUST check all inputs from potentially untrusted sources to ensure they are valid (an *allowlist*), and reject invalid inputs, if there are any restrictions on the data at all. [input_validation]

    We don't accept any inputs from arbitrary sources.


    Enough for a badge!

    Hardening mechanisms SHOULD be used in the software produced by the project so that software defects are less likely to result in security vulnerabilities. [hardening]

    We use strict compiler flags (see https://github.com/pixie-io/pixie/blob/9dceacc9657181bb978559c0540d5e8779971a2b/bazel/cc_toolchains/gcc.bzl#L57C1-L58) and run address sanitizers, thread sanitizers, race detectors (see https://github.com/pixie-io/pixie/blob/9dceacc9657181bb978559c0540d5e8779971a2b/.bazelrc#L142-L179).

    For the user facing components, we follow OWASP guidelines to set appropriate headers etc.


    Enough for a badge!

    The project MUST provide an assurance case that justifies why its security requirements are met. The assurance case MUST include: a description of the threat model, clear identification of trust boundaries, an argument that secure design principles have been applied, and an argument that common implementation security weaknesses have been countered. (URL required) [assurance_case]

    We are working through the process with TAG-Security. Tracking Issue: https://github.com/cncf/tag-security/issues/1068 Assessment Doc: https://docs.google.com/document/d/1H4C9uGVxLsLZijxIem_vwhOWLupBqtlwMduI2b3UL8M/edit#heading=h.arjzsoy5mukn


  • Static code analysis


    Enough for a badge!

    The project MUST use at least one static analysis tool with rules or approaches to look for common vulnerabilities in the analyzed language or environment, if there is at least one FLOSS tool that can implement this criterion in the selected language. [static_analysis_common_vulnerabilities]

    We use snyk and yarn audit to look for common vulnerabilities.


  • Dynamic code analysis


    Enough for a badge!

    If the software produced by the project includes software written using a memory-unsafe language (e.g., C or C++), then at least one dynamic tool (e.g., a fuzzer or web application scanner) MUST be routinely used in combination with a mechanism to detect memory safety problems such as buffer overwrites. If the project does not produce software written in a memory-unsafe language, choose "not applicable" (N/A). [dynamic_analysis_unsafe]

    asan, msan



This data is available under the Creative Commons Attribution version 3.0 or later license (CC-BY-3.0+). All are free to share and adapt the data, but must give appropriate credit. Please credit aimichelle and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: aimichelle.
Entry created on 2021-07-07 00:57:35 UTC, last updated on 2023-06-26 17:35:35 UTC. Last achieved passing badge on 2022-04-21 03:55:05 UTC.

Back