aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorMauro Sardara <msardara@cisco.com>2021-04-06 09:47:12 +0000
committerGerrit Code Review <gerrit@fd.io>2021-04-06 09:47:12 +0000
commitd6a155b63c37682a25b1f5a02c0189af5dd3edef (patch)
treec4d0a563f63ac85b1e0ca727fcdf9d2eda8d9c2f /docs
parent8cdce03a7cc7c643c9a853d10136463c25315f79 (diff)
parentf72849911653de9239f3b32359f38b0c5ed90ac6 (diff)
Merge "[HICN-692] Fix deb package installation of packethicn"
Diffstat (limited to 'docs')
-rw-r--r--docs/source/index.rst1
-rw-r--r--docs/source/packethicn.md50
2 files changed, 41 insertions, 10 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 99ea39afa..6d48ae646 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -22,6 +22,7 @@ on VPP and a client stack is provided to support any mobile and desktop operatin
control
telemetry
utils
+ packethicn
apps
diff --git a/docs/source/packethicn.md b/docs/source/packethicn.md
index 3d3424d71..cf4976837 100644
--- a/docs/source/packethicn.md
+++ b/docs/source/packethicn.md
@@ -9,11 +9,21 @@ The `packethicn` plugin adds support to Wireshark to parse and dissect HICN traf
2. As a standalone component (see [Standalone build](#Standalone-build))
-The second one is preferred if `HICN` is already installed in the system.
+The second one is preferred if HICN is already installed in the system.
-# Build with HICN
+# Supported platforms
+`packethicn` has been tested in
-## Dependencies
+- Ubuntu 18.04
+- Ubuntu 20.04
+- macOS 11.2
+
+Other platforms and architectures may work.
+
+# Installation
+## Build with HICN
+
+### Dependencies
```bash
$ sudo add-apt-repository ppa:wireshark-dev/stable
@@ -22,7 +32,7 @@ $ sudo apt install -y build-essential cmake wireshark wireshark-dev libgcrypt-de
```
-## Build and install
+### Build and install
From the root HICN dir add the `-DBUILD_WSPLUGIN` flag to cmake.
@@ -39,10 +49,10 @@ $ sudo make install
```
-# Standalone build
-## Linux (Ubuntu)
+## Standalone build
+### Linux (Ubuntu)
-### Install dependencies
+#### Install dependencies
```bash
$ sudo add-apt-repository ppa:wireshark-dev/stable
@@ -51,7 +61,7 @@ $ curl -s https://packagecloud.io/install/repositories/fdio/release/script.deb.s
$ sudo apt install -y build-essential cmake libhicn-dev wireshark wireshark-dev libgcrypt-dev libgnutls28-dev
```
-### Compile and install HICN plugin
+#### Compile and install HICN plugin
```bash
$ cd packethicn
@@ -65,7 +75,7 @@ $ sudo make install
```
-## macOS
+### macOS
If installing wireshark via brew use the `./install_macos.sh` script as shown below:
```bash
@@ -94,4 +104,24 @@ $ cmake ..
$ make
$ sudo make install
-``` \ No newline at end of file
+```
+
+# Usage
+
+## Filters
+
+| Filter | Description | Example |
+| --- | --- | --- |
+| `hicn` | HICN traffic only | *hicn* |
+| `hicn.l3.src` | Source address / Name Prefix (of data) | *hicn.l3.src == b001::a8f:ae2a:bd5b:0:0* |
+| `hicn.l3.dst` | Destination address / Name Prefix (of interest) | *hicn.l3.dst == b001::a8f:ae2a:bd5b:1111:0* |
+| `hicn.l4.namesuffix ` | Name Suffix | *hicn.l4.namesuffix == 0x21* |
+| `hicn.l4.pathlabel ` | Path Label | *hicn.l4.pathlabel == 0xbb* |
+| `hicn.l4.timescale ` | Timescale | *hicn.l4.timescale == 4* |
+| `hicn.l4.flags ` | Flags | *hicn.l4.flags == 0x42* |
+| `hicn.l4.flags.id ` | ID Flag | *hicn.l4.flags.<span></span>id == 1* |
+| `hicn.l4.flags.man ` | MAN Flag | *hicn.l4.flags.man == 0* |
+| `hicn.l4.flags.sig ` | SIG Flag | *hicn.l4.flags.sig == 0* |
+| `hicn.l4.ldr ` | Loss Detection and Recovery | *hicn.l4.ldr > 0* |
+| `hicn.l4.csum ` | Checksum | *hicn.l4.csum > 0* |
+| `hicn.l4.lifetime ` | Lifetime | *hicn.l4.lifetime == 1000* |