From 787da4ba7eadf12dac82bd66cd0cbf67cc75a160 Mon Sep 17 00:00:00 2001 From: Giuliano Bellini s294739 Date: Fri, 18 Nov 2022 10:47:49 +0100 Subject: [PATCH] updated changelog, readme --- CHANGELOG.md | 13 ++++++++-- Cargo.toml | 8 +++--- README.md | 56 ++++++++++++++++------------------------- src/gui/gui_run_page.rs | 3 +-- 4 files changed, 38 insertions(+), 42 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index db24b79f..5e721167 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,15 @@ All Sniffnet releases with the relative changes are documented in this file. +## [1.0.0] - 2022-11-xx + +- The application is no longer just a command line interface: Sniffnet has now a whole graphical user interface! + * Charts and traffic statistics are now constantly updated and shown interactively in the GUI + * Users don't have to worry about command line options anymore: it is now possible to comfortably specify adapters and filters through the GUI + * Sniffnet is now more accessible, available in real-time, easy to use and aesthetically pleasing thanks to its new interface +- In order to reach out as many people as possible, I created [installers](https://github.com/GyulyVGC/sniffnet/releases) for Windows and macOS, to make it easier to install Sniffnet for those that still doesn't have Rust on their machines + + ## [0.5.0] - 2022-10-02 - Optimized textual report updates: only changed entries are rewritten (file `report.txt`) @@ -33,8 +42,8 @@ All Sniffnet releases with the relative changes are documented in this file. ## [0.3.1] - 2022-08-31 -- Added devices description when application is launched with the `-d` option -- Intruduced feature to measure write timings and added a BufWriter to improve write performance +- Added devices' description when application is launched with the `-d` option +- Introduced feature to measure write timings and added a BufWriter to improve write performance - Fixed standard output colors for Windows systems diff --git a/Cargo.toml b/Cargo.toml index 46195b4d..72a3044e 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,14 +1,14 @@ [package] name = "sniffnet" version = "0.5.0" -edition = "2021" authors = ["Giuliano Bellini"] +edition = "2021" description = "Application to comfortably monitor your network traffic" -repository = "https://github.com/GyulyVGC/sniffnet" readme = "README.md" +repository = "https://github.com/GyulyVGC/sniffnet" +license = "MIT OR Apache-2.0" keywords = ["filter", "network", "packet", "sniffer", "parser"] categories = ["command-line-utilities", "concurrency", "network-programming"] -license = "MIT OR Apache-2.0" include = ["src/**/*", "LICENSE-*", "README.md"] @@ -31,5 +31,5 @@ thousands = "0.2.0" plotters = "0.3.4" indexmap = "1.9.1" plotters-iced = "0.3.3" -iced = {version = "0.4.2", features = ["tokio"] } +iced = { version = "0.4.2", features = ["tokio"] } iced_style = "0.4.0" \ No newline at end of file diff --git a/README.md b/README.md index de5d136c..812fc287 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ -

Sniffnet

+

Sniffnet

-

Application to comfortably monitor your network traffic

-

Multithreaded, cross-platform, reliable

+

Application to comfortably monitor your network traffic

+

Multithreaded, cross-platform, reliable

-

+

  @@ -15,9 +15,9 @@

-

+

-
+

Sniffnet is a simple yet insightful application to let you have a glance into your network traffic in a straightforward and appealing way

@@ -74,19 +74,19 @@ Otherwise, you can install Sniffnet through the installers available in the [lat ## Features - choose a network adapter to inspect -

+

- select filters to apply to the observed traffic -

+

- view real-time charts about traffic intensity (bytes and packets per second, incoming and outgoing) -

+

- view overall statistics about the filtered traffic -

+

- view most relevant connections (most recent, most packets, most bytes) -

+

- save complete textual report with detailed information for each connection: * source and destination IP addresses @@ -108,7 +108,7 @@ Otherwise, you can install Sniffnet through the installers available in the [lat
-
+
|Port number(s)|Application protocol | Description | |--|--|--| @@ -148,35 +148,23 @@ Otherwise, you can install Sniffnet through the installers available in the [lat See details +### Missing dependencies -### Pcap permission denied error +Most of the errors that can occur are likely due to your system missing required pcap dependencies, +necessary to correctly analyze a network adapter. -You may incur in this error if you have not the privilege to open a network adapter. Full error is reported below. +Check the [Install & Run](#Install-&-Run) section for instructions on how to proceed. -

+For a Windows reference, you can check [issue #1](https://github.com/GyulyVGC/sniffnet/issues/1). -To solve this error you can execute the following command: -```sudo chown username /dev/bp*``` +### Installers incompatibilities -Where ```username``` can be retrieved with the command ```whoami``` +If you have problems after having installed Sniffnet through the provided installers, +it could be due to your OS not being compatible with the pre-built binaries I generated for you. -Alternatively, you can run the application as root: ```sudo sniffnet [OPTIONS]``` - -In both cases you will be requested to insert your system password. - - -### Textual report contains just the header - -If the textual output is not reporting packets statistics, make sure you are sniffing the correct network adapter (use the ```-d``` -option to see the full list of your network adapters' names and addresses). -To inspect a network adapter of your choice, remember to specify the ```-a``` option followed by the name of the adapter to be analyzed. -If you don't include such option a default adapter is chosen by the application, but it may not be the one you expected to sniff. - -Note that to see report updates while Sniffnet is running you may have to close and re-open the report file. - -If you are still not able to see any packet statistic, then it probably means that you are just not receiving packets from the network: -surf the web to receive some packets. +Reach me out, and I'll try to generate an installer for your specific operating system. +### ***In any case don't hesitate to [open an issue](https://github.com/GyulyVGC/sniffnet/issues), and I will do my best to help you!*** diff --git a/src/gui/gui_run_page.rs b/src/gui/gui_run_page.rs index 4879d7a2..c0fe1b45 100644 --- a/src/gui/gui_run_page.rs +++ b/src/gui/gui_run_page.rs @@ -264,8 +264,7 @@ pub fn run_page(sniffer: &mut Sniffer) -> Column { .push(row_report); } } - } - else { // pcap threw an ERROR! + } else { // pcap threw an ERROR! let err_string = sniffer.pcap_error.lock().unwrap().clone().unwrap(); if sniffer.waiting.len() > 2 {