Erlang/OTP

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

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

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

        

 基本 13/13

  • 识别

    Erlang/OTP is a programming language and runtime system for building massively scalable soft real-time systems with requirements on high availability.

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


    项目网站必须简明扼要地描述软件的作用(它解决了什么问题?)。 [description_good]

    Erlang is a programming language and runtime system for building massively scalable soft real-time systems with requirements on high availability.



    项目网站必须提供有关如何获取和提供反馈(错误报告或增强功能)以及如何贡献的信息。 [interact]

    关于如何贡献的信息必须解释贡献流程(例如,是否使用拉请求?) (需要网址) [contribution]

    Non-trivial contribution file in repository: https://github.com/erlang/otp/blob/master/CONTRIBUTING.md.



    关于如何贡献的信息应包括对可接受的贡献的要求(例如,引用任何所需的编码标准)。 (需要网址) [contribution_requirements]
  • 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/erlang/otp/blob/master/LICENSE.txt.


  • 文档


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

    Documentation for installation can found in https://github.com/erlang/otp/tree/master/HOWTO. The Erlang documentation is https://github.com/erlang/otp/tree/c3585a862b7e6d4fb61ebaa2b09456b6020eba86/system/doc/reference_manual and also inline in source code. to generate the documentation, run make docs



    项目必须提供描述项目生成的软件的外部接口(输入和输出)的参考文档。 [documentation_interface]

    APIs are documented inline with Erlang source code. The API expected input/output can be generated running make docs.


  • 其他


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

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

    GitHub supports discussions on issues and pull requests.



    项目应该提供英文文档,并能够接受英文的代码的错误报告和评论。 [english]

    All issues are reported in English: https://github.com/erlang/otp/issues



    必须维护该项目。 [maintained]


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



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


    该项目必须有一个版本控制的源代码存储库。它必须是公开可读的并可通过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]

    master branch always include next year's release, maint branch always includes maintenance releases. Every release gets its own tag.



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

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


  • 唯一版本编号


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

    An overview of Erlang releases is found here: https://erlang.org/download/otp_versions_tree.html All Erlang releases are found here and each one has its own tag: https://github.com/erlang/otp/releases/



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


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

    Each release has associated its own git tag


  • 发行说明


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

    Release notes can be found in https://github.com/erlang/otp/releases/



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

    Example of reported CVE in release notes: https://github.com/erlang/otp/releases/tag/OTP-26.2.1


  • 错误报告流程


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

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

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

    This link shows that issues are taken care as fast as possible: https://github.com/erlang/otp/issues?q=is%3Aissue+is%3Aclosed



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

    Enhancement requests to libraries must be submitted as issues: https://github.com/erlang/otp/issues Enhancements to the Erlang language are submitted to this other issue tracker specific to Erlang Enhancement Process: https://github.com/erlang/eep



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


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

    如果支持私有漏洞报告,项目必须包括如何以保密的方式发送信息。 (需要网址) [vulnerability_report_private]

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

    Any vulnerability reported is treated as a high priority task, and is reviewed by a security team within 48 h.


  • 可工作的构建系统


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

    Instructions on how to build the system are here: https://github.com/erlang/otp/tree/master/HOWTO The system has make as dependency and can be built using the provided otp_build setup -a script



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

    Make



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

    Erlang/OTP can be built using FLOSS tools


  • 自动测试套件


    该项目必须使用至少一个作为FLOSS公开发布的自动测试套件(该测试套件可以作为单独的FLOSS项目维护)。 [test]

    测试套件应该以该语言的标准方式进行调用。 [test_invocation]

    make test; make dialyzer



    建议测试套件覆盖大部分(或理想情况下所有)代码分支,输入字段和功能。 [test_most]

    test suites run on all branches, and we try to cover as much as possible



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

    We use Github Actions and run Github CI


  • 新功能测试


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

    该项目必须有证据表明,在项目生成的软件的最近重大变化中,已经遵守了添加测试的条款: test_policy [tests_are_added]

    All new functionality must include tests or it won't be merged. Pull requests in Github show that the tests have passed.



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


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

    Running make dialyzer will run these tests. Dialyzer can be configured via flags to be more strict or more lenient.



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

    The warnings identified by Dialyzer are usually fixed. In rare cases, warnings in type specs about overlapping domains may be silenced.



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


    该项目必须至少有一个主要开发人员知道如何设计安全软件。 [know_secure_design]

    The Erlang/OTP team has more than 9 members with 15 years following secure development practices



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

    The team has experts in SSL/TLS and SSH protocols


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

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

    项目生成的软件默认情况下,只能使用由专家公开发布和审查的加密协议和算法(如果使用加密协议和算法)。 [crypto_published]

    Protocols that can be used in Erlang as libraries are SSH and TLS, which are reviewed by experts and standard in industry



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

    we rely on openssl for cryptographic functions



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

    openssl



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

    our SSL/TLS library is pretty flexible and can accommodate / disable different configurations: https://www.erlang.org/doc/apps/ssl/ssl.html



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

    Our TLS application offers safe defaults. For backward compatibility with older systems, users may opt-in to less safe defaults.



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

    We use secure defaults. There is only one special case for ssh where we have a fallback strategy that uses non-strict KEX.



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


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


    由项目生成的软件中的安全机制必须使用密码学安全的随机数生成器生成所有加密密钥和随机数,并且不得使用密码学不安全的生成器。 [crypto_random]

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


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

    https and SHA256 for tar.gz source code



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

  • 修正公开的漏洞


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

    High severity vulnerabilities are patched in emergency patches



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

  • 其他安全问题


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

    we do not store passwords nor private keys in the repository


  • 静态代码分析


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

    Erlang/OTP pull requests and branches are scan by OSV Github Actions We also run the static analysis tool Dialyzer, maintained by the Erlang/OTP team



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

    OSV and dialyzer



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

    https://github.com/erlang/otp/security contains information. We have a policy to reply within 48 h. We also have enabled SECURITY.txt for researchers: https://www.erlang.org/.well-known/security.txt



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

    We have configured OSV to run on each PR and every night at 1 am CET We also run the static analysis tool Dialyzer, maintained by the Erlang/OTP team, on every PR


  • 动态代码分析


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

    We use property-based testing (fuzzing tools) for Erlang code as well as LLVM/Clang sanitizers and valgrind for the runtime



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

    we use address sanitizers as well as valgrind for the runtime, written in C/C++



    建议由项目生成的软件包括许多运行时断言,在动态分析期间检查。 [dynamic_analysis_enable_assertions]


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


This data is available under the Community Data License Agreement – Permissive, Version 2.0 (CDLA-Permissive-2.0). This means that a Data Recipient may share the Data, with or without modifications, so long as the Data Recipient makes available the text of this agreement with the shared Data. Please credit Kiko Fernandez-Reyes and the OpenSSF Best Practices badge contributors.

项目徽章条目拥有者: Kiko Fernandez-Reyes.
最后更新于 2024-11-07 18:56:40 UTC, 最后更新于 2024-11-13 14:17:32 UTC。 最后在 2024-11-07 19:59:10 UTC 获得通过徽章。

后退