Skip to content

Commit 68a3acb

Browse files
committed
more readme and sample config optimizations
1 parent 15f04cc commit 68a3acb

File tree

6 files changed

+11
-19
lines changed

6 files changed

+11
-19
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ docker run --tty --rm --network host --volume $(pwd):/hawk \
9191
stackhawk/hawkscan stackhawk.d/stackhawk.yml
9292
```
9393

94-
Scan using web form authentication with a session cookie. [See the docs](https://docs.stackhawk.com/hawkscan/configuration/authenticated-scanning.html#example-usernamepassword-authentication--cookie-authorization) for more information.
94+
Scan using web form authentication with a session cookie. [See the docs](https://docs.stackhawk.com/hawkscan/authenticated-scanning/form-based-authentication.html#example-form-with-http-parameters-with-cookie-authorization) for more information.
9595
```shell
9696
# With the CLI
9797
hawk scan stackhawk.d/stackhawk.yml stackhawk.d/stackhawk-auth-form-cookie.yml
@@ -103,7 +103,7 @@ docker run --tty --rm --network host --volume $(pwd):/hawk \
103103
stackhawk/hawkscan stackhawk.d/stackhawk.yml stackhawk.d/stackhawk-auth-form-cookie.yml
104104
```
105105

106-
Scan using an authorization token retrieved by POSTing credentials to an API endpoint. [See the docs](https://docs.stackhawk.com/hawkscan/configuration/authenticated-scanning.html#usernamepassword-authentication--bearer-token-authorization) for more information.
106+
Scan using an authorization token retrieved by POSTing credentials to an API endpoint. [See the docs](https://docs.stackhawk.com/hawkscan/authenticated-scanning/form-based-authentication.html#example-form-with-api-call--json-payload-with-token-authorization) for more information.
107107
```shell
108108
# With the CLI
109109
hawk scan stackhawk.d/stackhawk.yml stackhawk.d/stackhawk-auth-json-token.yml
@@ -115,7 +115,7 @@ docker run --tty --rm --network host --volume $(pwd):/hawk \
115115
stackhawk/hawkscan stackhawk.d/stackhawk.yml stackhawk.d/stackhawk-auth-json-token.yml
116116
```
117117

118-
Scan using an authorization token extracted by an external script. This method can be useful for third-party authentication systems. [See the docs](https://docs.stackhawk.com/hawkscan/configuration/authenticated-scanning.html#example-external-token-authentication--custom-token-authorization) for more information.
118+
Scan using an authorization token extracted by an external script. This method can be useful for third-party authentication systems. [See the docs](https://docs.stackhawk.com/hawkscan/authenticated-scanning/inject-cookies-and-tokens.html#injecting-a-token) for more information.
119119
```shell
120120
# With the CLI
121121
hawk scan stackhawk.d/stackhawk.yml stackhawk.d/stackhawk-auth-external-token.yml
@@ -127,7 +127,7 @@ docker run --tty --rm --network host --volume $(pwd):/hawk \
127127
stackhawk/hawkscan stackhawk.d/stackhawk.yml stackhawk.d/stackhawk-auth-external-token.yml
128128
```
129129

130-
Scan using basic authentication, using an external script to derive the correct authorization token. This legacy method is an insecure form of bearer token authentication. [See the docs](https://docs.stackhawk.com/hawkscan/configuration/authenticated-scanning.html#example-external-token-authentication--custom-token-authorization) for more information.
130+
Scan using basic authentication, using an external script to derive the correct authorization token. This legacy method is an insecure form of bearer token authentication. [See the docs](https://docs.stackhawk.com/hawkscan/authenticated-scanning/inject-cookies-and-tokens.html#injecting-a-token) for more information.
131131
```shell
132132
# With the CLI
133133
export AUTH_TOKEN=$(./scripts/basic-auth.sh)

stackhawk.d/stackhawk-auth-basic.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,3 @@ app:
1212
path: /api/basic/items/search/1
1313
success: ".*200.*"
1414
requestMethod: GET
15-
loggedInIndicator: "Sign Out"
16-
loggedOutIndicator: "wubba lubba dub dub"

stackhawk.d/stackhawk-auth-external-jwt.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,6 @@ app:
1313
testPath:
1414
path: /api/jwt/items/search/
1515
success: ".*200.*"
16-
loggedInIndicator: "Sign Out"
17-
loggedOutIndicator: "wubba lubba dub dub"
1816

1917
hawk:
2018
spider:

stackhawk.d/stackhawk-auth-external-token.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ app:
1212
testPath:
1313
path: /api/token/items/search/1
1414
success: ".*200.*"
15-
loggedInIndicator: "Sign Out"
16-
loggedOutIndicator: "wubba lubba dub dub"
1715

1816
hawk:
1917
spider:

stackhawk.d/stackhawk-auth-form-cookie.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,5 @@ app:
1818
testPath:
1919
path: /search
2020
success: ".*200.*"
21-
loggedInIndicator: "Sign Out"
22-
loggedOutIndicator: "wubba lubba dub dub"
21+
loggedInIndicator: "\\QSign Out\\E"
22+
loggedOutIndicator: ".*Location:.*/login.*"

stackhawk.d/stackhawk-auth-json-token.yml

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
app:
22
env: ${APP_ENV:JSON Token}
3+
excludePaths:
4+
- "/logout"
35
openApiConf:
46
path: /openapi
57
authentication:
@@ -18,11 +20,7 @@ app:
1820
value: Authorization
1921
tokenType: Bearer
2022
testPath:
21-
path: /api/jwt/items/search/
23+
path: /api/jwt/items/search/i
2224
success: ".*200.*"
23-
loggedInIndicator: "Sign Out"
24-
loggedOutIndicator: "wubba lubba dub dub"
25-
26-
hawk:
27-
spider:
28-
base: false
25+
loggedInIndicator: "\\QSign Out\\E"
26+
loggedOutIndicator: ".*Location:.*/login.*"

0 commit comments

Comments
 (0)