# README
methodaws provides security operators with a number of data-rich AWS enumeration capabilities to help them gain visibility into their AWS environments. Designed with data-modeling and data-integration needs in mind, methodaws can be used on its own as an interactive CLI, orchestrated as part of a broader data pipeline, or leveraged from within the Method Platform.
The number of security-relevant AWS resources that methodaws can enumerate are constantly growing. For the most up to date listing, please see the documentation here
To learn more about methodaws, please see the Documentation site for the most detailed information.
Quick Start
Get methodaws
For the full list of available installation options, please see the Installation page. For convenience, here are some of the most commonly used options:
docker run methodsecurity/methodaws
docker run ghcr.io/method-security/methodaws:0.0.1
- Download the latest binary from the Github Releases page
- Installation documentation
Authentication
methodaws is built using the AWS Go SDK and leverages the same AWS Credentials that are used by the AWS CLI. Specifically, it looks for the proper environment variables to be exported with credential information. For more information, please see the AWS documentation on how to export AWS credentials as environment variables.
General Usage
methodaws <resource> enumerate --region <AWS Region>
Examples
methodaws s3 enumerate --region us-east-1
methodaws ec2 enumerate --region us-east-1
Contributing
Interested in contributing to methodaws? Please see our Contribution page.
Want More?
If you're looking for an easy way to tie methodaws into your broader cybersecurity workflows, or want to leverage some autonomy to improve your overall security posture, you'll love the broader Method Platform.
For more information, see [https://method.security]
Community
methodaws is a Method Security open source project.
Learn more about Method's open source source work by checking out our other projects here.
Have an idea for a Tool to contribute? Open a Discussion here.