VAST

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 6366 is passing Here is how to embed it:

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

        

 Basics 13/13

  • Identification

    The network telemetry engine for data-driven security investigations.

    What programming language(s) are used to implement the project?
  • Basic project website content


    The project website MUST succinctly describe what the software does (what problem does it solve?). [description_good]

    The project website MUST provide information on how to: obtain, provide feedback (as bug reports or enhancements), and contribute to the software. [interact]

    The information on how to contribute MUST explain the contribution process (e.g., are pull requests used?) (URL required) [contribution]

    Projects on GitHub by default use issues and pull requests, as encouraged by documentation such as https://guides.github.com/activities/contributing-to-open-source/.

    See also our contributing guide https://vast.io/docs/develop-vast/contributing



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

    This is explained in our contributing guide https://vast.io/docs/develop-vast/contributing


  • FLOSS license

    What license(s) is the project released under?



    The software produced by the project MUST be released as FLOSS. [floss_license]

    The BSD-3-Clause license is approved by the Open Source Initiative (OSI).



    It is SUGGESTED that any required license(s) for the software produced by the project be approved by the Open Source Initiative (OSI). [floss_license_osi]

    The BSD-3-Clause license is approved by the Open Source Initiative (OSI).



    The project MUST post the license(s) of its results in a standard location in their source repository. (URL required) [license_location]

    Non-trivial license location file in repository: https://github.com/tenzir/vast/blob/master/LICENSE.


  • Documentation


    The project MUST provide basic documentation for the software produced by the project. [documentation_basics]

    The documentation is available at https://vast.io/docs/about-vast and in version control directly in the tenzir/vast GitHub repository in the web/ directory.



    The project MUST provide reference documentation that describes the external interface (both input and output) of the software produced by the project. [documentation_interface]

    This is all throughout the docs, see for example https://vast.io/docs/use-vast/ingest


  • Other


    The project sites (website, repository, and download URLs) MUST support HTTPS using TLS. [sites_https]

    Given only https: URLs.



    The project MUST have one or more mechanisms for discussion (including proposed changes and issues) that are searchable, allow messages and topics to be addressed by URL, enable new people to participate in some of the discussions, and do not require client-side installation of proprietary software. [discussion]

    GitHub supports discussions on issues and pull requests.



    The project SHOULD provide documentation in English and be able to accept bug reports and comments about code in English. [english]

    We have guidelines for how to provide documentation at https://vast.io/docs/develop-vast/contributing/documentation



    The project MUST be maintained. [maintained]

    The project is actively maintained on GitHub; I am the mainly responsible maintainer currently.



