-
Notifications
You must be signed in to change notification settings - Fork 1.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
devguide/transactions: fix image filename #6245
Changes from all commits
f00229e
9676d10
ea95909
00b3b27
d82697b
d450d8a
b100dff
85a6478
676b0cc
abb5c85
8a971fa
32d34aa
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -1014,6 +1014,7 @@ jobs: | |
libjansson-dev \ | ||
libpython2.7 \ | ||
make \ | ||
mscgen \ | ||
parallel \ | ||
python3-yaml \ | ||
rustc \ | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,2 @@ | ||
_build | ||
extending/app-layer/img/*.png |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# MSC Sequence Diagram Example: DNS Query Transaction | ||
|
||
msc { | ||
# Chart Options | ||
arcgradient = "10"; | ||
|
||
# Entities | ||
a [ label = "Client" ], b [ label = "Server" ]; | ||
|
||
# Message Flow | ||
a =>> b [ label = "DNS Request" ]; | ||
--- [ label = "Transaction Completed" ]; | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# MSC Sequence Diagram for an HTTP2 Transaction, which is bidirectional in Suricata | ||
|
||
msc { | ||
|
||
# Chart options | ||
arcgradient = "10"; | ||
|
||
# Entities | ||
a [ label = "Client" ], b [ label = "Server" ]; | ||
|
||
# Message flow | ||
a =>> b [ label = "Request" ]; | ||
b =>> a [ label = "Response" ]; | ||
|||; | ||
--- [ label = "Transaction Completed" ]; | ||
} | ||
|
||
# Reference: https://tools.ietf.org/html/rfc7540#section-8.1 |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# MSC Sequence Diagram Example: Template transaction | ||
|
||
msc { | ||
# Chart Options | ||
arcgradient = "10"; | ||
|
||
# Entities | ||
a [ label = "Client" ], b [ label = "Server" ]; | ||
|
||
# Message Flow | ||
a =>> b [ label = "Request ('12:HelloWorld!')" ]; | ||
b =>> a [ label = "Response ('3:Bye')" ]; | ||
|||; | ||
--- [ label = "Transaction Completed" ]; | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# MSC Sequence Diagram Example: TLS Handshake Transaction | ||
|
||
msc { | ||
# Chart Options | ||
arcgradient = "10"; | ||
|
||
# Entities | ||
a [ label = "Client" ], b [ label = "Server"]; | ||
|
||
# Message Flow | ||
a =>> b [ label = "ClientHello"]; | ||
b =>> a [ label = "ServerHello"]; | ||
b =>> a [ label = "ServerCertificate"]; | ||
b =>> a [ label = "ServerHello Done"]; | ||
a =>> b [ label = "ClientCertificate"]; | ||
a =>> b [ label = "ClientKeyExchange"]; | ||
a =>> b [ label = "Finished" ]; | ||
b =>> a [ label = "Finished" ]; | ||
|
||
--- [ label = "Transaction Completed" ]; | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
#!/usr/bin/env bash | ||
# | ||
# Script to generate Sequence Diagram images with mscgen | ||
# | ||
|
||
cd extending/app-layer/img | ||
|
||
for FILE in *.msc ; do | ||
# call mscgen and convert each file in images dir | ||
mscgen -T png -F Arial $FILE | ||
# if command fails, lets inform about that | ||
if [ $? -ne 0 ]; then | ||
echo "$FILE couldn't be converted in the devguide" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should we not exit there ? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm not sure about that, what if that was just with a specific file, because of bad naming, for instance? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This looks like not supposed to happen, so let's stop the work so that the user notices ;-) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. That makes way more sense 😅 sorry for sounding stubborn sometimes. Patched. |
||
fi | ||
done | ||
|
||
exit 0 |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,3 +5,4 @@ App-Layer | |
:maxdepth: 2 | ||
|
||
parser.rst | ||
transactions.rst |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I do not know if this should be part of this PR, but
disable-docs
would be a nice configure option