Skip to content
This repository was archived by the owner on Oct 14, 2020. It is now read-only.

Commit 2c91d19

Browse files
committed
Ncrack documentation enhanced
1 parent 903eb02 commit 2c91d19

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

scanners/ncrack/README.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,59 @@ To learn more about the Ncrack scanner itself visit [Ncrack GitHub] or [Ncrack W
1414

1515
<!-- end -->
1616

17+
## Ncrack Deployment & Configuration
18+
19+
#### Setup with custom files:
20+
If you want to use your own files within the ncrack scan, you have to create a secret first:
21+
22+
```bash
23+
kubectl create secret generic --from-file users.txt --from-file passwords.txt ncrack-lists
24+
```
25+
26+
<b> IMPORTANT: Use an extra empty line at the end of your files, otherwise the last letter of the last line will be omitted (due to a bug in k8) </b>
27+
28+
29+
Now we created a secret named "ncrack-lists".
30+
But before we can use the files, we have to install the ncrack ScanType:
31+
32+
```bash
33+
cat <<EOF | helm install ncrack ./scanners/ncrack --values -
34+
scannerJob:
35+
extraVolumes:
36+
- name: ncrack-lists
37+
secret:
38+
secretName: ncrack-lists
39+
extraVolumeMounts:
40+
- name: ncrack-lists
41+
mountPath: "/ncrack/"
42+
EOF
43+
```
44+
45+
This enables us now to refer to our files via "/ncrack/<file>" in the scan.yaml.
46+
47+
For a full example on how to configure ncrack with your custom files against a ssh service, see the "dummy-ssh" example.
48+
49+
#### Basic setup (no files can be mounted):
50+
51+
The Ncrack ScanType can be deployed via helm:
52+
53+
```bash
54+
helm upgrade --install ncrack ./scanners/ncrack/
55+
```
56+
57+
#### Delete Ncrack ScanType:
58+
59+
```bash
60+
helm delete ncrack
61+
```
62+
63+
#### Options
64+
65+
All additional options for ncrack can be found on [Ncrack Documentation].
66+
67+
---
68+
69+
1770
> 🔧 The implementation is currently work-in-progress and still undergoing major changes. It'll be released here once it has stabilized.
1871
1972
[Ncrack Website]: https://nmap.org/ncrack/

0 commit comments

Comments
 (0)