Skip to content

OperatorFoundation/CanaryLinux

Repository files navigation

CanaryLinux

A command line tool for testing transport connections and gathering the packets for analysis.

Canary will run a series of transport tests based on the configs that you provide. It is possible to test each transport on a different transport server based on what host information is provided in the transport config files.

Currently Shadow and Starbridge tests are supported.

Currently in development

Compiling the project on a Linux system:

  • You will need to install libpcap-dev if you do not already have it using: sudo apt-get install libpcap-dev

Running Canary

  • Transport configs should include their transport server IP and port, and should include the transport name in the name of the file.
  • You should run Canary on the same platform it was compiled on
  • You must run Canary with sudo in order for it to capture any data
  • To run Canary with default settings simply provide the config directory for the transports you want to test as an argument:

sudo <path-to-canarylinux-executable> <path-to-config-directory>
(ex. sudo .build/x86_64-unknown-linux-gnu/debug/CanaryLinux /home/configdirectory)

About

Canary For Linux Users

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages