zettabgp 0.4.1

This is a BGP (parsing and composing) and BMP (only parsing) protocols driver library for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240

// Copyright 2021 Vladimir Melnikov.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// https://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! This module contains BGP path attributes
use crate::*;
pub mod aggregatoras;
pub mod aspath;
pub mod atomicaggregate;
pub mod attrset;
pub mod clusterlist;
pub mod community;
pub mod connector;
pub mod extcommunity;
pub mod localpref;
pub mod med;
pub mod multiproto;
pub mod nexthop;
pub mod origin;
pub mod originatorid;
pub mod pmsitunnelattr;
pub mod otc;
pub mod unknown;
#[cfg(feature = "serialization")]
use serde::{Deserialize, Serialize};

use aggregatoras::BgpAggregatorAS;
use aspath::BgpASpath;
use atomicaggregate::BgpAtomicAggregate;
use attrset::BgpAttrSet;
use clusterlist::BgpClusterList;
use community::{BgpCommunityList, BgpLargeCommunityList};
use connector::BgpConnector;
use extcommunity::BgpExtCommunityList;
use localpref::BgpLocalpref;
use med::BgpMED;
use multiproto::{BgpMPUpdates, BgpMPWithdraws};
use nexthop::BgpNextHop;
use origin::BgpOrigin;
use originatorid::BgpOriginatorID;
use pmsitunnelattr::BgpPMSITunnel;
use otc::BgpOTC;
use unknown::BgpAttrUnknown;

/// BGP path attribute mandatory parameters - typecode and flags
#[derive(Debug, Clone, Hash, PartialEq, Eq, PartialOrd, Ord)]
#[cfg(feature = "serialization")]
#[derive(Serialize, Deserialize)]
pub struct BgpAttrParams {
    pub typecode: u8,
    pub flags: u8,
}

pub trait BgpAttr: std::fmt::Display + std::fmt::Debug {
    fn encode_to(&self, peer: &BgpSessionParams, buf: &mut [u8]) -> Result<usize, BgpError>;
    fn attr(&self) -> BgpAttrParams;
}

/// BGP path attribute
#[derive(Clone, Debug, Hash, PartialOrd, Ord, PartialEq, Eq)]
#[cfg(feature = "serialization")]
#[derive(Serialize, Deserialize)]
pub enum BgpAttrItem {
    Origin(BgpOrigin),
    ASPath(BgpASpath),
    NextHop(BgpNextHop),
    MED(BgpMED),
    LocalPref(BgpLocalpref),
    AtomicAggregate(BgpAtomicAggregate),
    AggregatorAS(BgpAggregatorAS),
    CommunityList(BgpCommunityList),
    OriginatorID(BgpOriginatorID),
    ClusterList(BgpClusterList),
    MPUpdates(BgpMPUpdates),
    MPWithdraws(BgpMPWithdraws),
    ExtCommunityList(BgpExtCommunityList),
    LargeCommunityList(BgpLargeCommunityList),
    PMSITunnel(BgpPMSITunnel),
    AttrSet(BgpAttrSet),
    Connector(BgpConnector),
    OTC(BgpOTC),
    Unknown(BgpAttrUnknown),
}

