herald-for-android

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

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

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

        

 基本 13/13

  • 识别

    Herald for Android - Reliable mobile Bluetooth communications - Android library & test app

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


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

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

    Obtain: https://heraldprox.io/download Provide feedback/Contribute: https://heraldprox.io/community Repo also has a contributing.md file



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

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

    https://heraldprox.io/contribute - Contributor's guide (being created today and uploaded. Should be available from Monday 17th May 2021)


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


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

    Project documentation guide (multiple repo project).

    Developers/Integration guide: https://heraldprox.io/guide/



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

    Design guide: https://heraldprox.io/design/ Herald formal Standards guides: https://heraldprox.io/specs/

    We also work with ETSI and others on international standards.


  • 其他


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

    Given only https: URLs.



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

    GitHub supports discussions on issues and pull requests.

    There's is also an LFPH Slack instance with herald-* named channels. https://slack.lfph.io/



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

    必须维护该项目。 [maintained]

    Herald is a Tier 2 (soon Tier 3) Project within the Linux Foundation Public Health (LFPH). This requires minimum standards for community size. Submitter is the TSC Chair for 2021-2022.



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



It's a suite of project repositories with a common goal: Reliable presence detection, distance estimation, and data transfer between devices. This is aimed at providing eHealth approaches and benefits, both through Digital Contact Tracing (DCT) but also in helping other eHealth areas, including more efficient hospital operations.

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


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

    We have -beta1/ beta2 semver tags for intermediate releases. We have a public develop branch, and a public master/main branch with v tags for releases from either (depending on whether they are interim releases or not).



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

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


  • 唯一版本编号


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

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


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

    We use v* tags. E.g. v1.0, v1.2-beta1


  • 发行说明


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

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

    We don't publish a release if there is a known vulnerability to our code.


  • 错误报告流程


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

    https://github.com/theheraldproject/herald-for-android/issues

    We also provide templates for issues/features.



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

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


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

    We aim to respond within 5 days



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


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

    As per SECURITY.md file. The Linux Foundation Public Health currently does not have a standard policy or reporting mechanism (E.g. HackerOne) which we can use. I've raised this as an issue for the next TAC meeting. https://github.com/theheraldproject/herald-for-android/blob/develop/SECURITY.md



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

    As per SECURITY.md file. The Linux Foundation Public Health currently does not have a standard policy or reporting mechanism (E.g. HackerOne) which we can use. I've raised this as an issue for the next TAC meeting.



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

    We respond to all issue reports within 5 days. We have issued security patches in the past within 24 hours: https://github.com/theheraldproject/herald-for-android/releases/tag/v1.1.1


  • 可工作的构建系统


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

    Gradle build system for local (developer, adopter) and automated CI (project release via GitHub Actions) builds



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

    We use GitHub Actions and GitHub Packages where possible. We also use the appropriate packaging approach for each system (E.g. Maven Central for this Android repo)



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

    Gradle builds. Maven packages.


  • 自动测试套件


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

    Standard approach via gradle test. Branch protection rules for this to be ran for every PR to the develop or master/main branches.



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

    Gradle



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

    Currently covers all core library features. Elements requiring 2 device Bluetooth communication cannot be tested with unit tests, but we have a manual mechanism for this too. We abstract as much into classes as possible so there's little to test physically outside of unit tests.



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

    GitHub Actions has just been implemented.


  • 新功能测试


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

    This is a standard policy. We require developers to use Test Driven Development.



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

    We have just implemented a GitHub CI system that archives the test output HTML for every test as an artifact for each build (which is required for every single PR now). This is new though. There is a major (v2.0) version being released in the coming days adhering to this that all repos will adopt.



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

    It is documented in the new Contributor's guide (published 17 May 2021): https://heraldprox.io/contribute


  • 警告标志


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

    gradle lint is used



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

    Every major release requires that all warnings are addressed, or documented and ignores with a link to the documentation where the ignore instruction is present. (Not applicable for Android, but the Zephyr C++ build system has such warnings, which is well known in that community).



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

    For the Android/Java project this is done.


  • 安全开发知识


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

    Myself (Adam Fowler) in the core committer team and as TSC Chair has this knowledge. Other contributors (not committers) do too.



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

    I (Adam Fowler) has experience of this from industry, including OWASP and mobile application scanning tools. I am also familiar with NCSC secure coding requirements.


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

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

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

    RandomSource supports various options. We use the SecureRandom's backup option as we have to support old phones (Dating back to 2010) and old versions of Android that would otherwise block indefinitely, leading to poor epidemiological efficacy for older phones (and thus would disproportionately negatively effect poorer people). See these classes for examples of security steps taken:- - https://github.com/theheraldproject/herald-for-android/tree/develop/herald/src/main/java/io/heraldprox/herald/sensor/datatype/random - https://github.com/theheraldproject/herald-for-android/blob/develop/herald/src/main/java/io/heraldprox/herald/sensor/datatype/PseudoDeviceAddress.java - https://github.com/theheraldproject/herald-for-android/blob/develop/herald/src/main/java/io/heraldprox/herald/sensor/payload/simple/K.java



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

    We use provided cryptography where possible. There is a need in next version of the project to implement our own handshake and token mechanism to prevent relay and replay attacks over the wire. That will use DH and TOTP as a basis though. Initial design can be seen here: https://heraldprox.io/specs/payload-secured



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

    Both our library and any dependencies will be Apache-2.0. OpenJDK implementations of core crypto features are available for Java primitives.



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

    Met where applicable. Library adopters can configure a range of options, and plug in their own where needed.



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

    We follow NIST SP recommendations and NCSC recommendations.



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

    We do this where possible but we don't always use the very latest approaches. This is because, uniquely, we have to support platforms back to iOS 9.3 and Android SDK 21 in order to be widely usable on a very wide range of mobile devices so that poorer communities have access to life saving technology in our Digital Contact Tracing and eHealth solutions. Where a 'lowest common denominator' approach is used, we ensure that adopters can switch in/out a more secure provided algorithm, or replace it with their own algorithm. This allows us to provide maximum reach and recommend best practice without disadvantaging poor communities.



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

    This is the preferred approach but in an anonymous system there are limits to what can be achieved. E.g. for the 'simple payload' a daily key is used to forward generate the 5 minute expiring 'ephemeral keys' for digital contact tracing. This is a 'good thing', as less information needs to be transmitted across mobile networks for devices to realise they have had exposure to an ill person. The identity behind this daily key is not known, and only transmitted to devices after the event and after individuals have been diagnosed. (This is the same way GAEN works). A new Secured Payload will provide this mechanism in a different way. This will use 'tokens' issued over an encrypted mechanism where this token is only exchanged with that device. This will be generated in such a way as to provide for perfect forward secrecy. (There will not be a common key basis to each token).



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

    We don't store secrets. Where key storage features are used, we delegate this to the host OS. (E.g. it's managed in their secure enclaves, where available).



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

    Used where provided by the host device. Where enough entropy is not provided (old Android phones), an external source of additional entropy is used to change the random bytes generated.


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


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

    Source code: https and git+ssh source access. Builds on GitHub actions natively. Bluetooth transfer: Only certain approaches possible with completely anonymous data exchange. New Secured Payload will issue tokens and hash responses from devices, so even if the originating transfer is MITM'ed, the resultant 'exposure' data would fail to be authenticated.



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

    Not done in our project


  • 修正公开的漏洞


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

    No confirmed vulnerabilities. All security mechanisms can also be replaced / switched out by downstream adopters of the library to more secure versions. Due to the wide range of android (SDK 21) and iOS (9.3+) devices we have to support, some options are more secure than others, but adopters can choose their preferred approach for all security functions.



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

    Only time this has been necessary the fix was issued within 24 hours of the project team being notified.


  • 其他安全问题


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

    GitHub secrets are used for the build pipeline. No repository contains secrets, usernames, or passwords.


  • 静态代码分析


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

    Spotbugs now part of the unit_test GitHub Actions workflow, and ran on every PR to the develop or master/main branches as a pre-requisite check. This check also applies to administrators and cannot be bypassed.



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

    Spotbugs now part of the unit_test GitHub Actions workflow, and ran on every PR to the develop or master/main branches as a pre-requisite check. This check also applies to administrators and cannot be bypassed. We also use the findsecbugs plugin to spotbugs.



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

    A PR cannot be merged without tests passing, including static analysis (as of today). Standard issue report fix (E.g. new vulns, old code) have a target SLA of 5 days.



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

    We use gitflow so commits happen on forks. Every PR though has these required. (I.e. a commit set cannot be merged without these passing).


  • 动态代码分析


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

    Not done today.



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

    Java project.



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

    Not done today.



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

    Dynamic analysis not done today.



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

项目徽章条目拥有者: Adam Fowler.
最后更新于 2021-05-16 11:32:31 UTC, 最后更新于 2021-06-01 08:12:17 UTC。 最后在 2021-06-01 08:12:17 UTC 获得通过徽章。

后退