diff options
author | 2021-03-23 15:55:01 +0100 | |
---|---|---|
committer | 2021-03-25 16:53:16 +0100 | |
commit | 9f30bf6e794a7b431217ce91038a4ec0f917dc08 (patch) | |
tree | 32d58faf4e61045730e1fedc58153b979ce1e420 /docs | |
parent | eedc20451418af57a6ffe4c6d41652828f01b9fe (diff) |
[HICN-688] Include packethicn in hicn build
Add license headers
Add dependencies
Fix build for Ubuntu 18.04
Move doc
Signed-off-by: Marco Trinelli <marcotrinelli@gmail.com>
Change-Id: Ie92268d2d3a47c47746107ac6f9c34b21949671c
Diffstat (limited to 'docs')
-rw-r--r-- | docs/source/packethicn.md | 97 |
1 files changed, 97 insertions, 0 deletions
diff --git a/docs/source/packethicn.md b/docs/source/packethicn.md new file mode 100644 index 000000000..3d3424d71 --- /dev/null +++ b/docs/source/packethicn.md @@ -0,0 +1,97 @@ +HICN Plugin for Wireshark +=================== + +The `packethicn` plugin adds support to Wireshark to parse and dissect HICN traffic. + +`packethicn` can be compiled and installed in two ways: + +1. Alongside HICN, from the HICN root dir (see [Build with HICN](#Build-with-HICN)) + +2. As a standalone component (see [Standalone build](#Standalone-build)) + +The second one is preferred if `HICN` is already installed in the system. + +# Build with HICN + +## Dependencies + +```bash +$ sudo add-apt-repository ppa:wireshark-dev/stable + +$ sudo apt install -y build-essential cmake wireshark wireshark-dev libgcrypt-dev libgnutls28-dev + +``` + +## Build and install + +From the root HICN dir add the `-DBUILD_WSPLUGIN` flag to cmake. + +```bash +$ cd hicn + +$ mkdir build; cd build + +$ cmake -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl\@1.1 -DBUILD_APPS=ON -DBUILD_WSPLUGIN=ON .. + +$ make -j`nproc` + +$ sudo make install + +``` + +# Standalone build +## Linux (Ubuntu) + +### Install dependencies +```bash +$ sudo add-apt-repository ppa:wireshark-dev/stable + +$ curl -s https://packagecloud.io/install/repositories/fdio/release/script.deb.sh | sudo bash + +$ sudo apt install -y build-essential cmake libhicn-dev wireshark wireshark-dev libgcrypt-dev libgnutls28-dev + +``` +### Compile and install HICN plugin +```bash +$ cd packethicn + +$ mkdir build; cd build + +$ cmake .. + +$ make + +$ sudo make install +``` + + +## macOS +If installing wireshark via brew use the `./install_macos.sh` script as shown below: + +```bash +$ brew tap icn-team/hicn-tap + +$ brew install hicn + +$ brew install wireshark + +$ brew install cask wireshark + +$ cd packethicn + +$ ./install_macos.sh +``` + +Otherwise (if wireshark was compiled from sources) you can follow the setup for Linux: + +```bash +$ cd packethicn + +$ mkdir build; cd build + +$ cmake .. + +$ make + +$ sudo make install +```
\ No newline at end of file |