https://github.com/davidmoremad/dome9

Python wrapper for the Dome9 API
https://github.com/davidmoremad/dome9

ci cicd cloudguard cloudguard-dome9 cloudsecurity cspm dome9 python

Last synced: 2 months ago
JSON representation

Python wrapper for the Dome9 API

• Host: GitHub
• URL: https://github.com/davidmoremad/dome9
• Owner: davidmoremad
• License: mit
• Created: 2019-09-29T09:30:23.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-09-03T22:11:43.000Z (5 months ago)
• Last Synced: 2024-09-15T01:45:45.251Z (4 months ago)
• Topics: ci, cicd, cloudguard, cloudguard-dome9, cloudsecurity, cspm, dome9, python
• Language: Python
• Homepage: https://dome9.readthedocs.io/
• Size: 355 KB
• Stars: 2
• Watchers: 2
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Dome9 (Python SDK)

**🚨 This package is not maintained anymore. I recommend you to use the official [Dome9 Python SDK](https://github.com/dome9/dome9-sdk-python)**

![GitHub License](https://img.shields.io/github/license/davidmoremad/dome9?style=flat-square&color=purple)

[![Documentation Status](https://readthedocs.org/projects/dome9/badge/?version=latest&style=flat-square)](http://dome9.readthedocs.io/?badge=latest)

[![Test](https://github.com/davidmoremad/dome9/actions/workflows/test.yaml/badge.svg)](https://github.com/davidmoremad/dome9/actions/workflows/test.yaml)

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dome9?label=python%20version&style=flat-square)

![PyPI](https://img.shields.io/pypi/v/dome9?label=pypi%20package&style=flat-square)

Dome9, also known as Checkpoint CloudGuard, is a cloud native security solutions for securing

assets and workloads. At the core of this solution, CloudGuard Posture Management visualizes and

assesses security posture, detects misconfigurations, automates and actively enforces standard

policies (GDPR, HIPAA, ISO27001...), and protects against attacks and insider threats. 

This repository contains a Python SDK of this tool. Initially its SDK did not have much functionality

and that is why I developed this one to be able to work and include it within my Continuous Integration processes.

If you want to integrate Dome9 as part of your CI, check my other modules: [Dome9 CLI and Agile](https://github.com/davidmoremad/dome9cli).

## Installation

```bash

pip install dome9

```

**📚 Documentation**: https://dome9.readthedocs.io/

## Usage

There are two ways to authenticate:

* **As Arguments**: Passing variables on init -> `Dome9(key='xxxxxx', secret='yyyyyyy')`

* **As Environment variables**: Setting your credentials as environment variables -> `DOME9_ACCESS_KEY` and `DOME9_SECRET_KEY`

```python

from dome9 import Dome9

dome9 = Dome9(key='xxxxxx', secret='yyyyyyy')

rulesets = dome9.list_rulesets()

```

```bash

export DOME9_ACCESS_KEY='xxxxxxxxxxxxxxxxxxxx'

export DOME9_SECRET_KEY='yyyyyyyyyyyyyyyyyyyy'

python -c "from dome9 import Dome9; print(Dome9().list_rulesets())"

```

## What can I do?

* 🌵 List all cloud accounts -> `dome9.list_cloud_accounts()`

* 🌻 List AWS accounts -> `dome9.list_aws_accounts()`

* 🌷 List KUBERNETES accounts -> `dome9.list_kubernetes_accounts()`

* 🌼 Create ruleset -> `dome9.create_ruleset()`

* 🌴 Create remediation -> `dome9.create_remediation()`

* 🌲 Connect new AWS account -> `dome9.create_aws_account()`

* 🌹 Run assessment -> `dome9.run_assessment()`

* 🍀 List all your cloud assets -> `dome9.list_protected_assets()`