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

Uploaded Source

Built Distribution

cloudrail_knowledge-0.0.129b2-py3-none-any.whl (886.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cloudrail-knowledge-0.0.129b2.tar.gz
  • Upload date:
  • Size: 366.2 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.129b2.tar.gz
Algorithm Hash digest
SHA256 67b6d5e2327d387b535235db041fcb4ac59082a1f930e00e338a2257824de392
MD5 1500cb096a37cab2e253c4c8c7072367
BLAKE2b-256 611ccbca988cfb55ced162c24f940bb45c65a7d4558698fd6cd88fd5c75a7409

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cloudrail_knowledge-0.0.129b2-py3-none-any.whl
  • Upload date:
  • Size: 886.4 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.129b2-py3-none-any.whl
Algorithm Hash digest
SHA256 348b80f7df3ed8324834168fc490d7438765aa69f7116b63184d974e751746ed
MD5 5be11e38e0ec43ef6c9eb599828966b5
BLAKE2b-256 2d40934fcdd110a5f6f540d9d8c9547c79fc7798fca9c12f2c6ac1a536aff3d7

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