AerolVM

Проекты, которые следуют приведенным ниже лучшим практикам, могут добровольно и самостоятельно оценить себя и продемонстрировать, что они получили значок Open Source Security Foundation (OpenSSF).

Не существует набора практик, гарантирующего, что у программного обеспечения никогда не будет недостатков или уязвимостей; даже формальные методы могут не помочь, если спецификации или допущения ошибочны. Также не существует какой-либо практики, которая могла бы гарантировать, что проект будет поддерживать здоровое и хорошо функционирующее сообщество разработчиков. Однако следующие хорошие правила могут помочь улучшить результаты проектов. Например, некоторые правила описывают ревью несколькими участниками перед выпуском, что может помочь найти технические уязвимости, которые было бы сложно найти другим способом, и помочь построить доверие и желание дальнейшего взаимодействия между разработчиками из разных компаний. Чтобы получить значок, нужно выполнить все критерии с ключевыми словами "НЕОБХОДИМО"/"ОБЯЗАН"/"НЕДОПУСТИМО", все критерии со словом "СЛЕДУЕТ" либо должны удовлетворяться, либо должно быть приведено обоснование их невыполнения, и все критерии со словом "ЖЕЛАТЕЛЬНО" могут быть удовлетворены ИЛИ неудовлетворены (желательно, чтобы они были хотя бы рассмотрены). Если вы хотите ввести общий комментарий вместо объяснения, почему текущая ситуация приемлема, начните текст с '//' и пробела. Приветствуется обратная связь через сайт на GitHub в виде issues или pull requests. Существует также список рассылки для общих вопросов.

