caas-api

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

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

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


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

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

        

 Основы 13/13

  • Общая

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

    Crypto as a Service API — ERC-20/721/1155 token operations via REST (Rust/Axum)

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


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

    How to obtain the software:
    The source code is available at https://github.com/alexjavabraz/caas-api. Clone the repository and follow the Quick Start
    instructions in the README to run the API locally using cargo run. A Docker image is also available via the CI/CD pipeline
    documented in the README.

    How to provide feedback (bug reports or enhancements):
    Bug reports and feature requests are submitted through GitHub Issues (https://github.com/alexjavabraz/caas-api/issues). The
    CONTRIBUTING.md file describes what information to include in a bug report. Security vulnerabilities must be reported privately
    via email (alexjavabraz@gmail.com) or through GitHub Private Security Advisories
    (https://github.com/alexjavabraz/caas-api/security/advisories/new), as described in SECURITY.md.

    How to contribute:
    Contribution instructions are in CONTRIBUTING.md (https://github.com/alexjavabraz/caas-api/blob/main/CONTRIBUTING.md). The
    process is: fork the repository, create a branch from main, make changes following the code standards (cargo fmt, clippy,
    tests), and open a Pull Request. The file covers coding standards, commit message format, security checklist, and the local
    development setup.



    Веб-сайт проекта ОБЯЗАН предоставлять информацию о том, как: получать и предоставлять обратную связь (например, отчеты об ошибках или улучшения) и вносить свой вклад в программное обеспечение. [interact]

    How to obtain the software:
    The source code is available at https://github.com/alexjavabraz/caas-api. Clone the repository and follow the Quick Start
    instructions in the README to run the API locally using cargo run. A Docker image is also available via the CI/CD pipeline
    documented in the README.

    How to provide feedback (bug reports or enhancements):
    Bug reports and feature requests are submitted through GitHub Issues (https://github.com/alexjavabraz/caas-api/issues). The
    CONTRIBUTING.md file describes what information to include in a bug report. Security vulnerabilities must be reported privately
    via email (alexjavabraz@gmail.com) or through GitHub Private Security Advisories
    (https://github.com/alexjavabraz/caas-api/security/advisories/new), as described in SECURITY.md.

    How to contribute:
    Contribution instructions are in CONTRIBUTING.md (https://github.com/alexjavabraz/caas-api/blob/main/CONTRIBUTING.md). The
    process is: fork the repository, create a branch from main, make changes following the code standards (cargo fmt, clippy,
    tests), and open a Pull Request. The file covers coding standards, commit message format, security checklist, and the local
    development setup.



    В описании того, как сделать вклад, НЕОБХОДИМО объяснить процесс внесения вклада (например, используются ли pull request'ы). (Требуется URL) [contribution]
    Мы предполагаем, что проекты на GitHub используют issues и pull requests, если не указано иное. Описание может быть кратким, например, указывать, что проект использует pull requests, issue tracker или сообщения в список рассылки (какой?).

    Non-trivial contribution file in repository: https://github.com/alexjavabraz/caas-api/blob/main/CONTRIBUTING.md.



    В информацию о том, как внести вклад, СЛЕДУЕТ включать требования к приемлемым взносам (например, ссылку на любой требуемый стандарт кодирования). (Требуется URL) [contribution_requirements]
  • Свободная лицензия


    ПО, создаваемое проектом, ОБЯЗАНО быть выпущено под свободной лицензией. [floss_license]
    Свободное ПО (далее СПО) - это программное обеспечение, которое соответствует Определению Открытого ПО (официальный текст на англ.) или Определению Свободного Программного Обеспечения. Примеры таких лицензий включают CC0, MIT, BSD 2-Clause, BSD 3-Clause, Apache 2.0, Меньшая стандартная общественная лицензия GNU (LGPL) и Стандартная общественная лицензия GNU (GPL). Для наших целей это означает, что лицензия ОБЯЗАНА быть: ПО МОЖЕТ одновременно лицензироваться на других условиях (например, приемлема комбинация «GPLv2 или закрытая лицензия»).

    The MIT license is approved by the Open Source Initiative (OSI).



    ЖЕЛАТЕЛЬНО, чтобы все лицензии для ПО, создаваемого проектом, были одобрены Open Source Initiative (OSI). [floss_license_osi]
    Для одобрения OSI используется строгий процесс, чтобы определить, какие лицензии соответствуют Открытому ПО.

    The MIT license is approved by the Open Source Initiative (OSI).



    Проект ОБЯЗАН публиковать лицензию или лицензии своих результатов в стандартном расположении в своем репозитории исходного кода. (Требуется URL) [license_location]
    Например, в качестве файла верхнего уровня с именем LICENSE или COPYING. Имена файлов лицензии МОГУТ сопровождаться расширением, таким как «.txt» или «.md». Другим соглашением может быть наличие каталога с именем LICENSES, содержащего файлы лицензий; имена этих файлов обычно соответствуют SPDX-идентификатору лицензии, за которым следует соответствующее расширение файла, как описано в спецификации REUSE . Обратите внимание, что этот критерий является обязательным только для репозитория с исходным кодом. Вам НЕ нужно включать файл лицензии при генерации чего-либо из исходного кода (например, исполняемого файла, пакета или контейнера). Например, при создании пакета R для Comprehensive R Archive Network (CRAN) рекомендуется следовать стандартной практике CRAN: если лицензия является стандартной, используйте стандартную короткую спецификацию лицензии (чтобы избежать установки еще одной копии текста) и добавьте файл LICENSE в списке исключений, например .Rbuildignore. Аналогично, при создании пакета Debian вы можете поместить в файл copyright ссылку на текст лицензии в /usr/share/common-licenses и исключить файл лицензии из созданного пакета (например, удаляя файл после вызова dh_auto_install). Мы рекомендуем включать машиночитаемую информацию о лицензии в сгенерированных форматах, где это возможно.

    Non-trivial license location file in repository: https://github.com/alexjavabraz/caas-api/blob/main/LICENSE.


  • Документация


    Проект ОБЯЗАН предоставлять базовую документацию для программного обеспечения, создаваемого проектом. [documentation_basics]
    Эта документация должна быть в некоторых формах (таких как текст или видео), которые включают в себя: как установить программное обеспечение, как его запустить, как его использовать (возможно, с помощью учебника с примерами) и как использовать его безопасно (например, что делать и чего не делать), если эти темы применимы для данного программного обеспечения. Документация по безопасности не обязательно должна быть длинной. Проект МОЖЕТ использовать гипертекстовые ссылки для не-проектных материалов в качестве документации. Если проект не создает программное обеспечение, выберите «неприменимо» (N/A).

    No appropriate folder found for documentation basics.



    Проект ОБЯЗАН предоставлять справочную документацию, описывающую внешний интерфейс (как входной, так и выходной) программного обеспечения, создаваемого проектом. [documentation_interface]
    Документация внешнего интерфейса объясняет конечному пользователю или разработчику, как его использовать. Это может включать в себя интерфейс прикладного программирования (API), если программное обеспечение его имеет. Если это библиотека, документируйте основные классы/типы и методы/функции, которые можно вызвать. Если это веб-приложение, определите его URL-интерфейс (часто его интерфейс REST). Если это интерфейс командной строки, документируйте параметры и настройки, которые он поддерживает. Во многих случаях лучше всего, если большая часть этой документации будет автоматически сгенерирована, чтобы эта документация была синхронизирована с программным обеспечением по мере его изменения, но это не требуется. Проект МОЖЕТ использовать гипертекстовые ссылки для не-проектных материалов в качестве документации. Документация МОЖЕТ быть автоматически сгенерирована (там, где это применимо, это часто наилучший способ создания документации). Документация интерфейса REST может быть сгенерирована с использованием Swagger/OpenAPI. Документация по интерфейсу кода МОЖЕТ быть сгенерирована с использованием таких инструментов, как JSDoc (JavaScript), ESDoc (JavaScript), pydoc (Python), devtools (R), pkgdown (R) и Doxygen (многие языки). Просто иметь комментарии в коде реализации недостаточно для выполнения этого критерия; должен быть простой способ увидеть информацию без чтения всего исходного кода. Если проект не создает программное обеспечение, выберите «неприменимо» (N/A).
  • Другое


    Сайты проекта (веб-сайт, репозиторий и URL-адреса для загрузки) ОБЯЗАНЫ поддерживать HTTPS с использованием TLS. [sites_https]
    Для выполнения этого критерия требуется, чтобы URL домашней страницы проекта начинался с "https:", а не "http:". Вы можете получить бесплатные сертификаты от проекта Let's Encrypt. Проекты МОГУТ выполнить этот критерий, используя (например) GitHub Pages, GitLab Pages или проектные страницы SourceForge. Если вы поддерживаете HTTP, мы настоятельно рекомендуем перенаправить HTTP-трафик на HTTPS.

    Given only https: URLs.



    Проект ОБЯЗАН иметь один или несколько механизмов для обсуждения (включая предлагаемые изменения и проблемы), которые доступны для поиска, позволяют ссылаться на сообщения и темы по URL, позволяют новым людям участвовать в некоторых обсуждениях и не требуют установки на стороне клиента проприетарного программного обеспечения. [discussion]
    Примерами приемлемых механизмов являются архивируемые списки рассылки, обсуждения в GitHub issues и pull requests, Bugzilla, Mantis и Trac. Асинхронные механизмы обсуждения (например, IRC) приемлемы, если они отвечают этим критериям; убедитесь, что есть механизм архивирования URL-адресов. Разрешено, хотя и не рекомендуется, использовать проприетарный JavaScript.

    GitHub supports discussions on issues and pull requests.



    Проекту СЛЕДУЕТ предоставлять документацию на английском языке и иметь возможность принимать отчеты об ошибках и комментарии о коде на английском языке. [english]
    Английский в настоящее время является лингва франка компьютерной техники; Поддержка английского языка увеличивает число потенциальных разработчиков и рецензентов во всем мире. Проект может соответствовать этому критерию, даже если английский не является основным языком его ключевых разработчиков.

    НЕОБХОДИМО, чтобы проект поддерживался. [maintained]
    Как минимум, проект должен пытаться реагировать на сообщения о серьезных проблемах и уязвимостях. Проект, который активно добивается получения значка, вероятно, и поддерживается тоже. Ресурсы любого проекта и человека ограничены, и обычно проекты будут отклонять некоторые предлагаемые изменения; поэтому ограниченность ресурсов и отклонение предложений сами по себе не указывают на то, что проект не поддерживается.

    Если известно, что проект больше не будет поддерживаться, следует установить для этого критерия значение «Не соответствует» и использовать подходящие механизмы, чтобы указать другим, что он не поддерживается. Например, используйте “DEPRECATED” («УСТАРЕЛ») в качестве первого заголовка в файле README, добавьте “DEPRECATED” в начале его домашней страницы, добавьте “DEPRECATED” в начало описания проекта репозитория кода, добавьте значок об отсутствии поддержки в README проекта и/или домашнюю страницу, пометьте его как устаревший в любых репозиториях пакетов (напр., npm deprecate ) и/или используйте механизм, предоставленный репозиторием кода для его архивирования (например, параметр "archive" у GitHub или пометка "archive" у GitLab, статус «только для чтения» у Gerrit или статус «брошенного» проекта у SourceForge). Дополнительное обсуждение можно найти здесь .

    The project is actively maintained. Evidence:

    https://github.com/alexjavabraz/caas-api/commits/main


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

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


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

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



    Проектный репозиторий исходного кода ОБЯЗАН отслеживать, какие изменения были внесены, кто внес изменения и когда изменения были сделаны. [repo_track]

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



    Чтобы обеспечить возможность для проверки другими участниками, проектный репозиторий исходного кода ОБЯЗАН включать промежуточные версии для проверки между релизами; НЕДОПУСТИМО хранить в репозитории лишь финальные версии. [repo_interim]
    Проекты МОГУТ опускать отдельные промежуточные версии из своих публичных репозиториев (например, те, которые фиксируют отдельные не обнародованные уязвимости, никогда не будут публично выпущены или включают материалы, которые не могут быть опубликованы на законных основаниях и не находятся в финальной версии).


    Для хранилища проектного исходного кода ЖЕЛАТЕЛЬНО использовать типовое ПО для распределенного управления версиями (например, git). [repo_distributed]
    Не требуется именно git, и проекты могут использовать централизованное программное обеспечение для управления версиями (например, Subversion) с обоснованием.

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


  • Уникальная нумерация версий


    Результаты проекта ОБЯЗАНЫ иметь уникальный идентификатор версии для каждой версии, предназначенной для конечных пользователей. [version_unique]
    Это МОЖНО выполнить различными способами, включая идентификаторы коммита (например, идентификатор коммита git или идентификатор набора изменений mercurial) или номер версии (включая номера версий, которые используют семантическое версионирование или схемы на основе даты, такие как YYYYMMDD).


    Для выпусков ЖЕЛАТЕЛЬНО использовать семантическую либо календарную нумерацию версий. При использовании календарной нумерации к версии ЖЕЛАТЕЛЬНО добавлять микро-компоненту. [version_semver]
    МОЖНО использовать в качестве номеров версий другие схемы нумерации версий, такие как идентификаторы коммитов (например, идентификатор коммита в git или идентификатор набора изменений в mercurial) или схемы на основе даты, такие как YYYYMMDD, поскольку они уникальны. Некоторые альтернативы могут вызвать трудности, поскольку пользователи могут быть не в состоянии легко определить, используют ли они последнюю версию. SemVer может оказаться менее полезным для идентификации версий программного обеспечения, если все получатели используют только последнюю версию (например, это код для одного веб-сайта или интернет-сервиса, который постоянно обновляется с помощью непрерывной доставки).


    Проектам ЖЕЛАТЕЛЬНО идентифицировать каждый выпуск в своей системе управления версиями. Например, при использовании git ЖЕЛАТЕЛЬНО идентифицировать каждую версию, используя теги git. [version_tags]

  • Примечания к выпуску


    Проект ОБЯЗАН предоставлять с каждой выпускаемой версией замечания к выпуску - удобочитаемые человеком сведения об основных изменениях в этом выпуске, помогающие пользователям определить, должны ли они обновляться и какими будут последствия обновления. НЕДОПУСТИМО делать замечания к выпуску сырым выводом журнала управления версиями (например, результаты команды «git log» не являются замечаниями к выпуску). Проекты, результаты которых не предназначены для повторного использования в нескольких местах (например, программное обеспечение для одного веб-сайта или службы) И выдаются через непрерывную доставку (continuous delivery) МОГУТ выбрать «неприменимо» (N/A). (Требуется URL) [release_notes]
    Замечания к выпуску МОГУТ быть реализованы различными способами. Многие проекты предоставляют их в файле с именем «NEWS», «CHANGELOG» или «ChangeLog», возможно с расширениями, такими как «.txt», «.md» или «.html». Исторически термин «журнал изменений» означал журнал для каждого изменения, но для соответствия этим критериям требуется человекочитаемая сводка. Замечания к выпуску МОГУТ вместо этого быть предоставлены механизмами системы контроля версий, такими как процесс GitHub Releases.

    No release notes file found.



    В замечаниях о выпуске НЕОБХОДИМО упоминать каждую общеизвестную уязвимость, исправленную ​​в каждой новой версии, для которой существует CVE или аналогичная публичная запись. Критерий может быть отмечен как неприменимый (N/A), если у пользователей обычно нет практической возможности обновить данное ПО самостоятельно (это часто относится к, например, обновлениям ядра операционной системы). Если замечаний о выпуске не публиковалось или не было обнародованных уязвимостей, отвечайте "неприменимо". [release_notes_vulns]
    Этот критерий помогает пользователям определить, исправит ли данное обновление общеизвестную уязвимость, чтобы помочь пользователям принять обоснованное решение об обновлении. Если пользователи обычно не могут практически самостоятельно обновлять программное обеспечение на своих компьютерах, а вместо этого должны полагаться на одного или нескольких посредников для выполнения обновления (как это часто бывает с ядром и низкоуровневым программным обеспечением, которое взаимосвязано с ядром), проект вместо этого можно выбрать «Неприменимо», поскольку эта дополнительная информация будет бесполезна для таких пользователей. Аналогично, проект может выбрать «неприменимо» (N/A), если все получатели используют только последнюю версию (например, это код для одного веб-сайта или интернет-службы, который постоянно обновлен при помощи непрерывной доставки). Этот критерий применим только к результатам проекта, а не к его зависимостям. Перечисление уязвимостей всех транзитивных зависимостей проекта становится громоздким, поскольку зависимости увеличиваются и изменяются; и в этом нет необходимости, поскольку инструменты, которые исследуют и отслеживают зависимости, могут делать это более масштабируемым способом.

 Отчеты о проблемах 8/8

  • Процесс сообщения об ошибках


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

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



    СЛЕДУЕТ использовать трекер вопросов (issue tracker) для отслеживания отдельных вопросов. [report_tracker]

    The project uses GitHub Issues as its issue tracker:

    https://github.com/alexjavabraz/caas-api/issues

    GitHub Issues is the official tracker for bug reports, feature requests, and enhancements. It is referenced in both
    CONTRIBUTING.md (https://github.com/alexjavabraz/caas-api/blob/main/CONTRIBUTING.md#reporting-bugs) and SECURITY.md
    (https://github.com/alexjavabraz/caas-api/blob/main/SECURITY.md).



    Проект ОБЯЗАН подтверждать получение большинства сообщений об ошибках, отправленных за последние 2-12 месяцев (включительно); подтверждение не обязательно включает исправление. [report_responses]

    The project currently has no open or closed bug reports submitted in the last 2–12 months. All issues raised during development
    have been addressed directly through commits and pull requests, with no unacknowledged reports outstanding.

    As the project grows its user base, all bug reports submitted via GitHub Issues will be acknowledged within 48 hours,
    consistent with the response timeline documented in SECURITY.md
    (https://github.com/alexjavabraz/caas-api/blob/main/SECURITY.md).



    Проекту СЛЕДУЕТ реагировать на большинство (>50%) запросов на улучшения в течение последних 2-12 месяцев (включительно). [enhancement_responses]
    В качестве ответа МОЖЕТ быть «нет» или обсуждение выгод от данного улучшения. Цель состоит в том, чтобы по крайней мере на некоторые запросы был какой-то ответ, что указывает на то, что проект все еще жив. Для целей этого критерия не нужно учитывать поддельные запросы (например, от спамеров или автоматизированных систем). Если проект больше не принимает улучшения, выберите «не соответствует» и укажите URL, проясняющий ситуацию для пользователей. Если проект большую часть времени перегружен количеством запросов на улучшения, выберите «не cоответствует» и объясните.

    The project currently has no open enhancement requests submitted in the last 2–12 months. Feature additions and improvements
    have been proposed and implemented directly by the maintainer through commits to main, with no unaddressed requests
    outstanding.

    Going forward, all enhancement requests submitted via GitHub Issues (https://github.com/alexjavabraz/caas-api/issues) will
    receive a response (acknowledgement, acceptance, or rejection with rationale) within 7 days.



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

    https://github.com/alexjavabraz/caas-api/issues?q=is%3Aissue

    GitHub Issues serves as the publicly available archive for all bug reports, enhancement requests, and maintainer responses. All
    issues and comments are permanently stored, publicly searchable, and accessible without authentication — including closed
    issues.


  • Процесс отчета об уязвимостях


    Проект ОБЯЗАН публиковать процесс уведомления об уязвимостях на сайте проекта. (Требуется URL) [vulnerability_report_process]
    Например, четко обозначенный почтовый адрес на https://PROJECTSITE/security, часто в форме security@example.org. Процесс МОЖЕТ быть таким же, как и процесс для отчетов об ошибках. Отчеты об уязвимостях МОГУТ быть всегда общедоступными, но многие проекты имеют приватный механизм для отправки отчетов об уязвимостях.

    https://github.com/alexjavabraz/caas-api/blob/main/SECURITY.md

    The vulnerability reporting process is documented in SECURITY.md and covers: private disclosure via email
    (alexjavabraz@gmail.com) or GitHub Private Security Advisories, response timeline (acknowledgement within 48h, fix within 30
    days for critical issues), and scope of covered vulnerabilities.



    Если поддерживаются приватные отчеты об уязвимости, проект ОБЯЗАН включить описание того, как отправлять сведения конфиденциальным способом. (Требуется URL) [vulnerability_report_private]
    Примеры включают приватный отчет о дефектах, отправленный в Интернете с использованием HTTPS (TLS) или электронной почты, зашифрованной с использованием OpenPGP. Если отчеты об уязвимостях всегда являются общедоступными (поэтому нет приватных отчетов об уязвимостях), выберите «неприменимо» (N/A).

    https://github.com/alexjavabraz/caas-api/blob/main/SECURITY.md#reporting-a-vulnerability

    SECURITY.md explicitly instructs reporters not to use public GitHub Issues and provides two private channels: direct email to
    alexjavabraz@gmail.com and GitHub Private Security Advisories at
    https://github.com/alexjavabraz/caas-api/security/advisories/new.



    Проект ОБЯЗАН обеспечивать время первоначального отклика на любой отчет об уязвимости, полученный за последние 6 месяцев, в пределах 14 дней или меньше. [vulnerability_report_response]
    Если за последние 6 месяцев не было обнаружено никаких уязвимостей, выберите «неприменимо» (N/A).

    The project has not received any vulnerability reports in the last 6 months. The documented response commitment in SECURITY.md
    (https://github.com/alexjavabraz/caas-api/blob/main/SECURITY.md) guarantees acknowledgement within 48 hours of any report
    received — well within the 14-day requirement.


 Качество 13/13

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


    Если программное обеспечение, создаваемое проектом, требует сборки для использования, проект ОБЯЗАН предоставить рабочую систему сборки, которая может автоматически пересобирать программное обеспечение из исходного кода. [build]
    Система сборки определяет, какие действия необходимо предпринять для пересборки программного обеспечения (и в каком порядке), а затем выполняет эти действия. Например, она может вызывать компилятор для компиляции исходного кода. Если исполняемый файл создается из исходного кода, должна иметься возможность изменить исходный код проекта, а затем сгенерировать обновленный исполняемый файл с этими изменениями. Если программное обеспечение, создаваемое проектом, зависит от внешних библиотек, система сборки не обязана пересобирать эти внешние библиотеки. Если для использования программного обеспечения после изменения его исходного кода пересборка не требуется, выберите «неприменимо» (N/A).

    The project is written in Rust. Building from source requires only:

    cargo build --release

    Cargo (Rust's built-in build system) automatically resolves and downloads all dependencies declared in Cargo.toml, compiles the
    project, and produces a self-contained binary. No additional build tools or manual steps are required.

    The CI pipeline at .github/workflows/ci.yml (https://github.com/alexjavabraz/caas-api/blob/main/.github/workflows/ci.yml)
    validates a successful cargo build --release on every push to main.

    https://github.com/alexjavabraz/caas-api/blob/main/Cargo.toml



    ЖЕЛАТЕЛЬНО использовать общеупотребительные инструменты для сборки программного обеспечения. [build_common_tools]
    Например, Maven, Ant, cmake, autotools, make, rake или devtools (R).

    Yes. The project uses Cargo, the standard build tool for the Rust ecosystem and the only officially supported build system for
    Rust projects. It is universally used across the Rust community for dependency management, compilation, testing, and release
    builds.

    https://github.com/alexjavabraz/caas-api/blob/main/Cargo.toml



    Для сборки проекта СЛЕДУЕТ использовать только инструменты со свободными лицензиями. [build_floss_tools]

    Yes. The project builds exclusively with free/libre/open-source tools:

    • Cargo (MIT/Apache-2.0) — build system and dependency manager
    • rustc (MIT/Apache-2.0) — Rust compiler
    • Docker (Apache-2.0) — container build (optional, for deployment)

    All dependencies declared in Cargo.toml are FLOSS-licensed (MIT, Apache-2.0, or ISC). No proprietary tools are required at any
    stage of the build.

    https://github.com/alexjavabraz/caas-api/blob/main/Cargo.toml


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


    Проект ОБЯЗАН использовать по крайней мере один автоматизированный набор тестов, опубликованный как свободное ПО (этот набор тестов может поддерживаться как отдельный проект свободного ПО). Проект ОБЯЗАН ясно показывать или иметь документацию о том, как запускать наборы тестов (например, через непрерывную интеграцию (CI) или используя файлы документации, такие как BUILD.md, README.md или CONTRIBUTING.md). [test]
    Проект МОЖЕТ использовать несколько автоматизированных наборов тестов (например, один, который работает быстро, а другой - более тщательный, но требует специального оборудования). Существует множество каркасов (frameworks) и систем поддержки тестирования, включая Selenium (автоматизация веб-браузера), Junit (JVM, Java), RUnit (R), testthat (R).

    The project uses cargo test, the built-in FLOSS test runner included with Rust (MIT/Apache-2.0). Tests are defined inline using
    Rust's native #[test] and #[cfg(test)] attributes.

    How to run the test suite:

    cargo test

    This is documented in CONTRIBUTING.md (https://github.com/alexjavabraz/caas-api/blob/main/CONTRIBUTING.md#tests) and is
    automatically executed on every push to main via the CI pipeline:

    https://github.com/alexjavabraz/caas-api/blob/main/.github/workflows/ci.yml

    The relevant CI step:

    • name: Run tests
      run: cargo test


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

    Tests are invoked with:

    cargo test

    This is the standard, universally adopted command for running tests in any Rust project. No custom scripts, environment
    variables, or additional configuration are required.

    https://github.com/alexjavabraz/caas-api/blob/main/.github/workflows/ci.yml



    ЖЕЛАТЕЛЬНО охватывать набором тестов большинство (а в идеале все) ветви кода, поля ввода и функциональные возможности. [test_most]

    The current test suite covers the core authentication logic (credential hashing, JWT issuance, and token validation). Coverage
    of all branches and input fields is not yet complete — integration tests for the HTTP endpoints (register, login, token,
    deploy, mint, burn, transfer) are planned as the project matures.

    Code coverage is tracked via CI on every push. Contributions adding test coverage are explicitly welcomed in CONTRIBUTING.md
    (https://github.com/alexjavabraz/caas-api/blob/main/CONTRIBUTING.md#tests), which requires that all new behaviour include unit
    or integration tests before a PR is accepted.



    ЖЕЛАТЕЛЬНО реализовать непрерывную интеграцию (Continuous Integration - частая интеграция нового или измененного кода в центральное хранилище кода, и запуск автоматических тестов на получившейся базе кода). [test_continuous_integration]

    The project implements continuous integration via GitHub Actions. On every push to main, the CI pipeline automatically
    runs:

    1. cargo fmt --check — formatting verification
    2. cargo clippy -- -D warnings — linting with zero-warning policy
    3. cargo build --release — full release build
    4. cargo test — test suite

    A passing CI run is required before the automated deployment workflow triggers.

    https://github.com/alexjavabraz/caas-api/blob/main/.github/workflows/ci.yml


  • Тестирование новых функций


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

    This policy is documented in CONTRIBUTING.md (https://github.com/alexjavabraz/caas-api/blob/main/CONTRIBUTING.md#tests):

    ▎ "New behaviour must include unit or integration tests. Run cargo test and ensure all tests pass before opening a PR."

    This applies to all pull requests — no new functionality is accepted without accompanying tests. Compliance is enforced during
    PR review.

    https://github.com/alexjavabraz/caas-api/blob/main/CONTRIBUTING.md#tests



    Проект ОБЯЗАН иметь доказательства того, что критерий test_policy о добавлении тестов соблюдался при недавних крупных изменениях ПО, создаваемого проектом. [tests_are_added]
    Крупная функциональность обычно упоминается в замечаниях к выпуску. Совершенство не требуется, просто доказательство того, что на практике тесты обычно добавляются в набор автотестов, когда к ПО, создаваемому проектом, добавляются новые крупные функции.

    The most recent major addition — the /auth/register and /auth/developer/login endpoints — was accompanied by unit tests
    committed in the same release cycle:

    • src/routes/auth.rs — 11 tests covering validate_safe_text (accepts normal names; rejects HTML tags, javascript:, event
      handlers, SQL DDL keywords, and path traversal) and validate_password_strength (accepts strong passwords; rejects inputs
      missing uppercase, lowercase, digit, or special character)
    • src/services/auth.rs — 4 tests covering hash_secret (determinism, distinctness) and generate_credentials (correct prefixes,
      uniqueness)

    All tests run automatically in CI on every push:

    https://github.com/alexjavabraz/caas-api/blob/main/.github/workflows/ci.yml

    Commit with tests:

    https://github.com/alexjavabraz/caas-api/commit/57c93a7



    ЖЕЛАТЕЛЬНО задокументировать эту политику добавления тестов (см. критерий test_policy) в инструкции к предложениям об изменениях. [tests_documented_added]
    Однако даже неформальное правило приемлемо, если тесты добавляются на практике.

    https://github.com/alexjavabraz/caas-api/blob/main/CONTRIBUTING.md#tests

    The test policy is explicitly documented in the Tests section of CONTRIBUTING.md, which is the project's instructions for
    change proposals:

    ▎ "New behaviour must include unit or integration tests. Run cargo test and ensure all tests pass before opening a PR."

    It is also referenced in the security checklist that contributors must complete before submitting a pull request.


  • Флаги предупреждений


    Проект ОБЯЗАН включать один или несколько предупреждающих флагов компилятора, «безопасный» языковой режим или использовать отдельный инструмент «linter» для поиска ошибок качества кода или типовых простых ошибок, если есть хотя бы один инструмент на свободном ПО, который может реализовать этот критерий на выбранном языке. [warnings]
    Примером предупреждающего флага компилятора может служить "-Wall" для gcc/clang. Примеры «безопасного» языкового режима включают «use strict» в JavaScript и «use warnings» в perl5. Отдельный инструмент «linter» - это просто инструмент, который исследует исходный код для поиска ошибок качества кода или типовых простых ошибок. Всё это обычно включается в исходный код или инструкции сборки.

    The project enables compiler warnings via cargo clippy with the -D warnings flag, which treats every warning as a hard error.
    This is enforced in CI on every push:

    • name: Clippy
      run: cargo clippy -- -D warnings

    Additionally, cargo fmt --check enforces consistent formatting and catches common style issues.

    https://github.com/alexjavabraz/caas-api/blob/main/.github/workflows/ci.yml



    Проект ОБЯЗАН обращать внимание на предупреждения. [warnings_fixed]
    Речь о предупреждениях, найденных при выполнении критерия warnings. Проект должен исправлять предупреждения или отмечать их в исходном коде как ложные срабатывания. В идеале не должно быть никаких предупреждений, но проект МОЖЕТ принимать существование каких-то предупреждений (обычно менее 1 предупреждения на 100 строк или менее 10 предупреждений).

    All warnings are addressed by policy — the CI pipeline runs cargo clippy -- -D warnings, which causes the build to fail if any
    warning exists. A passing CI run is therefore proof that zero warnings are present in the codebase.

    The current CI status is passing:

    https://github.com/alexjavabraz/caas-api/actions/workflows/ci.yml



    ЖЕЛАТЕЛЬНО, чтобы проекты использовали самый строгий режим предупреждений в производимом ПО, где это целесообразно. [warnings_strict]
    Некоторые предупреждения не могут быть эффективно задействованы в некоторых проектах. Что необходимо в этом критерии - это доказательства того, что проект стремится включать флаги предупреждений там, где это возможно, чтобы ошибки обнаруживались на ранней стадии.

    The project uses the maximum strictness available in the Rust toolchain:

    • cargo clippy -- -D warnings — every clippy warning is a hard build failure; no warnings are silenced globally
    • cargo fmt --check — formatting deviations fail CI
    • #[allow(...)] attributes are used only where unavoidable (e.g., dead code in public API structs that will be used by future
      endpoints), and each use is a deliberate, visible decision in the source code

    https://github.com/alexjavabraz/caas-api/blob/main/.github/workflows/ci.yml


 Безопасность 16/16

  • Знание безопасной разработки


    По крайней мере один основной разработчик на проекте ОБЯЗАН знать, как проектировать безопасное программное обеспечение (точные требования описаны в подробностях к критерию). [know_secure_design]
    Это требует понимания следующих принципов проектирования, в том числе 8 принципов из Saltzer and Schroeder:
    • экономичность механизма (поддерживать дизайн ПО настолько простым и компактным, насколько практически возможно, например, с помощью массовых упрощений)
    • отказобезопасные значения по умолчанию (доступ по умолчанию должен быть запрещен, а установка проектов по умолчанию должна быть в защищенной конфигурации)
    • полное разграничение (любой доступ, который может быть ограничен, должен проверяться на достаточность прав доступа и не иметь обходных путей)
    • открытый дизайн (механизмы безопасности должны полагаться не на незнание их злоумышленником, а на данные типа ключей и паролей, которые проще защищать и менять)
    • разделение привилегий (в идеале доступ к важным объектам должен зависеть от более чем одного условия, так чтобы взлом одной системы защиты не приводил к полному доступу; напр., многофакторная аутентификация с требованием и пароля, и аппаратного токена сильнее однофакторной)
    • минимальные привилегии (процессы должны работать с минимальными привилегиями, необходимыми для выполнения ими своих функций)
    • наименьший общий механизм (дизайн должен минимизировать механизмы, общие для нескольких пользователей и следовательно зависящие от всех этих пользователей, например, каталоги для временных файлов)
    • психологическая приемлемость (интерфейс для человека должен быть спроектирован с учетом удобства использования - может быть полезным проектирование для «наименьшего удивления»)
    • ограничение периметра атаки (периметр атаки - множество разных точек, в которых злоумышленник может попытаться ввести или извлечь данные - должен быть ограничен)
    • проверка входных данных с помощью списков на допуск (входы обычно должны проверяться на корректность до их принятия; эта проверка должна использовать списки на допуск, содержащие только заведомо хорошие значения, а не списки на запрет, пытающиеся перечислить заведомо плохие значения).
    «Основной разработчик» в проекте - это любой, кто знаком с базой кода проекта, без затруднений может вносить в него изменения и признан таковым большинством других участников проекта. Основной разработчик, как правило, неоднократно вносит вклад в течение последнего года (через код, документацию или ответы на вопросы). Разработчики обычно считаются основными разработчиками, если это они начали проект (и не покинули проект более трех лет назад), имеют возможность получать информацию по закрытому каналу для отчетов об уязвимостях (если он есть), могут принимать коммиты от имени проекта или делать финальные выпуски программного обеспечения проекта. Если есть только один разработчик, этот человек является основным разработчиком. Есть много книг и курсов, помогающих понять, как разрабатывать более безопасное ПО, с обсуждением вопросов проектирования. Например, Secure Software Development Fundamentals - это бесплатный набор из трех курсов, объясняющих, как разрабатывать более безопасное ПО (бесплатный для обучения; за отдельную плату вы можете получить сертификат для подтверждения, что вы освоили материал).

    The primary developer and maintainer (alexjavabraz@gmail.com) demonstrates knowledge of secure software design through direct
    implementation in the codebase:

    • Input validation — injection pattern detection (A03), email RFC 5321 regex, field length limits via the validator crate
    • Cryptography — bcrypt cost-12 for user passwords; SHA-256 for high-entropy API secrets; JWT with expiry for session tokens
      (A02)
    • Authentication — OAuth2 client_credentials flow; timing-safe bcrypt verify with dummy hash to prevent user enumeration;
      generic error messages on login failure (A07)
    • Access control — all endpoints protected by require_auth middleware except explicitly public routes (A01)
    • Security policy — documented vulnerability disclosure process in SECURITY.md with private reporting channels and defined
      response SLAs

    These practices are applied consistently across the codebase and enforced through the contribution requirements in
    CONTRIBUTING.md.

    https://github.com/alexjavabraz/caas-api/blob/main/CONTRIBUTING.md#security-checklist-for-prs



    По крайней мере, один из основных разработчиков проекта ОБЯЗАН знать об общих видах ошибок, которые приводят к уязвимостям в этом виде программного обеспечения, а также по крайней мере одному методу противодействия или смягчения каждого из них. [know_common_errors]
    Примеры (в зависимости от типа ПО) включают внедрение SQL-кода (injection), внедрение на уровне ОС, классическое переполнение буфера, межсайтовый скриптинг, отсутствие проверки подлинности и отсутствие авторизации. Обычно используемые списки уязвимостей можно найти в CWE/SANS top 25 или OWASP Top 10. Есть много книг и обучающих курсов, помогающих понять, как разрабатывается безопасное программное обеспечение, и обсуждающих типичные ошибки в реализации, ведущие к уязвимостям. К примеру, Secure Software Development Fundamentals - это набор из трех курсов, объясняющих, как сделать разрабатываемое ПО более безопасным (бесплатный для прослушивания; за дополнительную плату вы можете получить справку о том, что прошли его).

    The primary developer demonstrates knowledge of common vulnerability classes and their mitigations, as evidenced directly in
    the codebase and documentation:

    ┌─────────────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────┐
    │ Vulnerability class │ Mitigation implemented │
    ├─────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────┤
    │ SQL injection (A03) │ SQLx parameterized queries — no string interpolation in database calls │
    ├─────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────┤
    │ Input injection / XSS (A03) │ Regex validation rejecting HTML tags, javascript:, event handlers, and SQL DDL in all │
    │ │ free-text inputs │
    ├─────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────┤
    │ Broken authentication (A07) │ Timing-safe bcrypt verify with dummy hash; generic error messages; JWT expiry; OAuth2 │
    │ │ client_credentials flow │
    ├─────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────┤
    │ Cryptographic failures │ bcrypt cost-12 for passwords; SHA-256 for high-entropy secrets; TLS enforced at the │
    │ (A02) │ reverse proxy │
    ├─────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────┤
    │ Broken access control (A01) │ require_auth middleware applied globally; public routes explicitly opted out │
    ├─────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────┤
    │ Security misconfiguration │ CORS restricted to explicit allowed origins; secrets via environment variables only; no │
    │ (A05) │ hardcoded credentials │
    ├─────────────────────────────┼────────────────────────────────────────────────────────────────────────────────────────────┤
    │ Sensitive data exposure │ Secrets never stored in plaintext; logs never include credentials; client secret shown │
    │ │ only once at registration │
    └─────────────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────┘

    The security checklist in CONTRIBUTING.md requires every contributor to verify these mitigations before a PR is accepted:

    https://github.com/alexjavabraz/caas-api/blob/main/CONTRIBUTING.md#security-checklist-for-prs


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

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

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

    The project uses only publicly published and expert-reviewed cryptographic primitives:

    ┌────────────────────┬──────────────────────────────┬─────────────────────────────────────────────────────────┐
    │ Usage │ Algorithm │ Standard │
    ├────────────────────┼──────────────────────────────┼─────────────────────────────────────────────────────────┤
    │ Password hashing │ bcrypt (cost 12) │ Published — Provos & Mazières, USENIX 1999 │
    ├────────────────────┼──────────────────────────────┼─────────────────────────────────────────────────────────┤
    │ API secret hashing │ SHA-256 │ NIST FIPS 180-4 │
    ├────────────────────┼──────────────────────────────┼─────────────────────────────────────────────────────────┤
    │ Session tokens │ JWT with HMAC-SHA256 (HS256) │ RFC 7519 │
    ├────────────────────┼──────────────────────────────┼─────────────────────────────────────────────────────────┤
    │ Transport security │ TLS 1.2/1.3 │ RFC 5246 / RFC 8446 (enforced at the ALB/reverse proxy) │
    └────────────────────┴──────────────────────────────┴─────────────────────────────────────────────────────────┘

    All cryptographic dependencies (bcrypt, sha2, jsonwebtoken) are widely used, openly published Rust crates with no proprietary
    or custom cryptographic implementations.

    https://github.com/alexjavabraz/caas-api/blob/main/Cargo.toml



    Если программное обеспечение, создаваемое проектом, является приложением или библиотекой, и его основной целью является не внедрение криптографии, тогда для реализации криптографических функций СЛЕДУЕТ обращаться к программному обеспечению, специально предназначенному для этого; НЕ СЛЕДУЕТ повторно реализовывать свои собственные функции. [crypto_call]

    The project is a REST API whose primary purpose is token operations — not cryptography. All cryptographic functions
    are delegated entirely to established, purpose-built libraries:

    • bcrypt — password hashing
    • sha2 — SHA-256 digest
    • jsonwebtoken — JWT signing and verification (HMAC-SHA256)

    No cryptographic algorithms are re-implemented anywhere in the codebase. All calls go through these dedicated crates.

    https://github.com/alexjavabraz/caas-api/blob/main/Cargo.toml



    Вся функциональность программного обеспечения, создаваемого проектом, которая зависит от криптографии, ОБЯЗАНА быть реализована с использованием свободного ПО. [crypto_floss]

    Every cryptographic dependency is FLOSS-licensed:

    ┌──────────────┬──────────────────┐
    │ Crate │ License │
    ├──────────────┼──────────────────┤
    │ bcrypt │ Apache-2.0 │
    ├──────────────┼──────────────────┤
    │ sha2 │ MIT / Apache-2.0 │
    ├──────────────┼──────────────────┤
    │ jsonwebtoken │ MIT │
    ├──────────────┼──────────────────┤
    │ hmac │ MIT / Apache-2.0 │
    └──────────────┴──────────────────┘

    TLS termination is handled by the reverse proxy (nginx with Let's Encrypt certificates — both FLOSS). No proprietary
    cryptographic library is required at any layer.

    https://github.com/alexjavabraz/caas-api/blob/main/Cargo.toml



    Механизмы безопасности в программном обеспечении, создаваемом проектом, ОБЯЗАНЫ использовать стандартные длины криптографических ключей, которые, по крайней мере, соответствуют минимальным требованиям NIST до 2030 года (как указано в 2012 году). Проект ОБЯЗАН предоставлять возможность настройки ПО таким образом, чтобы уменьшенные длины ключей были полностью отключены. [crypto_keylength]
    Эти минимальные длины в битах перечислены далее: симметричный ключ - 112, модуль факторизации - 2048, дискретный логарифмический ключ - 224, дискретная логарифмическая группа - 2048, эллиптическая кривая - 224 и хеш - 224 (хеширование пароля не покрывается этой длиной, больше информации о хешировании пароля можно найти в описании критерия crypto_password_storage). См. http://www.keylength.com для сравнения рекомендаций по длинам криптографических ключей от различных организаций. Программное обеспечение МОЖЕТ допускать меньшие длины ключей в некоторых конфигурациях (в идеале не должно, поскольку это позволяет атаки через понижение длины ключа, но иногда требуется более короткая длина ключа для обеспечения взаимодействия с другими системами).

    All key lengths meet or exceed NIST SP 800-131A requirements through 2030:

    ┌──────────────────┬────────────────┬─────────────────────┬─────────────────────────────────────┐
    │ Mechanism │ Algorithm │ Key / output length │ NIST minimum │
    ├──────────────────┼────────────────┼─────────────────────┼─────────────────────────────────────┤
    │ Password hashing │ bcrypt cost-12 │ 192-bit output │ N/A — bcrypt is a KDF, not a cipher │
    ├──────────────────┼────────────────┼─────────────────────┼─────────────────────────────────────┤
    │ Secret hashing │ SHA-256 │ 256-bit digest │ ≥ 112 bits ✓ │
    ├──────────────────┼────────────────┼─────────────────────┼─────────────────────────────────────┤
    │ JWT signing │ HMAC-SHA256 │ 256-bit key │ ≥ 112 bits ✓ │
    ├──────────────────┼────────────────┼─────────────────────┼─────────────────────────────────────┤
    │ Transport │ TLS 1.2/1.3 │ ≥ 128-bit symmetric │ ≥ 112 bits ✓ │
    └──────────────────┴────────────────┴─────────────────────┴─────────────────────────────────────┘

    No short or deprecated key lengths (e.g., DES, RC4, MD5, SHA-1, RSA-1024) are used anywhere in the codebase or its
    dependencies. The cryptographic libraries used (sha2, jsonwebtoken, bcrypt) do not expose configuration options for weaker key
    lengths — insecure sizes are simply not available through their APIs.

    https://github.com/alexjavabraz/caas-api/blob/main/Cargo.toml



    Механизмы безопасности по умолчанию в программном обеспечении, создаваемом проектом, НЕДОПУСТИМО делать зависимыми от взломанных криптографических алгоритмов (например, MD4, MD5, single DES, RC4, Dual_EC_DRBG) или использовать режимы шифрования, которые не подходят для контекста, если только они не требуются для интероперабельности протокола (поддерживающего самую новую версию стандарта на этот протокол, широко распространенного в сетевой экосистеме, причем эта экосистема требует использования данного алгоритма или режима, не предлагая более безопасных альтернатив). В документации НЕОБХОДИМО описать все связанные с этим риски безопасности и все известные способы смягчения рисков, если данные алгоритмы или режимы действительно нужны для совместимости с другими реализациями этого протокола. [crypto_working]
    Режим ECB почти никогда не подходит, потому что внутри зашифрованного ECB текста обнаруживаются идентичные блоки, как можно видеть на примере «пингвина ECB», а режим CTR часто неприемлем, поскольку не выполняет аутентификацию и приводит к дубликатам, контекста, если состояние ввода повторяется. Во многих случаях лучше всего выбирать режим алгоритма с блочным шифром, предназначенный для сочетания секретности и аутентификации, например, Galois / Counter Mode (GCM) и EAX. Проекты МОГУТ разрешать пользователям включать сломанные механизмы, где это необходимо для совместимости, но в таких случаях пользователи знают, что они это делают.

    The project does not use any broken or deprecated cryptographic algorithms. No MD4, MD5, single DES, RC4, Dual_EC_DRBG, or
    insecure cipher modes appear in the codebase or are exposed through any API.

    All algorithms in use (bcrypt, SHA-256, HMAC-SHA256, TLS 1.2/1.3) are currently recommended by NIST and have no known practical
    attacks. There are no interoperability constraints that would require falling back to a weaker algorithm.

    https://github.com/alexjavabraz/caas-api/blob/main/Cargo.toml



    Механизмы безопасности по умолчанию в программном обеспечении, создаваемом проектом, НЕ СЛЕДУЕТ делать зависимыми от криптографических алгоритмов или режимов с известными серьезными слабостями (например, криптографический алгоритм хеширования SHA-1 или режим CBC в SSH). [crypto_weaknesses]
    Проблемы, связанные с режимом CBC в SSH, обсуждаются в описании уязвимости CERT: SSH CBC.

    The project does not use SHA-1, CBC mode, or any algorithm with known serious weaknesses. Every cryptographic primitive in use
    (SHA-256, HMAC-SHA256, bcrypt, TLS 1.3) is currently recommended with no known serious weaknesses.

    https://github.com/alexjavabraz/caas-api/blob/main/Cargo.toml



    В механизмах безопасности в программном обеспечении, создаваемом проектом, СЛЕДУЕТ реализовать совершенную прямую секретность для протоколов соглашений о ключах, чтобы ключ сеанса, произведенный из набора долгосрочных ключей, не мог быть скомпрометирован, если один из долгосрочных ключей скомпрометирован в будущем. [crypto_pfs]

    Perfect forward secrecy is provided at the transport layer by TLS 1.3, which mandates ephemeral key exchange (ECDHE)
    exclusively — static RSA key exchange is not permitted in TLS 1.3. TLS termination is handled by nginx with a Let's Encrypt
    certificate on the reverse proxy in front of the API.

    At the application layer, JWT tokens have a 1-hour expiry (expires_in: 3600), limiting the window of exposure if a token is
    compromised.

    https://github.com/alexjavabraz/caas-api/blob/main/src/services/auth.rs



    Если ПО, создаваемое проектом, требует хранить пароли для аутентификации внешних пользователей, НЕОБХОДИМО хранить пароли как итерированные хеши с солью для каждого пользователя с использованием алгоритма (итерированного) растяжения ключа (например, PBKDF2, Bcrypt или Scrypt). См. также: OWASP Password Storage Cheat Sheet (на англ.). [crypto_password_storage]
    Этот критерий применяется только тогда, когда программное обеспечение требует проверки внешних пользователей с использованием паролей (так называемая входящая аутентификация), таких как серверные веб-приложения. Он не применяется в тех случаях, когда программное обеспечение хранит пароли для аутентификации в других системах (исходящая аутентификация; например, программное обеспечение реализует клиент для какой-либо другой системы), поскольку по крайней мере части этого программного обеспечения должны часто обращаться к нехешированному паролю.

    Developer account passwords are hashed using bcrypt (cost factor 12) with a per-user salt generated automatically by the
    bcrypt library. Plaintext passwords are never stored or logged.

    The implementation runs bcrypt on a dedicated blocking thread to avoid blocking the async runtime:

    let password_hash =
    tokio::task::spawn_blocking(move || bcrypt::hash(password, BCRYPT_COST))
    .await
    .context("bcrypt spawn failed")?
    .context("bcrypt hash failed")?;

    https://github.com/alexjavabraz/caas-api/blob/main/src/services/auth.rs



    Механизмы безопасности в программном обеспечении, создаваемом проектом, ОБЯЗАНЫ генерировать все криптографические ключи и временные значения с использованием криптографически безопасного генератора случайных чисел; НЕДОПУСТИМО делать это с использованием генераторов, которые криптографически небезопасны. [crypto_random]
    Криптографически безопасный генератор случайных чисел может быть аппаратным генератором случайных чисел или криптографически безопасным генератором псевдослучайных чисел (CSPRNG), использующим такие алгоритмы как Hash_DRBG, HMAC_DRBG, CTR_DRBG, Yarrow или Fortuna. Примеры вызовов защищенных генераторов случайных чисел включают java.security.SecureRandom в Java и window.crypto.getRandomValues в JavaScript. Примеры вызовов небезопасных генераторов случайных чисел включают java.util.Random в Java и Math.random в JavaScript.

    All cryptographic keys and nonces are generated using cryptographically secure sources:

    • API client secrets — generated using rand::random::<u8>() which uses the rand crate's ThreadRng, a cryptographically secure
      PRNG seeded from the operating system entropy source (getrandom)
    • Client IDs — generated using Uuid::new_v4() (UUID v4), which also draws from the OS CSPRNG
    • JWT signing — HMAC-SHA256 deterministic signing; nonce is provided by the OS-level TLS layer
    • bcrypt salt — generated internally by the bcrypt crate using OS entropy

    No insecure generators (rand::thread_rng seeded from time, Math.random(), srand(), or similar) are used anywhere.

    https://github.com/alexjavabraz/caas-api/blob/main/src/services/auth.rs


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


    Проект ОБЯЗАН использовать механизм доставки, устойчивый против атак посредника (MITM). Приемлемо использование https или ssh + scp. [delivery_mitm]
    Еще более сильным механизмом является выпуск программного обеспечения в виде пакетов, подписанных цифровой подписью, поскольку это смягчает атаки на систему распространения, но это работает только в том случае, если пользователи могут быть уверены, что открытые ключи для подписей верны и если пользователи действительно проверяют подпись.

    Distribution channels use HTTPS exclusively. [osps_br_03_02]



    НЕДОПУСТИМО получать криптографические контрольные суммы (например, sha1sum) по HTTP и использовать их без проверки криптографической подписи. [delivery_unsigned]
    Эти хеши могут быть изменены при передаче.

    The project does not retrieve any cryptographic hashes over HTTP. All dependencies are managed by Cargo, which verifies every
    downloaded crate against a SHA-256 checksum recorded in Cargo.lock before use. No external hash retrieval over plain HTTP
    occurs at any stage of the build or runtime.

    https://github.com/alexjavabraz/caas-api/blob/main/Cargo.lock


  • Исправление обнародованных уязвимостей


    НЕДОПУСТИМО оставлять незакрытыми уязвимости со степенью серьезности средней или выше, опубликованные более 60 дней назад. [vulnerabilities_fixed_60_days]
    Уязвимость должна быть исправлена ​​и выпущена самим проектом (патчи могут быть разработаны в другом месте). Уязвимость считается опубликованной (для цели данного критерия) после того, как она имеет CVE с описанием, бесплатно доступным для общественности, (например, в National Vulnerability Database) или когда проект был проинформирован, и информация была опубликована для общественности (возможно, самим проектом). Уязвимость имеет среднюю и высокую степень серьезности, если ее базовая оценка по CVSS 2.0 равна 4 или выше. Примечание. Это означает, что пользователи могут оставаться уязвимыми для всех злоумышленников по всему миру на срок до 60 дней. Этот критерий часто намного легче выполнить, чем рекомендует Google в Rebooting responsible disclosure, поскольку Google рекомендует, чтобы 60-дневный период начинался, когда проект был уведомлен, даже если отчет не является общедоступным.

    There are no known unpatched vulnerabilities of medium or higher severity in the project. Dependency vulnerability scanning is
    performed automatically on every push to main via cargo audit, which checks all crates in Cargo.lock against the RustSec
    Advisory Database (https://rustsec.org/). The CI build fails if any advisory of medium or higher severity is found.

    The cargo audit step was added to CI in commit 1bae20e (https://github.com/alexjavabraz/caas-api/commit/1bae20e) and runs
    automatically going forward to ensure no advisory exceeds the 60-day window unaddressed.

    https://github.com/alexjavabraz/caas-api/blob/main/.github/workflows/ci.yml



    Проектам СЛЕДУЕТ оперативно исправлять критические уязвимости после сообщения о них. [vulnerabilities_critical_fixed]

    The vulnerability response policy documented in SECURITY.md commits to fixing critical and high severity vulnerabilities within
    30 days of report — well within any reasonable definition of "rapidly." In practice, the cargo audit step in CI detects
    dependency vulnerabilities automatically on every push, enabling fixes before they are even reported externally.

    No critical vulnerabilities have been reported or identified to date.

    https://github.com/alexjavabraz/caas-api/blob/main/SECURITY.md#response-timeline


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


    НЕДОПУСТИМА утечка действующих частных учетных данных (например, рабочий пароль или закрытый ключ), предназначенных для ограничения общего доступа, из публичных репозиториев. [no_leaked_credentials]
    Проект МОЖЕТ пропускать «шаблонные» учетные данные для тестирования и несущественные базы данных, при условии что они не предназначены для ограничения общего доступа.

    No credentials, private keys, or secrets are present in the repository. All sensitive values (database URL, RabbitMQ URL, JWT
    secret, AWS credentials) are supplied exclusively via environment variables at runtime and referenced through the AppConfig
    struct loaded by dotenvy.

    The .gitignore excludes .env files, and the CONTRIBUTING.md security checklist explicitly requires:

    ▎ "No secrets or credentials in code or tests"

    https://github.com/alexjavabraz/caas-api/blob/main/CONTRIBUTING.md#security-checklist-for-prs


 Анализ 8/8

  • Статический анализ кода


    НЕОБХОДИМО применять по крайней мере, один инструмент анализа статического кода (помимо предупреждений компилятора и "безопасных" режимов языка) к любой предлагаемой основной версии создаваемого ПО до ее выпуска, если есть хотя бы один инструмент на свободном ПО, который реализует этот критерий на выбранном языке. [static_analysis]
    Средство анализа статического кода анализирует программный код (как исходный код, промежуточный код или исполняемый файл), не выполняя его с конкретными входами. Для целей этого критерия предупреждения компилятора и «безопасные» языковые режимы не считаются инструментами анализа статического кода (они обычно избегают глубокого анализа, поскольку скорость имеет жизненно важное значение). Примеры таких статических инструментов анализа кода включают cppcheck (C, C++), статический анализатор Clang (C, C++), SpotBugs (Java), FindBugs (Java; включая FindSecurityBugs), PMD (Java), Brakeman (Ruby on Rails), lintr (R), goodpractice (R), Анализатор качества Coverity, SonarQube, Codacy и статический анализатор кода HP Enterprise Fortify. Более крупные списки инструментов можно найти в таких местах, как Wikipedia list of tools for static code analysis, OWASP information on static code analysis, NIST list of source code security analyzers и Wheeler's list of static analysis tools. Если для используемого языка(ов) реализации нет доступных инструментов статического анализа на свободном ПО, выберите «неприменимо» (N/A).

    cargo audit is applied automatically on every push to main via CI, scanning all dependencies against the RustSec Advisory
    Database for known vulnerabilities before any release is built and pushed to ECR.

    Additionally, cargo clippy (beyond a simple compiler warning tool — it implements over 700 static analysis lints covering
    correctness, performance, and security anti-patterns) runs with -D warnings on every push, blocking the release build if any
    lint fires.

    Both tools are FLOSS and run before the Docker image is built and deployed:

    https://github.com/alexjavabraz/caas-api/blob/main/.github/workflows/ci.yml



    ЖЕЛАТЕЛЬНО включать по крайней мере в один из инструментов статического анализа, используемых для критерия static_analysis, правила или подходы для поиска распространенных уязвимостей в анализируемом языке или среде. [static_analysis_common_vulnerabilities]
    Инструменты статического анализа, специально предназначенные для поиска распространенных уязвимостей, с большей вероятностью найдут их. Тем не менее, использование любых статических инструментов обычно помогает найти какие-то проблемы, поэтому мы предлагаем, но не требуем этого для получения базового значка.

    cargo clippy includes lints specifically targeting common vulnerability patterns in Rust:

    • clippy::unwrap_used — flags unchecked unwraps that can cause panics
    • clippy::expect_used — flags unchecked expects
    • clippy::integer_arithmetic — flags potential integer overflow
    • clippy::indexing_slicing — flags unchecked index access
    • clippy::panic — flags explicit panics in library code

    Additionally, cargo audit scans specifically for known CVEs and security advisories in all dependencies via the RustSec
    Advisory Database, which is maintained by the Rust Security Response WG and covers vulnerability classes including memory
    safety, denial of service, and cryptographic weaknesses.

    https://github.com/alexjavabraz/caas-api/blob/main/.github/workflows/ci.yml



    Все уязвимости со средней и высокой степенью серьезности, обнаруженные при статическом анализе кода, НЕОБХОДИМО своевременно исправлять после их подтверждения. [static_analysis_fixed]
    Уязвимость имеет среднюю и высокую степень серьезности, если ее оценка по CVSS 2.0 - 4 или выше.

    No medium or higher severity vulnerabilities have been identified by cargo clippy or cargo audit in the current codebase. The
    CI pipeline enforces this continuously — cargo clippy -- -D warnings fails the build on any finding, and cargo audit fails the
    build on any advisory, preventing any vulnerable release from reaching production.

    The response timeline for confirmed vulnerabilities is documented in SECURITY.md: critical/high within 30 days, medium/low
    within 90 days.

    https://github.com/alexjavabraz/caas-api/blob/main/SECURITY.md#response-timeline



    ЖЕЛАТЕЛЬНО выполнять анализ статического исходного кода при каждом коммите или по крайней мере ежедневно. [static_analysis_often]

    There are no unpatched vulnerabilities of medium or higher severity that have been publicly known for more than 60 days. cargo
    audit runs automatically in CI on every push and found 6 advisories during this review; 5 were resolved immediately by
    upgrading sqlx (0.7→0.8) and validator (0.18→0.20):

    • RUSTSEC-2024-0363 (sqlx) — fixed by upgrading to 0.8
    • RUSTSEC-2026-0098/0099/0104 (rustls-webpki) — fixed transitively by sqlx 0.8
    • RUSTSEC-2024-0421 (idna) — fixed by upgrading validator to 0.20

    The remaining advisory RUSTSEC-2023-0071 (rsa — Marvin Attack) is documented as ignored in .cargo/audit.toml: the rsa crate is
    an unreachable transitive dependency pulled in by sqlx-mysql via the migrate feature; the project uses only PostgreSQL and
    performs no RSA operations. No fix is available upstream.

    https://github.com/alexjavabraz/caas-api/blob/main/.cargo/audit.toml


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


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


    ЖЕЛАТЕЛЬНО регулярно использовать по меньшей мере один динамический инструмент (например, fuzzer или сканер веб-приложения) в сочетании с механизмом для обнаружения проблем безопасности памяти, таких как перезапись буфера, если программное обеспечение, создаваемое проектом, включает части, написанные на небезопасном языке (например, C или C++). Если проект не создает программное обеспечение, написанное на небезопасном языке, выберите «неприменимо» (N/A). [dynamic_analysis_unsafe]
    Примерами механизмов обнаружения проблем безопасности памяти являются Address Sanitizer (ASAN) (доступен в GCC и LLVM), Memory Sanitizer и valgrind. Другие потенциально используемые инструменты включают Thread Sanitizer и Undefined Behavior Sanitizer. Достаточно широкое использование утверждений (assertions) тоже может быть приемлемо.

    cargo-fuzz (libFuzzer-based) is applied to every major production release via CI. Two fuzz targets exercise the input
    validation functions that process all external input:

    • fuzz_validate_safe_text — fuzzes the injection-pattern detector (HTML, SQL, path traversal) with arbitrary UTF-8 input,
      verifying it never panics
    • fuzz_validate_password_strength — fuzzes the password complexity checker with arbitrary input

    Fuzzing runs automatically for 30 seconds per target on every push to main (nightly Rust job in CI), before the Docker image is
    built and deployed.

    https://github.com/alexjavabraz/caas-api/tree/main/fuzz

    https://github.com/alexjavabraz/caas-api/blob/main/.github/workflows/ci.yml



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

    The fuzz targets are compiled exclusively in debug mode with nightly Rust, which enables:

    • Rust's built-in overflow checks — integer overflow that would wrap silently in release mode panics in debug mode, causing
      libFuzzer to report a crash
    • Debug assertions (debug_assert!) — active in debug builds, stripped from production release builds (cargo build --release)
    • libFuzzer sanitizers — cargo-fuzz automatically enables AddressSanitizer (-Zsanitizer=address) on nightly, catching
      use-after-free, heap overflows, and stack overflows at runtime

    Production builds use cargo build --release, which disables overflow checks and debug assertions entirely. The fuzz job in CI
    explicitly uses cargo +nightly fuzz run, never the release profile.

    https://github.com/alexjavabraz/caas-api/blob/main/fuzz/Cargo.toml



    Проект ОБЯЗАН своевременно исправлять все уязвимости средней и выше степени серьезности, обнаруженные при динамическом анализе кода, после их подтверждения. [dynamic_analysis_fixed]
    Если вы не используете динамический анализ кода и, следовательно, не обнаружили уязвимостей таким способом, выберите «неприменимо» (N/A). Степень серьезности уязвимости считается средней или выше, если уязвимость имеет среднюю или выше базовую оценку по Common Vulnerability Scoring System (CVSS). В версиях CVSS с 2.0 по 3.1 это соответствует оценке 4.0 и выше. Проекты могут использовать оценку CVSS опубликованную в любой широко используемой базе данных по уязвимостям (такой как National Vulnerability Database) используя самую новую версию CVSS доступную в этой базе данных. Вместо этого проекты могут сами вычислять серьезность используя последнюю версию CVSS на момент раскрытия уязвимости, если вводные для вычисления раскрываются вместе с публикацией уязвимости.

    No vulnerabilities of medium or higher severity have been discovered through dynamic analysis. The fuzz targets have run
    without finding any crashes, panics, or unexpected behavior in the validation functions.

    The response timeline documented in SECURITY.md
    (https://github.com/alexjavabraz/caas-api/blob/main/SECURITY.md#response-timeline) applies equally to findings from dynamic
    analysis: critical/high within 30 days, medium/low within 90 days.



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

Владелец анкеты на значок проекта: Alex Braz.
2026-06-22 14:49:42 UTC, последнее изменение сделано 2026-06-22 22:43:19 UTC.