Gapps

Gapps — это платформа для обеспечения соответствия требованиям безопасности, которая позволяет легко отслеживать ваш прогресс по различным фреймворкам безопасности.

❄️ Посетите сайт Gapps
🏠 Хотите связаться со мной? Присоединяйтесь к нашему discord

Содержание

1. Начало работы
2. Часто задаваемые вопросы

Новые возможности ❄️

• Добавлены SOC2, NIST CSF, NIST-800-53, CMMC, HIPAA, ASVS, ISO27001, CSC CIS18, PCI DSS и SSF! Теперь всего 10 фреймворков.
• Мультитенантность, OIDC (SSO)
• Совместная работа с аудиторами
• Реестр рисков
• S3/GCS для хранения файлов

Следующие большие функции ❄️

• Интеграции!

Скриншоты платформы

Панель управления контролем

Обзор проекта

Отслеживание прогресса по контролам

Начало работы

Следуйте документации

Часто задаваемые вопросы

Если при запуске Gapps возникает ошибка подключения к базе данных, обновите (или удалите) переменные окружения

[INFO] Checking if we can connect to the database server: postgresql://db1:db1@localhost/db1
[ERROR] could not connect to server: Connection refused
        Is the server running on host "localhost" (127.0.0.1) and accepting
        TCP/IP connections on port 5432?
could not connect to server: Cannot assign requested address
        Is the server running on host "localhost" (::1) and accepting
        TCP/IP connections on port 5432?

Обычно это можно исправить, сбросив две переменные, если вы запускаете Gapps внутри Docker. Если вы хотите использовать внешнюю базу данных, см. следующий FAQ

unset SQLALCHEMY_DATABASE_URI
unset POSTGRES_HOST

Установка переменных окружения для подключения к базе данных

Значение db1 является значением по умолчанию для имени пользователя, базы данных и пароля. Если вы хотите изменить его, замените db1 на соответствующие значения, а postgres — на хост.

export POSTGRES_HOST=${POSTGRES_HOST:-postgres}
export POSTGRES_PASSWORD=${POSTGRES_PASSWORD:-db1}
export POSTGRES_USER=${POSTGRES_USER:-db1}
export POSTGRES_DB=${POSTGRES_DB:-db1}
export SQLALCHEMY_DATABASE_URI="postgresql://db1:db1@postgres/db1"

Сброс базы данных

При первом запуске Gapps автоматически создает модели базы данных. Если вы хотите сбросить данные (например, удалить все данные), установите переменную окружения RESET_DB, например export RESET_DB=yes.

Запуск Gapps для разработки

Иногда может потребоваться запустить Gapps вне Docker. Это можно сделать, запустив контейнер Postgres, а затем запустив Gapps в интерактивном режиме.

1. Раскомментируйте объявление портов здесь
2. Запустите контейнер postgres: docker-compose up -d postgres
3. Установите следующие переменные окружения:

export POSTGRES_HOST=${POSTGRES_HOST:-localhost}
export POSTGRES_PASSWORD=${POSTGRES_PASSWORD:-db1}
export POSTGRES_USER=${POSTGRES_USER:-db1}
export POSTGRES_DB=${POSTGRES_DB:-db1}
export SQLALCHEMY_DATABASE_URI="postgresql://db1:db1@localhost/db1"

4. Выполните export FLASK_CONFIG=development;bash run.sh
5. Gapps должен запуститься и подключиться к базе данных. Теперь вы можете вносить изменения в код.

Запуск с Docker Desktop

1. Скачайте файл docker-compose.yml
2. Откройте командную строку с правами администратора и перейдите (cd) в каталог, куда был скачан файл docker-compose.yml (скорее всего, Загрузки)
3. Выполните docker compose up

Просмотр переменных окружения для отладки

docker exec -e ONESHOT=yes gapps env

Выполнение миграции базы данных

docker exec -e INIT_MIGRATE=yes -e MIGRATE=yes -e ONESHOT=yes gapps bash run.sh

ИЛИ

docker-compose up -d
docker exec -it gapps bash
python3 manage.py db migrate
python3 manage.py db stamp head
python3 manage.py db upgrade
exit

Создание базы данных вручную

Внимание — это приведет к удалению всех данных в базе данных!

docker exec -it gapps bash
python3 tools/check_db_connection.py
python3 tools/check_db_models.py
python3 manage.py init_db

Обновление версий

1.) Отредактируйте файл docker-compose.yml, указав нужную версию из Docker Hub. Везде, где в файле compose увидите старую версию (должно быть 4 экземпляра), замените её на нужную версию. (например, bmarsh13/gapps:3.3.9 -> bmarsh13/gapps:3.4.0)
2.) docker-compose up -d
3.) Выполните миграцию базы данных при необходимости

Загрузка новых фреймворков в Gapps

Вы всегда можете создать новый фреймворк и элементы управления в интерфейсе, но это займет много времени. Вместо этого вы можете загрузить JSON-файл в Gapps.

Формат состоит из контролов и подконтролов. Фрагмент ниже показывает пример контрола с одним (1) подконтролом, но вы можете добавить столько, сколько хотите. Наличие подконтролов не обязательно (может быть ноль). Однако это может иметь смысл, если вы хотите разбить контрол на отслеживаемые действия. Возьмем, к примеру, фреймворк CIS 18. Вы можете поместить все 18 «доменов» как контролы, а контролы внутри каждого домена будут подконтролами в Gapps.

[
    {
        "name": "Limit information system access to authorized users, processes acting on behalf of authorized users or",       
        "description": "Maintain list of authorized users defining their identity and associated role and sync with sys",       
        "guidance": "List approved users, services, and devices, and have logical controls in place to prevent unauthor",
        "ref_code": "AC.L1-3.1.1",
        "system_level": false,
        "subcategory": "Identity & Access Management (IAM)",
        "category": "Access Control",
        "dti": "easy",
        "dtc": "easy",
        "meta": {},
        "subcontrols": [
            {
                "ref_code": "3.1.1.a",
                "name": "Authorized users are identified.",
                "description": "Authorized users are identified.",
                "meta": {},
                "tasks": [
                    {
                        "title": "title of the task",
                        "description": "description of the task"
                    }
                ]
            }
        ]
    }
]

Затем сохраните приведенный выше формат JSON в файл (например, my_framework.json, но он должен заканчиваться на .json). Имя вашего фреймворка будет взято из имени файла при загрузке в Gapps (в данном случае my_framework). Сохраните файл в каталоге app/files/base_controls/. Вы также можете изменить каталог загрузки, задав переменную окружения FRAMEWORK_FOLDER. После того как новый фреймворк сохранен в файл и находится в каталоге фреймворков, вы можете создать нового Tenant в интерфейсе. Gapps автоматически загрузит ваш фреймворк. Если вы хотите добавить фреймворк в существующего Tenant, перейдите на страницу "Tenants", отредактируйте Tenant и нажмите кнопку "Reload Frameworks".

Сборка и публикация

docker build -t gapps:3.4.3 .
docker tag gapps:3.4.3 bmarsh13/gapps:3.4.3
docker push bmarsh13/gapps:3.4.3

Аутентификация API

Вы можете сгенерировать API-токен, открыв следующий маршрут в вашем браузере

# Create token that expires in 15 minutes
<gapps-host>/api/v1/token

# Create token that expires in 30 seconds
<gapps-host>/api/v1/token?expiration=30

# Create token that never expires
<gapps-host>/api/v1/token?expiration=0

А вот как использовать токен для аутентификации (пример с curl)

TOKEN="TOKEN HERE"
curl <gapps-host>/api/v1/tenants -H "token: $TOKEN"