summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authoryangwei <[email protected]>2024-07-24 15:04:59 +0800
committeryangwei <[email protected]>2024-07-24 15:13:09 +0800
commit4a00ae6dea92e1600a5fb057d4b6d902effac478 (patch)
tree8578f0ff91d72054d9609b8400e266d725b02f53 /README.md
parent501e1517825bae220b4145e082a6358cc6f9f34d (diff)
🔧 build(cmake parameter): set build warning as error
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 10 insertions, 4 deletions
diff --git a/README.md b/README.md
index 57d70af..ff5490a 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,18 @@
# Stellar-on-sapp: c adapter for stellar
+
## Concepts
-The Stellar-on-sapp is a transition solution from Sapp to Stellar for fast DPI plugin development. The Stellar-C is built on the concepts of sessions and messages. A session is defined as a sequence of packets that share the same traffic attributes, such as TCP or UDP sessions.
-* Each session has a message queue, which facilitates the exchange of messages among plugins. The message delivery is in the session scope. In Stellar-on-sapp, plugins are decoupled through the publish-subscribe mechanism.
+
+The stellar-on-sapp is a transition solution from Sapp to Stellar for fast DPI plugin development. The Stellar-on-sapp is built on the concepts of sessions and messages. A session is defined as a sequence of packets that share the same traffic attributes, such as TCP or UDP sessions.
+
+* Each session has a message queue, which facilitates the exchange of messages among plugins. The message delivery is in the session scope. In stellar-on-sapp, plugins are decoupled through the publish-subscribe mechanism.
* EXdata (Extra Data) is attached to a session for plugin context management.
![stellar-c-high-level-design](./docs/images/stellar-arch.jpg)
## Components
-The Stellar-on-sapp consists of the following components:
+
+The stellar-on-sapp consists of the following components:
+
* Sapp adaptor converts a Sapp stream to a Stellar session, and calls Stellar plugins to process the session.
* Firewall is a Sapp plugins that interact with TCP/UDP and L7 decoders. It inherits all TSG firewall functions and publish messages to Stellar plugins.
* Stellar plugins are DPI plugins that process the session, such as AppSketch, Session Flagging, Session Recorder.
@@ -15,6 +20,7 @@ The Stellar-on-sapp consists of the following components:
* Test framework generates sessions and messages from different data source for testing Stellar plugins. Possible data sources include pcap file, Kafka message queue, and fuzzing data.
## The Lifecycle of a Session
+
All session has three states for plugin view, which are Opening, Active, Closing.
-![stellar-session-life-cycle](./docs/images/firewall-session-lifecycle.png) \ No newline at end of file
+![stellar-session-life-cycle](./docs/images/firewall-session-lifecycle.png)