https://github.com/pixincreate/leak-checker

A small VSCode extension to keep an eye on exposure of sensitive information. Created for personal use.
https://github.com/pixincreate/leak-checker

api-keys leak-checker nodejs pixincreate sensitive-data typescript vscode vscode-extension vsix

Last synced: 20 days ago
JSON representation

A small VSCode extension to keep an eye on exposure of sensitive information. Created for personal use.

• Host: GitHub
• URL: https://github.com/pixincreate/leak-checker
• Owner: pixincreate
• License: cc0-1.0
• Created: 2023-09-18T16:21:13.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-18T17:35:39.000Z (about 1 year ago)
• Last Synced: 2023-09-18T22:24:08.311Z (about 1 year ago)
• Topics: api-keys, leak-checker, nodejs, pixincreate, sensitive-data, typescript, vscode, vscode-extension, vsix
• Language: TypeScript
• Homepage:
• Size: 52.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Leak Checker

**Leak checker** is a small extension created for personal use to stop myself and anyone who use this extension from pushing sensitive information to the internet.

**Leak checker** scans the entire repository and checks for possible `.toml` files along with `api_keys` that are not present in .gitignore and throws a warning at the user in the information dialog box that there might exist a possible sensitive information that might result in havoc if unaddressed.

This will keep you secure and safe from leaking sensitive infos by constantly showing exposure warnings in the _bottom right corner_.

![Alt text](src/images/image.png)

## Requirements

- VSCode needs to be installed

- Your repository must have some sensitive info that are not in .gitignore

## Usage

- Download **Leak Checker** [latest release](https://github.com/pixincreate/leak-checker/releases/latest)

- Open VSCode > Extensions > 3 dot menu > Install from VSIX > Select **Leak Checker**

- Once installed, `Ctrl / Cmd + Shift + P` > `Code Scanner` > Enter to Initialize

## Build (Windows specific)

- Execute `winget install nodeJs` or `winget install OpenJS.NodeJS.LTS` and reload the terminal

- `npm init -y`

- `npm install --save-dev yo generator-code` (This will install dependencies into your work env and not globally. If you want to enable in global use `-g` instead of `--save-dev`)

- `npx yo code`

- `npm install fs glob`

- `cd` to `leak-checker`

- Press `F5` to run the integration test

- `npm install -g @vscode/vsce`

- Execute: `vsce package` to export the `Leak Checker` package

### Quick Note

I'm new to this and I believe this is not robust and will eat your RAM. So use with caution, you've been warned!

## Release Notes

### 0.3.0

Reduce memory usage by means of caching

### 0.2.0

Optimize the extension logic

### 0.1.0

Initial release of Leak Checker