Skip to main content

Cloudrail's package for security rules

Project description

CD PyPI GitHub license PRs Welcome Makrdown Check List

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

Uploaded Source

Built Distribution

cloudrail_knowledge-0.0.212b2-py3-none-any.whl (1.1 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cloudrail-knowledge-0.0.212b2.tar.gz
  • Upload date:
  • Size: 470.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 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.212b2.tar.gz
Algorithm Hash digest
SHA256 518a5cfa4605ff8cee3e590249c07b48a47493ab85b3571e6224d375ad508a7c
MD5 43df236fc0d32ebeb6f2859a6ebf8d32
BLAKE2b-256 fe868e57d421bbce995e94dca5c594c94597fa7e434604e6abafc1230c7da184

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cloudrail_knowledge-0.0.212b2-py3-none-any.whl
  • Upload date:
  • Size: 1.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 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.212b2-py3-none-any.whl
Algorithm Hash digest
SHA256 b6ee17af8969d5c93005aa872397a8a01ada3527ce3e67ceae9555890a187033
MD5 8a979fd4e17c7083004f9d3124ccc6ba
BLAKE2b-256 f3dcc196099919fec7adcc656c41493b62accc6622911271995db427ccba4982

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