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

Commit a0daed2

Browse files
rfelberrfelber
committed
Updated readme for integrated scanner
1 parent 08903ca commit a0daed2

File tree

4 files changed

+190
-1
lines changed

4 files changed

+190
-1
lines changed

‎integrations/nmap/readme.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,3 +59,6 @@ Some useful example parameters listed below:
5959
2. Update the parser function here: `./parser/parser.js`
6060
3. Update the parser tests here: `./parser/parser.test.js`
6161
4. Run the testsuite: `npm test`
62+
63+
#### Basic scanner tests
64+
If you want to test sslyze localy you can use brew (only on macOS) to install it: `brew install nmap`

‎integrations/sslyze/README.md‎

Lines changed: 107 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,117 @@ helm upgrade --install sslyze ./integrations/sslyze/
2121

2222
A set of examples can be found in the [examples](./examples) folder.
2323
* Example *secureCodeBox.io* [scan](./examples/secureCodeBox.io/scan.yaml) and [findings](./examples/secureCodeBox.io/findings.yaml)
24-
* Example *example.com* [scan](./examples/secureCodeBox.io/scan.yaml) and [findings](./examples/secureCodeBox.io/findings.yaml)
24+
* Example *example.com* [scan](./examples/example.com/scan.yaml) and [findings](./examples/example.com/findings.yaml)
2525

2626
## Configuration
2727

2828
The follwing security scan configuration example are based on the [SSLyze Documentation], please take a look at the original documentation for more configuration examples.
2929

3030
The command line interface can be used to easily run server scans: `sslyze --regular www.example.com`
3131

