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.62b4.tar.gz (144.3 kB view details)

Uploaded Source

Built Distribution

cloudrail_knowledge-0.0.62b4-py3-none-any.whl (410.7 kB view details)

Uploaded Python 3

File details

Details for the file cloudrail-knowledge-0.0.62b4.tar.gz.

File metadata

  • Download URL: cloudrail-knowledge-0.0.62b4.tar.gz
  • Upload date:
  • Size: 144.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.5

File hashes

Hashes for cloudrail-knowledge-0.0.62b4.tar.gz
Algorithm Hash digest
SHA256 403e37280f83ee521cbeca8957f7945a99d91d9395768e1f6bfea25ced8279a4
MD5 1ab05326c9268d71e25b7d6eea2a39e8
BLAKE2b-256 4708f0612f2460400709b039fde357b368ff1b51ef9448d024031adcf52c17fb

See more details on using hashes here.

File details

Details for the file cloudrail_knowledge-0.0.62b4-py3-none-any.whl.

File metadata

  • Download URL: cloudrail_knowledge-0.0.62b4-py3-none-any.whl
  • Upload date:
  • Size: 410.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.5

File hashes

Hashes for cloudrail_knowledge-0.0.62b4-py3-none-any.whl
Algorithm Hash digest
SHA256 f54e81fa9b84130830d011c36f86889e35eb7a712486e8781157b53b19bd5996
MD5 6bf8d68cdc2f520a944e34b6bd66f882
BLAKE2b-256 45086458cc7708f6e93017d5354e6b9bfbaa08b0057b0004c92b90f2f48a6b87

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