commit 8ad48648bc69c78c33773ea481a3bd1335ec166b Author: perp Date: Thu Jul 25 12:47:36 2024 +0100 First commit diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..ba70db3 --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# Falcon +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0.html) + +Falcon is a proxy verifying library made in Go + +## Features +- Supports SOCKS5/4/4A & HTTP +- Proxy information lookup +- Full channel control +- 1 external dependency + +## Examples +Check `examples` directory + +## Disclaimer +###### Developers are not responsible for any misuse diff --git a/examples/advanced.go b/examples/advanced.go new file mode 100644 index 0000000..edef29e --- /dev/null +++ b/examples/advanced.go @@ -0,0 +1,46 @@ +package main + +import ( + "fmt" + "os" + "strings" + + "git.supernets.org/perp/falcon" +) + +const ( + reset = "\033[0m" + blue = "\033[34m" + green = "\033[32m" + red = "\033[31m" +) + +func main() { + content, err := os.ReadFile(os.Args[1]) + if err != nil { + panic(err) + } + + f := falcon.New(strings.Split(string(content), "\n")) + go f.Start() + + var count int + + for range len(f.Proxies) { + select { + case socks5 := <-f.SOCKS5: + count += 1 + + fmt.Printf("%sIP%s: %s%s\n", green, reset, blue, socks5.Query) + fmt.Printf("%sISP%s: %s%s\n", blue, reset, green, socks5.Isp) + fmt.Printf("%sCountry%s: %s%s\n", green, reset, blue, socks5.Country) + fmt.Printf("%sCity%s: %s%s\n", blue, reset, green, socks5.City) + fmt.Println(reset) + + case err := <-f.Error: + fmt.Printf("%s%s%s\n", red, err, reset) + } + } + + fmt.Printf("Found %s%d%s SOCKS5 proxies\n", green, count, reset) +} diff --git a/examples/basic.go b/examples/basic.go new file mode 100644 index 0000000..8219bf6 --- /dev/null +++ b/examples/basic.go @@ -0,0 +1,27 @@ +package main + +import ( + "fmt" + + "git.supernets.org/perp/falcon" +) + +func main() { + f := falcon.New([]string{"socks5://127.0.0.1:1337"}) + go f.Start() + + for range len(f.Proxies) { + select { + case socks5 := <-f.SOCKS5: + fmt.Println(socks5) + case socks4 := <-f.SOCKS4: + fmt.Println(socks4) + case socks4a := <-f.SOCKS4A: + fmt.Println(socks4a) + case http := <-f.HTTP: + fmt.Println(http) + case err := <-f.Error: + fmt.Println(err) + } + } +} diff --git a/falcon.go b/falcon.go new file mode 100644 index 0000000..b68b813 --- /dev/null +++ b/falcon.go @@ -0,0 +1,58 @@ +package falcon + +import ( + "sync" + "time" +) + +// Falcon represents a proxy checker +type Falcon struct { + // Proxies to verify + Proxies []string + // Proxy timeout (default: 5 seconds) + Timeout time.Duration + // Checking status + Running bool + // Incoming proxies + *Channels + + wg *sync.WaitGroup +} + +// New will return a default Falcon +func New(proxies []string) *Falcon { + return &Falcon{ + Proxies: proxies, + Timeout: time.Second * 5, + Running: false, + Channels: &Channels{ + SOCKS5: make(chan *Lookup), + SOCKS4: make(chan *Lookup), + SOCKS4A: make(chan *Lookup), + HTTP: make(chan *Lookup), + Error: make(chan error), + }, + wg: &sync.WaitGroup{}, + } +} + +// Start will start the proxy checker +func (f *Falcon) Start() { + f.Running = true + + for _, proxy := range f.Proxies { + if f.Running { + f.wg.Add(1) + go f.Verify(proxy, f.Timeout) + f.wg.Done() + } + } + + f.wg.Wait() + f.Running = false +} + +// Stop will stop the proxy checker +func (f *Falcon) Stop() { + f.Running = false +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..2719785 --- /dev/null +++ b/go.mod @@ -0,0 +1,5 @@ +module git.supernets.org/perp/falcon + +go 1.22.4 + +require h12.io/socks v1.0.3 diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..c892c67 --- /dev/null +++ b/go.sum @@ -0,0 +1,6 @@ +github.com/h12w/go-socks5 v0.0.0-20200522160539-76189e178364 h1:5XxdakFhqd9dnXoAZy1Mb2R/DZ6D1e+0bGC/JhucGYI= +github.com/h12w/go-socks5 v0.0.0-20200522160539-76189e178364/go.mod h1:eDJQioIyy4Yn3MVivT7rv/39gAJTrA7lgmYr8EW950c= +github.com/phayes/freeport v0.0.0-20180830031419-95f893ade6f2 h1:JhzVVoYvbOACxoUmOs6V/G4D5nPVUW73rKvXxP4XUJc= +github.com/phayes/freeport v0.0.0-20180830031419-95f893ade6f2/go.mod h1:iIss55rKnNBTvrwdmkUpLnDpZoAHvWaiq5+iMmen4AE= +h12.io/socks v1.0.3 h1:Ka3qaQewws4j4/eDQnOdpr4wXsC//dXtWvftlIcCQUo= +h12.io/socks v1.0.3/go.mod h1:AIhxy1jOId/XCz9BO+EIgNL2rQiPTBNnOfnVnQ+3Eck= diff --git a/proxy.go b/proxy.go new file mode 100644 index 0000000..3ba659d --- /dev/null +++ b/proxy.go @@ -0,0 +1,114 @@ +package falcon + +import ( + "encoding/json" + "fmt" + "io" + "net/http" + "time" +) + +// Endpoint for proxy lookup +var endpoint = "http://ip-api.com/json?fields=66842623" + +// Lookup represents a proxy lookup +type Lookup struct { + Status string `json:"status"` + Continent string `json:"continent"` + ContinentCode string `json:"continentCode"` + Country string `json:"country"` + CountryCode string `json:"countryCode"` + Region string `json:"region"` + RegionName string `json:"regionName"` + City string `json:"city"` + District string `json:"district"` + Zip string `json:"zip"` + Lat float64 `json:"lat"` + Lon float64 `json:"lon"` + Timezone string `json:"timezone"` + Offset int `json:"offset"` + Currency string `json:"currency"` + Isp string `json:"isp"` + Org string `json:"org"` + As string `json:"as"` + Asname string `json:"asname"` + Mobile bool `json:"mobile"` + Proxy bool `json:"proxy"` + Hosting bool `json:"hosting"` + Query string `json:"query"` +} + +// Channels represents incoming proxy channels +type Channels struct { + // Incoming verified SOCKS5 proxies + SOCKS5 chan *Lookup + // Incoming verified SOCKS4 proxies + SOCKS4 chan *Lookup + // Incoming verified SOCKS4A proxies + SOCKS4A chan *Lookup + // Incoming verified HTTP proxies + HTTP chan *Lookup + // Incoming errors + Error chan error +} + +// Verify will verify a proxy +func (c *Channels) Verify(proxy string, timeout time.Duration) { + // Create transport + scheme, transport, err := Transport(proxy) + if err != nil { + c.Error <- err + return + } + + // Create client + client := &http.Client{ + Timeout: timeout, + Transport: transport, + } + + // Create request + req, err := http.NewRequest("GET", endpoint, nil) + if err != nil { + c.Error <- err + return + } + + // Execute request + res, err := client.Do(req) + if err != nil { + c.Error <- err + return + } + + // Read body + body, err := io.ReadAll(res.Body) + if err != nil { + c.Error <- err + return + } + + // Store lookup + var lookup Lookup + + // Unmarshal JSON + err = json.Unmarshal(body, &lookup) + if err != nil { + c.Error <- err + return + } + + // Check scheme + switch scheme { + case "socks5": + c.SOCKS5 <- &lookup + case "socks4": + c.SOCKS4 <- &lookup + case "socks4a": + c.SOCKS4A <- &lookup + case "https", "http": + c.HTTP <- &lookup + default: + c.Error <- fmt.Errorf("unknown proxy scheme: %s", scheme) + } +} diff --git a/transport.go b/transport.go new file mode 100644 index 0000000..b43385d --- /dev/null +++ b/transport.go @@ -0,0 +1,42 @@ +package falcon + +import ( + "crypto/tls" + "fmt" + "net/http" + "net/url" + + "h12.io/socks" +) + +// Transport will return a http.Transport for the proxy protocol +func Transport(proxy string) (scheme string, transport *http.Transport, err error) { + // Parse URL + proxyURL, err := url.Parse(proxy) + if err != nil { + return "", nil, err + } + + // Check scheme & create transport + switch proxyURL.Scheme { + case "socks5", "socks4", "socks4a": + transport = &http.Transport{ + Dial: socks.Dial(proxy), + } + case "https", "http": + transport = &http.Transport{ + Proxy: http.ProxyURL(proxyURL), + } + default: + return "", nil, fmt.Errorf( + "unknown proxy protocol scheme: %s", + proxyURL.Scheme, + ) + } + + // Set options + transport.DisableKeepAlives = true + transport.TLSClientConfig = &tls.Config{InsecureSkipVerify: true} + + return proxyURL.Scheme, transport, nil +}