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

Uploaded Source

Built Distribution

cloudrail_knowledge-0.0.193b1-py3-none-any.whl (1.0 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cloudrail-knowledge-0.0.193b1.tar.gz
  • Upload date:
  • Size: 425.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.0 importlib_metadata/4.8.2 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.193b1.tar.gz
Algorithm Hash digest
SHA256 189ee0876a33981888ade49c019fe68c3b3c27750888910dc306236e543c230c
MD5 2bdacd48ddb0864179a9a6d4058390c6
BLAKE2b-256 5600999faf0a33b03b253a87b9b9e7c9b7b9913d0b73e84e0c7a4b4bdf4b94c2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cloudrail_knowledge-0.0.193b1-py3-none-any.whl
  • Upload date:
  • Size: 1.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.0 importlib_metadata/4.8.2 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.193b1-py3-none-any.whl
Algorithm Hash digest
SHA256 20a04c882ae6e5e608c34c4c7bfa73e38f3fb57c26e93f5f31ecc7d7efcd93e8
MD5 514302d36878a1eaced4e36b6ffe61a6
BLAKE2b-256 b498065c0806be81156eb61dfcf86f67ba281c02a2ce0494d4b9dc9046f49db9

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