LLVM

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

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

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

        

 基本 13/13

  • 识别

    The LLVM Project is a collection of modular and reusable compiler and toolchain technologies.

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


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

    https://llvm.org/ First paragraph at the top of the page.



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

    https://llvm.org * Links to download the software is on the top left side of the website. * LInk to bug tracker is on the top left side of the website. * The last paragraph on the main page has a 'getting involved' link.



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

    Non-trivial contribution file in repository: https://github.com/llvm/llvm-project/blob/main/CONTRIBUTING.md.



    关于如何贡献的信息应包括对可接受的贡献的要求(例如,引用任何所需的编码标准)。 (需要网址) [contribution_requirements]
  • FLOSS许可证

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



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

    The majority of the project is licensed under: Apache-2.0 WITH LLVM-exception OR NCSA. It is packaged for both Debian and Fedora when means the licenses meets their requirements.



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

    The majority of the project is licensed under: Apache-2.0 WITH LLVM-exception OR NCSA. There are small sections of code that are licensed under other licenses (e.g. MIT, Unicode, and others), but those are all NCSA approved.



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

    Non-trivial license location file in repository: https://github.com/llvm/llvm-project/blob/main/LICENSE.TXT.


  • 文档


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

    There are several different documentation pages for the various sub-projects, but here is the main documentation page for LLVM: https://llvm.org/docs/



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

    The full LLVM and clang API is published via doxygen at: https://llvm.org/doxygen/ and https://clang.llvm.org/doxygen/

    There are a large number of binary tools distributed by this project, the command line options for these are documented on web pages, like this: https://clang.llvm.org/docs/ClangCommandLineReference.html and/or in man pages distributed with the software.


  • 其他


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

    Given only https: URLs.



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

    GitHub supports discussions on issues and pull requests.



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

    必须维护该项目。 [maintained]


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



  • 错误报告流程


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

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

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

    On March 28, 2024, I ran a query looking at all the issues in the last 12 months:

    87.2% of the bugs had at least one person other than the reporter 'participate' in the bug. 49.9% of the bugs has at least two people other than the reporter 'participate' in the bug.

    From what I can tell 'participate' means someone added a comment, a label, or a reaction to a bug.



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

    We don't have a formal way to make feature requests. TODO: See if we can determine if there are any feature requests by looking at github labels and measure our response rate.



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


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

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

    The instructions here are for reporting a vulnerability privately: https://llvm.org/docs/Security.html#how-to-report-a-security-issue



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


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

    We provide a CMake build system for general use. In addition, there is a GN and also a Bazel build system that can be used as an alternative to CMake in some configurations.



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

    You can build the software using CMake, which is a very common tool.



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

    CMake is a FLOSS tool you can build the project with.


  • 自动测试套件


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

    The main test suites are integrated into the https://github.com/llvm/llvm-project repository. Instructions for how to run the tests can be found in our testing guide: https://llvm.org/docs/TestingGuide.html We have buildbots that automatically build and test the new code when it is committed: https://lab.llvm.org/buildbot/#/console



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

    You can run the test suite using make check-all or ninja check-all depending on which tool you are using. See https://llvm.org/docs/TestingGuide.html



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

    As of November 2023, our tests suite covered ~85% of the clang, llvm, and lldb sub-projects. See https://lab.llvm.org/coverage/coverage-reports/coverage/Users/buildslave/jenkins/workspace/coverage/llvm-project/index.html



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

    When code is merged to the main branch, there is an automated buildbot system that tests the result: https://lab.llvm.org/buildbot/#/console


  • 新功能测试


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

    We have a policy of requiring tests for bug fixes and new features: https://llvm.org/docs/DeveloperPolicy.html#test-cases



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

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

    We don't really have an official change proposal policy, but we do mention n the developer policy that tests should be added for new features: https://llvm.org/docs/DeveloperPolicy.html#test-cases


  • 警告标志


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

    The project enables -Wextra and other warnings by default and also enables -Wall except when compiling with clang-cl: https://github.com/llvm/llvm-project/blob/e07a2f49e3d3c13b6e9b89e0f6118652f2b2d3ac/llvm/cmake/modules/HandleLLVMOptions.cmake#L774



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

    Our latest release (17.0.6) had 9,636,137 lines of code ( cloc --include-lang="C,C++,C/C++ Header" compiler-rt/ clang-tools-extra/ libcxx libcxxabi/ libunwind/ openmp/ lld lldb polly mlir flang llvm/ bolt clang/). In our official release builds, there were 110 warnings: https://github.com/llvm/llvm-project/actions/runs/7017442066/job/19094022079. This is less that 1 per 100 lines.



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


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

    As of 4/23/2024, we have at least 2 developers how meet this criteria, see the discussion here: https://discourse.llvm.org/t/do-you-have-secure-development-knowledge/78429/4



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

    As of 4/23/2024, we have at least 2 developers how meet this criteria, see the discussion here: https://discourse.llvm.org/t/do-you-have-secure-development-knowledge/78429/4


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

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

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


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


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


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


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


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


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


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


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

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


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

    Releases are hosted on https://github.com/llvm/llvm-project/releases

    We sign our source tarballs, but not our release binaries.



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

    All our release assets are hosted at https://github.com/llvm/llvm-project/releases which uses https.


  • 修正公开的漏洞


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

    项目在得到报告后应该迅速修复所有致命漏洞。 [vulnerabilities_critical_fixed]
  • 其他安全问题


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

    We use https://www.passwordstore.org/ to encrypt and store our project credentials in a private git repository.


  • 静态代码分析


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

    We are running the clang static analyzer against our main branch one per day, and we will be running it for every commit the release branches going forward. https://github.com/llvm/llvm-project/actions/workflows/ci-post-commit-analyzer.yml



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

    We don't currently use a static analysis tool.



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

    We don't currently use a static analysis tool.



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

    We don't currently use a static analysis tool.


  • 动态代码分析


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

    We generally don't really much on fuzzing, because we assume that all inputs are trusted.



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

    We have several buildbots that run tests with the sanitizers enabled: https://lab.llvm.org



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

    We generally don't really much on fuzzing, because we assume that all inputs are trusted.



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

    We generally don't really much on fuzzing, because we assume that all inputs are trusted.



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

项目徽章条目拥有者: Tom Stellard.
最后更新于 2024-01-05 00:45:31 UTC, 最后更新于 2024-09-16 23:03:47 UTC。 最后在 2024-06-10 14:10:02 UTC 获得通过徽章。

后退