Border Gateway Protocol in Rust (bgp-rs)

A library for parsing Border Gateway Protocol (BGP) formatted streams in Rust. Messages such as UPDATE, OPEN, KEEPALIVE and NOTIFICATION can be read this way.

Examples & Documentation

Reading a MRT file containing BGP4MP messages

use std::fs::File;
use std::io::Cursor;
use std::io::Read;
use std::io::BufReader;
use mrt_rs::Record;
use mrt_rs::bgp4mp::BGP4MP;
use libflate::gzip::Decoder;
use bgp_rs::{Identifier, PathAttribute};

fn main() {
   // Download an update message.
   let file = File::open("res/updates.20190101.0000.gz").unwrap();

   // Decode the GZIP stream.
   let decoder = Decoder::new(BufReader::new(file)).unwrap();

   // Create a new MRTReader with a Cursor such that we can keep track of the position.
   let mut reader = mrt_rs::Reader { stream: decoder };

   // Keep reading MRT (Header, Record) tuples till the end of the file has been reached.
   while let Ok(Some((_, record))) = reader.read() {

       // Extract BGP4MP::MESSAGE_AS4 entries.
       if let Record::BGP4MP(BGP4MP::MESSAGE_AS4(x)) = record {

           // Read each BGP (Header, Message)
           let cursor = Cursor::new(x.message);
           let mut reader = bgp_rs::Reader::new(cursor);
           let (_, message) = reader.read().unwrap();

           // If this is an UPDATE message that contains announcements, extract its origin.
           if let bgp_rs::Message::Update(x) = message {
               if x.is_announcement() {
                   if let PathAttribute::AS_PATH(path) = x.get(Identifier::AS_PATH).unwrap()
                   {
                       // Test the path.origin() method.
                       let origin = path.origin();

                       // Do other stuff ...
                   }
               }
           }
       }
   }

Reading a MRT file containing TABLE_DUMP_V2 messages

For examples and documentation look here.

Supported Path Attributes

IANA has an official list of number assignments for BGP path attributes. In the table below one can see the status of each path attribute:

Minimum Supported Rust Version

This crate's minimum supported rustc version is 1.34.2.

Crate Features

The default feature set includes encoding & decoding of BGP Messages with attributes listed above

Enable Flowspec NLRI

To enable Flowspec NLRI (SAFI 133) parsing (RFC5575), specify the flowspec feature:

[dependencies]
...
bgp-rs = { version = "*", features = ["flowspec"]}
...

NOTE: This will add the bitflags dependency