Repository: ihciah/rabbit-tcp Branch: master Commit: ea572ad8e73b Files: 36 Total size: 106.4 KB Directory structure: gitextract_0wlk6vej/ ├── .github/ │ └── workflows/ │ ├── build.yml │ ├── publish-docker.yml │ └── release.yml ├── .gitignore ├── Dockerfile ├── LICENCE ├── Makefile ├── README.MD ├── README_ZH.MD ├── block/ │ └── block.go ├── client/ │ └── client.go ├── cmd/ │ └── rabbit.go ├── connection/ │ ├── block_processor.go │ ├── connection.go │ ├── const.go │ ├── inbound_connection.go │ ├── outbound_connection.go │ └── ring_buffer.go ├── connection_pool/ │ └── pool.go ├── docker-compose-client.yml ├── docker-compose-server.yml ├── go.mod ├── go.sum ├── logger/ │ └── logger.go ├── peer/ │ ├── client.go │ ├── peer.go │ ├── peer_group.go │ └── server.go ├── server/ │ └── server.go ├── tunnel/ │ ├── aead.go │ ├── cipher.go │ └── tunnel.go └── tunnel_pool/ ├── const.go ├── manager.go ├── pool.go └── tunnel.go ================================================ FILE CONTENTS ================================================ ================================================ FILE: .github/workflows/build.yml ================================================ name: Build on: [push] jobs: build: name: Build runs-on: ubuntu-latest steps: - name: Set up Go 1.13 uses: actions/setup-go@v1 with: go-version: 1.13 id: go - name: Check out code into the Go module directory uses: actions/checkout@v1 - name: Get dependencies run: | mkdir -p ~/go/src/github.com/ihciah ln -s "$(pwd)/../rabbit-tcp" ~/go/src/github.com/ihciah/rabbit-tcp go get -v -t -d ./... - name: Build run: go build -v cmd/rabbit.go ================================================ FILE: .github/workflows/publish-docker.yml ================================================ name: Publish Docker on: push: tags: - 'v*' jobs: build: name: Publish Docker runs-on: ubuntu-latest steps: - name: Check out code into the Go module directory uses: actions/checkout@v1 - name: Publish to Registry uses: ihciah/Publish-Docker-Github-Action@master with: name: ihciah/rabbit username: ${{ secrets.DOCKER_USERNAME }} password: ${{ secrets.DOCKER_PASSWORD }} spectag: ${{ github.ref }} ================================================ FILE: .github/workflows/release.yml ================================================ name: Upload Release on: push: tags: - 'v*' jobs: build: name: Upload Release runs-on: ubuntu-latest steps: - name: Checkout code uses: actions/checkout@master - name: Set up Go 1.13 uses: actions/setup-go@v1 with: go-version: 1.13 id: go - name: Check out code into the Go module directory uses: actions/checkout@v1 - name: Get dependencies run: | mkdir -p ~/go/src/github.com/ihciah ln -s "$(pwd)/../rabbit-tcp" ~/go/src/github.com/ihciah/rabbit-tcp go get -v -t -d ./... - name: Build run: | TAG=${{ github.ref }} TAG=${TAG#"refs/tags/"} TAG=${TAG#"v"} TAG=${TAG#"V"} make releases RABBITVERSION=$TAG - name: Create Release id: create_release uses: actions/create-release@v1.0.0 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} with: tag_name: ${{ github.ref }} release_name: Release ${{ github.ref }} draft: false prerelease: false - name: Upload Release windows-amd64 uses: actions/upload-release-asset@v1.0.1 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} with: upload_url: ${{ steps.create_release.outputs.upload_url }} asset_path: bin/rabbit-windows-amd64.zip asset_name: rabbit-windows-amd64.zip asset_content_type: application/zip - name: Upload Release windows-386 uses: actions/upload-release-asset@v1.0.1 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} with: upload_url: ${{ steps.create_release.outputs.upload_url }} asset_path: bin/rabbit-windows-386.zip asset_name: rabbit-windows-386.zip asset_content_type: application/zip - name: Upload Release linux-amd64 uses: actions/upload-release-asset@v1.0.1 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} with: upload_url: ${{ steps.create_release.outputs.upload_url }} asset_path: bin/rabbit-linux-amd64.gz asset_name: rabbit-linux-amd64.gz asset_content_type: application/gzip - name: Upload Release linux-386 uses: actions/upload-release-asset@v1.0.1 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} with: upload_url: ${{ steps.create_release.outputs.upload_url }} asset_path: bin/rabbit-linux-386.gz asset_name: rabbit-linux-386.gz asset_content_type: application/gzip - name: Upload Release linux-arm64 uses: actions/upload-release-asset@v1.0.1 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} with: upload_url: ${{ steps.create_release.outputs.upload_url }} asset_path: bin/rabbit-linux-arm64.gz asset_name: rabbit-linux-arm64.gz asset_content_type: application/gzip - name: Upload Release linux-arm uses: actions/upload-release-asset@v1.0.1 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} with: upload_url: ${{ steps.create_release.outputs.upload_url }} asset_path: bin/rabbit-linux-arm.gz asset_name: rabbit-linux-arm.gz asset_content_type: application/gzip - name: Upload Release darwin-amd64 uses: actions/upload-release-asset@v1.0.1 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} with: upload_url: ${{ steps.create_release.outputs.upload_url }} asset_path: bin/rabbit-darwin-amd64.gz asset_name: rabbit-darwin-amd64.gz asset_content_type: application/gzip - name: Upload Release darwin-386 uses: actions/upload-release-asset@v1.0.1 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} with: upload_url: ${{ steps.create_release.outputs.upload_url }} asset_path: bin/rabbit-darwin-386.gz asset_name: rabbit-darwin-386.gz asset_content_type: application/gzip ================================================ FILE: .gitignore ================================================ # Binaries for programs and plugins *.exe *.exe~ *.dll *.so *.dylib # Test binary, build with `go test -c` *.test # Output of the go coverage tool, specifically when used with LiteIDE *.out # idea .idea /bin ================================================ FILE: Dockerfile ================================================ FROM golang:1-alpine AS builder RUN mkdir -p /go/src/github.com/ihciah/rabbit-tcp COPY . /go/src/github.com/ihciah/rabbit-tcp RUN apk upgrade \ && apk add git \ && apk add make \ && cd /go/src/github.com/ihciah/rabbit-tcp \ && go get -v -t -d ./... \ && make FROM alpine:latest AS dist LABEL maintainer="ihciah " ENV MODE s ENV PASSWORD PASSWORD ENV RABBITADDR :443 ENV LISTEN :9891 ENV DEST= ENV TUNNELN 6 ENV VERBOSE 2 COPY --from=builder /go/src/github.com/ihciah/rabbit-tcp/bin/rabbit /usr/bin/rabbit CMD exec rabbit \ --mode=$MODE \ --password=$PASSWORD \ --rabbit-addr=$RABBITADDR \ --listen=$LISTEN \ --dest=$DEST \ --tunnelN=$TUNNELN \ --verbose=$VERBOSE ================================================ FILE: LICENCE ================================================ GNU AFFERO GENERAL PUBLIC LICENSE Version 3, 19 November 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU Affero General Public License is a free, copyleft license for software and other kinds of works, specifically designed to ensure cooperation with the community in the case of network server software. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, our General Public Licenses are intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. Developers that use our General Public Licenses protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License which gives you legal permission to copy, distribute and/or modify the software. A secondary benefit of defending all users' freedom is that improvements made in alternate versions of the program, if they receive widespread use, become available for other developers to incorporate. Many developers of free software are heartened and encouraged by the resulting cooperation. However, in the case of software used on network servers, this result may fail to come about. The GNU General Public License permits making a modified version and letting the public access it on a server without ever releasing its source code to the public. The GNU Affero General Public License is designed specifically to ensure that, in such cases, the modified source code becomes available to the community. It requires the operator of a network server to provide the source code of the modified version running there to the users of that server. Therefore, public use of a modified version, on a publicly accessible server, gives the public access to the source code of the modified version. An older license, called the Affero General Public License and published by Affero, was designed to accomplish similar goals. This is a different license, not a version of the Affero GPL, but Affero has released a new version of the Affero GPL which permits relicensing under this license. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU Affero General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Remote Network Interaction; Use with the GNU General Public License. Notwithstanding any other provision of this License, if you modify the Program, your modified version must prominently offer all users interacting with it remotely through a computer network (if your version supports such interaction) an opportunity to receive the Corresponding Source of your version by providing access to the Corresponding Source from a network server at no charge, through some standard or customary means of facilitating copying of software. This Corresponding Source shall include the Corresponding Source for any work covered by version 3 of the GNU General Public License that is incorporated pursuant to the following paragraph. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the work with which it is combined will remain governed by version 3 of the GNU General Public License. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU Affero General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU Affero General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU Affero General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU Affero General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. You should have received a copy of the GNU Affero General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If your software can interact with users remotely through a computer network, you should also make sure that it provides a way for users to get its source. For example, if your program is a web application, its interface could display a "Source" link that leads users to an archive of the code. There are many ways you could offer source, and different solutions will be better for different programs; see section 13 for the specific requirements. You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU AGPL, see . ================================================ FILE: Makefile ================================================ NAME=rabbit BINDIR=bin VERSIONPARAM= ifdef RABBITVERSION VERSIONPARAM=-X 'main.Version=$(RABBITVERSION)' endif GOBUILD=CGO_ENABLED=0 go build -ldflags "-w -s $(VERSIONPARAM)" BUILDFILE=cmd/rabbit.go current: $(GOBUILD) -o $(BINDIR)/$(NAME) $(BUILDFILE) all: linux-amd64 linux-386 linux-arm64 linux-arm darwin-amd64 darwin-386 windows-amd64 windows-386 linux-amd64: GOARCH=amd64 GOOS=linux $(GOBUILD) -o $(BINDIR)/$(NAME)-$@ $(BUILDFILE) linux-386: GOARCH=386 GOOS=linux $(GOBUILD) -o $(BINDIR)/$(NAME)-$@ $(BUILDFILE) linux-arm64: GOARCH=arm64 GOOS=linux $(GOBUILD) -o $(BINDIR)/$(NAME)-$@ $(BUILDFILE) linux-arm: GOARCH=arm GOOS=linux $(GOBUILD) -o $(BINDIR)/$(NAME)-$@ $(BUILDFILE) darwin-amd64: GOARCH=amd64 GOOS=darwin $(GOBUILD) -o $(BINDIR)/$(NAME)-$@ $(BUILDFILE) darwin-386: GOARCH=386 GOOS=darwin $(GOBUILD) -o $(BINDIR)/$(NAME)-$@ $(BUILDFILE) windows-amd64: GOARCH=amd64 GOOS=windows $(GOBUILD) -o $(BINDIR)/$(NAME)-$@.exe $(BUILDFILE) windows-386: GOARCH=386 GOOS=windows $(GOBUILD) -o $(BINDIR)/$(NAME)-$@.exe $(BUILDFILE) releases: linux-amd64 linux-386 linux-arm64 linux-arm darwin-amd64 darwin-386 windows-amd64 windows-386 chmod +x $(BINDIR)/$(NAME)-* gzip $(BINDIR)/$(NAME)-linux-amd64 gzip $(BINDIR)/$(NAME)-linux-386 gzip $(BINDIR)/$(NAME)-linux-arm64 gzip $(BINDIR)/$(NAME)-linux-arm gzip $(BINDIR)/$(NAME)-darwin-amd64 gzip $(BINDIR)/$(NAME)-darwin-386 zip -m -j $(BINDIR)/$(NAME)-windows-amd64.zip $(BINDIR)/$(NAME)-windows-amd64.exe zip -m -j $(BINDIR)/$(NAME)-windows-386.zip $(BINDIR)/$(NAME)-windows-386.exe clean: rm $(BINDIR)/* ================================================ FILE: README.MD ================================================ # Rabbit TCP ![Build badge](https://github.com/ihciah/rabbit-tcp/workflows/Build/badge.svg) ![Docker pull badge](https://img.shields.io/docker/pulls/ihciah/rabbit) A multi-connection TCP forwarder created for accelerating TCP connections English | [中文](README_ZH.MD) ## Introduction This project is created to support and forward TCP connections. It will split bytes into blocks and reconstruct them during forwarding. All upper connections visible to all users are carried by `N` underlying physical connections, and even a single upper connection is forwarded through all underlying connections. Due to the use of multiple connections, similar to the multi-threaded downloader, this project can accelerate the connection without any more traffic consumption (bilateral deployment is required). This project the extension of the accelerating method of [ShadowSocks-magic](https://github.com/ihciah/go-shadowsocks-magic). ![Rabbit TCP](.github/resources/rabbit-tcp.svg) ## Get Started This project can work in standalone proxy mode or inline in other Golang code. Here are two common usage examples. For detailed documentation, please go to the [Wiki](https://github.com/ihciah/rabbit-tcp/wiki). ### Accelerate any TCP service in a standalone proxy mode #### Server side 1. Install [Docker](https://docs.docker.com/install/linux/docker-ce/debian/#install-using-the-convenience-script) and [docker-compose](https://docs.docker.com/compose/install/) 2. Download and edit `docker-compose-server.yml` ([Link](https://github.com/ihciah/rabbit-tcp/raw/master/docker-compose-server.yml)) ```yaml rabbit-server: image: ihciah/rabbit ports: - "$RABBIT_PORT:9891/tcp" environment: - MODE=s - PASSWORD=$RABBIT_PASSWORD - RABBITADDR=:9891 - VERBOSE=2 restart: always ``` - `$RABBIT_PORT` replaced with RabbitTCP service port, which should be the same as the client side - `$RABBIT_PASSWORD` replaced with RabbitTCP service password, which should be the same as the client side 3. Run in the same directory `docker-compose -f docker-compose-server.yml up -d` #### Client side 1. Install [Docker](https://docs.docker.com/install/linux/docker-ce/debian/#install-using-the-convenience-script) and [docker-compose](https://docs.docker.com/compose/install/) 2. Download and edit `docker-compose-client.yml` ([Link](https://github.com/ihciah/rabbit-tcp/raw/master/docker-compose-client.yml)) ```yaml rabbit-client: image: ihciah/rabbit ports: - "$CLIENT_LISTEN_PORT:9892/tcp" environment: - MODE=c - PASSWORD=$RABBIT_PASSWORD - RABBITADDR=$RABBIT_ADDR - LISTEN=:9892 - DEST=$SERVICE_ADDR - TUNNELN=6 - VERBOSE=2 restart: always ``` - `$RABBIT_ADDR` replaced with `ip_or_domain:port` , which should be the same as the server side - `$RABBIT_PASSWORD` replaced with RabbitTCP service password, which should be the same as the server side - `$SERVICE_ADDR` replaced with the `ip_or_domain:port` of the target service - `$CLIENT_LISTEN_PORT` replaced with local listen port, which can be dialed when connecting to the target service with acceleration. - Modify `TUNNELN` if you want to change count of physical connections 3. Run in the same directory `docker-compose -f docker-compose-server.yml up -d` ### Accelerate ShadowSocks service in a standalone proxy mode with plugin The server-side configuration is the same as above. Please note that except for Rabbit TCP server, you have to [run ShadowSocks service](https://github.com/shadowsocks/shadowsocks-libev/blob/master/docker/alpine/docker-compose.yml) too. Configure client-side as above is useful too if you want to run a forwarder on a server inside the blocked area. However, run docker or daemon service on client devices is not so user-friendly. What recommended is the plugin built for ShadowSocks: [Rabbit Plugin](https://github.com/ihciah/rabbit-plugin). 1. [Download the latest Rabbit Plugin release](https://github.com/ihciah/rabbit-plugin/releases), unzip it and put it into the ShadowSocks folder(same as ShadowSocks.exe). 2. Fill in ShadowSocks client configuration(Take [ShadowSocks Windows](https://github.com/shadowsocks/shadowsocks-windows) as an example) - Server Addr: Rabbit TCP service ip/domain - Server Port: Rabbit TCP service port - Password: ShadowSocks password - Encryption: ShadowSocks Encryption - Plugin Program: The binary filename(without `.exe`) - Plugin Options: `serviceAddr=SHADOWSOCKS_ADDR;password=RABBIT_PASSWORD;tunnelN=4` - `SHADOWSOCKS_ADDR` is ShadowSocks server address(ip:port or domain:port), for example: `10.10.10.10:443` - `RABBIT_PASSWORD` is Rabbit TCP password - Modify `tunnelN` to change count of physical connections 3. Save ## Speedup Result Environment: - `Chrome <--> ShadowsocksWindows <--> RabbitTCP <==[ISP]==> RabbitTCP <--> ShadowsocksLibev` - Local ISP: China Unicom - Shanghai - Remote ISP: Amazon LightSail - Tokyo - Physical Connections Count: 4 Speedup with Rabbit TCP([Link](https://www.speedtest.net/result/8667412671)): ![Speed with rabbit-tcp](.github/resources/SpeedWithRabbit.jpg) Original ShadowSocks libev([Link](https://www.speedtest.net/result/8667415664)): ![Speed without rabbit-tcp](.github/resources/SpeedWithoutRabbit.jpg) ================================================ FILE: README_ZH.MD ================================================ # Rabbit TCP ![Build badge](https://github.com/ihciah/rabbit-tcp/workflows/Build/badge.svg) ![Docker pull badge](https://img.shields.io/docker/pulls/ihciah/rabbit) 一个为加速而生的多连接 TCP 转发器 [English](README.MD) | 中文 ## 简介 这个项目用来承载并转发 TCP 流量，并在转发时对流量进行分拆与重组。 所有用户可见的上层连接均由 `N` 条底层物理连接承载，即便是单条用户连接也会经所有底层连接进行转发。 由于使用了多条连接，与多线程下载器类似，本项目可以在不多消耗流量的情况下对连接进行加速（需双边部署）。 这个项目是 [ShadowSocks-magic](https://github.com/ihciah/go-shadowsocks-magic) 中加速方案的扩展。 ![Rabbit TCP](.github/resources/rabbit-tcp.svg) ## 开始使用 本项目既可以以独立代理模式工作，也可以内嵌在其他 Golang 代码中提供服务。 以下列举两种常用用法，详细的文档请移步 [Wiki](https://github.com/ihciah/rabbit-tcp/wiki)。 ### 以独立代理模式加速任意 TCP 服务 #### 服务端 1. 安装 [Docker](https://docs.docker.com/install/linux/docker-ce/debian/#install-using-the-convenience-script) 和 [docker-compose](https://docs.docker.com/compose/install/) 2. 下载并修改 `docker-compose-server.yml` 文件([链接](https://github.com/ihciah/rabbit-tcp/raw/master/docker-compose-server.yml)) ```yaml rabbit-server: image: ihciah/rabbit ports: - "$RABBIT_PORT:9891/tcp" environment: - MODE=s - PASSWORD=$RABBIT_PASSWORD - RABBITADDR=:9891 - VERBOSE=2 restart: always ``` - `$RABBIT_PORT` 替换为 RabbitTCP 服务端口，与 Client 保持一致即可 - `$RABBIT_PASSWORD` 替换为 RabbitTCP 服务密码，与 Client 保持一致即可 3. 在该文件同目录运行 `docker-compose -f docker-compose-server.yml up -d` #### 客户端 1. 安装 [Docker](https://docs.docker.com/install/linux/docker-ce/debian/#install-using-the-convenience-script) 和 [docker-compose](https://docs.docker.com/compose/install/) 2. 下载并修改 `docker-compose-client.yml` 文件([链接](https://github.com/ihciah/rabbit-tcp/raw/master/docker-compose-client.yml)) ```yaml rabbit-client: image: ihciah/rabbit ports: - "$CLIENT_LISTEN_PORT:9892/tcp" environment: - MODE=c - PASSWORD=$RABBIT_PASSWORD - RABBITADDR=$RABBIT_ADDR - LISTEN=:9892 - DEST=$SERVICE_ADDR - TUNNELN=6 - VERBOSE=2 restart: always ``` - `$RABBIT_ADDR` 替换为 RabbitTCP 服务 `地址:端口` ，端口与服务端保持一致即可 - `$RABBIT_PASSWORD` 替换为 RabbitTCP 服务密码，与服务端保持一致即可 - `$SERVICE_ADDR` 替换为待加速的服务 `地址:端口` - `$CLIENT_LISTEN_PORT` 替换为本地监听端口，后续若要加速访问目标服务，连接该端口即可 - 修改 `TUNNELN` 可以控制底层物理连接数 3. 在该文件同目录运行 `docker-compose -f docker-compose-server.yml up -d` ### 以独立代理 + 插件模式加速 ShadowSocks 服务 服务端配置同上。请注意 Rabbit TCP 并不包含 ShadowSocks，你仍然需要[运行 ShadowSocks](https://github.com/shadowsocks/shadowsocks-libev/blob/master/docker/alpine/docker-compose.yml)。 客户端可以按照上述配置，如运行在国内服务器上用作中转。 在用户终端上，运行 Docker 或直接运行后台服务较为麻烦。推荐使用为 ShadowSocks 定制的插件 [Rabbit Plugin](https://github.com/ihciah/rabbit-plugin)。 1. [下载最新 Rabbit Plugin 发布版](https://github.com/ihciah/rabbit-plugin/releases)并解压缩后放入 ShadowSocks 同目录 2. 在 ShadowSocks 客户端中填写信息(以 [ShadowSocks Windows](https://github.com/shadowsocks/shadowsocks-windows) 为例) - 服务器地址填写 Rabbit TCP 服务器 - 服务器端口填写 Rabbit TCP 端口 - 密码填写 ShadowSocks 密码 - 加密方式填写 ShadowSocks 加密方式 - 插件程序填写刚刚放入的插件程序文件名(不包含 `.exe` 后缀) - 插件选项填写 `serviceAddr=SHADOWSOCKS_ADDR;password=RABBIT_PASSWORD;tunnelN=4` - `SHADOWSOCKS_ADDR` 替换为 ShadowSocks 服务地址（包含端口），如 `10.10.10.10:443` - `RABBIT_PASSWORD` 替换为 Rabbit TCP 密码，与服务端保持一致 - 修改 `tunnelN` 对应数值控制底层物理连接个数 3. 保存即可 ## 加速效果 测试环境: - `Chrome <--> ShadowsocksWindows <--> RabbitTCP <==[ISP]==> RabbitTCP <--> ShadowsocksLibev` - 本地运营商: 中国联通 - 上海 - 远程运营商: Amazon LightSail - 东京 - 底层连接数: 4 使用 Rabbit TCP 加速([Link](https://www.speedtest.net/result/8667412671)): ![Speed with rabbit-tcp](.github/resources/SpeedWithRabbit.jpg) 使用原版 ShadowSocks-libev([Link](https://www.speedtest.net/result/8667415664)): ![Speed without rabbit-tcp](.github/resources/SpeedWithoutRabbit.jpg) ================================================ FILE: block/block.go ================================================ package block import ( "encoding/binary" "io" "go.uber.org/atomic" ) const ( TypeConnect = iota TypeDisconnect TypeData ShutdownRead = iota ShutdownWrite ShutdownBoth HeaderSize = 1 + 4 + 4 + 4 DataSize = 16*1024 - 13 MaxSize = HeaderSize + DataSize ) type Block struct { Type uint8 // 1 byte ConnectionID uint32 // 4 bytes BlockID uint32 // 4 bytes BlockLength uint32 // 4 bytes BlockData []byte packed []byte } func (block *Block) Pack() []byte { if block.packed != nil { return block.packed } block.packed = make([]byte, HeaderSize+len(block.BlockData)) block.packed[0] = block.Type binary.LittleEndian.PutUint32(block.packed[1:], block.ConnectionID) binary.LittleEndian.PutUint32(block.packed[5:], block.BlockID) binary.LittleEndian.PutUint32(block.packed[9:], block.BlockLength) copy(block.packed[HeaderSize:], block.BlockData) return block.packed } func NewBlockFromReader(reader io.Reader) (*Block, error) { headerBuf := make([]byte, HeaderSize) block := Block{} _, err := io.ReadFull(reader, headerBuf) if err != nil { return nil, err } block.Type = headerBuf[0] block.ConnectionID = binary.LittleEndian.Uint32(headerBuf[1:]) block.BlockID = binary.LittleEndian.Uint32(headerBuf[5:]) block.BlockLength = binary.LittleEndian.Uint32(headerBuf[9:]) block.BlockData = make([]byte, block.BlockLength) if block.BlockLength > 0 { _, err = io.ReadFull(reader, block.BlockData) if err != nil { return nil, err } } return &block, nil } func NewConnectBlock(connectID uint32, blockID uint32, address string) Block { data := []byte(address) return Block{ Type: TypeConnect, ConnectionID: connectID, BlockID: blockID, BlockLength: uint32(len(data)), BlockData: data, } } func newDataBlock(connectID uint32, blockID uint32, data []byte) Block { // We should copy data now blk := Block{ Type: TypeData, ConnectionID: connectID, BlockID: blockID, BlockLength: uint32(len(data)), BlockData: data, } blk.Pack() return blk } func NewDataBlocks(connectID uint32, blockID *atomic.Uint32, data []byte) []Block { blocks := make([]Block, 0) for cursor := 0; cursor < len(data); { end := cursor + DataSize if len(data) < end { end = len(data) } blocks = append(blocks, newDataBlock(connectID, blockID.Inc()-1, data[cursor:end])) cursor = end } return blocks } func NewDisconnectBlock(connectID uint32, blockID uint32, shutdownType uint8) Block { return Block{ Type: TypeDisconnect, ConnectionID: connectID, BlockID: blockID, BlockLength: 1, BlockData: []byte{shutdownType}, } } ================================================ FILE: client/client.go ================================================ package client import ( "io" "net" "sync" "time" "github.com/ihciah/rabbit-tcp/connection" "github.com/ihciah/rabbit-tcp/logger" "github.com/ihciah/rabbit-tcp/peer" "github.com/ihciah/rabbit-tcp/tunnel" ) type Client struct { peer peer.ClientPeer logger *logger.Logger } func NewClient(tunnelNum int, endpoint string, cipher tunnel.Cipher) Client { return Client{ peer: peer.NewClientPeer(tunnelNum, endpoint, cipher), logger: logger.NewLogger("[Client]"), } } func (c *Client) Dial(address string) connection.HalfOpenConn { return c.peer.Dial(address) } func (c *Client) ServeForward(listen, dest string) error { listener, err := net.Listen("tcp", listen) if err != nil { return err } for { conn, err := listener.Accept() if err != nil { c.logger.Errorf("Error when accept connection: %v.\n", err) continue } go func() { c.logger.Infoln("Accepted a connection.") connProxy := c.Dial(dest) biRelay(conn.(*net.TCPConn), connProxy, c.logger) }() } } func biRelay(left, right connection.HalfOpenConn, logger *logger.Logger) { var wg sync.WaitGroup wg.Add(1) go relay(left, right, &wg, logger, "local <- tunnel") wg.Add(1) go relay(right, left, &wg, logger, "local -> tunnel") wg.Wait() // logger.Errorf("===========> Close client biRelay") _ = left.Close() _ = right.Close() } func relay(dst, src connection.HalfOpenConn, wg *sync.WaitGroup, logger *logger.Logger, label string) { defer wg.Done() _, err := io.Copy(dst, src) if err != nil { _ = dst.SetDeadline(time.Now()) _ = src.SetDeadline(time.Now()) _ = dst.Close() _ = src.Close() if err != io.EOF { logger.Errorf("Error when relay client: %v.\n", err) } } else { // logger.Debugf("!!!!!!!!!!!!!!!! %s : dst close write", label) dst.CloseWrite() // logger.Debugf("!!!!!!!!!!!!!!!! %s : src close read", label) src.CloseRead() } } ================================================ FILE: cmd/rabbit.go ================================================ package main import ( "flag" "github.com/ihciah/rabbit-tcp/client" "github.com/ihciah/rabbit-tcp/logger" "github.com/ihciah/rabbit-tcp/server" "github.com/ihciah/rabbit-tcp/tunnel" "log" "strings" ) var Version = "No version information" const ( ClientMode = iota ServerMode DefaultPassword = "PASSWORD" ) func parseFlags() (pass bool, mode int, password string, addr string, listen string, dest string, tunnelN int, verbose int) { var modeString string var printVersion bool flag.StringVar(&modeString, "mode", "c", "running mode(s or c)") flag.StringVar(&password, "password", DefaultPassword, "password") flag.StringVar(&addr, "rabbit-addr", ":443", "listen(server mode) or remote(client mode) address used by rabbit-tcp") flag.StringVar(&listen, "listen", "", "[Client Only] listen address, eg: 127.0.0.1:2333") flag.StringVar(&dest, "dest", "", "[Client Only] destination address, eg: shadowsocks server address") flag.IntVar(&tunnelN, "tunnelN", 4, "[Client Only] number of tunnels to use in rabbit-tcp") flag.IntVar(&verbose, "verbose", 2, "verbose level(0~5)") flag.BoolVar(&printVersion, "version", false, "show version") flag.Parse() pass = true // version if printVersion { log.Println("Rabbit TCP (https://github.com/ihciah/rabbit-tcp/)") log.Printf("Version: %s.\n", Version) pass = false return } // mode modeString = strings.ToLower(modeString) if modeString == "c" || modeString == "client" { mode = ClientMode } else if modeString == "s" || modeString == "server" { mode = ServerMode } else { log.Printf("Unsupported mode %s.\n", modeString) pass = false return } // password if password == "" { log.Println("Password must be specified.") pass = false return } if password == DefaultPassword { log.Println("Password must be changed instead of default password.") pass = false return } // listen, dest, tunnelN if mode == ClientMode { if listen == "" { log.Println("Listen address must be specified in client mode.") pass = false } if dest == "" { log.Println("Destination address must be specified in client mode.") pass = false } if tunnelN == 0 { log.Println("Tunnel number must be positive.") pass = false } } return } func main() { pass, mode, password, addr, listen, dest, tunnelN, verbose := parseFlags() if !pass { return } cipher, _ := tunnel.NewAEADCipher("CHACHA20-IETF-POLY1305", nil, password) logger.LEVEL = verbose if mode == ClientMode { c := client.NewClient(tunnelN, addr, cipher) c.ServeForward(listen, dest) } else { s := server.NewServer(cipher) s.Serve(addr) } } ================================================ FILE: connection/block_processor.go ================================================ package connection import ( "context" "time" "github.com/ihciah/rabbit-tcp/block" "github.com/ihciah/rabbit-tcp/logger" "go.uber.org/atomic" ) // 1. Join blocks from chan to connection orderedRecvQueue // 2. Send bytes or control block type blockProcessor struct { cache map[uint32]block.Block logger *logger.Logger relayCtx context.Context removeFromPool context.CancelFunc sendBlockID atomic.Uint32 recvBlockID uint32 lastRecvBlockID uint32 } func newBlockProcessor(ctx context.Context, removeFromPool context.CancelFunc) blockProcessor { return blockProcessor{ cache: make(map[uint32]block.Block), relayCtx: ctx, removeFromPool: removeFromPool, logger: logger.NewLogger("[BlockProcessor]"), } } // Join blocks and send buffer to connection // TODO: If waiting a packet for TIMEOUT, break the connection; otherwise re-countdown for next waiting packet. func (x *blockProcessor) OrderedRelay(connection Connection) { x.logger.Infof("Ordered Relay of Connection %d started.\n", connection.GetConnectionID()) for { select { case blk := <-connection.getRecvQueue(): if blk.BlockID+1 > x.lastRecvBlockID { // Update lastRecvBlockID x.lastRecvBlockID = blk.BlockID + 1 } if x.recvBlockID == blk.BlockID { // Can send directly x.logger.Debugf("Send Block %d directly\n", blk.BlockID) connection.getOrderedRecvQueue() <- blk x.recvBlockID++ for { blk, ok := x.cache[x.recvBlockID] if !ok { break } x.logger.Debugf("Send Block %d from cache\n", blk.BlockID) connection.getOrderedRecvQueue() <- blk delete(x.cache, x.recvBlockID) x.recvBlockID++ } } else { // Cannot send directly if blk.BlockID < x.recvBlockID { // We don't need this old block x.logger.Debugf("Block %d is too old to cache\n", blk.BlockID) continue } x.logger.Debugf("Put Block %d to cache\n", blk.BlockID) x.cache[blk.BlockID] = blk } case <-time.After(PacketWaitTimeoutSec * time.Second): x.logger.Debugf("Packet wait time exceed of Connection %d.\n", connection.GetConnectionID()) if x.recvBlockID == x.lastRecvBlockID { x.logger.Debugf("recvBlockId == lastRecvBlockID(%d), but Connection %d is not in waiting status, continue.\n", x.recvBlockID, connection.GetConnectionID()) continue } x.logger.Warnf("Connection %d is going to be killed due to timeout.\n", connection.GetConnectionID()) x.removeFromPool() case <-x.relayCtx.Done(): x.logger.Infof("Ordered Relay of Connection %d stopped.\n", connection.GetConnectionID()) return } } } func (x *blockProcessor) packData(data []byte, connectionID uint32) []block.Block { return block.NewDataBlocks(connectionID, &x.sendBlockID, data) } func (x *blockProcessor) packConnect(address string, connectionID uint32) block.Block { return block.NewConnectBlock(connectionID, x.sendBlockID.Inc()-1, address) } func (x *blockProcessor) packDisconnect(connectionID uint32, shutdownType uint8) block.Block { return block.NewDisconnectBlock(connectionID, x.sendBlockID.Inc()-1, shutdownType) } ================================================ FILE: connection/connection.go ================================================ package connection import ( "net" "github.com/ihciah/rabbit-tcp/block" "github.com/ihciah/rabbit-tcp/logger" "go.uber.org/atomic" ) type HalfOpenConn interface { net.Conn CloseRead() error CloseWrite() error } type CloseWrite interface { CloseWrite() error } type CloseRead interface { CloseRead() error } type Connection interface { HalfOpenConn GetConnectionID() uint32 getOrderedRecvQueue() chan block.Block getRecvQueue() chan block.Block RecvBlock(block.Block) SendConnect(address string) SendDisconnect(uint8) OrderedRelay(connection Connection) // Run orderedRelay infinitely Stop() // Stop all related relay and remove itself from connectionPool } type baseConnection struct { blockProcessor blockProcessor connectionID uint32 closed *atomic.Bool sendQueue chan<- block.Block // Same as connectionPool recvQueue chan block.Block orderedRecvQueue chan block.Block logger *logger.Logger } func (bc *baseConnection) Stop() { bc.logger.Debugf("connection stop\n") bc.blockProcessor.removeFromPool() } func (bc *baseConnection) OrderedRelay(connection Connection) { bc.blockProcessor.OrderedRelay(connection) } func (bc *baseConnection) GetConnectionID() uint32 { return bc.connectionID } func (bc *baseConnection) getRecvQueue() chan block.Block { return bc.recvQueue } func (bc *baseConnection) getOrderedRecvQueue() chan block.Block { return bc.orderedRecvQueue } func (bc *baseConnection) RecvBlock(blk block.Block) { bc.recvQueue <- blk } func (bc *baseConnection) SendConnect(address string) { bc.logger.Debugf("Send connect to %s block.\n", address) blk := bc.blockProcessor.packConnect(address, bc.connectionID) bc.sendQueue <- blk } func (bc *baseConnection) SendDisconnect(shutdownType uint8) { bc.logger.Debugf("Send disconnect block: %v\n", shutdownType) blk := bc.blockProcessor.packDisconnect(bc.connectionID, shutdownType) bc.sendQueue <- blk if shutdownType == block.ShutdownBoth { bc.Stop() } } func (bc *baseConnection) sendData(data []byte) { bc.logger.Debugln("Send data block.") blocks := bc.blockProcessor.packData(data, bc.connectionID) for _, blk := range blocks { bc.sendQueue <- blk } } ================================================ FILE: connection/const.go ================================================ package connection const ( OrderedRecvQueueSize = 24 // OrderedRecvQueue channel cap RecvQueueSize = 24 // RecvQueue channel cap OutboundRecvBuffer = 16 * 1024 // 16K receive buffer for Outbound Connection OutboundBlockTimeoutSec = 3 // Wait the period and check exit signal PacketWaitTimeoutSec = 7 // If block processor is waiting for a "hole", and no packet comes within this limit, the Connection will be closed ) ================================================ FILE: connection/inbound_connection.go ================================================ package connection import ( "context" "fmt" "io" "math/rand" "net" "syscall" "time" "github.com/ihciah/rabbit-tcp/block" "github.com/ihciah/rabbit-tcp/logger" "go.uber.org/atomic" ) type InboundConnection struct { baseConnection dataBuffer ByteRingBuffer writeCtx context.Context readCtx context.Context readClosed *atomic.Bool writeClosed *atomic.Bool } func NewInboundConnection(sendQueue chan<- block.Block, ctx context.Context, removeFromPool context.CancelFunc) Connection { connectionID := rand.Uint32() c := InboundConnection{ baseConnection: baseConnection{ blockProcessor: newBlockProcessor(ctx, removeFromPool), connectionID: connectionID, closed: atomic.NewBool(false), sendQueue: sendQueue, recvQueue: make(chan block.Block, RecvQueueSize), orderedRecvQueue: make(chan block.Block, OrderedRecvQueueSize), logger: logger.NewLogger(fmt.Sprintf("[InboundConnection-%d]", connectionID)), }, dataBuffer: NewByteRingBuffer(block.MaxSize), readCtx: ctx, writeCtx: ctx, readClosed: atomic.NewBool(false), writeClosed: atomic.NewBool(false), } c.logger.Infof("InboundConnection %d created.\n", connectionID) return &c } func (c *InboundConnection) Read(b []byte) (n int, err error) { readN := 0 if !c.dataBuffer.Empty() { // There's something left in buffer readN += c.dataBuffer.Read(b) if readN == len(b) { // if dst is full, return return readN, nil } } if c.closed.Load() || c.readClosed.Load() { // Connection is closed, should read all data left in channel for { select { case blk := <-c.orderedRecvQueue: _ = c.readBlock(&blk, &readN, b) if readN == len(b) { return readN, nil } default: if readN != 0 { return readN, nil } else { return 0, io.EOF } } } } // Read at lease something if readN == 0 { select { case blk := <-c.orderedRecvQueue: c.logger.Debugln("Read in a block.") err := c.readBlock(&blk, &readN, b) if err == io.EOF || readN == len(b) { if readN != 0 { return readN, nil } else { return 0, err } } case <-c.readCtx.Done(): c.logger.Infoln("ReadDeadline exceeded.") if readN != 0 { return readN, nil } else { return 0, io.EOF } } } if readN == 0 { c.logger.Errorln("Unknown error.") } for { select { case blk := <-c.orderedRecvQueue: err := c.readBlock(&blk, &readN, b) c.logger.Debugln("Read in a block.") if err == io.EOF || readN == len(b) { return readN, nil } case <-c.readCtx.Done(): c.logger.Infoln("ReadDeadline exceeded.") return readN, nil default: return readN, nil } } } func (c *InboundConnection) readBlock(blk *block.Block, readN *int, b []byte) (err error) { switch blk.Type { case block.TypeDisconnect: // TODO: decide shutdown type if blk.BlockData[0] == block.ShutdownBoth { c.closed.Store(true) return io.EOF } else if blk.BlockData[0] == block.ShutdownWrite { c.readClosed.Store(true) return io.EOF } else if blk.BlockData[0] == block.ShutdownRead { c.writeClosed.Store(true) return nil } case block.TypeData: dst := b[*readN:] if len(dst) < len(blk.BlockData) { // if dst can't put a block, put part of it and return c.dataBuffer.OverWrite(blk.BlockData) *readN += c.dataBuffer.Read(dst) return } // if dst can put a block, put it *readN += copy(dst, blk.BlockData) } return } func (c *InboundConnection) Write(b []byte) (n int, err error) { // TODO: tag all blocks from b using WaitGroup // TODO: and wait all blocks sent? if c.writeClosed.Load() || c.closed.Load() { return 0, syscall.EINVAL } c.sendData(b) return len(b), nil } func (c *InboundConnection) Close() error { if c.closed.CAS(false, true) { c.SendDisconnect(block.ShutdownBoth) } c.Stop() return nil } func (c *InboundConnection) CloseRead() error { c.SendDisconnect(block.ShutdownRead) return nil } func (c *InboundConnection) CloseWrite() error { c.SendDisconnect(block.ShutdownWrite) return nil } func (c *InboundConnection) LocalAddr() net.Addr { // TODO return nil } func (c *InboundConnection) RemoteAddr() net.Addr { // TODO return nil } func (c *InboundConnection) SetDeadline(t time.Time) error { _ = c.SetReadDeadline(t) _ = c.SetWriteDeadline(t) return nil } func (c *InboundConnection) SetReadDeadline(t time.Time) error { c.readCtx, _ = context.WithDeadline(context.Background(), t) return nil } func (c *InboundConnection) SetWriteDeadline(t time.Time) error { c.writeCtx, _ = context.WithDeadline(context.Background(), t) return nil } ================================================ FILE: connection/outbound_connection.go ================================================ package connection import ( "context" "fmt" "io" "net" "time" "github.com/ihciah/rabbit-tcp/block" "github.com/ihciah/rabbit-tcp/logger" "go.uber.org/atomic" ) type OutboundConnection struct { baseConnection HalfOpenConn ctx context.Context cancel context.CancelFunc } func NewOutboundConnection(connectionID uint32, sendQueue chan<- block.Block, ctx context.Context, removeFromPool context.CancelFunc) Connection { c := OutboundConnection{ baseConnection: baseConnection{ blockProcessor: newBlockProcessor(ctx, removeFromPool), connectionID: connectionID, closed: atomic.NewBool(true), sendQueue: sendQueue, recvQueue: make(chan block.Block, RecvQueueSize), orderedRecvQueue: make(chan block.Block, OrderedRecvQueueSize), logger: logger.NewLogger(fmt.Sprintf("[OutboundConnection-%d]", connectionID)), }, ctx: ctx, cancel: removeFromPool, } c.logger.Infof("OutboundConnection %d created.\n", connectionID) return &c } func (oc *OutboundConnection) closeThenCancelWithOnceSend() { oc.HalfOpenConn.Close() oc.cancel() if oc.closed.CAS(false, true) { oc.SendDisconnect(block.ShutdownBoth) } } func (oc *OutboundConnection) closeThenCancel() { oc.HalfOpenConn.Close() oc.cancel() } // real connection -> ConnectionPool's SendQueue -> TunnelPool func (oc *OutboundConnection) RecvRelay() { recvBuffer := make([]byte, OutboundRecvBuffer) for { oc.HalfOpenConn.SetReadDeadline(time.Now().Add(OutboundBlockTimeoutSec * time.Second)) n, err := oc.HalfOpenConn.Read(recvBuffer) if err == nil { oc.sendData(recvBuffer[:n]) oc.HalfOpenConn.SetReadDeadline(time.Time{}) } else if err == io.EOF { oc.logger.Debugln("EOF received from outbound connection.") oc.closeThenCancelWithOnceSend() return } else if netErr, ok := err.(net.Error); ok && netErr.Timeout() { oc.logger.Debugln("Receive timeout from outbound connection.") } else { oc.logger.Errorf("Error when recv relay outbound connection: %v\n.", err) oc.closeThenCancelWithOnceSend() return } select { case <-oc.ctx.Done(): // Should read all before leave, or packet will be lost for { n, err := oc.HalfOpenConn.Read(recvBuffer) if err == nil { oc.logger.Debugln("Data received from outbound connection successfully after close.") oc.sendData(recvBuffer[:n]) } else { oc.logger.Debugf("Error when receiving data from outbound connection after close: %v.\n", err) break } } return default: continue } } } // orderedRecvQueue -> real connection func (oc *OutboundConnection) SendRelay() { for { select { case blk := <-oc.orderedRecvQueue: switch blk.Type { case block.TypeConnect: // Will do nothing! continue case block.TypeData: oc.logger.Debugln("Send out DATA bytes.") oc.HalfOpenConn.SetWriteDeadline(time.Now().Add(OutboundBlockTimeoutSec * time.Second)) _, err := oc.HalfOpenConn.Write(blk.BlockData) if err == nil { oc.HalfOpenConn.SetWriteDeadline(time.Time{}) } else { oc.logger.Errorf("Error when send relay outbound connection: %v\n.", err) oc.closeThenCancelWithOnceSend() } case block.TypeDisconnect: if blk.BlockData[0] == block.ShutdownRead { oc.logger.Debugf("CloseRead for remote connection\n") oc.HalfOpenConn.CloseRead() } else if blk.BlockData[0] == block.ShutdownWrite { oc.logger.Debugf("CloseWrite for remote connection\n") oc.HalfOpenConn.CloseWrite() } else { oc.logger.Debugln("Send out DISCONNECT action.") oc.closeThenCancel() } } case <-oc.ctx.Done(): oc.closeThenCancelWithOnceSend() return } } } func (oc *OutboundConnection) RecvBlock(blk block.Block) { if blk.Type == block.TypeConnect { address := string(blk.BlockData) go oc.connect(address) } oc.recvQueue <- blk } func (oc *OutboundConnection) connect(address string) { oc.logger.Debugln("Send out CONNECTION action.") if !oc.closed.Load() || oc.HalfOpenConn != nil { return } rawConn, err := net.Dial("tcp", address) if err == nil { oc.logger.Infof("Dial to %s successfully.\n", address) oc.HalfOpenConn = rawConn.(*net.TCPConn) oc.closed.Toggle() go oc.RecvRelay() go oc.SendRelay() } else { oc.logger.Warnf("Error when dial to %s: %v.\n", address, err) oc.SendDisconnect(block.ShutdownBoth) } } ================================================ FILE: connection/ring_buffer.go ================================================ package connection type ByteRingBuffer struct { buffer []byte head int tail int } func NewByteRingBuffer(size uint32) ByteRingBuffer { buffer := make([]byte, size) return ByteRingBuffer{ buffer: buffer, } } func (rb *ByteRingBuffer) OverWrite(data []byte) { if len(rb.buffer) < len(data) { rb.buffer = make([]byte, len(data)) } n := copy(rb.buffer, data) rb.head = 0 rb.tail = n } func (rb *ByteRingBuffer) Read(data []byte) int { n := len(data) if n > rb.tail-rb.head { n = rb.tail - rb.head } copy(data, rb.buffer[rb.head:rb.tail]) rb.head += n return n } func (rb *ByteRingBuffer) Empty() bool { return rb.tail-rb.head == 0 } ================================================ FILE: connection_pool/pool.go ================================================ package connection_pool import ( "context" "github.com/ihciah/rabbit-tcp/block" "github.com/ihciah/rabbit-tcp/connection" "github.com/ihciah/rabbit-tcp/logger" "github.com/ihciah/rabbit-tcp/tunnel_pool" "sync" ) const ( SendQueueSize = 48 // SendQueue channel cap ) type ConnectionPool struct { connectionMapping map[uint32]connection.Connection mappingLock sync.RWMutex tunnelPool *tunnel_pool.TunnelPool sendQueue chan block.Block acceptNewConnection bool logger *logger.Logger ctx context.Context cancel context.CancelFunc } func NewConnectionPool(pool *tunnel_pool.TunnelPool, acceptNewConnection bool, backgroundCtx context.Context) *ConnectionPool { ctx, cancel := context.WithCancel(backgroundCtx) cp := &ConnectionPool{ connectionMapping: make(map[uint32]connection.Connection), tunnelPool: pool, sendQueue: make(chan block.Block, SendQueueSize), acceptNewConnection: acceptNewConnection, logger: logger.NewLogger("[ConnectionPool]"), ctx: ctx, cancel: cancel, } cp.logger.Infoln("Connection Pool created.") go cp.sendRelay() go cp.recvRelay() return cp } // Create InboundConnection, and it to ConnectionPool and return func (cp *ConnectionPool) NewPooledInboundConnection() connection.Connection { connCtx, removeConnFromPool := context.WithCancel(cp.ctx) c := connection.NewInboundConnection(cp.sendQueue, connCtx, removeConnFromPool) cp.addConnection(c) go func() { <-connCtx.Done() cp.removeConnection(c) }() return c } // Create OutboundConnection, and it to ConnectionPool and return func (cp *ConnectionPool) NewPooledOutboundConnection(connectionID uint32) connection.Connection { connCtx, removeConnFromPool := context.WithCancel(cp.ctx) c := connection.NewOutboundConnection(connectionID, cp.sendQueue, connCtx, removeConnFromPool) cp.addConnection(c) go func() { <-connCtx.Done() cp.removeConnection(c) }() return c } func (cp *ConnectionPool) addConnection(conn connection.Connection) { cp.logger.Infof("Connection %d added to connection pool.\n", conn.GetConnectionID()) cp.mappingLock.Lock() defer cp.mappingLock.Unlock() cp.connectionMapping[conn.GetConnectionID()] = conn go conn.OrderedRelay(conn) } func (cp *ConnectionPool) removeConnection(conn connection.Connection) { cp.logger.Infof("Connection %d removed from connection pool.\n", conn.GetConnectionID()) cp.mappingLock.Lock() defer cp.mappingLock.Unlock() if _, ok := cp.connectionMapping[conn.GetConnectionID()]; ok { delete(cp.connectionMapping, conn.GetConnectionID()) } } // Deliver blocks from tunnelPool channel to specified connections func (cp *ConnectionPool) recvRelay() { cp.logger.Infoln("Recv Relay started.") for { select { case blk := <-cp.tunnelPool.GetRecvQueue(): connID := blk.ConnectionID var conn connection.Connection var ok bool cp.mappingLock.RLock() conn, ok = cp.connectionMapping[connID] cp.mappingLock.RUnlock() if !ok { if cp.acceptNewConnection { conn = cp.NewPooledOutboundConnection(blk.ConnectionID) cp.logger.Infoln("Connection created and added to connectionPool.") } else { cp.logger.Errorln("Unknown connection.") continue } } conn.RecvBlock(blk) cp.logger.Debugf("Block %d(type: %d) put to connRecvQueue.\n", blk.BlockID, blk.Type) case <-cp.ctx.Done(): cp.logger.Infoln("Recv Relay stopped.") return } } } // Deliver blocks from connPool's sendQueue to tunnelPool // TODO: Maybe QOS can be implemented here func (cp *ConnectionPool) sendRelay() { cp.logger.Infoln("Send Relay started.") for { select { case blk := <-cp.sendQueue: cp.tunnelPool.GetSendQueue() <- blk cp.logger.Debugf("Block %d(type: %d) put to connSendQueue.\n", blk.BlockID, blk.Type) case <-cp.ctx.Done(): cp.logger.Infoln("Send Relay stopped.") return } } } func (cp *ConnectionPool) stopRelay() { cp.logger.Infoln("Stop all ConnectionPool Relay.") cp.cancel() } ================================================ FILE: docker-compose-client.yml ================================================ rabbit-client: image: ihciah/rabbit ports: - "9892:443/tcp" environment: - MODE=c - PASSWORD=password - RABBITADDR=your.rabbit.server:9891 - LISTEN=:443 - DEST=your.service:port - TUNNELN=6 - VERBOSE=2 restart: always ================================================ FILE: docker-compose-server.yml ================================================ rabbit-server: image: ihciah/rabbit ports: - "9891:443/tcp" environment: - MODE=s - PASSWORD=password - RABBITADDR=:443 - VERBOSE=2 restart: always ================================================ FILE: go.mod ================================================ module github.com/ihciah/rabbit-tcp go 1.13 require ( go.uber.org/atomic v1.6.0 golang.org/x/crypto v0.0.0-20200221231518-2aa609cf4a9d ) ================================================ FILE: go.sum ================================================ github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= github.com/stretchr/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q= github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= go.uber.org/atomic v1.6.0 h1:Ezj3JGmsOnG1MoRWQkPBsKLe9DwWD9QeXzTRzzldNVk= go.uber.org/atomic v1.6.0/go.mod h1:sABNBOSYdrvTF6hTgEIbc7YasKWGhgEQZyfxyTvoXHQ= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= golang.org/x/crypto v0.0.0-20200221231518-2aa609cf4a9d h1:1ZiEyfaQIg3Qh0EoqpwAakHVhecoE5wlSg5GjnafJGw= golang.org/x/crypto v0.0.0-20200221231518-2aa609cf4a9d/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= golang.org/x/lint v0.0.0-20190930215403-16217165b5de h1:5hukYrvBGR8/eNkX5mdUezrA6JiaEZDtJb9Ei+1LlBs= golang.org/x/lint v0.0.0-20190930215403-16217165b5de/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc= golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190412213103-97732733099d h1:+R4KGOnez64A81RvjARKc4UT5/tI9ujCIVX+P5KiHuI= golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= golang.org/x/tools v0.0.0-20191029041327-9cc4af7d6b2c h1:IGkKhmfzcztjm6gYkykvu/NiS8kaqbCWAEWWAyf8J5U= golang.org/x/tools v0.0.0-20191029041327-9cc4af7d6b2c/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= ================================================ FILE: logger/logger.go ================================================ package logger import ( "log" "os" ) const ( LogLevelOff = iota LogLevelFatal LogLevelError LogLevelWarn LogLevelInfo LogLevelDebug ) var LEVEL int = LogLevelOff type Logger struct { logger *log.Logger level int } func NewLogger(prefix string) *Logger { return &Logger{ logger: log.New(os.Stdout, prefix, log.LstdFlags), level: LEVEL, } } func (l *Logger) Debugln(v string) { if l.level >= LogLevelDebug { l.logger.Println("[Debug] " + v) } } func (l *Logger) Debugf(format string, v ...interface{}) { if l.level >= LogLevelDebug { l.logger.Printf("[Debug] "+format, v...) } } func (l *Logger) Infoln(v string) { if l.level >= LogLevelInfo { l.logger.Println("[Info] " + v) } } func (l *Logger) Infof(format string, v ...interface{}) { if l.level >= LogLevelInfo { l.logger.Printf("[Info] "+format, v...) } } func (l *Logger) Warnln(v string) { if l.level >= LogLevelWarn { l.logger.Println("[Warn] " + v) } } func (l *Logger) Warnf(format string, v ...interface{}) { if l.level >= LogLevelWarn { l.logger.Printf("[Warn] "+format, v...) } } func (l *Logger) Errorln(v string) { if l.level >= LogLevelError { l.logger.Println("[Error] " + v) } } func (l *Logger) Errorf(format string, v ...interface{}) { if l.level >= LogLevelError { l.logger.Printf("[Error] "+format, v...) } } func (l *Logger) Fatalln(v string) { if l.level >= LogLevelFatal { l.logger.Println("[Fatal] " + v) } } func (l *Logger) Fatalf(format string, v ...interface{}) { if l.level >= LogLevelFatal { l.logger.Printf("[Fatal] "+format, v...) } } ================================================ FILE: peer/client.go ================================================ package peer import ( "context" "github.com/ihciah/rabbit-tcp/connection" "github.com/ihciah/rabbit-tcp/connection_pool" "github.com/ihciah/rabbit-tcp/tunnel" "github.com/ihciah/rabbit-tcp/tunnel_pool" "math/rand" ) type ClientPeer struct { Peer } func NewClientPeer(tunnelNum int, endpoint string, cipher tunnel.Cipher) ClientPeer { if initRand() != nil { panic("Error when initialize random seed.") } peerID := rand.Uint32() return newClientPeerWithID(peerID, tunnelNum, endpoint, cipher) } func newClientPeerWithID(peerID uint32, tunnelNum int, endpoint string, cipher tunnel.Cipher) ClientPeer { peerCtx, removePeerFunc := context.WithCancel(context.Background()) poolManager := tunnel_pool.NewClientManager(tunnelNum, endpoint, peerID, cipher) tunnelPool := tunnel_pool.NewTunnelPool(peerID, &poolManager, peerCtx) connectionPool := connection_pool.NewConnectionPool(tunnelPool, false, peerCtx) return ClientPeer{ Peer: Peer{ peerID: peerID, connectionPool: *connectionPool, tunnelPool: *tunnelPool, ctx: peerCtx, cancel: removePeerFunc, }, } } func (cp *ClientPeer) Dial(address string) connection.Connection { conn := cp.connectionPool.NewPooledInboundConnection() conn.SendConnect(address) return conn } ================================================ FILE: peer/peer.go ================================================ package peer import ( "context" crand "crypto/rand" "encoding/binary" "github.com/ihciah/rabbit-tcp/connection_pool" "github.com/ihciah/rabbit-tcp/tunnel_pool" "io" "math/rand" ) type Peer struct { peerID uint32 connectionPool connection_pool.ConnectionPool tunnelPool tunnel_pool.TunnelPool ctx context.Context cancel context.CancelFunc } func (p *Peer) Stop() { p.cancel() } func initRand() error { seedSize := 8 seedBytes := make([]byte, seedSize) _, err := io.ReadFull(crand.Reader, seedBytes) if err != nil { return err } rand.Seed(int64(binary.LittleEndian.Uint64(seedBytes))) return nil } ================================================ FILE: peer/peer_group.go ================================================ package peer import ( "context" "github.com/ihciah/rabbit-tcp/logger" "github.com/ihciah/rabbit-tcp/tunnel" "github.com/ihciah/rabbit-tcp/tunnel_pool" "net" "sync" ) type PeerGroup struct { lock sync.Mutex cipher tunnel.Cipher peerMapping map[uint32]*ServerPeer logger *logger.Logger } func NewPeerGroup(cipher tunnel.Cipher) PeerGroup { if initRand() != nil { panic("Error when initialize random seed.") } return PeerGroup{ cipher: cipher, peerMapping: make(map[uint32]*ServerPeer), logger: logger.NewLogger("[PeerGroup]"), } } // Add a tunnel to it's peer; will create peer if not exists func (pg *PeerGroup) AddTunnel(tunnel *tunnel_pool.Tunnel) error { // add tunnel to peer(if absent, create peer to peer_group) pg.lock.Lock() var peer *ServerPeer var ok bool peerID := tunnel.GetPeerID() if peer, ok = pg.peerMapping[peerID]; !ok { peerContext, removePeerFunc := context.WithCancel(context.Background()) serverPeer := NewServerPeerWithID(peerID, peerContext, removePeerFunc) peer = &serverPeer pg.peerMapping[peerID] = peer pg.logger.Infof("Server Peer %d added to PeerGroup.\n", peerID) go func() { <-peerContext.Done() pg.RemovePeer(peerID) }() } pg.lock.Unlock() peer.tunnelPool.AddTunnel(tunnel) return nil } // Like AddTunnel, add a raw connection func (pg *PeerGroup) AddTunnelFromConn(conn net.Conn) error { tun, err := tunnel_pool.NewPassiveTunnel(conn, pg.cipher) if err != nil { conn.Close() return err } return pg.AddTunnel(&tun) } func (pg *PeerGroup) RemovePeer(peerID uint32) { pg.logger.Infof("Server Peer %d removed from peer group.\n", peerID) pg.lock.Lock() defer pg.lock.Unlock() delete(pg.peerMapping, peerID) } ================================================ FILE: peer/server.go ================================================ package peer import ( "context" "github.com/ihciah/rabbit-tcp/connection_pool" "github.com/ihciah/rabbit-tcp/tunnel_pool" ) type ServerPeer struct { Peer } func NewServerPeerWithID(peerID uint32, peerContext context.Context, removePeerFunc context.CancelFunc) ServerPeer { poolManager := tunnel_pool.NewServerManager(removePeerFunc) tunnelPool := tunnel_pool.NewTunnelPool(peerID, &poolManager, peerContext) connectionPool := connection_pool.NewConnectionPool(tunnelPool, true, peerContext) return ServerPeer{ Peer: Peer{ peerID: peerID, connectionPool: *connectionPool, tunnelPool: *tunnelPool, ctx: peerContext, cancel: removePeerFunc, }, } } ================================================ FILE: server/server.go ================================================ package server import ( "github.com/ihciah/rabbit-tcp/logger" "github.com/ihciah/rabbit-tcp/peer" "github.com/ihciah/rabbit-tcp/tunnel" "net" ) type Server struct { peerGroup peer.PeerGroup logger *logger.Logger } func NewServer(cipher tunnel.Cipher) Server { return Server{ peerGroup: peer.NewPeerGroup(cipher), logger: logger.NewLogger("[Server]"), } } func (s *Server) Serve(address string) error { listener, err := net.Listen("tcp", address) if err != nil { return err } for { conn, err := listener.Accept() if err != nil { s.logger.Errorf("Error when accept connection: %v.\n", err) continue } err = s.peerGroup.AddTunnelFromConn(conn) if err != nil { s.logger.Errorf("Error when add tunnel to tunnel pool: %v.\n", err) } } } ================================================ FILE: tunnel/aead.go ================================================ package tunnel import ( "crypto/aes" "crypto/cipher" "errors" "golang.org/x/crypto/chacha20poly1305" "strings" ) var ErrCipherNotSupported = errors.New("cipher not supported") const ( aeadAes128Gcm = "AEAD_AES_128_GCM" aeadAes192Gcm = "AEAD_AES_192_GCM" aeadAes256Gcm = "AEAD_AES_256_GCM" aeadChacha20Poly1305 = "AEAD_CHACHA20_POLY1305" ) // List of AEAD ciphers: key size in bytes and constructor var aeadList = map[string]struct { KeySize int New func([]byte) (Cipher, error) }{ aeadAes128Gcm: {16, aesGCM}, aeadAes192Gcm: {24, aesGCM}, aeadAes256Gcm: {32, aesGCM}, aeadChacha20Poly1305: {32, chacha20Poly1305}, } func makeAESGCM(key []byte) (cipher.AEAD, error) { blk, err := aes.NewCipher(key) if err != nil { return nil, err } return cipher.NewGCM(blk) } // aesGCM creates a new Cipher with a pre-shared key. len(psk) must be // one of 16, 24, or 32 to select AES-128/196/256-GCM. func aesGCM(psk []byte) (Cipher, error) { switch l := len(psk); l { case 16, 24, 32: // AES 128/196/256 default: return nil, aes.KeySizeError(l) } return &metaCipher{psk: psk, makeAEAD: makeAESGCM}, nil } // chacha20Poly1305 creates a new Cipher with a pre-shared key. len(psk) // must be 32. func chacha20Poly1305(psk []byte) (Cipher, error) { if len(psk) != chacha20poly1305.KeySize { return nil, KeySizeError(chacha20poly1305.KeySize) } return &metaCipher{psk: psk, makeAEAD: chacha20poly1305.New}, nil } func NewAEADCipher(name string, key []byte, password string) (Cipher, error) { name = strings.ToUpper(name) switch name { case "CHACHA20-IETF-POLY1305": name = aeadChacha20Poly1305 case "AES-128-GCM": name = aeadAes128Gcm case "AES-192-GCM": name = aeadAes192Gcm case "AES-256-GCM": name = aeadAes256Gcm } if choice, ok := aeadList[name]; ok { if key == nil || len(key) == 0 { key = kdf(password, choice.KeySize) } if len(key) != choice.KeySize { return nil, KeySizeError(choice.KeySize) } aead, err := choice.New(key) return aead, err } return nil, ErrCipherNotSupported } ================================================ FILE: tunnel/cipher.go ================================================ package tunnel import ( "crypto/cipher" "crypto/md5" "crypto/sha1" "golang.org/x/crypto/hkdf" "io" "strconv" ) type Cipher interface { KeySize() int SaltSize() int Encrypter(salt []byte) (cipher.AEAD, error) Decrypter(salt []byte) (cipher.AEAD, error) } type KeySizeError int func (e KeySizeError) Error() string { return "key size error: need " + strconv.Itoa(int(e)) + " bytes" } func hkdfSHA1(secret, salt, info, outkey []byte) { r := hkdf.New(sha1.New, secret, salt, info) if _, err := io.ReadFull(r, outkey); err != nil { panic(err) // should never happen } } type metaCipher struct { psk []byte makeAEAD func(key []byte) (cipher.AEAD, error) } func (a *metaCipher) KeySize() int { return len(a.psk) } func (a *metaCipher) SaltSize() int { if ks := a.KeySize(); ks > 16 { return ks } return 16 } func (a *metaCipher) Encrypter(salt []byte) (cipher.AEAD, error) { subkey := make([]byte, a.KeySize()) hkdfSHA1(a.psk, salt, []byte("ss-subkey"), subkey) return a.makeAEAD(subkey) } func (a *metaCipher) Decrypter(salt []byte) (cipher.AEAD, error) { subkey := make([]byte, a.KeySize()) hkdfSHA1(a.psk, salt, []byte("ss-subkey"), subkey) return a.makeAEAD(subkey) } func kdf(password string, keyLen int) []byte { var b, prev []byte h := md5.New() for len(b) < keyLen { h.Write(prev) h.Write([]byte(password)) b = h.Sum(b) prev = b[len(b)-h.Size():] h.Reset() } return b[:keyLen] } ================================================ FILE: tunnel/tunnel.go ================================================ package tunnel import ( "bytes" "crypto/cipher" "crypto/rand" "io" "net" ) // payloadSizeMask is the maximum size of payload in bytes. const payloadSizeMask = 0x3FFF // 16*1024 - 1 type writer struct { io.Writer cipher.AEAD nonce []byte buf []byte } // NewWriter wraps an io.Writer with AEAD encryption. func NewWriter(w io.Writer, aead cipher.AEAD) io.Writer { return newWriter(w, aead) } func newWriter(w io.Writer, aead cipher.AEAD) *writer { return &writer{ Writer: w, AEAD: aead, buf: make([]byte, 2+aead.Overhead()+payloadSizeMask+aead.Overhead()), nonce: make([]byte, aead.NonceSize()), } } // Write encrypts b and writes to the embedded io.Writer. func (w *writer) Write(b []byte) (int, error) { n, err := w.ReadFrom(bytes.NewBuffer(b)) return int(n), err } // ReadFrom reads from the given io.Reader until EOF or error, encrypts and // writes to the embedded io.Writer. Returns number of bytes read from r and // any error encountered. func (w *writer) ReadFrom(r io.Reader) (n int64, err error) { for { buf := w.buf payloadBuf := buf[2+w.Overhead() : 2+w.Overhead()+payloadSizeMask] nr, er := r.Read(payloadBuf) if nr > 0 { n += int64(nr) buf = buf[:2+w.Overhead()+nr+w.Overhead()] payloadBuf = payloadBuf[:nr] buf[0], buf[1] = byte(nr>>8), byte(nr) // big-endian payload size w.Seal(buf[:0], w.nonce, buf[:2], nil) increment(w.nonce) w.Seal(payloadBuf[:0], w.nonce, payloadBuf, nil) increment(w.nonce) _, ew := w.Writer.Write(buf) if ew != nil { err = ew break } } if er != nil { if er != io.EOF { // ignore EOF as per io.ReaderFrom contract err = er } break } } return n, err } type reader struct { io.Reader cipher.AEAD nonce []byte buf []byte leftover []byte } // NewReader wraps an io.Reader with AEAD decryption. func NewReader(r io.Reader, aead cipher.AEAD) io.Reader { return newReader(r, aead) } func newReader(r io.Reader, aead cipher.AEAD) *reader { return &reader{ Reader: r, AEAD: aead, buf: make([]byte, payloadSizeMask+aead.Overhead()), nonce: make([]byte, aead.NonceSize()), } } // read and decrypt a record into the internal buffer. Return decrypted payload length and any error encountered. func (r *reader) read() (int, error) { // decrypt payload size buf := r.buf[:2+r.Overhead()] _, err := io.ReadFull(r.Reader, buf) if err != nil { return 0, err } _, err = r.Open(buf[:0], r.nonce, buf, nil) increment(r.nonce) if err != nil { return 0, err } size := (int(buf[0])<<8 + int(buf[1])) & payloadSizeMask // decrypt payload buf = r.buf[:size+r.Overhead()] _, err = io.ReadFull(r.Reader, buf) if err != nil { return 0, err } _, err = r.Open(buf[:0], r.nonce, buf, nil) increment(r.nonce) if err != nil { return 0, err } return size, nil } // Read reads from the embedded io.Reader, decrypts and writes to b. func (r *reader) Read(b []byte) (int, error) { // copy decrypted bytes (if any) from previous record first if len(r.leftover) > 0 { n := copy(b, r.leftover) r.leftover = r.leftover[n:] return n, nil } n, err := r.read() m := copy(b, r.buf[:n]) if m < n { // insufficient len(b), keep leftover for next read r.leftover = r.buf[m:n] } return m, err } // WriteTo reads from the embedded io.Reader, decrypts and writes to w until // there's no more data to write or when an error occurs. Return number of // bytes written to w and any error encountered. func (r *reader) WriteTo(w io.Writer) (n int64, err error) { // write decrypted bytes left over from previous record for len(r.leftover) > 0 { nw, ew := w.Write(r.leftover) r.leftover = r.leftover[nw:] n += int64(nw) if ew != nil { return n, ew } } for { nr, er := r.read() if nr > 0 { nw, ew := w.Write(r.buf[:nr]) n += int64(nw) if ew != nil { err = ew break } } if er != nil { if er != io.EOF { // ignore EOF as per io.Copy contract (using src.WriteTo shortcut) err = er } break } } return n, err } // increment little-endian encoded unsigned integer b. Wrap around on overflow. func increment(b []byte) { for i := range b { b[i]++ if b[i] != 0 { return } } } type streamConn struct { net.Conn Cipher r *reader w *writer } func (c *streamConn) initReader() error { salt := make([]byte, c.SaltSize()) if _, err := io.ReadFull(c.Conn, salt); err != nil { return err } aead, err := c.Decrypter(salt) if err != nil { return err } c.r = newReader(c.Conn, aead) return nil } func (c *streamConn) Read(b []byte) (int, error) { if c.r == nil { if err := c.initReader(); err != nil { return 0, err } } return c.r.Read(b) } func (c *streamConn) WriteTo(w io.Writer) (int64, error) { if c.r == nil { if err := c.initReader(); err != nil { return 0, err } } return c.r.WriteTo(w) } func (c *streamConn) initWriter() error { salt := make([]byte, c.SaltSize()) if _, err := io.ReadFull(rand.Reader, salt); err != nil { return err } aead, err := c.Encrypter(salt) if err != nil { return err } _, err = c.Conn.Write(salt) if err != nil { return err } c.w = newWriter(c.Conn, aead) return nil } func (c *streamConn) Write(b []byte) (int, error) { if c.w == nil { if err := c.initWriter(); err != nil { return 0, err } } return c.w.Write(b) } func (c *streamConn) ReadFrom(r io.Reader) (int64, error) { if c.w == nil { if err := c.initWriter(); err != nil { return 0, err } } return c.w.ReadFrom(r) } // NewEncryptedConn wraps a stream-oriented net.Conn with cipher. func NewEncryptedConn(c net.Conn, ciph Cipher) net.Conn { if ciph == nil { return c } return &streamConn{Conn: c, Cipher: ciph} } ================================================ FILE: tunnel_pool/const.go ================================================ package tunnel_pool const ( ErrorWaitSec = 3 // If a tunnel cannot be dialed, will wait for this period and retry infinitely TunnelBlockTimeoutSec = 8 // If a tunnel cannot send a block within the limit, will treat it a dead tunnel EmptyPoolDestroySec = 60 // The pool will be destroyed(server side) if no tunnel dialed in SendQueueSize = 48 // SendQueue channel cap RecvQueueSize = 48 // RecvQueue channel cap ) ================================================ FILE: tunnel_pool/manager.go ================================================ package tunnel_pool import ( "context" "github.com/ihciah/rabbit-tcp/logger" "github.com/ihciah/rabbit-tcp/tunnel" "go.uber.org/atomic" "net" "sync" "time" ) type Manager interface { Notify(pool *TunnelPool) // When TunnelPool size changed, Notify should be called DecreaseNotify(pool *TunnelPool) // When TunnelPool size decreased, DecreaseNotify should be called } type ClientManager struct { decreaseNotifyLock sync.Mutex // Only one decrease notify can run at the same time tunnelNum int endpoint string peerID uint32 cipher tunnel.Cipher logger *logger.Logger } func NewClientManager(tunnelNum int, endpoint string, peerID uint32, cipher tunnel.Cipher) ClientManager { return ClientManager{ tunnelNum: tunnelNum, endpoint: endpoint, cipher: cipher, peerID: peerID, logger: logger.NewLogger("[ClientManager]"), } } // Keep tunnelPool size above tunnelNum func (cm *ClientManager) DecreaseNotify(pool *TunnelPool) { cm.decreaseNotifyLock.Lock() defer cm.decreaseNotifyLock.Unlock() tunnelCount := len(pool.tunnelMapping) for tunnelToCreate := cm.tunnelNum - tunnelCount; tunnelToCreate > 0; { select { case <-pool.ctx.Done(): // Have to return if pool cancel is called. return default: } cm.logger.Infof("Need %d new tunnels now.\n", tunnelToCreate) conn, err := net.Dial("tcp", cm.endpoint) if err != nil { cm.logger.Errorf("Error when dial to %s: %v.\n", cm.endpoint, err) time.Sleep(ErrorWaitSec * time.Second) continue } tun, err := NewActiveTunnel(conn, cm.cipher, cm.peerID) if err != nil { cm.logger.Errorf("Error when create active tunnel: %v\n", err) time.Sleep(ErrorWaitSec * time.Second) continue } pool.AddTunnel(&tun) tunnelToCreate-- cm.logger.Infof("Successfully dialed to %s. TunnelToCreate: %d\n", cm.endpoint, tunnelToCreate) } } func (cm *ClientManager) Notify(pool *TunnelPool) {} type ServerManager struct { notifyLock sync.Mutex // Only one notify can run in the same time removePeerFunc context.CancelFunc cancelCountDownFunc context.CancelFunc triggered atomic.Bool logger *logger.Logger } func NewServerManager(removePeerFunc context.CancelFunc) ServerManager { return ServerManager{ logger: logger.NewLogger("[ServerManager]"), removePeerFunc: removePeerFunc, } } // If tunnelPool size is zero for more than EmptyPoolDestroySec, delete it func (sm *ServerManager) Notify(pool *TunnelPool) { tunnelCount := len(pool.tunnelMapping) if tunnelCount == 0 && sm.triggered.CAS(false, true) { var destroyAfterCtx context.Context destroyAfterCtx, sm.cancelCountDownFunc = context.WithCancel(context.Background()) go func(*ServerManager) { select { case <-destroyAfterCtx.Done(): sm.logger.Debugln("ServerManager notify canceled.") case <-time.After(EmptyPoolDestroySec * time.Second): sm.logger.Infoln("ServerManager will be destroyed.") sm.removePeerFunc() } }(sm) } if tunnelCount != 0 && sm.triggered.CAS(true, false) { sm.cancelCountDownFunc() } } func (sm *ServerManager) DecreaseNotify(pool *TunnelPool) {} ================================================ FILE: tunnel_pool/pool.go ================================================ package tunnel_pool import ( "context" "github.com/ihciah/rabbit-tcp/block" "github.com/ihciah/rabbit-tcp/logger" "sync" ) type TunnelPool struct { mutex sync.Mutex tunnelMapping map[uint32]*Tunnel peerID uint32 manager Manager sendQueue chan block.Block sendRetryQueue chan block.Block recvQueue chan block.Block ctx context.Context cancel context.CancelFunc // currently useless logger *logger.Logger } func NewTunnelPool(peerID uint32, manager Manager, peerContext context.Context) *TunnelPool { ctx, cancel := context.WithCancel(peerContext) tp := &TunnelPool{ tunnelMapping: make(map[uint32]*Tunnel), peerID: peerID, manager: manager, sendQueue: make(chan block.Block, SendQueueSize), sendRetryQueue: make(chan block.Block, SendQueueSize), recvQueue: make(chan block.Block, RecvQueueSize), ctx: ctx, cancel: cancel, logger: logger.NewLogger("[TunnelPool]"), } tp.logger.Infof("Tunnel Pool of peer %d created.\n", peerID) go manager.DecreaseNotify(tp) return tp } // Add a tunnel to tunnelPool and start bi-relay func (tp *TunnelPool) AddTunnel(tunnel *Tunnel) { tp.logger.Infof("Tunnel %d added to Peer %d.\n", tunnel.tunnelID, tp.peerID) tp.mutex.Lock() defer tp.mutex.Unlock() tp.tunnelMapping[tunnel.tunnelID] = tunnel tp.manager.Notify(tp) tunnel.ctx, tunnel.cancel = context.WithCancel(tp.ctx) go func() { <-tunnel.ctx.Done() tp.RemoveTunnel(tunnel) }() go tunnel.OutboundRelay(tp.sendQueue, tp.sendRetryQueue) go tunnel.InboundRelay(tp.recvQueue) } // Remove a tunnel from tunnelPool and stop bi-relay func (tp *TunnelPool) RemoveTunnel(tunnel *Tunnel) { tp.logger.Infof("Tunnel %d to peer %d removed from pool.\n", tunnel.tunnelID, tunnel.peerID) tp.mutex.Lock() defer tp.mutex.Unlock() if tunnel, ok := tp.tunnelMapping[tunnel.tunnelID]; ok { delete(tp.tunnelMapping, tunnel.tunnelID) tp.manager.Notify(tp) go tp.manager.DecreaseNotify(tp) } } func (tp *TunnelPool) GetSendQueue() chan block.Block { return tp.sendQueue } func (tp *TunnelPool) GetRecvQueue() chan block.Block { return tp.recvQueue } ================================================ FILE: tunnel_pool/tunnel.go ================================================ package tunnel_pool import ( "bytes" "context" "encoding/binary" "errors" "fmt" "github.com/ihciah/rabbit-tcp/block" "github.com/ihciah/rabbit-tcp/logger" "github.com/ihciah/rabbit-tcp/tunnel" "io" "math/rand" "net" "time" ) type Tunnel struct { net.Conn ctx context.Context cancel context.CancelFunc tunnelID uint32 peerID uint32 logger *logger.Logger } // Create a new tunnel from a net.Conn and cipher with random tunnelID func NewActiveTunnel(conn net.Conn, ciph tunnel.Cipher, peerID uint32) (Tunnel, error) { tun := newTunnelWithID(conn, ciph, peerID) return tun, tun.activeExchangePeerID() } func NewPassiveTunnel(conn net.Conn, ciph tunnel.Cipher) (Tunnel, error) { tun := newTunnelWithID(conn, ciph, 0) return tun, tun.passiveExchangePeerID() } // Create a new tunnel from a net.Conn and cipher with given tunnelID func newTunnelWithID(conn net.Conn, ciph tunnel.Cipher, peerID uint32) Tunnel { tunnelID := rand.Uint32() tun := Tunnel{ Conn: tunnel.NewEncryptedConn(conn, ciph), peerID: peerID, tunnelID: tunnelID, logger: logger.NewLogger(fmt.Sprintf("[Tunnel-%d]", tunnelID)), } tun.logger.Infoln("Tunnel created.") return tun } func (tunnel *Tunnel) activeExchangePeerID() (err error) { err = tunnel.sendPeerID(tunnel.peerID) if err != nil { tunnel.logger.Errorf("Cannot exchange peerID(send failed: %v).\n", err) return err } peerID, err := tunnel.recvPeerID() if err != nil { tunnel.logger.Errorf("Cannot exchange peerID(recv failed: %v).\n", err) return err } if tunnel.peerID != peerID { tunnel.logger.Errorf("Cannot exchange peerID(local: %d, remote: %d).\n", tunnel.peerID, peerID) return errors.New("invalid exchanging") } tunnel.logger.Infoln("PeerID exchange successfully.") return } func (tunnel *Tunnel) passiveExchangePeerID() (err error) { peerID, err := tunnel.recvPeerID() if err != nil { tunnel.logger.Errorf("Cannot exchange peerID(recv failed: %v).\n", err) return err } err = tunnel.sendPeerID(peerID) if err != nil { tunnel.logger.Errorf("Cannot exchange peerID(send failed: %v).\n", err) return err } tunnel.peerID = peerID tunnel.logger.Infoln("PeerID exchange successfully.") return } func (tunnel *Tunnel) sendPeerID(peerID uint32) error { peerIDBuffer := make([]byte, 4) binary.LittleEndian.PutUint32(peerIDBuffer, peerID) _, err := io.CopyN(tunnel.Conn, bytes.NewReader(peerIDBuffer), 4) if err != nil { tunnel.logger.Errorf("Peer id sent with error:%v.\n", err) return err } tunnel.logger.Infoln("Peer id sent.") return nil } func (tunnel *Tunnel) recvPeerID() (uint32, error) { peerIDBuffer := make([]byte, 4) _, err := io.ReadFull(tunnel.Conn, peerIDBuffer) if err != nil { tunnel.logger.Errorf("Peer id recv with error:%v.\n", err) return 0, err } peerID := binary.LittleEndian.Uint32(peerIDBuffer) tunnel.logger.Infoln("Peer id recv.") return peerID, nil } // Read block from send channel, pack it and send func (tunnel *Tunnel) OutboundRelay(normalQueue, retryQueue chan block.Block) { tunnel.logger.Infoln("Outbound relay started.") for { // cancel is of highest priority select { case <-tunnel.ctx.Done(): return default: } // retryQueue is of secondary highest priority select { case <-tunnel.ctx.Done(): return case blk := <-retryQueue: tunnel.packThenSend(blk, retryQueue) default: } // normalQueue is of secondary highest priority select { case <-tunnel.ctx.Done(): return case blk := <-retryQueue: tunnel.packThenSend(blk, retryQueue) case blk := <-normalQueue: tunnel.packThenSend(blk, retryQueue) } } } func (tunnel *Tunnel) packThenSend(blk block.Block, retryQueue chan block.Block) { dataToSend := blk.Pack() reader := bytes.NewReader(dataToSend) tunnel.Conn.SetWriteDeadline(time.Now().Add(TunnelBlockTimeoutSec * time.Second)) n, err := io.Copy(tunnel.Conn, reader) if err != nil || n != int64(len(dataToSend)) { tunnel.logger.Warnf("Error when send bytes to tunnel: (n: %d, error: %v).\n", n, err) // Tunnel down and message has not been fully sent. tunnel.closeThenCancel() go func() { retryQueue <- blk }() // Use new goroutine to avoid channel blocked } else { tunnel.Conn.SetWriteDeadline(time.Time{}) tunnel.logger.Debugf("Copied data to tunnel successfully(n: %d).\n", n) } } // Read bytes from connection, parse it to block then put in recv channel func (tunnel *Tunnel) InboundRelay(output chan<- block.Block) { tunnel.logger.Infoln("Inbound relay started.") for { select { case <-tunnel.ctx.Done(): // Should read all before leave, or packet will be lost for { // Will never be blocked because the tunnel is closed blk, err := block.NewBlockFromReader(tunnel.Conn) if err == nil { tunnel.logger.Debugf("Block received from tunnel(type: %d) successfully after close.\n", blk.Type) output <- *blk } else { tunnel.logger.Debugf("Error when receiving block from tunnel after close: %v.\n", err) break } } return default: blk, err := block.NewBlockFromReader(tunnel.Conn) if err != nil { // Server will never close connection in normal cases tunnel.logger.Errorf("Error when receiving block from tunnel: %v.\n", err) // Tunnel down and message has not been fully read. tunnel.closeThenCancel() } else { tunnel.logger.Debugf("Block received from tunnel(type: %d)successfully.\n", blk.Type) output <- *blk } } } } func (tunnel *Tunnel) GetPeerID() uint32 { return tunnel.peerID } func (tunnel *Tunnel) closeThenCancel() { tunnel.Close() tunnel.cancel() }