oui

Documentation

Overview

Copyright © 2023 Mikael Schultz <bitcanon@proton.me>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index

• func DownloadDatabase(w io.Writer, url string) error
• func GetDefaultDatabasePath() string
• func UpdateDatabase(csvFile string) error
• type FilterOptions
• type Oui
  • func (o *Oui) Contains(s string) bool
• type OuiDb
  • func LoadDatabase(r io.Reader) (*OuiDb, error)
  • func (db *OuiDb) FindAllVendors(s string, f FilterOptions) (*OuiDb, error)
  • func (db *OuiDb) FindOuiByAssignment(assignment string) *Oui
  • func (db *OuiDb) Len() int
  • func (db *OuiDb) Less(i, j int) bool
  • func (db *OuiDb) Swap(i, j int)

Functions

func DownloadDatabase

func DownloadDatabase(w io.Writer, url string) error

DownloadDatabase downloads the OUI database from the specified URL and writes it to the specified writer.

func GetDefaultDatabasePath

func GetDefaultDatabasePath() string

GetDefaultDatabasePath returns the path to the OUI database file based on the operating system: Windows: %LOCALAPPDATA%\Mactool\oui.csv Unix: $HOME/.local/share/mactool/oui.csv

func UpdateDatabase

func UpdateDatabase(csvFile string) error

UpdateDatabase checks if the OUI database file exists and downloads it if it doesn't. The CSV file is downloaded from the URL specified in the configuration file. If the URL is not specified, the default URL is used.

Types

type FilterOptions

type FilterOptions struct {
	Assignment   bool
	Organization bool
	Address      bool
}

FilterOptions represents a set of search options. If all are false, no filter is applied, and searches all fields.

type Oui

type Oui struct {
	Assignment   string // The OUI assignment (for example "1A2B3C")
	Organization string // The organization name
	Address      string // The organization street address
}

Oui represents an OUI entry in the database

func (*Oui) Contains

func (o *Oui) Contains(s string) bool

Contains returns true if the OUI entry contains the specified string in any of the OUI fields. The search is case-insensitive.

type OuiDb

type OuiDb struct {
	// The OUI database
	Entries []Oui
}

The OUI database

func LoadDatabase

func LoadDatabase(r io.Reader) (*OuiDb, error)

LoadDatabase loads an OUI database in CSV format from the specified reader

func (*OuiDb) FindAllVendors

func (db *OuiDb) FindAllVendors(s string, f FilterOptions) (*OuiDb, error)

FindAllVendors finds all vendors matching the specified string and returns a pointer to a new OUI database containing the results. The search is case-insensitive and gets filtered by the specified filter options. If no filter options are set, the search is performed in all columns.

func (*OuiDb) FindOuiByAssignment

func (db *OuiDb) FindOuiByAssignment(assignment string) *Oui

FindOuiByAssignment finds an OUI entry by the specified OUI assignment and returns a pointer to the entry if found, or nil if not found. The OUI assignment must be in the format "1A2B3C" (uppercase, no separators).

func (*OuiDb) Len

func (db *OuiDb) Len() int

Len returns the number of OUI entries in the database

func (*OuiDb) Less

func (db *OuiDb) Less(i, j int) bool

Less returns true if the OUI entry at index i is less than the OUI entry at index j

func (*OuiDb) Swap

func (db *OuiDb) Swap(i, j int)

Swap swaps the OUI entries at the specified indexes