awsum

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 12979 is passing 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/12979/badge)](https://www.bestpractices.dev/projects/12979)
or by embedding this in your HTML:
<a href="https://www.bestpractices.dev/projects/12979"><img src="https://www.bestpractices.dev/projects/12979/badge"></a>


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

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

        

 Basics 13/13

  • General

    Note that other projects may use the same name.

    Correctness-first, cross-target functional language

    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.
  • Basic project website content


    The project website MUST succinctly describe what the software does (what problem does it solve?). [description_good]
    This MUST be in language that potential users can understand (e.g., it uses minimal jargon).

    The home page (https://awsum-lang.org/) opens with a one-line summary — "Correctness-first, cross-target functional language" — followed by two short paragraphs explaining each half. The "Why Awsum?" section names the problem ("languages implement the wrong choices — people die, billions burn") with concrete historical incidents, and lists how Awsum addresses each class (Maybe instead of null, Either-typed arithmetic errors, stack-safe recursion of any shape, compile-time platform-effect gating).



    The project website MUST provide information on how to: obtain, provide feedback (as bug reports or enhancements), and contribute to the software. [interact]

    The Install page (https://awsum-lang.org/install) covers obtaining the software — prebuilt binaries for macOS / Linux (x86_64 + aarch64) / Windows, install commands for the five target runtimes, and install links for all five editor extensions. The Community page (https://awsum-lang.org/community) directs bug reports and feature requests to the per-repository issue trackers under github.com/awsum-lang and points contributors at each repository's CONTRIBUTING.md (development setup, signed-commit policy, PR conventions).



    The information on how to contribute MUST explain the contribution process (e.g., are pull requests used?) (URL required) [contribution]
    We presume that projects on GitHub use issues and pull requests unless otherwise noted. This information can be short, e.g., stating that the project uses pull requests, an issue tracker, or posts to a mailing list (which one?)

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



    The information on how to contribute SHOULD include the requirements for acceptable contributions (e.g., a reference to any required coding standard). (URL required) [contribution_requirements]

    Each repository's CONTRIBUTING.md documents the acceptance bar: signed commits (mandatory for merge), green CI on check-and-build.yml, a CHANGELOG.md entry under ## [Unreleased] for user-visible changes (grouped by Keep-a-Changelog section), and just fix passing locally (auto-formatter Ormolu, hlint, build with pedantic warnings, snapshot tests, property tests). The same shape is mirrored across all nine public repositories under github.com/awsum-lang. The compiler's reference document is at https://github.com/awsum-lang/awsum/blob/main/CONTRIBUTING.md.


  • FLOSS license


    The software produced by the project MUST be released as FLOSS. [floss_license]
    FLOSS is software released in a way that meets the Open Source Definition or Free Software Definition. Examples of such licenses include the CC0, MIT, BSD 2-clause, BSD 3-clause revised, Apache 2.0, Lesser GNU General Public License (LGPL), and the GNU General Public License (GPL). For our purposes, this means that the license MUST be: The software MAY also be licensed other ways (e.g., "GPLv2 or proprietary" is acceptable).

    The Apache-2.0 license is approved by the Open Source Initiative (OSI).



    It is SUGGESTED that any required license(s) for the software produced by the project be approved by the Open Source Initiative (OSI). [floss_license_osi]
    The OSI uses a rigorous approval process to determine which licenses are OSS.

    The Apache-2.0 license is approved by the Open Source Initiative (OSI).



    The project MUST post the license(s) of its results in a standard location in their source repository. (URL required) [license_location]
    One convention is posting the license as a top-level file named LICENSE or COPYING, which MAY be followed by an extension such as ".txt" or ".md". An alternative convention is to have a directory named LICENSES containing license file(s); these files are typically named as their SPDX license identifier followed by an appropriate file extension, as described in the REUSE Specification. Note that this criterion is only a requirement on the source repository. You do NOT need to include the license file when generating something from the source code (such as an executable, package, or container). For example, when generating an R package for the Comprehensive R Archive Network (CRAN), follow standard CRAN practice: if the license is a standard license, use the standard short license specification (to avoid installing yet another copy of the text) and list the LICENSE file in an exclusion file such as .Rbuildignore. Similarly, when creating a Debian package, you may put a link in the copyright file to the license text in /usr/share/common-licenses, and exclude the license file from the created package (e.g., by deleting the file after calling dh_auto_install). We encourage including machine-readable license information in generated formats where practical.

    Non-trivial license location file in repository: https://github.com/awsum-lang/awsum/blob/main/LICENSE.


  • Documentation


    The project MUST provide basic documentation for the software produced by the project. [documentation_basics]
    This documentation must be in some media (such as text or video) that includes: how to install it, how to start it, how to use it (possibly with a tutorial using examples), and how to use it securely (e.g., what to do and what not to do) if that is an appropriate topic for the software. The security documentation need not be long. The project MAY use hypertext links to non-project material as documentation. If the project does not produce software, choose "not applicable" (N/A).

    Some documentation basics file contents found.



    The project MUST provide reference documentation that describes the external interface (both input and output) of the software produced by the project. [documentation_interface]
    The documentation of an external interface explains to an end-user or developer how to use it. This would include its application program interface (API) if the software has one. If it is a library, document the major classes/types and methods/functions that can be called. If it is a web application, define its URL interface (often its REST interface). If it is a command-line interface, document the parameters and options it supports. In many cases it's best if most of this documentation is automatically generated, so that this documentation stays synchronized with the software as it changes, but this isn't required. The project MAY use hypertext links to non-project material as documentation. Documentation MAY be automatically generated (where practical this is often the best way to do so). Documentation of a REST interface may be generated using Swagger/OpenAPI. Code interface documentation MAY be generated using tools such as JSDoc (JavaScript), ESDoc (JavaScript), pydoc (Python), devtools (R), pkgdown (R), and Doxygen (many). Merely having comments in implementation code is not sufficient to satisfy this criterion; there needs to be an easy way to see the information without reading through all the source code. If the project does not produce software, choose "not applicable" (N/A).

    The Documentation page (https://awsum-lang.org/docs) opens with a CLI reference for the four primary commands — awsum build, awsum run, awsum check, awsum format — showing input file, command-line flags, and output artifacts for each of the five backends (LLVM, JVM, CLR, WASM, JS). It links to the language references on GitHub: docs/type-system.md (every type-system feature illustrated with programs that compile and programs that get rejected), docs/spec/grammar.ebnf (formal surface grammar), docs/principles.md (semantic contract), docs/targets.md (per-backend output details), docs/compatibility.md (supported host-OS / architecture matrix), and stdlib/Prelude.aww (the bundled prelude — the source of every library function and type the user can call, with sigatures and docstrings).


  • Other


    The project sites (website, repository, and download URLs) MUST support HTTPS using TLS. [sites_https]
    This requires that the project home page URL and the version control repository URL begin with "https:", not "http:". You can get free certificates from Let's Encrypt. Projects MAY implement this criterion using (for example) GitHub pages, GitLab pages, or SourceForge project pages. If you support HTTP, we urge you to redirect the HTTP traffic to HTTPS.

    Given only https: URLs.



    The project MUST have one or more mechanisms for discussion (including proposed changes and issues) that are searchable, allow messages and topics to be addressed by URL, enable new people to participate in some of the discussions, and do not require client-side installation of proprietary software. [discussion]
    Examples of acceptable mechanisms include archived mailing list(s), GitHub issue and pull request discussions, Bugzilla, Mantis, and Trac. Asynchronous discussion mechanisms (like IRC) are acceptable if they meet these criteria; make sure there is a URL-addressable archiving mechanism. Proprietary JavaScript, while discouraged, is permitted.

    GitHub supports discussions on issues and pull requests.



    The project SHOULD provide documentation in English and be able to accept bug reports and comments about code in English. [english]
    English is currently the lingua franca of computer technology; supporting English increases the number of different potential developers and reviewers worldwide. A project can meet this criterion even if its core developers' primary language is not English.

    All public-facing documentation is in English: the website (awsum-lang.org), every README, CONTRIBUTING.md, CHANGELOG.md, and the design docs under awsum/docs/ across all nine public repositories at github.com/awsum-lang. Source code identifiers and comments are also English-only — the compiler's just fix precommit runs scripts/detect-cyrillic.sh and rejects any non-Latin source. Bug reports and discussions on GitHub are accepted and answered in English.



    The project MUST be maintained. [maintained]
    As a minimum, the project should attempt to respond to significant problem and vulnerability reports. A project that is actively pursuing a badge is probably maintained. All projects and people have limited resources, and typical projects must reject some proposed changes, so limited resources and proposal rejections do not by themselves indicate an unmaintained project.

    When a project knows that it will no longer be maintained, it should set this criterion to "Unmet" and use the appropriate mechanism(s) to indicate to others that it is not being maintained. For example, use “DEPRECATED” as the first heading of its README, add “DEPRECATED” near the beginning of its home page, add “DEPRECATED” to the beginning of its code repository project description, add a no-maintenance-intended badge in its README and/or home page, mark it as deprecated in any package repositories (e.g., npm deprecate), and/or use the code repository's marking system to archive it (e.g., GitHub's "archive" setting, GitLab’s "archived" marking, Gerrit's "readonly" status, or SourceForge’s "abandoned" project status). Additional discussion can be found here.

    The compiler repository at github.com/awsum-lang/awsum is under continuous active development. Tagged releases are listed at github.com/awsum-lang/awsum/releases; commit history on the main branch is at github.com/awsum-lang/awsum/commits/main. Every change reaches main through a pull request gated by the check-and-build.yml CI workflow.


 Change Control 9/9

  • Public version-controlled source repository


    The project MUST have a version-controlled source repository that is publicly readable and has a URL. [repo_public]
    The URL MAY be the same as the project URL. The project MAY use private (non-public) branches in specific cases while the change is not publicly released (e.g., for fixing a vulnerability before it is revealed to the public).

    Repository on GitHub, which provides public git repositories with URLs.



    The project's source repository MUST track what changes were made, who made the changes, and when the changes were made. [repo_track]

    Repository on GitHub, which uses git. git can track the changes, who made them, and when they were made.



    To enable collaborative review, the project's source repository MUST include interim versions for review between releases; it MUST NOT include only final releases. [repo_interim]
    Projects MAY choose to omit specific interim versions from their public source repositories (e.g., ones that fix specific non-public security vulnerabilities, may never be publicly released, or include material that cannot be legally posted and are not in the final release).

    The compiler's main branch at github.com/awsum-lang/awsum/commits/main contains all interim commits between tagged releases — each change reaches main through a reviewed pull request gated by CI, never as a "release drop". Every commit on main is a reviewable interim state.



    It is SUGGESTED that common distributed version control software be used (e.g., git) for the project's source repository. [repo_distributed]
    Git is not specifically required and projects can use centralized version control software (such as subversion) with justification.

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


  • Unique version numbering


    The project results MUST have a unique version identifier for each release intended to be used by users. [version_unique]
    This MAY be met in a variety of ways including a commit IDs (such as git commit id or mercurial changeset id) or a version number (including version numbers that use semantic versioning or date-based schemes like YYYYMMDD).

    Every release of the compiler is published with a unique semantic-version git tag (v0.0.1, v0.0.2, …) at github.com/awsum-lang/awsum/releases. The same version is embedded into the binary (queryable via awsum --version), into download-artifact filenames, and is compared by the LSP server against the expectedAwsumVersion value each editor extension supplies during initialization. Each of the five editor-extension repositories follows the same scheme on its own independent release stream.



    It is SUGGESTED that the Semantic Versioning (SemVer) or Calendar Versioning (CalVer) version numbering format be used for releases. It is SUGGESTED that those who use CalVer include a micro level value. [version_semver]
    Projects should generally prefer whatever format is expected by their users, e.g., because it is the normal format used by their ecosystem. Many ecosystems prefer SemVer, and SemVer is generally preferred for application programmer interfaces (APIs) and software development kits (SDKs). CalVer tends to be used by projects that are large, have an unusually large number of independently-developed dependencies, have a constantly-changing scope, or are time-sensitive. It is SUGGESTED that those who use CalVer include a micro level value, because including a micro level supports simultaneously-maintained branches whenever that becomes necessary. Other version numbering formats may be used as version numbers, including git commit IDs or mercurial changeset IDs, as long as they uniquely identify versions. However, some alternatives (such as git commit IDs) can cause problems as release identifiers, because users may not be able to easily determine if they are up-to-date. The version ID format may be unimportant for identifying software releases if all recipients only run the latest version (e.g., it is the code for a single website or internet service that is constantly updated via continuous delivery).


    It is SUGGESTED that projects identify each release within their version control system. For example, it is SUGGESTED that those using git identify each release using git tags. [version_tags]

    Every release is identified by an annotated git tag of the form vMAJOR.MINOR.PATCH in the compiler's repository. The full list is at github.com/awsum-lang/awsum/tags; each tag is also mounted as a GitHub Release with notes drawn from CHANGELOG.md.


  • Release notes


    The project MUST provide, in each release, release notes that are a human-readable summary of major changes in that release to help users determine if they should upgrade and what the upgrade impact will be. The release notes MUST NOT be the raw output of a version control log (e.g., the "git log" command results are not release notes). Projects whose results are not intended for reuse in multiple locations (such as the software for a single website or service) AND employ continuous delivery MAY select "N/A". (URL required) [release_notes]
    The release notes MAY be implemented in a variety of ways. Many projects provide them in a file named "NEWS", "CHANGELOG", or "ChangeLog", optionally with extensions such as ".txt", ".md", or ".html". Historically the term "change log" meant a log of every change, but to meet these criteria what is needed is a human-readable summary. The release notes MAY instead be provided by version control system mechanisms such as the GitHub Releases workflow.

    Non-trivial release notes file in repository: https://github.com/awsum-lang/awsum/blob/main/CHANGELOG.md.



    The release notes MUST identify every publicly known run-time vulnerability fixed in this release that already had a CVE assignment or similar when the release was created. This criterion may be marked as not applicable (N/A) if users typically cannot practically update the software themselves (e.g., as is often true for kernel updates). This criterion applies only to the project results, not to its dependencies. If there are no release notes or there have been no publicly known vulnerabilities, choose N/A. [release_notes_vulns]
    This criterion helps users determine if a given update will fix a vulnerability that is publicly known, to help users make an informed decision about updating. If users typically cannot practically update the software themselves on their computers, but must instead depend on one or more intermediaries to perform the update (as is often the case for a kernel and low-level software that is intertwined with a kernel), the project may choose "not applicable" (N/A) instead, since this additional information will not be helpful to those users. Similarly, a project may choose N/A if all recipients only run the latest version (e.g., it is the code for a single website or internet service that is constantly updated via continuous delivery). This criterion only applies to the project results, not its dependencies. Listing the vulnerabilities of all transitive dependencies of a project becomes unwieldy as dependencies increase and vary, and is unnecessary since tools that examine and track dependencies can do this in a more scalable way.

    No publicly known run-time vulnerabilities have been assigned to the Awsum compiler or any of the awsum-lang/ public repositories to date. Release notes are nonetheless maintained in CHANGELOG.md (Keep-a-Changelog format) and surfaced as the body of each GitHub Release; the moment a CVE is filed against an Awsum release, the next release's notes will identify it under a Security section.


 Reporting 8/8

  • Bug-reporting process


    The project MUST provide a process for users to submit bug reports (e.g., using an issue tracker or a mailing list). (URL required) [report_process]

    Non-trivial SECURITY[.md] file found file in repository: https://github.com/awsum-lang/awsum/blob/main/SECURITY.md. [osps_do_02_01]



    The project SHOULD use an issue tracker for tracking individual issues. [report_tracker]

    Every public repository under github.com/awsum-lang uses GitHub Issues for bug reports, feature requests, and per-release tracking. The compiler's tracker is at github.com/awsum-lang/awsum/issues; each editor extension and the tree-sitter grammar each have their own independent tracker on the same pattern.



    The project MUST acknowledge a majority of bug reports submitted in the last 2-12 months (inclusive); the response need not include a fix. [report_responses]


    The project SHOULD respond to a majority (>50%) of enhancement requests in the last 2-12 months (inclusive). [enhancement_responses]
    The response MAY be 'no' or a discussion about its merits. The goal is simply that there be some response to some requests, which indicates that the project is still alive. For purposes of this criterion, projects need not count fake requests (e.g., from spammers or automated systems). If a project is no longer making enhancements, please select "unmet" and include the URL that makes this situation clear to users. If a project tends to be overwhelmed by the number of enhancement requests, please select "unmet" and explain.


    The project MUST have a publicly available archive for reports and responses for later searching. (URL required) [report_archive]

    Bug reports and the project's responses are archived in GitHub Issues, which is publicly readable without authentication and offers full-text search over open and closed issues alike. The compiler's archive (open + closed) is accessible at https://github.com/awsum-lang/awsum/issues?q=is%3Aissue; each of the other eight public repositories in the awsum-lang organization has its own archive on the same URL pattern.


  • Vulnerability report process


    The project MUST publish the process for reporting vulnerabilities on the project site. (URL required) [vulnerability_report_process]
    Projects hosted on GitHub SHOULD consider enabling privately reporting a security vulnerability. Projects on GitLab SHOULD consider using its ability for privately reporting a vulnerability. Projects MAY identify a mailing address on https://PROJECTSITE/security, often in the form security@example.org. This vulnerability reporting process MAY be the same as its bug reporting process. Vulnerability reports MAY always be public, but many projects have a private vulnerability reporting mechanism.

    The vulnerability reporting process is published on both surfaces. On the project website at https://awsum-lang.org/community a "Report security issues" section names the preferred channel (GitHub Private Vulnerability Reporting) and links to the full policy. The full policy itself lives at https://github.com/awsum-lang/awsum/security/policy (rendered from SECURITY.md): preferred and fallback channels, scope, supported-version policy, and committed acknowledgement / fix timelines (7 days / 90 days). The same SECURITY.md is mirrored across all nine public repositories in the awsum-lang organization.



    If private vulnerability reports are supported, the project MUST include how to send the information in a way that is kept private. (URL required) [vulnerability_report_private]
    Examples include a private defect report submitted on the web using HTTPS (TLS) or an email encrypted using OpenPGP. If vulnerability reports are always public (so there are never private vulnerability reports), choose "not applicable" (N/A).

    SECURITY.md (rendered at github.com/awsum-lang/awsum/security/policy) lists two private channels: GitHub Private Vulnerability Reporting (preferred — github.com/awsum-lang/awsum/security/advisories/new, visible only to maintainers and the reporter, supports CVE coordination) and a fallback email at security@awsum-lang.org. The policy explicitly warns against using public issues, pull requests, or discussions for security reports. The same channels are surfaced from the project website at https://awsum-lang.org/community#report-security-issues.



    The project's initial response time for any vulnerability report received in the last 6 months MUST be less than or equal to 14 days. [vulnerability_report_response]
    If there have been no vulnerabilities reported in the last 6 months, choose "not applicable" (N/A).

    No private vulnerability reports have been received through any of the published channels (GitHub Private Vulnerability Reporting or security@awsum-lang.org) in the last 6 months — the 14-day initial-response requirement is therefore satisfied vacuously. The published SECURITY.md commits to a 7-day acknowledgement target (stricter than the badge criterion) for any future report.


 Quality 13/13

  • Working build system


    If the software produced by the project requires building for use, the project MUST provide a working build system that can automatically rebuild the software from source code. [build]
    A build system determines what actions need to occur to rebuild the software (and in what order), and then performs those steps. For example, it can invoke a compiler to compile the source code. If an executable is created from source code, it must be possible to modify the project's source code and then generate an updated executable with those modifications. If the software produced by the project depends on external libraries, the build system does not need to build those external libraries. If there is no need to build anything to use the software after its source code is modified, select "not applicable" (N/A).

    The compiler is built with Haskell Stack from publicly pinned configuration (stack.yaml + package.yaml). Local builds run stack build directly or just build for the wrapped form with pedantic warnings (see github.com/awsum-lang/awsum/blob/main/justfile). The same build is re-run by the CI workflow .github/workflows/check-and-build.yml on every pull request across the host-OS / architecture matrix documented in docs/compatibility.md. Each of the eight other public repositories in the awsum-lang organization (editor extensions, tree-sitter grammar, website, examples) ships its own analogous build system on the toolchain native to that stack.



    It is SUGGESTED that common tools be used for building the software. [build_common_tools]
    For example, Maven, Ant, cmake, the autotools, make, rake (Ruby), or devtools (R).

    The compiler uses Haskell Stack (the canonical build tool for Haskell projects) configured by stack.yaml and package.yaml at the repository root. A thin just recipe layer at github.com/awsum-lang/awsum/blob/main/justfile wraps the common workflows (just build, just test, just fix) — just is a widely-used command runner, not a custom build system. Continuous integration runs on GitHub Actions (.github/workflows/check-and-build.yml). All toolchain versions are pinned in configuration files committed to the repository.



    The project SHOULD be buildable using only FLOSS tools. [build_floss_tools]

    The compiler is built entirely with FLOSS tools: Haskell Stack (BSD-3-Clause), GHC (BSD-3-Clause), just (CC0-1.0), and GitHub Actions runners running on FLOSS operating systems. No proprietary build dependency anywhere in the chain.
    https://github.com/awsum-lang/awsum/blob/main/stack.yaml


  • Automated test suite


    The project MUST use at least one automated test suite that is publicly released as FLOSS (this test suite may be maintained as a separate FLOSS project). The project MUST clearly show or document how to run the test suite(s) (e.g., via a continuous integration (CI) script or via documentation in files such as BUILD.md, README.md, or CONTRIBUTING.md). [test]
    The project MAY use multiple automated test suites (e.g., one that runs quickly, vs. another that is more thorough but requires special equipment). There are many test frameworks and test support systems available, including Selenium (web browser automation), Junit (JVM, Java), RUnit (R), testthat (R).

    The compiler ships a Hspec-based automated test suite under test/, released under the same Apache-2.0 license as the rest of the project. Two layers: snapshot tests across all five backends (just test) and property tests across all five backends with QuickCheck-generated inputs and an independently-computed expected value (just test-property). How to run is documented in docs/testing.md and exercised by the CI workflow .github/workflows/check-and-build.yml on every pull request.



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

    Tests are invocable through the standard Haskell tooling — stack test runs the Hspec suite directly, the same target the CI workflow at .github/workflows/check-and-build.yml invokes. The repository's justfile exposes the same target through just test (snapshot suite) and just test-property (property suite); both wrap stack test underneath.



    It is SUGGESTED that the test suite cover most (or ideally all) the code branches, input fields, and functionality. [test_most]

    The test suite covers the surface language, every compiler phase, and every backend. Snapshot tests under test/sources/successful/ and test/sources/errors/ exercise the frontend, typechecker, every lowering and Core-to-Core pass, and all five codegens (LLVM / JVM / CLR / WASM / JS); each program's stdout is asserted identical across the five backends, so every cross-backend divergence in any phase becomes a test failure. Property tests under test/sources/property/ with QuickCheck-generated inputs cover the input-value space — every generated case is fed through all five backends and compared against an independently-computed expected value defined in test/Awsum/PropertySpec.hs. The development workflow in docs/testing.md requires both suites to pass before a feature is considered finished.



    It is SUGGESTED that the project implement continuous integration (where new or changed code is frequently integrated into a central code repository and automated tests are run on the result). [test_continuous_integration]

    Continuous integration runs on every pull request via .github/workflows/check-and-build.yml. The workflow builds the compiler with pedantic warnings, runs the snapshot suite and the cross-backend property suite, and gates merge — a PR cannot land on main until CI is green. Every change therefore reaches the central code repository only after the full automated test suite has passed against it.


  • New functionality testing


    The project MUST have a general policy (formal or not) that as major new functionality is added to the software produced by the project, tests of that functionality should be added to an automated test suite. [test_policy]
    As long as a policy is in place, even by word of mouth, that says developers should add tests to the automated test suite for major new functionality, select "Met."

    The compiler's docs/testing.md section "Workflow when finishing a feature" states: "Any new functionality lands together with the tests that exercise it — snapshot tests for new language features or compiler passes, property tests for behaviour that has a generator-friendly input space." The full precommit just fix (format, lint, build, snapshot tests, property tests) then enforces that those tests pass before the change is pushed.



    The project MUST have evidence that the test_policy for adding tests has been adhered to in the most recent major changes to the software produced by the project. [tests_are_added]
    Major functionality would typically be mentioned in the release notes. Perfection is not required, merely evidence that tests are typically being added in practice to the automated test suite when new major functionality is added to the software produced by the project.

    Recent feature pull requests land with corresponding test sources under test/sources/. For example, #49 "Implement eqString" added test/sources/successful/string_eq/code/Main.aww (which auto-generates per-backend codegen and runtime-stdout snapshots), and the same pattern is visible across the merged-PR history at github.com/awsum-lang/awsum/pulls?q=is%3Apr+is%3Amerged — every PR that adds language- or compiler-visible behaviour also adds (or modifies) entries under test/sources/successful/ or test/sources/errors/. Pure-infrastructure PRs (license switch, CI tweaks) don't add tests, consistent with the policy in docs/testing.md.



    It is SUGGESTED that this policy on adding tests (see test_policy) be documented in the instructions for change proposals. [tests_documented_added]
    However, even an informal rule is acceptable as long as the tests are being added in practice.

    The compiler's CONTRIBUTING.md, under "Pull requests", states: "Any new functionality lands together with the tests that exercise it" with a link to the detailed workflow in docs/testing.md.


  • Warning flags


    The project MUST enable one or more compiler warning flags, a "safe" language mode, or use a separate "linter" tool to look for code quality errors or common simple mistakes, if there is at least one FLOSS tool that can implement this criterion in the selected language. [warnings]
    Examples of compiler warning flags include gcc/clang "-Wall". Examples of a "safe" language mode include JavaScript "use strict" and perl5's "use warnings". A separate "linter" tool is simply a tool that examines the source code to look for code quality errors or common simple mistakes. These are typically enabled within the source code or build instructions.

    The compiler enables every GHC warning. package.yaml sets ghc-options: -Weverything with a short list of explicit exclusions, and the build invocation in justfile is stack build --pedantic — --pedantic promotes warnings to errors. The separate FLOSS linter hlint is run by just lint-check and is part of the just fix precommit gate. CI .github/workflows/check-and-build.yml enforces both on every pull request.



    The project MUST address warnings. [warnings_fixed]
    These are the warnings identified by the implementation of the warnings criterion. The project should fix warnings or mark them in the source code as false positives. Ideally there would be no warnings, but a project MAY accept some warnings (typically less than 1 warning per 100 lines or less than 10 warnings).

    Warnings cannot accumulate in the codebase: stack build --pedantic (the build invocation in justfile and the CI workflow .github/workflows/check-and-build.yml) promotes every GHC warning to an error, so a pull request with any unaddressed warning fails CI and cannot be merged. hlint is run on the same gate. Any new warning surfaced by a new GHC release is fixed (or explicitly suppressed in package.yaml with a comment) as part of the upgrade.



    It is SUGGESTED that projects be maximally strict with warnings in the software produced by the project, where practical. [warnings_strict]
    Some warnings cannot be effectively enabled on some projects. What is needed is evidence that the project is striving to enable warning flags where it can, so that errors are detected early.

    The compiler enables -Weverything (the strictest GHC setting — all warnings, including ones disabled by -Wall), with a small explicit allow-list in package.yaml and a rationale comment above each suppression. stack build --pedantic promotes every remaining warning to a build error. hlint runs alongside on the same precommit and CI gate.


 Security 16/16

  • Secure development knowledge


    The project MUST have at least one primary developer who knows how to design secure software. (See ‘details’ for the exact requirements.) [know_secure_design]
    This requires understanding the following design principles, including the 8 principles from Saltzer and Schroeder:
    • economy of mechanism (keep the design as simple and small as practical, e.g., by adopting sweeping simplifications)
    • fail-safe defaults (access decisions should deny by default, and projects' installation should be secure by default)
    • complete mediation (every access that might be limited must be checked for authority and be non-bypassable)
    • open design (security mechanisms should not depend on attacker ignorance of its design, but instead on more easily protected and changed information like keys and passwords)
    • separation of privilege (ideally, access to important objects should depend on more than one condition, so that defeating one protection system won't enable complete access. E.G., multi-factor authentication, such as requiring both a password and a hardware token, is stronger than single-factor authentication)
    • least privilege (processes should operate with the least privilege necessary)
    • least common mechanism (the design should minimize the mechanisms common to more than one user and depended on by all users, e.g., directories for temporary files)
    • psychological acceptability (the human interface must be designed for ease of use - designing for "least astonishment" can help)
    • limited attack surface (the attack surface - the set of the different points where an attacker can try to enter or extract data - should be limited)
    • input validation with allowlists (inputs should typically be checked to determine if they are valid before they are accepted; this validation should use allowlists (which only accept known-good values), not denylists (which attempt to list known-bad values)).
    A "primary developer" in a project is anyone who is familiar with the project's code base, is comfortable making changes to it, and is acknowledged as such by most other participants in the project. A primary developer would typically make a number of contributions over the past year (via code, documentation, or answering questions). Developers would typically be considered primary developers if they initiated the project (and have not left the project more than three years ago), have the option of receiving information on a private vulnerability reporting channel (if there is one), can accept commits on behalf of the project, or perform final releases of the project software. If there is only one developer, that individual is the primary developer. Many books and courses are available to help you understand how to develop more secure software and discuss design. For example, the Secure Software Development Fundamentals course is a free set of three courses that explain how to develop more secure software (it's free if you audit it; for an extra fee you can earn a certificate to prove you learned the material).

    Vladimir Logachev is the sole primary developer of the Awsum compiler — initiator of the project, sole maintainer of github.com/awsum-lang/awsum, sole recipient of the private vulnerability-reporting channels, and the engineer who accepts commits and performs all releases. He is familiar with secure-design principles, including the Saltzer–Schroeder principles, and applies them throughout Awsum's design: economy of mechanism (small composable language with no defaulting, no shadowing, no catch-all on case); fail-safe defaults (errors are values via Either and IO e a, platform effects denied by default per program-type — using a browser-only effect in a CLI program is a compile error); complete mediation (every effect, pattern match, and arithmetic operation is mediated by the typechecker, with no escape hatch); open design (the compiler is FOSS and every design decision is documented in docs/); limited attack surface (no network operations, no dynamic plugin loading, dependencies pinned via stack.yaml); input validation with allowlists (the parser accepts only what the formal grammar describes, the typechecker rejects everything not explicitly permitted, row labels are validated against an allowlist with FNV-1a hash-collision detection, CLI flags are checked against an explicit option set); psychological acceptability (diagnostics carry source spans and machine-readable JSON, compiler-provided quick fixes surfaced through the LSP server to all five supported editors).



    At least one of the project's primary developers MUST know of common kinds of errors that lead to vulnerabilities in this kind of software, as well as at least one method to counter or mitigate each of them. [know_common_errors]
    Examples (depending on the type of software) include SQL injection, OS injection, classic buffer overflow, cross-site scripting, missing authentication, and missing authorization. See the CWE/SANS top 25 or OWASP Top 10 for commonly used lists. Many books and courses are available to help you understand how to develop more secure software and discuss common implementation errors that lead to vulnerabilities. For example, the Secure Software Development Fundamentals course is a free set of three courses that explain how to develop more secure software (it's free if you audit it; for an extra fee you can earn a certificate to prove you learned the material).

    Vladimir Logachev, as the sole primary developer, is familiar with common vulnerability classes relevant to compiler software — both classical (path traversal when reading source files, integer overflow in compiler internals, untrusted-input parser robustness, dependency-supply-chain risk, hash collisions in identifier tables) and code-generation-specific (memory safety in emitted LLVM/WASM via compiler-emitted reference counting, no undefined behaviour in generated IR, deterministic per-target lowering) — and applies mitigations consistently: input validation with allowlists for every external surface (grammar, type system, row-label hashes with explicit collision detection in Awsum.ElaborateLower, CLI flag parsing), Stack-pinned dependencies with no network operations, no dynamic plugin loading, OS-shell invocation only for build artefacts under paths the compiler itself controlled, and an arithmetic model (Either + typed overflow / underflow / precision-loss errors) that eliminates entire classes of silent corruption in user-written programs the compiler produces.


  • 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 use, by default, only cryptographic protocols and algorithms that are publicly published and reviewed by experts (if cryptographic protocols and algorithms are used). [crypto_published]
    These cryptographic criteria do not always apply because some software has no need to directly use cryptographic capabilities.

    The Awsum compiler does not use any cryptographic protocols or algorithms. There is no network operation, no signing or encryption of compiler output, no password handling, no certificate verification. The only hash function used internally is the non-cryptographic FNV-1a 32-bit for row-label tag dispatch in Awsum.ElaborateLower, with explicit collision detection at lowering time — it is not used in a security context.



    If the software produced by the project is an application or library, and its primary purpose is not to implement cryptography, then it SHOULD only call on software specifically designed to implement cryptographic functions; it SHOULD NOT re-implement its own. [crypto_call]

    The Awsum compiler does not use cryptography for any purpose; nothing is re-implemented because nothing is needed.



    All functionality in the software produced by the project that depends on cryptography MUST be implementable using FLOSS. [crypto_floss]

    The Awsum compiler does not use cryptography for any purpose.



    The security mechanisms within the software produced by the project MUST use default keylengths that at least meet the NIST minimum requirements through the year 2030 (as stated in 2012). It MUST be possible to configure the software so that smaller keylengths are completely disabled. [crypto_keylength]
    These minimum bitlengths are: symmetric key 112, factoring modulus 2048, discrete logarithm key 224, discrete logarithmic group 2048, elliptic curve 224, and hash 224 (password hashing is not covered by this bitlength, more information on password hashing can be found in the crypto_password_storage criterion). See https://www.keylength.com for a comparison of keylength recommendations from various organizations. The software MAY allow smaller keylengths in some configurations (ideally it would not, since this allows downgrade attacks, but shorter keylengths are sometimes necessary for interoperability).

    The Awsum compiler does not use cryptography for any purpose.



    The default security mechanisms within the software produced by the project MUST NOT depend on broken cryptographic algorithms (e.g., MD4, MD5, single DES, RC4, Dual_EC_DRBG), or use cipher modes that are inappropriate to the context, unless they are necessary to implement an interoperable protocol (where the protocol implemented is the most recent version of that standard broadly supported by the network ecosystem, that ecosystem requires the use of such an algorithm or mode, and that ecosystem does not offer any more secure alternative). The documentation MUST describe any relevant security risks and any known mitigations if these broken algorithms or modes are necessary for an interoperable protocol. [crypto_working]
    ECB mode is almost never appropriate because it reveals identical blocks within the ciphertext as demonstrated by the ECB penguin, and CTR mode is often inappropriate because it does not perform authentication and causes duplicates if the input state is repeated. In many cases it's best to choose a block cipher algorithm mode designed to combine secrecy and authentication, e.g., Galois/Counter Mode (GCM) and EAX. Projects MAY allow users to enable broken mechanisms (e.g., during configuration) where necessary for compatibility, but then users know they're doing it.

    The Awsum compiler does not use cryptography for any purpose.



    The default security mechanisms within the software produced by the project SHOULD NOT depend on cryptographic algorithms or modes with known serious weaknesses (e.g., the SHA-1 cryptographic hash algorithm or the CBC mode in SSH). [crypto_weaknesses]
    Concerns about CBC mode in SSH are discussed in CERT: SSH CBC vulnerability.

    The Awsum compiler does not use cryptography for any purpose.



    The security mechanisms within the software produced by the project SHOULD implement perfect forward secrecy for key agreement protocols so a session key derived from a set of long-term keys cannot be compromised if one of the long-term keys is compromised in the future. [crypto_pfs]

    The Awsum compiler does not use cryptography for any purpose.



    If the software produced by the project causes the storing of passwords for authentication of external users, the passwords MUST be stored as iterated hashes with a per-user salt by using a key stretching (iterated) algorithm (e.g., Argon2id, Bcrypt, Scrypt, or PBKDF2). See also OWASP Password Storage Cheat Sheet. [crypto_password_storage]
    This criterion applies only when the software is enforcing authentication of users using passwords for external users (aka inbound authentication), such as server-side web applications. It does not apply in cases where the software stores passwords for authenticating into other systems (aka outbound authentication, e.g., the software implements a client for some other system), since at least parts of that software must have often access to the unhashed password.


    The security mechanisms within the software produced by the project MUST generate all cryptographic keys and nonces using a cryptographically secure random number generator, and MUST NOT do so using generators that are cryptographically insecure. [crypto_random]
    A cryptographically secure random number generator may be a hardware random number generator, or it may be a cryptographically secure pseudo-random number generator (CSPRNG) using an algorithm such as Hash_DRBG, HMAC_DRBG, CTR_DRBG, Yarrow, or Fortuna. Examples of calls to secure random number generators include Java's java.security.SecureRandom and JavaScript's window.crypto.getRandomValues. Examples of calls to insecure random number generators include Java's java.util.Random and JavaScript's Math.random.

    The Awsum compiler does not use cryptography for any purpose; no key or nonce generation.


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


    The project MUST use a delivery mechanism that counters MITM attacks. Using https or ssh+scp is acceptable. [delivery_mitm]
    An even stronger mechanism is releasing the software with digitally signed packages, since that mitigates attacks on the distribution system, but this only works if the users can be confident that the public keys for signatures are correct and if the users will actually check the signature.

    Distribution channels use HTTPS exclusively. [osps_br_03_02]



    A cryptographic hash (e.g., a sha1sum) MUST NOT be retrieved over http and used without checking for a cryptographic signature. [delivery_unsigned]
    These hashes can be modified in transit.

    Nothing in the Awsum compiler retrieves a cryptographic hash over a network at any point. The install workflows documented on the project website at awsum-lang.org/install use HTTPS (TLS-secured) to download release artefacts from GitHub Releases, which are themselves served by GitHub over HTTPS. There is no http:// (plain HTTP) operation anywhere in the project's source, install instructions, or CI workflows.


  • Publicly known vulnerabilities fixed


    There MUST be no unpatched vulnerabilities of medium or higher severity that have been publicly known for more than 60 days. [vulnerabilities_fixed_60_days]
    The vulnerability must be patched and released by the project itself (patches may be developed elsewhere). A vulnerability becomes publicly known (for this purpose) once it has a CVE with publicly released non-paywalled information (reported, for example, in the National Vulnerability Database) or when the project has been informed and the information has been released to the public (possibly by the project). A vulnerability is considered medium or higher severity if its Common Vulnerability Scoring System (CVSS) base qualitative score is medium or higher. In CVSS versions 2.0 through 3.1, this is equivalent to a CVSS score of 4.0 or higher. Projects may use the CVSS score as published in a widely-used vulnerability database (such as the National Vulnerability Database) using the most-recent version of CVSS reported in that database. Projects may instead calculate the severity themselves using the latest version of CVSS at the time of the vulnerability disclosure, if the calculation inputs are publicly revealed once the vulnerability is publicly known. Note: this means that users might be left vulnerable to all attackers worldwide for up to 60 days. This criterion is often much easier to meet than what Google recommends in Rebooting responsible disclosure, because Google recommends that the 60-day period start when the project is notified even if the report is not public. Also note that this badge criterion, like other criteria, applies to the individual project. Some projects are part of larger umbrella organizations or larger projects, possibly in multiple layers, and many projects feed their results to other organizations and projects as part of a potentially-complex supply chain. An individual project often cannot control the rest, but an individual project can work to release a vulnerability patch in a timely way. Therefore, we focus solely on the individual project's response time. Once a patch is available from the individual project, others can determine how to deal with the patch (e.g., they can update to the newer version or they can apply just the patch as a cherry-picked solution).

    No publicly known unpatched vulnerabilities exist for the Awsum compiler. No CVEs have been assigned, and no reports have been submitted through the channels listed in SECURITY.md. The project commits to a 90-day fix-or-mitigation timeline once a vulnerability is reported, well within the 60-day post-disclosure window the criterion enforces.



    Projects SHOULD fix all critical vulnerabilities rapidly after they are reported. [vulnerabilities_critical_fixed]

    No vulnerabilities have been reported against the Awsum compiler. The published SECURITY.md commits to acknowledgement within 7 days and a fix or mitigation within 90 days; critical findings will be prioritized for faster turnaround as standard practice.


  • Other security issues


    The public repositories MUST NOT leak a valid private credential (e.g., a working password or private key) that is intended to limit public access. [no_leaked_credentials]
    A project MAY leak "sample" credentials for testing and unimportant databases, as long as they are not intended to limit public access.

    The compiler repository at github.com/awsum-lang/awsum contains no credentials, private keys, API tokens, or any other secret material. GitHub's secret-scanning runs on every push and has flagged no exposures. No CI workflow embeds plaintext secrets — anything required by CI uses GitHub Actions encrypted secrets at runtime.


 Analysis 8/8

  • Static code analysis


    At least one static code analysis tool (beyond compiler warnings and "safe" language modes) MUST be applied to any proposed major production release of the software before its release, if there is at least one FLOSS tool that implements this criterion in the selected language. [static_analysis]
    A static code analysis tool examines the software code (as source code, intermediate code, or executable) without executing it with specific inputs. For purposes of this criterion, compiler warnings and "safe" language modes do not count as static code analysis tools (these typically avoid deep analysis because speed is vital). Some static analysis tools focus on detecting generic defects, others focus on finding specific kinds of defects (such as vulnerabilities), and some do a combination. Examples of such static code analysis tools include cppcheck (C, C++), clang static analyzer (C, C++), SpotBugs (Java), FindBugs (Java) (including FindSecurityBugs), PMD (Java), Brakeman (Ruby on Rails), lintr (R), goodpractice (R), Coverity Quality Analyzer, SonarQube, Codacy, and HP Enterprise Fortify Static Code Analyzer. Larger lists of tools can be found in places such as the Wikipedia list of tools for static code analysis, OWASP information on static code analysis, NIST list of source code security analyzers, and Wheeler's list of static analysis tools. If there are no FLOSS static analysis tools available for the implementation language(s) used, you may select 'N/A'.

    The compiler's precommit and CI gate runs hlint (BSD-3-Clause, the canonical Haskell static-analysis linter), separate from the GHC compiler warnings. Invoked as just lint-check in justfile, part of the just fix full precommit, and re-run by CI in .github/workflows/check-and-build.yml. No production release ships unless hlint reports clean.



    It is SUGGESTED that at least one of the static analysis tools used for the static_analysis criterion include rules or approaches to look for common vulnerabilities in the analyzed language or environment. [static_analysis_common_vulnerabilities]
    Static analysis tools that are specifically designed to look for common vulnerabilities are more likely to find them. That said, using any static tools will typically help find some problems, so we are suggesting but not requiring this for the 'passing' level badge.

    The compiler is written in Haskell, where the type system itself enforces — by construction — many of the invariants that security-focused static analysers exist to catch in other languages: no null pointer dereferences (no implicit null), no buffer overflows (no raw pointer arithmetic, no manual length bookkeeping), no uninitialized memory reads, no implicit type conversions, no silent integer overflow in the compiler's own code (the production code uses explicit Integer or bounded arithmetic). -Weverything (in package.yaml) plus stack build --pedantic promote every such property to a build-failing diagnostic. hlint (run via just lint-check) adds code-quality and pattern-redundancy checks on top. There is no widely-adopted FLOSS Haskell-specific security linter equivalent to bandit / gosec; the type-system enforcement and pedantic compilation cover the spirit of the criterion in this language.



    All medium and higher severity exploitable vulnerabilities discovered with static code analysis MUST be fixed in a timely way after they are confirmed. [static_analysis_fixed]
    A vulnerability is considered medium or higher severity if its Common Vulnerability Scoring System (CVSS) base qualitative score is medium or higher. In CVSS versions 2.0 through 3.1, this is equivalent to a CVSS score of 4.0 or higher. Projects may use the CVSS score as published in a widely-used vulnerability database (such as the National Vulnerability Database) using the most-recent version of CVSS reported in that database. Projects may instead calculate the severity themselves using the latest version of CVSS at the time of the vulnerability disclosure, if the calculation inputs are publicly revealed once the vulnerability is publicly known. Note that criterion vulnerabilities_fixed_60_days requires that all such vulnerabilities be fixed within 60 days of being made public.

    No medium- or higher-severity exploitable vulnerabilities have been surfaced by static analysis on the Awsum compiler. hlint runs on every pull request via just fix and CI, and a clean report is a merge gate — any new finding would block merge and be addressed before the change lands. The same gate applies to release branches; no production release ships with outstanding findings.



    It is SUGGESTED that static source code analysis occur on every commit or at least daily. [static_analysis_often]

    hlint runs on every pull request via .github/workflows/check-and-build.yml, which gates merge — a PR cannot reach main until the static-analysis step is green. Every commit reaching the main branch has therefore passed static analysis.


  • Dynamic code analysis


    It is SUGGESTED that at least one dynamic analysis tool be applied to any proposed major production release of the software 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.

    The compiler is subject to property-based dynamic analysis through the QuickCheck suite under test/sources/property/, invoked as just test-property. Every generated input is compiled by each of the five backends (LLVM, JVM, CLR, WASM, JS) and run, then the stdout from each is compared against an independently-computed expected value defined in Haskell — any cross-backend divergence or any incorrect answer fails the test. The property suite is part of the just fix precommit pipeline and the CI gate at .github/workflows/check-and-build.yml, so no major release ships without it passing.



    It is SUGGESTED that if the software produced by the project includes software written using a memory-unsafe language (e.g., C or C++), then at least one dynamic tool (e.g., a fuzzer or web application scanner) be routinely used in combination with a mechanism to detect memory safety problems such as buffer overwrites. If the project does not produce software written in a memory-unsafe language, choose "not applicable" (N/A). [dynamic_analysis_unsafe]
    Examples of mechanisms to detect memory safety problems include Address Sanitizer (ASAN) (available in GCC and LLVM), Memory Sanitizer, and valgrind. Other potentially-used tools include thread sanitizer and undefined behavior sanitizer. Widespread assertions would also work.

    The Awsum compiler is written entirely in Haskell, a memory-safe garbage-collected language. No C / C++ / unsafe-Rust code is shipped in the compiler binary.



    It is SUGGESTED that the project use a configuration for at least some dynamic analysis (such as testing or fuzzing) which enables many assertions. In many cases these assertions should not be enabled in production builds. [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.

    The property-test suite (just test-property) is itself an assertion-rich dynamic-analysis configuration: every QuickCheck-generated input must produce stdout identical across all five backends and equal to an independently-computed expected value in Haskell — three layers of assertion per generated case. The compiler also includes always-on internal invariants (the Awsum.StackSafety post-pipeline verifier rejects any program where a non-tail self-call or non-trivial call-graph SCC survived the recursion-flattening passes; the Awsum.Reuse and Awsum.Lifetime passes assert well-formedness conditions on Core). These invariants ship enabled in production builds because their cost is negligible and they prevent silent miscompilation.



    All medium and higher severity exploitable vulnerabilities discovered with dynamic code analysis MUST be fixed in a timely way after they are confirmed. [dynamic_analysis_fixed]
    If you are not running dynamic code analysis and thus have not found any vulnerabilities in this way, choose "not applicable" (N/A). A vulnerability is considered medium or higher severity if its Common Vulnerability Scoring System (CVSS) base qualitative score is medium or higher. In CVSS versions 2.0 through 3.1, this is equivalent to a CVSS score of 4.0 or higher. Projects may use the CVSS score as published in a widely-used vulnerability database (such as the National Vulnerability Database) using the most-recent version of CVSS reported in that database. Projects may instead calculate the severity themselves using the latest version of CVSS at the time of the vulnerability disclosure, if the calculation inputs are publicly revealed once the vulnerability is publicly known.

    No medium- or higher-severity exploitable vulnerabilities have been surfaced by the project's dynamic-analysis suite (property tests, cross-backend identical-stdout invariant). The suite is a merge gate via just fix and the CI workflow .github/workflows/check-and-build.yml — any failure blocks merge and is addressed before the change lands; no release ships with outstanding findings.



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

Project badge entry owned by: Vladimir Logachev.
Entry created on 2026-05-25 21:16:57 UTC, last updated on 2026-05-25 22:39:10 UTC. Last achieved passing badge on 2026-05-25 22:39:10 UTC.