Skip to main content

:beginner: Clairvoyance - ECR Scan reports at your finger tips !

Build Status Coverage Status Code style: black Linter: flake8 Linter: tests pre-commit

Clairvoyance is a simple Hugo website with capabilities to parse ECR Security Scan reports

Nothing is better than a live demo ! Here is an overview of Clairvoyance that ran against three vulnerable docker images hosted on ECR:

:package: Clairvoyance - Architecture Diagram

architecture-diagram-alt-text


Clairvoyance - Static Hugo Website

reports-screenshot-alt-text


repo-overview-screenshot-alt-text


repo-details-screenshot-alt-text


Install voyance command line

pip install -e git+https://github.com/Lowess/clairvoyance@main#egg=clairvoyance

voyance is used to automatically generate Hugo content pages along with JSON data to easily visualize ECR scan reports. It scans the provided ECR registry as stated in the configuration file and look at a defined list of repositories and tagging patterns.

Here is a log sample you will get from voyance script execution:

Env var Description Example value
CLAIRVOYANCE_ECR__REGISTRY_ID The ECR private registry id to scan (equals your AWS account id) 123456789012
CLAIRVOYANCE_ECR__REPOSITORIES A list of ECR private repositories to get scans from '["repo1/app1", "repo2/app2"]'
CLAIRVOYANCE_ECR__ALLOWED_TAG_PATTERNS A list of tags or patterns to search for (can be a valid python regex) '["latest"]'
 voyance
2023-02-03 14:50:11,910,910      INFO credentials.py:1251 - Found credentials in shared credentials file: ~/.aws/credentials
2023-02-03 14:50:11,949,949      INFO voyance.py:84 - Clairvoyance initialized with EcrReporter configured to search in 3 repositories from registry 123456789012. Only images with ['.*'] tagging patterns will be scanned. [SnsNotifier configured to notify to SNS topic: arn:aws:sns:us-east-1:123456789012:topic-to-notify]
2023-02-03 14:50:15,539,539      INFO ecr.py:115 - Scan found for vulnerable/dvwa:latest
2023-02-03 14:50:16,015,015      INFO ecr.py:115 - Scan found for vulnerable/eclipse-temurin:11.0.13_8-jre-focal
2023-02-03 14:50:16,221,221      INFO ecr.py:115 - Scan found for vulnerable/eclipse-temurin:11.0.15_10-jre-focal
2023-02-03 14:50:16,526,526      INFO ecr.py:115 - Scan found for vulnerable/eclipse-temurin:11.0.14.1_1-jre-focal
2023-02-03 14:50:16,704,704      INFO ecr.py:115 - Scan found for vulnerable/eclipse-temurin:11.0.16.1_1-jre-focal
2023-02-03 14:50:17,772,772      INFO ecr.py:115 - Scan found for vulnerable/vulnerablewordpress:latest
2023-02-03 14:50:17,772,772      INFO voyance.py:46 - 6 scan reports found
2023-02-03 14:50:17,772,772      INFO voyance.py:27 - Function scan() took 5.82 seconds
2023-02-03 14:50:17,772,772      INFO ecr.py:152 - Generating report for dvwa/latest
2023-02-03 14:50:17,782,782      INFO ecr.py:152 - Generating report for eclipse-temurin/11.0.13_8-jre-focal
2023-02-03 14:50:17,783,783      INFO ecr.py:152 - Generating report for eclipse-temurin/11.0.15_10-jre-focal
2023-02-03 14:50:17,784,784      INFO ecr.py:152 - Generating report for eclipse-temurin/11.0.14.1_1-jre-focal
2023-02-03 14:50:17,785,785      INFO ecr.py:152 - Generating report for eclipse-temurin/11.0.16.1_1-jre-focal
2023-02-03 14:50:17,786,786      INFO ecr.py:152 - Generating report for vulnerablewordpress/latest

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

voyance-1.1.1.tar.gz (15.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

voyance-1.1.1-py3-none-any.whl (17.8 kB view details)

Uploaded Python 3

File details

Details for the file voyance-1.1.1.tar.gz.

File metadata

  • Download URL: voyance-1.1.1.tar.gz
  • Upload date:
  • Size: 15.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for voyance-1.1.1.tar.gz
Algorithm Hash digest
SHA256 a8960c611c1bc645f31a774df53d942d497adfd07ca4e86969583c7f852a36db
MD5 be3e188c30a08ea15cf94f64971fac1b
BLAKE2b-256 549522123acbc411840649ecf1395a92caa7212415c2028d15f705616660a6c5

See more details on using hashes here.

File details

Details for the file voyance-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: voyance-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 17.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for voyance-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0f5e3357ff13db80477ecbccc77c9e16af4e33087867853780330273ec114f8c
MD5 de642d7dd334ca95ab3ccc7648398aa4
BLAKE2b-256 4272296d1b02a59d697241bdfaa280df26c16232842b1ed0b6a1eb0e4d77bdb3

See more details on using hashes here.

Release history Release notifications | RSS feed

1.1.2

2 files

This release

1.1.1 This release

2 files

1.1.0

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

0.0.8

2 files

0.0.7

2 files

0.0.6

2 files

0.0.5

2 files

0.0.4

2 files

0.0.3

2 files

0.0.2

2 files

0.0.1

1 file

0.0.0

1 file

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page