EPICS Base

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

如果这是您的项目，请在您的项目页面上显示您的徽章状态！徽章状态如下所示： 项目227的徽章级别为passing 这里是如何嵌入它：

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

        

 基本 13/13 ●

  • 识别

    EPICS is a set of open source software tools, libraries and applications developed collaboratively and used worldwide to create distributed soft real-time control systems for scientific instruments such as a particle accelerators, telescopes and other large scientific experiments. EPICS Base is the C/C++ software package that provides the core libraries, Input/Output Controller application and networking protocols used by most EPICS projects.

    用什么编程语言实现项目？

  • 基本项目网站内容


    足够获得徽章！

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

    First paragraph on the EPICS home page describes the EPICS project as a whole. A separate page describes the EPICS Base sub-project.


    足够获得徽章！

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

    The EPICS Base page on the website has sections on bug reporting and Code Management with links to the Launchpad project, and on each major release branch dating back to 1991.


    足够获得徽章！

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

    As a project on Launchpad.net we use the Launchpad issue tracker, code management and merge request systems. This are linked to and described on the EPICS Base webpage. We can also accept pull requests through GitHub where we maintain a mirror of our code repository from Launchpad.


    足够获得徽章！

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

    There is no formal coding standard document, but the EPICS Base web-page does stress the requirement for portability to the variety of platforms that we support.


  • FLOSS许可证

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


    足够获得徽章！

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

    EPICS Base is licensed under the EPICS Open License


    勉强够获得徽章。

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

    The EPICS Open License has not been submitted to OSI for approval, although it does meet their criteria.


    足够获得徽章！

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

    http://www.aps.anl.gov/epics/license/open.php


  • 文档


    足够获得徽章！

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

    Each release of the software comes with several documents, and also gets its own page on the EPICS website with links to documentation specific to that release. The set of documents available includes a README file with getting-started instructions. For example http://www.aps.anl.gov/epics/base/R3-16/1.php


    足够获得徽章！

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

    Alongside each release and linked from the release-specific webpage we publish PDF and HTML versions of the EPICS Application Developers Guide to provide reference documentation, e.g. http://www.aps.anl.gov/epics/base/R3-16/1-docs/AppDevGuide/


  • 其他


    足够获得徽章！

    项目网站（网站，存储库和下载URL）必须使用TLS支持HTTPS。 [sites_https]

    All websites used now support HTTPS.


    足够获得徽章！

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

    The EPICS project provides several mailing lists; the main support list is called tech-talk and additional lists are provided for discussions between developers. We use Launchpad for bug-reporting and issue tracking.


    足够获得徽章！

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

    All project business and documentation is in English.


    足够获得徽章！

    必须维护该项目。 [maintained]


（高级）哪些用户还有额外权限编辑此徽章条目？目前：[]



