Skip to main content

Cloudrail's package for security rules

Project description

CD PyPI GitHub license PRs Welcome Makrdown Check List

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

Uploaded Source

Built Distribution

cloudrail_knowledge-0.0.211b1-py3-none-any.whl (1.1 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cloudrail-knowledge-0.0.211b1.tar.gz
  • Upload date:
  • Size: 470.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for cloudrail-knowledge-0.0.211b1.tar.gz
Algorithm Hash digest
SHA256 22c55bbf706a049ba2dabd835e9cf37e45860d754bfcf3747fcfa2f51aad693b
MD5 68bdf87dfcefe7121c20d29bfdcef57a
BLAKE2b-256 f624b679ff2b749d5d41bba582e211e7bcbf45f3ccf5338fbf0be5bfa6fa2e10

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cloudrail_knowledge-0.0.211b1-py3-none-any.whl
  • Upload date:
  • Size: 1.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for cloudrail_knowledge-0.0.211b1-py3-none-any.whl
Algorithm Hash digest
SHA256 6e3fa1390487f97b3fc7431351c748885ef6e54be7a5cb672a7a12728acaac03
MD5 8a70dac5c0f1fb8fed7fd88fb37131c6
BLAKE2b-256 c2c1abe514b2c84a1572967832249bcaaf250777449cd7c82ca95525e7cf121a

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