Secret Scanner Installation

Installation Options

Choose your preferred installation method:

Install from Source

git clone https://github.com/bytehide/bytehide-secrets-scanner-wrappers.git
cd bytehide-secrets-scanner-wrappers/wrappers/go
go build -o bytehide-secrets .

git clone https://github.com/bytehide/bytehide-secrets-scanner-wrappers.git
cd bytehide-secrets-scanner-wrappers/wrappers/go
go build -o bytehide-secrets .

Install Globally

go install github.com/bytehide/bytehide-secrets-scanner-wrappers/wrappers/go@latest

go install github.com/bytehide/bytehide-secrets-scanner-wrappers/wrappers/go@latest

Basic Setup

After installation, initialize the scanner configuration:

./bytehide-secrets init

./bytehide-secrets init

This interactive command will create a bytehide.secrets.json file in your project root directory:

{
  "token": "<your-project-token>",
  "appName": "My Go Project",
  "environment": "development",
  "sync": true,
  "fix": false,
  "anonymize": false
}

{
  "token": "<your-project-token>",
  "appName": "My Go Project",
  "environment": "development",
  "sync": true,
  "fix": false,
  "anonymize": false
}

Verify Installation

After installation, run a scan to verify everything is working:

./bytehide-secrets scan

./bytehide-secrets scan

The scanner will automatically:

1. Check if scanning is enabled for your configuration
2. Scan source code for secrets
3. Report any findings to your ByteHide dashboard
4. Export detected secrets to your ByteHide Secrets Manager (if configured)

Makefile Integration

You can integrate the scanner into your build process using a Makefile:

.PHONY: scan-secrets
scan-secrets:
	bytehide-secrets scan .

.PHONY: build
build: scan-secrets
	go build -o myapp .

.PHONY: scan-secrets
scan-secrets:
	bytehide-secrets scan .

.PHONY: build
build: scan-secrets
	go build -o myapp .

Then run:

make build

make build

go:generate Integration

Add to your Go file for scanning during code generation:

//go:generate bytehide-secrets scan .

//go:generate bytehide-secrets scan .

Then run:

go generate

go generate

Scanner Workflow

The Secret Scanner integrates into your development workflow:

1. Installation: Build from source or install globally
2. Configuration: Set up the scanner via the JSON file or init command
3. Scanning: Run manually or automatically during builds
4. Reporting: Detected secrets appear in your ByteHide dashboard
5. Action: Export, fix, or receive alerts about found secrets

What's Next?

• Configure scanner options
• Set up GitHub integration
• Integrate with CI/CD pipelines
• View detected secrets