Squey

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 7021 is in_progress Here is how to embed it:

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

        

 Basics 12/13

  • Identification

    Squey is an open-source visualization software designed to interactively explore and understand large amounts of tabular data.

    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]

    La información sobre cómo contribuir DEBE explicar el proceso de contribución (por ejemplo, ¿se utilizan "pull requests" en el proyecto?) (URL required) [contribution]

    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]
  • FLOSS license

    What license(s) is the project released under?



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

    https://gitlab.com/squey/squey/-/blob/main/LICENSE The MIT 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 MIT 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]
  • Documentation


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

    An exhaustive reference manual is located here : https://doc.squey.org



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

  • Other


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

    The project website is hosted here : https://squey.org

    The reference manual is hosted here : https://doc.squey.org

    The project source code is hosted here : https://gitlab.com/squey/squey and mirrored here https://github.com/squey/squey

    The project reference manual is hosted here : https://doc.squey.org



    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]

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

    The code comments as well as the software documentation are redacted in english and bugs are submitted in english using the bug tracking system.



    The project MUST be maintained. [maintained]

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



  • Repositorio público para el control de versiones de código fuente


    El proyecto DEBE tener un repositorio público para el control de versiones de código fuente que sea legible públicamente y tenga URL. [repo_public]

    El repositorio fuente del proyecto DEBE rastrear qué cambios se realizaron, quién realizó los cambios y cuándo se realizaron los cambios. [repo_track]

    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]

    Any feature branch which Merge Request contains the label "action::flatpak_export" is exposed on the flatpak development repository :

    flatpak remote-add squey_dev --no-gpg-verify https://inspector-cassiopee.ensam.eu/flatpak/

    flatpak remote-ls squey_dev

    flatpak install squey_dev org.squey.Squey//name_of_the_feature_branch



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

    The project is stored on gitlab.com which uses git as its version control system


  • Numeración única de versión


    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]
  • Notas de lanzamiento


    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]

    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]

    There have been no publicly known vulnerabilities.


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

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

    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]

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

    El proyecto DEBE tener un archivo públicamente disponible para informes y respuestas para búsquedas posteriores. (URL required) [report_archive]
  • Proceso de informe de vulnerabilidad


    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]

    Gitlab issue tracking system support confidential issues ("This issue is confidential and should only be visible to team members with at least Reporter access")

    https://gitlab.com/squey/squey/-/issues/new



    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]

    There have been no vulnerabilities reported in the last 6 months.


  • Working build system


    Si el software generado por el proyecto requiere ser construido para su uso, el proyecto DEBE proporcionar un sistema de compilación que pueda satisfactoriamente reconstruir automáticamente el software a partir del código fuente. [build]

    The project is using BuildStream containerization system to handle all the needed dependencies : https://gitlab.com/squey/squey/-/tree/main#development



    Se SUGIERE que se utilicen herramientas comunes para construir el software. [build_common_tools]

    The project is built using CMake and BuildStream



    El proyecto DEBERÍA ser construible usando solo herramientas FLOSS. [build_floss_tools]

    The project is built upon the FLOSS freedesktop SDK and all the additional dependencies are FLOSS projects : https://gitlab.com/squey/squey/-/tree/main/buildstream/elements


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

    The CI/CD script : https://gitlab.com/squey/squey/-/blob/main/.gitlab-ci.yml#L26

    The testsuite result of the release 4.9.10 of the project : https://gitlab.com/squey/squey/-/jobs/3518248773



    Un conjunto de pruebas DEBERÍA ser invocable de forma estándar para ese lenguaje. [test_invocation]

    ninja squey_run_testsuite



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


    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]

    The CI/CD script which run the testsuite for each Merge Request : https://gitlab.com/squey/squey/-/blob/main/.gitlab-ci.yml#L26


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

    No new features will be merged to the main branch if they do not implement the proper test units with sufficient code coverage.



    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]

    A code coverage report is updated daily on the default branch : https://squey.gitlab.io/squey/code_coverage_report/



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

    It is specified on the CONTRIBUTING.md document that the code should be tested : https://gitlab.com/squey/squey/-/blob/main/CONTRIBUTING.md


  • Banderas de advertencia


    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]

    The project is compiled using the compilers "-Wall" and "-Wextra" options that enables all warnings : https://gitlab.com/squey/squey/-/blob/main/CMakeCompilers.txt#L16



    El proyecto DEBE abordar las advertencias. [warnings_fixed]

    The CI/CD script is treating warnings as error ("-Werror") on each feature branch so that no warnings could be introduced to the main branch : https://gitlab.com/squey/squey/-/blob/main/buildstream/elements/squey.bst#L100

    However, this behavior is not enforced locally on development builds in order to avoid disruption when developing new features or fixing bugs. See : https://embeddedartistry.com/blog/2017/05/22/werror-is-not-your-friend/



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

    Two compilers (g++ and clang++) are used to build the project in order to have the best warnings coverage possible.


  • Conocimiento de desarrollo seguro


    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]

    I have read and understood Saltzer & Schroeder "The Protection of Information in Computer Systems" tutorial paper.



    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]

    CWE-787 (Out-of-bounds Write) -> use of STL algorithms CWE-416 (Use After Free) -> use of smart pointers CWE-20 (Improper Input Validation) -> use of Qt specialized fields widgets CWE-125 (Out-of-bounds Read) -> use of STL algorithms CWE-476 (NULL Pointer Dereference) -> use references or smart pointer instead of pointers when possible, raise exceptions instead of returning nullptr, write tests CWE-798 (Use of Hard-coded Credentials) -> Gitlab instance is monitored by GitGuardian


  • Use buenas prácticas criptográficas

    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]

    The software has no need to directly use cryptographic capabilities.



    Si el software producido por el proyecto es una aplicación o una librería, y su propósito principal no es implementar criptografía, entonces DEBE SOLAMENTE invocar un software específicamente diseñado para implementar funciones criptográficas; NO DEBERÍA volver a implementar el suyo. [crypto_call]

    The software has no need to directly use cryptographic capabilities.



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

    The software has no need to directly use cryptographic capabilities.



    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]

    The software has no need to directly use cryptographic capabilities.



    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]

    The software has no need to directly use cryptographic capabilities.



    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]

    The software has no need to directly use cryptographic capabilities.



    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]

    The software has no need to directly use cryptographic capabilities.



    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 need to directly use cryptographic capabilities.



    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 has no need to directly use cryptographic capabilities.


  • Entrega garantizada contra ataques de hombre en el medio (MITM)


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

    None of the websites used for the software delivery are using plain HTTP :

    Windows installer hosted on Gitlab pages : https://squey.gitlab.io/squey/squey-inspector_installer.exe

    Flathub project page : https://flathub.org/apps/details/org.squey.Squey

    Flatpak development repository : https://inspector-cassiopee.ensam.eu/flatpak

    Plus, the flatpak package is signed with a private GPG key to avoid any tempering : https://gitlab.com/inendi/inspector/-/blob/main/.gitlab-ci.yml#L51



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

    No cryptographic hash is retrieved over http.


  • Vulnerabilidades públicamente conocidas corregidas


    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]

    There is no unpatched vulnerabilities of medium or higher severity that have been publicly known for more than 60 days.



    Projects SHOULD fix all critical vulnerabilities rapidly after they are reported. [vulnerabilities_critical_fixed]
  • Otros problemas de seguridad


    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]

    Each commits pushed to a branch are scanned in real time using gitleaks : https://gitlab.com/squey/squey/-/blob/main/.gitlab-ci.yml#L149 The whole Gitlab instance group of the project is also monitored by GitGuardian.


  • Análisis estático de código


    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]

    An Code Quality target is enabled in the CI/CD script which execute "cppcheck" daily : https://gitlab.com/squey/squey/-/blob/main/.gitlab-ci.yml#L149

    Code quality daily report : https://squey.gitlab.io/squey/code_quality_report/



    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]

    An SAST target is enabled in the CI/CD script which executes "flawfinder" and "semgrep" daily : https://gitlab.com/squey/squey/-/blame/main/.gitlab-ci.yml#L127

    The SAST vulnerability report can be found here : https://gitlab.com/squey/squey/-/security/vulnerability_report



    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]


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

    A scheduled pipeline running Code Quality "cppcheck" and SAST "flawfinder" and "semgrep" tools is executed daily : https://gitlab.com/squey/squey/-/pipeline_schedules


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


    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]


    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]

    The daily code coverage testsuite in ran in "Debug" mode (ie. without NDEBUG being defined)



    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]


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 Jean-Baptiste Leonesio and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Jean-Baptiste Leonesio.
Entry created on 2023-02-13 15:40:08 UTC, last updated on 2024-05-08 12:10:36 UTC.

Back