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

Uploaded Source

Built Distribution

cloudrail_knowledge-0.0.190b1-py3-none-any.whl (1.0 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cloudrail-knowledge-0.0.190b1.tar.gz
  • Upload date:
  • Size: 419.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.8

File hashes

Hashes for cloudrail-knowledge-0.0.190b1.tar.gz
Algorithm Hash digest
SHA256 b156b451394a0471ef20a78027c5ac7acbf1bc8a93f5da4330571ca3e45b76d2
MD5 4148491020a65305b2cc4fbe8f64a845
BLAKE2b-256 3b9c82200915f145efc5c33b8907a68cf5c9f40b119b6f34070ef26018904649

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cloudrail_knowledge-0.0.190b1-py3-none-any.whl
  • Upload date:
  • Size: 1.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.8

File hashes

Hashes for cloudrail_knowledge-0.0.190b1-py3-none-any.whl
Algorithm Hash digest
SHA256 83c633a83db7a0f23cc58c49a9caa164e23b10b06de4920a4e2d5e310e51a6ed
MD5 0433ebe13f51847dcd214b5322f1da72
BLAKE2b-256 a3fb5af9887dc03bfbb9a45c552cc801f56b59b0c4054cb64b5a3a8517a02ccc

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