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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
#![deny(missing_docs)]
#![forbid(unsafe_code)]
extern crate bincode;
extern crate byteorder;
extern crate eui48;
#[macro_use]
extern crate failure;
#[macro_use]
extern crate log;
extern crate regex;
#[macro_use]
extern crate serde_derive;
extern crate serde;
use std::collections::BTreeMap;
use std::fs::File;
use std::io::prelude::*;
use std::io::BufReader;
use byteorder::{NetworkEndian, ReadBytesExt};
use eui48::MacAddress;
use failure::{Error, ResultExt};
use regex::Regex;
type OuiMap = BTreeMap<(u64, u64), OuiEntry>;
#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]
pub struct OuiEntry {
name_short: String,
name_long: Option<String>,
comment: Option<String>,
}
impl Default for OuiEntry {
fn default() -> OuiEntry {
OuiEntry {
name_short: String::new(),
name_long: None,
comment: None,
}
}
}
pub struct OuiDatabase {
database: OuiMap,
}
impl OuiDatabase {
pub fn new_from_file(dbfile: &str) -> Result<OuiDatabase, Error> {
let db = create_oui_db_from_file(dbfile)?;
info!("Created a new OUI Vendor database from file {}", dbfile);
Ok(OuiDatabase { database: db })
}
pub fn new_from_export(data: &[u8]) -> Result<OuiDatabase, Error> {
let deserialized = bincode::deserialize(data).context("could not deserialize data")?;
info!("Created a new OUI Vendor database from previously exported data");
Ok(OuiDatabase {
database: deserialized,
})
}
pub fn export(&self) -> Result<Vec<u8>, Error> {
let data = bincode::serialize(&self.database).context("could not serialize database")?;
info!("Created a dump of the OUI Vendor database for export");
Ok(data)
}
pub fn query_by_mac(&self, mac_addr: &MacAddress) -> Result<Option<OuiEntry>, Error> {
let mac_int = mac_to_u64(mac_addr)?;
debug!(
"Querying OUI Vendor database for {:?} ({})",
mac_addr, mac_int
);
self.query(&mac_int)
}
pub fn query_by_str(&self, mac_str: &str) -> Result<Option<OuiEntry>, Error> {
let mac_addr = MacAddress::parse_str(&mac_str)
.context(format!("could not parse MAC address from str: {}", mac_str))?;
self.query_by_mac(&mac_addr)
}
pub fn len(&self) -> usize {
self.database.len()
}
pub fn is_empty(&self) -> bool {
self.database.is_empty()
}
fn query(&self, query: &u64) -> Result<Option<OuiEntry>, Error> {
let mut results = Vec::<((u64, u64), OuiEntry)>::new();
for ((lo, hi), value) in &self.database {
if query >= lo && query <= hi {
results.push(((*lo, *hi), value.clone()));
}
}
if results.len() > 2 {
return Err(format_err!(
"more than two oui matches - possible database error? {:?}",
results
));
}
match results.pop() {
Some(oui_res) => Ok(Some(oui_res.1)),
_ => Ok(None),
}
}
}
fn mac_to_u64(mac: &MacAddress) -> Result<u64, Error> {
let mac_bytes = mac.as_bytes();
let padded = vec![
0,
0,
mac_bytes[0],
mac_bytes[1],
mac_bytes[2],
mac_bytes[3],
mac_bytes[4],
mac_bytes[5],
];
let mut padded_mac = &padded[..8];
let mac_num = padded_mac.read_u64::<NetworkEndian>().context(format!(
"could not read_u64 from padded MAC byte array: {:?}",
padded_mac
))?;
Ok(mac_num)
}
fn create_oui_db_from_file(dbfile: &str) -> Result<OuiMap, Error> {
let file = File::open(dbfile).context(format!("could not open database file: {}", dbfile))?;
let re = Regex::new("[\t]+").context("could not compile regex")?;
let mut vendor_data = OuiMap::new();
for line in BufReader::new(file).lines() {
let entry = line.context("could not get data line")?;
if !(entry.starts_with('#') || entry.is_empty()) {
let data = re.replace_all(&entry, "|");
let fields_raw: Vec<&str> = data.split('|').collect();
let fields_cleaned: Vec<_> = fields_raw
.into_iter()
.map(|field| {
let f = field.replace('#', "");
f.trim().to_owned()
})
.collect();
if !(fields_cleaned.len() >= 2 && fields_cleaned.len() <= 4) {
return Err(format_err!(
"unexpected number of fields extracted: {:?}",
fields_cleaned
));
}
let mut mask: u8;
let oui_and_mask: Vec<_> = fields_cleaned[0].split('/').collect();
match oui_and_mask.len() {
1 => mask = 24,
2 => {
mask = u8::from_str_radix(&oui_and_mask[1], 10)
.context(format!("could not parse mask: {}", &oui_and_mask[1]))?;
if !(mask >= 8 && mask <= 48) {
return Err(format_err!("incorrect mask value: {}", mask));
}
}
_ => {
return Err(format_err!(
"invalid number of mask separators: {:?}",
oui_and_mask
))
}
};
let oui = oui_and_mask[0]
.to_owned()
.to_uppercase()
.replace(":", "")
.replace("-", "")
.replace(".", "");
let oui_int = u64::from_str_radix(&oui, 16)
.context(format!("could not parse stripped OUI: {}", oui))?;
let mut oui_start: u64;
if mask == 24 {
oui_start = oui_int << 24;
} else {
oui_start = oui_int
};
let oui_end: u64 = oui_start | 0xFFFF_FFFF_FFFF >> mask;
let mut comment: Option<String>;
if fields_cleaned.len() == 4 {
comment = Some(fields_cleaned[3].to_owned())
} else {
comment = None
}
let mut name_long: Option<String>;
if fields_cleaned.len() >= 3 {
name_long = Some(fields_cleaned[2].to_owned())
} else {
name_long = None
}
let mut name_short: String = fields_cleaned[1].to_owned();
let entry_data = OuiEntry {
name_short,
name_long,
comment,
};
trace!(
"Inserting entry for vendor: Range {}-{} is {:?}",
oui_start,
oui_end,
entry_data
);
vendor_data.insert((oui_start, oui_end), entry_data);
};
}
Ok(vendor_data)
}