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.107b1.tar.gz (160.2 kB view details)

Uploaded Source

Built Distribution

cloudrail_knowledge-0.0.107b1-py3-none-any.whl (444.9 kB view details)

Uploaded Python 3

File details

Details for the file cloudrail-knowledge-0.0.107b1.tar.gz.

File metadata

  • Download URL: cloudrail-knowledge-0.0.107b1.tar.gz
  • Upload date:
  • Size: 160.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6

File hashes

Hashes for cloudrail-knowledge-0.0.107b1.tar.gz
Algorithm Hash digest
SHA256 7c8a554b62076b02c5075caf2b3745e94931765a219a6d853f0dfb9795d0729b
MD5 2738ee96a2fa1c5b96433971dbb13778
BLAKE2b-256 221674851edb1817c5e29c21cd331a5ef337110491e5fcdf781923601670efa4

See more details on using hashes here.

File details

Details for the file cloudrail_knowledge-0.0.107b1-py3-none-any.whl.

File metadata

  • Download URL: cloudrail_knowledge-0.0.107b1-py3-none-any.whl
  • Upload date:
  • Size: 444.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6

File hashes

Hashes for cloudrail_knowledge-0.0.107b1-py3-none-any.whl
Algorithm Hash digest
SHA256 989ca329dad612f304796cf861025df8021f1192773d8b2ec36962e7743f413c
MD5 383d3429ee4884afe2d1177be9bbc9f3
BLAKE2b-256 a6ed43150e366fc903af00be2811adb0ae9d6f49e80920dde5aff2e65adb4e9f

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