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

Uploaded Source

Built Distribution

cloudrail_knowledge-0.0.129b1-py3-none-any.whl (888.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cloudrail-knowledge-0.0.129b1.tar.gz
  • Upload date:
  • Size: 366.6 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.2 CPython/3.9.6

File hashes

Hashes for cloudrail-knowledge-0.0.129b1.tar.gz
Algorithm Hash digest
SHA256 bc03ee05c3745b1ade2e8b98afdd09aadb9ba28f4ad0ea17885bc50bdb368896
MD5 9214d47cc903f9c157ec395b12f1c54a
BLAKE2b-256 6abe3ebcd8070dd502ee6a0028188859968df3bc2a9c00e0e9502ab37a313ba7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cloudrail_knowledge-0.0.129b1-py3-none-any.whl
  • Upload date:
  • Size: 888.2 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.2 CPython/3.9.6

File hashes

Hashes for cloudrail_knowledge-0.0.129b1-py3-none-any.whl
Algorithm Hash digest
SHA256 282c9085154ad505ce813e362ffb37936a957b8784598851f0a17d18a22f836d
MD5 67986f5f23f0d89bc0b7c37a7c1bf3b7
BLAKE2b-256 2d1acbda0f943f308e3b89387b6e802df0f8a05b971f0ecff079d69b4bc9d09c

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