first commit

.github/workflows/go-cross.yml

@@ -0,0 +1,47 @@
+name: Go Matrix
+on: [push, pull_request]
+
+jobs:
+
+  cross:
+    name: Go
+    runs-on: ${{ matrix.os }}
+    env:
+      CGO_ENABLED: 0
+
+    strategy:
+      matrix:
+        go-version: [ 1.17, 1.x ]
+        os: [ubuntu-latest, macos-latest, windows-latest]
+
+    steps:
+      # https://github.com/marketplace/actions/setup-go-environment
+      - name: Set up Go ${{ matrix.go-version }}
+        uses: actions/setup-go@v2
+        with:
+          go-version: ${{ matrix.go-version }}
+
+      # https://github.com/marketplace/actions/checkout
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      # https://github.com/marketplace/actions/cache
+      - name: Cache Go modules
+        uses: actions/cache@v2
+        with:
+          # In order:
+          # * Module download cache
+          # * Build cache (Linux)
+          # * Build cache (Mac)
+          # * Build cache (Windows)
+          path: |
+            ~/go/pkg/mod
+            ~/.cache/go-build
+            ~/Library/Caches/go-build
+            %LocalAppData%\go-build
+          key: ${{ runner.os }}-${{ matrix.go-version }}-go-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ matrix.go-version }}-go-
+
+      - name: Test
+        run: go test -v -cover ./...

.github/workflows/main.yml

@@ -0,0 +1,72 @@
+name: Main
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+
+  main:
+    name: Main Process
+    runs-on: ubuntu-latest
+    env:
+      GO_VERSION: 1.17
+      GOLANGCI_LINT_VERSION: v1.46.2
+      YAEGI_VERSION: v0.13.0
+      CGO_ENABLED: 0
+    defaults:
+      run:
+        working-directory: ${{ github.workspace }}/go/src/github.com/${{ github.repository }}
+
+    steps:
+
+      # https://github.com/marketplace/actions/setup-go-environment
+      - name: Set up Go ${{ env.GO_VERSION }}
+        uses: actions/setup-go@v2
+        with:
+          go-version: ${{ env.GO_VERSION }}
+
+      # https://github.com/marketplace/actions/checkout
+      - name: Check out code
+        uses: actions/checkout@v2
+        with:
+          path: go/src/github.com/${{ github.repository }}
+          fetch-depth: 0
+
+      # https://github.com/marketplace/actions/cache
+      - name: Cache Go modules
+        uses: actions/cache@v2
+        with:
+          path: ${{ github.workspace }}/go/pkg/mod
+          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-go-
+
+      # https://golangci-lint.run/usage/install#other-ci
+      - name: Install golangci-lint ${{ env.GOLANGCI_LINT_VERSION }}
+        run: curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin ${GOLANGCI_LINT_VERSION}
+
+      - name: Install Yaegi ${{ env.YAEGI_VERSION }}
+        run: curl -sfL https://raw.githubusercontent.com/traefik/yaegi/master/install.sh | bash -s -- -b $(go env GOPATH)/bin ${YAEGI_VERSION}
+
+      - name: Setup GOPATH
+        run: go env -w GOPATH=${{ github.workspace }}/go
+
+      - name: Check and get dependencies
+        run: |
+          go mod tidy
+          git diff --exit-code go.mod
+          # git diff --exit-code go.sum
+          go mod download
+          go mod vendor
+          # git diff --exit-code ./vendor/
+
+      - name: Lint and Tests
+        run: make
+
+      - name: Run tests with Yaegi
+        run: make yaegi_test
+        env:
+          GOPATH: ${{ github.workspace }}/go

.gitignore

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

.golangci.yml

@@ -0,0 +1,66 @@
+run:
+  timeout: 3m
+  skip-files: []
+  skip-dirs: []
+
+linters-settings:
+  govet:
+    enable-all: true
+    disable:
+      - fieldalignment
+  golint:
+    min-confidence: 0
+  gocyclo:
+    min-complexity: 12
+  goconst:
+    min-len: 5
+    min-occurrences: 4
+  misspell:
+    locale: US
+  funlen:
+    lines: -1
+    statements: 50
+  godox:
+    keywords:
+      - FIXME
+  gofumpt:
+    extra-rules: true
+
+linters:
+  enable-all: true
+  disable:
+    - interfacer # deprecated
+    - maligned # deprecated
+    - scopelint # deprecated
+    - golint # deprecated
+    - exhaustivestruct # deprecated
+    - cyclop # duplicate of gocyclo
+    - bodyclose # Too many false positives: https://github.com/timakin/bodyclose/issues/30
+    - dupl
+    - testpackage
+    - tparallel
+    - paralleltest
+    - nlreturn
+    - wsl
+    - exhaustive
+    - exhaustruct
+    - goerr113
+    - wrapcheck
+    - ifshort
+    - noctx
+    - lll
+    - gomnd
+    - forbidigo
+    - varnamelen
+
+issues:
+  exclude-use-default: false
+  max-per-linter: 0
+  max-same-issues: 0
+  exclude: []
+  exclude-rules:
+    - path: (.+)_test.go
+      linters:
+        - goconst
+        - funlen
+        - godot

.traefik.yml

@@ -0,0 +1,12 @@
+displayName: Crowdsec Bouncer Traefik Plugin
+type: middleware
+iconPath: .assets/icon.png
+
+import: github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin
+
+summary: 'Add Request Header'
+
+testData:
+  Headers:
+    X-Demo: test
+    X-URL: '{{URL}}'

LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 Containous SAS
+   Copyright 2020 Traefik Labs
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

Makefile

@@ -0,0 +1,20 @@
+.PHONY: lint test vendor clean
+
+export GO111MODULE=on
+
+default: lint test
+
+lint:
+	golangci-lint run
+
+test:
+	go test -v -cover ./...
+
+yaegi_test:
+	yaegi test -v .
+
+vendor:
+	go mod vendor
+
+clean:
+	rm -rf ./vendor

bouncer.go

@@ -0,0 +1,86 @@
+// Package plugindemo a demo plugin.
+package crowdsec_bouncer_traefik_plugin
+
+import (
+	"bytes"
+	"context"
+	"fmt"
+	"net/http"
+	"regexp"
+	"text/template"
+)
+
+var ipRegex = regexp.MustCompile(`\b\d+\.\d+\.\d+\.\d+\b`)
+
+// Config the plugin configuration.
+// type Config struct {
+// 	Headers map[string]string `json:"headers,omitempty"`
+// }
+// // CreateConfig creates the default plugin configuration.
+// func CreateConfig() *Config {
+// 	return &Config{
+// 		Headers: make(map[string]string),
+// 	}
+// }
+
+type Config struct {
+	Enabled               bool   `json:"enabled,omitempty"`
+	CrowdsecURL           string `json:"crowdsecUrl,omitempty"`
+	CrowdsecMode          string `json:"crowdsecMode,omitempty"`
+	CrowdsecLapiKey       string `json:"crowdsecLapiKey,omitempty"`
+	UpdateIntervalSeconds int    `json:"updateIntervalSeconds,omitempty"`
+}
+
+func CreateConfig() *Config {
+	return &Config{
+		Enabled:               false,
+		CrowdsecURL:           "http://crowdsec:8080",
+		CrowdsecMode:          "none",
+		CrowdsecLapiKey:       "",
+		UpdateIntervalSeconds: 300,
+	}
+}
+
+// Demo a Demo plugin.
+type Demo struct {
+	next     http.Handler
+	headers  map[string]string
+	name     string
+	template *template.Template
+}
+
+// New created a new Demo plugin.
+func New(ctx context.Context, next http.Handler, config *Config, name string) (http.Handler, error) {
+	if len(config.Headers) == 0 {
+		return nil, fmt.Errorf("headers cannot be empty")
+	}
+
+	return &Demo{
+		headers:  config.Headers,
+		next:     next,
+		name:     name,
+		template: template.New("demo").Delims("[[", "]]"),
+	}, nil
+}
+
+func (a *Demo) ServeHTTP(rw http.ResponseWriter, req *http.Request) {
+	for key, value := range a.headers {
+		tmpl, err := a.template.Parse(value)
+		if err != nil {
+			http.Error(rw, err.Error(), http.StatusInternalServerError)
+			return
+		}
+
+		writer := &bytes.Buffer{}
+
+		err = tmpl.Execute(writer, req)
+		if err != nil {
+			http.Error(rw, err.Error(), http.StatusInternalServerError)
+			return
+		}
+
+		req.Header.Set(key, writer.String())
+	}
+
+	a.next.ServeHTTP(rw, req)
+}

bouncer_test.go

