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
use serde::Serialize;
use num_traits::FromPrimitive;
use std::error::Error;
use std::fmt::{Display, Formatter};

/// BGP capability parsing error
#[derive(Debug, PartialEq, Eq, Clone, Serialize)]
pub enum BgpCapabilityParsingError {
    Unassigned(u8),
    DeprecatedCode(u8),
    ReservedCode(u8),
    ReservedExperimentalCode(u8),
}

impl Display for BgpCapabilityParsingError {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        match self {
            BgpCapabilityParsingError::Unassigned(v) => {
                write!(f, "unassigned BGP capability code: {}", v)
            }
            BgpCapabilityParsingError::DeprecatedCode(v) => {
                write!(f, "deprecated BGP capability code: {}", v)
            }
            BgpCapabilityParsingError::ReservedCode(v) => {
                write!(f, "reserved BGP capability code: {}", v)
            }
            BgpCapabilityParsingError::ReservedExperimentalCode(v) => {
                write!(f, "reserved BGP capability code for experimental use: {}", v)
            }
        }
    }
}

impl Error for BgpCapabilityParsingError{}

#[allow(non_camel_case_types)]
#[derive(Debug, Primitive, PartialEq, Eq, Hash, Copy, Clone, Serialize)]
pub enum BgpCapabilityType {
    MULTIPROTOCOL_EXTENSIONS_FOR_BGP_4 = 1,
    ROUTE_REFRESH_CAPABILITY_FOR_BGP_4 = 2,
    OUTBOUND_ROUTE_FILTERING_CAPABILITY = 3,
    EXTENDED_NEXT_HOP_ENCODING = 5,
    BGP_EXTENDED_MESSAGE = 6,
    BGPSEC_CAPABILITY = 7,
    MULTIPLE_LABELS_CAPABILITY = 8,
    BGP_ROLE = 9,
    GRACEFUL_RESTART_CAPABILITY = 64,
    SUPPORT_FOR_4_OCTET_AS_NUMBER_CAPABILITY = 65,
    SUPPORT_FOR_DYNAMIC_CAPABILITY = 67,
    MULTISESSION_BGP_CAPABILITY = 68,
    ADD_PATH_CAPABILITY = 69,
    ENHANCED_ROUTE_REFRESH_CAPABILITY = 70,
    LONG_LIVED_GRACEFUL_RESTART_CAPABILITY = 71,
    ROUTING_POLICY_DISTRIBUTION = 72,
    FQDN_CAPABILITY = 73,
}

pub fn parse_capability(capability_code: &u8) -> Result<BgpCapabilityType, BgpCapabilityParsingError> {
    match BgpCapabilityType::from_u8(*capability_code) {
        Some(v) => {
            return Ok(v)
        }
        None => {
            if [4, 66, 128, 129, 130, 131, 184, 185].contains(capability_code) {
                Err(BgpCapabilityParsingError::DeprecatedCode(*capability_code))
            } else if *capability_code == 0 || *capability_code == 255 {
                Err(BgpCapabilityParsingError::ReservedCode(*capability_code))
            } else if *capability_code >= 239 && *capability_code <= 254 {
                Err(BgpCapabilityParsingError::ReservedExperimentalCode(*capability_code))
            } else {
                Err(BgpCapabilityParsingError::Unassigned(*capability_code))
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_parsing_capability() {
        let mut code;

        // reserved
        code = 0;
        assert_eq!(parse_capability(&code), Err(BgpCapabilityParsingError::ReservedCode(code)));
        code = 255;
        assert_eq!(parse_capability(&code), Err(BgpCapabilityParsingError::ReservedCode(code)));

        // deprecated
        for code in [4, 66, 128, 129, 130, 131, 184, 185] {
            assert_eq!(parse_capability(&code), Err(BgpCapabilityParsingError::DeprecatedCode(code)));
        }

        // unassigned
        for code in 10..=63 {
            assert_eq!(parse_capability(&code), Err(BgpCapabilityParsingError::Unassigned(code)));
        }
        for code in 74..=127 {
            assert_eq!(parse_capability(&code), Err(BgpCapabilityParsingError::Unassigned(code)));
        }
        for code in 132..=183 {
            assert_eq!(parse_capability(&code), Err(BgpCapabilityParsingError::Unassigned(code)));
        }
        for code in 186..=238 {
            assert_eq!(parse_capability(&code), Err(BgpCapabilityParsingError::Unassigned(code)));
        }

        // valid capabilities
        code = 1;
        assert_eq!(parse_capability(&code), Ok(BgpCapabilityType::MULTIPROTOCOL_EXTENSIONS_FOR_BGP_4));
        code = 2;
        assert_eq!(parse_capability(&code), Ok(BgpCapabilityType::ROUTE_REFRESH_CAPABILITY_FOR_BGP_4));
        code = 3;
        assert_eq!(parse_capability(&code), Ok(BgpCapabilityType::OUTBOUND_ROUTE_FILTERING_CAPABILITY));
        code = 5;
        assert_eq!(parse_capability(&code), Ok(BgpCapabilityType::EXTENDED_NEXT_HOP_ENCODING));
        code = 6;
        assert_eq!(parse_capability(&code), Ok(BgpCapabilityType::BGP_EXTENDED_MESSAGE));
        code = 7;
        assert_eq!(parse_capability(&code), Ok(BgpCapabilityType::BGPSEC_CAPABILITY));
        code = 8;
        assert_eq!(parse_capability(&code), Ok(BgpCapabilityType::MULTIPLE_LABELS_CAPABILITY));
        code = 9;
        assert_eq!(parse_capability(&code), Ok(BgpCapabilityType::BGP_ROLE));

        code = 64;
        assert_eq!(parse_capability(&code), Ok(BgpCapabilityType::GRACEFUL_RESTART_CAPABILITY));
        code = 65;
        assert_eq!(parse_capability(&code), Ok(BgpCapabilityType::SUPPORT_FOR_4_OCTET_AS_NUMBER_CAPABILITY));
        code = 67;
        assert_eq!(parse_capability(&code), Ok(BgpCapabilityType::SUPPORT_FOR_DYNAMIC_CAPABILITY));
        code = 68;
        assert_eq!(parse_capability(&code), Ok(BgpCapabilityType::MULTISESSION_BGP_CAPABILITY));
        code = 69;
        assert_eq!(parse_capability(&code), Ok(BgpCapabilityType::ADD_PATH_CAPABILITY));
        code = 70;
        assert_eq!(parse_capability(&code), Ok(BgpCapabilityType::ENHANCED_ROUTE_REFRESH_CAPABILITY));
        code = 71;
        assert_eq!(parse_capability(&code), Ok(BgpCapabilityType::LONG_LIVED_GRACEFUL_RESTART_CAPABILITY));
        code = 72;
        assert_eq!(parse_capability(&code), Ok(BgpCapabilityType::ROUTING_POLICY_DISTRIBUTION));
        code = 73;
        assert_eq!(parse_capability(&code), Ok(BgpCapabilityType::FQDN_CAPABILITY));

    }
}