Skip to content

Commit 559a9e5

Browse files
committedMay 19, 2023
feat: Add forwarding proxy
1 parent 1d7a724 commit 559a9e5

4 files changed

+30
-8
lines changed
 

‎jobs/README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ Documentation around the _Job_ file structure can be found at https://docs.guard
33
Examples of _Job_ files can be found at https://github.com/guardrailsio/runtime-resources/tree/main/jobs
44

55
* advanced-BrowserApp-job-example: This _Job_ file targets the [NodeGoat](https://github.com/OWASP/NodeGoat) SUT, which we host using [purpleteam-iac-sut](https://github.com/purpleteam-labs/purpleteam-iac-sut). You can use this _Job_ file and just update the `sutHost` to point to your hosted copy of NodeGoat as well as the `username` and `password` properties
6-
* simple-BrowserApp-job-example: This _Job_ file is good for most browser applications that don't require authentication. If using this _Job_ file, you will need to provide a valid `sutHost` property value. As it is, it will inform the _Application Testing Engine_ to scan the specified host from the root. If you want to be more specific, you can add routes to be scanned
7-
* simple-BrowserApp-job-fast-example: This _Job_ file extends simple-BrowserApp-job-example by adding a single route, this will inform the _Application Testing Engine_ to only scan the specified route of the specified host. You will need to provide a valid `sutHost` property value, and a valid `route.id` property value. By using this _Job_, the [_Test Run_](https://docs.guardrails.io/docs/glossary#test-run) should be faster because it is not scanning from the root
8-
6+
* simple-BrowserApp-job-example: This _Job_ file is good for most browser applications that don't require authentication. If using this _Job_ file, you will need to provide a valid `sutHost` property value. As it is, it will inform the _Application Testing Engine_ to scan the specified host from the root. If you want to be more specific, you can add routes to be scanned.
7+
If you are using a forwarding proxy, between the engine and your SUT, configure the `forwardingProxy` object properties with valid values. If you are not using a fowarding proxy, just remove the `forwardingProxy` object
8+
* simple-BrowserApp-job-fast-example: This _Job_ file extends simple-BrowserApp-job-example by adding a single route, this will inform the _Application Testing Engine_ to only scan the specified route of the specified host. You will need to provide a valid `sutHost` property value, and a valid `route.id` property value. By using this _Job_, the [_Test Run_](https://docs.guardrails.io/docs/glossary#test-run) should be faster because it is not scanning from the root.
9+
If you are using a forwarding proxy, between the engine and your SUT, configure the `forwardingProxy` object properties with valid values. If you are not using a fowarding proxy, just remove the `forwardingProxy` object

‎jobs/advanced-BrowserApp-job-example

+8-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"data": {
33
"type": "BrowserApp",
44
"attributes": {
5-
"version": "0.0.1",
5+
"version": "0.1.0",
66
"sutAuthentication": {
77
"sitesTreeSutAuthenticationPopulationStrategy": "FormStandard",
88
"emissaryAuthenticationStrategy": "FormStandard",
@@ -16,6 +16,13 @@
1616
"sutPort": 443,
1717
"sutProtocol": "https",
1818
"browser": "chrome",
19+
"forwardingProxy": {
20+
"protocol": "[http|https]",
21+
"username": "<proxy-username>",
22+
"password": "<proxy-password>",
23+
"hostname": "<proxy-hostname>",
24+
"port": <proxy-port>
25+
}
1926
"loggedInIndicator": "<p>Found. Redirecting to <a href=\"\/dashboard\">\/dashboard<\/a><\/p>"
2027
},
2128
"relationships": {

‎jobs/simple-BrowserApp-job-example

+9-2
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,22 @@
22
"data": {
33
"type": "BrowserApp",
44
"attributes": {
5-
"version": "0.0.1",
5+
"version": "0.1.0",
66
"sutAuthentication": {
77
"sitesTreeSutAuthenticationPopulationStrategy": "NoAuthentication",
88
"emissaryAuthenticationStrategy": "NoAuthentication"
99
},
1010
"sutHost": "<targetdomain.com>",
1111
"sutPort": 443,
1212
"sutProtocol": "https",
13-
"browser": "chrome"
13+
"browser": "chrome",
14+
"forwardingProxy": {
15+
"protocol": "[http|https]",
16+
"username": "<proxy-username>",
17+
"password": "<proxy-password>",
18+
"hostname": "<proxy-hostname>",
19+
"port": <proxy-port>
20+
}
1421
},
1522
"relationships": {
1623
"data": [{

‎jobs/simple-BrowserApp-job-fast-example

+9-2
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,22 @@
22
"data": {
33
"type": "BrowserApp",
44
"attributes": {
5-
"version": "0.0.1",
5+
"version": "0.1.0",
66
"sutAuthentication": {
77
"sitesTreeSutAuthenticationPopulationStrategy": "NoAuthentication",
88
"emissaryAuthenticationStrategy": "NoAuthentication"
99
},
1010
"sutHost": "<targetdomain.com>",
1111
"sutPort": 443,
1212
"sutProtocol": "https",
13-
"browser": "chrome"
13+
"browser": "chrome",
14+
"forwardingProxy": {
15+
"protocol": "[http|https]",
16+
"username": "<proxy-username>",
17+
"password": "<proxy-password>",
18+
"hostname": "<proxy-hostname>",
19+
"port": <proxy-port>
20+
}
1421
},
1522
"relationships": {
1623
"data": [{

0 commit comments

Comments
 (0)
Failed to load comments.