SGO - Sistema de Gestao Operacional

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

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

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


Это критерии Базового Уровня 2. Эти критерии относятся к базовой версии v2025.10.10 с обновлённым текстом критериев из версии v2026.02.19. Критерии, новые в версии v2026.02.19, помечены как «будущие» и начнут применяться с 2026-06-01. Пожалуйста, предоставьте ответы на «будущие» критерии до этой даты.

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

        

 Основы

  • Общая

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

    SGO - Sistema de Gestao Operacional | Open-source Micro-SaaS platform with Module Federation, Docker Swarm & Traefik

    Plataforma open-source de gestão para micro empresas. Chassi pronto (autenticação, usuários, permissões, whitelabel) + módulos de negócio que você adiciona no seu ritmo. Sem lock-in: o sistema pode ficar no seu servidor, sob sua marca.

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

    Plataforma open-source de gestão para micro empresas. Chassi pronto (autenticação, usuários, permissões, whitelabel) + módulos de negócio que você adiciona no seu ritmo. Sem lock-in: o sistema pode ficar no seu servidor, sob sua marca.

    Para quem implanta: sistema profissional, validado, que fica com o cliente após a implantação.
    Para integradores e devs: base documentada, Module Federation, guias para criar módulos (incluindo uso com IA).

 Элементы управления 18/19

  • Элементы управления


    Когда задача CI/CD выполняется без указания прав доступа, система CI/CD ОБЯЗАНА по умолчанию назначать задаче минимальные права, предоставленные в конвейере. [OSPS-AC-04.01]
    Настройте параметры проекта для назначения минимальных доступных прав новым конвейерам по умолчанию, предоставляя дополнительные права только при необходимости для конкретных задач.

    Os workflows GitHub Actions (.github/workflows/) definem permissões explícitas ou usam o padrão restritivo do GitHub (read-only para a maioria dos escopos). O workflow docker.yml usa apenas as permissões necessárias (packages: write para ghcr.io).



    Когда создается официальный выпуск, этому выпуску ОБЯЗАН быть назначен уникальный идентификатор версии. [OSPS-BR-02.01]
    Присваивайте уникальный идентификатор версии каждому выпуску, создаваемому проектом, следуя согласованному соглашению о наименовании или схеме нумерации. Примеры включают SemVer, CalVer или идентификатор коммита git.

    Versões são identificadas de forma única: tags Git (v4.0.0), campo "version" em cada package.json, e tags de imagem Docker (latest + sha-<commit>). CHANGELOG.md documenta a versão 4.0.0. https://github.com/altrsconsult/sgo/blob/master/CHANGELOG.md



    Когда создается официальный выпуск, этот выпуск ОБЯЗАН содержать описательный журнал функциональных изменений и изменений безопасности. [OSPS-BR-04.01]
    Убедитесь, что все выпуски содержат описательный журнал изменений. Рекомендуется обеспечить, чтобы журнал изменений был читаемым человеком и содержал более подробные сведения, чем сообщения коммитов, такие как описания влияния на безопасность или релевантность для различных сценариев использования. Для обеспечения машиночитаемости размещайте содержимое под заголовком markdown, таким как "## Changelog".

    CHANGELOG.md contém registro das modificações funcionais e de segurança da versão 4.0.0 (baseado em "Keep a Changelog"), incluindo adições, alterações e documentação de segurança. https://github.com/altrsconsult/sgo/blob/master/CHANGELOG.md



    Когда конвейер сборки и выпуска загружает зависимости, он ОБЯЗАН использовать стандартизированные инструменты, где они доступны. [OSPS-BR-05.01]
    Используйте общие инструменты для вашей экосистемы, такие как менеджеры пакетов или инструменты управления зависимостями для загрузки зависимостей во время сборки. Это может включать использование файла зависимостей, lock-файла или манифеста для указания требуемых зависимостей, которые затем подключаются системой сборки.

    O pipeline usa pnpm (gerenciador de pacotes padronizado) com pnpm-lock.yaml para instalação determinística de dependências. Dockerfiles usam COPY controlado. GitHub Actions usa actions/checkout@v4 e docker/build-push-action@v5 (ações oficiais).



    Когда создается официальный выпуск, этот выпуск ОБЯЗАН быть подписан или учтен в подписанном манифесте, включающем криптографические хеши каждого актива. [OSPS-BR-06.01]
    Подписывайте все выпущенные программные активы во время сборки с использованием криптографической подписи или аттестаций, таких как подпись GPG или PGP, подписи Sigstore, происхождение SLSA или SLSA VSA. Включите криптографические хеши каждого актива в подписанный манифест или файл метаданных.

    Imagens Docker recebem attestation de proveniência via Sigstore (GitHub Actions), que inclui o hash SHA256 do artefato e assinatura criptográfica. Verificável com: gh attestation verify. https://github.com/altrsconsult/sgo/blob/master/docs/security/BUILD-AND-PROVENANCE.md



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

    docs/AGENTS.md e pnpm-workspace.yaml descrevem as dependências do projeto. docs/processes/SECURITY-AND-PRIVACY.md documenta o processo de monitoramento (pnpm audit, Dependabot). SBOM gerado no CI lista todas as dependências. https://github.com/altrsconsult/sgo/blob/master/docs/AGENTS.md



    (Будущий критерий) Документация проекта ДОЛЖНА включать инструкции по сборке программного обеспечения, включая необходимые библиотеки, фреймворки, SDK и зависимости. [OSPS-DO-07.01]
    Рекомендуется публиковать эту информацию вместе с документацией для участников проекта, например в файле CONTRIBUTING.md или другой документации по задачам разработчика. Это также может быть задокументировано с помощью целей Makefile или других сценариев автоматизации.


    Пока проект активен, документация проекта ОБЯЗАНА включать список членов проекта с доступом к критическим ресурсам. [OSPS-GV-01.01]
    Документируйте участников проекта и их роли с помощью таких артефактов, как members.md, governance.md, maintainers.md или аналогичного файла в репозитории исходного кода проекта. Это может быть просто включение имен или учетных записей в список сопровождающих или более сложное в зависимости от управления проектом.

    docs/governance/README.md identifica o mantenedor principal (ALTRS Consultoria / altrsadmin) como quem tem permissão de merge e acesso a recursos sensíveis do repositório. https://github.com/altrsconsult/sgo/blob/master/docs/governance/README.md



    Пока проект активен, документация проекта ОБЯЗАНА включать описания ролей и обязанностей для членов проекта. [OSPS-GV-01.02]
    Документируйте участников проекта и их роли с помощью таких артефактов, как members.md, governance.md, maintainers.md или аналогичного файла в репозитории исходного кода проекта.

    docs/governance/README.md define papéis e responsabilidades: Mantenedor (revisa/mergeia PRs, mantém políticas e releases) e Contribuidor (envia patches/docs via PRs). https://github.com/altrsconsult/sgo/blob/master/docs/governance/README.md



    Пока проект активен, документация проекта ОБЯЗАНА включать руководство для участников кода, которое включает требования к приемлемым вкладам. [OSPS-GV-03.02]
    Расширьте содержимое CONTRIBUTING.md или CONTRIBUTING/ в документации проекта, чтобы изложить требования к приемлемым вкладам, включая стандарты кодирования, требования к тестированию и руководства по отправке для участников кода. Рекомендуется, чтобы это руководство было источником истины как для участников, так и для утверждающих.

    CONTRIBUTING.md define requisitos: código segue convenções (AGENTS.md), CI deve estar verde, tom respeitoso, DCO (Signed-off-by). docs/AGENTS.md lista convenções técnicas detalhadas (TypeScript, Zod, sem inline styles, etc.). https://github.com/altrsconsult/sgo/blob/master/CONTRIBUTING.md



    Пока проект активен, система контроля версий ОБЯЗАНА требовать от всех участников кода утверждать, что они имеют законное право вносить соответствующий вклад в каждом коммите. [OSPS-LE-01.01]
    Включите DCO в репозиторий проекта, требуя от участников кода утверждать, что они имеют законное право вносить соответствующий вклад в каждом коммите. Используйте проверку статуса, чтобы убедиться, что утверждение сделано. CLA также удовлетворяет этому требованию. Некоторые системы контроля версий, такие как GitHub, могут включать это в условия обслуживания платформы.

    CONTRIBUTING.md define DCO implícito: "use git commit -s para adicionar Signed-off-by". Cada commit com -s atesta que o contribuidor está legalmente autorizado a submeter a contribuição. https://github.com/altrsconsult/sgo/blob/master/CONTRIBUTING.md



    При внесении коммита в основную ветку все автоматические проверки статуса для коммитов ДОЛЖНЫ пройти успешно или быть явно обойдены вручную. [OSPS-QA-03.01]
    Настройте систему контроля версий проекта таким образом, чтобы все автоматические проверки статуса должны были пройти успешно или требовать ручного подтверждения перед тем, как коммит может быть объединен с основной веткой. Рекомендуется НЕ настраивать необязательные проверки статуса как требование успешного прохождения или провала, которые утверждающие могут быть склонны обойти.

    DEVELOPMENT-AND-RELEASE.md: "Todo PR deve deixar o CI em estado verde antes do merge." DEVELOPMENT-SECURITY.md: "Merges para a branch principal exigem status verde no CI." Branch protection configurada. https://github.com/altrsconsult/sgo/blob/master/docs/processes/DEVELOPMENT-AND-RELEASE.md



    Перед принятием коммита в проекте ДОЛЖЕН выполняться хотя бы один автоматизированный набор тестов в конвейере CI/CD для обеспечения соответствия изменений ожиданиям. [OSPS-QA-06.01]
    Автоматизированные тесты должны выполняться перед каждым объединением с основной веткой. Набор тестов должен выполняться в конвейере CI/CD, и результаты должны быть видны всем участникам. Набор тестов должен выполняться в согласованной среде и таким образом, чтобы участники могли выполнять тесты локально. Примеры наборов тестов включают модульные тесты, интеграционные тесты и сквозные тесты.

    O workflow security.yml executa em todo push/PR: pnpm audit, Gitleaks, SBOM e pnpm run test (job "Testes"). CI deve estar verde para merge. https://github.com/altrsconsult/sgo/blob/master/docs/governance/TESTING-POLICY.md



    Когда проект выпустил релиз, документация проекта ДОЛЖНА включать проектную документацию, демонстрирующую все действия и участников в системе. [OSPS-SA-01.01]
    Включите в документацию проекта проектные описания, объясняющие действия и участников. Участники включают любую подсистему или сущность, которая может повлиять на другой сегмент в системе. Убедитесь, что эта информация обновляется для новых функций или критических изменений.

    docs/architecture/SYSTEM-OVERVIEW.md contém diagrama de alto nível com todos os atores (usuário, Traefik, chassi-frontend, chassi-backend, PostgreSQL, Nexus) e o ciclo de vida completo de uma requisição. https://github.com/altrsconsult/sgo/blob/master/docs/architecture/SYSTEM-OVERVIEW.md



    Когда проект выпустил релиз, документация проекта ДОЛЖНА включать описания всех внешних программных интерфейсов выпущенных программных активов. [OSPS-SA-02.01]
    Документируйте все программные интерфейсы (API) выпущенных программных активов, объясняя, как пользователи могут взаимодействовать с программным обеспечением и какие данные ожидаются или производятся. Убедитесь, что эта информация обновляется для новых функций или критических изменений.

    docs/AGENTS.md documenta todas as interfaces externas: 19 rotas da API REST (/api/auth, /api/users, /api/modules, etc.), interface Module Federation para módulos, e a API M2M (X-SGO-MASTER-KEY). docs/standards/MODULE-MANIFEST-SCHEMA.md define o contrato de módulos. https://github.com/altrsconsult/sgo/blob/master/docs/AGENTS.md



    Когда проект выпустил релиз, проект ДОЛЖЕН провести оценку безопасности для понимания наиболее вероятных и значимых потенциальных проблем безопасности, которые могут возникнуть в программном обеспечении. [OSPS-SA-03.01]
    Проведение оценки безопасности информирует как членов проекта, так и конечных потребителей о том, что проект понимает, какие проблемы могут возникнуть в программном обеспечении. Понимание того, какие угрозы могут быть реализованы, помогает проекту управлять рисками и справляться с ними. Эта информация полезна для конечных потребителей для демонстрации компетентности в области безопасности и практик проекта. Убедитесь, что эта информация обновляется для новых функций или критических изменений.

    O processo de segurança inclui: pnpm audit (dependências), Trivy (imagens Docker), Gitleaks (secrets), revisão de código em PRs e CI. DEVELOPMENT-SECURITY.md documenta as checagens de segurança que identificam problemas mais prováveis (deps vulneráveis, secrets expostos, CVEs em imagens). https://github.com/altrsconsult/sgo/blob/master/docs/security/DEVELOPMENT-SECURITY.md



    Пока проект активен, документация проекта ДОЛЖНА включать политику координированного раскрытия уязвимостей (CVD) с четко определенными сроками ответа. [OSPS-VM-01.01]
    Создайте файл SECURITY.md в корневом каталоге, описывающий политику проекта для координированного раскрытия уязвимостей. Включите метод сообщения об уязвимостях. Установите ожидания относительно того, как проект будет реагировать и решать сообщенные проблемы.

    SECURITY.md define política de CVD (Coordinated Vulnerability Disclosure): reporte privado (e-mail ou GitHub Security Advisories), confirmação em até 5 dias úteis, acompanhamento até correção e divulgação responsável. https://github.com/altrsconsult/sgo/blob/master/docs/security/SECURITY.md



    Пока проект активен, документация проекта ДОЛЖНА предоставлять средства для приватного сообщения об уязвимостях непосредственно контактам по безопасности в проекте. [OSPS-VM-03.01]
    Предоставьте средства для того, чтобы исследователи безопасности могли приватно сообщать об уязвимостях в проект. Это может быть специальный адрес электронной почты, веб-форма, специализированные инструменты системы контроля версий, адреса электронной почты контактов по безопасности или другие методы.

    SECURITY.md fornece dois meios de relato privado: e-mail contato@altrs.com.br e GitHub Security Advisories (aba Security → Report a vulnerability). Ambos são canais privados, não públicos. https://github.com/altrsconsult/sgo/blob/master/docs/security/SECURITY.md



    Пока проект активен, документация проекта ДОЛЖНА публично публиковать данные об обнаруженных уязвимостях. [OSPS-VM-04.01]
    Предоставляйте информацию об известных уязвимостях в предсказуемом публичном канале, таком как запись CVE, запись в блоге или другом носителе. По мере возможности эта информация должна включать затронутые версии, как потребитель может определить, уязвим ли он, и инструкции по смягчению последствий или исправлению.

    SECURITY.md inclui seção "Histórico de divulgação": vulnerabilidades corrigidas e divulgadas de forma responsável são listadas com data, gravidade e resumo (ou via GitHub Security Advisory público). https://github.com/altrsconsult/sgo/blob/master/docs/security/SECURITY.md



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

Владелец анкеты на значок проекта: Alesso.
2026-02-25 17:23:17 UTC, последнее изменение сделано 2026-02-25 18:26:41 UTC. Последний раз условия для получения значка были выполнены 2026-02-25 17:55:06 UTC.