Мы с удовольствием предоставляем информацию на нескольких языках, однако, если есть какой-либо конфликт или несоответствие между переводами, английская версия является авторитетной.
Если это ваш проект, пожалуйста, отобразите статус вашего базового значка на странице проекта! Статус базового значка выглядит так: Базовый уровень значка для проекта 15170 - baseline-3 Вот как встроить базовый значок:
Вы можете показать статус базового значка, вставив это в ваш файл markdown:
[![OpenSSF Baseline](https://www.bestpractices.dev/projects/15170/baseline)](https://www.bestpractices.dev/projects/15170)
или вставив это в ваш HTML:
<a href="https://www.bestpractices.dev/projects/15170"><img src="https://www.bestpractices.dev/projects/15170/baseline"></a>


Это критерии Базового Уровня 2. Это критерии версии v2026.08.28.

Baseline Series: Базовый уровень 1 Базовый Уровень 2 Базовый Уровень 3

        

 Основы

  • Общая

    Обратите внимание, что другие проекты могут использовать то же имя.

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

    Используйте формат выражения лицензии SPDX; примеры включают «Apache-2.0», «BSD-2-Clause», «BSD-3-Clause», «GPL-2.0+», «LGPL-3.0+», «MIT» и «(BSD-2-Clause OR Ruby)».
    Если используется более одного языка, перечислите их через запятую (пробелы необязательны), и отсортируйте их от наиболее до наименее используемого. Если список длинный, пожалуйста, перечислите по крайней мере три наиболее распространенных. Если языка нет (например, это проект только для документации или только для тестирования), используйте один символ «-» (минус). Для каждого языка используйте общепринятую капитализацию названия, например «JavaScript».
    Common Platform Enumeration (CPE) - это структурированная схема именования для информационных систем, программного обеспечения и пакетов. Она используется в ряде систем и баз данных для отчетов об уязвимостях.

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

 Элементы управления 19/19 ●

  • Элементы управления


    Когда задача CI/CD выполняется без указания прав доступа, система CI/CD ОБЯЗАНА по умолчанию назначать задаче минимальные права, предоставленные в конвейере. [OSPS-AC-04.01]
    Настройте параметры проекта для назначения минимальных доступных прав новым конвейерам по умолчанию, предоставляя дополнительные права только при необходимости для конкретных задач.

    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



    Когда создается официальный выпуск, этому выпуску ОБЯЗАН быть назначен уникальный идентификатор версии. [OSPS-BR-02.01]
    Присваивайте уникальный идентификатор версии каждому выпуску, создаваемому проектом, следуя согласованному соглашению о наименовании или схеме нумерации. Примеры включают SemVer, CalVer или идентификатор коммита git.

    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



    Когда создается официальный выпуск, этот выпуск ОБЯЗАН содержать описательный журнал функциональных изменений и изменений безопасности. [OSPS-BR-04.01]
    Убедитесь, что все выпуски содержат описательный журнал изменений. Рекомендуется обеспечить, чтобы журнал изменений был читаемым человеком и содержал более подробные сведения, чем сообщения коммитов, такие как описания влияния на безопасность или релевантность для различных сценариев использования. Для обеспечения машиночитаемости размещайте содержимое под заголовком markdown, таким как "## Changelog".

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



    Когда конвейер сборки и выпуска загружает зависимости, он ОБЯЗАН использовать стандартизированные инструменты, где они доступны. [OSPS-BR-05.01]
    Используйте общие инструменты для вашей экосистемы, такие как менеджеры пакетов или инструменты управления зависимостями для загрузки зависимостей во время сборки. Это может включать использование файла зависимостей, lock-файла или манифеста для указания требуемых зависимостей, которые затем подключаются системой сборки.

    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



    Когда создается официальный выпуск, этот выпуск ОБЯЗАН быть подписан или учтен в подписанном манифесте, включающем криптографические хеши каждого актива. [OSPS-BR-06.01]
    Подписывайте все выпущенные программные активы во время сборки с использованием криптографической подписи или аттестаций, таких как подпись GPG или PGP, подписи Sigstore, происхождение SLSA или SLSA VSA. Включите криптографические хеши каждого актива в подписанный манифест или файл метаданных.

    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



    Когда проект создал выпуск, документация проекта ОБЯЗАНА включать описание того, как проект выбирает, получает и отслеживает свои зависимости. [OSPS-DO-06.01]
    Рекомендуется публиковать эту информацию вместе с технической документацией и документацией по дизайну проекта в общедоступном ресурсе, таком как репозиторий исходного кода, веб-сайт проекта или другой канал.


    Документация проекта ДОЛЖНА включать инструкции по сборке программного обеспечения, включая необходимые библиотеки, фреймворки, SDK и зависимости. [OSPS-DO-07.01]
    Рекомендуется публиковать эту информацию вместе с документацией для участников проекта, например в файле CONTRIBUTING.md или другой документации по задачам разработчика. Это также может быть задокументировано с помощью целей Makefile или других сценариев автоматизации.

    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



    Документация проекта ОБЯЗАНА включать список участников проекта, имеющих доступ к чувствительным ресурсам. [OSPS-GV-01.01]
    Документируйте участников проекта и их роли с помощью таких артефактов, как members.md, governance.md, maintainers.md или аналогичного файла в репозитории исходного кода проекта. Это может быть просто включение имен или учетных записей в список сопровождающих или более сложное в зависимости от управления проектом.

    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



    Документация проекта ОБЯЗАНА включать описания ролей и обязанностей участников проекта. [OSPS-GV-01.02]
    Документируйте участников проекта и их роли с помощью таких артефактов, как members.md, governance.md, maintainers.md или аналогичного файла в репозитории исходного кода проекта.

    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



    Документация проекта ОБЯЗАНА включать руководство для авторов кода, содержащее требования к приемлемым вкладам. [OSPS-GV-03.02]
    Расширьте содержимое CONTRIBUTING.md или CONTRIBUTING/ в документации проекта, чтобы изложить требования к приемлемым вкладам, включая стандарты кодирования, требования к тестированию и руководства по отправке для участников кода. Рекомендуется, чтобы это руководство было источником истины как для участников, так и для утверждающих.

    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



    Система управления версиями ОБЯЗАНА требовать от всех авторов кода подтверждения того, что они юридически уполномочены вносить соответствующие изменения, при каждом коммите. [OSPS-LE-01.01]
    Включите DCO в репозиторий проекта, требуя от участников кода утверждать, что они имеют законное право вносить соответствующий вклад в каждом коммите. Используйте проверку статуса, чтобы убедиться, что утверждение сделано. CLA также удовлетворяет этому требованию. Некоторые системы контроля версий, такие как GitHub, могут включать это в условия обслуживания платформы.

    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



    При внесении коммита в основную ветку все автоматические проверки статуса для коммитов ДОЛЖНЫ пройти успешно или быть явно обойдены вручную. [OSPS-QA-03.01]
    Настройте систему контроля версий проекта таким образом, чтобы все автоматические проверки статуса должны были пройти успешно или требовать ручного подтверждения перед тем, как коммит может быть объединен с основной веткой. Рекомендуется НЕ настраивать необязательные проверки статуса как требование успешного прохождения или провала, которые утверждающие могут быть склонны обойти.

    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



    Перед принятием коммита в проекте ДОЛЖЕН выполняться хотя бы один автоматизированный набор тестов в конвейере CI/CD для обеспечения соответствия изменений ожиданиям. [OSPS-QA-06.01]
    Автоматизированные тесты должны выполняться перед каждым объединением с основной веткой. Набор тестов должен выполняться в конвейере CI/CD, и результаты должны быть видны всем участникам. Набор тестов должен выполняться в согласованной среде и таким образом, чтобы участники могли выполнять тесты локально. Примеры наборов тестов включают модульные тесты, интеграционные тесты и сквозные тесты.

    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



    Когда проект выпустил релиз, документация проекта ДОЛЖНА включать проектную документацию, демонстрирующую все действия и участников в системе. [OSPS-SA-01.01]
    Включите в документацию проекта проектные описания, объясняющие действия и участников. Участники включают любую подсистему или сущность, которая может повлиять на другой сегмент в системе. Убедитесь, что эта информация обновляется для новых функций или критических изменений.

    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



    Когда проект выпустил релиз, документация проекта ДОЛЖНА включать описания всех внешних программных интерфейсов выпущенных программных активов. [OSPS-SA-02.01]
    Документируйте все программные интерфейсы (API) выпущенных программных активов, объясняя, как пользователи могут взаимодействовать с программным обеспечением и какие данные ожидаются или производятся. Убедитесь, что эта информация обновляется для новых функций или критических изменений.

    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



    Когда проект выпустил релиз, проект ДОЛЖЕН провести оценку безопасности для понимания наиболее вероятных и значимых потенциальных проблем безопасности, которые могут возникнуть в программном обеспечении. [OSPS-SA-03.01]
    Проведение оценки безопасности информирует как членов проекта, так и конечных потребителей о том, что проект понимает, какие проблемы могут возникнуть в программном обеспечении. Понимание того, какие угрозы могут быть реализованы, помогает проекту управлять рисками и справляться с ними. Эта информация полезна для конечных потребителей для демонстрации компетентности в области безопасности и практик проекта. Убедитесь, что эта информация обновляется для новых функций или критических изменений.

    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



    Документация проекта ОБЯЗАНА включать политику скоординированного раскрытия информации об уязвимостях (CVD) с четко определенными сроками реагирования. [OSPS-VM-01.01]
    Создайте файл SECURITY.md в корневом каталоге, описывающий политику проекта для координированного раскрытия уязвимостей. Включите метод сообщения об уязвимостях. Установите ожидания относительно того, как проект будет реагировать и решать сообщенные проблемы.

    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



    Документация проекта ОБЯЗАНА предоставлять способ конфиденциального сообщения об уязвимостях непосредственно контактам по вопросам безопасности в проекте. [OSPS-VM-03.01]
    Предоставьте средства для того, чтобы исследователи безопасности могли приватно сообщать об уязвимостях в проект. Это может быть специальный адрес электронной почты, веб-форма, специализированные инструменты системы контроля версий, адреса электронной почты контактов по безопасности или другие методы.

    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



    Документация проекта ОБЯЗАНА публично публиковать данные об обнаруженных уязвимостях. [OSPS-VM-04.01]
    Предоставляйте информацию об известных уязвимостях в предсказуемом публичном канале, таком как запись CVE, запись в блоге или другом носителе. По мере возможности эта информация должна включать затронутые версии, как потребитель может определить, уязвим ли он, и инструкции по смягчению последствий или исправлению.

    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



Вы можете использовать инструменты и системы ИИ для предложения изменений через простой URL, например https://www.bestpractices.dev/ru/projects/15170/choose/edit?osps_ac_01_01_status=Met&osps_ac_01_01_justification=GitHub+enforced. Смотрите нашу систему автоматизированных предложений о том, как это сделать. Эти данные доступны по лицензии Community Data License Agreement – Permissive, Version 2.0 (CDLA-Permissive-2.0). Это означает, что получатель данных может распространять данные с изменениями или без них, при условии, что получатель данных предоставляет текст данного соглашения вместе с распространяемыми данными. Пожалуйста, укажите в качестве источника Suman и участников OpenSSF Best Practices badge.

Владелец анкеты на значок проекта: Suman.
2026-10-02 15:43:29 UTC, последнее изменение сделано 2026-10-03 09:07:55 UTC. Последний раз условия для получения значка были выполнены 2026-10-02 22:18:41 UTC.