Skip to content

Commit 43345b3

Browse files
committed
chore: init
0 parents  commit 43345b3

File tree

11 files changed

+951
-0
lines changed

11 files changed

+951
-0
lines changed

.traefik.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Traefik plugin manifest for tianji plugin
2+
displayName: Tianji Plugin
3+
type: middleware
4+
import: github.com/msgbyte/traefik-tianji-plugin
5+
6+
summary: 'A Traefik plugin for Tianji analytics integration'
7+
8+
testData:
9+
forwardPath: _tianji
10+
tianjiHost: http://localhost:12345
11+
websiteId: "test-website-id"

LICENSE

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
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.

Makefile

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
.PHONY: lint test vendor clean
2+
3+
export GO111MODULE=on
4+
5+
default: lint test
6+
7+
test:
8+
go test -v -cover ./...
9+
10+
yaegi_test:
11+
yaegi test -v .
12+
13+
vendor:
14+
go mod vendor
15+
16+
clean:
17+
rm -rf ./vendor

forwarding.go

Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
package traefik_tianji_plugin
2+
3+
// Copied source from
4+
// https://github.com/kzmake/traefik-plugin-forward-request/blob/master/util.go
5+
6+
import (
7+
"bytes"
8+
"io"
9+
"io/ioutil"
10+
"net"
11+
"net/http"
12+
"strings"
13+
)
14+
15+
const (
16+
xForwardedProto = "x-forwarded-proto"
17+
xForwardedFor = "x-forwarded-for"
18+
xForwardedHost = "x-forwarded-host"
19+
xForwardedPort = "x-forwarded-port"
20+
xForwardedURI = "x-forwarded-uri"
21+
xForwardedMethod = "x-forwarded-method"
22+
23+
connection = "connection"
24+
keepAlive = "keep-alive"
25+
proxyAuthenticate = "proxy-authenticate"
26+
proxyAuthorization = "proxy-authorization"
27+
te = "te" // canonicalized version of "TE"
28+
trailers = "trailers"
29+
transferEncoding = "transfer-Encoding"
30+
upgrade = "upgrade"
31+
)
32+
33+
var hopHeaders = []string{
34+
connection,
35+
keepAlive,
36+
proxyAuthenticate,
37+
proxyAuthorization,
38+
te, // canonicalized version of "TE"
39+
trailers,
40+
transferEncoding,
41+
upgrade,
42+
}
43+
44+
func newForwardRequest(req *http.Request, forwardURL string) (*http.Request, error) {
45+
drainedBody, body, err := drainBody(req.Body)
46+
req.Body = body
47+
if err != nil {
48+
return nil, err
49+
}
50+
51+
fReq, err := http.NewRequestWithContext(req.Context(), req.Method, forwardURL, drainedBody)
52+
if err != nil {
53+
return nil, err
54+
}
55+
56+
copyHeaders(fReq.Header, req.Header)
57+
removeHeaders(fReq.Header, hopHeaders...)
58+
writeXForwardedHeaders(fReq.Header, req)
59+
60+
return fReq, nil
61+
}
62+
63+
func drainBody(b io.ReadCloser) (r1, r2 io.ReadCloser, err error) {
64+
if b == nil || b == http.NoBody {
65+
return http.NoBody, http.NoBody, nil
66+
}
67+
var buf bytes.Buffer
68+
if _, err = buf.ReadFrom(b); err != nil {
69+
return nil, b, err
70+
}
71+
if err := b.Close(); err != nil {
72+
return nil, b, err
73+
}
74+
75+
return ioutil.NopCloser(&buf), ioutil.NopCloser(bytes.NewReader(buf.Bytes())), nil
76+
}
77+
78+
func copyHeaders(dst, src http.Header) {
79+
for k, vv := range src {
80+
for _, v := range vv {
81+
dst.Add(k, v)
82+
}
83+
}
84+
}
85+
86+
func removeHeaders(headers http.Header, names ...string) {
87+
for _, h := range names {
88+
headers.Del(h)
89+
}
90+
}
91+
92+
func writeXForwardedHeaders(dst http.Header, req *http.Request) {
93+
if clientIP, _, err := net.SplitHostPort(req.RemoteAddr); err == nil {
94+
if values := req.Header.Values(xForwardedFor); len(values) > 0 {
95+
clientIP = strings.Join(values, ", ") + ", " + clientIP
96+
}
97+
dst.Set(xForwardedFor, clientIP)
98+
}
99+
100+
xfm := req.Header.Get(xForwardedMethod)
101+
switch {
102+
case xfm != "":
103+
dst.Set(xForwardedMethod, xfm)
104+
case req.Method != "":
105+
dst.Set(xForwardedMethod, req.Method)
106+
default:
107+
dst.Del(xForwardedMethod)
108+
}
109+
110+
xfp := req.Header.Get(xForwardedProto)
111+
switch {
112+
case xfp != "":
113+
dst.Set(xForwardedProto, xfp)
114+
case req.TLS != nil:
115+
dst.Set(xForwardedProto, "https")
116+
default:
117+
dst.Set(xForwardedProto, "http")
118+
}
119+
120+
if xfp := req.Header.Get(xForwardedPort); xfp != "" {
121+
dst.Set(xForwardedPort, xfp)
122+
}
123+
124+
xfh := req.Header.Get(xForwardedHost)
125+
switch {
126+
case xfh != "":
127+
dst.Set(xForwardedHost, xfh)
128+
case req.Host != "":
129+
dst.Set(xForwardedHost, req.Host)
130+
default:
131+
dst.Del(xForwardedHost)
132+
}
133+
134+
xfu := req.Header.Get(xForwardedURI)
135+
switch {
136+
case xfu != "":
137+
dst.Set(xForwardedURI, xfu)
138+
case req.URL.RequestURI() != "":
139+
dst.Set(xForwardedURI, req.URL.RequestURI())
140+
default:
141+
dst.Del(xForwardedURI)
142+
}
143+
}
144+
145+
func overrideHeaders(dst, src http.Header, overrideHeaders ...string) {
146+
removeHeaders(dst, overrideHeaders...)
147+
148+
for _, overrideHeader := range overrideHeaders {
149+
values := src.Values(overrideHeader)
150+
for _, v := range values {
151+
dst.Add(overrideHeader, v)
152+
}
153+
}
154+
}

go.mod

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module github.com/msgbyte/traefik-tianji-plugin
2+
3+
go 1.19

go.work

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
go 1.19
2+
3+
use .

0 commit comments

Comments
 (0)