parsec

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 4856 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

    Platform AbstRaction for SECurity service

    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 repository landing page has a description of the scope and purpose of the Parsec service, along with a link to more in-depth documentation: https://github.com/parallaxsecond/parsec



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

    The repository landing page has descriptions and links to further resources on how to obtain and use the software ( https://github.com/parallaxsecond/parsec#getting-started ) and how to contribute ( https://github.com/parallaxsecond/parsec#contributing )



    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]

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



    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]

    We have extensive guidelines for both contributors and maintainers in the Parsec book: https://parallaxsecond.github.io/parsec-book/contributing/index.html


  • FLOSS license

    What license(s) is the project released under?



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

    The Apache-2.0 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 Apache-2.0 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/parallaxsecond/parsec/blob/main/LICENSE.


  • Documentation


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

    Extensive documentation can be found at the Parsec Book website: https://parallaxsecond.github.io/parsec-book/



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

    Project documentation, including in-depth description of our service interface, can be found at the Parsec Book website: https://parallaxsecond.github.io/parsec-book/ Extra documentation for any service developers can be found at the parsec-service Rust crate documentation: https://docs.rs/parsec-service/*/parsec_service/


  • 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, pull requests and the Discussions tab. Other ways to get in touch with the project maintainers are detailed in the Parsec Community repo: https://github.com/parallaxsecond/community



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

    Documentation in English is provided at the Parsec Book website ( https://parallaxsecond.github.io/parsec-book/ ) and all discussions happen in English, be it in issues and PRs in Github, on the community Slack channel or on the weekly Zoom call (details in the community repo: https://github.com/parallaxsecond/community )



    The project MUST be maintained. [maintained]

    The project is in active development, a list of maintainers can be found here: https://github.com/parallaxsecond/parsec/blob/main/MAINTAINERS.toml



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



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

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



    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]

    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]

    All project state is held in the public repository in Github where all the development happens.



    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.


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

    Versioning for the Parsec service uses semver, which mandates unique identifiers



    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]

    All release versions are tagged appropriately in Github: https://github.com/parallaxsecond/parsec/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]

    Non-trivial release notes file in repository: https://github.com/parallaxsecond/parsec/blob/main/CHANGELOG.md.



    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]

    No publicly known vulnerabilities have so far been identified.


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

    Bugs can be reported as Github issues: https://github.com/parallaxsecond/parsec/issues



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

    Individual issues are tracked under the feature with the same name in Github: https://github.com/parallaxsecond/parsec/issues



    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]

    We strive to acknowledge and fix all bug reports as soon as possible.



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

    We acknowledge and discuss publicly all enhancement requests we get from the community.



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

    All of our reports and responses can be found under https://github.com/parallaxsecond/parsec/issues?q=is%3Aissue


  • Proceso de informe de vulnerabilidad


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

    The process for reporting vulnerabilities is described under https://github.com/parallaxsecond/parsec/security/policy



    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 process is described here: https://github.com/parallaxsecond/parsec/security/policy - we accept vulnerability reports to the maintainers email list, cncf-parsec-maintainers@lists.cncf.io



    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]

    No vulnerabilities have been 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 uses Rust, for which the Cargo toolchain can rebuild the software from source given that the correct dependencies are found locally.



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

    Cargo is the typical build tool for Rust projects.



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

    Cargo and the rest of the toolchain required is FLOSS


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

    We provide extensive documentation on our testing frameworks and how they can be used locally: https://parallaxsecond.github.io/parsec-book/parsec_service/tests/index.html All our CI framework can also be found open-source in the repository in form of scripts and tests: https://github.com/parallaxsecond/parsec/blob/main/ci.sh https://github.com/parallaxsecond/parsec/tree/main/e2e_tests Our CI pipeline is fully open-source: https://github.com/parallaxsecond/parsec/tree/main/.github/workflows https://github.com/parallaxsecond/parsec/tree/main/.circleci



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

    Testing is done in a typical way for Rust projects, with the sole difference that the testing framework resides in its own Rust crate: https://github.com/parallaxsecond/parsec/tree/main/e2e_tests



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

    We maintain CodeCov reports for the parts of the project which we can test and instrument, and the code coverage is currently around 65%: https://app.codecov.io/gh/parallaxsecond/parsec



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

    A testing policy exists for new features in our PR guidelines: https://parallaxsecond.github.io/parsec-book/contributing/pr_checklist.html



    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]

    We strive to test all new functionality when possible.

    As an example, a list of features delivered in the most recent release (0.7.0) and a description of tests implemented for them is given below: * Adding support for admin clients in the service: both the PR where the admin configuration option is added ( https://github.com/parallaxsecond/parsec/pull/316 ) and the PR where the admin operations are added ( https://github.com/parallaxsecond/parsec/pull/318 ) include testing * Adding two new providers, CryptoAuthLib, for which we had an open issue to produce a suitable testing framework ( https://github.com/parallaxsecond/parsec/pull/318 ) and the work for building the framework is ongoing; and the Trusted Services provider, which is already integrated in the testing framework ( see trusted-service-provider job in https://github.com/parallaxsecond/parsec/blob/main/.github/workflows/ci.yml ), though without code coverage checks for now.



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

    A testing policy exists for new features in our PR guidelines: https://parallaxsecond.github.io/parsec-book/contributing/pr_checklist.html


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

    We use clippy, a tool for linting and code checking packaged in the default Rust toolchain, for linting.



    El proyecto DEBE abordar las advertencias. [warnings_fixed]

    The warnings must be addressed for each change, as the clippy checks are incorporated in the CI pipeline.



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

    CI clippy checks are as strict as we could get them to be.


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

    The two main maintainers and contributors - Hugues de Valon and Ionut Mihalcea ( https://github.com/parallaxsecond/parsec/graphs/contributors ) - have experience in designing and developing secure software and have been trained for this purpose.



    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]

    The two main maintainers and contributors - Hugues de Valon and Ionut Mihalcea ( https://github.com/parallaxsecond/parsec/graphs/contributors ) - have experience in designing and developing secure software and have been trained for this purpose.


  • 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 Parsec project has a big part of its functionality involved in cryptography. However, all of the cryptographic APIs exposed or consumed by us are part of cryptographic specifications that have been devised by experts. For the APIs that we expose we also receive continuous help and feedback from experts in this field.



    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]

    Our main goal is to bridge between different cryptography APIs and interfaces. None of the cryptographic functionality that is exposed by the Parsec service is implemented by us, but is, instead, delegated to hardware backends or software implementations produced by experts.



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

    All functionality in the project is implementable as 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]

    For the cryptographic algorithms that we use internally we strive for key lengths way beyond the requirements given here, e.g. for communication with physical TPMs we aim for encryption with 256 bit AES keys. Note, however, that since our service bridges between cryptography APIs, clients of the service can actually access smaller key lengths (e.g. 1024 bit RSA keys).



    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]

    Our security mechanisms do not depend on broken cryptographic algorithms, but we do expose some as an option in our crypto API (e.g. MD5).



    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]

    No modes with security weaknesses are used in the software, but we do expose some as an option in our crypto API (e.g. SHA-1).



    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]

    No key agreement protocols are used within the service, but we do expose algorithms that do not implement perfect forward secrecy through our API.



    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]

    We do not handle passwords for our clients.



    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]

    All keys and nonces are generated using the backends that we rely on and that we can trust to be a CS(P)RNG.


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

    Our current interface is for local connections using sockets, for which we can trust the OS against MitM attacks.



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

    No such exchange exists


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

    No vulnerabilities have been reported.



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

    No vulnerabilities have been reported.


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

    There are no private credentials that could be leaked in the public repositories.


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

    Using the Rust compiler together with the clippy linter catches most (if not all) of typical vulnerabilities found in languages such as C/C++. Extra tooling for identifying such vulnerabilities is not needed (and not standard in the development process for Rust projects).



    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]

    Static analysis tools are not generally used for Rust projects.



    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]

    Static analysis tools are not generally used for Rust projects.



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

    Static analysis tools are not generally used for Rust projects.


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

    Fuzz testing has been done previously, but not in a consistent manner.



    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]

    Project is written in memory-safe language.



    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]

    Fuzz testing has been done previously, but not in a consistent manner. Generally, assertions do not need to be enabled as the Rust language enforces a wide range of tests and checks by default. A new issues has been created to look into how we could instrument our code for testing: https://github.com/parallaxsecond/parsec/issues/418 . Fuzz testing will also be placed on the release guidelines.



    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 Ionuț Mihalcea and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Ionuț Mihalcea.
Entry created on 2021-05-07 13:40:50 UTC, last updated on 2021-05-12 16:08:07 UTC. Last achieved passing badge on 2021-05-12 16:08:07 UTC.

Back