thecyberworld/docser

Docser

Docser is a credential scanning tool similar to gitleaks custom tailored for document git repositories which are prone to have a lot of false positives.

Prerequisite

go 1.21.0

Installation

$ git clone https://github.com/0xFTW/docser

$ cd docser 

$ go install

$ go build

Adding to path

$ sudo mv docser /usr/local/bin/

$ chmod 755 /usr/local/bin/docser

Usage

$ docser -h
Usage: docser -d /path/to/directory
  -d string
        Directory to be scanned. (Default is current directory)
  -h    Displays help menu

Upgrade

You can upgrade the client to the latest version using the following command.

$ ./docser --upgrade
Application upgraded successfully.

If you are already using the latest version, you will see the following message.

./docser --upgrade
You are using the latest version.

Plans for future

• Support for toml files for custom configuration
• Logic to parse finding and show in similar to gitleaks.
• Multi threading / concurrency for faster processing.
• Support for remote git repository.

Contributing

• Contributions make the open source community such an amazing place to learn, inspire, and create.
• Any contributions you make are truly appreciated.
• Check out our contribution guidelines for more information.

---

🛡 License

Docser is licensed under the MIT License - see the LICENSE file for details.

---

docser's Issues

[FEATURE] Scan remote github repositories

Detailed description

Add support for the tool to scan remote github repositories for secrets so that it would be possible for anyone to run the tool in a pipeline.

Context

This feature will add support for pipeline which will make monitoring easier for security engineers and developers.

Possible implementation

No response

Additional information

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[FEATURE] Add multithreading to the project to make it faster

Detailed description

Currently the project runs in a single thread which makes it very slow compared to other credential scanners out there.

Context

Currently the project runs in a single thread which makes it very slow compared to other credential scanners out there.
Add multithreading to it which will increase the performance of the tool.

Possible implementation

No response

Additional information

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[DOCS] Upgrade plan for future section in Readme

Description

Currently readme includes plans for future which are already there in the project, remove those and add new plans for future in the project

Screenshots

No response

Additional information

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[FEATURE] Upgrade script from github if a newer version is available

Detailed description

The project should check if there is a new commit on github and if there is one the it should upgrade the tool with all the new changes available.

Context

A user can simple run docser --upgrade and then project should check if there is a new commit on github and if there is one the it should upgrade the tool with all the new changes available.

Possible implementation

No response

Additional information

No response

Code of Conduct

• I agree to follow this project's Code of Conduct