impl BgpAttrItem {
    pub fn decode_from(
        peer: &BgpSessionParams,
        typecode: u8,
        flags: u8,
        attrlen: usize,
        buf: &[u8],
    ) -> Result<BgpAttrItem, BgpError> {
        match typecode {
            1 => Ok(BgpAttrItem::Origin(BgpOrigin::decode_from(buf)?)),
            2 => Ok(BgpAttrItem::ASPath(BgpASpath::decode_from(peer, buf)?)),
            3 => Ok(BgpAttrItem::NextHop(BgpNextHop::decode_from(peer, buf)?)),
            4 => Ok(BgpAttrItem::MED(BgpMED::decode_from(buf)?)),
            5 => Ok(BgpAttrItem::LocalPref(BgpLocalpref::decode_from(buf)?)),
            6 => Ok(BgpAttrItem::AtomicAggregate(
                BgpAtomicAggregate::decode_from(peer, buf)?,
            )),
            7 => Ok(BgpAttrItem::AggregatorAS(BgpAggregatorAS::decode_from(
                peer, buf,
            )?)),
            8 => Ok(BgpAttrItem::CommunityList(BgpCommunityList::decode_from(
                buf,
            )?)),
            9 => Ok(BgpAttrItem::OriginatorID(BgpOriginatorID::decode_from(
                peer, buf,
            )?)),
            10 => Ok(BgpAttrItem::ClusterList(BgpClusterList::decode_from(
                peer, buf,
            )?)),
            14 => Ok(BgpAttrItem::MPUpdates(BgpMPUpdates::decode_from(
                peer, buf,
            )?)),
            15 => Ok(BgpAttrItem::MPWithdraws(BgpMPWithdraws::decode_from(
                peer, buf,
            )?)),
            16 => Ok(BgpAttrItem::ExtCommunityList(
                BgpExtCommunityList::decode_from(buf)?,
            )),
            22 => Ok(BgpAttrItem::PMSITunnel(BgpPMSITunnel::decode_from(
                peer, buf,
            )?)),
            20 => Ok(BgpAttrItem::Connector(BgpConnector::decode_from(buf)?)),
            32 => Ok(BgpAttrItem::LargeCommunityList(
                BgpLargeCommunityList::decode_from(buf)?,
            )),
            21 =>
            //deprecated
            {
                Ok(BgpAttrItem::Unknown(BgpAttrUnknown::decode_from(
                    typecode,
                    flags,
                    &buf[0..attrlen],
                )?))
            }
            35 => Ok(BgpAttrItem::OTC(
                BgpOTC::decode_from(peer,buf)?,
            )),
            128 => Ok(BgpAttrItem::AttrSet(BgpAttrSet::decode_from(peer, buf)?)),
            _ => {
                log::trace!(
                    "Unknown PA TC={:?} flags={:?} len={:?}: {:?}",
                    typecode,
                    flags,
                    attrlen,
                    &buf[0..attrlen]
                );
                Ok(BgpAttrItem::Unknown(BgpAttrUnknown::decode_from(
                    typecode,
                    flags,
                    &buf[0..attrlen],
                )?))
            }
        }
    }
    fn encode_bgpattr(
        attr: &impl BgpAttr,
        peer: &BgpSessionParams,
        buf: &mut [u8],
    ) -> Result<usize, BgpError> {
        let attrparams = attr.attr();
        buf[0] = attrparams.flags;
        buf[1] = attrparams.typecode;
        let mut curpos: usize = 2;
        if (attrparams.flags & 16) > 0 {
            curpos += 2;
        } else {
            curpos += 1;
        }
        let attrlen = attr.encode_to(peer, &mut buf[curpos..])?;
        if (attrparams.flags & 16) > 0 {
            if attrlen > 65535 {
                return Err(BgpError::static_str("Invalid path attribute length"));
            }
            setn_u16(attrlen as u16, &mut buf[2..4]);
        } else {
            if attrlen > 255 {
                return Err(BgpError::static_str("Invalid path attribute length"));
            }
            buf[2] = attrlen as u8;
        }
        Ok(curpos + attrlen)
    }
    pub fn encode_to(&self, peer: &BgpSessionParams, buf: &mut [u8]) -> Result<usize, BgpError> {
        match self {
            BgpAttrItem::Origin(pa) => BgpAttrItem::encode_bgpattr(pa, peer, buf),
            BgpAttrItem::ASPath(pa) => BgpAttrItem::encode_bgpattr(pa, peer, buf),
            BgpAttrItem::NextHop(pa) => BgpAttrItem::encode_bgpattr(pa, peer, buf),
            BgpAttrItem::MED(pa) => BgpAttrItem::encode_bgpattr(pa, peer, buf),
            BgpAttrItem::LocalPref(pa) => BgpAttrItem::encode_bgpattr(pa, peer, buf),
            BgpAttrItem::AtomicAggregate(pa) => BgpAttrItem::encode_bgpattr(pa, peer, buf),
            BgpAttrItem::AggregatorAS(pa) => BgpAttrItem::encode_bgpattr(pa, peer, buf),
            BgpAttrItem::CommunityList(pa) => BgpAttrItem::encode_bgpattr(pa, peer, buf),
            BgpAttrItem::OriginatorID(pa) => BgpAttrItem::encode_bgpattr(pa, peer, buf),
            BgpAttrItem::ClusterList(pa) => BgpAttrItem::encode_bgpattr(pa, peer, buf),
            BgpAttrItem::MPUpdates(pa) => BgpAttrItem::encode_bgpattr(pa, peer, buf),
            BgpAttrItem::MPWithdraws(pa) => BgpAttrItem::encode_bgpattr(pa, peer, buf),
            BgpAttrItem::ExtCommunityList(pa) => BgpAttrItem::encode_bgpattr(pa, peer, buf),
            BgpAttrItem::LargeCommunityList(pa) => BgpAttrItem::encode_bgpattr(pa, peer, buf),
            BgpAttrItem::PMSITunnel(pa) => BgpAttrItem::encode_bgpattr(pa, peer, buf),
            BgpAttrItem::AttrSet(pa) => BgpAttrItem::encode_bgpattr(pa, peer, buf),
            BgpAttrItem::Connector(pa) => BgpAttrItem::encode_bgpattr(pa, peer, buf),
            BgpAttrItem::OTC(pa) => BgpAttrItem::encode_bgpattr(pa, peer, buf),
            BgpAttrItem::Unknown(pa) => BgpAttrItem::encode_bgpattr(pa, peer, buf),
        }
    }
}

impl std::fmt::Display for BgpAttrItem {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        match self {
            BgpAttrItem::Origin(pa) => pa.fmt(f),
            BgpAttrItem::ASPath(pa) => pa.fmt(f),
            BgpAttrItem::NextHop(pa) => pa.fmt(f),
            BgpAttrItem::MED(pa) => pa.fmt(f),
            BgpAttrItem::LocalPref(pa) => pa.fmt(f),
            BgpAttrItem::AtomicAggregate(pa) => pa.fmt(f),
            BgpAttrItem::AggregatorAS(pa) => pa.fmt(f),
            BgpAttrItem::CommunityList(pa) => pa.fmt(f),
            BgpAttrItem::OriginatorID(pa) => pa.fmt(f),
            BgpAttrItem::ClusterList(pa) => pa.fmt(f),
            BgpAttrItem::MPUpdates(pa) => pa.fmt(f),
            BgpAttrItem::MPWithdraws(pa) => pa.fmt(f),
            BgpAttrItem::ExtCommunityList(pa) => pa.fmt(f),
            BgpAttrItem::LargeCommunityList(pa) => pa.fmt(f),
            BgpAttrItem::PMSITunnel(pa) => pa.fmt(f),
            BgpAttrItem::AttrSet(pa) => pa.fmt(f),
            BgpAttrItem::Connector(pa) => pa.fmt(f),
            BgpAttrItem::OTC(pa) => pa.fmt(f),
            BgpAttrItem::Unknown(pa) => pa.fmt(f),
        }
    }
}