Casting light on shadow cloud deployments
Project description
Luminaut
Casting light on shadow cloud deployments. Detect exposure of resources deployed in AWS.
Introduction
Luminaut is a utility to scope cloud environment exposure for triage. The goal is to quickly identify exposed resources and collect information to start an investigation.
Starting from the public IP addresses of AWS Elastic Network Interfaces (ENIs) and GCP Compute Engine instances, plus public URIs of GCP Cloud Run services, Luminaut gathers information about the associated resources, security configurations, and related events. The framework includes active scanning tools like nmap and whatweb, to identify services running on exposed ports, and passive sources like Shodan.
By combining cloud configuration data with external sources, Luminaut provides context to guide the next steps of an investigation.
Luminaut supports both AWS and GCP environments, with modular architecture allowing for the addition of new cloud providers, tools, and services as needed.
Features
AWS
- Enumerate ENIs with public IPs.
- Gather information about associated EC2 instances and Elastic load balancers.
- Identify permissive rules for attached security groups.
- Scan CloudTrail history for related events to answer who, what, and when.
- Supports querying for activity related to discovered ENI, EC2, ELB, and Security Group resources.
- Optionally specify a time frame to limit the scan to a specific time period.
- Query AWS Config for resource configuration changes over time.
- Supports scanning AWS Config history for the discovered ENI and EC2 Instance associated with the ENI.
- Optionally specify a time frame to limit the scan to a specific time period.
- Skip scanning and reporting on resources based on the resource id or tag values
- Supports skipping based on the resource id of the ENI.
GCP
- Enumerate Compute Engine instances with public IPs.
- Enumerate Cloud Run services with public URIs.
- Identify permissive firewall rules that allow external access to instances.
- Query GCP audit logs for instance and service lifecycle events to answer who, what, and when.
- Supports querying for activity related to discovered Compute Engine instances and Cloud Run services.
- Optionally specify a time frame to limit the scan to a specific time period.
Active scanning
- nmap to scan common ports and services against identified IP addresses.
- nmap will only scan ports associated with permissive security group rules or a load balancer listener.
- whatweb to identify services running on ports associated with exposed security group ports.
- whatweb will only scan ports associated with permissive security group rules or a load balancer listener.
Passive sources
- shodan to gather information about exposed services and vulnerabilities.
Reporting
- Console output with rich formatting, displaying key information.
- HTML capture of console output to preserve prior executions.
- CSV Timeline of events from CloudTrail, GCP audit logs, and other sources.
- JSON lines output with full event information for parsing and integration with other tools.
Installation
Luminaut is available on PyPI and can be installed with pip:
pip install luminaut
There is also a docker image available on GitHub, you can pull it locally by running:
docker pull ghcr.io/luminaut-org/luminaut
Additional installation information is available within the Luminaut documentation
Usage
Luminaut requires access to cloud providers with appropriate credentials and permissions. Configure your system with the necessary credentials for the cloud providers you want to scan:
- AWS: Configure AWS credentials using the AWS CLI.
- GCP: Configure GCP credentials using the gcloud CLI.
See the Configuration documentation for required cloud provider permissions.
No arguments are required to run luminaut. The default is to look for a luminaut.toml
file in the same directory
and run available tools to start detecting resources.
The default configuration options are shown in the Configuration section.
Luminaut help is available with the argument --help
.
$ luminaut --help
usage: luminaut [-h] [--config CONFIG] [--log LOG] [--verbose]
Luminaut: Casting light on shadow cloud deployments.
options:
-h, --help show this help message and exit
--config CONFIG Configuration file. (default: luminaut.toml)
--log LOG Log file. (default: luminaut.log)
--verbose Verbose output in the log file. (default: False)
See more usage information and examples in the Luminaut documentation
Configuration
See the documentation on Luminaut configuration
Examples
See examples/
for scripts that demonstrate the usage of Luminaut as a Python package.
Contributing
If you would like to contribute to Luminaut, please follow the guidelines in the CONTRIBUTING.md file.
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
Built Distribution
File details
Details for the file luminaut-0.13.2.tar.gz
.
File metadata
- Download URL: luminaut-0.13.2.tar.gz
- Upload date:
- Size: 27.7 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.0.1 CPython/3.12.8
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
fbf76d56e52f25a5b269d01bdf77671df69643e0a3a6cfd840bf7a7057f25ee1
|
|
MD5 |
5358a67ebf3a024c573622f12cec4fff
|
|
BLAKE2b-256 |
3130abdc441a7dd50dd777d7e5139fcb01c7cb9f62c8645b403926fb6883a2fb
|
Provenance
The following attestation bundles were made for luminaut-0.13.2.tar.gz
:
Publisher:
pypi.yml
on luminaut-org/luminaut
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1
-
Predicate type:
https://docs.pypi.org/attestations/publish/v1
-
Subject name:
luminaut-0.13.2.tar.gz
-
Subject digest:
fbf76d56e52f25a5b269d01bdf77671df69643e0a3a6cfd840bf7a7057f25ee1
- Sigstore transparency entry: 348835902
- Sigstore integration time:
-
Permalink:
luminaut-org/luminaut@b37a8cc84885840e70d443fc7f864e383e739a5d
-
Branch / Tag:
refs/tags/v0.13.2
- Owner: https://github.com/luminaut-org
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com
-
Runner Environment:
github-hosted
-
Publication workflow:
pypi.yml@b37a8cc84885840e70d443fc7f864e383e739a5d
-
Trigger Event:
release
-
Statement type:
File details
Details for the file luminaut-0.13.2-py3-none-any.whl
.
File metadata
- Download URL: luminaut-0.13.2-py3-none-any.whl
- Upload date:
- Size: 39.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.0.1 CPython/3.12.8
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
5859b03d47d95f552ca0e6e0b2e02ceda4a12ef01b2873ff0dae0eebcefb8ef2
|
|
MD5 |
b3232e7c65c4ca87354141b6aeca9de1
|
|
BLAKE2b-256 |
5a1065ae96099f1d4ee8fe62c7ca1d67b560dd330208a5e860924129ba157f53
|
Provenance
The following attestation bundles were made for luminaut-0.13.2-py3-none-any.whl
:
Publisher:
pypi.yml
on luminaut-org/luminaut
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1
-
Predicate type:
https://docs.pypi.org/attestations/publish/v1
-
Subject name:
luminaut-0.13.2-py3-none-any.whl
-
Subject digest:
5859b03d47d95f552ca0e6e0b2e02ceda4a12ef01b2873ff0dae0eebcefb8ef2
- Sigstore transparency entry: 348835939
- Sigstore integration time:
-
Permalink:
luminaut-org/luminaut@b37a8cc84885840e70d443fc7f864e383e739a5d
-
Branch / Tag:
refs/tags/v0.13.2
- Owner: https://github.com/luminaut-org
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com
-
Runner Environment:
github-hosted
-
Publication workflow:
pypi.yml@b37a8cc84885840e70d443fc7f864e383e739a5d
-
Trigger Event:
release
-
Statement type: