Skip to main content

Cloudrail's package for security rules

Project description

CD PyPI GitHub license PRs Welcome

Cloudrail Knowledge

Cloudrail is a tool for doing security analysis of infrastructure-as-code before its deployment. For example Cloudrail can inspect Terraform plans and identify configurations that violate company policy and best practices, and stop the CI pipeline accordingly.

This repository contains the rules that Cloudrail runs to conduct this analysis, as well as the context model the rules evaluate against. You can use this repository for a few purposes:

  1. Review the rules Cloudrail has and how they work.
  2. Propose additions/changes to rules (just open a PR).
  3. Build your own custom rules using the same context model existing rules use (for examples see cloudrail-sample-custom-rules)

Want to understand how Cloudrail's knowledge works? Our documentation is available at https://knowledge.docs.cloudrail.app/.

Contributing

We welcome all contributions. Simply open an issue and a PR with your additions or changes. Some requirements:

  • Branch names should be <ticket-id>_<what_it's_trying_to_solve>. Such as issue_40_add_docdb_encryption_rule or 40_add_docdb_encryption_rule.
  • Any rule must have tests, see the tests directory on how these are built.

Releases

This repository has frequent releases. Those with "beta" or "b" in their name are considered still in development, not yet included in the production Cloudrail code (running in the Cloudrail SaaS). The latest non-beta release is the one currently running within Cloudrail's production service.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cloudrail-knowledge-0.0.138b8.tar.gz (375.5 kB view details)

Uploaded Source

Built Distribution

cloudrail_knowledge-0.0.138b8-py3-none-any.whl (902.6 kB view details)

Uploaded Python 3

File details

Details for the file cloudrail-knowledge-0.0.138b8.tar.gz.

File metadata

  • Download URL: cloudrail-knowledge-0.0.138b8.tar.gz
  • Upload date:
  • Size: 375.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for cloudrail-knowledge-0.0.138b8.tar.gz
Algorithm Hash digest
SHA256 d26efb8f23751969a510f47c91a4c588b0fcb1234e059d9c45759f330881bb4c
MD5 5dad4e4185c75bb3701af6636d3ca6b5
BLAKE2b-256 66d04176438ec36fd6e7704204a54fcafa267c74ef27fbb9ff4e3533e4424d3f

See more details on using hashes here.

File details

Details for the file cloudrail_knowledge-0.0.138b8-py3-none-any.whl.

File metadata

  • Download URL: cloudrail_knowledge-0.0.138b8-py3-none-any.whl
  • Upload date:
  • Size: 902.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for cloudrail_knowledge-0.0.138b8-py3-none-any.whl
Algorithm Hash digest
SHA256 9c5f533edcf3bb96ab0fde551fe552463be59151b870d95fcd5735859a8eb39e
MD5 d3f303c03ae4b2232c95ecd0613d9a5d
BLAKE2b-256 1e2ef4bf83975dbb69a50e68b372efa3c5e0588d195ca5be0e77f759938053b6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page