manuf 0.2.0

Ethernet vendor codes, and well-known MAC addresses
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

//! `rust-manuf` is a rust library provides Ethernet vendor codes, and well-known MAC addresses.
//!
//! ## Example
//!
//! ```rust
//! #[macro_use]
//! extern crate manuf;
//!
//! fn main() {
//!     assert_eq!(
//!         manuf::vendor([0x8c, 0x85, 0x90, 0x0b, 0xcb, 0x9e]),
//!         Some(("Apple", "Apple, Inc."))
//!     );
//!
//!     assert!(
//!         manuf::prefix("Apple")
//!             .any(|prefix| prefix == ([0x8c, 0x85, 0x90, 0x00, 0x00, 0x00], 24))
//!     );
//! }
//! ```
mod parse;

pub use crate::parse::{parse, EtherAddr, ETHER_ADDR_LEN};

use byteorder::{ByteOrder, NetworkEndian};

include!(concat!(env!("OUT_DIR"), "/vendors.rs"));

/// Find vendor name and description base on an ethernet (MAC) address.
///
/// ## Example
///
/// ```rust
/// assert_eq!(
///     manuf::vendor([0x8c, 0x85, 0x90, 0x0b, 0xcb, 0x9e]),
///     Some(("Apple", "Apple, Inc."))
/// );
/// ```
pub fn vendor(addr: EtherAddr) -> Option<(&'static str, &'static str)> {
    match VENDORS.binary_search_by_key(&addr, |&((prefix, _), _)| prefix) {
        Ok(idx) => Some(VENDORS[idx].1),
        Err(idx) if idx > 0 => {
            let ((prefix, mask), vendor) = VENDORS[idx - 1];

            if NetworkEndian::read_uint(&addr, ETHER_ADDR_LEN) & mask
                == NetworkEndian::read_uint(&prefix, ETHER_ADDR_LEN)
            {
                Some(vendor)
            } else {
                None
            }
        }
        _ => None,
    }
}

/// Find vendor's prefix and mask for the ethernet (MAC) address.
///
/// ## Example
///
/// ```rust
/// assert!(
///     manuf::prefix("Apple")
///         .any(|prefix| prefix == ([0x8c, 0x85, 0x90, 0x00, 0x00, 0x00], 24))
/// );
/// ```
pub fn prefix<S: AsRef<str>>(s: S) -> impl Iterator<Item = (EtherAddr, u32)> {
    VENDORS
        .iter()
        .filter(move |(_, (name, _))| *name == s.as_ref())
        .map(|&((prefix, prefix_max), _)| (prefix, prefix_max.count_ones()))
}

#[cfg(test)]
mod tests {
    use std::time::{SystemTime, UNIX_EPOCH};

    use super::*;

    #[test]
    fn test_vendor() {
        assert!(!VENDORS.is_empty());
        assert_eq!(
            vendor([0x8c, 0x85, 0x90, 0x0b, 0xcb, 0x9e]),
            Some(("Apple", "Apple, Inc."))
        );
        assert_eq!(
            vendor([0x00, 0x00, 0x00, 0x00, 0x00, 0x00]),
            Some((
                "00:00:00",
                "Officially Xerox, but 0:0:0:0:0:0 is more common"
            ))
        );
        assert_eq!(
            vendor([0xFC, 0xFF, 0xAA, 0x11, 0x22, 0x33]),
            Some(("IEEERegi", "IEEE Registration Authority"))
        );
        assert_eq!(
            vendor([0x50, 0x50, 0x2a, 0x00, 0x00, 0x00]),
            Some(("Egardia", ""))
        );
        assert_eq!(vendor([0x0a, 0x00, 0x27, 0x00, 0x00, 0x00]), None);

        for &((prefix, prefix_mask), (name, desc)) in VENDORS {
            if name == "IEEERegi" {
                continue;
            }

            assert_eq!(vendor(prefix), Some((name, desc)));

            let mut addr = [0; ETHER_ADDR_LEN];

            NetworkEndian::write_uint(
                &mut addr,
                NetworkEndian::read_uint(&prefix, ETHER_ADDR_LEN)
                    + u64::from(
                        SystemTime::now()
                            .duration_since(UNIX_EPOCH)
                            .unwrap()
                            .subsec_nanos(),
                    ) % (1 << (ETHER_ADDR_LEN * 8 - prefix_mask.count_ones() as usize)),
                ETHER_ADDR_LEN,
            );

            assert_eq!(vendor(addr), Some((name, desc)));
        }
    }

    #[test]
    fn test_prefix() {
        assert!(prefix("Apple").any(|prefix| prefix == ([0x8c, 0x85, 0x90, 0x00, 0x00, 0x00], 24)));
        assert_eq!(
            prefix("00:00:00").collect::<Vec<_>>(),
            vec![([0x00, 0x00, 0x00, 0x00, 0x00, 0x00], 24)]
        );
        assert!(
            prefix("IEEERegi").any(|prefix| prefix == ([0xFC, 0xFF, 0xAA, 0x00, 0x00, 0x00], 24))
        );

        for &((data, mask), (name, _)) in VENDORS {
            assert!(prefix(name).any(|prefix| prefix == (data, mask.count_ones())));
        }
    }
}