Update README.md
Browse files
README.md
CHANGED
|
@@ -1,3 +1,17 @@
|
|
| 1 |
-
#
|
| 2 |
|
| 3 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Password-Model
|
| 2 |
|
| 3 |
+
The Password Model is intended to be used with [Credential Digger](https://github.com/SAP/credential-digger) in order to automatically filter false positive password discoveries.
|
| 4 |
+
|
| 5 |
+
## Model description
|
| 6 |
+
|
| 7 |
+
[CodeBERT-base-mlm](https://huggingface.co/microsoft/codebert-base-mlm) fine-tuned on a dataset for leak detection.
|
| 8 |
+
|
| 9 |
+
The aim of this model is to classify whether a code snippet contains a password (i.e., there is a leak) or not.
|
| 10 |
+
|
| 11 |
+
## How to use
|
| 12 |
+
|
| 13 |
+
The model is directly integrated into Credential Digger and can be used to filter the false positive discoveries of a scan.
|
| 14 |
+
|
| 15 |
+
Please refer to Credential Digger for its usage within the [python library](https://github.com/SAP/credential-digger#python-library-usage),
|
| 16 |
+
the [CLI](https://github.com/SAP/credential-digger/wiki/CLI:--Command-Line-Interface),
|
| 17 |
+
or the UI.
|