agaric

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

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

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


Это критерии уровня Gold. Вы также можете просмотреть критерии уровня Passing или Silver.

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

        

 Основы 0/5 ●

  • Общая

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

    Agaric — local-first, block-based note-taking app inspired by Org-mode and Logseq. Tauri 2 + React 19 + Rust.

    Используйте формат выражения лицензии 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) - это структурированная схема именования для информационных систем, программного обеспечения и пакетов. Она используется в ряде систем и баз данных для отчетов об уязвимостях.

  • Предварительные требования


    Недостаточно для значка.

    Проект ОБЯЗАН получить серебряный значок. [achieve_silver]

    Silver tier blocked by genuine gaps: bus_factor / access_continuity / two_person_review (solo project), build_reproducible (Gold-only, but tracked), test_statement_coverage90 / test_branch_coverage80 (currently ~88%/~79% per https://github.com/jfolcini/agaric/blob/main/pending/PEND-44-coverage-90.md), security_review (Gold; no formal periodic review), small_tasks/copyright_per_file/license_per_file (intentional non-policy per https://github.com/jfolcini/agaric/blob/main/docs/architecture/ci-and-tooling.md § Supply-chain posture § License headers).


  • Надзор за проектом


    Недостаточно для значка.

    Проект ОБЯЗАН иметь «коэффициент автобуса» 2 или более. (Требуется URL) [bus_factor]
    «Коэффициент автобуса» (или «коэффициент грузовика») - это минимальное количество участников проекта, которые должны внезапно исчезнуть из проекта («попасть под автобус»), чтобы проект заглох из-за отсутствия квалифицированного или компетентного персонала. Инструмент truck-factor может оценить это для проектов на GitHub. Для получения дополнительной информации см. статью Cosentino et al. Assessing the Bus Factor of Git Repositories.

    Solo project. Bus factor = 1. Honest call: this is the genuine current state of an early-stage solo OSS project. Tracked in https://github.com/jfolcini/agaric/blob/main/GOVERNANCE.md § Revisit triggers as a soft signal for governance-model evolution.


    Недостаточно для значка.

    Проект ОБЯЗАН иметь как минимум двух несвязанных значительных соавторов. (Требуется URL) [contributors_unassociated]
    Соавторы связаны, если они оплачиваются работой одной и той же организации (как работник или подрядчик), и организация может выиграть от результатов проекта. Финансовые гранты не считаются находящимися в одной организации, если они проходят через другие организации (например, гранты на науку, выплачиваемые различным организациям из общего правительства или источника НПО, не приводят к тому, что вкладчики могут быть связаны). Соавтор считается значительным, если за последний год он(а) внес(ла) заметный вклад в проект. Примерами хороших показателей значительного соавтора являются: написано не менее 1000 строк кода, внесено 50 коммитов или предоставлено не менее 20 страниц документации.

    Solo project — no external significant contributors yet. Flips to Met when the first sustained external contributor lands. Tracked as a soft revisit trigger in https://github.com/jfolcini/agaric/blob/main/GOVERNANCE.md § Revisit triggers.


  • Другое


    Недостаточно для значка.

    Проект ОБЯЗАН указывать лицензию в каждом исходном файле. Это МОЖЕТ быть сделано путем включения в комментарий рядом с началом каждого файла следующей строки: SPDX-License-Identifier: [SPDX-выражение лицензии для проекта]. [license_per_file]
    Это МОЖЕТ также быть сделано путем указания лицензии на естественном языке. Проект МОЖЕТ также включать стабильный URL-адрес, указывающий на текст лицензии, или полный текст лицензии. Обратите внимание, что критерий license_location требует помещать лицензию проекта в стандартном расположении. См. этот учебник SPDX для получения дополнительных сведений об SPDX-выражениях лицензии. Обратите внимание на связь с критерием copyright_per_file, содержимое для которого обычно предшествует информации о лицензии.

    Same as copyright_per_file — deliberate non-policy. Repo-level https://github.com/jfolcini/agaric/blob/main/LICENSE is canonical; per-file SPDX headers not enforced. Decision documented in https://github.com/jfolcini/agaric/blob/main/docs/architecture/ci-and-tooling.md § Supply-chain posture § License headers.


 Управление изменениями 3/4 ●

  • Публичное хранилище исходного кода с поддержкой версий


    Достаточно для значка!

    Хранилище проектного исходного кода ОБЯЗАНО использовать типовое ПО для распределенного управления версиями (например, git или mercurial). [repo_distributed]
    Не требуется именно git, и проекты могут использовать централизованное программное обеспечение для управления версиями (например, Subversion) с обоснованием.

    Project uses Git, a distributed VCS. Hosted at https://github.com/jfolcini/agaric .


    Недостаточно для значка.

    Проект ОБЯЗАН четко обозначать небольшие задачи, которые могут быть выполнены новыми или случайными участниками. (Требуется URL) [small_tasks]
    Это обозначение обычно делается путем маркировки выбранных проблем в трекере одним или несколькими тегами, которые использует проект для этой цели, например up-for-grabs, «только для новичков», «Небольшое исправление», «микрозадача» или IdealFirstBug. Эти новые задачи не обязательно требуют добавления функциональности; это может быть улучшение документации, добавление тестовых кейсов или что-то еще, что помогает проекту и помогает участнику лучше понять проект.

    No formal good-first-issue labelling. Solo project with no external contributors yet — labelling has no audience today. Will adopt once external contributors arrive (same revisit trigger as the governance roles table in https://github.com/jfolcini/agaric/blob/main/GOVERNANCE.md).


    Достаточно для значка!

    Проект ОБЯЗАН требовать двухфакторной аутентификации (ДФА) от разработчиков для изменения центрального хранилища или доступа к конфиденциальным данным (например, приватным отчетам об уязвимостях). Этот механизм ДФА МОЖЕТ использовать механизмы без криптографической защиты, такие как SMS, хотя это не рекомендуется. [require_2FA]

    Maintainer @jfolcini's GitHub account enforces 2FA. Verifiable on the maintainer's profile (https://github.com/jfolcini). The main-branch ruleset's required_signatures rule additionally requires every commit on main to carry a GPG signature, including direct pushes — see https://github.com/jfolcini/agaric/blob/main/docs/architecture/ci-and-tooling.md § Asymmetric branch-protection convention.


    Достаточно для значка!

    При двухфакторной аутентификации (ДФА) проекту СЛЕДУЕТ использовать криптографические механизмы для предотвращения имперсонации. ДФА на основе службы коротких сообщений (SMS) сама по себе НЕ соответствует этому критерию, поскольку короткие сообщения не шифруются. [secure_2FA]
    Механизм ДФА, который соответствует этому критерию, может быть приложением для генерации временных одноразовых паролей (Time-based One-Time Password, TOTP), которое автоматически генерирует код аутентификации, меняющийся через определенный промежуток времени. Обратите внимание, что GitHub поддерживает TOTP.

    Maintainer's 2FA uses cryptographic mechanisms — FIDO2 security key (WebAuthn) + TOTP — not SMS. GPG-signed commits/tags add a second cryptographic factor: every commit on main is signed by an Ed25519/RSA key that is separate from the GitHub account credentials.


 Качество 3/7 ●

  • Стандарты кодирования


    Достаточно для значка!

    Проект ОБЯЗАН документировать свои требования по ревью кода, в том числе, как проводится ревью кода, что необходимо проверять и что необходимо для приемлемости кода. (Требуется URL) [code_review_standards]
    См. также критерии two_person_review и contrib_requirements.

    Code review standards documented at https://github.com/jfolcini/agaric/blob/main/CONTRIBUTING.md and the main-branch ruleset's pull_request rule (described in https://github.com/jfolcini/agaric/blob/main/docs/architecture/ci-and-tooling.md § Asymmetric branch-protection convention): every PR requires code-owner review (driven by https://github.com/jfolcini/agaric/blob/main/.github/CODEOWNERS), last-push approval, thread resolution, stale-approval dismissal, and validate-all green. Solo-maintainer admin bypass covers direct pushes only — flips off when first external maintainer joins.


    Недостаточно для значка.

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

    Solo project — the admin-bypass actor on the main-branch ruleset lets the maintainer direct-push without a second pair of eyes. Honest by-design state while solo per https://github.com/jfolcini/agaric/blob/main/docs/architecture/ci-and-tooling.md § Asymmetric branch-protection convention (revisit trigger: first external maintainer joins, at which point the bypass is removed or widened with an explicit policy).


  • Рабочая система сборки


    Недостаточно для значка.

    Проект ОБЯЗАН обеспечивать воспроизводимую сборку. Если сборка не требуется (например, в случае языков сценариев, где исходный код используется непосредственно вместо компиляции), выберите «N/A». (Требуется URL) [build_reproducible]
    Воспроизводимая сборка означает, что несколько сторон могут независимо повторить процесс генерации информации из исходных файлов и получить аналогичный результат с точностью до бита. В некоторых случаях воспроизводимости можно достичь путем принудительного выставления окружения. Разработчики JavaScript могут рассмотреть возможность использования npm shrinkwrap и webpack OccurenceOrderPlugin. Пользователи GCC и clang могут найти полезной опцию -frandom-seed. Среда сборки (включая набор инструментов) часто может быть определена для внешних сторон путём указания криптографической суммы (hash) для конкретного контейнера или виртуальной машины, которые они могут использовать для пересборки. В проекте Reproducible Builds есть документация о том, как это сделать.

    Reproducible builds not yet verified end-to-end (bit-for-bit identical output from two clean builds of the same source). Plan tracked at https://github.com/jfolcini/agaric/blob/main/pending/REVIEW-LATER.md PEND-48 row — heavier than the other gap-closing PEND items because non-determinism sources can hide in any build step (timestamps, sort order, embedded build env).


  • Набор автотестов


    Достаточно для значка!

    Набор тестов ОБЯЗАН запускаться стандартным способом для этого языка. (Требуется URL) [test_invocation]
    Например, «make check», «mvn test» или «rake test» (Ruby).

    Documented in https://github.com/jfolcini/agaric/blob/main/docs/BUILD.md and https://github.com/jfolcini/agaric/blob/main/CONTRIBUTING.md : npm test (vitest) / cd src-tauri && cargo nextest run / npx playwright test. CI mirrors the same commands — https://github.com/jfolcini/agaric/blob/main/.github/workflows/_validate.yml .


    Достаточно для значка!

    Проект ОБЯЗАН реализовать непрерывную интеграцию, при которой новый или измененный код интегрируется в центральное хранилище кода, и на получившейся базе кода запускаются автоматические тесты. (Требуется URL) [test_continuous_integration]
    В большинстве случаев это означает, что каждый разработчик, занимающийся проектом полный рабочий день, интегрируется, по крайней мере, ежедневно.

    GitHub Actions runs the full test matrix (lint + vitest x3 shards + playwright x2 shards + cargo-tests) on every push and PR — see https://github.com/jfolcini/agaric/blob/main/.github/workflows/_validate.yml .


    Недостаточно для значка.

    Проект ОБЯЗАН иметь автоматические тестовые пакеты на СПО, которые обеспечивают покрытие не менее 90% инструкций кода, если есть хотя бы один инструмент на СПО, который может измерять этот критерий на выбранном языке. [test_statement_coverage90]

    Current vitest merged coverage ~87% statements / ~88% lines (3-shard merged via https://github.com/jfolcini/agaric/blob/main/scripts/merge-vitest-coverage.mjs) — short of the 90% Gold target. Plan documented in https://github.com/jfolcini/agaric/blob/main/pending/PEND-44-coverage-90.md (statement coverage second, ~2% gap, mostly UI render-path work).


    Недостаточно для значка.

    Проект ОБЯЗАН иметь автоматические тестовые пакеты на СПО, которые обеспечивают покрытие не менее 80% веток кода, если есть хотя бы один инструмент на СПО, который может измерять этот критерий на выбранном языке. [test_branch_coverage80]

    Current vitest merged branch coverage ~78.99% — short of the 80% Gold target by ~1pp. Plan documented in https://github.com/jfolcini/agaric/blob/main/pending/PEND-44-coverage-90.md (branch coverage first — lower-effort, error-path branches in notify.ts/tauri.ts and flag-gated UI affordances are the prime targets).


 Безопасность 4/5 ●

  • Основы правильного использования криптографии

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

    Достаточно для значка!

    В ПО, создаваемом проектом, НЕОБХОДИМО поддерживать безопасные протоколы для всех сетевых коммуникаций, такие как SSHv2 или новее, TLS1.2 или новее (HTTPS), IPsec, SFTP и SNMPv3. По умолчанию НЕОБХОДИМО отключать небезопасные протоколы, такие как FTP, HTTP, telnet, SSLv3 или более ранние версии, и SSHv1, и разрешать их только в том случае, если пользователь явным образом это задаёт. Если программное обеспечение, созданное проектом, не поддерживает сетевые коммуникации, выберите «неприменимо» (N/A). [crypto_used_network]

    Sync transport uses TLS 1.3 via rustls (https://github.com/jfolcini/agaric/blob/main/src-tauri/src/sync_protocol/loro_sync.rs); no insecure protocols supported. Outbound HTTP (updater check, Google Calendar) over HTTPS only. CSP in https://github.com/jfolcini/agaric/blob/main/src-tauri/tauri.conf.json#L24 blocks plaintext network from the WebView.


    Достаточно для значка!

    Если ПО, создаваемое проектом, поддерживает или использует TLS, НЕОБХОДИМО поддерживать как минимум версию TLS 1.2. Примечание: предшественник TLS называется SSL. Если программное обеспечение не использует TLS, выберите «неприменимо» (N/A). [crypto_tls12]

    rustls config in https://github.com/jfolcini/agaric/tree/main/src-tauri/src/sync_protocol pins TLS 1.3, which is a strict superset of the 1.2-or-newer requirement. No TLS 1.1 / 1.0 / SSL paths exist anywhere in the tree.


  • Доставка, защищенная от атак посредника (MITM)


    Достаточно для значка!

    Веб-сайт проекта, репозиторий (если он доступен через Интернет) и сайт загрузки (если он существует отдельно) ОБЯЗАНЫ использовать упрочняющие безопасность (hardening) заголовки с неразрешающими значениями. (Требуется URL) [hardened_site]
    Обратите внимание, что GitHub отвечает этому критерию. Такие сайты как https://securityheaders.io/ могут быстро проверить использование. Ключевыми заголовками для упрочнения являются: Content Security Policy (CSP), HTTP Strict Transport Security (HSTS), X-Content-Type-Options (выставленный в «nosniff»), X-Frame-Options и X-XSS-Protection. Статические веб-сайты без возможности входа в систему через веб-страницы могут опускать упрочняющие HTTP-заголовки CSP и X-XSS-Protection, поскольку в этом случае эти заголовки менее эффективны.

    Project has no separately hosted website. README and docs are rendered by GitHub, which enforces HTTPS + HSTS + strict CSP / X-Frame-Options / X-Content-Type-Options on github.com. Releases at https://github.com/jfolcini/agaric/releases are served from the same hardened origin. No third-party domain to harden.


  • Другие вопросы безопасности


    Недостаточно для значка.

    Проект ОБЯЗАН иметь проверку безопасности за последние 5 лет. При проверке НЕОБХОДИМО учитывать требования и границы безопасности. [security_review]
    Эта оценка МОЖЕТ быть выполнена членами проекта и/или независимо. Эта оценка МОЖЕТ подкрепляться инструментами статического и динамического анализа, но кроме этого должна быть проверка человеком для выявления проблем (особенно в дизайне), которые инструменты не могут обнаружить.

    No formal periodic security review has been performed. The project runs continuous coverage via cargo-deny + cargo-audit + zizmor + CodeQL + clippy + biome + gitleaks per https://github.com/jfolcini/agaric/blob/main/SECURITY.md § Existing automated coverage, but that is not equivalent to a structured periodic review of security requirements + boundary. Tracked at https://github.com/jfolcini/agaric/blob/main/pending/PEND-46-threat-model-formal.md for a formal threat-model + review pass.


    Достаточно для значка!

    В ПО, создаваемом проектом, НЕОБХОДИМО использовать механизмы упрочнения безопасности (hardening), чтобы дефекты программного обеспечения с меньшей вероятностью приводили к уязвимостям в безопасности. (Требуется URL) [hardening]
    Механизмы упрочнения могут включать HTTP-заголовки, такие как Content Security Policy (CSP), флаги компилятора для противостояния атакам (например, -fstack-protector) или флаги компилятора, устраняющие неопределенное поведение. Для наших целей политика наименьших привилегий не считается механизмом упрочнения (использовать наименьшие достаточные привилегии важно, но этому посвящён отдельный критерий).

    Hardening mechanisms layered: (1) strict CSP default-src 'self' in https://github.com/jfolcini/agaric/blob/main/src-tauri/tauri.conf.json#L24; (2) Tauri capability allowlist at https://github.com/jfolcini/agaric/blob/main/src-tauri/capabilities/default.json; (3) workspace unsafe_code = "deny" in https://github.com/jfolcini/agaric/blob/main/src-tauri/Cargo.toml with allowlist (https://github.com/jfolcini/agaric/blob/main/src-tauri/unsafe-allowlist.txt) policed by a prek hook; (4) panic = "abort" in release; (5) SLSA provenance; (6) gitleaks + bundle secret scan.


 Анализ 2/2 ●

  • Динамический анализ кода


    Достаточно для значка!

    Проект ОБЯЗАН применять хотя бы один инструмент динамического анализа к любой предлагаемой основной версии ПО, создаваемого проектом до её выпуска. [dynamic_analysis]
    Инструмент динамического анализа проверяет программное обеспечение, выполняя его с конкретными входными данными. Например, проект МОЖЕТ использовать инструмент фаззинг-тестирования (например, American Fuzzy Lop) или сканер веб-приложений (например, OWASP ZAP или w3af). В некоторых случаях проект OSS-Fuzz может быть готов применить фаззинг-тестирование к вашему проекту. Для целей этого критерия инструмент динамического анализа должен каким-то образом варьировать исходные данные, чтобы искать проблемы разного рода или быть автоматическим набором тестов с покрытием веток исполнения не менее 80%. Страница Википедии о динамическом анализе и cтраница OWASP о фаззинг-тестировании указывают некоторые инструменты динамического анализа. Использование инструмента/ов анализа МОЖЕТ, но не обязано быть сосредоточено на поиске уязвимостей в безопасности.

    Three dynamic-analysis suites run on every commit: cargo nextest (Rust unit + integration), vitest (frontend under happy-dom), playwright (E2E browser). Specs at https://github.com/jfolcini/agaric/tree/main/src-tauri/tests , https://github.com/jfolcini/agaric/tree/main/src/__tests__ and https://github.com/jfolcini/agaric/tree/main/e2e . Rust's borrow checker provides compile-time memory-safety guarantees.


    Достаточно для значка!

    Проекту СЛЕДУЕТ включать достаточно много утверждений (assertions) времени выполнения в создаваемом им ПО и проверять эти утверждения во время динамического анализа. [dynamic_analysis_enable_assertions]
    Этот критерий не предполагает включения утверждений на этапе эксплуатации; решение об этом полностью лежит на проекте и его пользователях. Вместо этого критерий направлен на улучшение обнаружения ошибок во время динамического анализа перед развертыванием. Использование утверждений при эксплуатации полностью отличается от такового во время динамического анализа (например, при тестировании). В некоторых случаях включать утверждения при эксплуатации крайне неразумно (особенно в компонентах с высокой степенью целостности). Существует множество аргументов против включения утверждений в выпускаемых сборках: например, библиотеки не должны вызывать сбой при вызове, присутствие утверждений может привести к отклонению магазинами приложений и/или активация их при рабочем использовании может привести к раскрытию частных данных, таких как закрытые ключи. Помните, что во многих дистрибутивах Linux NDEBUG не определен, поэтому C/C++assert() в таких рабочих средах по умолчанию будет включен. Может быть важно использовать другой механизм утверждений или определить NDEBUG для эксплуатации в этих средах.

    Test/dev profiles keep debug_assertions = true by default (cargo nextest run --profile ci in https://github.com/jfolcini/agaric/blob/main/.github/workflows/_validate.yml). The release profile uses panic = "abort" for crash-safety. Profiles defined in https://github.com/jfolcini/agaric/blob/main/src-tauri/Cargo.toml .



Эти данные доступны по лицензии Community Data License Agreement – Permissive, Version 2.0 (CDLA-Permissive-2.0). Это означает, что получатель данных может распространять данные с изменениями или без них, при условии, что получатель данных предоставляет текст данного соглашения вместе с распространяемыми данными. Пожалуйста, укажите в качестве источника Javier Folcini и участников OpenSSF Best Practices badge.

Владелец анкеты на значок проекта: Javier Folcini.
2026-05-17 05:56:35 UTC, последнее изменение сделано 2026-05-17 08:50:28 UTC. Последний раз условия для получения значка были выполнены 2026-05-17 07:53:16 UTC.