Skip to content

Commit

Permalink
Update documents
Browse files Browse the repository at this point in the history
  • Loading branch information
hahwul committed Jan 20, 2022
1 parent 4a535c7 commit aa719cd
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,10 @@ URLs and Roles are managed as YAML-based templates, which can be automatically c
* Generate scan template `$ authz0 new`
* Include URLs
* Include Roles
* Easy modify scan template (Role, URL) `$ authz0 setUrl` `$ authz0 setRole`
* Include ZAP history (Select URLS > Save Selected Entiries as HAR)
* Include Burp history (Select URLs > Save item)
* Imclude HAR file
* Easy modify scan template (Role, URL) `$ authz0 setUrl` `$ authz0 setRole` `authz0 setCred`
* Scanning authorization(access-control) with template `$ authz0 scan`

## 🚀 Installation
Expand All @@ -44,6 +47,7 @@ Need more information? please refer to [installation guide](https://authz0.hahwu
help Help about any command
new Generate new template
scan Scanning
setCred Append Credential to Template
setRole Append Role to Template
setUrl Append URL to Template
version Show version
Expand All @@ -53,6 +57,7 @@ Need more information? please refer to [installation guide](https://authz0.hahwu
```
authz0 new <filename> [flags]
```

2) Scanning
```
authz0 scan <filename> [flags]
Expand Down
7 changes: 7 additions & 0 deletions docs/structure/template.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,11 @@ urls:
asserts: # assertions
- type: success-status
value: "200,201,202,204"
credentials:
- rolename: User
headers:
- 'X-API-Key: 1234'
- rolename: Admin1
headers:
- 'X-API-Key: 5555'
```
21 changes: 21 additions & 0 deletions docs/usage/setCred.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: setCred command
layout: default
parent: Usage
nav_order: 5
---

```
Usage:
authz0 setCred <filename> [flags]
Flags:
-H, --headers strings Headers
-h, --help help for setCred
-n, --name string Role name
```

```
authz0 setCred samples/sample.yaml -n "User" -H "X-API-Key: 1234"
authz0 setCred samples/sample.yaml -n "Admin1" -H "X-API-Key: 5555" -H "X-Test-1234: bbbb"
```

0 comments on commit aa719cd

Please sign in to comment.