AerolVM

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 baseline badge status on your project page! The baseline badge status looks like this: Baseline badge level for project 15170 is baseline-3 Here is how to embed the baseline badge:
You can show your baseline badge status by embedding this in your markdown file:
[![OpenSSF Baseline](https://www.bestpractices.dev/projects/15170/baseline)](https://www.bestpractices.dev/projects/15170)
or by embedding this in your HTML:
<a href="https://www.bestpractices.dev/projects/15170"><img src="https://www.bestpractices.dev/projects/15170/baseline"></a>


These are the Baseline Level 2 criteria. These are criteria version v2026.08.28.

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

        

 Basics

  • General

    Note that other projects may use the same name.

    AerolVM is a self-hosted platform for creating isolated Docker-backed sandboxes on a single Linux host.

    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.

    AerolVM is a self-hosted platform for isolated Linux sandboxes, with Docker, Firecracker, WASM, and V8 isolate runtimes, plus optional multi-node cluster mode.

 Controls 19/19 ●

  • Controls


    When a CI/CD task is executed with no permissions specified, the CI/CD system MUST default the task's permissions to the lowest permissions granted in the pipeline. [OSPS-AC-04.01]
    Configure the project's settings to assign the lowest available permissions to new pipelines by default, granting additional permissions only when necessary for specific tasks.

    The repository Actions setting "Workflow permissions" is "Read repository contents and packages permissions". A job with no permissions block receives that read-only GITHUB_TOKEN. Workflows also set permissions explicitly, usually contents: read.
    https://github.com/aerol-ai/microvm/blob/main/.github/workflows/test.yml
    https://github.com/aerol-ai/microvm/blob/main/.github/workflows/release.yml



    When an official release is created, that release MUST be assigned a unique version identifier. [OSPS-BR-02.01]
    Assign a unique version identifier to each release produced by the project, following a consistent naming convention or numbering scheme. Examples include SemVer, CalVer, or git commit id.

    Official releases are GitHub releases identified by a unique git tag (v0.6.3, v0.6.2, v0.6.1, v0.6.0). The release workflow publishes assets to that tag. GitHub rejects a second release with the same tag.
    https://github.com/aerol-ai/microvm/releases/tag/v0.6.3
    https://github.com/aerol-ai/microvm/blob/main/.github/workflows/release.yml



    When an official release is created, that release MUST contain a descriptive log of functional and security modifications. [OSPS-BR-04.01]
    Ensure that all releases include a descriptive change log. It is recommended to ensure that the change log is human-readable and includes details beyond commit messages, such as descriptions of the security impact or relevance to different use cases. To ensure machine readability, place the content under a markdown header such as "## Changelog".

    Non-trivial release notes file in repository: https://github.com/aerol-ai/microvm/blob/main/CHANGELOG.md. [release_notes]



    When a build and release pipeline ingests dependencies, it MUST use standardized tooling where available. [OSPS-BR-05.01]
    Use a common tooling for your ecosystem, such as package managers or dependency management tools to ingest dependencies at build time. This may include using a dependency file, lock file, or manifest to specify the required dependencies, which are then pulled in by the build system.

    Release and CI install dependencies with the language's standard tool: Go modules (go build / go test), npm ci, Maven (mvn), pip (python -m pip install --require-hashes), and Cargo (cargo test --locked / cargo publish). Each reads the committed manifest and lockfile (go.mod, package-lock.json, pom.xml, requirements-ci.txt, Cargo.lock).
    https://github.com/aerol-ai/microvm/blob/main/.github/workflows/release.yml
    https://github.com/aerol-ai/microvm/blob/main/.github/workflows/test.yml
    https://github.com/aerol-ai/microvm/blob/main/.github/workflows/publish-sdks.yml



    When an official release is created, that release MUST be signed or accounted for in a signed manifest including each asset's cryptographic hashes. [OSPS-BR-06.01]
    Sign all released software assets at build time with a cryptographic signature or attestations, such as GPG or PGP signature, Sigstore signatures, SLSA provenance, or SLSA VSAs. Include the cryptographic hashes of each asset in a signed manifest or metadata file.

    The release workflow writes checksums.txt (sha256sum of every asset), then signs those assets with actions/attest-build-provenance. The signed SLSA provenance bundle is published as v0.6.3.intoto.jsonl and stored in GitHub's attestation API. The bundle is copied in after signing so it is not a subject of itself.
    https://github.com/aerol-ai/microvm/releases/download/v0.6.3/checksums.txt
    https://github.com/aerol-ai/microvm/releases/download/v0.6.3/v0.6.3.intoto.jsonl
    https://github.com/aerol-ai/microvm/blob/main/.github/workflows/release.yml



    When the project has made a release, the project documentation MUST include a description of how the project selects, obtains, and tracks its dependencies. [OSPS-DO-06.01]
    It is recommended to publish this information alongside the project's technical & design documentation on a publicly viewable resource such as the source code repository, project website, or other channel.


    The project documentation MUST include instructions on how to build the software, including required libraries, frameworks, SDKs, and dependencies. [OSPS-DO-07.01]
    It is recommended to publish this information alongside the project's contributor documentation, such as in CONTRIBUTING.md or other developer task documentation. This may also be documented using Makefile targets or other automation scripts.

    Released versions record dependencies in committed manifests and lockfiles. A new dependency is added only in a reviewed pull request. CI obtains them with Go modules, npm ci, pip install --require-hashes, Maven, and cargo --locked. Dependabot opens a weekly update pull request for Go, GitHub Actions, npm, pip, Maven, and Cargo, and security updates are enabled. The Go CI job runs govulncheck.
    https://github.com/aerol-ai/microvm/blob/main/README.md#dependencies
    https://github.com/aerol-ai/microvm/blob/main/.github/dependabot.yml



    The project documentation MUST include a list of project members with access to sensitive resources. [OSPS-GV-01.01]
    Document project participants and their roles through such artifacts as members.md, governance.md, maintainers.md, or similar file within the source code repository of the project. This may be as simple as including names or account handles in a list of maintainers, or more complex depending on the project's governance.

    The README lists every GitHub account that can reach sensitive resources. sumansaurabh is the organization owner and repository admin (branch rules, Actions secrets, security settings, releases). akanshasinha19 and sumansaurabh-slice have write access (push, open pull requests, publish a release, dispatch the SDK publish workflow). Registry publish tokens are GitHub Actions secrets, read by the release and SDK publish workflows, and are not in the git tree.
    https://github.com/aerol-ai/microvm/blob/main/README.md#access-to-sensitive-resources



    The project documentation MUST include descriptions of the roles and responsibilities for members of the project [OSPS-GV-01.02]
    Document project participants and their roles through such artifacts as members.md, governance.md, maintainers.md, or similar file within the source code repository of the project.

    The README describes four roles. The maintainer (sumansaurabh) approves pull requests, publishes official releases and SDK packages, changes branch rules and Actions secrets, and triages reports sent to security@aerol.ai and GitHub private advisories. Code owners (sumansaurabh, akanshasinha19) review pull requests; a code owner other than the author approves changes to the default branch. Write collaborators (akanshasinha19, sumansaurabh-slice) push branches and open pull requests. Anyone else contributes through issues and pull requests and has no access to secrets, branch rules, or release publishing.
    https://github.com/aerol-ai/microvm/blob/main/README.md#roles-and-responsibilities
    https://github.com/aerol-ai/microvm/blob/main/.github/CODEOWNERS



    The project documentation MUST include a guide for code contributors that includes requirements for acceptable contributions. [OSPS-GV-03.02]
    Extend the CONTRIBUTING.md or CONTRIBUTING/ contents in the project documentation to outline the requirements for acceptable contributions, including coding standards, testing requirements, and submission guidelines for code contributors. It is recommended that this guide is the source of truth for both contributors and approvers.

    CONTRIBUTING.md is the contributor guide. A change is acceptable when it is a pull request approved by a code owner other than the author, the pull request description fills every template section, Go changes are formatted and tested (new code keeps the package at or above 85% line coverage), a user-facing API change updates each SDK that exposes it, and the diff contains no secrets. Changes to the service, store, Caddy client, API, or SDKs must address pr-review.md. The README Contributing section links to that guide.
    https://github.com/aerol-ai/microvm/blob/main/CONTRIBUTING.md
    https://github.com/aerol-ai/microvm/blob/main/README.md#contributing



    The version control system MUST require all code contributors to assert that they are legally authorized to make the associated contributions on every commit. [OSPS-LE-01.01]
    Include a DCO in the project's repository, requiring code contributors to assert that they are legally authorized to commit the associated contributions on every commit. Use a status check to ensure the assertion is made. A CLA also satisfies this requirement. Some version control systems, such as GitHub, may include this in the platform terms of service.

    Every pull request commit must include a Signed-off-by trailer (git commit -s). CONTRIBUTING.md defines that trailer as the Developer Certificate of Origin 1.1, the contributor's assertion that they are legally allowed to submit the change. The trailer is checked inside the changes job, which the default-branch ruleset requires to pass before merge. There are no bypass actors on that ruleset.
    https://github.com/aerol-ai/microvm/blob/main/CONTRIBUTING.md#developer-certificate-of-origin
    https://github.com/aerol-ai/microvm/blob/main/.github/workflows/test.yml
    https://github.com/aerol-ai/microvm/rules/16186085



    When a commit is made to the primary branch, any automated status checks for commits MUST pass or be manually bypassed. [OSPS-QA-03.01]
    Configure the project's version control system to require that all automated status checks pass or require manual acknowledgement before a commit can be merged into the primary branch. It is recommended that any optional status checks are NOT configured as a pass or fail requirement that approvers may be tempted to bypass.

    The default-branch ruleset requires the changes status check, with strict status checks and no bypass actors. A commit reaches main only through a pull request whose required checks passed.
    https://github.com/aerol-ai/microvm/rules/16186085
    https://github.com/aerol-ai/microvm/blob/main/.github/workflows/test.yml



    Prior to a commit being accepted, the project's CI/CD pipelines MUST run at least one automated test suite to ensure the changes meet expectations. [OSPS-QA-06.01]
    Automated tests should be run prior to every merge into the primary branch. The test suite should be run in a CI/CD pipeline and the results should be visible to all contributors. The test suite should be run in a consistent environment and should be run in a way that allows contributors to run the tests locally. Examples of test suites include unit tests, integration tests, and end-to-end tests.

    The default-branch ruleset requires the changes status check and has no bypass actors. That job fails unless the Go SDK test suite passed on the pull request, and unless every suite selected by the changed paths passed (daemon unit tests, race tests, govulncheck, and the TypeScript, Python, Java, Rust, and Go SDK suites). The merge queue re-runs the same check.
    https://github.com/aerol-ai/microvm/blob/main/.github/workflows/test.yml
    https://github.com/aerol-ai/microvm/rules/16186085



    When the project has made a release, the project documentation MUST include design documentation demonstrating all actions and actors within the system. [OSPS-SA-01.01]
    Include designs in the project documentation that explains the actions and actors. Actors include any subsystem or entity that can influence another segment in the system. Ensure this is updated for new features or breaking changes.

    DESIGN.md is the design of a released node. It lists every actor (operator, API client, sandbox guest, preview or TCP client, SSH client, cluster peer, external storage) and the action each one can cause, with the component that carries the action out. Cluster peer actions do not run when cluster mode is off.
    https://github.com/aerol-ai/microvm/blob/main/DESIGN.md
    https://github.com/aerol-ai/microvm/blob/main/README.md#documentation



    When the project has made a release, the project documentation MUST include descriptions of all external software interfaces of the released software assets. [OSPS-SA-02.01]
    Document all software interfaces (APIs) of the released software assets, explaining how users can interact with the software and what data is expected or produced. Ensure this is updated for new features or breaking changes.

    The docs describe the external interfaces of the released software: the HTTP API and SDKs, the Daytona and E2B facades, HTTP preview URLs, TCP/TLS ports, SSH, filesystem and exec, external storage, and the installer.
    https://microvm.aerol.ai/sandboxes
    https://microvm.aerol.ai/sdk-setup
    https://microvm.aerol.ai/preview
    https://microvm.aerol.ai/tcp-ports
    https://microvm.aerol.ai/ssh-access
    https://microvm.aerol.ai/getting-started



    When the project has made a release, the project MUST perform a security assessment to understand the most likely and impactful potential security problems that could occur within the software. [OSPS-SA-03.01]
    Performing a security assessment informs both project members as well as downstream consumers that the project understands what problems could arise within the software. Understanding what threats could be realized helps the project manage and address risk. This information is useful to downstream consumers to demonstrate the security acumen and practices of the project. Ensure this is updated for new features or breaking changes.

    SECURITY-ASSESSMENT.md records the assessment for the 0.6.3 release and the standing model. The most severe problems are host command execution, host path traversal, cross-tenant access, API or SSH authentication bypass, egress bypass, and a tampered release. The 0.6.3 review fixed the mount-source and WASM toolhost command-execution bugs and the path-traversal bugs. Releases are covered by checksums and a signed provenance bundle. Running code inside a sandbox the caller owns is intended.
    https://github.com/aerol-ai/microvm/blob/main/SECURITY-ASSESSMENT.md
    https://github.com/aerol-ai/microvm/blob/main/CHANGELOG.md



    The project documentation MUST include a policy for coordinated vulnerability disclosure (CVD), with a clear timeframe for response. [OSPS-VM-01.01]
    Create a SECURITY.md file at the root of the directory, outlining the project's policy for coordinated vulnerability disclosure. Include a method for reporting vulnerabilities. Set expectations for how the project will respond and address reported issues.

    SECURITY.md is the coordinated disclosure policy. Acknowledgement within 3 business days, initial assessment within 7 business days, a fix for a critical issue in about 14 days, a high issue in about 30 days, and other issues in the next release. The fix is published as a GitHub Security Advisory with the release.
    https://github.com/aerol-ai/microvm/blob/main/SECURITY.md



    The project documentation MUST provide a means for private vulnerability reporting directly to the security contacts within the project. [OSPS-VM-03.01]
    Provide a means for security researchers to report vulnerabilities privately to the project. This may be a dedicated email address, a web form, VCS specialized tools, email addresses for security contacts, or other methods.

    Private reports go directly to the security contacts: a GitHub private advisory, or email to security@aerol.ai. Discord is first contact only and must not contain vulnerability details.
    https://github.com/aerol-ai/microvm/security/advisories/new
    https://github.com/aerol-ai/microvm/blob/main/SECURITY.md



    The project documentation MUST publicly publish data about discovered vulnerabilities. [OSPS-VM-04.01]
    Provide information about known vulnerabilities in a predictable public channel, such as a CVE entry, blog post, or other medium. To the degree possible, this information should include affected version(s), how a consumer can determine if they are vulnerable, and instructions for mitigation or remediation.

    Discovered vulnerabilities are published as GitHub Security Advisories and in the changelog. The critical mount-source bug fixed in 0.6.3 is GHSA-5pqm-4fh4-585q.
    https://github.com/aerol-ai/microvm/security/advisories/GHSA-5pqm-4fh4-585q
    https://github.com/aerol-ai/microvm/blob/main/CHANGELOG.md



You can use tools and AI systems to propose changes via a simple URL, such as https://www.bestpractices.dev/en/projects/15170/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 Suman and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Suman.
Entry created on 2026-10-02 15:43:29 UTC, last updated on 2026-10-03 09:07:55 UTC. Last achieved passing badge on 2026-10-02 22:18:41 UTC.