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
|
//! SNMPv3 Parser
//!
//! SNMPv3 is defined in the following RFCs:
//! - [RFC2570](https://tools.ietf.org/html/rfc2570): Introduction to SNMP v3
//! - [RFC3412](https://tools.ietf.org/html/rfc3412): Message Processing and Dispatching for the
//! Simple Network Management Protocol (SNMP)
//!
//! See also:
//! - [RFC2578](https://tools.ietf.org/html/rfc2578): Structure of Management Information Version 2 (SMIv2)
use asn1_rs::{Error, FromBer, Sequence};
use nom::combinator::{map, map_res};
use nom::{Err, IResult};
use std::fmt;
use crate::error::SnmpError;
use crate::snmp::{parse_snmp_v2c_pdu, SnmpPdu};
pub use crate::usm::{parse_usm_security_parameters, UsmSecurityParameters};
#[derive(Clone, Copy, Eq, PartialEq)]
pub struct SecurityModel(pub u32);
#[allow(non_upper_case_globals)]
impl SecurityModel {
pub const SnmpV1: SecurityModel = SecurityModel(1);
pub const SnmpV2c: SecurityModel = SecurityModel(2);
pub const USM: SecurityModel = SecurityModel(3);
}
impl fmt::Debug for SecurityModel {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match self.0 {
1 => f.write_str("SnmpV1"),
2 => f.write_str("SnmpV2c"),
3 => f.write_str("USM"),
n => f.debug_tuple("SecurityModel").field(&n).finish(),
}
}
}
impl<'a> FromBer<'a> for SecurityModel {
fn from_ber(bytes: &'a [u8]) -> asn1_rs::ParseResult<'a, Self> {
map(u32::from_ber, SecurityModel)(bytes)
}
}
#[derive(Debug, PartialEq)]
#[allow(clippy::upper_case_acronyms)]
pub enum SecurityParameters<'a> {
Raw(&'a [u8]),
USM(UsmSecurityParameters<'a>),
}
/// An SNMPv3 message
#[derive(Debug, PartialEq)]
pub struct SnmpV3Message<'a> {
/// Version, as raw-encoded: 3 for SNMPv3
pub version: u32,
pub header_data: HeaderData,
pub security_params: SecurityParameters<'a>,
pub data: ScopedPduData<'a>,
}
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct HeaderData {
pub msg_id: u32,
pub msg_max_size: u32,
pub msg_flags: u8,
pub msg_security_model: SecurityModel,
}
impl HeaderData {
pub fn is_authenticated(&self) -> bool {
self.msg_flags & 0b001 != 0
}
pub fn is_encrypted(&self) -> bool {
self.msg_flags & 0b010 != 0
}
pub fn is_reportable(&self) -> bool {
self.msg_flags & 0b100 != 0
}
}
impl<'a> FromBer<'a> for HeaderData {
fn from_ber(bytes: &'a [u8]) -> asn1_rs::ParseResult<'a, Self> {
Sequence::from_ber_and_then(bytes, |i| {
let (i, msg_id) = u32::from_ber(i)?;
let (i, msg_max_size) = u32::from_ber(i)?;
let (i, b) = <&[u8]>::from_ber(i)?;
let msg_flags = if b.len() == 1 {
b[0]
} else {
return Err(Err::Error(Error::BerValueError));
};
let (i, msg_security_model) = map(u32::from_ber, SecurityModel)(i)?;
let hdr = HeaderData {
msg_id,
msg_max_size,
msg_flags,
msg_security_model,
};
Ok((i, hdr))
})
}
}
#[derive(Debug, PartialEq)]
pub enum ScopedPduData<'a> {
Plaintext(ScopedPdu<'a>),
Encrypted(&'a [u8]),
}
#[derive(Debug, PartialEq)]
pub struct ScopedPdu<'a> {
pub ctx_engine_id: &'a [u8],
pub ctx_engine_name: &'a [u8],
/// ANY -- e.g., PDUs as defined in [RFC3416](https://tools.ietf.org/html/rfc3416)
pub data: SnmpPdu<'a>,
}
pub(crate) fn parse_snmp_v3_data<'a>(
i: &'a [u8],
hdr: &HeaderData,
) -> IResult<&'a [u8], ScopedPduData<'a>, SnmpError> {
if hdr.is_encrypted() {
map(<&[u8]>::from_ber, ScopedPduData::Encrypted)(i).map_err(Err::convert)
} else {
parse_snmp_v3_plaintext_pdu(i)
}
}
pub(crate) fn parse_secp<'a>(
i: &'a [u8],
hdr: &HeaderData,
) -> Result<SecurityParameters<'a>, SnmpError> {
match hdr.msg_security_model {
SecurityModel::USM => match parse_usm_security_parameters(i) {
Ok((_, usm)) => Ok(SecurityParameters::USM(usm)),
_ => Err(SnmpError::InvalidSecurityModel),
},
_ => Ok(SecurityParameters::Raw(i)),
}
}
/// Parse an SNMPv3 top-level message
///
/// Example:
///
/// ```rust
/// use snmp_parser::{parse_snmp_v3,ScopedPduData,SecurityModel};
///
/// static SNMPV3_REQ: &[u8] = include_bytes!("../assets/snmpv3_req.bin");
///
/// # fn main() {
/// match parse_snmp_v3(&SNMPV3_REQ) {
/// Ok((_, ref r)) => {
/// assert!(r.version == 3);
/// assert!(r.header_data.msg_security_model == SecurityModel::USM);
/// match r.data {
/// ScopedPduData::Plaintext(ref _pdu) => { },
/// ScopedPduData::Encrypted(_) => (),
/// }
/// },
/// Err(e) => panic!("{}", e),
/// }
/// # }
/// ```
pub fn parse_snmp_v3(bytes: &[u8]) -> IResult<&[u8], SnmpV3Message, SnmpError> {
Sequence::from_der_and_then(bytes, |i| {
let (i, version) = u32::from_ber(i).map_err(Err::convert)?;
let (i, header_data) = parse_snmp_v3_headerdata(i)?;
let (i, secp) =
map_res(<&[u8]>::from_ber, |x| parse_secp(x, &header_data))(i).map_err(Err::convert)?;
let (i, data) = parse_snmp_v3_data(i, &header_data)?;
let msg = SnmpV3Message {
version,
header_data,
security_params: secp,
data,
};
Ok((i, msg))
})
}
#[inline]
pub(crate) fn parse_snmp_v3_headerdata(i: &[u8]) -> IResult<&[u8], HeaderData, SnmpError> {
HeaderData::from_ber(i).map_err(Err::convert)
}
fn parse_snmp_v3_plaintext_pdu(bytes: &[u8]) -> IResult<&[u8], ScopedPduData, SnmpError> {
Sequence::from_der_and_then(bytes, |i| {
let (i, ctx_engine_id) = <&[u8]>::from_ber(i).map_err(Err::convert)?;
let (i, ctx_engine_name) = <&[u8]>::from_ber(i).map_err(Err::convert)?;
let (i, data) = parse_snmp_v2c_pdu(i)?;
let pdu = ScopedPdu {
ctx_engine_id,
ctx_engine_name,
data,
};
Ok((i, ScopedPduData::Plaintext(pdu)))
})
}
|
