Skip to content

Latest commit

 

History

History
39 lines (27 loc) · 1.64 KB

README.md

File metadata and controls

39 lines (27 loc) · 1.64 KB

reflex-core

reflex

Reflex

Reflex enforces security best practices in cloud environments through event-driven automation. Get started by visiting our documentation.

reflex-core

Package for the core Reflex classes. You can use these classes to easily create Reflex rules to secure your cloud environment (currently only supports AWS).

You'll also want to familiarize yourself with the other parts of Reflex:

  • reflex-cli, a CLI for creating and managing your Reflex rules and environment.
  • reflex-engine, Terraform modules for deploying required Reflex rule infrastructure.
  • reflex documentation, general documentation about deploying reflex.

Installation

You can install reflex-core using pip.

pip install reflex-core

Usage

To utilize reflex-core, simply import the rule class you want to utilize and implement the required methods.

from reflex_core import AWSRule

class MyRule(AWSRule):
    def extract_event_data(event):
        # Logic for extracting required event info

    def resource_compliant():
        # Logic for determining if the resource configuration is compliant

    # etc

For examples, browse provided rules on Reflexive Security's GitHub.

License

Reflex is made available under the MPL 2.0 license. For more information view the LICENSE