From 97117d4e509f9eba7a71886038b482997ea12bc2 Mon Sep 17 00:00:00 2001 From: Soner Tari Date: Mon, 4 Oct 2021 02:18:44 +0300 Subject: [PATCH] Fix and update documentation We use B-tree not BST --- README.md | 11 ++++++----- src/sslproxy.1 | 11 ++++++----- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 3ac24f9..c70292a 100644 --- a/README.md +++ b/README.md @@ -81,7 +81,7 @@ the SSLproxy line in the first packet in the connection. The response from the Server follows the same path back to the Client in reverse order. -See the SSLsplit documentation for split style proxyspecs. +See the SSLsplit documentation for split style and structured proxyspecs. #### SSLproxy line @@ -407,10 +407,11 @@ The macro name must be followed by words separated with spaces. You can append an asterisk `*` to the fields in filtering rules for substring matching. Otherwise, the filter searches for an exact match with the field in -the rule. The filter uses binary search trees (BST) for exact match and linked -lists for substring match. So, filtering rules should be written using exact -matches instead of substring matches, as much as possible. Because BST search -must be faster than substring search over linked lists. +the rule. The filter uses B-tree data structure, a self-balancing tree for +exact match, and linked list for substring match. So, filtering rules should +be written using exact matches instead of substring matches, as much as +possible, because B-tree search must be faster than substring search over a +linked list. The ordering of filtering rules is important. The ordering of from, to, and log parts is not important. The ordering of log actions is not important. diff --git a/src/sslproxy.1 b/src/sslproxy.1 index b94de48..f2033ac 100644 --- a/src/sslproxy.1 +++ b/src/sslproxy.1 @@ -116,7 +116,7 @@ connection. Then SSLproxy re-encrypts and sends the packets to the Server. The response from the Server follows the same path back to the Client in reverse order. .LP -See the SSLsplit documentation for split style proxyspecs. +See the SSLsplit documentation for split style and structured proxyspecs. .SH SSLproxy line A sample line SSLproxy inserts into the first packet in the connection is the following: @@ -421,10 +421,11 @@ The macro name must be followed by words separated with spaces. .LP You can append an asterisk * to the fields in filtering rules for substring matching. Otherwise, the filter searches for an exact match with the field in -the rule. The filter uses binary search trees (BST) for exact match and linked -lists for substring match. So, filtering rules should be written using exact -matches instead of substring matches, as much as possible. Because BST search -must be faster than substring search over linked lists. +the rule. The filter uses B-tree data structure, a self-balancing tree for +exact match, and linked list for substring match. So, filtering rules should +be written using exact matches instead of substring matches, as much as +possible, because B-tree search must be faster than substring search over a +linked list. .LP The ordering of filtering rules is important. The ordering of from, to, and log parts is not important. The ordering of log actions is not important.