Skip to content

Commit e687817

Browse files
committedJun 13, 2023
feat: Base64 encode authentication values
1 parent 559a9e5 commit e687817

4 files changed

+20
-18
lines changed
 

‎jobs/README.md

+10-5
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,13 @@ Documentation around the _Job_ file structure can be found at https://docs.guard
22

33
Examples of _Job_ files can be found at https://github.com/guardrailsio/runtime-resources/tree/main/jobs
44

5-
* 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-
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
5+
* 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 `passwordBase64` properties
6+
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-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.
9+
10+
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
11+
* 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.
12+
13+
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
14+

‎jobs/advanced-BrowserApp-job-example

+6-7
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"data": {
33
"type": "BrowserApp",
44
"attributes": {
5-
"version": "0.1.0",
5+
"version": "1.0.0",
66
"sutAuthentication": {
77
"sitesTreeSutAuthenticationPopulationStrategy": "FormStandard",
88
"emissaryAuthenticationStrategy": "FormStandard",
@@ -18,8 +18,7 @@
1818
"browser": "chrome",
1919
"forwardingProxy": {
2020
"protocol": "[http|https]",
21-
"username": "<proxy-username>",
22-
"password": "<proxy-password>",
21+
"authorizationBase64": "<base64-encoded-username:password>",
2322
"hostname": "<proxy-hostname>",
2423
"port": <proxy-port>
2524
}
@@ -59,8 +58,8 @@
5958
"scanningStrategy": "BrowserAppStandard",
6059
"postScanningStrategy": "BrowserAppStandard",
6160
"reportingStrategy": "Standard",
62-
"username": "[your-user]",
63-
"password": "[your-password]",
61+
"username": "<your-user>",
62+
"passwordBase64": "<your-base64-encoded-password>",
6463
"aScannerAttackStrength": "HIGH",
6564
"aScannerAlertThreshold": "LOW",
6665
"alertThreshold": 12
@@ -82,8 +81,8 @@
8281
"scanningStrategy": "BrowserAppStandard",
8382
"postScanningStrategy": "BrowserAppStandard",
8483
"reportingStrategy": "Standard",
85-
"username": "[admin-user]",
86-
"password": "[admin-password]"
84+
"username": "<admin-user>",
85+
"passwordBase64": "<base64-encoded-admin-password>"
8786
},
8887
"relationships": {
8988
"data": [{

‎jobs/simple-BrowserApp-job-example

+2-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"data": {
33
"type": "BrowserApp",
44
"attributes": {
5-
"version": "0.1.0",
5+
"version": "1.0.0",
66
"sutAuthentication": {
77
"sitesTreeSutAuthenticationPopulationStrategy": "NoAuthentication",
88
"emissaryAuthenticationStrategy": "NoAuthentication"
@@ -13,8 +13,7 @@
1313
"browser": "chrome",
1414
"forwardingProxy": {
1515
"protocol": "[http|https]",
16-
"username": "<proxy-username>",
17-
"password": "<proxy-password>",
16+
"authorizationBase64": "<base64-encoded-username:password>",
1817
"hostname": "<proxy-hostname>",
1918
"port": <proxy-port>
2019
}

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

+2-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"data": {
33
"type": "BrowserApp",
44
"attributes": {
5-
"version": "0.1.0",
5+
"version": "1.0.0",
66
"sutAuthentication": {
77
"sitesTreeSutAuthenticationPopulationStrategy": "NoAuthentication",
88
"emissaryAuthenticationStrategy": "NoAuthentication"
@@ -13,8 +13,7 @@
1313
"browser": "chrome",
1414
"forwardingProxy": {
1515
"protocol": "[http|https]",
16-
"username": "<proxy-username>",
17-
"password": "<proxy-password>",
16+
"authorizationBase64": "<base64-encoded-username-password>",
1817
"hostname": "<proxy-hostname>",
1918
"port": <proxy-port>
2019
}

0 commit comments

Comments
 (0)
Failed to load comments.