get-oui(1)

1GET-OUI(1)                  General Commands Manual                 GET-OUI(1)
2
3
4

NAME

6       get-oui - Fetch the arp-scan OUI file from the IEEE website
7

SYNOPSIS

9       get-oui [options]
10

DESCRIPTION

12       get-oui  fetches the Ethernet OUI file from the IEEE website, and saves
13       it in the format used by arp-scan.
14
15       The OUI file contains all of the OUIs (Organizationally Unique  Identi‐
16       fiers) that have been registered with IEEE.  Each OUI entry in the file
17       specifies the first 24-bits of the 48-bit  Ethernet  hardware  address,
18       leaving  the remaining 24-bits for use by the registering organisation.
19       For example the OUI entry "080020",  registered  to  Sun  Microsystems,
20       applies  to  any  Ethernet  hardware  address from 08:00:20:00:00:00 to
21       08:00:20:ff:ff:ff inclusive.  Each OUI assignment represents a total of
22       2^24 (16,777,216) Ethernet addresses.
23
24       Every  major Ethernet hardware vendor registers an OUI for their equip‐
25       ment, and larger vendors will need to  register  more  than  one.   For
26       example,  3Com have a total of 37 OUI entries.  Organisations that only
27       produce a small number of Ethernet devices will  often  obtain  an  IAB
28       registration instead.  See get-iab(1) for details.
29
30       This script can be used to update the arp-scan OUI file from the latest
31       data on the IEEE website.  Most of the Ethernet addresses in use belong
32       to an OUI registration, so this is the most important of the files that
33       arp-scan uses to decode Ethernet hardware addresses.  You should there‐
34       fore run get-oui occasionally to keep the arp-scan OUI file up to date.
35
36       The    OUI   data   is   fetched   from   the   URL   http://standards-
37       oui.ieee.org/oui/oui.txt and the output file is saved to the file ieee-
38       oui.txt in the current directory. The URL to fetch the data from can be
39       changed with the -u option, and the output file  name  can  be  changed
40       with the -f option.
41
42       The  ieee-oui.txt  file that is produced by this script is used by arp-
43       scan to determine the Ethernet card vendor from its hardware address.
44
45       The directory that arp-scan will look for the ieee-oui.txt file depends
46       on  the  options  used  when  it  was built.  If it was built using the
47       default options, then it will look in /usr/local/share/arp-scan.
48

OPTIONS

50       -h     Display a brief usage message and exit.
51
52       -f <fn>
53              Write the output to the specified file instead  of  the  default
54              ieee-oui.txt.
55
56       -u <URL>
57              Use  the specified URL to fetch the raw OUI data from instead of
58              the default http://standards-oui.ieee.org/oui/oui.txt.
59
60       -v     Display verbose progress messages.
61

FILES

63       ieee-oui.txt
64              The default output file.
65

EXAMPLES

67       $ get-oui -v
68       Renaming ieee-oui.txt to ieee-oui.txt.bak
69       Fetching OUI data from http://standards-oui.ieee.org/oui/oui.txt
70       Fetched 3467133 bytes
71       Opening output file ieee-oui.txt
72       22402 OUI entries written to file ieee-oui.txt
73

NOTES

75       get-oui is implemented in Perl, so you need to  have  the  Perl  inter‐
76       preter installed on your system to use it.
77
78       get-oui  uses the LWP::UserAgent Perl module to fetch the data from the
79       IEEE website. You must have this module installed on your system for it
80       to  work.  This module is available on most distributions, often called
81       libwww-perl.  It is also available in source form from CPAN.
82
83       You can use a proxy server by defining the http_proxy environment vari‐
84       able.
85

AUTHOR

87       Roy Hills <Roy.Hills@nta-monitor.com>
88