Unconcealment

Tool to detect secrets (AWS, GCP or AZURE keys, NPM tokens etc...)

Badges

Usage/Examples

# help 
docker run -ti --rm adioss/unconcealment:latest -h                                             
usage: main.py [-h] [-f FILE] [-d DIRECTORY] [-l LOG_LEVEL] ...

Detect secrets (AWS, GCP or AZURE keys, NPM tokens etc...)

positional arguments:
  remainder                             input from stdin

optional arguments:
  -h, --help                            show this help message and exit
  -f FILE, --file FILE                  input file
  -d DIRECTORY, --directory DIRECTORY   input directory
  -l LOG_LEVEL, --log-level LOG_LEVEL   configure the logging level.

Samples

# using input from stdin
docker run -ti --rm adioss/unconcealment:latest here some text that contains secrets like "ENV AWS_SECRET_ACCESS_KEY=4FcmDrL8tJ7jx8poyV0L5GOVqabM/abdefHQREOH"
# using file as input
docker run -ti --rm -v ${PWD}:/mnt adioss/unconcealment:latest -f /mnt/anyfile.txt
# using files as input from directory (recursive)
docker run -ti --rm -v ${PWD}:/mnt adioss/unconcealment:latest -f /mnt

Running Tests

To run tests, run the following command

   poetry run python -m unittest discover -p "test_*.py"

Run Locally

Clone the project

  git clone [email protected]:adioss/unconcealment.git

Go to the project directory

  cd unconcealment

Install poetry and install dependencies

  poetry self update
  poetry install

Start

  poetry run python unconcealment/main.py 

Documentation

TODO

Contributing

Contributions are always welcome!

See CONTRIBUTING.md for ways to get started.

Please adhere to this project's code of conduct.

Authors

• @adioss

Acknowledgements

• TODO

Support

For support, create a ticket https://www.github.com/adioss