git-secrets-replacer

README

Git Secrets Replacer

Overview

Git Secrets Replacer is a tool to help you remove sensitive information (secrets) from the entire history of a Git repository. It allows you to replace secrets in all commits with a sanitized version and optionally force push the changes to the remote repository.

Features

• Replace secrets across all commits in a Git repository.
• Supports multiple secrets from a secrets file.
• Optionally force push changes to the remote repository.
• Utilizes goroutines for faster processing.

Installation

Precompiled Binaries

Download the precompiled binaries for your operating system from the Releases page.

From Source

To build from source, you need to have Go installed. Clone the repository and build the binary:

git clone https://github.com/DeviousLabs/git-secrets-replacer.git
cd git-secrets-replacer
go build -o git-secrets-replacer main.go

Usage

Running the Binary

Run the precompiled binary and follow the prompts:

./git-secrets-replacer

Running from Source

To run the tool directly from the source code, use the go run command:

go run main.go

Command-Line Flags

The following command-line flags can be used to configure the tool:

• repoPath: Path to the repository that the code will run on.
• secretsFilePath: Path to the file containing all the secrets that need to be removed.
• forcePushToOrigin: True or False flag if the code should force push the changes to the remote/origin.

Example usage:

go run main.go --repoPath /path/to/repo --secretsFilePath /path/to/secrets.txt --forcePushToOrigin true

Secrets

The secretsFilePath should point to a text file that contains all the secrets that need to be removed from the repository history. Each secret should be on a new line.

For example, your secrets.txt file might look like this:

myPassword
anotherSecret
123456

The tool will search for each of these secrets in the repository and replace them with **REMOVED**.

Examples

Running from the Source

To run the project from the source, you need to have Go installed on your machine. Follow these steps:

1. Clone the repository:

   git clone https://github.com/DeviousLabs/git-secrets-replacer.git
   cd git-secrets-replacer
   

2. Run the project:

   go run main.go
   

Command Line Flags

You can also run the project using command line flags:

go run main.go --repoPath=/path/to/repo --secretsFilePath=/path/to/secrets.txt --forcePushToOrigin=true

In this example:

--repoPath specifies the path to the repository.
--secretsFilePath specifies the path to the secrets file.
--forcePushToOrigin is a boolean flag that determines whether to force push the changes to the remote repository.

Contributions

We welcome contributions! If you'd like to contribute to the project, please follow these steps:

1. Fork the repository.
2. Create a feature branch (git checkout -b feature-branch).
3. Commit your changes (git commit -am 'Add new feature').
4. Push to the branch (git push origin feature-branch).
5. Create a new pull request.
6. Please ensure that your code follows the project's coding style and passes any tests before submitting.

For more detailed instructions, see the CONTRIBUTING file.

Reporting Security Vulnerabilities

If you discover a security vulnerability, please send an email to GitSecretsReplacer@proton.me. Do not file an issue for security vulnerabilities.

For more details on how to report a vulnerability, see our SECURITY.md file.

Issue Tracking

If you encounter any issues while using the tool, or if you have suggestions for improvement, please open an issue on our GitHub Issues page.

When reporting issues, please include:

1. A clear description of the issue.
2. Steps to reproduce the issue.
3. Any relevant logs or screenshots.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

If you have any questions or suggestions, please feel free to reach out.

You can also open an issue on this repository: GitHub Issues