The EPICS project encompasses many parts which are developed separately, most of which have their own separate repositories and websites. The main EPICS website provides a central reference location for these in addition to supporting the EPICS Base subproject.

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


    足够获得徽章！

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

    The EPICS Base source repositories are hosted at Launchpad.net using Git, with a mirror available on GitHub.


    足够获得徽章！

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

    Implemented by Git.


    足够获得徽章！

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

    All revisions are included in the Git repository on Launchpad and its GitHub mirror.


    足够获得徽章！

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

    EPICS Base is available using Git.


  • 唯一版本编号


    足够获得徽章！

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

    Unique version numbers are used for every release of the software package, and we also now use a separate numbering scheme for our internal components.


    勉强够获得徽章。

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

    Our version numbering scheme predates the development of the SemVer scheme, and has slightly different characteristics. We don't always guarantee API compatibility between minor versions, although we do try to ensure that any incompatible changes will cause a build-time failure. We have never promised ABI compatibility between releases.

    Version numbers that contain components with a zero (e.g. 3.16.0.1) are for developer use and are not recommended for production use; the first production-quality release in the 3.16 series will be numbered 3.16.1.


    足够获得徽章！

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

    All releases are tagged in the Git version control system.


  • 发行说明


    足够获得徽章！

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

    Each release contains a copy of a Release Notes file which is also available on the website, for example http://www.aps.anl.gov/epics/base/R3-16/1-docs/RELEASE_NOTES.html


    足够获得徽章！

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

    We try to link entries in the Release Notes file to any associated bug-tracker entry, although some bugs may be fixed without entries in the bug-tracker. We also publish a document for each release listing the Known Problems in that release for which bug-fix patches are available.


  • 错误报告流程


    足够获得徽章！

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

    Users can submit reports to our public mailing lists, or file issues directly using the bug tracker on Launchpad.


    足够获得徽章！

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

    We use the bug tracker on Launchpad.


    足够获得徽章！

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

    Bug reports and mailing list posts are monitored examined by the core developers who normally respond within 1-2 business days.


    足够获得徽章！

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

    Core developers monitor the mailing lists and bug tracker and will respond as they see fit, usually within 1-2 business days.


    足够获得徽章！

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

    Mailing lists are archived tech-talk core-talk and the archives are searchable, as is the bug tracker.


  • 漏洞报告流程


    足够获得徽章！

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

    A section on the EPICS Base page describes how to report vulnerabilities through our Launchpad bug tracker.


    足够获得徽章！

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

    The Launchpad bug tracker supports the ability to mark bug reports as private security issues, and is configured to limit access to those bug reports to the core developers.


    足够获得徽章！

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

    The core developers usually respond to bug reports within 1-2 business days. We have not received any vulnerability reports in the last 6 months.


  • 可工作的构建系统


    足够获得徽章！

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

    EPICS Base comes with an extensive and highly capable set of Makefiles for GNUmake.


    足够获得徽章！

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

    The build process requires GNUmake.


    足够获得徽章！

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

    No proprietary tools are required to build EPICS Base on any supported OS.


  • 自动测试套件


    足够获得徽章！

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

    Automated test programs are included with the software.


    足够获得徽章！

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

    The test suite is run by asking GNUmake to run the tests.


    勉强够获得徽章。

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

    Large parts of the software were originally designed (in the 1990s) for a cross-build environment where automated testing was not feasible, so all tests were initiated manually. An automated test suite was added in 2006 and has expanded significantly since then, although some parts of the software still require manual testing.


    足够获得徽章！

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

    The project uses several different CI servers including Travis-CI, Appveyor and two instances of Jenkins to check out and build the software for many different target configurations after every commit, and runs the tests for many of those builds.


  • 新功能测试


    足够获得徽章！

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

    Additional tests are being added in newer versions; we now require that all significant new features come with automated tests.


    足够获得徽章！

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

    The number of automated tests in the 3.14 maintenance release series is currently 2,636. The 3.15 series has 8,659 tests, while the 3.16 series has 11,215. These figures can be seen on the Jenkins CI view. Our latest release series 7.0 runs 21,882 tests, but this number is a bit harder to find on Jenkins.


    足够获得徽章！

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

    Policy is described in this wiki page.


  • 警告标志


    足够获得徽章！

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

    Builds using GCC and clang are compiled with the flag -Wall. Most Perl scripts in the latest versions contain use strict.


    足够获得徽章！

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

    Project builds on Linux using GCC currently generate single-digit numbers of warnings from a code-base of over 150,000 lines of C & C++ code.


    勉强够获得徽章。

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

    The code must compile for a wide variety of targets using several different compilers. Different compilers and compiler versions generate different warnings, and it is not feasible to eliminate all of them.


  • 安全开发知识


    足够获得徽章！

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

    The core developers are software professionals with many years experience working at US DOE laboratories and similar large organizations.


    足够获得徽章！

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

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

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

    足够获得徽章！

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

    EPICS Base does not use or contain cryptographic software.


    足够获得徽章！

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

    Software downloads and repository access are available over HTTPS or ssh.


    足够获得徽章！

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

    GPG signatures of the download files are available over HTTPS.


  • 修正公开的漏洞


    足够获得徽章！

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

    A search of the NVD for the keyword "EPICS" on 2016-06-29 returned zero results. We are not aware of any CVE's associated with EPICS.


    足够获得徽章！

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

    Core developers monitor the mailing lists and bug tracker and usually respond within 1-2 business days. Patches for serious issues are made available via a release-specific Known Problems webpage, e.g. http://www.aps.anl.gov/epics/base/R3-15/4-docs/KnownProblems.html


  • 其他安全问题


    足够获得徽章！

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

    Source code repositories do not contain any credentials.


  • 静态代码分析


    足够获得徽章！

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

    New releases are currently being checked using the cppcheck tool. Additional or alternate tools may be substituted as we have time to experiment with them.


    足够获得徽章！

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

    The cppcheck tool mentioned above reports common vulnerabilities.


    足够获得徽章！

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

    The core developers aim to fix all reported vulnerabilities as soon as possible.


    勉强够获得徽章。

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

    We plan to have our Jenkins CI server run cppcheck on every commit.


  • 动态代码分析


    勉强够获得徽章。

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

    TBD.


    足够获得徽章！

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

    Memory allocation code has been instrumented for and is frequently tested using valgrind.


    足够获得徽章！

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

    Code is liberally sprinkled with assert() statements.


    足够获得徽章！

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

    The core developers aim to fix all reported vulnerabilities as soon as possible.



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

项目徽章条目拥有者： Andrew Johnson.
最后更新于 2016-06-28 22:37:02 UTC, 最后更新于 2017-12-20 04:31:33 UTC。 最后在 2017-12-20 03:45:23 UTC 获得通过徽章。

后退