├── .gitignore ├── go.mod ├── Makefile ├── .traefik.yml ├── .golangci.toml ├── .github └── workflows │ ├── go-cross.yml │ └── main.yml ├── README.md ├── blockuseragent.go ├── blockuseragent_test.go └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .idea/ 2 | .DS_Store 3 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/agence-gaya/traefik-plugin-blockuseragent 2 | 3 | go 1.23 4 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: lint test vendor clean 2 | 3 | export GO123MODULE=on 4 | 5 | default: lint test 6 | 7 | lint: 8 | golangci-lint run 9 | 10 | test: 11 | go test -v -cover ./... 12 | 13 | yaegi_test: 14 | yaegi test -v . 15 | 16 | vendor: 17 | go mod vendor 18 | 19 | clean: 20 | rm -rf ./vendor -------------------------------------------------------------------------------- /.traefik.yml: -------------------------------------------------------------------------------- 1 | displayName: Block User-Agent 2 | summary: Blocks HTTP requests with a User-Agent matching the configured regex. 3 | type: middleware 4 | import: github.com/agence-gaya/traefik-plugin-blockuseragent 5 | compatibility: TODO 6 | testData: 7 | Regex: 8 | - "\buseragent1\b|\buseragent2\b|\buseragent3\b|\buseragent4\b" 9 | - "\buseragent5\b|\buseragent6\b|\buseragent7\b|\buseragent8\b" 10 | -------------------------------------------------------------------------------- /.golangci.toml: -------------------------------------------------------------------------------- 1 | [run] 2 | timeout = "3m" 3 | skip-files = [] 4 | skip-dirs = [] 5 | 6 | [linters-settings] 7 | 8 | [linters-settings.govet] 9 | check-shadowing = false 10 | 11 | [linters-settings.golint] 12 | min-confidence = 0.0 13 | 14 | [linters-settings.gocyclo] 15 | min-complexity = 12.0 16 | 17 | [linters-settings.maligned] 18 | suggest-new = true 19 | 20 | [linters-settings.goconst] 21 | min-len = 3.0 22 | min-occurrences = 4.0 23 | 24 | [linters-settings.misspell] 25 | locale = "US" 26 | 27 | [linters-settings.funlen] 28 | lines = 60 # default 60 29 | statements = 40 # default 40 30 | 31 | [linters] 32 | enable-all = true 33 | disable = [ 34 | "bodyclose", 35 | "goerr113", 36 | "nlreturn", 37 | "testpackage", 38 | "paralleltest", 39 | "tparallel", 40 | ] 41 | 42 | [issues] 43 | exclude-use-default = false 44 | max-per-linter = 0 45 | max-same-issues = 0 46 | exclude = [ 47 | "don't use an underscore in package name", 48 | "ST1003: should not use underscores in package names", 49 | "got 'user-agent' want 'userAgent'" 50 | ] 51 | 52 | [[issues.exclude-rules]] 53 | path = "(.+)_test.go" 54 | linters = ["goconst", "funlen", "godot", "scopelint"] -------------------------------------------------------------------------------- /.github/workflows/go-cross.yml: -------------------------------------------------------------------------------- 1 | name: Go Matrix 2 | on: [push, pull_request] 3 | 4 | jobs: 5 | 6 | cross: 7 | name: Go 8 | runs-on: ${{ matrix.os }} 9 | env: 10 | CGO_ENABLED: 0 11 | 12 | strategy: 13 | matrix: 14 | go-version: [ 1.23, 1.x ] 15 | os: [ubuntu-latest, macos-latest, windows-latest] 16 | 17 | steps: 18 | # https://github.com/marketplace/actions/setup-go-environment 19 | - name: Set up Go ${{ matrix.go-version }} 20 | uses: actions/setup-go@v2 21 | with: 22 | go-version: ${{ matrix.go-version }} 23 | 24 | # https://github.com/marketplace/actions/checkout 25 | - name: Checkout code 26 | uses: actions/checkout@v2 27 | 28 | # https://github.com/marketplace/actions/cache 29 | - name: Cache Go modules 30 | uses: actions/cache@v2 31 | with: 32 | path: | 33 | ~/go/pkg/mod # Module download cache 34 | ~/.cache/go-build # Build cache (Linux) 35 | ~/Library/Caches/go-build # Build cache (Mac) 36 | '%LocalAppData%\go-build' # Build cache (Windows) 37 | key: ${{ runner.os }}-${{ matrix.go-version }}-go-${{ hashFiles('**/go.sum') }} 38 | restore-keys: | 39 | ${{ runner.os }}-${{ matrix.go-version }}-go- 40 | 41 | - name: Test 42 | run: go test -v -cover ./... 43 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Block User-Agent 2 | 3 | [![Build Status](https://github.com/agence-gaya/traefik-plugin-blockuseragent/workflows/Main/badge.svg?branch=master)](https://github.com/agence-gaya/traefik-plugin-blockuseragent/actions) 4 | 5 | Block User-Agent is a middleware plugin for [Traefik](https://github.com/traefik/traefik) which sends an HTTP `403 Forbidden` 6 | response when the requested HTTP User-Agent header matches one the configured [regular expressions](https://github.com/google/re2/wiki/Syntax). 7 | 8 | ## Configuration 9 | 10 | ## StaticUpdate 11 | 12 | ```toml 13 | [pilot] 14 | token="xxx" 15 | 16 | [experimental.plugins.blockuseragent] 17 | modulename = "github.com/agence-gaya/traefik-plugin-blockuseragent" 18 | version = "vX.Y.Z" 19 | ``` 20 | 21 | ## Dynamic 22 | 23 | To configure the `Block User-Agent` plugin you should create a [middleware](https://docs.traefik.io/middlewares/overview/) in 24 | your dynamic configuration as explained [here](https://docs.traefik.io/middlewares/overview/). The following example creates 25 | and uses the `blockuseragent` middleware plugin to block all HTTP requests with a User-Agent like `\bTheAgent\b`. 26 | You can use regexAllow to make exception on blocking regex. 27 | 28 | ```toml 29 | [http.routers] 30 | [http.routers.my-router] 31 | rule = "Host(`localhost`)" 32 | middlewares = ["block-foo"] 33 | service = "my-service" 34 | 35 | # Block all user agent containing TheAgent except if containing Allowed word 36 | [http.middlewares] 37 | [http.middlewares.block-foo.plugin.blockuseragent] 38 | regexAllow = ["\bAllowed\b"] 39 | regex = ["\bTheAgent\b"] 40 | 41 | [http.services] 42 | [http.services.my-service] 43 | [http.services.my-service.loadBalancer] 44 | [[http.services.my-service.loadBalancer.servers]] 45 | url = "http://127.0.0.1" 46 | ``` 47 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: Main 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | tags: 8 | - v* 9 | pull_request: 10 | 11 | jobs: 12 | 13 | main: 14 | name: Main Process 15 | runs-on: ubuntu-latest 16 | env: 17 | GO_VERSION: 1.23 18 | GOLANGCI_LINT_VERSION: v1.61.0 19 | YAEGI_VERSION: v0.16.1 20 | CGO_ENABLED: 0 21 | defaults: 22 | run: 23 | working-directory: ${{ github.workspace }}/go/src/github.com/${{ github.repository }} 24 | 25 | steps: 26 | 27 | # https://github.com/marketplace/actions/setup-go-environment 28 | - name: Set up Go ${{ env.GO_VERSION }} 29 | uses: actions/setup-go@v2 30 | with: 31 | go-version: ${{ env.GO_VERSION }} 32 | 33 | # https://github.com/marketplace/actions/checkout 34 | - name: Check out code 35 | uses: actions/checkout@v2 36 | with: 37 | path: go/src/github.com/${{ github.repository }} 38 | fetch-depth: 0 39 | 40 | # https://github.com/marketplace/actions/cache 41 | - name: Cache Go modules 42 | uses: actions/cache@v2 43 | with: 44 | path: ${{ github.workspace }}/go/pkg/mod 45 | key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }} 46 | restore-keys: | 47 | ${{ runner.os }}-go- 48 | 49 | # https://golangci-lint.run/usage/install#other-ci 50 | - name: Install golangci-lint ${{ env.GOLANGCI_LINT_VERSION }} 51 | run: curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin ${GOLANGCI_LINT_VERSION} 52 | 53 | - name: Install Yaegi ${{ env.YAEGI_VERSION }} 54 | run: curl -sfL https://raw.githubusercontent.com/traefik/yaegi/master/install.sh | bash -s -- -b $(go env GOPATH)/bin ${YAEGI_VERSION} 55 | 56 | - name: Setup GOPATH 57 | run: go env -w GOPATH=${{ github.workspace }}/go 58 | 59 | - name: Check and get dependencies 60 | run: | 61 | go mod tidy 62 | git diff --exit-code go.mod 63 | # git diff --exit-code go.sum 64 | go mod download 65 | go mod vendor 66 | # git diff --exit-code ./vendor/ 67 | 68 | - name: Lint and Tests 69 | run: make 70 | 71 | - name: Run tests with Yaegi 72 | run: make yaegi_test 73 | env: 74 | GOPATH: ${{ github.workspace }}/go 75 | -------------------------------------------------------------------------------- /blockuseragent.go: -------------------------------------------------------------------------------- 1 | // Package traefik_plugin_blockuseragent a plugin to block User-Agent. 2 | package traefik_plugin_blockuseragent 3 | 4 | import ( 5 | "context" 6 | "encoding/json" 7 | "fmt" 8 | "log" 9 | "net/http" 10 | "regexp" 11 | ) 12 | 13 | // Config holds the plugin configuration. 14 | type Config struct { 15 | RegexAllow []string `json:"regexAllow,omitempty"` 16 | Regex []string `json:"regex,omitempty"` 17 | } 18 | 19 | // CreateConfig creates and initializes the plugin configuration. 20 | func CreateConfig() *Config { 21 | return &Config{RegexAllow: make([]string, 0), Regex: make([]string, 0)} 22 | } 23 | 24 | // BlockUserAgent struct. 25 | type BlockUserAgent struct { 26 | name string 27 | next http.Handler 28 | regexpsAllow []*regexp.Regexp 29 | regexpsDeny []*regexp.Regexp 30 | } 31 | 32 | // BlockUserAgentMessage struct. 33 | type BlockUserAgentMessage struct { 34 | Regex int `json:"regex"` 35 | UserAgent string `json:"user-agent"` 36 | RemoteAddr string `json:"ip"` 37 | Host string `json:"host"` 38 | RequestURI string `json:"uri"` 39 | } 40 | 41 | // New creates and returns a plugin instance. 42 | func New(_ context.Context, next http.Handler, config *Config, name string) (http.Handler, error) { 43 | regexpsAllow := make([]*regexp.Regexp, len(config.RegexAllow)) 44 | regexpsDeny := make([]*regexp.Regexp, len(config.Regex)) 45 | 46 | for index, regex := range config.RegexAllow { 47 | re, err := regexp.Compile(regex) 48 | if err != nil { 49 | return nil, fmt.Errorf("error compiling regexAllow %q: %w", regex, err) 50 | } 51 | 52 | regexpsAllow[index] = re 53 | } 54 | 55 | for index, regex := range config.Regex { 56 | re, err := regexp.Compile(regex) 57 | if err != nil { 58 | return nil, fmt.Errorf("error compiling regex %q: %w", regex, err) 59 | } 60 | 61 | regexpsDeny[index] = re 62 | } 63 | 64 | return &BlockUserAgent{ 65 | name: name, 66 | next: next, 67 | regexpsAllow: regexpsAllow, 68 | regexpsDeny: regexpsDeny, 69 | }, nil 70 | } 71 | 72 | func (b *BlockUserAgent) ServeHTTP(res http.ResponseWriter, req *http.Request) { 73 | if req != nil { 74 | userAgent := req.UserAgent() 75 | 76 | for _, re := range b.regexpsAllow { 77 | if re.MatchString(userAgent) { 78 | b.next.ServeHTTP(res, req) 79 | 80 | return 81 | } 82 | } 83 | 84 | for index, re := range b.regexpsDeny { 85 | if re.MatchString(userAgent) { 86 | message := &BlockUserAgentMessage{ 87 | Regex: index, 88 | UserAgent: userAgent, 89 | RemoteAddr: req.RemoteAddr, 90 | Host: req.Host, 91 | RequestURI: req.RequestURI, 92 | } 93 | jsonMessage, err := json.Marshal(message) 94 | 95 | if err == nil { 96 | log.Printf("%s: %s", b.name, jsonMessage) 97 | } 98 | 99 | res.WriteHeader(http.StatusForbidden) 100 | 101 | return 102 | } 103 | } 104 | } 105 | 106 | b.next.ServeHTTP(res, req) 107 | } 108 | -------------------------------------------------------------------------------- /blockuseragent_test.go: -------------------------------------------------------------------------------- 1 | package traefik_plugin_blockuseragent 2 | 3 | import ( 4 | "context" 5 | "net/http" 6 | "net/http/httptest" 7 | "testing" 8 | ) 9 | 10 | func TestNew(t *testing.T) { 11 | tests := []struct { 12 | desc string 13 | regexAllow []string 14 | regexDeny []string 15 | expErr bool 16 | }{ 17 | { 18 | desc: "should return no error", 19 | regexAllow: []string{`\bagent1\b`}, 20 | regexDeny: []string{`\bagent2\b`}, 21 | expErr: false, 22 | }, 23 | { 24 | desc: "should return an error", 25 | regexAllow: []string{"*"}, 26 | regexDeny: nil, 27 | expErr: true, 28 | }, 29 | { 30 | desc: "should return an error", 31 | regexAllow: nil, 32 | regexDeny: []string{"*"}, 33 | expErr: true, 34 | }, 35 | } 36 | 37 | for _, test := range tests { 38 | t.Run(test.desc, func(t *testing.T) { 39 | cfg := &Config{ 40 | RegexAllow: test.regexAllow, 41 | Regex: test.regexDeny, 42 | } 43 | 44 | if _, err := New(context.Background(), nil, cfg, "name"); test.expErr && err == nil { 45 | t.Errorf("expected error on bad regexp format") 46 | } 47 | }) 48 | } 49 | } 50 | 51 | func TestServeHTTP(t *testing.T) { 52 | tests := []struct { 53 | desc string 54 | regexAllow []string 55 | regexDeny []string 56 | reqUserAgent string 57 | reqURI string 58 | expNextCall bool 59 | expStatusCode int 60 | }{ 61 | { 62 | desc: "should return forbidden status", 63 | regexAllow: nil, 64 | regexDeny: []string{"\\bagent1\\b"}, 65 | reqUserAgent: "agent1", 66 | reqURI: "http://localhost/", 67 | expNextCall: false, 68 | expStatusCode: http.StatusForbidden, 69 | }, 70 | { 71 | desc: "should return forbidden status", 72 | regexAllow: nil, 73 | regexDeny: []string{"\\bagent1\\b", "\\bagent2\\b"}, 74 | reqUserAgent: "agent2", 75 | reqURI: "http://localhost/test", 76 | expNextCall: false, 77 | expStatusCode: http.StatusForbidden, 78 | }, 79 | { 80 | desc: "should return ok status", 81 | regexAllow: nil, 82 | regexDeny: []string{"\\bagent1\\b", "\\bagent2\\b"}, 83 | reqUserAgent: "agentok", 84 | reqURI: "http://localhost/test", 85 | expNextCall: true, 86 | expStatusCode: http.StatusOK, 87 | }, 88 | { 89 | desc: "should return ok status", 90 | regexAllow: nil, 91 | regexDeny: nil, 92 | reqUserAgent: "agentok", 93 | reqURI: "http://localhost/test", 94 | expNextCall: true, 95 | expStatusCode: http.StatusOK, 96 | }, 97 | { 98 | desc: "should return forbidden status", 99 | regexAllow: nil, 100 | regexDeny: []string{"\\bagent.*"}, 101 | reqUserAgent: "agent1", 102 | reqURI: "http://localhost/test", 103 | expNextCall: false, 104 | expStatusCode: http.StatusForbidden, 105 | }, 106 | { 107 | desc: "should return forbidden status", 108 | regexAllow: nil, 109 | regexDeny: []string{"^agent.*"}, 110 | reqUserAgent: "agent1", 111 | reqURI: "http://localhost/test", 112 | expNextCall: false, 113 | expStatusCode: http.StatusForbidden, 114 | }, 115 | { 116 | desc: "should return forbidden status", 117 | regexAllow: nil, 118 | regexDeny: []string{"^$"}, 119 | reqUserAgent: "", 120 | reqURI: "http://localhost/test", 121 | expNextCall: false, 122 | expStatusCode: http.StatusForbidden, 123 | }, 124 | { 125 | desc: "should return ok status", 126 | regexAllow: nil, 127 | regexDeny: []string{"^$"}, 128 | reqUserAgent: "agentok", 129 | reqURI: "http://localhost/test", 130 | expNextCall: true, 131 | expStatusCode: http.StatusOK, 132 | }, 133 | { 134 | desc: "should return ok status", 135 | regexAllow: []string{"^agent1$"}, 136 | regexDeny: []string{".*"}, 137 | reqUserAgent: "agent1", 138 | reqURI: "http://localhost/test", 139 | expNextCall: true, 140 | expStatusCode: http.StatusOK, 141 | }, 142 | { 143 | desc: "should return ok status", 144 | regexAllow: []string{"^agent1$", "^agent2$"}, 145 | regexDeny: []string{".*"}, 146 | reqUserAgent: "agent2", 147 | reqURI: "http://localhost/test", 148 | expNextCall: true, 149 | expStatusCode: http.StatusOK, 150 | }, 151 | { 152 | desc: "should return forbidden status", 153 | regexAllow: []string{"^agent1$", "^agent2$"}, 154 | regexDeny: []string{".*"}, 155 | reqUserAgent: "agent3", 156 | reqURI: "http://localhost/test", 157 | expNextCall: false, 158 | expStatusCode: http.StatusForbidden, 159 | }, 160 | { 161 | desc: "should return ok status", 162 | regexAllow: []string{"^agent1$", "^agent2$"}, 163 | regexDeny: nil, 164 | reqUserAgent: "agent3", 165 | reqURI: "http://localhost/test", 166 | expNextCall: true, 167 | expStatusCode: http.StatusOK, 168 | }, 169 | { 170 | desc: "should return forbidden status", 171 | regexAllow: []string{"\\bAllowed\\b"}, 172 | regexDeny: []string{"\\bTheAgent\\b"}, 173 | reqUserAgent: "This is TheAgent-1.0", 174 | reqURI: "http://localhost/test", 175 | expNextCall: false, 176 | expStatusCode: http.StatusForbidden, 177 | }, 178 | { 179 | desc: "should return ok status", 180 | regexAllow: []string{"\\bAllowed\\b"}, 181 | regexDeny: []string{"\\bTheAgent\\b"}, 182 | reqUserAgent: "This is TheAgent-Allowed-1.0", 183 | reqURI: "http://localhost/test", 184 | expNextCall: true, 185 | expStatusCode: http.StatusOK, 186 | }, 187 | } 188 | 189 | for _, test := range tests { 190 | t.Run(test.desc, func(t *testing.T) { 191 | cfg := &Config{ 192 | RegexAllow: test.regexAllow, 193 | Regex: test.regexDeny, 194 | } 195 | 196 | nextCall := false 197 | next := http.HandlerFunc(func(_ http.ResponseWriter, _ *http.Request) { 198 | nextCall = true 199 | }) 200 | 201 | handler, err := New(context.Background(), next, cfg, "blockuseragent") 202 | if err != nil { 203 | t.Fatal(err) 204 | } 205 | 206 | recorder := httptest.NewRecorder() 207 | 208 | req := httptest.NewRequest(http.MethodGet, test.reqURI, nil) 209 | req.Header.Add("User-Agent", test.reqUserAgent) 210 | 211 | handler.ServeHTTP(recorder, req) 212 | 213 | if nextCall != test.expNextCall { 214 | t.Errorf("next handler should not be called") 215 | } 216 | 217 | if recorder.Result().StatusCode != test.expStatusCode { 218 | t.Errorf("got status code %d, want %d", recorder.Code, test.expStatusCode) 219 | } 220 | }) 221 | } 222 | } 223 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2020 Containous SAS 190 | Copyright 2020 Traefik Labs 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | --------------------------------------------------------------------------------