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

Uploaded Source

Built Distribution

cloudrail_knowledge-0.0.29b1-py3-none-any.whl (381.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cloudrail-knowledge-0.0.29b1.tar.gz
  • Upload date:
  • Size: 134.4 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.29b1.tar.gz
Algorithm Hash digest
SHA256 30e4fb053e27947cb7cbf3ffc22974aceedbf0f4e0a65954402704077da4b413
MD5 3e27f24d19c36620b8d9feb2a3b9755b
BLAKE2b-256 607c36f4e412521a28abd96ccfa38986ffaeeae41739d4e4c91425ecb19232b8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cloudrail_knowledge-0.0.29b1-py3-none-any.whl
  • Upload date:
  • Size: 381.5 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.29b1-py3-none-any.whl
Algorithm Hash digest
SHA256 5fce4ec1cf162eba5b45ed56f35cf28421a0bfa2992eedce5ce8cc37a8d4d2ad
MD5 bcaf134e9e05ed60f8d4bd55f24b0995
BLAKE2b-256 55438ec5760ad2da64d7f98bd89dd64cda65acff64f776ce9401fc42baa31a0b

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