initial commit

NetworkJack2 · NetworkJack2 · commit 48fdeb990c4c · 2019-12-08T23:54:05.000-05:00
diff --git a/README.md b/README.md
@@ -0,0 +1,18 @@
+Python-generate_mac
+===================
+
+Python class for Generating Ethernet MAC addresses. Can use the wireshark manuf
+for specific vendors, and or a random, but assigned address. Will work with
+any file formated the same as said file.
+
+Supported functions:
+
+**total_random()** - Procedurely generated MAC address, using random function.
+
+**vid_file_random(_file_)** - uses random line from wireshark's manuf file
+
+**vid_file_vendor(_file, name_)** - specify a vendor name, uses wireshark's manuf file
+instead of being completely random
+
+**vid_provided(_vid bytes_)** - specify the VID bytes when calling the function.
+Random device bytes will be generated.
diff --git a/generate_mac/__init__.py b/generate_mac/__init__.py
@@ -0,0 +1,190 @@
+#!/usr/bin/env python3
+
+import random
+import string
+
+class generate_mac():
+    '''MAC address generation class'''
+    _valid_char = "0123456789ABCDEF"
+    _valid_bcast_char = "02468ACE"
+    _valid_vendors = set()
+    _vid_table = {
+    '36':2,
+    '32':3,
+    '28':4,
+    'none':6,
+    }
+    def _strip_comments(in_list):
+        '''Proccesses out comments using # as the comment character'''
+        file_lines = []
+        for line in in_list:
+            line=line.strip()
+            if not line.startswith("#") and line != "":
+                file_lines.append(line.split("#")[0])
+        return(file_lines)
+    
+    def _read_vid_file(vid_file):
+        '''Reads a VID file and returns a list nested list of line contents'''
+        ''' Every line is [MAC,Vendor,Comment]'''
+        out_lines = []
+        try:
+            in_file    = open(vid_file,"r")
+            file_lines = in_file.readlines()
+            in_file.close()
+        except FileNotFoundError:
+            raise FileNotFoundError("ERROR: Cannot read VID file " + in_file)
+
+        # Sanitize inputs
+        file_lines = generate_mac._strip_comments(file_lines)
+
+        # Generate a list of lines which are split into a list, make a set of
+        # vendors
+        for line in file_lines:
+            line   = line.split('\t')
+            try:
+                vendor = line[1]
+                generate_mac._valid_vendors.add(vendor)
+            except:
+                continue
+            out_lines.append(line)
+        # delete the first line which is 00:00:00, by Xerox. Malformed, and
+        # unlikely to be in use with modern equipment
+        del(file_lines[0])
+
+        return out_lines
+
+    def _get_processed_vid(in_line):
+        '''Returns a formated tupple with MAC info (prefix,bytes_needed,vendor,description)'''
+
+        # Start with the items that don't need transforms
+        vendor         = in_line[1]
+        try:
+           description = in_line[2]
+        except:
+           description = ""
+
+        # prefix or raw VID bytes
+        prefix = in_line[0].split('/')[0]
+        suffix = ''
+        # get the suffix. It is either going to be 36, 28 or none.
+        try:
+           suffix = in_line[0].split('/')[1]
+        except:
+           suffix = 'none'
+
+        bytes_needed = generate_mac._vid_table[suffix]
+
+        # Generate the string returned
+        out_vid = ''
+        if suffix == 'none':
+            out_vid = prefix
+        else:
+            # Cut down the trailing zeros so random data can be generated in that
+            # space
+            prefix_size  = ( 12 - bytes_needed ) // 2
+            prefix = prefix.split(':')
+            prefix = prefix[0:prefix_size]
+            prefix = ":".join(prefix)
+            out_vid = prefix
+
+        return prefix,bytes_needed,vendor,description
+
+    def _gen_rand_bytes(bytes_needed):
+        '''Generate X amount of random bytes, seperated by a :'''
+        out_bytes    = []
+        rand_byte    = ""
+        for i in range(bytes_needed):
+            rand_byte = random.choice(generate_mac._valid_char) + random.choice(generate_mac._valid_char)
+            out_bytes.append(rand_byte)
+        out_bytes    = ":".join(out_bytes)
+        return out_bytes
+        
+    def _is_byte(test_byte):
+        '''Tests if a string is a hexdecimal byte, returns True/False'''
+        test_byte = test_byte.strip(":")
+        # If a byte does not convert from hex, its not a byte
+        try:
+            test_byte = int(test_byte,16)
+        except:
+            return False
+        # If the value is out of range for a single byte, it is not
+        if  0 < test_byte > 255:
+            return False
+        #If we get to the end, its a byte
+        return True
+
+    def total_random():
+        '''Generates a completely random mac'''
+        # An odd number in the first Digit is multi-cast and invalid for
+        # assignment
+        first_byte = random.choice(generate_mac._valid_char) + random.choice(generate_mac._valid_bcast_char)
+
+        # the rest are random hexdecimal values
+        five_bytes = generate_mac._gen_rand_bytes(5)
+        out_mac = first_byte + ":" + five_bytes
+        return out_mac
+ 
+    def vid_file_random(vid_file):
+        '''Generates a MAC with random vendor bytes read from a the wireshark manuf file'''
+        file_lines = generate_mac._read_vid_file(vid_file)
+
+        # Get a random line from the file
+        rand_line = file_lines[ random.randrange( len(file_lines) ) ]
+        # Get the MAC address from the line
+        rand_line = generate_mac._get_processed_vid(rand_line)
+        vid_bytes = rand_line[0]
+
+        # Now generate the random device bytes
+        bytes_needed = rand_line[1] //2
+        dev_bytes    = generate_mac._gen_rand_bytes(bytes_needed)
+
+        output = vid_bytes + ":" + dev_bytes
+        return(output)
+        
+    def vid_file_vendor(vid_file,vendor):
+        '''Generates a random MAC from a specified vendor name'''
+        file_lines = generate_mac._read_vid_file(vid_file)
+        # Get a random VID assigned to Apple Inc
+        line_vendor = ""
+        vid_bytes   = ""
+        descrption  = ""
+        rand_line   = ""
+        if vendor not in generate_mac._valid_vendors:
+            raise KeyError(vendor + " has no associated VID byte in manuf file")
+        while line_vendor != vendor:
+            # Get a random line from the file, and then proccess
+            rand_line    = file_lines[ random.randrange( len(file_lines) ) ]
+            rand_line    = generate_mac._get_processed_vid(rand_line)
+            # Fill in the blanks
+            vid_bytes    = rand_line[0]
+            bytes_needed = rand_line[1]
+            line_vendor  = rand_line[2]
+            description  = rand_line[3]
+
+        # Now generate the random device bytes
+        bytes_needed = rand_line[1] //2
+        dev_bytes    = generate_mac._gen_rand_bytes(bytes_needed)
+
+        output = vid_bytes + ":" + dev_bytes
+        return output
+
+    def vid_provided(vid_bytes):
+        '''Generates only the Device bytes, given specified VID bytes'''
+        test_vid = []
+        i = ""
+        rand_bytes = ""
+        output = ""
+        ## Start with error checking
+        #remove any trailing :
+        vid_bytes = vid_bytes.rstrip(":")
+        test_vid = vid_bytes.split(":")
+        # If there aren't precisely three bytes, its not a VID
+        if len(test_vid) != 3:
+            raise ValueError(vid_bytes + ' are not valid VID bytes')
+        for i in test_vid:
+            if generate_mac._is_byte(i) == False:
+                raise ValueError(vid_bytes + ' are not valid VID bytes')
+        
+        rand_bytes = generate_mac._gen_rand_bytes(3)
+        output = vid_bytes + ":" + rand_bytes
+        return output
diff --git a/generate_mac/__pycache__/__init__.cpython-38.pyc b/generate_mac/__pycache__/__init__.cpython-38.pyc
diff --git a/setup.py b/setup.py
@@ -0,0 +1,22 @@
+import setuptools
+
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
+setuptools.setup(
+    name="python-generate_mac",
+    version="1.0.0",
+    author="GI_Jack",
+    author_email="GI_Jack@example.com",
+    description="Library for generating Ethernet MAC addresses",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/GIJack/python-generate_mac",
+    packages=setuptools.find_packages(),
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+        "Operating System :: OS Independent",
+    ],
+    python_requires='>=3.0',
+)
