├── .gitignore
├── go.mod
├── Dockerfile
├── .github
└── workflows
│ ├── go.yml
│ └── dockerhub.yaml
├── healthCheck.go
├── tor_test.go
├── go.sum
├── README.md
├── tor.go
├── main.go
└── LICENSE
/.gitignore:
--------------------------------------------------------------------------------
1 | data-dir*/
2 | test*/
3 | *.log
--------------------------------------------------------------------------------
/go.mod:
--------------------------------------------------------------------------------
1 | module github.com/JustHumanz/Go-MultiTor
2 |
3 | go 1.16
4 |
5 | require (
6 | github.com/cretz/bine v0.2.0
7 | github.com/gorilla/mux v1.8.0
8 | github.com/pytimer/mux-logrus v0.0.0-20200505085744-ce5a5e748151
9 | github.com/sirupsen/logrus v1.8.1
10 | golang.org/x/net v0.0.0-20210525063256-abc453219eb5
11 | )
12 |
--------------------------------------------------------------------------------
/Dockerfile:
--------------------------------------------------------------------------------
1 | FROM golang:alpine as builder
2 | RUN apk update --no-cache && apk add git
3 | COPY . /app
4 | WORKDIR /app
5 | RUN go build -o MultiTOR
6 |
7 | FROM alpine
8 | RUN apk update --no-cache && apk add tor
9 | RUN adduser -D app
10 | WORKDIR /home/app
11 | COPY --from=builder /app/MultiTOR .
12 | RUN chown app.app -R .
13 | USER app
14 | EXPOSE 2525 1412
15 | CMD ["./MultiTOR"]
16 |
--------------------------------------------------------------------------------
/.github/workflows/go.yml:
--------------------------------------------------------------------------------
1 | name: Go
2 |
3 | on:
4 | push:
5 | branches: [ master ]
6 | pull_request:
7 | branches: [ master ]
8 |
9 | jobs:
10 |
11 | build:
12 | runs-on: ubuntu-latest
13 | steps:
14 | - uses: actions/checkout@v2
15 |
16 | - name: Set up Go
17 | uses: actions/setup-go@v2
18 | with:
19 | go-version: 1.17
20 |
21 | - name: Build
22 | run: go build -v ./...
23 |
24 | - name: Test
25 | run: go test -v ./...
26 |
--------------------------------------------------------------------------------
/.github/workflows/dockerhub.yaml:
--------------------------------------------------------------------------------
1 | name: build multitor
2 |
3 | on:
4 | push:
5 | branches:
6 | - 'master'
7 |
8 | jobs:
9 | build:
10 | runs-on: ubuntu-latest
11 | steps:
12 | -
13 | name: Checkout
14 | uses: actions/checkout@v2
15 | -
16 | name: Set up QEMU
17 | uses: docker/setup-qemu-action@v1
18 | -
19 | name: Set up Docker Buildx
20 | uses: docker/setup-buildx-action@v1
21 | -
22 | name: Login to DockerHub
23 | uses: docker/login-action@v1
24 | with:
25 | username: ${{ secrets.DOCKERHUB_USERNAME }}
26 | password: ${{ secrets.DOCKERHUB_TOKEN }}
27 | -
28 | name: Build and push
29 | uses: docker/build-push-action@v2
30 | with:
31 | context: .
32 | push: true
33 | tags: justhumanz/go-multitor
34 |
35 |
--------------------------------------------------------------------------------
/healthCheck.go:
--------------------------------------------------------------------------------
1 | package main
2 |
3 | import (
4 | "net/http"
5 | "time"
6 |
7 | log "github.com/sirupsen/logrus"
8 | "golang.org/x/net/proxy"
9 | )
10 |
11 | //HealthCheck tor circuit checker
12 | func HealthCheck(t []TorStruct) {
13 | log.WithFields(log.Fields{
14 | "Len": len(t),
15 | }).Info("Start check tor circuit")
16 |
17 | for i, v := range t {
18 | dialSocksProxy, err := proxy.SOCKS5("tcp", *hostNode+":"+v.Port, nil, proxy.Direct)
19 | if err != nil {
20 | log.Error(err)
21 | }
22 | tr := &http.Transport{
23 | Dial: dialSocksProxy.Dial,
24 | }
25 | _, res, err := Curl(&http.Client{
26 | Transport: tr,
27 | Timeout: 10 * time.Second,
28 | })
29 | if err != nil || res.StatusCode != http.StatusOK {
30 | log.WithFields(log.Fields{
31 | "Error": err,
32 | "IP Addr": v.IPAddr,
33 | "Country": v.Country,
34 | }).Info("Delete dirty circuit")
35 | v.DeleteCircuit()
36 | t = RemoveTorList(t, i)
37 |
38 | log.Info("Request new tor circuit")
39 | newTor, err := initTor(1)
40 | if err != nil {
41 | log.Error(err)
42 | }
43 | t = append(t, newTor...)
44 |
45 | } else {
46 | log.WithFields(log.Fields{
47 | "IP Addr": v.IPAddr,
48 | "Country": v.Country,
49 | }).Info("Circuit OK")
50 | }
51 | }
52 | }
53 |
--------------------------------------------------------------------------------
/tor_test.go:
--------------------------------------------------------------------------------
1 | package main
2 |
3 | import (
4 | "testing"
5 | )
6 |
7 | var torTest = TorStruct{
8 | TorList: nil,
9 | Port: "2525",
10 | IPAddr: "127.0.0.1",
11 | Country: "ID",
12 | City: "Jakarta",
13 | Load: 100,
14 | }
15 |
16 | func TestChangeCountry(t *testing.T) {
17 | countryTest := "JP"
18 | t.Logf("new country %s", countryTest)
19 | torTest.AddCountry(countryTest)
20 | if torTest.Country != countryTest {
21 | t.Errorf("country should be changed into %s", countryTest)
22 | }
23 | }
24 |
25 | func TestChangeIP(t *testing.T) {
26 | ipTest := "192.168.1.254"
27 | t.Logf("new ip %s", ipTest)
28 | torTest.AddIP(ipTest)
29 | if torTest.IPAddr != ipTest {
30 | t.Errorf("ip should be changed into %s", ipTest)
31 | }
32 | }
33 |
34 | func TestTorRRLB(t *testing.T) {
35 | torTestSlice := []TorStruct{torTest, torTest}
36 |
37 | t.Logf("test round robin LB")
38 | torTestLb := GetTorLB(torTestSlice)
39 |
40 | //it's should be the first slice of torTestSlice
41 | if torTestLb.Load != torTest.Load+1 {
42 | t.Errorf("failed to counter TorStruct load")
43 | }
44 | }
45 |
46 | func TestTorLcLB(t *testing.T) {
47 | newTorTest := torTest
48 | newTorTest.Load = 10
49 |
50 | t.Logf("test least connetion LB")
51 | torTestSlice := []TorStruct{torTest, newTorTest}
52 | torTestLb := GetTorLBWeight(torTestSlice)
53 |
54 | //it's should be the secound slice of torTestSlice
55 | if torTestLb.Load != newTorTest.Load+1 {
56 | t.Errorf("failed to counter TorStruct load")
57 | }
58 | }
59 |
--------------------------------------------------------------------------------
/go.sum:
--------------------------------------------------------------------------------
1 | github.com/cretz/bine v0.2.0 h1:8GiDRGlTgz+o8H9DSnsl+5MeBK4HsExxgl6WgzOCuZo=
2 | github.com/cretz/bine v0.2.0/go.mod h1:WU4o9QR9wWp8AVKtTM1XD5vUHkEqnf2vVSo6dBqbetI=
3 | github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
4 | github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
5 | github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
6 | github.com/gorilla/mux v1.7.4/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So=
7 | github.com/gorilla/mux v1.8.0 h1:i40aqfkR1h2SlN9hojwV5ZA91wcXFOvkdNIeFDP5koI=
8 | github.com/gorilla/mux v1.8.0/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So=
9 | github.com/konsorten/go-windows-terminal-sequences v1.0.3/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ=
10 | github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
11 | github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
12 | github.com/pytimer/mux-logrus v0.0.0-20200505085744-ce5a5e748151 h1:2cqVHP0JQ6V2POM75KwMQVq2T03mYilTFhwmWygiX7I=
13 | github.com/pytimer/mux-logrus v0.0.0-20200505085744-ce5a5e748151/go.mod h1:STLGZ9ThqAtmDb8QM4Sv2TUSzWBmOddOJZ9HSfBbzro=
14 | github.com/sirupsen/logrus v1.6.0/go.mod h1:7uNnSEd1DgxDLC74fIahvMZmmYsHGZGEOFrfsX/uA88=
15 | github.com/sirupsen/logrus v1.8.1 h1:dJKuHgqk1NNQlqoA6BTlM1Wf9DOH3NBjQyu0h9+AZZE=
16 | github.com/sirupsen/logrus v1.8.1/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0=
17 | github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
18 | github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
19 | github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
20 | github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
21 | golang.org/x/crypto v0.0.0-20210513164829-c07d793c2f9a h1:kr2P4QFmQr29mSLA43kwrOcgcReGTfbE9N577tCTuBc=
22 | golang.org/x/crypto v0.0.0-20210513164829-c07d793c2f9a/go.mod h1:P+XmwS30IXTQdn5tA2iutPOUgjI07+tq3H3K9MVA1s8=
23 | golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
24 | golang.org/x/net v0.0.0-20210525063256-abc453219eb5 h1:wjuX4b5yYQnEQHzd+CBcrcC6OVR2J1CN6mUy0oSxIPo=
25 | golang.org/x/net v0.0.0-20210525063256-abc453219eb5/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
26 | golang.org/x/sys v0.0.0-20190422165155-953cdadca894/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
27 | golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
28 | golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
29 | golang.org/x/sys v0.0.0-20210423082822-04245dca01da h1:b3NXsE2LusjYGGjL5bxEVZZORm/YEFFrWFjR8eFrw/c=
30 | golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
31 | golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
32 | golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
33 | golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
34 | golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
35 | gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
36 | gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
37 | gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
38 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | ## Go Multi Tor
2 | Multitor with golang
3 |
4 |
5 | ### Purpose
6 | this tools was inspired by [multitor](https://github.com/trimstray/multitor),but multitor was not very scalable with container and have issuse with high memory usage
7 |
8 |
9 | ### Workflow
10 |
11 | ```
12 | ┌───────────────────────┐
13 | │ │
14 | │ Mux (Rest api) │
15 | ┌───────────────┤ ├───────────────────────────┐
16 | | │ Controller │ │
17 | | │ │ │
18 | | └────────────┬──────────┘ │
19 | | │ │
20 | | │ │
21 | | │ │
22 | | │ │
23 | | │ │
24 | | │ xxxxx│xxxxxxxxxx
25 | | │ x ┌──┴─────┐ x
26 | | │ x │ │ x
27 | | │ x │ Tor │ x
28 | | │ ┌────────────────x─┤ │ x
29 | │ │ │ x └────────┘ x
30 | │ │ │ x Tor cluster x
31 | │ ┌───────────────┴────────────────┤ x ┌────────┐ x
32 | │ | │ x │ │ x
33 | User ├────────────┤ Socks5 tcp load balancer ├────────────────x─┤ Tor │ x
34 | │ │ x │ │ x
35 | └────────────────────────────────┤ x └────────┘ x
36 | │ x x
37 | │ x ┌────────┐ x
38 | │ x │ │ x
39 | └────────────────x─┤ Tor │ x
40 | x │ │ x
41 | x └────────┘ x
42 | xxxxxxxxxxxxxxxx
43 |
44 |
45 | ```
46 | Create a bunch of tor circuit > load balancing theme with round robin > serve as ~~http~~ socks5 proxy
47 |
48 | ### Requirement
49 | - tor
50 | - go1.16.5 linux/amd64
51 |
52 | ### Use
53 | Deploy
54 | ```
55 | docker run -it -d -p 1412:1412 -p 2525:2525 --name=go-multitor justhumanz/go-multitor
56 | ```
57 | Test
58 | ```
59 | while true;do curl -x socks5://localhost:1412 https://ifconfig.me;printf "\n";done
60 | ```
61 |
62 | ### Rest API
63 | soon
64 |
65 | ### Features
66 | - [x] Scalable tor circuit
67 | - [x] Rest API
68 | - [x] Http proxy
69 | - [x] Scoks5 load balancer
70 | - [x] Rest API use authentication
71 | - [ ] Multiple tor circuit nodes
72 | - [x] Tor health check
73 |
--------------------------------------------------------------------------------
/tor.go:
--------------------------------------------------------------------------------
1 | package main
2 |
3 | import (
4 | "context"
5 | "encoding/json"
6 | "fmt"
7 | "io/ioutil"
8 | "net/http"
9 | "strconv"
10 | "strings"
11 | "sync"
12 | "time"
13 |
14 | "github.com/cretz/bine/tor"
15 | log "github.com/sirupsen/logrus"
16 | "golang.org/x/net/proxy"
17 | )
18 |
19 | type TorStruct struct {
20 | TorList *tor.Tor
21 | Port string
22 | IPAddr string
23 | Country string
24 | City string
25 | Load int
26 | }
27 |
28 | func (p *TorStruct) AddCountry(new string) *TorStruct {
29 | p.Country = new
30 | return p
31 | }
32 |
33 | func (p *TorStruct) AddIP(new string) *TorStruct {
34 | p.IPAddr = new
35 | return p
36 | }
37 |
38 | func (i *TorStruct) TorStructLoad() *TorStruct {
39 | i.Load++
40 | return i
41 | }
42 |
43 | func initTor(n int) ([]TorStruct, error) {
44 | var TorList []TorStruct
45 | var wg sync.WaitGroup
46 | for i := PortUsage; i < PortUsage+n; i++ {
47 | wg.Add(1)
48 |
49 | go func(wg *sync.WaitGroup, j int) {
50 | defer wg.Done()
51 | Port := strconv.Itoa(j)
52 | Time := *renewIP * 60
53 | Args := []string{"SOCKSPort", Port, "MaxCircuitDirtiness", strconv.Itoa(Time)}
54 | if *exitNode != "" {
55 | exitNodeSlice := []string{}
56 | for _, v := range strings.Split(*exitNode, ",") {
57 | exitNodeSlice = append(exitNodeSlice, fmt.Sprintf("{%s}", v))
58 | }
59 |
60 | Args = append(Args, "StrictNodes", "1", "ExitNodes", strings.Join(exitNodeSlice, ","), "Log", "debug")
61 | }
62 |
63 | t, err := tor.Start(context.Background(), &tor.StartConf{
64 | ExePath: *torPath,
65 | ExtraArgs: Args,
66 | EnableNetwork: true,
67 | RetainTempDataDir: false,
68 | })
69 | if err != nil {
70 | log.Fatal(err)
71 | }
72 | log.WithFields(log.Fields{
73 | "Args": Args,
74 | }).Info("Successfully create new tor circuit")
75 |
76 | dialSocksProxy, err := proxy.SOCKS5("tcp", *hostNode+":"+Port, nil, proxy.Direct)
77 | if err != nil {
78 | log.Fatal(err)
79 | }
80 |
81 | body, _, err := Curl(&http.Client{
82 | Transport: &http.Transport{Dial: dialSocksProxy.Dial},
83 | })
84 | if err != nil {
85 | log.Error(err)
86 | t.Close()
87 | return
88 | }
89 |
90 | var ipInfo IpinfoIo
91 |
92 | err = json.Unmarshal(body, &ipInfo)
93 | if err != nil {
94 | log.Error(err)
95 | }
96 |
97 | log.WithFields(log.Fields{
98 | "RealIP": ipInfoOri.IP,
99 | "TorIP": ipInfo.IP,
100 | "Country": ipInfo.Country,
101 | }).Info("Testing tor circuit")
102 |
103 | TorList = append(TorList, TorStruct{
104 | TorList: t,
105 | Port: Port,
106 | Country: ipInfo.Country,
107 | IPAddr: ipInfo.IP,
108 | City: ipInfo.City,
109 | })
110 | }(&wg, i)
111 |
112 | }
113 | wg.Wait()
114 | PortUsage = PortUsage + n
115 | return TorList, nil
116 | }
117 |
118 | func CurlTor(s string, p TorStruct) (*http.Response, error) {
119 | dialSocksProxy, err := proxy.SOCKS5("tcp", *hostNode+":"+p.Port, nil, proxy.Direct)
120 | if err != nil {
121 | return nil, err
122 | }
123 | tr := &http.Transport{Dial: dialSocksProxy.Dial}
124 |
125 | // Create client
126 | myClient := &http.Client{
127 | Transport: tr,
128 | Timeout: 2 * time.Minute,
129 | }
130 | res, err := myClient.Get(s)
131 | if err != nil {
132 | return nil, err
133 | }
134 | return res, nil
135 |
136 | }
137 |
138 | func TortoMap(p []TorStruct) map[int]interface{} {
139 | A := make(map[int]interface{})
140 | for i, v := range p {
141 | A[i] = map[string]interface{}{
142 | "IP Address": v.IPAddr,
143 | "Socks5": *hostNode + ":" + v.Port,
144 | "Country": v.Country,
145 | "City": v.City,
146 | }
147 | }
148 | return A
149 | }
150 |
151 | func (p TorStruct) DeleteCircuit() {
152 | p.TorList.Close()
153 | }
154 |
155 | func RemoveTorList(s []TorStruct, index int) []TorStruct {
156 | return append(s[:index], s[index+1:]...)
157 | }
158 |
159 | var Counter = 0
160 |
161 | //GetTorLB Get one tor slice
162 | func GetTorLB(i []TorStruct) *TorStruct {
163 | Circuit := i[Counter].TorStructLoad()
164 | Counter++
165 |
166 | if Counter >= (len(i)) {
167 | Counter = 0
168 | }
169 |
170 | return Circuit
171 | }
172 |
173 | func GetTorLBWeight(i []TorStruct) *TorStruct {
174 | Circuit := TorStruct{}
175 | for j := 0; j < len(i); j++ {
176 | currenCir := i[j]
177 | nextCir := i[j+1].TorStructLoad()
178 |
179 | if nextCir.Load <= currenCir.Load {
180 | Circuit = *nextCir
181 | break
182 | }
183 | }
184 |
185 | return &Circuit
186 | }
187 |
188 | type IpinfoIo struct {
189 | IP string `json:"ip"`
190 | City string `json:"city"`
191 | Region string `json:"region"`
192 | Country string `json:"country"`
193 | Loc string `json:"loc"`
194 | Org string `json:"org"`
195 | Timezone string `json:"timezone"`
196 | Readme string `json:"readme"`
197 | }
198 |
199 | func Curl(c *http.Client) ([]byte, *http.Response, error) {
200 | res, err := c.Get(ifconfig)
201 | if err != nil {
202 | return nil, nil, err
203 | }
204 |
205 | defer res.Body.Close()
206 | body, err := ioutil.ReadAll(res.Body)
207 | if err != nil {
208 | return nil, nil, err
209 | }
210 |
211 | return body, res, nil
212 | }
213 |
--------------------------------------------------------------------------------
/main.go:
--------------------------------------------------------------------------------
1 | package main
2 |
3 | import (
4 | "encoding/base64"
5 | "encoding/json"
6 | "flag"
7 | "io"
8 | "math/rand"
9 | "net"
10 | "net/http"
11 | "strconv"
12 | "strings"
13 | "time"
14 |
15 | "github.com/gorilla/mux"
16 | muxlogrus "github.com/pytimer/mux-logrus"
17 |
18 | log "github.com/sirupsen/logrus"
19 | )
20 |
21 | const ifconfig string = "https://ipinfo.io"
22 |
23 | var torPath = flag.String("tor", "/usr/bin/tor", "path of tor binary file")
24 | var torCircuit = flag.Int("circuit", 10, "total of torCircuit")
25 | var renewIP = flag.Int("lifeSpan", 10, "duration of tor ip address")
26 | var exitNode = flag.String("exitNode", "", "specific country torCircuit (separated by comma)")
27 | var hostNode = flag.String("host", "0.0.0.0", "hostname or ip address")
28 | var RestAPIPort = flag.String("apiPort", "2525", "rest api port")
29 | var socksLBPort = flag.String("lbPort", "1412", "socks5 load balancing port")
30 | var LBalgo = flag.String("lbAlgo", "rr", "choice algorithm for loadbalancing,rr(round robin)&lc(least connetion)")
31 | var PortUsage = 9090
32 | var ipInfoOri IpinfoIo
33 | var acessKey = flag.String("key", "", "add api key,if key empty key will be created")
34 |
35 | var who, _ = base64.StdEncoding.DecodeString(img)
36 |
37 | func init() {
38 | log.SetFormatter(&log.TextFormatter{FullTimestamp: true, DisableColors: true})
39 | }
40 |
41 | func main() {
42 | flag.Parse()
43 | Secret := ""
44 | if *acessKey == "" {
45 | const letterBytes = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ123456789=-_"
46 | Secret = func() string {
47 | b := make([]byte, 36)
48 | for i := range b {
49 | b[i] = letterBytes[rand.Intn(len(letterBytes))]
50 | }
51 | return string(b)
52 | }()
53 |
54 | } else {
55 | Secret = *acessKey
56 | }
57 |
58 | log.Info("Aceess key ", Secret, " add this key into http header as 'access_key'")
59 |
60 | bodyNormal, _, err := Curl(&http.Client{})
61 | if err != nil {
62 | log.Fatalln(err)
63 | }
64 | err = json.Unmarshal(bodyNormal, &ipInfoOri)
65 | if err != nil {
66 | log.Fatalln(err)
67 | }
68 |
69 | torList, err := initTor(*torCircuit)
70 | if err != nil {
71 | log.Error(err)
72 | }
73 | log.WithFields(log.Fields{
74 | "Tor circuit": len(torList),
75 | }).Info("Done testing tor circuit")
76 |
77 | router := mux.NewRouter()
78 | router.HandleFunc("/", func(rw http.ResponseWriter, r *http.Request) {
79 | rw.Header().Set("Access-Control-Allow-Origin", "*")
80 | rw.Header().Set("Content-Type", "application/json")
81 | rw.WriteHeader(http.StatusOK)
82 | json.NewEncoder(rw).Encode(map[string]interface{}{
83 | "Date": time.Now(),
84 | "Proxy": map[string]interface{}{
85 | "Socks5": "socks5://" + *hostNode + ":" + *socksLBPort,
86 | },
87 | })
88 | })
89 |
90 | router.HandleFunc("/info", func(rw http.ResponseWriter, r *http.Request) {
91 | rw.Header().Set("Access-Control-Allow-Origin", "*")
92 | rw.Header().Set("Content-Type", "application/json")
93 | rw.WriteHeader(http.StatusOK)
94 | json.NewEncoder(rw).Encode(TortoMap(torList))
95 | })
96 |
97 | router.HandleFunc("/add/{new:[0-9]+}", func(rw http.ResponseWriter, r *http.Request) {
98 | if r.Header.Get("access_key") == "" {
99 | rw.WriteHeader(http.StatusUnauthorized)
100 | rw.Write(who)
101 | return
102 | }
103 |
104 | newreq := mux.Vars(r)["new"]
105 | reqint, err := strconv.Atoi(newreq)
106 | if err != nil {
107 | log.Error(err)
108 | rw.WriteHeader(http.StatusBadRequest)
109 | rw.Write([]byte(err.Error()))
110 | return
111 |
112 | }
113 | Create := func() []TorStruct {
114 | log.Info("Request new tor circuit")
115 | newTor, err := initTor(reqint)
116 | if err != nil {
117 | log.Error(err)
118 | rw.WriteHeader(http.StatusInternalServerError)
119 | rw.Write([]byte(err.Error()))
120 | return nil
121 | }
122 |
123 | torList = append(torList, newTor...)
124 | return torList
125 | }
126 | if reqint > 10 {
127 | go Create()
128 | rw.Header().Set("Access-Control-Allow-Origin", "*")
129 | rw.Header().Set("Content-Type", "application/json")
130 | rw.WriteHeader(http.StatusOK)
131 | json.NewEncoder(rw).Encode(map[string]interface{}{
132 | "Status": http.StatusOK,
133 | })
134 | return
135 | } else {
136 | newTor := Create()
137 | rw.Header().Set("Access-Control-Allow-Origin", "*")
138 | rw.Header().Set("Content-Type", "application/json")
139 | rw.WriteHeader(http.StatusOK)
140 | json.NewEncoder(rw).Encode(TortoMap(newTor))
141 | }
142 |
143 | }).Methods(http.MethodPost)
144 |
145 | Delete := router.PathPrefix("/delete").Subrouter()
146 | Delete.HandleFunc("/ip/{ip}", func(rw http.ResponseWriter, r *http.Request) {
147 | if r.Header.Get("access_key") == "" {
148 | rw.WriteHeader(http.StatusUnauthorized)
149 | rw.Write(who)
150 | return
151 | }
152 |
153 | newreq := strings.Split(mux.Vars(r)["ip"], ",")
154 | log.Info("Delete tor circuit by ip")
155 | for i, v := range torList {
156 | for _, v2 := range newreq {
157 | if v.IPAddr == v2 {
158 | torList = RemoveTorList(torList, i)
159 | }
160 | }
161 | }
162 |
163 | rw.Header().Set("Access-Control-Allow-Origin", "*")
164 | rw.Header().Set("Content-Type", "application/json")
165 | rw.WriteHeader(http.StatusOK)
166 | json.NewEncoder(rw).Encode(TortoMap(torList))
167 | }).Methods(http.MethodPost)
168 |
169 | Delete.HandleFunc("/ip/country/{country}", func(rw http.ResponseWriter, r *http.Request) {
170 | if r.Header.Get("access_key") == "" {
171 | rw.WriteHeader(http.StatusUnauthorized)
172 | rw.Write(who)
173 | return
174 | }
175 |
176 | newreq := strings.Split(mux.Vars(r)["country"], ",")
177 | log.Info("Delete tor circuit by country")
178 | for i, v := range torList {
179 | for _, v2 := range newreq {
180 | if v.Country == v2 {
181 | torList = RemoveTorList(torList, i)
182 | }
183 | }
184 | }
185 |
186 | rw.Header().Set("Access-Control-Allow-Origin", "*")
187 | rw.Header().Set("Content-Type", "application/json")
188 | rw.WriteHeader(http.StatusOK)
189 | json.NewEncoder(rw).Encode(TortoMap(torList))
190 | }).Methods(http.MethodPost)
191 |
192 | Delete.HandleFunc("/ip/city/{city}", func(rw http.ResponseWriter, r *http.Request) {
193 | if r.Header.Get("access_key") == "" {
194 | rw.WriteHeader(http.StatusUnauthorized)
195 | rw.Write(who)
196 | return
197 | }
198 |
199 | newreq := strings.Split(mux.Vars(r)["city"], ",")
200 | log.Info("Delete tor circuit by city")
201 | for i, v := range torList {
202 | for _, v2 := range newreq {
203 | if v.City == v2 {
204 | torList = RemoveTorList(torList, i)
205 | }
206 | }
207 | }
208 |
209 | rw.Header().Set("Access-Control-Allow-Origin", "*")
210 | rw.Header().Set("Content-Type", "application/json")
211 | rw.WriteHeader(http.StatusOK)
212 | json.NewEncoder(rw).Encode(TortoMap(torList))
213 | }).Methods(http.MethodPost)
214 |
215 | router.Use(muxlogrus.NewLogger().Middleware)
216 |
217 | go func() {
218 | listener, err := net.Listen("tcp", *hostNode+":"+*socksLBPort)
219 | if err != nil {
220 | panic(err)
221 | }
222 | for {
223 | conn, err := listener.Accept()
224 | if err != nil {
225 | log.Error("error accepting connection ", err)
226 | continue
227 | }
228 | go func() {
229 | TorCir := func() *TorStruct {
230 | if *LBalgo == "lc" {
231 | return GetTorLBWeight(torList)
232 | } else {
233 | return GetTorLB(torList)
234 | }
235 | }()
236 |
237 | addr := "localhost:" + TorCir.Port
238 | log.WithFields(log.Fields{
239 | "Tor IP": TorCir.IPAddr,
240 | "Source Address": conn.LocalAddr().String(),
241 | "Socks5 Address": addr,
242 | "Circuit Load": TorCir.Load,
243 | }).Info("Tcp load balancer")
244 |
245 | conn2, err := net.DialTimeout("tcp", addr, 10*time.Second)
246 | if err != nil {
247 | log.Error("error dialing remote addr ", err)
248 | log.Info("Deleting dirty circuit")
249 | for i, v := range torList {
250 | if v.IPAddr == TorCir.IPAddr {
251 | torList = RemoveTorList(torList, i)
252 | }
253 | }
254 | log.Info("Request new circuit")
255 | newTor, err := initTor(1)
256 | if err != nil {
257 | log.Error(err)
258 | return
259 | }
260 | torList = append(torList, newTor...)
261 | return
262 | }
263 | go io.Copy(conn2, conn)
264 | io.Copy(conn, conn2)
265 | conn2.Close()
266 | conn.Close()
267 | }()
268 | }
269 |
270 | }()
271 |
272 | go func() {
273 | for {
274 | log.Info("Start tor Health check")
275 | HealthCheck(torList)
276 | time.Sleep(2 * time.Hour)
277 | }
278 | }()
279 |
280 | http.ListenAndServe(":"+*RestAPIPort, router)
281 | }
282 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------