Skip to content

Commit 3ea0342

Browse files
committed
Update documentation.
1 parent 08ac011 commit 3ea0342

File tree

3 files changed

+68
-5
lines changed

3 files changed

+68
-5
lines changed

docs/api.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ my_streamer = NFStreamer(source="facebook.pcap",
5151

5252
### NFStreamer attributes
5353

54-
| `source` | `[default=None]` | Packet capture source. Pcap file path or network interface name. |
54+
| `source` | `[default=None]` | Packet capture source. Pcap file path, List of pcap files path (considered as a single file) or network interface name. |
5555
| `decode_tunnels` | `[default=True]` | Enable/Disable GTP/CAPWAP/TZSP tunnels decoding. |
5656
| `bpf_filter` | `[default=None]` | Specify a [BPF filter][bpf] filter for filtering selected traffic. |
5757
| `promiscuous_mode` | `[default=True]` | Enable/Disable promiscuous capture mode. |
@@ -138,7 +138,8 @@ In the following we detail each implemented feature.
138138

139139
| `application_name` | `str` | nDPI detected application name. |
140140
| `application_category_name` | `str` | nDPI detected application category name. |
141-
| `application_is_guessed` | `int` | Indicates if detection result is based on pure dissection or on a port-based guess. |
141+
| `application_is_guessed` | `int` | Indicates if detection result is based on pure dissection or on a guess heuristics. |
142+
| `application_confidence` | `int` | Indicates the underlying detection method (O: Unknown classification, 100: Classification results based on partial/incomplete DPI information, 110: Classification results based on some LRU cache with partial/incomplete DPI information, 200: Classification results based on some LRU cache (i.e. correlation among sessions), 210: Deep packet inspection). |
142143
| `requested_server_name` | `str` | Requested server name (SSL/TLS, DNS, HTTP). |
143144
| `client_fingerprint` | `str` | Client fingerprint (DHCP fingerprint for DHCP, [JA3][ja3] for SSL/TLS and [HASSH][hassh] for SSH). |
144145
| `server_fingerprint` | `str` | Server fingerprint ([JA3][ja3] for SSL/TLS and [HASSH][hassh] for SSH). |

docs/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,6 @@ git clone --recurse-submodules https://github.com/nfstream/nfstream.git
7171
cd nfstream
7272
python3 -m pip install --upgrade pip
7373
python3 -m pip install -r dev_requirements.txt
74-
python3 prepare.py
7574
python3 -m pip install .
7675
```
7776

docs/releases.md

Lines changed: 65 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,72 @@ This page contains NFStream release history
1515

1616
- GitHub page: <https://github.com/aouinizied/nfstream>{:target="_blank"}
1717

18-
## Latest Official Release - v6.3.4
18+
## Latest Official Release - v6.5.2
19+
Release date: 2022-09-27 {% include new-release.html %}
1920

20-
Release date: 2021-09-03 {% include new-release.html %}
21+
* nDPI update.
22+
* Windows fixes.
23+
* Multiple pcap files support.
24+
* Wheels generation for Alpine, Linux 32bits, aarch64, Apple Silicon.
25+
26+
## v6.5.1
27+
28+
Release date: 2022-04-27
29+
30+
* Fix for broken pypi Linux wheels.
31+
32+
## v6.5.0
33+
34+
Release date: 2022-04-27
35+
36+
* Performances improvements (x3 faster): CFFI bindings from ABI to API mod.
37+
* nDPI integration several improvements.
38+
39+
## v6.4.3
40+
41+
Release date: 2022-03-16
42+
43+
* Add CSV rotating files feature.
44+
* Add pypi wheels for aarch64 and armhf.
45+
* nDPI maintenance update.
46+
* Fix RAW datalink handling on Windows.
47+
48+
## v6.4.2
49+
50+
Release date: 2022-02-11
51+
52+
* Fix for pypi missing wheels.
53+
54+
## v6.4.1
55+
56+
Release date: 2022-02-10
57+
58+
* nDPI maintenance update.
59+
60+
## v6.4.0
61+
62+
Release date: 2021-12-10
63+
64+
* Introduce Windows platform official support.
65+
* Introduce System Visibility feature.
66+
* Introduce Python 3.10 official support.
67+
* nDPI maintenance update.
68+
* Patch for RPI platforms cores detection.
69+
70+
## v6.3.5
71+
72+
Release date: 2021-10-07
73+
74+
* Improve IPv6 handling.
75+
* nDPI maintenance update (memory consumption reduction).
76+
* Fix macOS multiprocessing context.
77+
* Fix macOS dependencies handling (NumPy and pandas)
78+
* Improve README (ToC and related publications).
79+
80+
81+
## v6.3.4
82+
83+
Release date: 2021-09-03
2184

2285
* Fix transport_size value.
2386
* Fix requirements on MacOS and PyPy.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy