mirror of
https://github.com/dcarrillo/whatismyip.git
synced 2025-07-06 14:49:25 +00:00
Compare commits
12 Commits
Author | SHA1 | Date | |
---|---|---|---|
8b5cccd744 | |||
2571e22843
|
|||
2807e2afc9
|
|||
1aa59f1b0b | |||
126ae833b5
|
|||
97b3245278
|
|||
7bc95f98c8
|
|||
66f3436371
|
|||
7d2209d390
|
|||
255660374f
|
|||
36f82eb6a7 | |||
c0d1143de6
|
66
.github/workflows/main.yml
vendored
Normal file
66
.github/workflows/main.yml
vendored
Normal file
@ -0,0 +1,66 @@
|
|||||||
|
name: CI
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
tags:
|
||||||
|
- '*'
|
||||||
|
pull_request:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
tests:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2.4.0
|
||||||
|
|
||||||
|
- name: install go
|
||||||
|
uses: actions/setup-go@v2
|
||||||
|
with:
|
||||||
|
go-version: "^1.17"
|
||||||
|
|
||||||
|
- name: Lint
|
||||||
|
run: make lint
|
||||||
|
|
||||||
|
- name: Tests
|
||||||
|
run: make test
|
||||||
|
|
||||||
|
deploy:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
needs: tests
|
||||||
|
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
goosarch: [linux-amd64]
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2.4.0
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
|
- name: Set env
|
||||||
|
run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
|
||||||
|
|
||||||
|
- name: Sign in to dockerhub
|
||||||
|
run: echo "${{ secrets.DOCKERHUB_TOKEN }}" | docker login -u ${{ secrets.DOCKERHUB_USERNAME }} --password-stdin
|
||||||
|
|
||||||
|
- name: Deploy image
|
||||||
|
run: make docker-push VERSION=$RELEASE_VERSION
|
||||||
|
|
||||||
|
- name: Build
|
||||||
|
run: make build VERSION=$RELEASE_VERSION
|
||||||
|
|
||||||
|
- name: Prepare release
|
||||||
|
run: |
|
||||||
|
git log $(git describe HEAD~ --tags --abbrev=0)..HEAD --pretty='format:%h - %s (%cr) <%an>' --no-merges > changelog.txt
|
||||||
|
tar zcvf whatismyip-$RELEASE_VERSION-${{matrix.goosarch}}.tar.gz whatismyip LICENSE README.md
|
||||||
|
sha256sum whatismyip-$RELEASE_VERSION-${{matrix.goosarch}}.tar.gz > whatismyip-$RELEASE_VERSION-${{matrix.goosarch}}.tar.gz.sha256
|
||||||
|
|
||||||
|
- name: Release
|
||||||
|
uses: softprops/action-gh-release@v0.1.14
|
||||||
|
with:
|
||||||
|
body_path: changelog.txt
|
||||||
|
files: |
|
||||||
|
whatismyip-${{env.RELEASE_VERSION}}-${{matrix.goosarch}}.tar.gz
|
||||||
|
whatismyip-${{env.RELEASE_VERSION}}-${{matrix.goosarch}}.tar.gz.sha256
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
@ -1,10 +1,13 @@
|
|||||||
FROM golang:1.17-alpine as builder
|
FROM golang:1.17-alpine as builder
|
||||||
|
|
||||||
|
ARG ARG_VERSION
|
||||||
|
ENV VERSION $ARG_VERSION
|
||||||
|
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
|
|
||||||
COPY . .
|
COPY . .
|
||||||
|
|
||||||
RUN apk add make && make build
|
RUN apk add make && make build VERSION=$VERSION
|
||||||
|
|
||||||
# Build final image
|
# Build final image
|
||||||
FROM scratch
|
FROM scratch
|
||||||
|
36
Makefile
36
Makefile
@ -1,3 +1,4 @@
|
|||||||
|
GOPATH ?= $(shell go env GOPATH)
|
||||||
VERSION ?= devel-$(shell git rev-parse --short HEAD)
|
VERSION ?= devel-$(shell git rev-parse --short HEAD)
|
||||||
DOCKER_URL ?= dcarrillo/whatismyip
|
DOCKER_URL ?= dcarrillo/whatismyip
|
||||||
|
|
||||||
@ -13,32 +14,49 @@ integration-test:
|
|||||||
go test ./integration-tests -v
|
go test ./integration-tests -v
|
||||||
|
|
||||||
.PHONY: install-tools
|
.PHONY: install-tools
|
||||||
install-int:
|
install-tools:
|
||||||
@hash golangci-lint > /dev/null 2>&1; if [ $$? -ne 0 ]; then \
|
@command golangci-lint > /dev/null 2>&1; if [ $$? -ne 0 ]; then \
|
||||||
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.43.0
|
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(GOPATH)/bin v1.43.0; \
|
||||||
fi
|
fi
|
||||||
|
|
||||||
@hash shadow > /dev/null 2>&1; if [ $$? -ne 0 ]; then \
|
@command $(GOPATH)/shadow > /dev/null 2>&1; if [ $$? -ne 0 ]; then \
|
||||||
go install golang.org/x/tools/go/analysis/passes/shadow/cmd/shadow@v0.1.7
|
go install golang.org/x/tools/go/analysis/passes/shadow/cmd/shadow@v0.1.7; \
|
||||||
|
fi
|
||||||
|
|
||||||
|
@command $(GOPATH)/golines > /dev/null 2>&1; if [ $$? -ne 0 ]; then \
|
||||||
|
go install github.com/segmentio/golines@latest; \
|
||||||
fi
|
fi
|
||||||
.PHONY: lint
|
.PHONY: lint
|
||||||
lint: install-tools
|
lint: install-tools
|
||||||
|
gofmt -l . && test -z $$(gofmt -l .)
|
||||||
|
golines -l . && test -z $$(golines -l .)
|
||||||
golangci-lint run
|
golangci-lint run
|
||||||
shadow ./...
|
shadow ./...
|
||||||
|
|
||||||
.PHONY: build
|
.PHONY: build
|
||||||
build:
|
build:
|
||||||
CGO_ENABLED=0 go build -ldflags="-X 'github.com/dcarrillo/whatismyip/internal/core.Version=${VERSION}'" -o whatismyip ./cmd
|
CGO_ENABLED=0 go build -ldflags="-s -w -X 'github.com/dcarrillo/whatismyip/internal/core.Version=${VERSION}'" -o whatismyip ./cmd
|
||||||
|
|
||||||
.PHONY: docker-build
|
.PHONY: docker-build
|
||||||
docker-build:
|
docker-build:
|
||||||
docker build --tag ${DOCKER_URL}:${VERSION} .
|
docker build --build-arg=ARG_VERSION="${VERSION}" --tag ${DOCKER_URL}:${VERSION} .
|
||||||
|
|
||||||
|
.PHONY: docker-push
|
||||||
|
docker-push: docker-build
|
||||||
|
ifneq (,$(findstring devel-,$(VERSION)))
|
||||||
|
@echo "VERSION is set to ${VERSION}, I can't push devel builds"
|
||||||
|
exit 1
|
||||||
|
else
|
||||||
|
docker push ${DOCKER_URL}:${VERSION}
|
||||||
|
docker tag ${DOCKER_URL}:${VERSION} ${DOCKER_URL}:latest
|
||||||
|
docker push ${DOCKER_URL}:latest
|
||||||
|
endif
|
||||||
|
|
||||||
.PHONY: docker-run
|
.PHONY: docker-run
|
||||||
docker-run: docker-build
|
docker-run: docker-build
|
||||||
docker run --tty --interactive --rm \
|
docker run --tty --interactive --rm \
|
||||||
-v $$PWD/test/GeoIP2-City-Test.mmdb:/tmp/GeoIP2-City-Test.mmdb:ro \
|
-v ${PWD}/test/GeoIP2-City-Test.mmdb:/tmp/GeoIP2-City-Test.mmdb:ro \
|
||||||
-v $$PWD/test/GeoLite2-ASN-Test.mmdb:/tmp/GeoLite2-ASN-Test.mmdb:ro -p 8080:8080 \
|
-v ${PWD}/test/GeoLite2-ASN-Test.mmdb:/tmp/GeoLite2-ASN-Test.mmdb:ro -p 8080:8080 \
|
||||||
${DOCKER_URL}:${VERSION} \
|
${DOCKER_URL}:${VERSION} \
|
||||||
-geoip2-city /tmp/GeoIP2-City-Test.mmdb \
|
-geoip2-city /tmp/GeoIP2-City-Test.mmdb \
|
||||||
-geoip2-asn /tmp/GeoLite2-ASN-Test.mmdb \
|
-geoip2-asn /tmp/GeoLite2-ASN-Test.mmdb \
|
||||||
|
41
README.md
41
README.md
@ -5,6 +5,11 @@
|
|||||||
- [Endpoints](#endpoints)
|
- [Endpoints](#endpoints)
|
||||||
- [Build](#build)
|
- [Build](#build)
|
||||||
- [Usage](#usage)
|
- [Usage](#usage)
|
||||||
|
- [Examples](#examples)
|
||||||
|
- [Run a default TCP server](#run-a-default-tcp-server)
|
||||||
|
- [Run a TLS (HTTP/2) server only](#run-a-tls-http2-server-only)
|
||||||
|
- [Run a default TCP server with a custom template and trust a custom header set by an upstream proxy](#run-a-default-tcp-server-with-a-custom-template-and-trust-a-custom-header-set-by-an-upstream-proxy)
|
||||||
|
- [Download](#download)
|
||||||
- [Docker](#docker)
|
- [Docker](#docker)
|
||||||
- [Running a container locally using test databases](#running-a-container-locally-using-test-databases)
|
- [Running a container locally using test databases](#running-a-container-locally-using-test-databases)
|
||||||
- [From Docker Hub](#from-docker-hub)
|
- [From Docker Hub](#from-docker-hub)
|
||||||
@ -25,12 +30,14 @@ curl -6 ifconfig.es
|
|||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- TLS available
|
- TLS and HTTP/2.
|
||||||
- Can run behind a proxy by trusting a custom header (usually `X-Real-IP`) to figure out the source IP address.
|
- Can run behind a proxy by trusting a custom header (usually `X-Real-IP`) to figure out the source IP address.
|
||||||
- IPv4 and IPv6.
|
- IPv4 and IPv6.
|
||||||
- Geolocation info including ASN. This feature is possible thanks to [maxmind](https://dev.maxmind.com/geoip/geolite2-free-geolocation-data?lang=en) GeoLite2 databases. In order to use these databases, a -icense key is needed. Please visit Maxmind site for further instructions and get a free license.
|
- Geolocation info including ASN. This feature is possible thanks to [maxmind](https://dev.maxmind.com/geoip/geolite2-free-geolocation-data?lang=en) GeoLite2 databases. In order to use these databases, a license key is needed. Please visit Maxmind site for further instructions and get a free license.
|
||||||
- High performance
|
- High performance.
|
||||||
- HTML with templates, text plain and JSON output.
|
- Self-contained server what can reload GeoLite2 databases and/or SSL certificates without stop/start. The `hup` signal is honored.
|
||||||
|
- HTML templates for the landing page.
|
||||||
|
- Text plain and JSON output.
|
||||||
|
|
||||||
## Endpoints
|
## Endpoints
|
||||||
|
|
||||||
@ -81,9 +88,33 @@ Usage of ./whatismyip:
|
|||||||
Output version information and exit
|
Output version information and exit
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
### Run a default TCP server
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./whatismyip -geoip2-city ./test/GeoIP2-City-Test.mmdb -geoip2-asn ./test/GeoLite2-ASN-Test.mmdb
|
||||||
|
```
|
||||||
|
|
||||||
|
### Run a TLS (HTTP/2) server only
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./whatismyip -geoip2-city ./test/GeoIP2-City-Test.mmdb -geoip2-asn ./test/GeoLite2-ASN-Test.mmdb -bind "" -tls-bind :8081 -tls-crt ./test/server.pem -tls-key ./test/server.key
|
||||||
|
```
|
||||||
|
|
||||||
|
### Run a default TCP server with a custom template and trust a custom header set by an upstream proxy
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./whatismyip -geoip2-city ./test/GeoIP2-City-Test.mmdb -geoip2-asn ./test/GeoLite2-ASN-Test.mmdb -trusted-header X-Real-IP -template mytemplate.tmpl
|
||||||
|
```
|
||||||
|
|
||||||
|
## Download
|
||||||
|
|
||||||
|
Download latest version from https://github.com/dcarrillo/whatismyip/releases
|
||||||
|
|
||||||
## Docker
|
## Docker
|
||||||
|
|
||||||
An ultra-light (13MB) image is available.
|
An ultra-light (~9MB) image is available.
|
||||||
|
|
||||||
### Running a container locally using test databases
|
### Running a container locally using test databases
|
||||||
|
|
||||||
|
@ -3,6 +3,8 @@ package main
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"errors"
|
"errors"
|
||||||
|
"flag"
|
||||||
|
"fmt"
|
||||||
"log"
|
"log"
|
||||||
"net/http"
|
"net/http"
|
||||||
"os"
|
"os"
|
||||||
@ -24,7 +26,15 @@ var (
|
|||||||
)
|
)
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
setting.Setup()
|
o, err := setting.Setup(os.Args[1:])
|
||||||
|
if err == flag.ErrHelp || err == setting.ErrVersion {
|
||||||
|
fmt.Print(o)
|
||||||
|
os.Exit(0)
|
||||||
|
} else if err != nil {
|
||||||
|
fmt.Print(err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
|
||||||
models.Setup(setting.App.GeodbPath.City, setting.App.GeodbPath.ASN)
|
models.Setup(setting.App.GeodbPath.City, setting.App.GeodbPath.ASN)
|
||||||
setupEngine()
|
setupEngine()
|
||||||
router.SetupTemplate(engine)
|
router.SetupTemplate(engine)
|
||||||
@ -112,7 +122,8 @@ func runTLSServer() {
|
|||||||
|
|
||||||
go func() {
|
go func() {
|
||||||
log.Printf("Starting TLS server listening on %s", setting.App.TLSAddress)
|
log.Printf("Starting TLS server listening on %s", setting.App.TLSAddress)
|
||||||
if err := tlsServer.ListenAndServeTLS(setting.App.TLSCrtPath, setting.App.TLSKeyPath); err != nil && !errors.Is(err, http.ErrServerClosed) {
|
if err := tlsServer.ListenAndServeTLS(setting.App.TLSCrtPath, setting.App.TLSKeyPath); err != nil &&
|
||||||
|
!errors.Is(err, http.ErrServerClosed) {
|
||||||
log.Fatal(err)
|
log.Fatal(err)
|
||||||
}
|
}
|
||||||
log.Printf("Stopping TLS server...")
|
log.Printf("Stopping TLS server...")
|
||||||
|
@ -1,6 +1,8 @@
|
|||||||
package setting
|
package setting
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"bytes"
|
||||||
|
"errors"
|
||||||
"flag"
|
"flag"
|
||||||
"fmt"
|
"fmt"
|
||||||
"os"
|
"os"
|
||||||
@ -26,62 +28,75 @@ type settings struct {
|
|||||||
TLSKeyPath string
|
TLSKeyPath string
|
||||||
TrustedHeader string
|
TrustedHeader string
|
||||||
Server serverSettings
|
Server serverSettings
|
||||||
|
version bool
|
||||||
}
|
}
|
||||||
|
|
||||||
const defaultAddress = ":8080"
|
const defaultAddress = ":8080"
|
||||||
|
|
||||||
var App *settings
|
var ErrVersion = errors.New("setting: version requested")
|
||||||
|
var App = settings{
|
||||||
|
// hard-coded for the time being
|
||||||
|
Server: serverSettings{
|
||||||
|
ReadTimeout: 10 * time.Second,
|
||||||
|
WriteTimeout: 10 * time.Second,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
func Setup() {
|
func Setup(args []string) (output string, err error) {
|
||||||
city := flag.String("geoip2-city", "", "Path to GeoIP2 city database")
|
flags := flag.NewFlagSet("whatismyip", flag.ContinueOnError)
|
||||||
asn := flag.String("geoip2-asn", "", "Path to GeoIP2 ASN database")
|
var buf bytes.Buffer
|
||||||
template := flag.String("template", "", "Path to template file")
|
flags.SetOutput(&buf)
|
||||||
address := flag.String("bind", defaultAddress, "Listening address (see https://pkg.go.dev/net?#Listen)")
|
|
||||||
addressTLS := flag.String("tls-bind", "", "Listening address for TLS (see https://pkg.go.dev/net?#Listen)")
|
|
||||||
tlsCrtPath := flag.String("tls-crt", "", "When using TLS, path to certificate file")
|
|
||||||
tlsKeyPath := flag.String("tls-key", "", "When using TLS, path to private key file")
|
|
||||||
trustedHeader := flag.String("trusted-header", "", "Trusted request header for remote IP (e.g. X-Real-IP)")
|
|
||||||
ver := flag.Bool("version", false, "Output version information and exit")
|
|
||||||
|
|
||||||
flag.Parse()
|
flags.StringVar(&App.GeodbPath.City, "geoip2-city", "", "Path to GeoIP2 city database")
|
||||||
|
flags.StringVar(&App.GeodbPath.ASN, "geoip2-asn", "", "Path to GeoIP2 ASN database")
|
||||||
|
flags.StringVar(&App.TemplatePath, "template", "", "Path to template file")
|
||||||
|
flags.StringVar(
|
||||||
|
&App.BindAddress,
|
||||||
|
"bind",
|
||||||
|
defaultAddress,
|
||||||
|
"Listening address (see https://pkg.go.dev/net?#Listen)",
|
||||||
|
)
|
||||||
|
flags.StringVar(
|
||||||
|
&App.TLSAddress,
|
||||||
|
"tls-bind",
|
||||||
|
"",
|
||||||
|
"Listening address for TLS (see https://pkg.go.dev/net?#Listen)",
|
||||||
|
)
|
||||||
|
flags.StringVar(&App.TLSCrtPath, "tls-crt", "", "When using TLS, path to certificate file")
|
||||||
|
flags.StringVar(&App.TLSKeyPath, "tls-key", "", "When using TLS, path to private key file")
|
||||||
|
flags.StringVar(&App.TrustedHeader,
|
||||||
|
"trusted-header",
|
||||||
|
"",
|
||||||
|
"Trusted request header for remote IP (e.g. X-Real-IP)",
|
||||||
|
)
|
||||||
|
flags.BoolVar(&App.version, "version", false, "Output version information and exit")
|
||||||
|
|
||||||
if *ver {
|
err = flags.Parse(args)
|
||||||
fmt.Printf("whaismyip version %s", core.Version)
|
if err != nil {
|
||||||
os.Exit(0)
|
return buf.String(), err
|
||||||
}
|
}
|
||||||
|
|
||||||
if *city == "" || *asn == "" {
|
if App.version {
|
||||||
exitWithError("geoip2-city and geoip2-asn parameters are mandatory")
|
return fmt.Sprintf("whatismyip version %s", core.Version), ErrVersion
|
||||||
}
|
}
|
||||||
|
|
||||||
if (*addressTLS != "") && (*tlsCrtPath == "" || *tlsKeyPath == "") {
|
if App.GeodbPath.City == "" || App.GeodbPath.ASN == "" {
|
||||||
exitWithError("In order to use TLS -tls-crt and -tls-key flags are mandatory")
|
return "", fmt.Errorf("geoip2-city and geoip2-asn parameters are mandatory")
|
||||||
}
|
}
|
||||||
|
|
||||||
if *template != "" {
|
if (App.TLSAddress != "") && (App.TLSCrtPath == "" || App.TLSKeyPath == "") {
|
||||||
info, err := os.Stat(*template)
|
return "", fmt.Errorf("In order to use TLS -tls-crt and -tls-key flags are mandatory")
|
||||||
if os.IsNotExist(err) || info.IsDir() {
|
}
|
||||||
exitWithError(*template + " doesn't exist or it's not a file")
|
|
||||||
|
if App.TemplatePath != "" {
|
||||||
|
info, err := os.Stat(App.TemplatePath)
|
||||||
|
if os.IsNotExist(err) {
|
||||||
|
return "", fmt.Errorf("%s no such file or directory", App.TemplatePath)
|
||||||
|
}
|
||||||
|
if info.IsDir() {
|
||||||
|
return "", fmt.Errorf("%s must be a file", App.TemplatePath)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
App = &settings{
|
return buf.String(), nil
|
||||||
GeodbPath: geodbPath{City: *city, ASN: *asn},
|
|
||||||
TemplatePath: *template,
|
|
||||||
BindAddress: *address,
|
|
||||||
TLSAddress: *addressTLS,
|
|
||||||
TLSCrtPath: *tlsCrtPath,
|
|
||||||
TLSKeyPath: *tlsKeyPath,
|
|
||||||
TrustedHeader: *trustedHeader,
|
|
||||||
Server: serverSettings{
|
|
||||||
ReadTimeout: 10 * time.Second,
|
|
||||||
WriteTimeout: 10 * time.Second,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func exitWithError(error string) {
|
|
||||||
fmt.Printf("%s\n\n", error)
|
|
||||||
flag.Usage()
|
|
||||||
os.Exit(1)
|
|
||||||
}
|
}
|
||||||
|
193
internal/setting/app_test.go
Normal file
193
internal/setting/app_test.go
Normal file
@ -0,0 +1,193 @@
|
|||||||
|
package setting
|
||||||
|
|
||||||
|
import (
|
||||||
|
"flag"
|
||||||
|
"reflect"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestParseMandatoryFlags(t *testing.T) {
|
||||||
|
var mandatoryFlags = []struct {
|
||||||
|
args []string
|
||||||
|
conf settings
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
[]string{},
|
||||||
|
settings{},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
[]string{"-geoip2-city", "/city-path"},
|
||||||
|
settings{},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
[]string{"-geoip2-asn", "/asn-path"},
|
||||||
|
settings{},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
[]string{
|
||||||
|
"-geoip2-city", "/city-path", "-geoip2-asn", "/asn-path", "-tls-bind", ":9000",
|
||||||
|
},
|
||||||
|
settings{},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
[]string{
|
||||||
|
"-geoip2-city", "/city-path", "-geoip2-asn", "/asn-path", "-tls-bind", ":9000",
|
||||||
|
"-tls-crt", "/crt-path",
|
||||||
|
},
|
||||||
|
settings{},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
[]string{
|
||||||
|
"-geoip2-city", "/city-path", "-geoip2-asn", "/asn-path", "-tls-bind", ":9000",
|
||||||
|
"-tls-key", "/key-path",
|
||||||
|
},
|
||||||
|
settings{},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range mandatoryFlags {
|
||||||
|
t.Run(strings.Join(tt.args, " "), func(t *testing.T) {
|
||||||
|
_, err := Setup(tt.args)
|
||||||
|
assert.NotNil(t, err)
|
||||||
|
assert.Contains(t, err.Error(), "mandatory")
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestParseFlags(t *testing.T) {
|
||||||
|
var flags = []struct {
|
||||||
|
args []string
|
||||||
|
conf settings
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
[]string{"-geoip2-city", "/city-path", "-geoip2-asn", "/asn-path"},
|
||||||
|
settings{
|
||||||
|
GeodbPath: geodbPath{
|
||||||
|
City: "/city-path",
|
||||||
|
ASN: "/asn-path",
|
||||||
|
},
|
||||||
|
TemplatePath: "",
|
||||||
|
BindAddress: ":8080",
|
||||||
|
TLSAddress: "",
|
||||||
|
TLSCrtPath: "",
|
||||||
|
TLSKeyPath: "",
|
||||||
|
TrustedHeader: "",
|
||||||
|
Server: serverSettings{
|
||||||
|
ReadTimeout: 10 * time.Second,
|
||||||
|
WriteTimeout: 10 * time.Second,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
[]string{"-bind", ":8001", "-geoip2-city", "/city-path", "-geoip2-asn", "/asn-path"},
|
||||||
|
settings{
|
||||||
|
GeodbPath: geodbPath{
|
||||||
|
City: "/city-path",
|
||||||
|
ASN: "/asn-path",
|
||||||
|
},
|
||||||
|
TemplatePath: "",
|
||||||
|
BindAddress: ":8001",
|
||||||
|
TLSAddress: "",
|
||||||
|
TLSCrtPath: "",
|
||||||
|
TLSKeyPath: "",
|
||||||
|
TrustedHeader: "",
|
||||||
|
Server: serverSettings{
|
||||||
|
ReadTimeout: 10 * time.Second,
|
||||||
|
WriteTimeout: 10 * time.Second,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
[]string{
|
||||||
|
"-geoip2-city", "/city-path", "-geoip2-asn", "/asn-path", "-tls-bind", ":9000",
|
||||||
|
"-tls-crt", "/crt-path", "-tls-key", "/key-path",
|
||||||
|
},
|
||||||
|
settings{
|
||||||
|
GeodbPath: geodbPath{
|
||||||
|
City: "/city-path",
|
||||||
|
ASN: "/asn-path",
|
||||||
|
},
|
||||||
|
TemplatePath: "",
|
||||||
|
BindAddress: ":8080",
|
||||||
|
TLSAddress: ":9000",
|
||||||
|
TLSCrtPath: "/crt-path",
|
||||||
|
TLSKeyPath: "/key-path",
|
||||||
|
TrustedHeader: "",
|
||||||
|
Server: serverSettings{
|
||||||
|
ReadTimeout: 10 * time.Second,
|
||||||
|
WriteTimeout: 10 * time.Second,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
[]string{
|
||||||
|
"-geoip2-city", "/city-path", "-geoip2-asn", "/asn-path",
|
||||||
|
"-trusted-header", "header",
|
||||||
|
},
|
||||||
|
settings{
|
||||||
|
GeodbPath: geodbPath{
|
||||||
|
City: "/city-path",
|
||||||
|
ASN: "/asn-path",
|
||||||
|
},
|
||||||
|
TemplatePath: "",
|
||||||
|
BindAddress: ":8080",
|
||||||
|
TLSAddress: "",
|
||||||
|
TLSCrtPath: "",
|
||||||
|
TLSKeyPath: "",
|
||||||
|
TrustedHeader: "header",
|
||||||
|
Server: serverSettings{
|
||||||
|
ReadTimeout: 10 * time.Second,
|
||||||
|
WriteTimeout: 10 * time.Second,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range flags {
|
||||||
|
t.Run(strings.Join(tt.args, " "), func(t *testing.T) {
|
||||||
|
_, err := Setup(tt.args)
|
||||||
|
assert.Nil(t, err)
|
||||||
|
assert.True(t, reflect.DeepEqual(App, tt.conf))
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestParseFlagsUsage(t *testing.T) {
|
||||||
|
var usageArgs = []string{"-help", "-h", "--help"}
|
||||||
|
|
||||||
|
for _, arg := range usageArgs {
|
||||||
|
t.Run(arg, func(t *testing.T) {
|
||||||
|
output, err := Setup([]string{arg})
|
||||||
|
assert.ErrorIs(t, err, flag.ErrHelp)
|
||||||
|
assert.Contains(t, output, "Usage of")
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestParseFlagVersion(t *testing.T) {
|
||||||
|
output, err := Setup([]string{"-version"})
|
||||||
|
assert.ErrorIs(t, err, ErrVersion)
|
||||||
|
assert.Contains(t, output, "whatismyip version")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestParseFlagTemplate(t *testing.T) {
|
||||||
|
flags := []string{
|
||||||
|
"-geoip2-city", "/city-path", "-geoip2-asn", "/asn-path",
|
||||||
|
"-template", "/template-path",
|
||||||
|
}
|
||||||
|
_, err := Setup(flags)
|
||||||
|
assert.Error(t, err)
|
||||||
|
assert.Contains(t, err.Error(), "no such file or directory")
|
||||||
|
|
||||||
|
flags = []string{
|
||||||
|
"-geoip2-city", "/city-path", "-geoip2-asn", "/asn-path",
|
||||||
|
"-template", "/",
|
||||||
|
}
|
||||||
|
_, err = Setup(flags)
|
||||||
|
assert.Error(t, err)
|
||||||
|
assert.Contains(t, err.Error(), "must be a file")
|
||||||
|
}
|
@ -5,7 +5,6 @@ import (
|
|||||||
"net/http"
|
"net/http"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"regexp"
|
"regexp"
|
||||||
"strings"
|
|
||||||
|
|
||||||
"github.com/dcarrillo/whatismyip/internal/httputils"
|
"github.com/dcarrillo/whatismyip/internal/httputils"
|
||||||
"github.com/dcarrillo/whatismyip/internal/setting"
|
"github.com/dcarrillo/whatismyip/internal/setting"
|
||||||
@ -46,12 +45,14 @@ func getRoot(ctx *gin.Context) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func getClientPortAsString(ctx *gin.Context) {
|
func getClientPortAsString(ctx *gin.Context) {
|
||||||
ctx.String(http.StatusOK, strings.Split(ctx.Request.RemoteAddr, ":")[1]+"\n")
|
_, port, _ := net.SplitHostPort(ctx.Request.RemoteAddr)
|
||||||
|
ctx.String(http.StatusOK, port+"\n")
|
||||||
}
|
}
|
||||||
|
|
||||||
func getAllAsString(ctx *gin.Context) {
|
func getAllAsString(ctx *gin.Context) {
|
||||||
output := "IP: " + ctx.ClientIP() + "\n"
|
output := "IP: " + ctx.ClientIP() + "\n"
|
||||||
output += "Client Port: " + strings.Split(ctx.Request.RemoteAddr, ":")[1] + "\n"
|
_, port, _ := net.SplitHostPort(ctx.Request.RemoteAddr)
|
||||||
|
output += "Client Port: " + port + "\n"
|
||||||
|
|
||||||
r := service.Geo{IP: net.ParseIP(ctx.ClientIP())}
|
r := service.Geo{IP: net.ParseIP(ctx.ClientIP())}
|
||||||
if record := r.LookUpCity(); record != nil {
|
if record := r.LookUpCity(); record != nil {
|
||||||
@ -82,10 +83,11 @@ func jsonOutput(ctx *gin.Context) JSONResponse {
|
|||||||
version = 6
|
version = 6
|
||||||
}
|
}
|
||||||
|
|
||||||
|
_, port, _ := net.SplitHostPort(ctx.Request.RemoteAddr)
|
||||||
return JSONResponse{
|
return JSONResponse{
|
||||||
IP: ctx.ClientIP(),
|
IP: ctx.ClientIP(),
|
||||||
IPVersion: version,
|
IPVersion: version,
|
||||||
ClientPort: strings.Split(ctx.Request.RemoteAddr, ":")[1],
|
ClientPort: port,
|
||||||
Country: cityRecord.Country.Names["en"],
|
Country: cityRecord.Country.Names["en"],
|
||||||
CountryCode: cityRecord.Country.ISOCode,
|
CountryCode: cityRecord.Country.ISOCode,
|
||||||
City: cityRecord.City.Names["en"],
|
City: cityRecord.City.Names["en"],
|
||||||
|
@ -1,6 +1,7 @@
|
|||||||
package router
|
package router
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"net"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/http/httptest"
|
"net/http/httptest"
|
||||||
"testing"
|
"testing"
|
||||||
@ -9,7 +10,18 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
func TestIP4RootFromCli(t *testing.T) {
|
func TestIP4RootFromCli(t *testing.T) {
|
||||||
uas := []string{"", "curl", "wget", "libwww-perl", "python", "ansible-httpget", "HTTPie", "WindowsPowerShell", "http_request", "Go-http-client"}
|
uas := []string{
|
||||||
|
"",
|
||||||
|
"curl",
|
||||||
|
"wget",
|
||||||
|
"libwww-perl",
|
||||||
|
"python",
|
||||||
|
"ansible-httpget",
|
||||||
|
"HTTPie",
|
||||||
|
"WindowsPowerShell",
|
||||||
|
"http_request",
|
||||||
|
"Go-http-client",
|
||||||
|
}
|
||||||
|
|
||||||
req, _ := http.NewRequest("GET", "/", nil)
|
req, _ := http.NewRequest("GET", "/", nil)
|
||||||
req.Header.Set("X-Real-IP", testIP.ipv4)
|
req.Header.Set("X-Real-IP", testIP.ipv4)
|
||||||
@ -37,7 +49,7 @@ func TestHost(t *testing.T) {
|
|||||||
|
|
||||||
func TestClientPort(t *testing.T) {
|
func TestClientPort(t *testing.T) {
|
||||||
req, _ := http.NewRequest("GET", "/client-port", nil)
|
req, _ := http.NewRequest("GET", "/client-port", nil)
|
||||||
req.RemoteAddr = testIP.ipv4 + ":" + "1000"
|
req.RemoteAddr = net.JoinHostPort(testIP.ipv4, "1000")
|
||||||
req.Header.Set("X-Real-IP", testIP.ipv4)
|
req.Header.Set("X-Real-IP", testIP.ipv4)
|
||||||
|
|
||||||
w := httptest.NewRecorder()
|
w := httptest.NewRecorder()
|
||||||
@ -60,10 +72,10 @@ func TestNotFound(t *testing.T) {
|
|||||||
|
|
||||||
func TestJSON(t *testing.T) {
|
func TestJSON(t *testing.T) {
|
||||||
expectedIPv4 := `{"client_port":"1000","ip":"81.2.69.192","ip_version":4,"country":"United Kingdom","country_code":"GB","city":"London","latitude":51.5142,"longitude":-0.0931,"postal_code":"","time_zone":"Europe/London","asn":0,"asn_organization":"","host":"test","headers":{"X-Real-Ip":["81.2.69.192"]}}`
|
expectedIPv4 := `{"client_port":"1000","ip":"81.2.69.192","ip_version":4,"country":"United Kingdom","country_code":"GB","city":"London","latitude":51.5142,"longitude":-0.0931,"postal_code":"","time_zone":"Europe/London","asn":0,"asn_organization":"","host":"test","headers":{"X-Real-Ip":["81.2.69.192"]}}`
|
||||||
expectedIPv6 := `{"asn":3352, "asn_organization":"TELEFONICA DE ESPANA", "city":"", "client_port":"9000", "country":"", "country_code":"", "headers":{"X-Real-Ip":["2a02:9000::1"]}, "host":"test", "ip":"2a02:9000::1", "ip_version":6, "latitude":0, "longitude":0, "postal_code":"", "time_zone":""}`
|
expectedIPv6 := `{"asn":3352, "asn_organization":"TELEFONICA DE ESPANA", "city":"", "client_port":"1000", "country":"", "country_code":"", "headers":{"X-Real-Ip":["2a02:9000::1"]}, "host":"test", "ip":"2a02:9000::1", "ip_version":6, "latitude":0, "longitude":0, "postal_code":"", "time_zone":""}`
|
||||||
|
|
||||||
req, _ := http.NewRequest("GET", "/json", nil)
|
req, _ := http.NewRequest("GET", "/json", nil)
|
||||||
req.RemoteAddr = testIP.ipv4 + ":" + "1000"
|
req.RemoteAddr = net.JoinHostPort(testIP.ipv4, "1000")
|
||||||
req.Host = "test"
|
req.Host = "test"
|
||||||
req.Header.Set("X-Real-IP", testIP.ipv4)
|
req.Header.Set("X-Real-IP", testIP.ipv4)
|
||||||
|
|
||||||
@ -74,7 +86,7 @@ func TestJSON(t *testing.T) {
|
|||||||
assert.Equal(t, contentType.json, w.Header().Get("Content-Type"))
|
assert.Equal(t, contentType.json, w.Header().Get("Content-Type"))
|
||||||
assert.JSONEq(t, expectedIPv4, w.Body.String())
|
assert.JSONEq(t, expectedIPv4, w.Body.String())
|
||||||
|
|
||||||
req.RemoteAddr = testIP.ipv6 + ":" + "1000"
|
req.RemoteAddr = net.JoinHostPort(testIP.ipv6, "1000")
|
||||||
req.Host = "test"
|
req.Host = "test"
|
||||||
req.Header.Set("X-Real-IP", testIP.ipv6)
|
req.Header.Set("X-Real-IP", testIP.ipv6)
|
||||||
|
|
||||||
@ -106,7 +118,7 @@ X-Real-Ip: 81.2.69.192
|
|||||||
`
|
`
|
||||||
|
|
||||||
req, _ := http.NewRequest("GET", "/all", nil)
|
req, _ := http.NewRequest("GET", "/all", nil)
|
||||||
req.RemoteAddr = testIP.ipv4 + ":" + "1000"
|
req.RemoteAddr = net.JoinHostPort(testIP.ipv4, "1000")
|
||||||
req.Host = "test"
|
req.Host = "test"
|
||||||
req.Header.Set("X-Real-IP", testIP.ipv4)
|
req.Header.Set("X-Real-IP", testIP.ipv4)
|
||||||
req.Header.Set("Header1", "one")
|
req.Header.Set("Header1", "one")
|
||||||
|
Reference in New Issue
Block a user