pii-shield

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

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

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


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

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

        

 Основы 13/13 ●

  • Общая

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

    Zero-code K8s sidecar for log sanitization. Detects secrets via Entropy Analysis, preserves JSON integrity, and redacts PII deterministically. 🛡️

    Используйте формат выражения лицензии 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]
    Описание ОБЯЗАНО быть на языке, который могут понять потенциальные пользователи (например, с минимумом жаргона).

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

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

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

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

    CONTRIBUTING.md explains that contributors should open issues for bugs or feature requests, make changes on a branch or fork, run tests, and submit pull requests against main. It also describes that pull requests must pass required GitHub Actions checks and address review feedback before merge.
    https://github.com/pii-shield/pii-shield/blob/main/CONTRIBUTING.md


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

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

    CONTRIBUTING.md defines acceptable contribution requirements, including standard Go formatting with gofmt, keeping tests passing, adding or updating tests for behavior changes, updating documentation for user-facing changes, avoiding secrets or generated binaries, and keeping pull requests focused.
    https://github.com/pii-shield/pii-shield/blob/main/CONTRIBUTING.md


  • Свободная лицензия


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

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

    PII-Shield is licensed under Apache License 2.0, an OSI-approved FLOSS license.
    https://github.com/pii-shield/pii-shield/blob/main/LICENSE


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

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

    PII-Shield is licensed under the Apache License 2.0, which is approved by the Open Source Initiative (OSI).
    https://github.com/pii-shield/pii-shield/blob/main/LICENSE


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

    Проект ОБЯЗАН публиковать лицензию или лицензии своих результатов в стандартном расположении в своем репозитории исходного кода. (Требуется 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/pii-shield/pii-shield/blob/main/LICENSE.


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


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

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

    The project provides basic documentation in README.md, including an overview, installation and usage examples, configuration, Helm deployment, and testing guidance. The project website also provides quick-start instructions and integration guides for common logging stacks.
    https://github.com/pii-shield/pii-shield/blob/main/README.md
    https://pii-shield.com
    https://pii-shield.com/guide-datadog.html
    https://pii-shield.com/guide-loki.html
    https://pii-shield.com/guide-elk.html


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

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

    The project documents its external interfaces in README.md. It describes CLI/container input through stdin log streams and output as sanitized logs with sensitive values replaced by deterministic [HIDDEN:<hash>] tokens. It also documents the Kubernetes operator interface through Helm installation, PiiPolicy resources, pod labels, annotations, and configuration environment variables. The README links to CONFIGURATION.md for the supported environment-variable interface.
    https://github.com/pii-shield/pii-shield/blob/main/README.md


  • Другое


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

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

    https://pii-shield.com
    https://github.com/pii-shield/pii-shield
    https://github.com/pii-shield/pii-shield/releases
    https://hub.docker.com/r/thelisdeep/pii-shield
    https://artifacthub.io/packages/search?repo=pii-shield


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

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

    The project uses GitHub Issues and Pull Requests for public discussion of bugs, feature requests, proposed changes, and code changes. These discussions are searchable, each issue, pull request, and comment has a stable URL, new contributors can participate through the web interface, and no client-side installation of proprietary software is required.
    https://github.com/pii-shield/pii-shield/issues
    https://github.com/pii-shield/pii-shield/pulls


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

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

    The project documentation, including README.md, CONTRIBUTING.md, SECURITY.md, and the project website, is written in English. The project accepts bug reports, feature requests, pull requests, and code comments in English through GitHub Issues and Pull Requests.
    https://github.com/pii-shield/pii-shield/blob/main/README.md
    https://github.com/pii-shield/pii-shield/blob/main/CONTRIBUTING.md
    https://github.com/pii-shield/pii-shield/issues
    https://github.com/pii-shield/pii-shield/pulls


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

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

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

    The project is actively maintained, with recent commits, merged pull requests, CI runs, dependency update activity, issue tracking, and release artifacts. Maintainers respond through GitHub Issues and Pull Requests.
    https://github.com/pii-shield/pii-shield/commits/main
    https://github.com/pii-shield/pii-shield/pulls?q=is%3Apr
    https://github.com/pii-shield/pii-shield/issues
    https://github.com/pii-shield/pii-shield/releases


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

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


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

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

    The project source code is maintained in a public GitHub repository that is version-controlled with Git and publicly readable.
    https://github.com/pii-shield/pii-shield


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

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

    The project uses Git as its version control system on GitHub. The repository commit history records each change, the author/committer, timestamps, commit messages, and diffs.
    https://github.com/pii-shield/pii-shield/commits/main


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

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

    The repository tracks ongoing development through commits and pull requests between releases, enabling collaborative review of interim versions.
    https://github.com/pii-shield/pii-shield/commits/main
    https://github.com/pii-shield/pii-shield/pulls


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

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

    The project uses Git, a common distributed version control system, with the public source repository hosted on GitHub.
    https://github.com/pii-shield/pii-shield


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


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

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

    Each user-facing release is identified by a unique version tag, for example v2.0.x, and published through GitHub Releases/tags.
    https://github.com/pii-shield/pii-shield/releases
    https://github.com/pii-shield/pii-shield/tags


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

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

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

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

    The project identifies releases in the Git version control history using Git tags, such as v2.0.5 and related release tags.
    https://github.com/pii-shield/pii-shield/tags
    https://github.com/pii-shield/pii-shield/releases


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


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

    Проект ОБЯЗАН предоставлять с каждой выпускаемой версией замечания к выпуску - удобочитаемые человеком сведения об основных изменениях в этом выпуске, помогающие пользователям определить, должны ли они обновляться и какими будут последствия обновления. НЕДОПУСТИМО делать замечания к выпуску сырым выводом журнала управления версиями (например, результаты команды «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), если все получатели используют только последнюю версию (например, это код для одного веб-сайта или интернет-службы, который постоянно обновлен при помощи непрерывной доставки). Этот критерий применим только к результатам проекта, а не к его зависимостям. Перечисление уязвимостей всех транзитивных зависимостей проекта становится громоздким, поскольку зависимости увеличиваются и изменяются; и в этом нет необходимости, поскольку инструменты, которые исследуют и отслеживают зависимости, могут делать это более масштабируемым способом.

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

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


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

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

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


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

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

    The project uses GitHub Issues as its public issue tracker for individual bug reports, feature requests, and enhancement discussions.
    https://github.com/pii-shield/pii-shield/issues


    Не хватает обязательной информации, недостаточно для значка.

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

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

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

    The only externally submitted enhancement/integration request in the 2-12 month evaluation window was issue #1. It was acknowledged by the maintainer, discussed, and later closed after the related implementation was completed. Maintainer-created planning issues are not counted as externally submitted enhancement requests.
    https://github.com/pii-shield/pii-shield/issues/1


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

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

    The project uses GitHub Issues as a publicly available archive for reports and maintainer responses. Issues and comments remain searchable, include timestamps and status, and can be referenced by stable URLs.
    https://github.com/pii-shield/pii-shield/issues


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


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

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

    https://github.com/pii-shield/pii-shield/blob/main/SECURITY.md
    The project publishes a SECURITY.md policy that explains how to report security issues privately to the maintainer, including what information to include such as the affected component, reproduction steps, expected behavior, logs, and policy snippets.


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

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

    https://github.com/pii-shield/pii-shield/blob/main/SECURITY.md
    SECURITY.md instructs reporters to send security issues privately to the maintainer by email instead of opening a public issue. It asks reporters to include the affected component, reproduction steps, expected behavior, and relevant logs or policy snippets.


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

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

    N/A. The project has not received any vulnerability reports in the last 6 months, so there are no vulnerability report response times to evaluate.


 Качество 13/13 ●

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


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

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

    The project provides automated build workflows and build instructions for rebuilding the software from source. The repository includes Go module files, Dockerfiles, Helm chart packaging, and GitHub Actions workflows that build release artifacts, container images, SDK packages, and charts from source code.
    https://github.com/pii-shield/pii-shield/blob/main/README.md#build-from-source
    https://github.com/pii-shield/pii-shield/tree/main/.github/workflows
    https://github.com/pii-shield/pii-shield/blob/main/Dockerfile
    https://github.com/pii-shield/pii-shield/blob/main/operator/Dockerfile


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

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

    The project uses common build tools and ecosystems, including Go modules and go build for binaries, Docker/Buildx for container images, Helm for Kubernetes charts, npm for the Node/WASM SDK, pip/Python packaging for the Python SDK, and GitHub Actions for CI/CD automation.
    https://github.com/pii-shield/pii-shield/blob/main/README.md#build-from-source
    https://github.com/pii-shield/pii-shield/tree/main/.github/workflows
    https://github.com/pii-shield/pii-shield/blob/main/go.mod
    https://github.com/pii-shield/pii-shield/blob/main/charts/pii-shield-operator/Chart.yaml


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

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

    The project can be built using FLOSS tools: Go toolchain, Go modules, Docker/BuildKit-compatible container builds, Helm, npm, Python packaging tools, and standard shell scripts. The source repository provides Dockerfiles, Go module metadata, Helm chart files, and build instructions that do not require proprietary build tools.
    https://github.com/pii-shield/pii-shield/blob/main/README.md#build-from-source
    https://github.com/pii-shield/pii-shield/blob/main/go.mod
    https://github.com/pii-shield/pii-shield/blob/main/Dockerfile
    https://github.com/pii-shield/pii-shield/blob/main/charts/pii-shield-operator/Chart.yaml


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


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

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

    The project includes automated FLOSS test suites in the public repository, including Go unit tests, fuzz tests, smoke tests, operator tests, and SDK tests. README.md and CONTRIBUTING.md document how to run the tests locally, and public GitHub Actions workflows run them in CI.
    https://github.com/pii-shield/pii-shield/blob/main/README.md#verification
    https://github.com/pii-shield/pii-shield/blob/main/CONTRIBUTING.md#testing
    https://github.com/pii-shield/pii-shield/tree/main/.github/workflows
    https://github.com/pii-shield/pii-shield/blob/main/pkg/scanner/fuzz_test.go
    https://github.com/pii-shield/pii-shield/tree/main/operator/internal/controller


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

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

    The main Go test suite is invocable using the standard Go command go test ./.... The repository also documents standard invocations for focused tests and benchmarks, including go test -bench=. -benchmem ./pkg/scanner, and the operator test suite can be run with go test ./... from the operator directory.
    https://github.com/pii-shield/pii-shield/blob/main/CONTRIBUTING.md#testing
    https://github.com/pii-shield/pii-shield/blob/main/README.md#operator-integration-tests


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

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

    The project has automated tests covering core scanner behavior, JSON handling, multilingual logs, fuzz/stress inputs, smoke scenarios, operator controller behavior, webhook behavior, SDK paths, and end-to-end operator validation. README.md documents that unit tests cover edge cases, multilingual support, and JSON integrity with more than 85% coverage.
    https://github.com/pii-shield/pii-shield/blob/main/README.md#verification
    https://github.com/pii-shield/pii-shield/blob/main/pkg/scanner/fuzz_test.go
    https://github.com/pii-shield/pii-shield/tree/main/operator/internal/controller
    https://github.com/pii-shield/pii-shield/tree/main/operator/internal/webhook


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

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

    The project uses GitHub Actions for continuous integration. Pull requests and pushes run automated test, lint, fuzz, performance, SDK, and CodeQL workflows before changes are merged into the main branch.
    https://github.com/pii-shield/pii-shield/actions
    https://github.com/pii-shield/pii-shield/blob/main/.github/workflows/ci.yml
    https://github.com/pii-shield/pii-shield/blob/main/.github/workflows/test.yml
    https://github.com/pii-shield/pii-shield/blob/main/.github/workflows/codeql.yml


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


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

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

    CONTRIBUTING.md defines the project testing policy for contributions: contributors should add or update tests when behavior changes and keep the existing automated test suite passing before opening or merging pull requests.
    https://github.com/pii-shield/pii-shield/blob/main/CONTRIBUTING.md


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

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

    The project has evidence that recent functional changes include automated tests. For example, the recent PII_MIN_SECRET_LENGTH configuration change updated the scanner implementation and added corresponding coverage in pkg/scanner/config_coverage_test.go. The repository also contains scanner, CLI, fuzz, smoke, SDK, operator controller, webhook, and integration tests for major user-facing areas.
    https://github.com/pii-shield/pii-shield/commit/9a89505
    https://github.com/pii-shield/pii-shield/blob/main/pkg/scanner/config_coverage_test.go
    https://github.com/pii-shield/pii-shield/tree/main/pkg/scanner
    https://github.com/pii-shield/pii-shield/tree/main/operator/internal/controller
    https://github.com/pii-shield/pii-shield/tree/main/operator/internal/webhook


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

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

    CONTRIBUTING.md documents the policy for adding tests as part of the contribution and pull request process. It tells contributors to add or update tests when behavior changes and to keep existing tests passing before opening or merging pull requests.
    https://github.com/pii-shield/pii-shield/blob/main/CONTRIBUTING.md


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


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

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

    The project uses golangci-lint, a FLOSS linter for Go, in the public GitHub Actions CI workflow to detect code quality errors and common mistakes. The CI workflow also runs Go tests with the race detector enabled.
    https://github.com/pii-shield/pii-shield/blob/main/.github/workflows/ci.yml


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

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

    The project treats linter and race-test findings as CI checks. Pull requests must pass the GitHub Actions workflow that runs golangci-lint and go test -race before merge, so warnings and common code-quality issues reported by these tools are addressed as part of the review and merge process.
    https://github.com/pii-shield/pii-shield/blob/main/.github/workflows/ci.yml
    https://github.com/pii-shield/pii-shield/actions


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

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

    The project is strict for new changes: CI runs golangci-lint with only-new-issues enabled, dependency verification, fuzz sanity checks, and go test -race, so new warnings and common mistakes are blocked before merge while avoiding disruption from legacy findings.
    https://github.com/pii-shield/pii-shield/blob/main/.github/workflows/ci.yml


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

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


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

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

    The primary maintainer has professional QA and test automation experience and has documented secure design work for this project, including a threat model, security policy, secret-handling guidance, and production-readiness guidance. The project also uses security-oriented practices such as fuzz testing, CodeQL, OpenSSF Scorecard, dependency updates, and CI quality gates.
    https://github.com/pii-shield/pii-shield/blob/main/docs/threat-model.md
    https://github.com/pii-shield/pii-shield/blob/main/SECURITY.md
    https://github.com/pii-shield/pii-shield/blob/main/docs/application-readiness.md


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

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

    The primary maintainer understands common vulnerability patterns relevant to this project, including accidental secret/PII disclosure in logs, unsafe custom redaction or whitelist rules, unsafe handling of salts and credentials, malformed or adversarial log input, Kubernetes webhook/deployment failure modes, and dependency or CI supply-chain risks. The project documents mitigations such as threat modeling, private vulnerability reporting, secret-handling guidance, fuzz testing, regression tests, CodeQL, Dependabot, OpenSSF Scorecard, and production-readiness validation before rollout.

    https://github.com/pii-shield/pii-shield/blob/main/docs/threat-model.md
    https://github.com/pii-shield/pii-shield/blob/main/SECURITY.md
    https://github.com/pii-shield/pii-shield/blob/main/docs/application-readiness.md
    https://github.com/pii-shield/pii-shield/blob/main/pkg/scanner/fuzz_test.go


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

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

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

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

    PII-Shield uses HMAC-SHA256 for deterministic redaction tokens. HMAC and SHA-256 are publicly published, widely reviewed cryptographic algorithms, and the implementation uses Go's standard library crypto packages rather than a custom cryptographic implementation.
    https://github.com/pii-shield/pii-shield/blob/main/README.md
    https://github.com/pii-shield/pii-shield/blob/main/SECURITY.md
    https://github.com/pii-shield/pii-shield/blob/main/pkg/scanner/scanner.go


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

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

    The scanner uses hmac.New(sha256.New, salt) for deterministic redaction tokens and crypto/rand for salt generation, both from Go's standard library.
    https://github.com/pii-shield/pii-shield/blob/main/pkg/scanner/scanner.go


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

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

    All cryptographic functionality used by PII-Shield is implemented through the FLOSS Go toolchain and Go standard library crypto packages, including crypto/hmac, crypto/sha256, and crypto/rand. No proprietary cryptographic library or proprietary cryptographic service is required.
    https://github.com/pii-shield/pii-shield/blob/main/pkg/scanner/scanner.go


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

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

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

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

    PII-Shield's default cryptographic mechanism uses HMAC-SHA256 and crypto/rand from the Go standard library. It does not depend on broken cryptographic algorithms such as MD4, MD5, single DES, RC4, or Dual_EC_DRBG, and it does not use an inappropriate cipher mode for encryption.
    https://github.com/pii-shield/pii-shield/blob/main/pkg/scanner/scanner.go


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

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

    PII-Shield's default security mechanism uses HMAC-SHA256 with Go standard library crypto packages and does not rely on algorithms or modes with known serious weaknesses such as SHA-1 or CBC-mode encryption. The project does not implement general-purpose encryption; it uses keyed hashing for deterministic redaction tokens.
    scanner.go


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

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

    N/A. PII-Shield does not implement a key agreement protocol or derive session keys from long-term keys. Its cryptographic use is limited to HMAC-SHA256 for deterministic redaction tokens and crypto/rand for salt generation, so perfect forward secrecy is not applicable.
    scanner.go


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

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

    N/A. PII-Shield does not provide user authentication and does not store external user passwords. It processes log streams and may redact password-like values found in logs, but it does not store passwords for authentication.
    https://github.com/pii-shield/pii-shield/blob/main/README.md


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

    Механизмы безопасности в программном обеспечении, создаваемом проектом, ОБЯЗАНЫ генерировать все криптографические ключи и временные значения с использованием криптографически безопасного генератора случайных чисел; НЕДОПУСТИМО делать это с использованием генераторов, которые криптографически небезопасны. [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.

    PII-Shield uses Go's cryptographically secure crypto/rand package to generate the default random salt used by its HMAC-SHA256 redaction mechanism. It does not use insecure random generators for cryptographic salt generation.
    https://github.com/pii-shield/pii-shield/blob/main/pkg/scanner/scanner.go


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


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

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

    The project delivers source code, releases, documentation, and package/download links over HTTPS. The public GitHub repository, GitHub Releases, Docker Hub page, Artifact Hub page, and project website all use HTTPS, which counters MITM attacks during delivery.

    https://pii-shield.com
    https://github.com/pii-shield/pii-shield
    https://github.com/pii-shield/pii-shield/releases
    https://hub.docker.com/r/thelisdeep/pii-shield
    https://artifacthub.io/packages/search?repo=pii-shield


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

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

    The project distributes releases and checksum files through GitHub Releases over HTTPS, not plain HTTP. The project does not instruct users to retrieve cryptographic hashes over HTTP and trust them without signature verification.
    https://github.com/pii-shield/pii-shield/releases
    https://github.com/pii-shield/pii-shield/blob/main/README.md


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


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

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

    The project runs vulnerability checks with govulncheck and OpenSSF Scorecard. govulncheck reports 0 reachable vulnerabilities in the main codebase and no vulnerabilities in the operator. Scorecard currently reports two dependency-level OSV findings, GO-2026-5024 and GHSA-hfvc-g4fc-pqhx, but both were published less than 60 days ago as of 2026-05-26, and govulncheck does not report them as reachable in project code. Therefore there are no unpatched medium-or-higher vulnerabilities publicly known for more than 60 days.
    https://osv.dev/vulnerability/GO-2026-5024
    https://osv.dev/vulnerability/GHSA-hfvc-g4fc-pqhx
    https://github.com/pii-shield/pii-shield/actions/workflows/scorecard.yml


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

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

    The project monitors vulnerabilities through Dependabot, govulncheck, and OpenSSF Scorecard. Current govulncheck results show 0 reachable vulnerabilities in the main codebase and no vulnerabilities in the operator. No open critical vulnerabilities are currently known for the project, and recent vulnerability cleanup work was handled through dependency update PRs.
    https://github.com/pii-shield/pii-shield/security/dependabot
    https://github.com/pii-shield/pii-shield/actions/workflows/scorecard.yml
    Local govulncheck on 2026-05-26 reported 0 reachable vulnerabilities for ./... and no vulnerabilities for ./operator/...


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


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

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

    The public repository does not intentionally contain private credentials, passwords, private keys, production salts, kubeconfigs, or tokens. SECURITY.md documents that secrets must not be committed and that any accidentally committed credential must be rotated immediately. The project also uses GitHub Actions secrets for CI/CD credentials rather than storing them in the repository.
    https://github.com/pii-shield/pii-shield/blob/main/SECURITY.md
    https://github.com/pii-shield/pii-shield/security/secret-scanning


 Анализ 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).

    The project applies static analysis through CodeQL and golangci-lint in GitHub Actions. CodeQL analyzes Go code for security issues, and golangci-lint checks for code quality and common defects before changes are merged and released.
    https://github.com/pii-shield/pii-shield/blob/main/.github/workflows/codeql.yml
    https://github.com/pii-shield/pii-shield/blob/main/.github/workflows/ci.yml


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

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

    The project uses CodeQL for Go static analysis. CodeQL includes security queries designed to detect common vulnerability patterns in Go code and the surrounding environment, and it runs in GitHub Actions as part of the project's security checks.
    https://github.com/pii-shield/pii-shield/blob/main/.github/workflows/codeql.yml


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

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

    The project uses CodeQL code scanning and treats confirmed medium-or-higher severity static analysis findings as issues to fix before merge or in follow-up remediation. Current CodeQL pull request checks pass, and there are no known confirmed exploitable medium-or-higher severity static analysis findings left unresolved.
    https://github.com/pii-shield/pii-shield/security/code-scanning
    https://github.com/pii-shield/pii-shield/actions/workflows/codeql.yml


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

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

    The project runs static analysis regularly through GitHub Actions. CodeQL is configured to run on pull requests and pushes to the main branch, and golangci-lint runs in the CI workflow for pull requests and pushes, so static analysis is applied to new changes as they are integrated.
    https://github.com/pii-shield/pii-shield/blob/main/.github/workflows/codeql.yml
    https://github.com/pii-shield/pii-shield/blob/main/.github/workflows/ci.yml


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


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

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

    The project applies dynamic analysis before release through Go fuzz testing, race-detected test runs, smoke tests, benchmarks, and operator integration tests. CI runs fuzz sanity checks and go test -race, while repository scripts provide smoke and operator integration validation for release candidates.
    https://github.com/pii-shield/pii-shield/blob/main/.github/workflows/ci.yml
    https://github.com/pii-shield/pii-shield/blob/main/pkg/scanner/fuzz_test.go
    https://github.com/pii-shield/pii-shield/blob/main/scripts/test-smoke.sh
    https://github.com/pii-shield/pii-shield/blob/main/scripts/test-operator-integration.sh


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

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

    N/A. The project does not produce software written in a memory-unsafe language such as C or C++. The primary implementation is Go, with SDK packaging for Node.js/Python/WASM, so this memory-unsafe-language dynamic analysis criterion is not applicable.


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

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

    The project runs dynamic analysis through Go tests, fuzz tests, and race-detected test runs. The CI uses go test -race and fuzz sanity checks, which enable additional runtime checking and failure detection beyond normal production execution. These checks are used for testing/CI and are not part of production runtime builds.
    https://github.com/pii-shield/pii-shield/blob/main/.github/workflows/ci.yml
    https://github.com/pii-shield/pii-shield/blob/main/pkg/scanner/fuzz_test.go


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

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

    The project treats confirmed medium-or-higher severity findings from dynamic analysis as defects to fix before release. Dynamic analysis checks include Go fuzzing, race-detected tests, smoke tests, and operator integration tests. Current CI dynamic-analysis checks pass, and there are no known confirmed exploitable medium-or-higher vulnerabilities from dynamic analysis left unresolved.
    https://github.com/pii-shield/pii-shield/actions
    https://github.com/pii-shield/pii-shield/blob/main/.github/workflows/ci.yml
    https://github.com/pii-shield/pii-shield/blob/main/pkg/scanner/fuzz_test.go



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

Владелец анкеты на значок проекта: aragossa.
2026-05-22 20:10:12 UTC, последнее изменение сделано 2026-05-26 18:26:51 UTC.