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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: cloudrail-knowledge-0.0.188b1.tar.gz
  • Upload date:
  • Size: 417.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.8

File hashes

Hashes for cloudrail-knowledge-0.0.188b1.tar.gz
Algorithm Hash digest
SHA256 43cf2d6301d9192fee2131ee17a0f6e1c3eb1af4c11cea84511f65589c033a0d
MD5 a8df6ae66e693b23f830dbc1b287679e
BLAKE2b-256 715cbf957b432b806821970eaf675e61c0c47d835fbdfab2aef40cf0a5e03ef1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cloudrail_knowledge-0.0.188b1-py3-none-any.whl
  • Upload date:
  • Size: 1.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.8

File hashes

Hashes for cloudrail_knowledge-0.0.188b1-py3-none-any.whl
Algorithm Hash digest
SHA256 986b92dd5def71e295b51172ab03c985f5b3118452930eedea869c69a06c3d2b
MD5 d108fb64956a7a001abef32b9597df76
BLAKE2b-256 dbda1a770c3d859669858949b6734376835db73a80e8f9d5d9b826f48dace84e

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