summaryrefslogtreecommitdiffstats
path: root/doc/userguide/devguide/extending/app-layer/diagrams
diff options
context:
space:
mode:
Diffstat (limited to 'doc/userguide/devguide/extending/app-layer/diagrams')
-rw-r--r--doc/userguide/devguide/extending/app-layer/diagrams/DnsUnidirectionalTransactions.msc19
-rw-r--r--doc/userguide/devguide/extending/app-layer/diagrams/DnsUnidirectionalTransactions.pngbin0 -> 12620 bytes
-rw-r--r--doc/userguide/devguide/extending/app-layer/diagrams/HTTP2BidirectionalTransaction.msc20
-rw-r--r--doc/userguide/devguide/extending/app-layer/diagrams/HTTP2BidirectionalTransaction.pngbin0 -> 9344 bytes
-rw-r--r--doc/userguide/devguide/extending/app-layer/diagrams/TemplateTransaction.msc18
-rw-r--r--doc/userguide/devguide/extending/app-layer/diagrams/TemplateTransaction.pngbin0 -> 11707 bytes
-rw-r--r--doc/userguide/devguide/extending/app-layer/diagrams/TlsHandshake.msc34
-rw-r--r--doc/userguide/devguide/extending/app-layer/diagrams/TlsHandshake.pngbin0 -> 27884 bytes
8 files changed, 91 insertions, 0 deletions
diff --git a/doc/userguide/devguide/extending/app-layer/diagrams/DnsUnidirectionalTransactions.msc b/doc/userguide/devguide/extending/app-layer/diagrams/DnsUnidirectionalTransactions.msc
new file mode 100644
index 0000000..43dd653
--- /dev/null
+++ b/doc/userguide/devguide/extending/app-layer/diagrams/DnsUnidirectionalTransactions.msc
@@ -0,0 +1,19 @@
+# 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 1 Completed" ];
+ |||;
+ b =>> a [ label = "DNS Response" ];
+ --- [ label = "Transaction 2 Completed" ];
+
+ |||;
+ ||| [label="[ generated with Mscgen ]", textcolor="gray"];
+}
diff --git a/doc/userguide/devguide/extending/app-layer/diagrams/DnsUnidirectionalTransactions.png b/doc/userguide/devguide/extending/app-layer/diagrams/DnsUnidirectionalTransactions.png
new file mode 100644
index 0000000..611ae31
--- /dev/null
+++ b/doc/userguide/devguide/extending/app-layer/diagrams/DnsUnidirectionalTransactions.png
Binary files differ
diff --git a/doc/userguide/devguide/extending/app-layer/diagrams/HTTP2BidirectionalTransaction.msc b/doc/userguide/devguide/extending/app-layer/diagrams/HTTP2BidirectionalTransaction.msc
new file mode 100644
index 0000000..3c3484f
--- /dev/null
+++ b/doc/userguide/devguide/extending/app-layer/diagrams/HTTP2BidirectionalTransaction.msc
@@ -0,0 +1,20 @@
+# 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" ];
+ |||;
+ ||| [label="[ generated with Mscgen ]", textcolor="gray"];
+}
+
+# Reference: https://tools.ietf.org/html/rfc7540#section-8.1
diff --git a/doc/userguide/devguide/extending/app-layer/diagrams/HTTP2BidirectionalTransaction.png b/doc/userguide/devguide/extending/app-layer/diagrams/HTTP2BidirectionalTransaction.png
new file mode 100644
index 0000000..02de5dc
--- /dev/null
+++ b/doc/userguide/devguide/extending/app-layer/diagrams/HTTP2BidirectionalTransaction.png
Binary files differ
diff --git a/doc/userguide/devguide/extending/app-layer/diagrams/TemplateTransaction.msc b/doc/userguide/devguide/extending/app-layer/diagrams/TemplateTransaction.msc
new file mode 100644
index 0000000..3a5a308
--- /dev/null
+++ b/doc/userguide/devguide/extending/app-layer/diagrams/TemplateTransaction.msc
@@ -0,0 +1,18 @@
+# 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" ];
+
+ |||;
+ ||| [label="[ generated with Mscgen ]", textcolor="gray"];
+}
diff --git a/doc/userguide/devguide/extending/app-layer/diagrams/TemplateTransaction.png b/doc/userguide/devguide/extending/app-layer/diagrams/TemplateTransaction.png
new file mode 100644
index 0000000..89daed4
--- /dev/null
+++ b/doc/userguide/devguide/extending/app-layer/diagrams/TemplateTransaction.png
Binary files differ
diff --git a/doc/userguide/devguide/extending/app-layer/diagrams/TlsHandshake.msc b/doc/userguide/devguide/extending/app-layer/diagrams/TlsHandshake.msc
new file mode 100644
index 0000000..34a025d
--- /dev/null
+++ b/doc/userguide/devguide/extending/app-layer/diagrams/TlsHandshake.msc
@@ -0,0 +1,34 @@
+# MSC Sequence Diagram Example: TLS Handshake Transaction
+
+msc {
+ # Chart Options
+ arcgradient = "10";
+
+ # Entities
+ a [ label = "Client" ], b [ label = "Server" ];
+
+ # Message Flow
+ # TLS_STATE_IN_PROGRESS = 0,
+ a abox b [ label = "TLS_STATE_IN_PROGRESS" ];
+ a =>> b [ label = "ClientHello" ];
+ b =>> a [ label = "ServerHello" ];
+ b =>> a [ label = "ServerCertificate" ];
+ b =>> a [ label = "ServerHello Done" ];
+
+ a =>> b [ label = "ClientCertificate" ];
+ # TLS_STATE_CERT_READY = 1,
+ a abox b [ label = "TLS_STATE_CERT_READY" ];
+ a =>> b [ label = "ClientKeyExchange" ];
+
+ a =>> b [ label = "Finished" ];
+ b =>> a [ label = "Finished" ];
+ # TLS_HANDSHAKE_DONE = 2,
+ a abox b [ label = "TLS_HANDSHAKE_DONE" ];
+ ...;
+ # TLS_STATE_FINISHED = 3
+ a abox b [ label = "TLS_STATE_FINISHED" ];
+ --- [ label = "Transaction Completed" ];
+
+ |||;
+ ||| [label="[ generated with Mscgen ]", textcolor="gray"];
+}
diff --git a/doc/userguide/devguide/extending/app-layer/diagrams/TlsHandshake.png b/doc/userguide/devguide/extending/app-layer/diagrams/TlsHandshake.png
new file mode 100644
index 0000000..4be7b04
--- /dev/null
+++ b/doc/userguide/devguide/extending/app-layer/diagrams/TlsHandshake.png
Binary files differ