meitheal

Projects that follow the best practices below can voluntarily self-certify and show that they've achieved an Open Source Security Foundation (OpenSSF) best practices badge.

There is no set of practices that can guarantee that software will never have defects or vulnerabilities; even formal methods can fail if the specifications or assumptions are wrong. Nor is there any set of practices that can guarantee that a project will sustain a healthy and well-functioning development community. However, following best practices can help improve the results of projects. For example, some practices enable multi-person review before release, which can both help find otherwise hard-to-find technical vulnerabilities and help build trust and a desire for repeated interaction among developers from different companies. To earn a badge, all MUST and MUST NOT criteria must be met, all SHOULD criteria must be met OR be unmet with justification, and all SUGGESTED criteria must be met OR unmet (we want them considered at least). If you want to enter justification text as a generic comment, instead of being a rationale that the situation is acceptable, start the text block with '//' followed by a space. Feedback is welcome via the GitHub site as issues or pull requests There is also a mailing list for general discussion.

We gladly provide the information in several locales, however, if there is any conflict or inconsistency between the translations, the English version is the authoritative version.
If this is your project, please show your badge status on your project page! The badge status looks like this: Badge level for project 16683 is silver Here is how to embed it:
You can show your badge status by embedding this in your markdown file:
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/16683/badge)](https://www.bestpractices.dev/projects/16683)
or by embedding this in your HTML:
<a href="https://www.bestpractices.dev/projects/16683"><img src="https://www.bestpractices.dev/projects/16683/badge"></a>


These are the Gold level criteria. You can also view the Passing or Silver level criteria.

Baseline Series: Baseline Level 1 Baseline Level 2 Baseline Level 3

        

 Basics 3/5 ●

  • General

    Note that other projects may use the same name.

    Meitheal keeps household tasks, recurring routines and home projects together inside Home Assistant. It runs locally and can create tasks from user-configured automations.

    Please use SPDX license expression format; examples include "Apache-2.0", "BSD-2-Clause", "BSD-3-Clause", "GPL-2.0+", "LGPL-3.0+", "MIT", and "(BSD-2-Clause OR Ruby)". Do not include single quotes or double quotes.
    If there is more than one language, list them as comma-separated values (spaces optional) and sort them from most to least used. If there is a long list, please list at least the first three most common ones. If there is no language (e.g., this is a documentation-only or test-only project), use the single character "-". Please use a conventional capitalization for each language, e.g., "JavaScript".
    The Common Platform Enumeration (CPE) is a structured naming scheme for information technology systems, software, and packages. It is used in a number of systems and databases when reporting vulnerabilities.

    Meitheal core is available under AGPL-3.0-only. Optional commercial terms require a separate explicit agreement. The narrowly defined external-API permission permits specified independent integrations; it does not remove copyleft from the core. Home Assistant and Node-RED integrations retain Apache-2.0, documentation retains CC-BY-4.0 where stated, and third-party material retains its own notices.

  • Prerequisites


    The project MUST achieve a silver level badge. [achieve_silver]

  • Project oversight


    The project MUST have a "bus factor" of 2 or more. (URL required) [bus_factor]
    A "bus factor" (aka "truck factor") is the minimum number of project members that have to suddenly disappear from a project ("hit by a bus") before the project stalls due to lack of knowledgeable or competent personnel. The truck-factor tool can estimate this for projects on GitHub. For more information, see Assessing the Bus Factor of Git Repositories by Cosentino et al.

    Meitheal is currently a small, founder-maintained project with one primary human maintainer. Contributor recruitment and documented development/release procedures reduce onboarding barriers, but the project does not yet claim a bus factor of two. One-week emergency access continuity is handled as a separate requirement. https://github.com/ryan-winkler/meitheal/blob/dev/GOVERNANCE.md



    The project MUST have at least two unassociated significant contributors. (URL required) [contributors_unassociated]
    Contributors are associated if they are paid to work by the same organization (as an employee or contractor) and the organization stands to benefit from the project's results. Financial grants do not count as being from the same organization if they pass through other organizations (e.g., science grants paid to different organizations from a common government or NGO source do not cause contributors to be associated). Someone is a significant contributor if they have made non-trivial contributions to the project in the past year. Examples of good indicators of a significant contributor are: written at least 1,000 lines of code, contributed 50 commits, or contributed at least 20 pages of documentation.

    The project has not yet established two unassociated significant human contributors within the required period. Automated accounts and multiple identities for the same person do not establish independent contributors. https://github.com/ryan-winkler/meitheal/graphs/contributors


  • Other


    The project MUST include a license statement in each source file. This MAY be done by including the following inside a comment near the beginning of each file: SPDX-License-Identifier: [SPDX license expression for project]. [license_per_file]
    This MAY also be done by including a statement in natural language identifying the license. The project MAY also include a stable URL pointing to the license text, or the full license text. Note that the criterion license_location requires the project license be in a standard location. See this SPDX tutorial for more information about SPDX license expressions. Note the relationship with copyright_per_file, whose content would typically precede the license information.

    Each source file identifies its applicable license using an SPDX identifier or equivalent license statement. Meitheal core uses AGPL-3.0-only; separately licensed integrations and third-party material identify their own licenses and retain their notices. Any applicable additional permission is identified consistently with the published permission text. https://github.com/ryan-winkler/meitheal/blob/dev/LICENSE https://github.com/ryan-winkler/meitheal/blob/dev/NOTICE https://github.com/ryan-winkler/meitheal/tree/dev/integrations


 Change Control 4/4 ●

  • Public version-controlled source repository


    The project's source repository MUST use a common distributed version control software (e.g., git or mercurial). [repo_distributed]
    Git is not specifically required and projects can use centralized version control software (such as subversion) with justification.

    Meitheal uses Git in its public GitHub repository. Contributors can clone the repository, work locally, and submit branches or pull requests. The default development branch is dev. https://github.com/ryan-winkler/meitheal



    The project MUST clearly identify small tasks that can be performed by new or casual contributors. (URL required) [small_tasks]
    This identification is typically done by marking selected issues in an issue tracker with one or more tags the project uses for the purpose, e.g., up-for-grabs, first-timers-only, "Small fix", microtask, or IdealFirstBug. These new tasks need not involve adding functionality; they can be improving documentation, adding test cases, or anything else that aids the project and helps the contributor understand more about the project.

    The contribution guide and issue tracker identify specific small, self-contained tasks suitable for new or casual contributors. Starter tasks describe the expected outcome and provide enough context for a contributor to begin. https://github.com/ryan-winkler/meitheal/blob/dev/CONTRIBUTING.md https://github.com/ryan-winkler/meitheal/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22



    The project MUST require two-factor authentication (2FA) for developers for changing a central repository or accessing sensitive data (such as private vulnerability reports). This 2FA mechanism MAY use mechanisms without cryptographic mechanisms such as SMS, though that is not recommended. [require_2FA]

    GitHub requires 2FA as of March 2023. [osps_ac_01_01]


    The project requires two-factor authentication for developers changing the central repository or accessing sensitive project data, including private vulnerability reports. This requirement covers repository write access and the accounts used to receive and handle confidential reports. The access policy is documented in project governance and the security policy. https://github.com/ryan-winkler/meitheal/blob/dev/GOVERNANCE.md; https://github.com/ryan-winkler/meitheal/blob/dev/SECURITY.md



    The project's two-factor authentication (2FA) SHOULD use cryptographic mechanisms to prevent impersonation. Short Message Service (SMS) based 2FA, by itself, does NOT meet this criterion, since it is not encrypted. [secure_2FA]
    A 2FA mechanism that meets this criterion would be a Time-based One-Time Password (TOTP) application that automatically generates an authentication code that changes after a certain period of time. Note that GitHub supports TOTP.

    The relevant developer and confidential-report accounts use cryptographic multifactor authentication: Yubico Neo Key/ FIDO2 Passkey. SMS alone is not used to satisfy this requirement. This concerns project-maintenance and sensitive-report access, rather than Authentication inside the Meitheal application. https://github.com/ryan-winkler/meitheal/blob/dev/GOVERNANCE.md


 Quality 3/7 ●

  • Coding standards


    The project MUST document its code review requirements, including how code review is conducted, what must be checked, and what is required to be acceptable. (URL required) [code_review_standards]
    See also two_person_review and contribution_requirements.

    CONTRIBUTING.md documents who reviews pull requests, what reviewers check, and what makes a change acceptable. Its checklist covers problem fit, required checks, tests, input and access validation, privacy, compatibility, accessibility, documentation and dependencies. It describes self-review while there is one maintainer and review by another maintainer when one is available. Automated review supports human review. https://github.com/ryan-winkler/meitheal/blob/8982623e5c8dbee96d66ae40601f97f9e0bc0c03/CONTRIBUTING.md#code-review-standard



    The project MUST have at least 50% of all proposed modifications reviewed before release by a person other than the author, to determine if it is a worthwhile modification and free of known issues which would argue against its inclusion [two_person_review]

    Review by a person other than the author for at least 50% of proposed modifications before release has not yet been established. Automated reviews assist the process but do not replace the required different-human review. https://github.com/ryan-winkler/meitheal/blob/dev/CONTRIBUTING.md


  • Working build system


    The project MUST have a reproducible build. If no building occurs (e.g., scripting languages where the source code is used directly instead of being compiled), select "not applicable" (N/A). (URL required) [build_reproducible]
    A reproducible build means that multiple parties can independently redo the process of generating information from source files and get exactly the same bit-for-bit result. In some cases, this can be resolved by forcing some sort order. JavaScript developers may consider using npm shrinkwrap and webpack OccurrenceOrderPlugin. GCC and clang users may find the -frandom-seed option useful. The build environment (including the toolset) can often be defined for external parties by specifying the cryptographic hash of a specific container or virtual machine that they can use for rebuilding. The reproducible builds project has documentation on how to do this.

  • Automated test suite


    A test suite MUST be invocable in a standard way for that language. (URL required) [test_invocation]
    For example, "make check", "mvn test", or "rake test" (Ruby).

    The root package exposes pnpm test. The test workspace exposes pnpm --filter @meitheal/tests test for Playwright tests and test:ci for the isolated full suite. The Home Assistant integration uses python -m pytest. CONTRIBUTING.md and the CI workflow document the commands. https://github.com/ryan-winkler/meitheal/blob/8982623e5c8dbee96d66ae40601f97f9e0bc0c03/package.json; https://github.com/ryan-winkler/meitheal/blob/8982623e5c8dbee96d66ae40601f97f9e0bc0c03/CONTRIBUTING.md; https://github.com/ryan-winkler/meitheal/blob/8982623e5c8dbee96d66ae40601f97f9e0bc0c03/.github/workflows/ci.yml



    The project MUST implement continuous integration, where new or changed code is frequently integrated into a central code repository and automated tests are run on the result. (URL required) [test_continuous_integration]
    In most cases this means that each developer who works full-time on the project integrates at least daily.

    GitHub Actions CI runs for relevant pushes and pull requests across dev, main and release. It builds and checks the TypeScript/Astro application, runs isolated Playwright suites, tests the Home Assistant integration and checks migrations and schema drift. The current dev commit has a completed successful CI run, with 243 spec files passing and 141 Python tests passing. https://github.com/ryan-winkler/meitheal/blob/8982623e5c8dbee96d66ae40601f97f9e0bc0c03/.github/workflows/ci.yml; https://github.com/ryan-winkler/meitheal/actions/runs/43633956016



    The project MUST have FLOSS automated test suite(s) that provide at least 90% statement coverage if there is at least one FLOSS tool that can measure this criterion in the selected language. [test_statement_coverage90]


    The project MUST have FLOSS automated test suite(s) that provide at least 80% branch coverage if there is at least one FLOSS tool that can measure this criterion in the selected language. [test_branch_coverage80]

 Security 4/5 ●

  • Use basic good cryptographic practices

    Note that some software does not need to use cryptographic mechanisms. If your project produces software that (1) includes, activates, or enables encryption functionality, and (2) might be released from the United States (US) to outside the US or to a non-US-citizen, you may be legally required to take a few extra steps. Typically this just involves sending an email. For more information, see the encryption section of Understanding Open Source Technology & US Export Controls.

    The software produced by the project MUST support secure protocols for all of its network communications, such as SSHv2 or later, TLS1.2 or later (HTTPS), IPsec, SFTP, and SNMPv3. Insecure protocols such as FTP, HTTP, telnet, SSLv3 or earlier, and SSHv1 MUST be disabled by default, and only enabled if the user specifically configures it. If the software produced by the project does not support network communications, select "not applicable" (N/A). [crypto_used_network]

    Meitheal supports secure protocols for all network communication paths. Insecure protocols are disabled by default and require explicit operator configuration. This policy includes application access, external integrations and internal Home Assistant/Supervisor communication; a private network alone is not treated as encrypted transport. https://github.com/ryan-winkler/meitheal/blob/dev/SECURITY.md https://github.com/ryan-winkler/meitheal/blob/dev/docs/architecture.md https://github.com/ryan-winkler/meitheal/blob/dev/meitheal-hub/DOCS.md



    The software produced by the project MUST, if it supports or uses TLS, support at least TLS version 1.2. Note that the predecessor of TLS was called SSL. If the software does not use TLS, select "not applicable" (N/A). [crypto_tls12]

    Meitheal supports HTTPS connections through the supported Node.js runtime and its standard HTTP client. Node.js supports TLS 1.2 and TLS 1.3; the reviewed application does not replace the TLS implementation with a legacy-only stack. This statement concerns supported TLS connections and does not claim that every default transport is encrypted. https://github.com/ryan-winkler/meitheal/blob/8982623e5c8dbee96d66ae40601f97f9e0bc0c03/apps/web/src/domains/ha/ha-connection.ts; https://github.com/ryan-winkler/meitheal/blob/8982623e5c8dbee96d66ae40601f97f9e0bc0c03/package.json; https://nodejs.org/api/tls.html#tlsdefault_min_version


  • Secured delivery against man-in-the-middle (MITM) attacks


    The project website, repository (if accessible via the web), and download site (if separate) MUST include key hardening headers with nonpermissive values. (URL required) [hardened_site]
    Note that GitHub and GitLab are known to meet this. Sites such as https://securityheaders.com/ can quickly check this. The key hardening headers are: Content Security Policy (CSP), HTTP Strict Transport Security (HSTS), X-Content-Type-Options (as "nosniff"), and X-Frame-Options. Fully static web sites with no ability to log in via the web pages could omit some hardening headers with less risk, but there's no reliable way to detect such sites, so we require these headers even if they are fully static sites.

    The project website, web repository and download locations serve appropriate nonpermissive Content-Security-Policy, Strict-Transport-Security, X-Content-Type-Options: nosniff and framing protection headers. These protections cover the project sites as well as the application where applicable. https://meitheal.io https://github.com/ryan-winkler/meitheal https://github.com/ryan-winkler/meitheal/releases


  • Other security issues


    The project MUST have performed a security review within the last 5 years. This review MUST consider the security requirements and security boundary. [security_review]
    This MAY be done by the project members and/or an independent evaluation. This evaluation MAY be supported by static and dynamic analysis tools, but there also must be human review to identify problems (particularly in design) that tools cannot detect.


    Hardening mechanisms MUST be used in the software produced by the project so that software defects are less likely to result in security vulnerabilities. (URL required) [hardening]
    Hardening mechanisms may include HTTP headers like Content Security Policy (CSP), compiler flags to mitigate attacks (such as -fstack-protector), or compiler flags to eliminate undefined behavior. For our purposes least privilege is not considered a hardening mechanism (least privilege is important, but separate).

    The runtime applies response hardening including X-Content-Type-Options: nosniff, restrictive object/base/form CSP directives, a referrer policy, and a permissions policy. Home Assistant App manifests enable AppArmor, with a profile that denies raw/packet networking, mounting, and specified kernel interfaces. These mechanisms are present in addition to authentication and least-privilege controls. https://github.com/ryan-winkler/meitheal/blob/8982623e5c8dbee96d66ae40601f97f9e0bc0c03/apps/web/src/domains/auth/ingress-policy.ts; https://github.com/ryan-winkler/meitheal/blob/8982623e5c8dbee96d66ae40601f97f9e0bc0c03/meitheal-hub/apparmor.txt; https://github.com/ryan-winkler/meitheal/blob/8982623e5c8dbee96d66ae40601f97f9e0bc0c03/meitheal-hub/config.yaml


 Analysis 2/2 ●

  • Dynamic code analysis


    The project MUST apply at least one dynamic analysis tool to any proposed major production release of the software produced by the project before its release. [dynamic_analysis]
    A dynamic analysis tool examines the software by executing it with specific inputs. For example, the project MAY use a fuzzing tool (e.g., American Fuzzy Lop) or a web application scanner (e.g., OWASP ZAP or w3af). In some cases the OSS-Fuzz project may be willing to apply fuzz testing to your project. For purposes of this criterion the dynamic analysis tool needs to vary the inputs in some way to look for various kinds of problems or be an automated test suite with at least 80% branch coverage. The Wikipedia page on dynamic analysis and the OWASP page on fuzzing identify some dynamic analysis tools. The analysis tool(s) MAY be focused on looking for security vulnerabilities, but this is not required.

    Before each proposed major production release, Meitheal runs dynamic analysis using its ZAP web scan and fast-check fuzzing. The release process reviews the findings and retains results tied to the release candidate. https://github.com/ryan-winkler/meitheal/blob/dev/.github/workflows/zap-baseline.yml https://github.com/ryan-winkler/meitheal/blob/dev/tests/unit/framework-formula-fuzz.spec.ts https://github.com/ryan-winkler/meitheal/blob/dev/docs/kcs/releasing.md



    The project SHOULD include many run-time assertions in the software it produces and check those assertions during dynamic analysis. [dynamic_analysis_enable_assertions]
    This criterion does not suggest enabling assertions during production; that is entirely up to the project and its users to decide. This criterion's focus is instead to improve fault detection during dynamic analysis before deployment. Enabling assertions in production use is completely different from enabling assertions during dynamic analysis (such as testing). In some cases enabling assertions in production use is extremely unwise (especially in high-integrity components). There are many arguments against enabling assertions in production, e.g., libraries should not crash callers, their presence may cause rejection by app stores, and/or activating an assertion in production may expose private data such as private keys. Beware that in many Linux distributions NDEBUG is not defined, so C/C++ assert() will by default be enabled for production in those environments. It may be important to use a different assertion mechanism or defining NDEBUG for production in those environments.

    Meitheal includes meaningful run-time assertions for internal application invariants. Assertions remain enabled in the configurations used for dynamic analysis, and the test and fuzzing processes exercise and check them. https://github.com/ryan-winkler/meitheal/tree/dev/apps/web https://github.com/ryan-winkler/meitheal/tree/dev/packages https://github.com/ryan-winkler/meitheal/blob/dev/tests/unit/framework-formula-fuzz.spec.ts



You can use tools and AI systems to propose changes via a simple URL, such as https://www.bestpractices.dev/en/projects/16683/choose/edit?osps_ac_01_01_status=Met&osps_ac_01_01_justification=GitHub+enforced. See our automation proposals system for how to do that. 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 Ryan Winkler and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Ryan Winkler.
Entry created on 2026-11-14 09:37:07 UTC, last updated on 2026-11-14 22:24:16 UTC. Last achieved passing badge on 2026-11-14 21:57:16 UTC.