Update of dependencies and improvements for Debian based distros

Changes:
 * Add support for FreeBSD
 * Updated go.mod files
 * Improved logger.go
 * Updated dependencies
 * Fixed systemd service for Debian based distributions
 * Various other improvements

Author: 4ndyZ

.github/workflows/release.yml

@@ -1,9 +1,8 @@
 name: "Release"
 
 on:
-  create:
-    tags:
-      - v*
+  pull_request:
+  push:
 
 jobs:
   build:

.goreleaser.yaml

@@ -4,6 +4,7 @@ builds:
       - linux
       - windows
       - darwin
+      - freebsd
     goarch:
       - amd64
       - arm64
@@ -27,7 +28,7 @@ nfpms:
     homepage: https://github.com/4ndyZ/MAC-API
     file_name_template: "{{ tolower .ProjectName }}-{{ tolower .Tag }}.{{ .Os }}.{{ tolower .Arch }}"
     license: GPL-3.0
-    # Build as deb for Debian based distors and rpm for RedHat based distros
+    # Build as deb for Debian based distributions and rpm for RedHat based distributions
     formats:
       - deb
       - rpm
@@ -41,8 +42,12 @@ nfpms:
           owner: root
           group: mac-api
       # Systemd service file
-      - src: service/service.service
+      - src: service/service_deb.service
         dst: /usr/lib/systemd/system/mac-api.service
+        packager: deb
+      - src: service/service_rpm.service
+        dst: /usr/lib/systemd/system/mac-api.service
+        packager: rpm
     # Install and remove scripts
     scripts:
       preinstall: "scripts/preinstall.sh"

LICENSE

@@ -632,7 +632,7 @@ state the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
 
     MAC-API
-    Copyright (C) 2021-2022 AndyZ (AndyCraftz)
+    Copyright (C) 2021-2022 Andreas Seidl <AndyZ>
 
     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -652,7 +652,7 @@ Also add information on how to contact you by electronic and paper mail.
   If the program does terminal interaction, make it output a short
 notice like this when it starts in an interactive mode:
 
-    MAC-API Copyright (C) 2021-2022 AndyZ (AndyCraftz)
+    MAC-API Copyright (C) 2021-2022 Andreas Seidl <AndyZ>
     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
     This is free software, and you are welcome to redistribute it
     under certain conditions; type `show c' for details.

README.md

@@ -1,7 +1,7 @@
 # MAC-API
 This projects provides an easy to deploy API to lookup up MAC-Vendors using the MAC address or OUI.
 
-The API provides a fast webserver written in Golang as API endpoint. The service is getting the data from the offical IEEE MAC address assignment.
+The API provides a fast webserver written in Golang as API endpoint. The service is getting the data from the official IEEE MAC address assignment.
 
 ## Function
 The API provides two endpoints for requests. The first one `/v1/oui` provides information about Vendor OUIs. The seconds one `/v1/mac` provides information about a MAC address
@@ -53,7 +53,7 @@ Content-Length: 130
 ```
 
 ## Prerequisites
