Giter VIP home page Giter VIP logo

netgauze's Introduction

NetGauze (under-development)

github build status codecov

A collection of network related libraries that includes protocol parsers and daemons. This project is still in an early stage.

Supported Protocols

  1. BGP
    1. Packet representation and wire format serialization/deserialization: netgauze-bgp-pkt
    2. BGP Speaker (including connection management and FSM): netgauze-bgp-speaker
  2. BMP
    1. Packet representation and wire format serialization/deserialization: netgauze-bmp-pkt
    2. Service building block to receive BMP messages: netgauze-bmp-service
  3. Netflow V9 and IPFIX
    1. Packet representation and wire format serialization/deserialization: netgauze-flow-pkt
    2. Service building block to receive messages: netgauze-flow-service

Development documentation

Running tests

NetGauze uses macro test from the trybuild crate. To generate the expected output for macro test an override env var must be set.

TRYBUILD=overwrite cargo test

Running code formatting and clippy checks

cargo fmt -- --config format_code_in_doc_comments=true --config wrap_comments=true --config imports_granularity=Crate

NetGauze uses nightly rust build for clippy checks just to anticipate what's coming in new rust releases.

cargo +nightly clippy --tests -- -Dclippy::all

Running examples

Some NetGauze crates come with examples. Check ls ./crates/*/examples to list existing examples.

For example, run the ./crates/flow-service/example/print-flow.rs, you can use:

cargo run -p netgauze-flow-service --example print-flow

Running Packet Serde Fuzzer

  • Fuzzing BGP Peer cargo +nightly fuzz run fuzz-bgp-peer

  • Fuzzing BGP pkt serde

    cargo +nightly fuzz run fuzz-bgp-pkt
    cargo +nightly fuzz run fuzz-bgp-pkt-serialize
    
  • Fuzzing BMP pkt serde

    cargo +nightly fuzz run fuzz-bmp-pkt
    cargo +nightly fuzz run fuzz-bmp-pkt-serialize
    
  • Fuzzing IPFIX cargo +nightly fuzz run fuzz-ipfix-pkt

  • Fuzzing Netflow V9 cargo +nightly fuzz run fuzz-netflow-v9-pkt

License

Licensed under Apache License, Version 2.0 (LICENSE or http://www.apache.org/licenses/LICENSE-2.0)

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be licensed as above, without any additional terms or conditions.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.