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.31b2.tar.gz (128.6 kB view details)

Uploaded Source

Built Distribution

cloudrail_knowledge-0.0.31b2-py3-none-any.whl (360.1 kB view details)

Uploaded Python 3

File details

Details for the file cloudrail-knowledge-0.0.31b2.tar.gz.

File metadata

  • Download URL: cloudrail-knowledge-0.0.31b2.tar.gz
  • Upload date:
  • Size: 128.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

File hashes

Hashes for cloudrail-knowledge-0.0.31b2.tar.gz
Algorithm Hash digest
SHA256 616fe2c43a4651c44554dbe77331d10d1f6f94b94a35f36f2e03c64993333022
MD5 8a07aed286a7185e836c1543cc9b2653
BLAKE2b-256 7bda70e9fead752e72dd2f35ff1f921c3aaaa49e2aa95387309dbb9ddba397ba

See more details on using hashes here.

File details

Details for the file cloudrail_knowledge-0.0.31b2-py3-none-any.whl.

File metadata

  • Download URL: cloudrail_knowledge-0.0.31b2-py3-none-any.whl
  • Upload date:
  • Size: 360.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

File hashes

Hashes for cloudrail_knowledge-0.0.31b2-py3-none-any.whl
Algorithm Hash digest
SHA256 56669e871415ed49460982054c10b7143a81e2507d26ae7cd769aab0c49b6269
MD5 5ec05eaf7263587f373ced92aedc59ee
BLAKE2b-256 b9505d95f2d119e2dc2e05790b7b58f89f00273c39675337b8a019c0902a9099

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