parsec

遵循以下最佳实践的项目将能够自愿的自我认证,并显示他们已经实现了核心基础设施计划(OpenSSF)徽章。

如果这是您的项目,请在您的项目页面上显示您的徽章状态!徽章状态如下所示: 项目4856的徽章级别为passing 这里是如何嵌入它:

这些是通过级别条款。您还可以查看白银黄金级别条款。

        

 基本 13/13

  • 识别

    Platform AbstRaction for SECurity service

    用什么编程语言实现项目?
  • 基本项目网站内容


    项目网站必须简明扼要地描述软件的作用(它解决了什么问题?)。 [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



    项目网站必须提供有关如何获取和提供反馈(错误报告或增强功能)以及如何贡献的信息。 [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 )



    关于如何贡献的信息必须解释贡献流程(例如,是否使用拉请求?) (需要网址) [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/.



    关于如何贡献的信息应包括对可接受的贡献的要求(例如,引用任何所需的编码标准)。 (需要网址) [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许可证

    项目使用什么许可证发布?



    项目生产的软件必须作为FLOSS发布。 [floss_license]

    The Apache-2.0 license is approved by the Open Source Initiative (OSI).



    建议由项目生成的软件的任何必需的许可证是由开放源码促进会(OSI)批准的许可证(英文)[floss_license_osi]

    The Apache-2.0 license is approved by the Open Source Initiative (OSI).



    项目必须将其许可证在其源代码存储库中的标准位置发布。 (需要网址) [license_location]

    Non-trivial license location file in repository: https://github.com/parallaxsecond/parsec/blob/main/LICENSE.


  • 文档


    项目必须为项目生成的软件提供基本文档。 [documentation_basics]

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



    项目必须提供描述项目生成的软件的外部接口(输入和输出)的参考文档。 [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/


  • 其他


    项目网站(网站,存储库和下载URL)必须使用TLS支持HTTPS。 [sites_https]

    Given only https: URLs.



    该项目必须有一个或多个讨论机制(包括建议的更改和问题),可搜索,允许通过URL访问消息和主题,使新人能够参与一些讨论,并且不需要客户端安装专有软件。 [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



    项目应该提供英文文档,并能够接受英文的代码的错误报告和评论。 [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 )



    必须维护该项目。 [maintained]

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



(高级)哪些用户还有额外权限编辑此徽章条目?目前:[10590, 10591]



  • 公开的版本控制的源代码存储库


    该项目必须有一个版本控制的源代码存储库。它必须是公开可读的并可通过URL访问。 [repo_public]

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



    项目的源代码存储库必须跟踪所做的更改,谁进行了更改,何时进行了更改。 [repo_track]

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



    为了实现协作检视,项目的源代码存储库必须包括临时版本,以便检视版本之间的变化;它不得仅包括最终版本。 [repo_interim]

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



    建议使用通用分布式版本控制软件(例如,git)作为项目的源代码存储库。 [repo_distributed]

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


  • 唯一版本编号


    项目生成的用于每个用户使用的版本必须具有唯一版本标识符。 [version_unique]

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



    建议使用语义版本控制(SemVer)格式进行发布。 [version_semver]


    建议项目识别其版本控制系统中的每个版本。例如,建议使用git的项目,使用git标签识别每个版本。 [version_tags]

    All release versions are tagged appropriately in Github: https://github.com/parallaxsecond/parsec/tags


  • 发行说明


    该项目必须在每个版本中提供发布说明,这是该版本中主要变化的可读的摘要,以帮助用户确定是否应升级,升级影响将如何。发行说明不能是版本控制日志的原始输出(例如,“git log”命令结果不是发行说明)。其产出不适用于多个地点的项目(如单个网站或服务的软件),并采用持续交付,可以选择“N/A”。 (需要网址) [release_notes]

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



    发行说明必须列出每个新版本中修复的每个公开的漏洞。如果没有发行说明或者没有公开的漏洞,选择“不适用”。 [release_notes_vulns]

    No publicly known vulnerabilities have so far been identified.


  • 错误报告流程


    项目必须为用户提交错误报告(例如,使用问题跟踪器或邮件列表)提供相关流程。 (需要网址) [report_process]

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



    项目必须使用问题跟踪器来跟踪每个问题。 [report_tracker]

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



    该项目必须响应过去2-12个月内(含)提交的大多数错误报告;响应不需要包括修复。 [report_responses]

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



    该项目应该对过去2-12个月内(包括)的大部分(> 50%)的增强请求作出回应。 [enhancement_responses]

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



    该项目必须有一个公开的报告和回复的档案供后续搜索。 (需要网址) [report_archive]

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


  • 漏洞报告流程


    项目必须在项目网站上发布报告漏洞的流程。 (需要网址) [vulnerability_report_process]

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



    如果支持私有漏洞报告,项目必须包括如何以保密的方式发送信息。 (需要网址) [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



    该项目在过去6个月收到的任何漏洞报告的初始响应时间必须小于或等于14天。 [vulnerability_report_response]

    No vulnerabilities have been reported in the last 6 months


  • 可工作的构建系统


    如果项目生成的软件需要构建使用,项目必须提供可以从源代码自动重新构建软件的可工作的构建系统。 [build]

    The project uses Rust, for which the Cargo toolchain can rebuild the software from source given that the correct dependencies are found locally.



    建议使用通用工具来构建软件。 [build_common_tools]

    Cargo is the typical build tool for Rust projects.



    该项目应该仅使用FLOSS工具来构建。 [build_floss_tools]

    Cargo and the rest of the toolchain required is FLOSS


  • 自动测试套件


    该项目必须使用至少一个作为FLOSS公开发布的自动测试套件(该测试套件可以作为单独的FLOSS项目维护)。 [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



    测试套件应该以该语言的标准方式进行调用。 [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



    建议测试套件覆盖大部分(或理想情况下所有)代码分支,输入字段和功能。 [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



    建议项目实施持续集成,将新的或更改的代码经常集成到中央代码库中,并对结果进行自动化测试。 [test_continuous_integration]
  • 新功能测试


    该项目必须有通用的策略(正式或非正式),当主要的新功能被添加到项目生成的软件中,该功能的测试应该同时添加到自动测试套件。 [test_policy]

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



    该项目必须有证据表明,在项目生成的软件的最近重大变化中,已经遵守了添加测试的条款: test_policy [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.



    建议您在更改提案的说明文档中添加测试策略要求(请参阅test_policy)。 [tests_documented_added]

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


  • 警告标志


    该项目必须启用一个或多个编译器警告标志,“安全”语言模式,或者使用单独的“linter”工具查找代码质量错误或常见的简单错误,如果至少有一个FLOSS工具可以在所选择的语言实现此条款。 [warnings]

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



    该项目必须处理警告。 [warnings_fixed]

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



    建议在实际情况下,项目以最严格方式对待项目生成的软件中的告警。 [warnings_strict]

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


  • 安全开发知识


    该项目必须至少有一个主要开发人员知道如何设计安全软件。 [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.



    该项目的主要开发人员中,至少有一个必须知道导致这类型软件漏洞的常见错误类型,以及至少有一种方法来对付或缓解这些漏洞。 [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.


  • 使用基础的良好加密实践

    请注意,某些软件不需要使用加密机制。

    项目生成的软件默认情况下,只能使用由专家公开发布和审查的加密协议和算法(如果使用加密协议和算法)。 [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.



    如果项目生成的软件是应用程序或库,其主要目的不是实现加密,那么它应该只调用专门设计实现加密功能的软件,而不应该重新实现自己的。 [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.



    项目所产生的软件中,所有依赖于密码学的功能必须使用FLOSS实现。 [crypto_floss]

    All functionality in the project is implementable as FLOSS.



    项目生成的软件中的安全机制使用的默认密钥长度必须至少达到2030年(如2012年所述)的NIST最低要求。必须提供配置,以使较小的密钥长度被完全禁用。 [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).



    项目产生的软件中的默认安全机制不得取决于已被破解的密码算法(例如,MD4,MD5,单DES,RC4,Dual_EC_DRBG)或使用不适合上下文的密码模式(例如,ECB模式几乎不适当,因为它揭示了密文中相同的块,如 ECB企鹅所示。CTR模式通常是不合适的,因为如果重复输入状态,则它不执行认证并导致重复)。 [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).



    由项目产生的软件中的默认安全机制不应该依赖于具有已知严重弱点的加密算法或模式(例如,SHA-1密码散列算法或SSH中的CBC模式)。 [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).



    项目产生的软件中的安全机制应该​​对密钥协商协议实施完美的前向保密(PFS),如果长期密钥集合中的一个长期密钥在将来泄露,也不能破坏从一组长期密钥导出的会话密钥。 [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.



    如果项目产生的软件存储用于外部用户认证的密码,则必须使用密钥拉伸(迭代)算法(例如,PBKDF2,Bcrypt或Scrypt)将密码存储为每用户盐值不同的迭代散列 。 [crypto_password_storage]

    We do not handle passwords for our clients.



    由项目生成的软件中的安全机制必须使用密码学安全的随机数生成器生成所有加密密钥和随机数,并且不得使用密码学不安全的生成器。 [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.


  • 安全交付防御中间人(MITM)的攻击


    该项目必须使用一种针对MITM攻击的传递机制。使用https或ssh + scp是可以接受的。 [delivery_mitm]

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



    不得通过http协议获取加密散列(例如,sha1sum)并直接使用,而不检查密码学签名。 [delivery_unsigned]

    No such exchange exists


  • 修正公开的漏洞


    被公开了超过60天的中等或更高严重程度的漏洞,必须被修复。 [vulnerabilities_fixed_60_days]

    No vulnerabilities have been reported.



    项目在得到报告后应该迅速修复所有致命漏洞。 [vulnerabilities_critical_fixed]

    No vulnerabilities have been reported.


  • 其他安全问题


    公共存储库不得泄漏旨在限制公众访问的有效私人凭证(例如,工作密码或私钥)。 [no_leaked_credentials]

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


  • 静态代码分析


    如果至少有一个FLOSS工具以所选择的语言实现此条款,则至少需要将一个静态代码分析工具应用于软件发布之前任何提议的主要生成版本。 [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).



    建议至少有一个用于static_analysis标准的静态分析工具包括在分析语言或环境中查找常见漏洞的规则或方法。 [static_analysis_common_vulnerabilities]

    Static analysis tools are not generally used for Rust projects.



    使用静态代码分析发现的所有中,高严重性可利用漏洞必须在确认后及时修复。 [static_analysis_fixed]

    Static analysis tools are not generally used for Rust projects.



    建议每次提交或至少每天执行静态源代码分析。 [static_analysis_often]

    Static analysis tools are not generally used for Rust projects.


  • 动态代码分析


    建议在发布之前,至少将一个动态分析工具应用于软件任何发布的主要生产版本。 [dynamic_analysis]

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



    建议如果项目生成的软件包含使用内存不安全语言编写的软件(例如C或C++),则至少有一个动态工具(例如,fuzzer或web应用扫描程序)与检测缓冲区覆盖等内存安全问题的机制例行应用。如果该项目生成的软件没有以内存不安全语言编写,请选择“不适用”(N / A)。 [dynamic_analysis_unsafe]

    Project is written in memory-safe language.



    建议由项目生成的软件包括许多运行时断言,在动态分析期间检查。 [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.



    通过动态代码分析发现的所有严重性为中,高的可利用漏洞必须在确认后及时修复。 [dynamic_analysis_fixed]


此数据在知识共享署名3.0或更高版本许可证(CC-BY-3.0 +) 下可用。所有内容都可以自由分享和演绎,但必须给予适当的署名。请署名为Ionuț Mihalcea和OpenSSF最佳实践徽章贡献者。

项目徽章条目拥有者: Ionuț Mihalcea.
最后更新于 2021-05-07 13:40:50 UTC, 最后更新于 2021-05-12 16:08:07 UTC。 最后在 2021-05-12 16:08:07 UTC 获得通过徽章。

后退