- Introduction
- How To Use
- Overall Architecture
- Retrain Model
- License
- How to Get Involved
- How to Contact
CredSweeper is a tool to detect credentials in any directories or files. CredSweeper could help users to detect unwanted exposure of credentials (such as personal information, token, passwords, api keys and etc) in advance. By scanning lines, filtering, and using AI model as option, CredSweeper reports lines with possible credentials, where the line is, and expected type of the credential as a result.
Full documentation can be found here: https://credsweeper.readthedocs.io/
- Python 3.7, 3.8, 3.9
Details here.
pip install credsweeper[ml]Get all argument list:
python -m credsweeper --helpRun CredSweeper:
python -m credsweeper --ml_validation --path tests/samples/password --save-json output.jsonTo check JSON file run:
cat output.json[
{
"rule": "Password",
"severity": "medium",
"line_data_list": [
{
"line": "password = \"cackle!\"",
"line_num": 1,
"path": "tests/samples/password",
"entropy_validation": false
}
],
"api_validation": "NOT_AVAILABLE",
"ml_validation": "VALIDATED_KEY"
}
]To run all tests:
python -m pytest --cov=credsweeper --cov-report=term-missing -s tests/To run only tests independent from external api:
python -m pytest -m "not api_validation" --cov=credsweeper --cov-report=term-missing -s tests/We have a dataset for testing credential scanners that called CredData. If you want to test CredSweeper with this dataset please check here.
To check overall architecture of CredSweeper please check here.
If you want to check how model was trained or retrain it on your own data, please refer to the experiment folder
The CredSweeper is an Open Source project released under the terms of MIT License V2.
In addition to developing under an Open Source license, A use an Open Source Development approach, welcoming everyone to participate, contribute, and engage with each other through the project.
A recognizes the following formal roles: Contributor and Maintainer. Informally, the community may organize itself and give rights and responsibilities to the necessary people to achieve its goals.
A Contributor is anyone who wishes to contribute to the project, at any level. Contributors are granted the following rights, to:
- Contribute code, documentation, translations, artwork, and etc.
- Report defects (bugs) and suggestions for enhancement.
- Participate in the process of reviewing contributions by others.
If you want to participate in the project development, check out the how to contribute guideline in advance.
Contributors who show dedication and skill are rewarded with additional rights and responsibilities. Their opinions weigh more when decisions are made, in a fully meritocratic fashion.
A Maintainer is a Contributor who is also responsible for knowing, directing and anticipating the needs of a given a Module. As such, Maintainers have the right to set the overall organization of the source code in the Module, and the right to participate in the decision-making. Maintainers are required to review the contributor’s requests and decide whether to accept or not.
Please post questions, issues, or suggestions into Issues, This is the best way to communicate with the developer.