ratchet

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

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

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


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

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

        

 Основы 4/5

  • Общая

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

    Effect gate for AI agents. An agent asks before it charges a card, ships a deploy, or sends the email, and gets back a durable decision — so the same real-world action is attempted at most once. Ratchet never performs the effect itself and holds no vendor credentials.

    Используйте формат выражения лицензии 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]

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


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

    Two people hold every credential the project depends on — the npm account, the domain registrar, Fly.io, and the database including AUTH_SECRET — and both hold admin on this repository, so either can create and close issues, accept proposed changes, and cut a release without recovering the other's personal account first. Roles and the full asset list: https://github.com/thearchitect0x-glitch/ratchet/blob/main/GOVERNANCE.md#continuity . Recovery procedure, written for somebody who is not the author: https://github.com/thearchitect0x-glitch/ratchet/blob/main/docs/handoff/RECOVERY.md



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

    Not met, and answered rather than left blank. Ratchet has one significant contributor, the maintainer. The second repository administrator is a partner at Deimos AI LLC and is therefore associated, which this criterion's own details explicitly exclude. Outside contribution is real but not yet significant by the threshold in those details (roughly 1,000 lines, 50 commits, or 20 pages of documentation within a year): https://github.com/thearchitect0x-glitch/ratchet/pull/12 was merged from a contributor with no connection to the company. Substantial work is scoped and open for anyone to take: https://github.com/thearchitect0x-glitch/ratchet/issues/15


  • Другое


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

    Every source file carries SPDX-License-Identifier: Apache-2.0 immediately alongside the copyright line, in that file's own comment syntax. https://github.com/thearchitect0x-glitch/ratchet/blob/main/src/domain/effects.ts


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

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


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

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



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

    https://github.com/thearchitect0x-glitch/ratchet/labels/good%20first%20issue - four tasks, each self-contained and carrying file paths and acceptance criteria: guard the per-file licence headers with a test, property-test normalizeText directly, fuzz the MCP JSON-RPC parser, and document which error codes are worth retrying. All four are real work identified during development, not tasks invented to satisfy this criterion.



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

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



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

    Two-factor authentication on the account that controls the repository, the deployment path and the npm publish workflow uses a TOTP authenticator application, not SMS. TOTP is a cryptographic mechanism and is the example this criterion names as meeting it; GitHub supports it directly. SMS was in use previously and was recorded here as unmet until it was replaced, because SMS is not encrypted and can be taken by SIM swap without access to any device the holder owns. That mattered more than the criterion: npm releases are signed with SLSA provenance generated by a workflow in this repository, so an attacker holding the account could have shipped artifacts carrying genuine, verifiable provenance.


 Качество 6/7

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


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

    https://github.com/thearchitect0x-glitch/ratchet/blob/main/docs/CODE_REVIEW.md documents what is checked automatically (full suite, property-based fuzzing, production dependency audit, CodeQL), what is checked by reading against the project contract in CLAUDE.md, what makes a change unacceptable, and the rule that a test must be broken on purpose and watched to fail before it is trusted. It also states plainly that review here is not two people agreeing, and why - see two_person_review, recorded unmet.



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

    Enforced, not intended. main carries a repository ruleset with no bypass actors: a change reaches it only through a pull request carrying an approving review from somebody other than the last pusher (require_last_push_approval is on). It binds the maintainer too, which was confirmed by attempting a direct push and being refused rather than read off a settings page. What a reviewer checks: https://github.com/thearchitect0x-glitch/ratchet/blob/main/docs/CODE_REVIEW.md . The first change to go through the rule is the change that documents it: https://github.com/thearchitect0x-glitch/ratchet/pull/14 . Instituted 2026-09-05, so the proportion is 100% of proposed modifications from that date; the prior history of 3 reviewed of 247 commits is stated rather than claimed.


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


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

    Two clean builds produce byte-identical output - 183 files, same manifest - and the output carries nothing specific to the machine that produced it. Source maps reference sources relatively with an empty sourceRoot, no file in dist contains the checkout's absolute path, TypeScript is pinned to an exact version, every Docker base image is pinned by digest, and npm ci resolves from a committed lockfile. Verified by a command rather than asserted: npm run verify:build, which runs in CI on every push and exits non-zero if two builds differ or if a source map references an absolute path. https://github.com/thearchitect0x-glitch/ratchet/blob/main/scripts/verify-reproducible.sh


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


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

    A single documented command: npm test

    Предупреждение: требуется URL, но URL не найден.



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

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

    90.87% statement coverage of src/, measured with c8 (FLOSS) across all three automated suites - unit, integration and end-to-end - against a disposable PostgreSQL database. npm run coverage reproduces it and fails below 90% statements, so the figure cannot drift beneath this claim without the build going red. Two earlier figures in this answer were wrong in opposite directions and both are worth stating: 85.68% counted the test files themselves in the denominator, and 80.01% then measured only unit and integration, leaving out the suite that covers the MCP handlers and the OAuth routes almost entirely.



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

    81.56% branch coverage of src/, measured with c8 (FLOSS) across the unit, integration and end-to-end suites against a disposable PostgreSQL database. npm run coverage reproduces it and fails below 78% branches. Full measurement: 90.87% statements, 81.56% branches, 91.75% functions, 90.87% lines.


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

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

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

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

    All network communication uses TLS. HSTS is set with max-age=31536000 and includeSubDomains, and outbound webhook delivery is https-only with private, loopback, link-local, CGNAT and metadata ranges refused.



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

    TLS 1.2 or later, negotiated by the hosting platform; nothing older is offered.


  • Доставка, защищенная от атак посредника (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, поскольку в этом случае эти заголовки менее эффективны.

    Found all required security hardening headers.

    Предупреждение: требуется URL, но URL не найден.


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


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

    A security review has been performed and written down rather than asserted: https://github.com/thearchitect0x-glitch/ratchet/blob/main/ASSURANCE_CASE.md . It states seven security requirements, the threat model including what is explicitly out of scope, the trust boundary and what crosses it, the secure design argument, and a table of common implementation weaknesses with the countermeasure and the test holding each one. The security boundary is the product's central claim: Ratchet performs no side effect itself, holds no vendor credential, and has no outbound access to customer systems. The review was performed by the maintainer - this criterion asks for a review considering the security requirements and boundary, not for an outside reviewer, and no outside reviewer is claimed.



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

    Content-Security-Policy default-src 'self' with base-uri 'none', form-action 'self' and frame-ancestors 'none'; plus X-Content-Type-Options nosniff, X-Frame-Options DENY, Referrer-Policy strict-origin-when-cross-origin, Permissions-Policy denying geolocation, microphone and camera, and HSTS. The container runs as a non-root user.

    Предупреждение: требуется URL, но URL не найден.


 Анализ 2/2

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


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

    The end-to-end suite exercises the built application over real HTTP against a real PostgreSQL database, and the deploy gate additionally runs a smoke test against the running staging build before any production release — a build that fails it is refused rather than promoted.



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

    Assertions are enabled throughout the test suites, which run the application rather than mocking it. TypeScript strict mode and runtime JSON Schema validation act as always-on assertions at the API boundary in production too.



Вы можете использовать инструменты и системы ИИ для предложения изменений через простой URL, например https://www.bestpractices.dev/ru/projects/14440/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). Это означает, что получатель данных может распространять данные с изменениями или без них, при условии, что получатель данных предоставляет текст данного соглашения вместе с распространяемыми данными. Пожалуйста, укажите в качестве источника The Architect и участников OpenSSF Best Practices badge.

Владелец анкеты на значок проекта: The Architect .
2026-09-03 20:43:11 UTC, последнее изменение сделано 2026-09-06 07:04:04 UTC. Последний раз условия для получения значка были выполнены 2026-09-03 21:23:31 UTC.