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.161b5.tar.gz (391.1 kB view details)

Uploaded Source

Built Distribution

cloudrail_knowledge-0.0.161b5-py3-none-any.whl (938.0 kB view details)

Uploaded Python 3

File details

Details for the file cloudrail-knowledge-0.0.161b5.tar.gz.

File metadata

  • Download URL: cloudrail-knowledge-0.0.161b5.tar.gz
  • Upload date:
  • Size: 391.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for cloudrail-knowledge-0.0.161b5.tar.gz
Algorithm Hash digest
SHA256 ab96d5f865209abc67cfb0013fa30f047473e416b02688fd6f43bcc664ef2172
MD5 48d2b17dca508c564f9df79e8fa4625a
BLAKE2b-256 28c6187fa36d958a286ccbb30bb295084886c88011bd951011b85721f139972f

See more details on using hashes here.

File details

Details for the file cloudrail_knowledge-0.0.161b5-py3-none-any.whl.

File metadata

  • Download URL: cloudrail_knowledge-0.0.161b5-py3-none-any.whl
  • Upload date:
  • Size: 938.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for cloudrail_knowledge-0.0.161b5-py3-none-any.whl
Algorithm Hash digest
SHA256 2851be7af655972a9b492d75a9c8400c0dce96e38b9ae9f59e9d248778355b01
MD5 d6a2b1c63dd124466de7073e0705066d
BLAKE2b-256 d730a53bac9c4c84622a4a91b4f2e2190fd9dc5a80c1213199b7068c2e595f57

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