Skip to content

Commit becc7c4

Browse files
committed
Updating Helm Docs
1 parent 58679ad commit becc7c4

1 file changed

Lines changed: 5 additions & 6 deletions

File tree

‎scanners/nmap/README.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,17 @@ helm upgrade --install nmap secureCodeBox/nmap
2525

2626
## Scanner Configuration
2727

28-
The nmap scan target is set via the targets location of the securityTest. The target should be a Hostname or an IP Address.
28+
The Nmap scan targets are specified as the last parameter. The target should be a hostname, an IP address or an IP range. See [Nmap Docs](https://nmap.org/book/man-target-specification.html) for details.
2929

30-
Additional nmap scan features can be configured via the parameter attribute. For a detailed explanation to which parameters are available refer to the [Nmap Reference Guide](https://nmap.org/book/man.html). All parameters are supported, but be careful with parameters that require root level rights, as these require additional configuration on the ScanType to be supported.
30+
Additional Nmap scan features can be configured via the parameter attribute. For a detailed explanation to which parameters are available refer to the [Nmap Reference Guide](https://nmap.org/book/man.html). All parameters are supported, but be careful with parameters that require root level rights, as these require additional configuration on the ScanType to be supported.
3131

3232
Some useful example parameters listed below:
3333

34-
- `-p` xx: Scan ports of the target. Replace xx with a single port number or
35-
a range of ports.
34+
- `-p` xx: Scan ports of the target. Replace xx with a single port number or a range of ports.
3635
- `-PS`, `-PA`, `-PU` xx: Replace xx with the ports to scan. TCP SYN/ACK or
3736
UDP discovery.
3837
- `-sV`: Determine service and version info.
39-
- `-O`: Determine OS info. **Note:** This requires the the user to be run as root or the system capabilities to be extended to allow nmap to send raw sockets. See more information on [how to deploy the secureCodeBox nmap container to allow this](https://github.com/secureCodeBox/scanner-infrastructure-nmap/pull/20) and the [nmap docs about privileged scans](https://secwiki.org/w/Running_nmap_as_an_unprivileged_user)
38+
- `-O`: Determine OS info. **Note:** This requires that Nmap is run as root, or that the user has the system capabilities to be extended to allow Nmap to send raw sockets. See more information on [how to deploy the secureCodeBox nmap container to allow this](https://github.com/secureCodeBox/scanner-infrastructure-nmap/pull/20) and the [nmap docs about privileged scans](https://secwiki.org/w/Running_nmap_as_an_unprivileged_user)
4039
- `-A`: Determine service/version and OS info.
4140
- `-script` xx: Replace xx with the script name. Start the scan with the given script.
4241
- `--script` xx: Replace xx with a coma-separated list of scripts. Start the scan with the given scripts.
@@ -68,7 +67,7 @@ scannerJob:
6867
EOF
6968
```
7069

71-
You the start scans with operating system identification enabled:
70+
Then, you can start scans with operating system identification enabled:
7271

7372
```yaml
7473
apiVersion: "execution.securecodebox.io/v1"

0 commit comments

Comments
 (0)