cookiecutter-python-package

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

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

Мы с удовольствием предоставляем информацию на нескольких языках, однако, если есть какой-либо конфликт или несоответствие между переводами, английская версия является авторитетной.

Если это ваш проект, пожалуйста, покажите свой значок на странице проекта! Статус значка выглядит следующим образом:

Уровень значка для проекта 5988 - passing

Вот как вставить его:

Вы можете показать свой статус значка, вставив его в файл с разметкой Markdown:

[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/5988/badge)](https://www.bestpractices.dev/projects/5988)

- или HTML:
<a href="https://www.bestpractices.dev/projects/5988"><img src="https://www.bestpractices.dev/projects/5988/badge"></a>

Это критерии уровня

. Вы также можете просмотреть критерии уровня

или

Анализ 2/2 ●

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

Criterion [dynamic_analysis]
Соответствует

Не соответствует

Неприменимо

?

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

We have enabled a 3-factor build matrix to stress test the package. Each Job runs the Test Suite on an environment defined by a python version (1st factor: 3.6, 3.7, 3.8, 3.9, 3.10), by a platform (2nd factor: Linux, MacOS) and by package installation type (3rd factor: just putting the package under test into PYTHONPATH, installing an sdist after building the package, or installing a wheel after building the package).

This is achieved with a combination of github action workflow config file (see https://github.com/boromir674/cookiecutter-python-package/blob/master/.github/workflows/test.yaml), a tox.ini file (see https://github.com/boromir674/cookiecutter-python-package/blob/master/tox.ini), and the tox-gh-actions python module).

This is also visible on the Github Actions interface (see https://github.com/boromir674/cookiecutter-python-package/actions) where by clicking on a Workflow run, each Job spawned based on the build matrix is visible on the left-side pane.

Criterion [dynamic_analysis_enable_assertions]
Соответствует

Не соответствует

Неприменимо

?

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

We have enabled a 3-factor build matrix to stress test the package. Each Job runs the Test Suite on an environment defined by a python version (1st factor: 3.6, 3.7, 3.8, 3.9, 3.10), by a platform (2nd factor: Linux, MacOS) and by package installation type (3rd factor: just putting the package under test into PYTHONPATH, installing an sdist after building the package, or installing a wheel after building the package).

This is achieved with a combination of github action workflow config file (see https://github.com/boromir674/cookiecutter-python-package/blob/master/.github/workflows/test.yaml), a tox.ini file (see https://github.com/boromir674/cookiecutter-python-package/blob/master/tox.ini), and the tox-gh-actions python module).

This is also visible on the Github Actions interface (see https://github.com/boromir674/cookiecutter-python-package/actions) where by clicking on a Workflow run, each Job spawned based on the build matrix is visible on the left-side pane.

This data is available under the Community Data License Agreement – Permissive, Version 2.0 (CDLA-Permissive-2.0). This means that a Data Recipient may share the Data, with or without modifications, so long as the Data Recipient makes available the text of this agreement with the shared Data. Please credit Konstantinos Lampridis and the OpenSSF Best Practices badge contributors.

Владелец анкеты на значок проекта: Konstantinos Lampridis.
2022-04-23 17:54:46 UTC, последнее изменение сделано 2025-05-10 12:01:06 UTC. Последний раз условия для получения значка были выполнены 2022-04-30 11:32:24 UTC.

cookiecutter-python-package

Основы 0/5 ●

Идентификация

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

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

Другое

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

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

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

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

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

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

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

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

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

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

Анализ 2/2 ●

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