-It is recommend to have a server where you can deploy the API, but it is also possible to start the microservice manually on a local machine.
+It is recommended to have a server where you can deploy the API, but it is also possible to start the microservice manually on a local machine.
 
 ## Installation and configuration
 Download the prebuilt binary packages from the [release page](https://github.com/4ndyZ/MAC-API/releases) and install them on your server.
@@ -82,23 +82,23 @@ Now you are able to install the package.
 
 After installing the package configure the API. The configuration file is located under `/etc/mac-api/config.yml`.
 
-No you you are able to enable the Systemd service using `systemctl`.
+Now you are able to enable the Systemd service using `systemctl`.
 `sudo systemctl enable mac-api`
 
 And start the service also using `systemctl`.
 `sudo systemctl start mac-api`
 
 #### Windows/Other
-If you plan to run the API on Windows or another OS the whole process is a bit more complicated because there is no installation package avaible only prebuilt binaries.
+If you plan to run the API on Windows or another OS the whole process is a bit more complicated because there is no installation package available only prebuilt binaries.
 
 Download the prebuilt binary for your operating system.
 
-Exctract the prebuilt binary and change the configuration file located under `config/config.conf`.
+Extract the prebuilt binary and change the configuration file located under `config/config.conf`.
 
 After successful changing the configuration file you are able to run the prebuilt binary.
 
 ### Configuration
-The API tries to access the configuration file located under `/etc/mac-api/config.conf`. It the configuration file is not accessable or found the API will fallback to the local file located unter `config/config.conf`.
+The API tries to access the configuration file located under `/etc/mac-api/config.conf`. If the configuration file is not accessible or found the API will fall back to the local file located under `config/config.conf`.
 
 ### Logging
 The API while try to put the log file in the `/var/log/mac-api` folder. If the service is not able to access or find that folder, the logging file gets created in the local folder `logs`.

app.go

@@ -55,7 +55,6 @@ func (a *App) Refresh() {
 func (a *App) Run() {
 
 	ctx, cancel := context.WithCancel(context.Background())
-
 	httpServer := &http.Server{
 		Addr:        *a.address,
 		Handler:     a.router,
@@ -88,8 +87,6 @@ func (a *App) Run() {
 		Log.Logger.Info().Msg("API Webserver stopped.")
 		cancel()
 		Log.Logger.Info().Msg("API stopped.")
-		// Rotate log file
-		Log.Rotate()
 		// Exit
 		os.Exit(1)
 	}()

go.mod

@@ -1,12 +1,18 @@
 module github.com/4ndyZ/MAC-API/m/v2
 
-go 1.17
+go 1.18
 
 require (
 	github.com/gorilla/mux v1.8.0
-	github.com/rs/zerolog v1.26.1
+	github.com/rs/zerolog v1.27.0
 	gopkg.in/natefinch/lumberjack.v2 v2.0.0
-	gopkg.in/yaml.v2 v2.4.0
+	gopkg.in/yaml.v3 v3.0.1
 )
 
-require github.com/BurntSushi/toml v0.3.1 // indirect
+require (
+	github.com/BurntSushi/toml v1.1.0 // indirect
+	github.com/mattn/go-colorable v0.1.12 // indirect
+	github.com/mattn/go-isatty v0.0.14 // indirect
+	golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6 // indirect
+	gopkg.in/yaml.v2 v2.4.0 // indirect
+)

go.sum

@@ -1,42 +1,25 @@
-github.com/BurntSushi/toml v0.3.1 h1:WXkYYl6Yr3qBf1K79EBnL4mak0OimBfB0XUf9Vl28OQ=
-github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
-github.com/coreos/go-systemd/v22 v22.3.2/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc=
+github.com/BurntSushi/toml v1.1.0 h1:ksErzDEI1khOiGPgpwuI7x2ebx/uXQNw7xJpn9Eq1+I=
+github.com/BurntSushi/toml v1.1.0/go.mod h1:CxXYINrC8qIiEnFrOxCa7Jy5BFHlXnUU2pbicEuybxQ=
+github.com/coreos/go-systemd/v22 v22.3.3-0.20220203105225-a9a7ef127534/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc=
 github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
 github.com/gorilla/mux v1.8.0 h1:i40aqfkR1h2SlN9hojwV5ZA91wcXFOvkdNIeFDP5koI=
 github.com/gorilla/mux v1.8.0/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So=
+github.com/mattn/go-colorable v0.1.12 h1:jF+Du6AlPIjs2BiUiQlKOX0rt3SujHxPnksPKZbaA40=
+github.com/mattn/go-colorable v0.1.12/go.mod h1:u5H1YNBxpqRaxsYJYSkiCWKzEfiAb1Gb520KVy5xxl4=
+github.com/mattn/go-isatty v0.0.14 h1:yVuAays6BHfxijgZPzw+3Zlu5yQgKGP2/hcQbHb7S9Y=
+github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94=
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/rs/xid v1.3.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg=
-github.com/rs/zerolog v1.26.1 h1:/ihwxqH+4z8UxyI70wM1z9yCvkWcfz/a3mj48k/Zngc=
-github.com/rs/zerolog v1.26.1/go.mod h1:/wSSJWX7lVrsOwlbyTRSOJvqRlc+WjWlfes+CiJ+tmc=
-github.com/yuin/goldmark v1.4.0/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k=
-golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
-golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
-golang.org/x/crypto v0.0.0-20211215165025-cf75a172585e/go.mod h1:P+XmwS30IXTQdn5tA2iutPOUgjI07+tq3H3K9MVA1s8=
-golang.org/x/mod v0.4.2/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
-golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
-golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
-golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
-golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
-golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
-golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
-golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
-golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
-golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
-golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
-golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
-golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
-golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
-golang.org/x/tools v0.1.7/go.mod h1:LGqMHiF4EqQNHR1JncWGqT5BVaXmza+X+BDGol+dOxo=
-golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
-golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
-golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+github.com/rs/zerolog v1.27.0 h1:1T7qCieN22GVc8S4Q2yuexzBb1EqjbgjSH9RohbMjKs=
+github.com/rs/zerolog v1.27.0/go.mod h1:7frBqO0oezxmnO7GF86FY++uy8I0Tk/If5ni1G9Qc0U=
+golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6 h1:foEbQz/B0Oz6YIqu/69kfXPYeFQAuuMYFkjaqXzl5Wo=
+golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/natefinch/lumberjack.v2 v2.0.0 h1:1Lc07Kr7qY4U2YPouBjpCLxpiyxIVoxqXgkXLknAOE8=
 gopkg.in/natefinch/lumberjack.v2 v2.0.0/go.mod h1:l0ndWWf7gzL7RNwBG7wST/UCcT4T24xpD6X8LsfU/+k=
 gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
 gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

handler.go

@@ -48,7 +48,7 @@ func (a *App) ParseMACData(body *[][]string) ([]OUI, error) {
 func (a *App) GetOUI(w http.ResponseWriter, r *http.Request) {
 	input := strings.ToUpper((mux.Vars(r))["oui"]) // Convert OUI to upper case
 
-	// Remove all non HEX chars
+	// Remove all non-HEX chars
 	reg, _ := regexp.Compile("[^0-9A-F]+")
 	request := reg.ReplaceAllString(input, "")
 
@@ -76,7 +76,7 @@ func (a *App) GetOUI(w http.ResponseWriter, r *http.Request) {
 func (a *App) GetMAC(w http.ResponseWriter, r *http.Request) {
 	input := strings.ToUpper((mux.Vars(r))["mac"]) // Convert OUI to upper case
 
-	// Remove all non HEX chars
+	// Remove all non-HEX chars
 	reg := regexp.MustCompile("[^0-9A-F]+")
 	request := reg.ReplaceAllString(input, "")
 
@@ -120,7 +120,10 @@ func (a *App) respondWithJSON(w http.ResponseWriter, code int, payload interface
 
 	w.Header().Set("Content-Type", "application/json")
 	w.WriteHeader(code)
-	w.Write(response)
+	_, err := w.Write(response)
+	if err != nil {
+		return
+	}
 }
 
 // Send a JSON error message

logger.go

@@ -21,9 +21,9 @@ func (l *Logger) Initialize(f string) {
 	// Create file writer
 	fileWriter := &lumberjack.Logger{
 		Filename:   f,
-		MaxSize:    100, // Megabytes
-		MaxBackups: 3,
-		MaxAge:     28, // Days: true
+		MaxSize:    10, // Megabytes
+		MaxBackups: 5,
+		MaxAge:     28, // Days
 		LocalTime:  true,
 	}
 	multi := zerolog.MultiLevelWriter(consoleWriter, fileWriter)
@@ -48,11 +48,3 @@ func (l *Logger) EnableDebug(debug bool) {
 		}
 	}
 }
-
-// Rotate log file
-func (l *Logger) Rotate() {
-	err := l.fileWriter.Rotate()
-	if err != nil {
-		Log.Logger.Warn().Str("error", err.Error()).Msg("Unable to rotate log file.")
-	}
-}

main.go

@@ -2,13 +2,13 @@ package main
 
 import (
 	"flag"
-	"gopkg.in/yaml.v2"
+	"gopkg.in/yaml.v3"
 	"io/ioutil"
 	"os"
 	"strings"
 )
 
-var Log Logger = Logger{}
+var Log = Logger{}
 
 func main() {
 	// Create configuration object
@@ -67,7 +67,6 @@ func main() {
 	if configuration.Logging.Debug {
 		Log.EnableDebug(true)
 	}
-
 	// Create app worker
 	a := App{}
 	a.Initialize("http://standards-oui.ieee.org/oui/oui.csv", configuration.Address, configuration.TimeInterval)

service/service_deb.service

@@ -0,0 +1,23 @@
+[Unit]
+Description=MAC-API Service
+ConditionPathExists=/usr/bin/mac-api
+After=network.target
+StartLimitIntervalSec=60
+
+[Service]
+Type=simple
+User=mac-api
+Group=mac-api
+
+Restart=on-failure
+RestartSec=10
+
+ExecStart=/usr/bin/mac-api
+
+# Make sure log directory exists
+ExecStartPre=+/bin/mkdir -p /var/log/mac-api
+ExecStartPre=+/bin/chown mac-api:mac-api /var/log/mac-api
+ExecStartPre=+/bin/chmod 0744 /var/log/mac-api
+
+[Install]
+WantedBy=multi-user.target

service/service.service renamed to service/service_rpm.service

@@ -2,6 +2,7 @@
 Description=MAC-API Service
 ConditionPathExists=/usr/local/bin/mac-api
 After=network.target
+StartLimitIntervalSec=60
 
 [Service]
 Type=simple
@@ -10,15 +11,13 @@ Group=mac-api
 
 Restart=on-failure
 RestartSec=10
-startLimitIntervalSec=60
 
 ExecStart=/usr/local/bin/mac-api
 
 # Make sure log directory exists
-PermissionsStartOnly=true
-ExecStartPre=/bin/mkdir -p /var/log/mac-api
-ExecStartPre=/bin/chown mac-api:mac-api /var/log/mac-api
-ExecStartPre=/bin/chmod 0744 /var/log/mac-api
+ExecStartPre=+/bin/mkdir -p /var/log/mac-api
+ExecStartPre=+/bin/chown mac-api:mac-api /var/log/mac-api
+ExecStartPre=+/bin/chmod 0744 /var/log/mac-api
 
 [Install]
 WantedBy=multi-user.target