Skip to content

Improve ncrack documentation #1836

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
J12934 merged 5 commits into from
Jul 26, 2023
Merged

Improve ncrack documentation #1836

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5607dde
Replace helm install with upgrade --install to prevent error if alrea…
Jul 26, 2023
79a6773
Replaced deprecated openssl rsautl subcommand
Jul 26, 2023
1d9ea97
Replace chart source to not require source files for applying scan
Jul 26, 2023
41bbba5
Add findings.json to dummy-ssh example
Jul 26, 2023
4ad7a91
Adjust ArtifactHub doc to helm doc template
Jul 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions scanners/ncrack/.helm-docs.gotmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,13 +134,13 @@ Now you only need to set the value *encryptPasswords.existingSecret* to the
secrets name when installing the scanner

```bash
helm install ncrack secureCodeBox/ncrack --set="encryptPasswords.existingSecret=<ncrack-secret-name>"
helm upgrade --install ncrack secureCodeBox/ncrack --set="encryptPasswords.existingSecret=<ncrack-secret-name>"
```

To decrypt a password from a finding use:

```bash
base64 encryptedPassword -d | openssl rsautl -decrypt -inkey key.pem -out decryptedPassword.txt
base64 encryptedPassword -d | openssl pkeyutl -decrypt -inkey key.pem -out decryptedPassword.txt
```

#### Setup with custom files:
Expand All @@ -156,7 +156,7 @@ Now we created a secret named "ncrack-lists".
Before we can use the files, we have to install the Ncrack ScanType:

```bash
cat <<EOF | helm install ncrack ./scanners/ncrack --values -
cat <<EOF | helm upgrade --install ncrack secureCodeBox/ncrack --values -
scanner:
extraVolumes:
- name: ncrack-lists
Expand Down
6 changes: 3 additions & 3 deletions scanners/ncrack/docs/README.ArtifactHub.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,13 +159,13 @@ Now you only need to set the value *encryptPasswords.existingSecret* to the
secrets name when installing the scanner

```bash
helm install ncrack secureCodeBox/ncrack --set="encryptPasswords.existingSecret=<ncrack-secret-name>"
helm upgrade --install ncrack secureCodeBox/ncrack --set="encryptPasswords.existingSecret=<ncrack-secret-name>"
```

To decrypt a password from a finding use:

```bash
base64 encryptedPassword -d | openssl rsautl -decrypt -inkey key.pem -out decryptedPassword.txt
base64 encryptedPassword -d | openssl pkeyutl -decrypt -inkey key.pem -out decryptedPassword.txt
```

#### Setup with custom files:
Expand All @@ -181,7 +181,7 @@ Now we created a secret named "ncrack-lists".
Before we can use the files, we have to install the Ncrack ScanType:

```bash
cat <<EOF | helm install ncrack ./scanners/ncrack --values -
cat <<EOF | helm upgrade --install ncrack secureCodeBox/ncrack --values -
scanner:
extraVolumes:
- name: ncrack-lists
Expand Down
19 changes: 19 additions & 0 deletions scanners/ncrack/examples/dummy-ssh/findings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
[{
"name": "Credentials for Service ssh://10.96.117.136:22 discovered via bruteforce.",
"description": "",
"category": "Discovered Credentials",
"location": "ssh://10.96.117.136:22",
"osi_layer": "APPLICATION",
"severity": "HIGH",
"mitigation": "Use a more secure password or disable the service at ssh://10.96.117.136:22",
"attributes": {
"port": "22",
"ip_addresses": ["10.96.117.136"],
"protocol": "tcp",
"service": "ssh",
"username": "root",
"password": "THEPASSWORDYOUCREATED"
},
"id": "5ac02686-a5a6-4bbd-921f-f0dd05a2915f",
"parsed_at": "2023-07-26T10:03:00.858Z"
}]