Skip to content

Commit dc80ef2

Browse files
committed
Updated the readme.
1 parent ca6ef0d commit dc80ef2

12 files changed

Lines changed: 653 additions & 342 deletions

File tree

‎hooks/declarative-subsequent-scans/hook.test.js‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ beforeEach(() => {
5252
];
5353
});
5454

55-
test("should create subsequent scans for open HTTPS ports (NMAP findings)", () => {
55+
test("Should create subsequent scans for open HTTPS ports (NMAP findings)", () => {
5656
const findings = [
5757
{
5858
name: "Port 443 is open",
@@ -110,7 +110,7 @@ test("Should create no subsequent scans if there are no rules", () => {
110110
expect(cascadedScans).toMatchInlineSnapshot(`Array []`);
111111
});
112112

113-
test("should not try to do magic to the scan name if its something random", () => {
113+
test("Should not try to do magic to the scan name if its something random", () => {
114114
parentScan.metadata.name = "foobar.com";
115115

116116
const findings = [
@@ -150,7 +150,7 @@ test("should not try to do magic to the scan name if its something random", () =
150150
`);
151151
});
152152

153-
test("should not start scan when the cascadingrule for it is already in the chain", () => {
153+
test("Should not start a new scan when the corresponding cascadingRule is already in the chain", () => {
154154
parentScan.metadata.annotations["cascading.securecodebox.io/chain"] =
155155
sslyzeCascadingRules[0].metadata.name;
156156

@@ -176,7 +176,7 @@ test("should not start scan when the cascadingrule for it is already in the chai
176176
expect(cascadedScans).toMatchInlineSnapshot(`Array []`);
177177
});
178178

179-
test("should not crash when the annotations are not set", () => {
179+
test("Should not crash when the annotations are not set", () => {
180180
parentScan.metadata.annotations = undefined;
181181

182182
const findings = [
@@ -215,7 +215,7 @@ test("should not crash when the annotations are not set", () => {
215215
`);
216216
});
217217

218-
test("should add env fields from cascading rule to created scan", () => {
218+
test("Should copy ENV fields from cascadingRule to created scan", () => {
219219
sslyzeCascadingRules[0].spec.scanSpec.env = [
220220
{
221221
name: "FOOBAR",
@@ -269,7 +269,7 @@ test("should add env fields from cascading rule to created scan", () => {
269269
`);
270270
});
271271

272-
test("should allow wildcards in cascading rules", () => {
272+
test("Should allow wildcards in cascadingRules", () => {
273273
sslyzeCascadingRules = [
274274
{
275275
apiVersion: "cascading.securecodebox.io/v1",

‎scanners/zap-advanced/README.md‎

Lines changed: 309 additions & 28 deletions
Large diffs are not rendered by default.

‎scanners/zap-advanced/README.md.gotmpl‎

Lines changed: 309 additions & 28 deletions
Large diffs are not rendered by default.

‎scanners/zap-advanced/examples/demo-juiceshop-scan/zap-advanced-full-scan.yaml‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,7 @@ data:
5252
# scriptBasedSessionManagement configuration details
5353
scriptBasedSessionManagement:
5454
scriptName: "juiceshop-session-management.js"
55-
# Script engine values: 'Oracle Nashorn' for Javascript
56-
# 'jython' for python, 'JSR 223 JRuby Engine' for ruby
55+
# Script engine values: 'Graal.js', 'Oracle Nashorn' for Javascript and 'Mozilla Zest' for Zest Scripts
5756
scriptEngine: "Oracle Nashorn"
5857
# Must be a full path to the script file inside the ZAP container (corresponding to the configMap FileMount)
5958
scriptFilePath: "/home/zap/.ZAP_D/scripts/scripts/session/juiceshop-session-management.js"

‎scanners/zap-advanced/examples/integration-tests/scantype-configMap.yaml‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,9 +99,8 @@ data:
9999
# scriptBasedSessionManagement configuration details
100100
scriptBasedSessionManagement:
101101
scriptName: "juiceshop-session-management.js"
102-
# Script engine values: 'Oracle Nashorn' for Javascript
103-
# 'jython' for python, 'JSR 223 JRuby Engine' for ruby
104-
scriptEngine: "Oracle Nashorn"
102+
# Script engine values: 'Graal.js', 'Oracle Nashorn' for Javascript and 'Mozilla Zest' for Zest Scripts
103+
scriptEngine: "Oracle Nashorn"
105104
# Must be a full path to the script file inside the ZAP container (corresponding to the configMap FileMount)
106105
scriptFilePath: "/home/zap/.ZAP_D/scripts/scripts/session/juiceshop-session-management.js"
107106
scriptDescription: "This is a JuiceShop specific SessionManagement Script used to handle JWT."

‎scanners/zap-advanced/scanner/tests/mocks/context-with-overlay-secrets/1_zap-advanced-scan-type-config.yaml‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,7 @@ contexts:
3434
# script-based
3535
script-based:
3636
scriptName: "scb-oidc-password-grand-type.js"
37-
# Script engine values: 'Oracle Nashorn' for Javascript
38-
# 'jython' for python, 'JSR 223 JRuby Engine' for ruby
37+
# Script engine values: 'Graal.js', 'Oracle Nashorn' for Javascript and 'Mozilla Zest' for Zest Scripts
3938
scriptEngine: "Oracle Nashorn"
4039
# Must be a full path to the script file inside the ZAP container (corresponding to the configMap FileMount)
4140
scriptFilePath: "/home/zap/.ZAP_D/scripts/scripts/authentication/scb-oidc-password-grand-type.js"
@@ -63,8 +62,7 @@ contexts:
6362
# basic-auth requires no further configuration
6463
scriptBasedSessionManagement:
6564
scriptName: "juiceshop-session-management.js"
66-
# Script engine values: 'Oracle Nashorn' for Javascript
67-
# 'jython' for python, 'JSR 223 JRuby Engine' for ruby
65+
# Script engine values: 'Graal.js', 'Oracle Nashorn' for Javascript and 'Mozilla Zest' for Zest Scripts
6866
scriptEngine: "Oracle Nashorn"
6967
# Must be a full path to the script file inside the ZAP container (corresponding to the configMap FileMount)
7068
scriptFilePath: "/home/zap/.ZAP_D/scripts/scripts/session/juiceshop-session-management.js"

‎scanners/zap-advanced/scanner/tests/mocks/context-with-overlay/2_zap-advanced-scan-config.yaml‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,7 @@ contexts:
3636
# script-based
3737
script-based:
3838
scriptName: "scb-oidc-password-grand-type.js"
39-
# Script engine values: 'Oracle Nashorn' for Javascript
40-
# 'jython' for python, 'JSR 223 JRuby Engine' for ruby
39+
# Script engine values: 'Graal.js', 'Oracle Nashorn' for Javascript and 'Mozilla Zest' for Zest Scripts
4140
scriptEngine: "Oracle Nashorn"
4241
# Must be a full path to the script file inside the ZAP container (corresponding to the configMap FileMount)
4342
scriptFilePath: "/home/zap/.ZAP_D/scripts/scripts/authentication/scb-oidc-password-grand-type.js"
@@ -65,8 +64,7 @@ contexts:
6564
# basic-auth requires no further configuration
6665
scriptBasedSessionManagement:
6766
scriptName: "juiceshop-session-management.js"
68-
# Script engine values: 'Oracle Nashorn' for Javascript
69-
# 'jython' for python, 'JSR 223 JRuby Engine' for ruby
67+
# Script engine values: 'Graal.js', 'Oracle Nashorn' for Javascript and 'Mozilla Zest' for Zest Scripts
7068
scriptEngine: "Oracle Nashorn"
7169
# Must be a full path to the script file inside the ZAP container (corresponding to the configMap FileMount)
7270
scriptFilePath: "/home/zap/.ZAP_D/scripts/scripts/session/juiceshop-session-management.js"

‎scanners/zap-advanced/scanner/tests/mocks/scan-full-juiceshop-docker/1_zap-advanced-scan-config.yaml‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,7 @@ contexts:
5050
# scriptBasedSessionManagement configuration details
5151
scriptBasedSessionManagement:
5252
scriptName: juiceshop-session-management.js
53-
# Script engine values: 'Graal.js', 'Oracle Nashorn' for Javascript
54-
# 'Mozilla Zest' for Zest Scripts
53+
# Script engine values: 'Graal.js', 'Oracle Nashorn' for Javascript and 'Mozilla Zest' for Zest Scripts
5554
scriptEngine: "Oracle Nashorn"
5655
# Must be a full path to the script file inside the ZAP container (corresponding to the configMap FileMount)
5756
scriptFilePath: "/home/zap/.ZAP_D/scripts/scripts/session/juiceshop-session-management.js"

‎scanners/zap-advanced/scanner/tests/mocks/scan-full-juiceshop-local/1_zap-advanced-scan-config.yaml‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,7 @@ contexts:
5454
# scriptBasedSessionManagement configuration details
5555
scriptBasedSessionManagement:
5656
scriptName: juiceshop-session-management.js
57-
# Script engine values: 'Oracle Nashorn' for Javascript
58-
# 'jython' for python, 'JSR 223 JRuby Engine' for ruby
57+
# Script engine values: 'Graal.js', 'Oracle Nashorn' for Javascript and 'Mozilla Zest' for Zest Scripts
5958
scriptEngine: "Oracle Nashorn"
6059
# Must be a full path to the script file inside the ZAP container (corresponding to the configMap FileMount)
6160
scriptFilePath: "/home/zap/.ZAP_D/scripts/scripts/session/juiceshop-session-management.js"

‎scanners/zap-advanced/scanner/zapclient/__main__.py‎

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ def process(args):
7373

7474
def get_parser_args(args=None):
7575
parser = argparse.ArgumentParser(prog='zap-client',
76-
description='OWASP ZAP Scan (extended with advanced authentication fatures')
76+
description='OWASP secureCodeBox OWASP ZAP Client (can be used to automate OWASP ZAP instances based on YAML configuration files.)')
7777
parser.add_argument("-z",
7878
"--zap-url",
7979
help='The ZAP API Url used to call the ZAP API',
@@ -104,12 +104,6 @@ def get_parser_args(args=None):
104104
help='The OWASP ZAP Report Type u.',
105105
choices=['XML', 'JSON', 'HTML', 'MD'],
106106
default=None,
107-
required=False),
108-
parser.add_argument("-s",
109-
"--scan",
110-
help='The scan config is optionaly used to configure what type of scan ZAP is forced to. Normaly this shold be configured with the config YAML.',
111-
choices=['baseline', 'full', 'openApi', 'graphQl'],
112-
default='baseline',
113107
required=False)
114108
return parser.parse_args(args)
115109

0 commit comments

Comments
 (0)