Skip to content

Commit 401b853

Browse files
Ap workflows passive/active (#90)
* Image upload push/pull. * Edited image upload push pull. * Image push/pull. * Image push/pull. * Image push/pull. * Redo of Workflows under Testing and typo/layout/capitalization/proper noun fixes. * Optimised images with calibre/image-actions * Noticed a capitalization error. * Three quick changes to layout. * Passive Type Workflow documentation branch. Ready for PR review. * Optimised images with calibre/image-actions * Fixes requested in review. Just need to upload example Workflows and link them for downloading. * Optimised images with calibre/image-actions * Inclusion of Workflow JSON files. --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent cb52861 commit 401b853

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+960
-329
lines changed

.markdownlint.json

+3-1
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,7 @@
44
"first-line-heading": false,
55
"single-title": false,
66
"fenced-code-language": false,
7-
"no-duplicate-heading": false
7+
"no-duplicate-heading": false,
8+
"ol-prefix": false,
9+
"no-trailing-punctuation": false
810
}
+92
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
{
2+
"description": "The example given in the Convert Workflows documentation section.",
3+
"edition": 2,
4+
"graph": {
5+
"edges": [
6+
{
7+
"source": {
8+
"exec_alias": "exec",
9+
"node_id": 0
10+
},
11+
"target": {
12+
"exec_alias": "exec",
13+
"node_id": 2
14+
}
15+
},
16+
{
17+
"source": {
18+
"exec_alias": "exec",
19+
"node_id": 2
20+
},
21+
"target": {
22+
"exec_alias": "exec",
23+
"node_id": 1
24+
}
25+
}
26+
],
27+
"nodes": [
28+
{
29+
"alias": "convert_start",
30+
"definition_id": "caido/convert-start",
31+
"display": {
32+
"x": 0,
33+
"y": -80
34+
},
35+
"id": 0,
36+
"inputs": [],
37+
"name": "Convert Start",
38+
"version": "0.1.0"
39+
},
40+
{
41+
"alias": "convert_end",
42+
"definition_id": "caido/convert-end",
43+
"display": {
44+
"x": 0,
45+
"y": 100
46+
},
47+
"id": 1,
48+
"inputs": [
49+
{
50+
"alias": "data",
51+
"value": {
52+
"data": "$base64_d.data",
53+
"kind": "ref"
54+
}
55+
}
56+
],
57+
"name": "Convert End",
58+
"version": "0.1.0"
59+
},
60+
{
61+
"alias": "base64_d",
62+
"definition_id": "caido/base64-decode",
63+
"display": {
64+
"x": 0,
65+
"y": 10
66+
},
67+
"id": 2,
68+
"inputs": [
69+
{
70+
"alias": "format",
71+
"value": {
72+
"data": "STANDARD",
73+
"kind": "string"
74+
}
75+
},
76+
{
77+
"alias": "data",
78+
"value": {
79+
"data": "",
80+
"kind": "bytes"
81+
}
82+
}
83+
],
84+
"name": "Base64 D",
85+
"version": "0.2.0"
86+
}
87+
]
88+
},
89+
"id": "5a6cd175-23b5-4b3b-a72a-ea5964804365",
90+
"kind": "convert",
91+
"name": "Base64 Decode Example"
92+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
{
2+
"description": "The example given in the Passive Workflows documentation section. Sets color of GET requests to navy blue.",
3+
"edition": 2,
4+
"graph": {
5+
"edges": [
6+
{
7+
"source": {
8+
"exec_alias": "exec",
9+
"node_id": 3
10+
},
11+
"target": {
12+
"exec_alias": "exec",
13+
"node_id": 1
14+
}
15+
},
16+
{
17+
"source": {
18+
"exec_alias": "exec",
19+
"node_id": 2
20+
},
21+
"target": {
22+
"exec_alias": "exec",
23+
"node_id": 4
24+
}
25+
},
26+
{
27+
"source": {
28+
"exec_alias": "exec",
29+
"node_id": 0
30+
},
31+
"target": {
32+
"exec_alias": "exec",
33+
"node_id": 6
34+
}
35+
},
36+
{
37+
"source": {
38+
"exec_alias": "true",
39+
"node_id": 6
40+
},
41+
"target": {
42+
"exec_alias": "exec",
43+
"node_id": 2
44+
}
45+
},
46+
{
47+
"source": {
48+
"exec_alias": "false",
49+
"node_id": 6
50+
},
51+
"target": {
52+
"exec_alias": "exec",
53+
"node_id": 1
54+
}
55+
},
56+
{
57+
"source": {
58+
"exec_alias": "false",
59+
"node_id": 4
60+
},
61+
"target": {
62+
"exec_alias": "exec",
63+
"node_id": 1
64+
}
65+
},
66+
{
67+
"source": {
68+
"exec_alias": "true",
69+
"node_id": 4
70+
},
71+
"target": {
72+
"exec_alias": "exec",
73+
"node_id": 3
74+
}
75+
}
76+
],
77+
"nodes": [
78+
{
79+
"alias": "on_intercept_request",
80+
"definition_id": "caido/on-intercept-request",
81+
"display": {
82+
"x": 10,
83+
"y": -180
84+
},
85+
"id": 0,
86+
"inputs": [],
87+
"name": "On intercept request",
88+
"version": "0.1.0"
89+
},
90+
{
91+
"alias": "passive_end",
92+
"definition_id": "caido/passive-end",
93+
"display": {
94+
"x": 240,
95+
"y": 460
96+
},
97+
"id": 1,
98+
"inputs": [],
99+
"name": "Passive End",
100+
"version": "0.1.0"
101+
},
102+
{
103+
"alias": "matches_httpql",
104+
"definition_id": "caido/httpql-matches",
105+
"display": {
106+
"x": 10,
107+
"y": 50
108+
},
109+
"id": 2,
110+
"inputs": [
111+
{
112+
"alias": "query",
113+
"value": {
114+
"data": "req.method.eq:\"GET\"",
115+
"kind": "string"
116+
}
117+
},
118+
{
119+
"alias": "request",
120+
"value": {
121+
"data": "$on_intercept_request.request",
122+
"kind": "ref"
123+
}
124+
}
125+
],
126+
"name": "Matches HTTPQL",
127+
"version": "0.1.0"
128+
},
129+
{
130+
"alias": "set_color",
131+
"definition_id": "caido/color-set",
132+
"display": {
133+
"x": 10,
134+
"y": 300
135+
},
136+
"id": 3,
137+
"inputs": [
138+
{
139+
"alias": "request",
140+
"value": {
141+
"data": "$on_intercept_request.request",
142+
"kind": "ref"
143+
}
144+
},
145+
{
146+
"alias": "color",
147+
"value": {
148+
"data": "#185a6c",
149+
"kind": "string"
150+
}
151+
}
152+
],
153+
"name": "Set Color",
154+
"version": "0.1.0"
155+
},
156+
{
157+
"alias": "if_else",
158+
"definition_id": "caido/if-else",
159+
"display": {
160+
"x": 10,
161+
"y": 180
162+
},
163+
"id": 4,
164+
"inputs": [
165+
{
166+
"alias": "condition",
167+
"value": {
168+
"data": "$matches_httpql.matches",
169+
"kind": "ref"
170+
}
171+
}
172+
],
173+
"name": "If/Else",
174+
"version": "0.1.0"
175+
},
176+
{
177+
"alias": "in_scope",
178+
"definition_id": "caido/in-scope",
179+
"display": {
180+
"x": 10,
181+
"y": -60
182+
},
183+
"id": 6,
184+
"inputs": [
185+
{
186+
"alias": "request",
187+
"value": {
188+
"data": "$on_intercept_request.request",
189+
"kind": "ref"
190+
}
191+
}
192+
],
193+
"name": "In Scope",
194+
"version": "0.1.0"
195+
}
196+
]
197+
},
198+
"id": "10d89306-ae4c-4759-a509-beee8fad15fd",
199+
"kind": "passive",
200+
"name": "Color In-Scope GET Requests Example"
201+
}

src/SUMMARY.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[Common Errors](./common_errors.md)
77
[Report a Bug](./report_bug.md)
88

9-
# Beginner Guide
9+
# Beginner's Guide
1010

1111
- [Welcome to Caido]()
1212
- [Introduction to Caido](./beginner_guide/welcome_to_caido/onboarding.md)
@@ -64,7 +64,8 @@
6464
- [Replay](./features/testing/replay.md)
6565
- [Automate](./features/testing/automate.md)
6666
- [Assistant](./features/testing/assistant.md)
67-
- [Workflows]()
67+
- [Workflows](./features/testing/workflows.md)
68+
- [Passive](./features/testing/workflows/passive.md)
6869
- [Convert](./features/testing/workflows/convert.md)
6970
- [Logging]()
7071
- [Search](./features/logging/search.md)
218 KB
Loading

src/_images/if_else_example_wf.png

183 KB
Loading
189 KB
Loading

src/_images/in_scope_example_wf.png

203 KB
Loading
213 KB
Loading
242 KB
Loading

src/_images/md5_hash_example.png

390 KB
Loading
186 KB
Loading
202 KB
Loading
170 KB
Loading
350 KB
Loading
123 KB
Loading
227 KB
Loading
339 KB
Loading

src/_images/set_color_example_wf.png

201 KB
Loading

src/_images/workflow_editor.png

401 KB
Loading

src/_images/workflows_tab_layout.png

180 KB
Loading

src/beginner_guide/getting_help/support.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ We have documented some of the common errors you might encounter while using Cai
2424

2525
---
2626

27+
<img alt="Discord banner." src="../../_images/discord_banner.png"/>
28+
2729
With an active community and constant discussion, feel free to ask any questions!
2830

2931
Click [here](https://links.caido.io/www-discord) to join the server!
30-
31-
<img alt="Discord banner." src="../../_images/discord_banner.png"/>

src/beginner_guide/setup/config.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Basic Configuration
22

3-
_For advanced documentation on where Caido saves data, customizing the listening address/port used by Caido and importing Caido's CA certificate - can be found below:_
3+
_Advanced documentation on where Caido saves data, customizing the listening address/port used by Caido and importing Caido's CA certificate - can be found below:_
44

55
- [Data Location](../../configuration/data_location.md)
66
- [Listening Address/Port](../../configuration/listening_address.md)

0 commit comments

Comments
 (0)