Metadata-Version: 2.1
Name: mpsiemlib
Version: 1.5.1.1a0
Summary: MaxPatrol SIEM API SDK
Home-page: https://github.com/nikolaiav/mpsiemlib
Author: nikolaiav
Author-email: 
License: GPLv3
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Requires-Dist: PyYAML
Requires-Dist: pytz
Requires-Dist: elasticsearch (>=7.17.9)

# Maxpatrol SIEM API SDK
Неофициальный SDK для работы с MP SIEM через API.  
В SDK используется как UI API, так и прямые вызовы к микросервисам вследствие того, что UI API имеет ряд ограничений.  
Пример использования можно посмотреть в tests.

# Основный функции
0. Unit-тесты для проверки совместимости с новыми версиями MP SIEM.
1. Аутентификация с Core, KB, Storage.
2. Журналирование и его настройка.
3. Хранение параметров и передача модулям.
4. Работа с активами
5. Работа с событиями.
6. Работа с фильтрами событий.
7. Работа с инцидентами.
8. Работа с табличными списками.
9. Работа с контентом в KB.
10. Работа с задачами сбора.
11. Работа со встроенным мониторингом SIEM.
12. Работа со встроенным мониторингом источников.
13. Работа с пользователями в IAM.

Более детальное описание в [CHANGELOG.md](CHANGELOG.md)

## Сетевой доступ и права
Для работы SDK необходимы следующие сетевые разрешения:
- MP Core: tcp 443, tcp 3334
- PT KB: tcp 8091
- Storage (Elastic): tcp 9200

SDK аутентифицируется в Core и PT KB.  
Ряд функций требует административной учетной записи в IAM, PT KB, SIEM.

# Спасибо за помощь
[mkosmach](https://github.com/mkosmach), [GenRockeR](https://github.com/GenRockeR), [srublev](https://github.com/srublev)


# Release Notes
[CHANGELOG.md](CHANGELOG.md)

