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

Uploaded Source

Built Distribution

cloudrail_knowledge-0.0.118b5-py3-none-any.whl (873.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cloudrail-knowledge-0.0.118b5.tar.gz
  • Upload date:
  • Size: 365.5 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.118b5.tar.gz
Algorithm Hash digest
SHA256 80a8df888e25e012db8a4789f61325845a52e9688feb08bc18ffe58e8f793940
MD5 e596aa7865112e9206e1e1cb9ba2eb85
BLAKE2b-256 21516972c9c3e43cee084b14b54a2ebe5e4608fb4e33122363f099d08fc35797

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cloudrail_knowledge-0.0.118b5-py3-none-any.whl
  • Upload date:
  • Size: 873.9 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.118b5-py3-none-any.whl
Algorithm Hash digest
SHA256 bac169f82d86ca72d4be4e391167e588b8b834cd0e1adc0734e1528aa2ac2778
MD5 4a299695e3f942329ef93e5fc280a56e
BLAKE2b-256 dcf19a8b65939561591d69a9d45e65dc565b8c7177e77b5ed24ed91ecfeb70b7

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