(Advanced) What other users have additional rights to edit this badge entry? Currently: []



  • Public version-controlled source repository


    The project MUST have a version-controlled source repository that is publicly readable and has a URL. [repo_public]

    Repository on GitHub, which provides public git repositories with URLs.



    The project's source repository MUST track what changes were made, who made the changes, and when the changes were made. [repo_track]

    Repository on GitHub, which uses git. git can track the changes, who made them, and when they were made.



    To enable collaborative review, the project's source repository MUST include interim versions for review between releases; it MUST NOT include only final releases. [repo_interim]

    We cut release candidates with a feature freeze period until the actual release, see anything with a -rc* suffix on https://github.com/tenzir/vast/releases



    It is SUGGESTED that common distributed version control software be used (e.g., git) for the project's source repository. [repo_distributed]

    Repository on GitHub, which uses git. git is distributed.


  • Unique version numbering


    The project results MUST have a unique version identifier for each release intended to be used by users. [version_unique]

    It is SUGGESTED that the Semantic Versioning (SemVer) or Calendar Versioning (CalVer) version numbering format be used for releases. It is SUGGESTED that those who use CalVer include a micro level value. [version_semver]


    It is SUGGESTED that projects identify each release within their version control system. For example, it is SUGGESTED that those using git identify each release using git tags. [version_tags]

    We use annotated tags for our releases at https://github.com/tenzir/vast/releases


  • Release notes


    The project MUST provide, in each release, release notes that are a human-readable summary of major changes in that release to help users determine if they should upgrade and what the upgrade impact will be. The release notes MUST NOT be the raw output of a version control log (e.g., the "git log" command results are not release notes). Projects whose results are not intended for reuse in multiple locations (such as the software for a single website or service) AND employ continuous delivery MAY select "N/A". (URL required) [release_notes]

    Non-trivial release notes file in repository: https://github.com/tenzir/vast/blob/master/CHANGELOG.md.

    There is an additional written summary in https://github.com/tenzir/vast/releases and in the blog at https://vast.io/blog



    The release notes MUST identify every publicly known run-time vulnerability fixed in this release that already had a CVE assignment or similar when the release was created. This criterion may be marked as not applicable (N/A) if users typically cannot practically update the software themselves (e.g., as is often true for kernel updates). This criterion applies only to the project results, not to its dependencies. If there are no release notes or there have been no publicly known vulnerabilities, choose N/A. [release_notes_vulns]

    We did not have a CVE yet, but we do have a security policy at https://github.com/tenzir/vast/security/policy


  • Bug-reporting process


    The project MUST provide a process for users to submit bug reports (e.g., using an issue tracker or a mailing list). (URL required) [report_process]

    See bug report template at https://github.com/tenzir/vast/issues/new/choose, and



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

    There is an issue tracker at https://github.com/tenzir/vast/issues, and there is an additional issue tracker that is not open to the public. We are looking to move to an open roadmap.



    The project MUST acknowledge a majority of bug reports submitted in the last 2-12 months (inclusive); the response need not include a fix. [report_responses]

    See pull requests labeled 'bug' that were recently merged: https://github.com/tenzir/vast/pulls?q=is%3Apr+is%3Aclosed+label%3Abug



    The project SHOULD respond to a majority (>50%) of enhancement requests in the last 2-12 months (inclusive). [enhancement_responses]

    Most of the requests come in via our Community Slack channel at slack.tenzir.com; there are no public metrics on this, but >90% of the requests of the past year were done within 3 months.



    The project MUST have a publicly available archive for reports and responses for later searching. (URL required) [report_archive]

    Most of the communication takes place in GitHub pull requests directly on https://github.com/tenzir/vast/pulls


  • Vulnerability report process


    The project MUST publish the process for reporting vulnerabilities on the project site. (URL required) [vulnerability_report_process]

    If private vulnerability reports are supported, the project MUST include how to send the information in a way that is kept private. (URL required) [vulnerability_report_private]

    The project's initial response time for any vulnerability report received in the last 6 months MUST be less than or equal to 14 days. [vulnerability_report_response]

    Did not have any vuln reports in the past 6 months.


  • Working build system


    If the software produced by the project requires building for use, the project MUST provide a working build system that can automatically rebuild the software from source code. [build]

    Non-trivial build file in repository: https://github.com/tenzir/vast/blob/master/CMakeLists.txt.



    It is SUGGESTED that common tools be used for building the software. [build_common_tools]

    Non-trivial build file in repository: https://github.com/tenzir/vast/blob/master/CMakeLists.txt.



    The project SHOULD be buildable using only FLOSS tools. [build_floss_tools]

    All dependencies are open-source; a full list is available at https://vast.io/docs/setup-vast/build#dependencies


  • Automated test suite


    The project MUST use at least one automated test suite that is publicly released as FLOSS (this test suite may be maintained as a separate FLOSS project). The project MUST clearly show or document how to run the test suite(s) (e.g., via a continuous integration (CI) script or via documentation in files such as BUILD.md, README.md, or CONTRIBUTING.md). [test]

    There is extensive CI that is required to succeed before a PR may be merged; every change has to go through the PR workflow. See here for a list of past runs: https://github.com/tenzir/vast/actions



    A test suite SHOULD be invocable in a standard way for that language. [test_invocation]

    The testing is invocable using cmake; run the build targets 'integration' to run integration tests, and 'test' to run unit tests.



    It is SUGGESTED that the test suite cover most (or ideally all) the code branches, input fields, and functionality. [test_most]

    There's an ever increasing test coverage of ~80%. We're in the process of adding this to our CI.



    It is SUGGESTED that the project implement continuous integration (where new or changed code is frequently integrated into a central code repository and automated tests are run on the result). [test_continuous_integration]

    There is extensive CI that is required to succeed before a PR may be merged; every change has to go through the PR workflow. See here for a list of past runs: https://github.com/tenzir/vast/actions


  • New functionality testing


    The project MUST have a general policy (formal or not) that as major new functionality is added to the software produced by the project, tests of that functionality should be added to an automated test suite. [test_policy]

    This is part of the review workflow. No change gets merged without having at least one approval from the team, with an explanation on how it was tested.



    The project MUST have evidence that the test_policy for adding tests has been adhered to in the most recent major changes to the software produced by the project. [tests_are_added]

    Should be visible from past pull requests, e.g., see the review comment history on this recent PR: https://github.com/tenzir/vast/pull/2493



    It is SUGGESTED that this policy on adding tests (see test_policy) be documented in the instructions for change proposals. [tests_documented_added]

    There is some documentation on this throughout our contribution guide at https://vast.io/docs/develop-vast/contributing/


  • Warning flags


    The project MUST enable one or more compiler warning flags, a "safe" language mode, or use a separate "linter" tool to look for code quality errors or common simple mistakes, if there is at least one FLOSS tool that can implement this criterion in the selected language. [warnings]

    We enable -Wall -Wextra and a few other warnings by default.

    See also: https://github.com/tenzir/vast/blob/017de2f9ec156c80655ec6ac3765a2476a2142b3/CMakeLists.txt#L304-L316



    The project MUST address warnings. [warnings_fixed]

    We build using -Werror in CI, which is mandatory for passing. This causes CI to treat warnings like errors and to fail the CI run. This enforces that the project builds on master without warnings.

    See also: https://github.com/tenzir/vast/blob/017de2f9ec156c80655ec6ac3765a2476a2142b3/CMakeLists.txt#L304-L316



    It is SUGGESTED that projects be maximally strict with warnings in the software produced by the project, where practical. [warnings_strict]

    See here for the list of enabled warnings in our CMake configuration: https://github.com/tenzir/vast/blob/017de2f9ec156c80655ec6ac3765a2476a2142b3/CMakeLists.txt#L304-L316


  • Secure development knowledge


    The project MUST have at least one primary developer who knows how to design secure software. (See ‘details’ for the exact requirements.) [know_secure_design]

    This should be met by the four most senior developers on the team. GitHub usernames are mavam, tobim, dominiklohmann, lava

    Not really sure how to "prove" this.



    At least one of the project's primary developers MUST know of common kinds of errors that lead to vulnerabilities in this kind of software, as well as at least one method to counter or mitigate each of them. [know_common_errors]

    This should be met by the four most senior developers on the team. GitHub usernames are mavam, tobim, dominiklohmann, lava

    Not really sure how to "prove" this.


  • 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.

    The software produced by the project MUST use, by default, only cryptographic protocols and algorithms that are publicly published and reviewed by experts (if cryptographic protocols and algorithms are used). [crypto_published]

    We only re-use cryptographic routines from OpenSSL and do not implement them ourselves.



    If the software produced by the project is an application or library, and its primary purpose is not to implement cryptography, then it SHOULD only call on software specifically designed to implement cryptographic functions; it SHOULD NOT re-implement its own. [crypto_call]

    We only use cryptographic functions via OpenSSL.



    All functionality in the software produced by the project that depends on cryptography MUST be implementable using FLOSS. [crypto_floss]

    Only cryptographic dependency is OpenSSL, which is FLOSS.



    The security mechanisms within the software produced by the project MUST use default keylengths that at least meet the NIST minimum requirements through the year 2030 (as stated in 2012). It MUST be possible to configure the software so that smaller keylengths are completely disabled. [crypto_keylength]

    This is not applicable to our project directly. We use CAF's OpenSSL layer for networking (see https://github.com/actor-framework/actor-framework), and do not implement this in VAST directly.



    The default security mechanisms within the software produced by the project MUST NOT depend on broken cryptographic algorithms (e.g., MD4, MD5, single DES, RC4, Dual_EC_DRBG), or use cipher modes that are inappropriate to the context, unless they are necessary to implement an interoperable protocol (where the protocol implemented is the most recent version of that standard broadly supported by the network ecosystem, that ecosystem requires the use of such an algorithm or mode, and that ecosystem does not offer any more secure alternative). The documentation MUST describe any relevant security risks and any known mitigations if these broken algorithms or modes are necessary for an interoperable protocol. [crypto_working]

    This is not applicable to our project directly. We use CAF's OpenSSL layer for networking (see https://github.com/actor-framework/actor-framework), and do not implement this in VAST directly.



    The default security mechanisms within the software produced by the project SHOULD 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]

    This is not applicable to our project directly. We use CAF's OpenSSL layer for networking (see https://github.com/actor-framework/actor-framework), and do not implement this in VAST directly.



    The security mechanisms within the software produced by the project SHOULD implement perfect forward secrecy for key agreement protocols so a session key derived from a set of long-term keys cannot be compromised if one of the long-term keys is compromised in the future. [crypto_pfs]

    This is not applicable to our project directly. We use CAF's OpenSSL layer for networking (see https://github.com/actor-framework/actor-framework), and do not implement this in VAST directly.



    If the software produced by the project causes the storing of 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). See also OWASP Password Storage Cheat Sheet. [crypto_password_storage]

    The software has no user authentication.



    The security mechanisms within the software produced by the project MUST generate all cryptographic keys and nonces using a cryptographically secure random number generator, and MUST NOT do so using generators that are cryptographically insecure. [crypto_random]

    The software generates no cryptographic keys.


  • Secured delivery against man-in-the-middle (MITM) attacks


    The project MUST use a delivery mechanism that counters MITM attacks. Using https or ssh+scp is acceptable. [delivery_mitm]

    The software uses CAF's OpenSSL layer for networking (see https://github.com/actor-framework/actor-framework), which uses a TCP connection with OpenSSL.



    A cryptographic hash (e.g., a sha1sum) MUST NOT be retrieved over http and used without checking for a cryptographic signature. [delivery_unsigned]

    Software does not communicate over HTTP.


  • Publicly known vulnerabilities fixed


    There MUST be no unpatched vulnerabilities of medium or higher severity that have been publicly known for more than 60 days. [vulnerabilities_fixed_60_days]

    No known public vulnerabilities.



    Projects SHOULD fix all critical vulnerabilities rapidly after they are reported. [vulnerabilities_critical_fixed]

    No known public vulnerabilities, so I assume this applies.


  • Other security issues


    The public repositories MUST NOT leak a valid private credential (e.g., a working password or private key) that is intended to limit public access. [no_leaked_credentials]

    This would be considered a vulnerability in VAST, and as far as I know there is no such thing.


  • Static code analysis


    At least one static code analysis tool (beyond compiler warnings and "safe" language modes) MUST be applied to any proposed major production release of the software before its release, if there is at least one FLOSS tool that implements this criterion in the selected language. [static_analysis]

    We use address sanitizer and thread sanitizer in all debug builds (verified in CI), and there's an option to enable undefined behavior sanitizer which passes local builds (not in CI because of timeout limitations).

    We also have a clang-tidy configuration that we follow for all newly added code; this is additionally enforced in CI.



    It is SUGGESTED that at least one of the static analysis tools used for the static_analysis criterion include rules or approaches to look for common vulnerabilities in the analyzed language or environment. [static_analysis_common_vulnerabilities]

    See for example the clang-tidy configuration https://github.com/tenzir/vast/blob/master/.clang-tidy



    All medium and higher severity exploitable vulnerabilities discovered with static code analysis MUST be fixed in a timely way after they are confirmed. [static_analysis_fixed]

    This is enforced by CI: PRs with failing checks cannot be merged.



    It is SUGGESTED that static source code analysis occur on every commit or at least daily. [static_analysis_often]

    Occurs for every PR; branch protections on GitHub ensure that PRs with failing checks cannot be merged, be that tests or static analysis failures.


  • Dynamic code analysis


    It is SUGGESTED that at least one dynamic analysis tool be applied to any proposed major production release of the software before its release. [dynamic_analysis]

    There are additional checks at runtime enforced via assertions for non-release builds. There is a suite of end-to-end tests that must pass CI here, that all run with assertions enabled: https://github.com/tenzir/vast/blob/master/vast/integration/vast_integration_suite.yaml

    We are in the process of integrating fuzzing via Code Intelligence. There's a WIP example here that we intend to upstream in the near future: https://github.com/tenzir/vast-fuzzing

    This is not currently being done before every release, but will be automated in the future.



    It is SUGGESTED that 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) 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]

    We are in the process of integrating fuzzing via Code Intelligence. There's a WIP example here that we intend to upstream in the near future: https://github.com/tenzir/vast-fuzzing



    It is SUGGESTED that the project use a configuration for at least some dynamic analysis (such as testing or fuzzing) which enables many assertions. In many cases these assertions should not be enabled in production builds. [dynamic_analysis_enable_assertions]

    All medium and higher severity exploitable vulnerabilities discovered with dynamic code analysis MUST be fixed in a timely way after they are confirmed. [dynamic_analysis_fixed]

    Assertions cause CI to fail so newly added code that causes assertions to trigger cannot be merged. In the future, we intend to run fuzzing on a schedule, with the additional internal requirement to fix problems found via fuzzing in a timely manner.



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 Dominik Lohmann and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Dominik Lohmann.
Entry created on 2022-08-16 14:11:05 UTC, last updated on 2022-08-31 08:10:44 UTC. Last achieved passing badge on 2022-08-16 15:17:17 UTC.

Back