Update github/codeql-action action to v3 (#33)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

.deepsource.toml

@@ -0,0 +1,8 @@
+version = 1
+
+[[analyzers]]
+name = "go"
+enabled = true
+
+  [analyzers.meta]
+  import_root = "github.com/luketainton/iPilot"

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,58 @@
+---
+name: "Bug Report"
+description: "Submit a bug report"
+labels: ["bug"]
+assignees: ["luketainton"]
+body:
+  - type: checkboxes
+    id: checks
+    attributes:
+      label: First Check
+      description: Please confirm and check all the following options.
+      options:
+        - label: This is not a feature request
+          required: true
+        - label: I added a descriptive title to this issue.
+          required: true
+        - label: I used the GitHub search to find a similar issue and didn't find one.
+          required: true
+  - type: input
+    id: ipilot-version
+    attributes:
+      label: iPilot Version
+    validations:
+      required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: What is the issue you are experiencing?
+      placeholder: A clear and concise description of what the bug is.
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction
+    attributes:
+      description: If you do not provide a way to reproduce the issue, your issue will likely be closed.
+      label: How can the maintainer reproduce the issue?
+      placeholder: A clear step-by-step guide on how to reproduce the issue.
+    validations:
+      required: true
+  - type: dropdown
+    id: os
+    attributes:
+      label: Deployment
+      description: What Deployment system are you using?
+      multiple: true
+      options:
+        - Docker
+        - Native (Windows)
+        - Native (MacOS)
+        - Native (Linux)
+        - Other
+    validations:
+      required: true
+  - type: textarea
+    id: os-details
+    attributes:
+      label: Deployment Details
+      description: You can add more details about your operating system here, in particular if you chose "Other".

.github/workflows/build.yml

@@ -0,0 +1,63 @@
+name: Build
+on:
+  push:
+    tags: '*'
+
+jobs:
+  prepare-data:
+    name: Prepare Data
+    runs-on: ubuntu-latest
+    outputs:
+      tag: ${{ steps.prepare.outputs.SOURCE_TAG }}
+      repo: ${{ steps.prepare.outputs.REPO }}
+      lrepo: ${{ steps.prepare.outputs.LREPO }}
+    steps:
+      - id: prepare
+        name: Prepare environment variables
+        run: |
+          echo ::set-output name=SOURCE_NAME::${GITHUB_REF#refs/*/}
+          echo ::set-output name=SOURCE_BRANCH::${GITHUB_REF#refs/heads/}
+          echo ::set-output name=SOURCE_TAG::${GITHUB_REF#refs/tags/}
+          echo ::set-output name=REPO::${GITHUB_REPOSITORY#luketainton/}
+          echo ::set-output name=LREPO::${GITHUB_REPOSITORY#luketainton/} | tr '[:upper:]' '[:lower:]'
+
+  docker:
+    name: GitHub Package Registry
+    runs-on: ubuntu-latest
+    needs: [prepare-data]
+    steps:
+    - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+    - name: Login to GitHub Package Registry
+      run: echo ${{ secrets.PAT }} | docker login ghcr.io -u luketainton --password-stdin
+    - name: Build image for GitHub Package Registry
+      run: docker build . --file Dockerfile --tag ghcr.io/luketainton/${{ needs.prepare-data.outputs.lrepo }}:${{ needs.prepare-data.outputs.tag }} --tag ghcr.io/luketainton/${{ needs.prepare-data.outputs.lrepo }}:latest
+    - name: Push image to GitHub Package Registry
+      run: |
+        docker push ghcr.io/luketainton/${{ needs.prepare-data.outputs.lrepo }}:latest
+        docker push ghcr.io/luketainton/${{ needs.prepare-data.outputs.lrepo }}:${{ needs.prepare-data.outputs.tag }}
+
+  build:
+    name: Build and Release
+    runs-on: ubuntu-latest
+    needs: [prepare-data]
+    steps:
+    - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+    - name: Build artifacts
+      run: |
+        docker run --rm -w /go/src/app -v ${PWD}:/go/src/app -e CGO_ENABLED=0 -e GOARCH=amd64 -e GOOS=darwin golang:alpine go build -o /go/src/app/${{ needs.prepare-data.outputs.repo }}-${{ needs.prepare-data.outputs.tag }}-darwin-amd64
+        docker run --rm -w /go/src/app -v ${PWD}:/go/src/app -e CGO_ENABLED=0 -e GOARCH=arm64 -e GOOS=darwin golang:alpine go build -o /go/src/app/${{ needs.prepare-data.outputs.repo }}-${{ needs.prepare-data.outputs.tag }}-darwin-arm64
+        docker run --rm -w /go/src/app -v ${PWD}:/go/src/app -e CGO_ENABLED=0 -e GOARCH=amd64 -e GOOS=linux golang:alpine go build -o /go/src/app/${{ needs.prepare-data.outputs.repo }}-${{ needs.prepare-data.outputs.tag }}-linux-amd64
+        docker run --rm -w /go/src/app -v ${PWD}:/go/src/app -e CGO_ENABLED=0 -e GOARCH=amd64 -e GOOS=windows golang:alpine go build -o /go/src/app/${{ needs.prepare-data.outputs.repo }}-${{ needs.prepare-data.outputs.tag }}-win-amd64.exe
+        docker run --rm -w /go/src/app -v ${PWD}:/go/src/app -e CGO_ENABLED=0 -e GOARCH=386 -e GOOS=windows golang:alpine go build -o /go/src/app/${{ needs.prepare-data.outputs.repo }}-${{ needs.prepare-data.outputs.tag }}-win-x86.exe
+    - uses: meeDamian/github-release@v2.0.3
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+        tag: ${{ needs.prepare-data.outputs.tag }}
+        gzip: false
+        files: >
+          ${{ needs.prepare-data.outputs.repo }}-${{ needs.prepare-data.outputs.tag }}-darwin-amd64
+          ${{ needs.prepare-data.outputs.repo }}-${{ needs.prepare-data.outputs.tag }}-darwin-arm64
+          ${{ needs.prepare-data.outputs.repo }}-${{ needs.prepare-data.outputs.tag }}-linux-amd64
+          ${{ needs.prepare-data.outputs.repo }}-${{ needs.prepare-data.outputs.tag }}-win-amd64.exe
+          ${{ needs.prepare-data.outputs.repo }}-${{ needs.prepare-data.outputs.tag }}-win-x86.exe
+

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '18 1 * * 1'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'go' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v3
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v3
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v3

.github/workflows/issues.yml

@@ -0,0 +1,15 @@
+name: Issue assignment
+
+on:
+  issues:
+    types: [opened]
+
+jobs:
+  auto-assign:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Auto-assign issue'
+        uses: pozil/auto-assign-issue@v1
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          assignees: luketainton

.github/workflows/test.yml

@@ -0,0 +1,42 @@
+name: Test
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+  push:
+    branches: [ main ]
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+        with:
+          fetch-depth: 0
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: 1.19
+      - name: Create golangci-lint report
+        run: |
+          curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.42.1
+          $(go env GOPATH)/bin/golangci-lint run --out-format checkstyle -D deadcode,unused --build-tags=integration --timeout 10m --issues-exit-code 0 ./... > report.xml
+          sed -i 's+<file name="+<file name="go/+g' report.xml
+          cat report.xml
+      - name: Test
+        run: go test -short -coverprofile=coverage.out
+        continue-on-error: true
+      - name: SonarCloud Scan
+        uses: SonarSource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN_CLOUD }}
+      # - uses: sonarsource/sonarqube-scan-action@master
+      #   env:
+      #     SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+      #     SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
+      # - uses: sonarsource/sonarqube-quality-gate-action@master
+      #   timeout-minutes: 5
+      #   env:
+      #     SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

.gitignore

@@ -0,0 +1,2 @@
+/.vscode
+/.idea

API.go

@@ -1,26 +1,67 @@
 package main
 
 import (
+	"encoding/json"
+	"fmt"
 	"io/ioutil"
 	"net"
 	"net/http"
+	"os"
+	"sort"
+	"strings"
 )
 
 func getLocalIP() string {
-	resp, _ := http.Get("https://api.ipify.org")
+	resp, err := http.Get("https://api.ipify.org")
+	if err != nil {
+		fmt.Println("FATAL: Cannot get local IP.")
+		os.Exit(2)
+		return ""
+	}
 	body, _ := ioutil.ReadAll(resp.Body)
-	return string(body[:])
+	return string(body)
 }
 
-func checkIPSyntax(ipaddress string) bool {
+func isIPAddress(ipaddress string) bool {
 	addr := net.ParseIP(ipaddress)
-	if addr == nil {
+	return addr != nil
-		return false
-	}
-	return true
 }
 
 func resolveDNSHostname(hostname string) string {
 	address, _ := net.LookupHost(hostname)
 	return address[0]
 }
+
+func getIPInfo(ipaddress string) IPAddressInfo {
+	apiEndpoint := "http://ip-api.com/json/" + ipaddress
+	resp, err := http.Get(apiEndpoint)
+	if err != nil {
+		fmt.Println("FATAL: Cannot contact IP address information API.")
+		os.Exit(3)
+	}
+	body, _ := ioutil.ReadAll(resp.Body)
+	infoString := string(body)
+	var info IPAddressInfo
+	err = json.Unmarshal([]byte(infoString), &info)
+	if err != nil {
+		fmt.Println("FATAL: Cannot serialize recieved IP address data.")
+		os.Exit(4)
+	}
+	return info
+}
+
+func printBGPPrefixes(as string) {
+	apiEndpoint := "https://api.hackertarget.com/aslookup/?q=" + as
+	resp, err := http.Get(apiEndpoint)
+	if err != nil {
+		fmt.Println("FATAL: Cannot contact BGP Prefixes API.")
+		os.Exit(5)
+	}
+	body, _ := ioutil.ReadAll(resp.Body)
+	prefixesString := string(body)
+	var prefixes = strings.Split(prefixesString, "\n")[1:]
+	sort.Strings(prefixes)
+	for index := range prefixes {
+		fmt.Println(prefixes[index])
+	}
+}

Dockerfile

@@ -0,0 +1,10 @@
+FROM golang:1.21-alpine as build
+WORKDIR /go/src/app
+COPY . /go/src/app
+RUN CGO_ENABLED=0 go build -o /go/bin/app
+
+FROM gcr.io/distroless/base-debian10
+LABEL maintainer="Luke Tainton <luke@tainton.uk>"
+LABEL org.opencontainers.image.source="https://github.com/luketainton/iPilot"
+COPY --from=build /go/bin/app /
+CMD ["/app"]

Header.go

@@ -11,4 +11,5 @@ func printHeader() {
 	fmt.Println("|      By Luke Tainton       |")
 	fmt.Println("|        @luketainton        |")
 	fmt.Println("------------------------------")
+	fmt.Println("")
 }

IPInfo.go

@@ -1,10 +1,7 @@
 package main
 
 import (
-	"encoding/json"
 	"fmt"
-	"io/ioutil"
-	"net/http"
 	"strings"
 )
 
@@ -26,26 +23,17 @@ type IPAddressInfo struct {
 	IPAddress    string  `json:"query"`
 }
 
-func getIPInfo(ipaddress string) IPAddressInfo {
+func printIPInfo(input string, wantPrefixes bool) {
-	apiEndpoint := "http://ip-api.com/json/" + ipaddress
-	resp, _ := http.Get(apiEndpoint)
-	body, _ := ioutil.ReadAll(resp.Body)
-	// fmt.Print(string(body))
-	infoString := string(body)
-	var info IPAddressInfo
-	err := json.Unmarshal([]byte(infoString), &info)
-	if err != nil {
-		fmt.Println(err)
-	}
-	return info
-}
-
-func printIPInfo(input string) {
 	var IPInfo IPAddressInfo = getIPInfo(input)
 	var location string = IPInfo.Country + "/" + IPInfo.RegionName + "/" + IPInfo.City
+	var bgpAS string = strings.Fields(IPInfo.AS)[0]
 	fmt.Println("IP Address:	", IPInfo.IPAddress)
 	fmt.Println("Location:	", location)
 	fmt.Println("Timezone:	", IPInfo.Timezone)
 	fmt.Println("ISP:		", IPInfo.ISP)
-	fmt.Println("BGP AS:		", strings.Fields(IPInfo.AS)[0])
+	fmt.Println("BGP AS:		", bgpAS)
+	if wantPrefixes {
+		fmt.Println("\nBGP Prefixes:")
+		printBGPPrefixes(bgpAS)
+	}
 }

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Luke Tainton
+
+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.

Main.go

@@ -3,23 +3,51 @@ package main
 import (
 	"flag"
 	"fmt"
+	"os"
 )
 
 func main() {
-	printHeader()
-
 	var input string
-	localIPAddress := getLocalIP()
+	var wantPrefixes bool
-	flag.StringVar(&input, "i", localIPAddress, "Specify IP address or domain name.")
+	var wantHeader bool
+
+	flag.StringVar(&input, "i", "", "IP address or domain")
+	flag.BoolVar(&wantPrefixes, "p", false, "print BGP prefixes")
+	flag.BoolVar(&wantHeader, "b", true, "enable/disable header")
+
+	flag.Usage = func() {
+		fmt.Printf("Usage of iPilot: \n")
+		fmt.Printf("Example: iPilot -b=false -i=me -p \n")
+		fmt.Printf("  -b	bool	enable/disable header (default true)\n")
+		fmt.Printf("  -h	bool	view help\n")
+		fmt.Printf("  -i	string	IP address or domain\n")
+		fmt.Printf("  -p	bool	print BGP prefixes (default false)\n")
+	}
+
 	flag.Parse()
-	var isIPCorrect bool = checkIPSyntax(input)
+
-	if isIPCorrect == true {
+	if wantHeader {
-		printIPInfo(input)
+		printHeader()
+	}
+
+	if input == "" {
+		fmt.Println("FATAL: No IP address or domain name was specified.")
+		os.Exit(1)
+	}
+
+	if input == "me" {
+		input = getLocalIP()
+	}
+	if isIPAddress(input) {
+		printIPInfo(input, wantPrefixes)
 	} else {
-		// fmt.Println(ipaddress, "is not a valid IP address.")
-		fmt.Println("Domain Name:	", input)
 		ipaddress := resolveDNSHostname(input)
-		printIPInfo(ipaddress)
+		if isIPAddress(ipaddress) {
+			fmt.Println("Domain Name:	", input)
+			printIPInfo(ipaddress, wantPrefixes)
+		} else {
+			fmt.Println("Invalid query.")
+		}
 	}
 
 }

README.md

@@ -0,0 +1,23 @@
+# IP Information Lookup Tool (iPilot)
+
+This Go application takes an IP address or domain name and gathers the following information:
+- Location
+- Timezone
+- Internet Service Provider
+- Autonomous System
+- Advertised Prefixes
+
+## Running the script
+Here are some ways that you can run the script:
+| Command                | Description                              |
+| ---------------------- | ---------------------------------------- |
+| `./iPilot -i me`         | Run against your own connection          |
+| `./iPilot -i 1.1.1.1`    | Run against the IP address `1.1.1.1`     |
+| `./iPilot -i google.com` | Run against the domain name `google.com` |
+| `./iPilot -i google.com -p` | Run against the domain name `google.com` and lists BGP prefixes |
+
+## Support
+For support please open an issue on [GitLab](https://gitlab.com/luketainton/iPilot) or email [ipilot@help.tainton.uk](mailto:ipilot@help.tainton.uk).
+
+## Credits
+This script runs thanks to the APIs provided by [IP-API](http://ip-api.com) and [HackerTarget](https://hackertarget.com/as-ip-lookup).

go.mod

@@ -0,0 +1,3 @@
+module github.com/luketainton/iPilot
+
+go 1.19

ipilot_test.go

@@ -0,0 +1,29 @@
+package main
+
+import "testing"
+
+func TestGetCurrentIP(t *testing.T) {
+	myip := getLocalIP()
+	if myip == "" {
+		t.Log("could not retrieve current IP")
+		t.Fail()
+	}
+}
+
+func TestIsIPAddress(t *testing.T) {
+	ipaddress := "192.168.0.1"
+	isIP := isIPAddress(ipaddress)
+	if isIP == false {
+		t.Log("could not verify " + ipaddress + " is an IP address")
+		t.Fail()
+	}
+}
+
+func TestResolveDNSHostname(t *testing.T) {
+	hostname := "one.one.one.one"
+	ipaddress := resolveDNSHostname(hostname)
+	if ipaddress != "1.1.1.1" {
+		t.Log("could not resolve IP for " + hostname)
+		t.Fail()
+	}
+}

renovate.json

@@ -0,0 +1,16 @@
+{
+  "extends": ["config:base"],
+  "platformCommit": true,
+  "dependencyDashboardAutoclose": true,
+  "assignAutomerge": true,
+  "assigneesFromCodeOwners": true,
+  "rebaseWhen": "behind-base-branch",
+  "rollbackPrs": true,
+  "labels": ["dependencies"],
+  "vulnerabilityAlerts": {
+    "enabled": true,
+    "labels": ["security"],
+    "commitMessagePrefix": "[SECURITY] ",
+    "prCreation": "immediate"
+  }
+}

sonar-project.properties

@@ -0,0 +1,11 @@
+sonar.organization=luketainton
+sonar.projectKey=luketainton_iPilot
+# sonar.projectKey=luketainton_iPilot_AYKYmHI397IDIMpeRtF7
+sonar.projectName=iPilot
+sonar.projectVersion=1.3.9
+sonar.sources=.
+sonar.exclusions=,.github/**,.gitignore,CODEOWNERS,CHANGELOG.md,LICENSE.md,README.md,renovate.json,**/*_test.go
+sonar.tests=.
+sonar.test.inclusions=**/*_test.go
+sonar.go.golangci-lint.reportPaths=report.xml
+sonar.go.coverage.reportPaths=coverage.out