@@ -0,0 +1,49 @@
+package crowdsec_bouncer_traefik_plugin_test
+
+import (
+	"context"
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin"
+)
+
+func TestDemo(t *testing.T) {
+	cfg := crowdsec_bouncer_traefik_plugin.CreateConfig()
+	cfg.Headers["X-Host"] = "[[.Host]]"
+	cfg.Headers["X-Method"] = "[[.Method]]"
+	cfg.Headers["X-URL"] = "[[.URL]]"
+	cfg.Headers["X-URL"] = "[[.URL]]"
+	cfg.Headers["X-Demo"] = "test"
+
+	ctx := context.Background()
+	next := http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {})
+
+	handler, err := crowdsec_bouncer_traefik_plugin.New(ctx, next, cfg, "demo-plugin")
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	recorder := httptest.NewRecorder()
+
+	req, err := http.NewRequestWithContext(ctx, http.MethodGet, "http://localhost", nil)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	handler.ServeHTTP(recorder, req)
+
+	assertHeader(t, req, "X-Host", "localhost")
+	assertHeader(t, req, "X-URL", "http://localhost")
+	assertHeader(t, req, "X-Method", "GET")
+	assertHeader(t, req, "X-Demo", "test")
+}
+
+func assertHeader(t *testing.T, req *http.Request, key, expected string) {
+	t.Helper()
+
+	if req.Header.Get(key) != expected {
+		t.Errorf("invalid header value: %s", req.Header.Get(key))
+	}
+}

config.go

@@ -0,0 +1,88 @@
+package config
+
+import (
+	"log"
+	"os"
+	"strconv"
+	"time"
+)
+
+const (
+	RealIpHeader                = "X-Real-Ip"
+	ForwardHeader               = "X-Forwarded-For"
+	CrowdsecAuthHeader          = "X-Api-Key"
+	CrowdsecBouncerRoute        = "v1/decisions"
+	CrowdsecBouncerStreamRoute  = "v1/decisions/stream"
+)
+
+/*
+	Check for an environment variable value, if absent use a default value
+*/
+func OptionalEnv(varName string, optional string) string {
+	envVar := os.Getenv(varName)
+	if envVar == "" {
+		return optional
+	}
+	return envVar
+}
+
+/*
+	Check for an environment variable value, exit program if not found
+*/
+func RequiredEnv(varName string) string {
+	envVar := os.Getenv(varName)
+	if envVar == "" {
+		log.Fatalf("The required env var %s is not provided. Exiting", varName)
+	}
+	return envVar
+}
+
+/*
+	Check for an environment variable value with expected possibilities, exit program if value not expected
+*/
+func ExpectedEnv(varName string, expected []string) string {
+	envVar := RequiredEnv(varName)
+	if !contains(expected, envVar) {
+		log.Fatalf("The value for env var %s is not expected. Expected values are %v", varName, expected)
+	}
+	return envVar
+}
+
+func contains(source []string, target string) bool {
+	for _, a := range source {
+		if a == target {
+			return true
+		}
+	}
+	return false
+}
+
+/*
+	Function for custom validation of configuration that will panic if values are not expected.
+	//FIXME it's a first start before centralizing configuration then injection of dependency.
+*/
+func ValidateEnv() {
+	// Validate Ban response code is a valid http response code
+	banResponseCode := OptionalEnv("CROWDSEC_BOUNCER_BAN_RESPONSE_CODE", "403")
+	parsedCode, err := strconv.Atoi(banResponseCode)
+	if err != nil {
+		log.Fatalf("The value for env var %s is not an int. It should be a valid http response code.", "CROWDSEC_BOUNCER_BAN_RESPONSE_CODE")
+	}
+	if parsedCode < 100 || parsedCode > 599 {
+		log.Fatalf("The value for env var %s should be a valid http response code between 100 and 599 included.", "CROWDSEC_BOUNCER_BAN_RESPONSE_CODE")
+	}
+	cacheMode := OptionalEnv("CROWDSEC_BOUNCER_CACHE_MODE", "none")
+	if !contains([]string{"none", "live", "stream"}, cacheMode) {
+		log.Fatalf("Cache mode must be one of 'none', 'stream' or 'live'")
+	}
+  cacheStreamInterval := OptionalEnv("CROWDSEC_BOUNCER_CACHE_STREAM_INTERVAL", "1m")
+	duration, err := time.ParseDuration(cacheStreamInterval)
+	if err != nil && duration.Seconds() < 3600 {
+		log.Fatalf("Cache stream interval provided is not valid")
+	}
+	defaultCacheDuration := OptionalEnv("CROWDSEC_DEFAULT_CACHE_DURATION", "5m")
+	duration2, err := time.ParseDuration(defaultCacheDuration)
+	if err != nil && duration2.Seconds() < 3600 {
+		log.Fatalf("Cache default duration provided is not valid")
+	}
+}

go.mod

@@ -0,0 +1,3 @@
+module github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin
+
+go 1.17