32+
```bash
33+
Usage: sslyze [options] target1.com target2.com:443 target3.com:443{ip} etc...
34+
35+
Options:
36+
--version show program's version number and exit
37+
-h, --help show this help message and exit
38+
--regular Regular HTTPS scan; shortcut for --sslv2 --sslv3
39+
--tlsv1 --tlsv1_1 --tlsv1_2 --tlsv1_3 --reneg --resum
40+
--certinfo --hide_rejected_ciphers --compression
41+
--heartbleed --openssl_ccs --fallback --robot
42+
43+
Trust stores options:
44+
--update_trust_stores
45+
Update the default trust stores used by SSLyze. The
46+
latest stores will be downloaded from https://github.c
47+
om/nabla-c0d3/trust_stores_observatory. This option is
48+
meant to be used separately, and will silence any
49+
other command line option supplied to SSLyze.
50+
51+
Client certificate options:
52+
--cert=CERT Client certificate chain filename. The certificates
53+
must be in PEM format and must be sorted starting with
54+
the subject's client certificate, followed by
55+
intermediate CA certificates if applicable.
56+
--key=KEY Client private key filename.
57+
--keyform=KEYFORM Client private key format. DER or PEM (default).
58+
--pass=KEYPASS Client private key passphrase.
59+
60+
Input and output options:
61+
--json_out=JSON_FILE
62+
Write the scan results as a JSON document to the file
63+
JSON_FILE. If JSON_FILE is set to "-", the JSON output
64+
will instead be printed to stdout. The resulting JSON
65+
file is a serialized version of the ScanResult objects
66+
described in SSLyze's Python API: the nodes and
67+
attributes will be the same. See https://nabla-c0d3.gi
68+
thub.io/sslyze/documentation/available-scan-
69+
commands.html for more details.
70+
--targets_in=TARGETS_IN
71+
Read the list of targets to scan from the file
72+
TARGETS_IN. It should contain one host:port per line.
73+
--quiet Do not output anything to stdout; useful when using
74+
--json_out.
75+
76+
Connectivity options:
77+
--slow_connection Greatly reduce the number of concurrent connections
78+
initiated by SSLyze. This will make the scans slower
79+
but more reliable if the connection between your host
80+
and the server is slow, or if the server cannot handle
81+
many concurrent connections. Enable this option if you
82+
are getting a lot of timeouts or errors.
83+
--https_tunnel=HTTPS_TUNNEL
84+
Tunnel all traffic to the target server(s) through an
85+
HTTP CONNECT proxy. HTTP_TUNNEL should be the proxy's
86+
URL: 'http://USER:PW@HOST:PORT/'. For proxies
87+
requiring authentication, only Basic Authentication is
88+
supported.
89+
--starttls=STARTTLS
90+
Perform a StartTLS handshake when connecting to the
91+
target server(s). StartTLS should be one of: auto,
92+
smtp, xmpp, xmpp_server, pop3, imap, ftp, ldap, rdp,
93+
postgres. The 'auto' option will cause SSLyze to
94+
deduce the protocol (ftp, imap, etc.) from the
95+
supplied port number, for each target servers.
96+
--xmpp_to=XMPP_TO Optional setting for STARTTLS XMPP. XMPP_TO should be
97+
the hostname to be put in the 'to' attribute of the
98+
XMPP stream. Default is the server's hostname.
99+
--sni=SNI Use Server Name Indication to specify the hostname to
100+
connect to. Will only affect TLS 1.0+ connections.
101+
102+
Scan commands:
103+
--tlsv1_1 Test a server for TLS 1.1 support.
104+
--tlsv1_2 Test a server for TLS 1.2 support.
105+
--robot Test a server for the ROBOT vulnerability.
106+
--reneg Test a server for for insecure TLS renegotiation and
107+
client-initiated renegotiation.
108+
--early_data Test a server for TLS 1.3 early data support.
109+
--fallback Test a server for the TLS_FALLBACK_SCSV mechanism to
110+
prevent downgrade attacks.
111+
--tlsv1_3 Test a server for TLS 1.3 support.
112+
--certinfo Retrieve and analyze a server's certificate(s) to
113+
verify its validity.
114+
--certinfo_ca_file=CERTINFO_CA_FILE
115+
Path to a file containing root certificates in PEM
116+
format that will be used to verify the validity of the
117+
server's certificate.
118+
--heartbleed Test a server for the OpenSSL Heartbleed
119+
vulnerability.
120+
--resum_rate Measure a server's session resumption rate when
121+
attempting 100 resumptions using session IDs.
122+
--resum Test a server for session resumption support using
123+
session IDs and TLS tickets.
124+
--http_headers Test a server for the presence of security-related
125+
HTTP headers.
126+
--sslv2 Test a server for SSL 2.0 support.
127+
--tlsv1 Test a server for TLS 1.0 support.
128+
--sslv3 Test a server for SSL 3.0 support.
129+
--compression Test a server for TLS compression support, which can
130+
be leveraged to perform a CRIME attack.
131+
--openssl_ccs Test a server for the OpenSSL CCS Injection
132+
vulnerability (CVE-2014-0224).
133+
```
134+
32135
## Development
33136
34137
### Local setup
@@ -43,5 +146,8 @@ The command line interface can be used to easily run server scans: `sslyze --reg
43146
3. Update the parser tests here: `./parser/parser.test.js`
44147
4. Run the testsuite: `npm test`
45148
149+
#### Basic scanner tests
150+
If you want to test sslyze localy you can use brew (only on macOS) to install it: `brew install sslyze`
151+
46152
[SSLyze GitHub]: https://github.com/nabla-c0d3/sslyze
47153
[SSLyze Documentation]: https://nabla-c0d3.github.io/sslyze/documentation/

‎integrations/zap/README.md‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
title: "ZAP"
3+
path: "scanner/Zap"
4+
category: "scanner"
5+
usecase: "Webapplication Vulnerability Scanner"
6+
---
7+
8+
![zap logo](https://raw.githubusercontent.com/wiki/zaproxy/zaproxy/images/zap32x32.png)
9+
10+
The OWASP Zed Attack Proxy (ZAP) is one of the world’s most popular free security tools and is actively maintained by hundreds of international volunteers*. It can help you automatically find security vulnerabilities in your web applications while you are developing and testing your applications. Its also a great tool for experienced pentesters to use for manual security testing.
11+
12+
To learn more about the ZAP scanner itself visit [OWASP_Zap_Project] or [zaproxy.org].
13+
14+
<!-- end -->
15+
16+
## Deployment
17+
18+
The ZAP scanType can be deployed via helm.
19+
20+
```bash
21+
helm upgrade --install zap ./integrations/zap/
22+
```
23+
24+
## Examples
25+
26+
A set of examples can be found in the [examples](./examples) folder.
27+
* Example *secureCodeBox.io* [scan](./examples/secureCodeBox.io/scan.yaml) and [findings](./examples/secureCodeBox.io/findings.yaml)
28+
* Example *example.com* [scan](./examples/example.com/scan.yaml) and [findings](./examples/example.com/findings.yaml)
29+
30+
## Configuration
31+
32+
The follwing security scan configuration example are based on the [ZAP Documentation], please take a look at the original documentation for more configuration examples.
33+
34+
The command line interface can be used to easily run server scans: `-t www.example.com`
35+
36+
```bash
37+
Usage: zap-baseline.py -t <target> [options]
38+
-t target target URL including the protocol, eg https://www.example.com
39+
Options:
40+
-h print this help message
41+
-c config_file config file to use to INFO, IGNORE or FAIL warnings
42+
-u config_url URL of config file to use to INFO, IGNORE or FAIL warnings
43+
-g gen_file generate default config file (all rules set to WARN)
44+
-m mins the number of minutes to spider for (default 1)
45+
-r report_html file to write the full ZAP HTML report
46+
-w report_md file to write the full ZAP Wiki (Markdown) report
47+
-x report_xml file to write the full ZAP XML report
48+
-J report_json file to write the full ZAP JSON document
49+
-a include the alpha passive scan rules as well
50+
-d show debug messages
51+
-P specify listen port
52+
-D delay in seconds to wait for passive scanning
53+
-i default rules not in the config file to INFO
54+
-I do not return failure on warning
55+
-j use the Ajax spider in addition to the traditional one
56+
-l level minimum level to show: PASS, IGNORE, INFO, WARN or FAIL, use with -s to hide example URLs
57+
-n context_file context file which will be loaded prior to spidering the target
58+
-p progress_file progress file which specifies issues that are being addressed
59+
-s short output format - dont show PASSes or example URLs
60+
-T max time in minutes to wait for ZAP to start and the passive scan to run
61+
-z zap_options ZAP command line options e.g. -z "-config aaa=bbb -config ccc=ddd"
62+
--hook path to python file that define your custom hooks
63+
```
64+
65+
## Development
66+
67+
### Local setup
68+
1. Clone the repository `git clone git@github.com:secureCodeBox/secureCodeBox-v2-alpha.git`
69+
2. Ensure you have node.js installed
70+
* On MacOs with brew package manager: `brew install node`
71+
72+
### Parser Development
73+
74+
1. Install the dependencies `npm install`
75+
2. Update the parser function here: `./parser/parser.js`
76+
3. Update the parser tests here: `./parser/parser.test.js`
77+
4. Run the testsuite: `npm test`
78+
79+
[SSLyze GitHub]: https://github.com/nabla-c0d3/sslyze
80+
[SSLyze Documentation]: https://nabla-c0d3.github.io/sslyze/documentation/

‎integrations/zap/examples/.gitkeep‎

Whitespace-only changes.

0 commit comments

Comments
 (0)