Veillax/shark-expose
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

shark expose: put a local port on the internet through Hammerhead

Browse Source 
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This commit is contained in:
VeillaxandClaude Sonnet 5.5 committed 2026-10-27 17:00:53 -06:00
commit 61143d107c
15 files changed
+1538
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

.gitignore
+4
View File
@@ -0,0 +1,4 @@
bin/
dist/
*.exe
.env
LICENSE
+235
View File
@@ -0,0 +1,235 @@
GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
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.
Hammerhead
Copyright (C) 2026 Veillax
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 <http://www.gnu.org/licenses/>.
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 <http://www.gnu.org/licenses/>.
README.md
+74
View File
@@ -0,0 +1,74 @@
# shark-expose
`shark expose 3000`: put a local port on the internet through your own [Hammerhead](https://git.veillax.com/Veillax/hammerhead) and [Blacktip](https://git.veillax.com/Veillax/blacktip), the way ngrok does, with nothing to clean up afterwards.
```
$ shark expose 3000 --password s3cret
shark http://demo-4f2a.dev.example.com -> 127.0.0.1:3000
Visitors must sign in.
Press Ctrl+C to stop.
```
One command asks Hammerhead for a short-lived site and a public name or port, brings up the WireGuard tunnel from your machine (it embeds the [Bamboo](https://git.veillax.com/Veillax/bamboo) agent, so there is nothing else to install or run), prints the address, and keeps it alive. On Ctrl+C it deletes everything it created. If shark is killed or loses the network, Hammerhead removes the exposure itself once its TTL runs out (5 minutes unless you say otherwise).
## Install
```
go env -w GOPRIVATE=git.veillax.com
go install git.veillax.com/Veillax/shark-expose/cmd/shark@latest
```
## Sign in
Make an API key under **Access** in the Hammerhead dashboard, then:
```
shark login --hammerhead https://hammerhead.example.com --token hhk_...
```
This checks the key and saves it to your user config folder (`shark/config.json`, readable by you only; `SHARK_CONFIG` picks another file). `SHARK_HAMMERHEAD` and `SHARK_TOKEN` override it, which suits CI.
An API key belongs to one organization and can manage its settings, so treat it like a password. Exposures are made in that organization.
## Use
```
shark expose 3000 website on <random>.<one of your domains>
shark expose https 3000 the same over HTTPS (Blacktip gets the certificate)
shark expose 3000 --name demo demo-<random>.<domain>
shark expose 3000 --hostname me.dev.example.com
shark expose 192.168.1.20:8080 something else on your network
shark expose tcp 25565 raw TCP on a free public port (20000-29999)
shark expose tcp 22 --port 20022 ...on the port you pick
shark ls what is exposed in your organization right now
```
| Flag | |
|---|---|
| `--password P`, `--pin N`, `--sso` | Put a login in front of a website: a shared password (6+ characters), a PIN (4-12 digits), or a Hammerhead account. Can be combined; `SHARK_PASSWORD` avoids putting the password on the command line. |
| `--ttl 10m` | How long Hammerhead keeps it if shark goes quiet (30s to 24h). shark renews every third of that while it runs. |
| `--name`, `--hostname`, `--port`, `--edge` | Choose the label, the full public name, the public port, or the edge. |
| `--verbose` | Show the tunnel agent's log. |
For websites Hammerhead needs a domain to put the name under (**Domains** in the dashboard), with a wildcard DNS record pointing at the edge. TCP needs no domain: it uses the edge's address and a free port in 20000-29999, which has to be open in the edge's firewall. Login protection is for websites only.
## How it works
1. `POST /api/orgs/-/expose` makes an *ephemeral* site and mapping tagged `ephemeral` and returns the public address and the site's token.
2. shark runs Bamboo in-process with that token. It dials out to the edge, so your machine needs no inbound ports.
3. When the edge reports the port listening, shark prints the address.
4. `POST .../renew` every TTL/3. A 404 means Hammerhead dropped it, and shark exits with an error; renewals failing for longer than the TTL end it too.
5. `DELETE` on exit. The site, port, login secrets and tunnel address all go with it.
The API is documented in Hammerhead's README ("Ephemeral exposures"). It currently lives on Hammerhead's `feature/ephemeral-expose` branch.
## Development
```
go test ./... # unit tests, with a fake Hammerhead
cd e2e && go test ./... # shark against a real Hammerhead + Blacktip + Bamboo in one process
```
`e2e` is its own module so the CLI does not depend on Hammerhead. Its `go.mod` has a `replace` pointing at `../../hammerhead-expose`, a checkout of the Hammerhead branch above; change it once that is merged and released.
cmd/shark/main.go
+21
View File
@@ -0,0 +1,21 @@
// shark exposes a local port through your own Hammerhead and Blacktip, like ngrok.
package main
import (
"context"
"os"
"os/signal"
"syscall"
"git.veillax.com/Veillax/shark-expose/internal/cli"
)
// version is set at build time (-ldflags "-X main.version=...").
var version = "dev"
func main() {
ctx, stop := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGTERM)
defer stop()
cli.Version = version
os.Exit(cli.Run(ctx, os.Args[1:], os.Stdout, os.Stderr))
}
e2e/e2e_test.go
+272
View File
@@ -0,0 +1,272 @@
// Package e2e runs the shark CLI against a real Hammerhead, Blacktip and Bamboo in one process.
package e2e
import (
"bytes"
"context"
"crypto/tls"
"encoding/json"
"fmt"
"io"
"net"
"net/http"
"net/http/cookiejar"
"net/http/httptest"
"regexp"
"strconv"
"strings"
"sync"
"testing"
"time"
"git.veillax.com/Veillax/blacktip"
"git.veillax.com/Veillax/hammerhead"
"git.veillax.com/Veillax/shark-expose/internal/cli"
)
type stack struct {
url, key string
admin *http.Client
org string
}
func freeUDPPort(t *testing.T) int {
pc, err := net.ListenPacket("udp", "127.0.0.1:0")
if err != nil {
t.Fatal(err)
}
defer pc.Close()
return pc.LocalAddr().(*net.UDPAddr).Port
}
func freePort(t *testing.T) int {
l, err := net.Listen("tcp", "127.0.0.1:0")
if err != nil {
t.Fatal(err)
}
defer l.Close()
return l.Addr().(*net.TCPAddr).Port
}
func (s *stack) call(t *testing.T, method, path string, in any) []byte {
t.Helper()
var body io.Reader
if in != nil {
b, _ := json.Marshal(in)
body = bytes.NewReader(b)
}
req, _ := http.NewRequest(method, s.url+path, body)
req.Header.Set("Content-Type", "application/json")
resp, err := s.admin.Do(req)
if err != nil {
t.Fatal(err)
}
defer resp.Body.Close()
raw, _ := io.ReadAll(resp.Body)
if resp.StatusCode != 200 {
t.Fatalf("%s %s -> %d %s", method, path, resp.StatusCode, raw)
}
return raw
}
// newStack starts Hammerhead and one Blacktip edge with a domain, makes an API key, and points
// shark's settings at it.
func newStack(t *testing.T) *stack {
t.Helper()
s := &stack{}
var handler http.Handler
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { handler.ServeHTTP(w, r) }))
t.Cleanup(ts.Close)
hh, err := hammerhead.New(t.TempDir(), hammerhead.Options{AdminEmail: "admin@test.local", AdminPassword: "password123", DashboardURL: ts.URL})
if err != nil {
t.Fatal(err)
}
t.Cleanup(hh.Close)
handler = hh.Handler()
s.url = ts.URL
jar, _ := cookiejar.New(nil)
s.admin = &http.Client{Jar: jar, Timeout: 15 * time.Second}
s.call(t, "POST", "/api/login", map[string]string{"email": "admin@test.local", "password": "password123"})
var me struct{ Orgs []struct{ ID string } }
json.Unmarshal(s.call(t, "GET", "/api/me", nil), &me)
s.org = me.Orgs[0].ID
tunnel := freeUDPPort(t)
var edge struct{ ID, Token string }
json.Unmarshal(s.call(t, "POST", "/api/edges", map[string]any{"name": "edge", "tunnelAddr": "127.0.0.1:" + strconv.Itoa(tunnel)}), &edge)
s.call(t, "POST", "/api/orgs/"+s.org+"/domains", map[string]any{"name": "dev.test", "edgeId": edge.ID})
var key struct{ Key string }
json.Unmarshal(s.call(t, "POST", "/api/orgs/"+s.org+"/apikeys", map[string]string{"name": "shark"}), &key)
s.key = key.Key
ctx, cancel := context.WithCancel(context.Background())
t.Cleanup(cancel)
bt, err := blacktip.New(blacktip.Config{Hammerhead: ts.URL, Token: edge.Token, TunnelAddr: "127.0.0.1:" + strconv.Itoa(tunnel), DataDir: t.TempDir(),
GetCertificate: func(*tls.ClientHelloInfo) (*tls.Certificate, error) { return nil, fmt.Errorf("no tls in this test") }})
if err != nil {
t.Fatal(err)
}
go bt.Run(ctx)
t.Setenv("SHARK_CONFIG", t.TempDir()+"/config.json")
t.Setenv("SHARK_HAMMERHEAD", s.url)
t.Setenv("SHARK_TOKEN", s.key)
return s
}
// syncBuf is a buffer that can be read while shark is still writing to it.
type syncBuf struct {
mu sync.Mutex
b bytes.Buffer
}
func (s *syncBuf) Write(p []byte) (int, error) { s.mu.Lock(); defer s.mu.Unlock(); return s.b.Write(p) }
func (s *syncBuf) String() string { s.mu.Lock(); defer s.mu.Unlock(); return s.b.String() }
var addrLine = regexp.MustCompile(`shark (\S+)\s+->`)
// shark runs `shark <args>` and waits for it to print its public address. stop is Ctrl+C: it
// waits for shark to exit and returns the exit code.
func shark(t *testing.T, args ...string) (addr string, stop func() int) {
t.Helper()
out, errb := &syncBuf{}, &syncBuf{}
ctx, cancel := context.WithCancel(context.Background())
code := make(chan int, 1)
go func() { code <- cli.Run(ctx, args, out, errb) }()
var once sync.Once
var exit int
stop = func() int {
once.Do(func() {
cancel()
select {
case exit = <-code:
case <-time.After(20 * time.Second):
t.Error("shark did not exit after Ctrl+C")
}
})
return exit
}
t.Cleanup(func() { stop() })
for i := 0; i < 200; i++ {
if m := addrLine.FindStringSubmatch(out.String()); m != nil {
return m[1], stop
}
select {
case c := <-code:
t.Fatalf("shark exited early (%d): %s%s", c, out.String(), errb.String())
case <-time.After(100 * time.Millisecond):
}
}
t.Fatalf("no address printed: %s%s", out.String(), errb.String())
return
}
func (s *stack) exposures(t *testing.T) int {
t.Helper()
req, _ := http.NewRequest("GET", s.url+"/api/orgs/-/expose", nil)
req.Header.Set("Authorization", "Bearer "+s.key)
resp, err := http.DefaultClient.Do(req)
if err != nil {
t.Fatal(err)
}
defer resp.Body.Close()
var list []map[string]any
json.NewDecoder(resp.Body).Decode(&list)
return len(list)
}
func TestSharkTCP(t *testing.T) {
s := newStack(t)
l, err := net.Listen("tcp", "127.0.0.1:0")
if err != nil {
t.Fatal(err)
}
defer l.Close()
go func() {
for {
c, err := l.Accept()
if err != nil {
return
}
go func() {
defer c.Close()
b := make([]byte, 64)
n, _ := c.Read(b)
fmt.Fprintf(c, "echo:%s", b[:n])
}()
}
}()
addr, stop := shark(t, "expose", "tcp", strconv.Itoa(l.Addr().(*net.TCPAddr).Port))
hostport := strings.TrimPrefix(addr, "tcp://")
var got string
for i := 0; i < 60 && got != "echo:hi"; i++ {
if c, err := net.DialTimeout("tcp", hostport, time.Second); err == nil {
c.SetDeadline(time.Now().Add(2 * time.Second))
fmt.Fprint(c, "hi")
b, _ := io.ReadAll(c)
c.Close()
got = string(b)
}
time.Sleep(150 * time.Millisecond)
}
if got != "echo:hi" {
t.Fatalf("through shark: %q", got)
}
if n := s.exposures(t); n != 1 {
t.Fatalf("want 1 exposure while running, have %d", n)
}
if code := stop(); code != 0 {
t.Errorf("exit code %d", code)
}
if n := s.exposures(t); n != 0 {
t.Errorf("exposure left behind after exit: %d", n)
}
closed := false
for i := 0; i < 30 && !closed; i++ {
c, err := net.DialTimeout("tcp", hostport, 300*time.Millisecond)
if err != nil {
closed = true
break
}
c.Close()
time.Sleep(200 * time.Millisecond)
}
if !closed {
t.Error("public port still open after exit")
}
}
func TestSharkHTTPWithPassword(t *testing.T) {
s := newStack(t)
app := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { fmt.Fprint(w, "hello from the app") }))
defer app.Close()
port := freePort(t)
addr, stop := shark(t, "expose", app.Listener.Addr().String(), "--name", "demo", "--port", strconv.Itoa(port), "--password", "hunter22")
host := strings.TrimPrefix(addr, "http://")
host = host[:strings.LastIndex(host, ":")]
if !strings.HasPrefix(host, "demo-") || !strings.HasSuffix(host, ".dev.test") {
t.Fatalf("public name %q", host)
}
// the edge is on loopback, so dial it directly while presenting the public host name
hc := &http.Client{Timeout: 5 * time.Second,
Transport: &http.Transport{DialContext: func(ctx context.Context, _, _ string) (net.Conn, error) {
return (&net.Dialer{}).DialContext(ctx, "tcp", "127.0.0.1:"+strconv.Itoa(port))
}},
CheckRedirect: func(*http.Request, []*http.Request) error { return http.ErrUseLastResponse }}
var status int
var loc string
for i := 0; i < 60 && status != 302; i++ {
if resp, err := hc.Get(addr + "/"); err == nil {
resp.Body.Close()
status, loc = resp.StatusCode, resp.Header.Get("Location")
}
time.Sleep(150 * time.Millisecond)
}
if status != 302 || !strings.HasPrefix(loc, s.url+"/auth/r/") {
t.Fatalf("a protected site should redirect to the login, got %d %q", status, loc)
}
stop()
if n := s.exposures(t); n != 0 {
t.Errorf("exposure left behind: %d", n)
}
}
e2e/go.mod
+40
View File
@@ -0,0 +1,40 @@
module git.veillax.com/Veillax/shark-expose/e2e
go 1.27.3
// The ephemeral-exposure API is on Hammerhead's feature/ephemeral-expose branch; until it is
// released, point this at a checkout of that branch.
replace git.veillax.com/Veillax/hammerhead => ../../hammerhead-expose
require (
git.veillax.com/Veillax/blacktip v0.1.9
git.veillax.com/Veillax/hammerhead v0.0.0
git.veillax.com/Veillax/shark-expose v0.0.0
)
require (
git.veillax.com/Veillax/bamboo v0.1.5 // indirect
git.veillax.com/Veillax/reef v0.1.10 // indirect
github.com/Microsoft/go-winio v0.6.4 // indirect
github.com/dustin/go-humanize v1.1.0 // indirect
github.com/emersion/go-msgauth v0.7.0 // indirect
github.com/google/btree v1.1.2 // indirect
github.com/google/uuid v1.6.0 // indirect
github.com/mattn/go-isatty v0.0.24 // indirect
github.com/ncruces/go-strftime v1.1.0 // indirect
github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec // indirect
golang.org/x/crypto v0.58.0 // indirect
golang.org/x/net v0.61.0 // indirect
golang.org/x/sys v0.49.0 // indirect
golang.org/x/text v0.43.0 // indirect
golang.org/x/time v0.7.0 // indirect
golang.zx2c4.com/wintun v0.0.0-20230126152724-0fa3db229ce2 // indirect
golang.zx2c4.com/wireguard v0.0.0-20261024220952-b3bc704ef0ee // indirect
gvisor.dev/gvisor v0.0.0-20250503011706-39ed1f5ac29c // indirect
modernc.org/libc v1.79.0 // indirect
modernc.org/mathutil v1.7.1 // indirect
modernc.org/memory v1.12.1 // indirect
modernc.org/sqlite v1.61.0 // indirect
)
replace git.veillax.com/Veillax/shark-expose => ../
e2e/go.sum
+76
View File
@@ -0,0 +1,76 @@
git.veillax.com/Veillax/bamboo v0.1.5 h1:i81c75/7wjayP9tOQ3tSnJWTBhvbjAwNBEPhT+3P2Xk=
git.veillax.com/Veillax/bamboo v0.1.5/go.mod h1:se4kkcP6c3uCGD4HQd+nDLoblS0lN8qa+eFWLo5Horw=
git.veillax.com/Veillax/blacktip v0.1.9 h1:MMkF8GCrN01IWwwii1WM5l+nqIbHsOznyrbG7OvDtoo=
git.veillax.com/Veillax/blacktip v0.1.9/go.mod h1:9mYwKMiKXN/P0dpPtdTzG7zf1IeHt/aISa0SQD9rlzY=
git.veillax.com/Veillax/reef v0.1.10 h1:b15oD1vyrGOriCHhipQtJ3j7Cy5ForYWvfJkqifLQPg=
git.veillax.com/Veillax/reef v0.1.10/go.mod h1:ZBUd/BARO5kkpUNTP81TTY1aQXLHFR6bKDhCxckjHso=
github.com/Microsoft/go-winio v0.6.4 h1:kJF2pamtYCWXf0xAT8sAkwKC0pMl2HYBrRPHAqyUc+g=
github.com/Microsoft/go-winio v0.6.4/go.mod h1:1xl5JXG4ze/m74GH6Dc4Mwxfc3VL5siRVQjIAlHH07U=
github.com/dustin/go-humanize v1.1.0 h1:dbKTrvD0klcbBV/h4AWJdMuZogJACoMlvWIWZ5b2xWg=
github.com/dustin/go-humanize v1.1.0/go.mod h1:hc1CvRkJMsgxqjmjMQF3QNRAZBwY8AXBAzKYoSX9sFI=
github.com/emersion/go-msgauth v0.7.0 h1:vj2hMn6KhFtW41kshIBTXvp6KgYSqpA/ZN9Pv4g1INc=
github.com/emersion/go-msgauth v0.7.0/go.mod h1:mmS9I6HkSovrNgq0HNXTeu8l3sRAAuQ9RMvbM4KU7Ck=
github.com/google/btree v1.1.2 h1:xf4v41cLI2Z6FxbKm+8Bu+m8ifhj15JuZ9sa0jZCMUU=
github.com/google/btree v1.1.2/go.mod h1:qOPhT0dTNdNzV6Z/lhRX0YXUafgPLFUh+gZMl761Gm4=
github.com/google/pprof v0.0.0-20261016150608-1facf8f91b50 h1:PlNWJRxu5APSV0pWqfIsZ0qt9OOGHSWfZQ4zvx+WgWs=
github.com/google/pprof v0.0.0-20261016150608-1facf8f91b50/go.mod h1:yUo1AMMpsPIDFGuwDK8nLcf8+vvAd5l2O6JDZ6hpwrM=
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
github.com/hashicorp/golang-lru/v2 v2.0.7 h1:a+bsQ5rvGLjzHuww6tVxozPZFVghXaHOwFs4luLUK2k=
github.com/hashicorp/golang-lru/v2 v2.0.7/go.mod h1:QeFd9opnmA6QUJc5vARoKUSoFhyfM2/ZepoAG6RGpeM=
github.com/mattn/go-isatty v0.0.24 h1:tGZZoVgT/KiqK1c8ocVLeDS8BSWMRd47J3Lbz7vsReI=
github.com/mattn/go-isatty v0.0.24/go.mod h1:nMCL3Zebbrt45jsMDgnfIwz6ydEQApk5oEI3HqDio6A=
github.com/ncruces/go-strftime v1.1.0 h1:vtPmPWMkb539RGV9WpWT9EwJGvrOCKvMNI4obWL47Hk=
github.com/ncruces/go-strftime v1.1.0/go.mod h1:yVaq7iwCN09vHRrKBrrflXT0M9tTMG2KmZ9Fj7xeG/g=
github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec h1:W09IVJc94icq4NjY3clb7Lk8O1qJ8BdBEF8z0ibU0rE=
github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec/go.mod h1:qqbHyh8v60DhA7CoWK5oRCqLrMHRGoxYCSS9EjAz6Eo=
golang.org/x/crypto v0.58.0 h1:COkYLr4k7nDI4r6QtMML2AfzeIswWHAJthLS6K/M/54=
golang.org/x/crypto v0.58.0/go.mod h1:Xh+kl5A+M0gMiWDytH2Hhr5Z7WbNCpv/eB/EFgfSk+w=
golang.org/x/mod v0.42.0 h1:ICeL3t2L30ljSPHHxDnR4fqVcBt/zR2zJAb9juavmQg=
golang.org/x/mod v0.42.0/go.mod h1:u5fzIrRInkL8MaO1cbRkUHT64v303YIT5KEqpNr7jRs=
golang.org/x/net v0.61.0 h1:RR+6j/BTBCrggOLugxa+66R8FvoN6MHlzDlZIbN9YFw=
golang.org/x/net v0.61.0/go.mod h1:WgDCOTH8iwtB66T4/GfI94AHo/hhdb7Hah9NDseQfiI=
golang.org/x/sync v0.24.0 h1:iqiDrGoDgyuvAKrhLQthUEzU/R378N78gXbBjxed7oA=
golang.org/x/sync v0.24.0/go.mod h1:sUUOizhqBxiL6pEWpqNLUiaJn1ShEbZ6BBqskPbjZm0=
golang.org/x/sys v0.49.0 h1:XbzkgYJHdqh/8m2Uu0W/dQv8nktxx4BFHp1M0gROTXA=
golang.org/x/sys v0.49.0/go.mod h1:hNLxWAXmnKAxqDtdwIYC4bM9oQPEecfsnNMuSxOs3og=
golang.org/x/text v0.43.0 h1:1QivrlhwAsnMOcqgOdl9my7s9OyZl8O5/UGUTJVXoWc=
golang.org/x/text v0.43.0/go.mod h1:hbSIYA/amXcRXTFSZqh8tWHEoqRvvbKPJ2uz/KU+a+s=
golang.org/x/time v0.7.0 h1:ntUhktv3OPE6TgYxXWv9vKvUSJyIFJlyohwbkEwPrKQ=
golang.org/x/time v0.7.0/go.mod h1:3BpzKBy/shNhVucY/MWOyx10tF3SFh9QdLuxbVysPQM=
golang.org/x/tools v0.52.0 h1:ryxg4U63oaUYk7uOLTF37n43f4qgtGvqV4Ioit1BaEs=
golang.org/x/tools v0.52.0/go.mod h1:ItcP5UNaVGG+Yc4eIYmaFLNJ4soEopkx5Y2d4lcEurs=
golang.zx2c4.com/wintun v0.0.0-20230126152724-0fa3db229ce2 h1:B82qJJgjvYKsXS9jeunTOisW56dUokqW/FOteYJJ/yg=
golang.zx2c4.com/wintun v0.0.0-20230126152724-0fa3db229ce2/go.mod h1:deeaetjYA+DHMHg+sMSMI58GrEteJUUzzw7en6TJQcI=
golang.zx2c4.com/wireguard v0.0.0-20261024220952-b3bc704ef0ee h1:hByBPN/P/BVzJ591rJfvNhdoL94vmBtRbnVw77QJL20=
golang.zx2c4.com/wireguard v0.0.0-20261024220952-b3bc704ef0ee/go.mod h1:rpwXGsirqLqN2L0JDJQlwOboGHmptD5ZD6T2VmcqhTw=
gvisor.dev/gvisor v0.0.0-20250503011706-39ed1f5ac29c h1:m/r7OM+Y2Ty1sgBQ7Qb27VgIMBW8ZZhT4gLnUyDIhzI=
gvisor.dev/gvisor v0.0.0-20250503011706-39ed1f5ac29c/go.mod h1:3r5CMtNQMKIvBlrmM9xWUNamjKBYPOWyXOjmg5Kts3g=
modernc.org/cc/v4 v4.30.3 h1:aDq8gIX1X7+VFgO/JYYji6pLWL2H4tv3g8WatT3KCys=
modernc.org/cc/v4 v4.30.3/go.mod h1:OnovgIhbbMXMu1aISnJ0wvVD1KnW+cAUJkIrAWh+kVI=
modernc.org/ccgo/v4 v4.37.0 h1:BAuJCUtIHIxFIYaFhqXIw5YaoMBlNCUlFovejHfMip4=
modernc.org/ccgo/v4 v4.37.0/go.mod h1:/8627VhwWtAbqUXmPORxFQU5SgLrAx2jl9seLw9GBhY=
modernc.org/fileutil v1.4.0 h1:j6ZzNTftVS054gi281TyLjHPp6CPHr2KCxEXjEbD6SM=
modernc.org/fileutil v1.4.0/go.mod h1:EqdKFDxiByqxLk8ozOxObDSfcVOv/54xDs/DUHdvCUU=
modernc.org/gc/v2 v2.6.5 h1:nyqdV8q46KvTpZlsw66kWqwXRHdjIlJOhG6kxiV/9xI=
modernc.org/gc/v2 v2.6.5/go.mod h1:YgIahr1ypgfe7chRuJi2gD7DBQiKSLMPgBQe9oIiito=
modernc.org/gc/v3 v3.2.0 h1:/Y3LGDMQaoYf55PebP1qsZ5FDGgAZyG1RYKEHeQzh1o=
modernc.org/gc/v3 v3.2.0/go.mod h1:HFK/6AGESC7Ex+EZJhJ2Gni6cTaYpSMmU/cT9RmlfYY=
modernc.org/goabi0 v0.2.0 h1:HvEowk7LxcPd0eq6mVOAEMai46V+i7Jrj13t4AzuNks=
modernc.org/goabi0 v0.2.0/go.mod h1:CEFRnnJhKvWT1c1JTI3Avm+tgOWbkOu5oPA8eH8LnMI=
modernc.org/libc v1.79.0 h1:9Dvvv++bAMSkSuBzuOFAatbTV5OIoq6Y6FohmD3e7q8=
modernc.org/libc v1.79.0/go.mod h1:uT3kR61NsbeKJSLqq83GJwSnZMVLlSjyAz4DfTaBy1M=
modernc.org/mathutil v1.7.1 h1:GCZVGXdaN8gTqB1Mf/usp1Y/hSqgI2vAGGP4jZMCxOU=
modernc.org/mathutil v1.7.1/go.mod h1:4p5IwJITfppl0G4sUEDtCr4DthTaT47/N3aT6MhfgJg=
modernc.org/memory v1.12.1 h1:nFMiWrpStgZczNl6XI9GnIk/rWhYIyHGUaR04pGbp9g=
modernc.org/memory v1.12.1/go.mod h1:/JP4VbVC+K5sU2wZi9bHoq2MAkCnrt2r98UGeSK7Mjw=
modernc.org/opt v0.2.0 h1:tGyef5ApycA7FSEOMraay9SaTk5zmbx7Tu+cJs4QKZg=
modernc.org/opt v0.2.0/go.mod h1:03fq9lsNfvkYSfxrfUhZCWPk1lm4cq4N+Bh//bEtgns=
modernc.org/sortutil v1.2.1 h1:+xyoGf15mM3NMlPDnFqrteY07klSFxLElE2PVuWIJ7w=
modernc.org/sortutil v1.2.1/go.mod h1:7ZI3a3REbai7gzCLcotuw9AC4VZVpYMjDzETGsSMqJE=
modernc.org/sqlite v1.61.0 h1:sQi63oLQ9uquAUA4CzOisH35Q3pEszkPBuHM0tFL8CY=
modernc.org/sqlite v1.61.0/go.mod h1:f4gr5tbpx2umklaT/QVtbi/50hNdM+4ng+2zMo8KXJ0=
modernc.org/strutil v1.2.1 h1:UneZBkQA+DX2Rp35KcM69cSsNES9ly8mQWD71HKlOA0=
modernc.org/strutil v1.2.1/go.mod h1:EHkiggD70koQxjVdSBM3JKM7k6L0FbGE5eymy9i3B9A=
modernc.org/token v1.1.0 h1:Xl7Ap9dKaEs5kLoOQeQmPWevfnk/DM5qcLcYlA8ys6Y=
modernc.org/token v1.1.0/go.mod h1:UGzOrNV1mAFSEB63lOFHIpNRUVMvYTc6yu1SMY/XTDM=
go.mod
+18
View File
@@ -0,0 +1,18 @@
module git.veillax.com/Veillax/shark-expose
go 1.27.3
require git.veillax.com/Veillax/bamboo v0.1.5
require (
git.veillax.com/Veillax/reef v0.1.7 // indirect
github.com/Microsoft/go-winio v0.6.4 // indirect
github.com/google/btree v1.1.2 // indirect
golang.org/x/crypto v0.58.0 // indirect
golang.org/x/net v0.61.0 // indirect
golang.org/x/sys v0.49.0 // indirect
golang.org/x/time v0.7.0 // indirect
golang.zx2c4.com/wintun v0.0.0-20230126152724-0fa3db229ce2 // indirect
golang.zx2c4.com/wireguard v0.0.0-20261024220952-b3bc704ef0ee // indirect
gvisor.dev/gvisor v0.0.0-20250503011706-39ed1f5ac29c // indirect
)
go.sum
+22
View File
@@ -0,0 +1,22 @@
git.veillax.com/Veillax/bamboo v0.1.5 h1:i81c75/7wjayP9tOQ3tSnJWTBhvbjAwNBEPhT+3P2Xk=
git.veillax.com/Veillax/bamboo v0.1.5/go.mod h1:se4kkcP6c3uCGD4HQd+nDLoblS0lN8qa+eFWLo5Horw=
git.veillax.com/Veillax/reef v0.1.7 h1:5C2udonlJac2xvDOE5e+zDxej+AbZ9ttrNSE4owmwuU=
git.veillax.com/Veillax/reef v0.1.7/go.mod h1:ZBUd/BARO5kkpUNTP81TTY1aQXLHFR6bKDhCxckjHso=
github.com/Microsoft/go-winio v0.6.4 h1:kJF2pamtYCWXf0xAT8sAkwKC0pMl2HYBrRPHAqyUc+g=
github.com/Microsoft/go-winio v0.6.4/go.mod h1:1xl5JXG4ze/m74GH6Dc4Mwxfc3VL5siRVQjIAlHH07U=
github.com/google/btree v1.1.2 h1:xf4v41cLI2Z6FxbKm+8Bu+m8ifhj15JuZ9sa0jZCMUU=
github.com/google/btree v1.1.2/go.mod h1:qOPhT0dTNdNzV6Z/lhRX0YXUafgPLFUh+gZMl761Gm4=
golang.org/x/crypto v0.58.0 h1:COkYLr4k7nDI4r6QtMML2AfzeIswWHAJthLS6K/M/54=
golang.org/x/crypto v0.58.0/go.mod h1:Xh+kl5A+M0gMiWDytH2Hhr5Z7WbNCpv/eB/EFgfSk+w=
golang.org/x/net v0.61.0 h1:RR+6j/BTBCrggOLugxa+66R8FvoN6MHlzDlZIbN9YFw=
golang.org/x/net v0.61.0/go.mod h1:WgDCOTH8iwtB66T4/GfI94AHo/hhdb7Hah9NDseQfiI=
golang.org/x/sys v0.49.0 h1:XbzkgYJHdqh/8m2Uu0W/dQv8nktxx4BFHp1M0gROTXA=
golang.org/x/sys v0.49.0/go.mod h1:hNLxWAXmnKAxqDtdwIYC4bM9oQPEecfsnNMuSxOs3og=
golang.org/x/time v0.7.0 h1:ntUhktv3OPE6TgYxXWv9vKvUSJyIFJlyohwbkEwPrKQ=
golang.org/x/time v0.7.0/go.mod h1:3BpzKBy/shNhVucY/MWOyx10tF3SFh9QdLuxbVysPQM=
golang.zx2c4.com/wintun v0.0.0-20230126152724-0fa3db229ce2 h1:B82qJJgjvYKsXS9jeunTOisW56dUokqW/FOteYJJ/yg=
golang.zx2c4.com/wintun v0.0.0-20230126152724-0fa3db229ce2/go.mod h1:deeaetjYA+DHMHg+sMSMI58GrEteJUUzzw7en6TJQcI=
golang.zx2c4.com/wireguard v0.0.0-20261024220952-b3bc704ef0ee h1:hByBPN/P/BVzJ591rJfvNhdoL94vmBtRbnVw77QJL20=
golang.zx2c4.com/wireguard v0.0.0-20261024220952-b3bc704ef0ee/go.mod h1:rpwXGsirqLqN2L0JDJQlwOboGHmptD5ZD6T2VmcqhTw=
gvisor.dev/gvisor v0.0.0-20250503011706-39ed1f5ac29c h1:m/r7OM+Y2Ty1sgBQ7Qb27VgIMBW8ZZhT4gLnUyDIhzI=
gvisor.dev/gvisor v0.0.0-20250503011706-39ed1f5ac29c/go.mod h1:3r5CMtNQMKIvBlrmM9xWUNamjKBYPOWyXOjmg5Kts3g=
internal/api/api.go
+157
View File
@@ -0,0 +1,157 @@
// Package api is the small slice of Hammerhead's HTTP API that `shark expose` uses.
package api
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"net/url"
"strings"
"time"
)
// Client talks to Hammerhead with an API key (the "user token" from Access in the dashboard).
type Client struct {
Base string
Token string
HTTP *http.Client
}
func New(base, token string) *Client {
return &Client{Base: strings.TrimRight(base, "/"), Token: token, HTTP: &http.Client{Timeout: 20 * time.Second}}
}
// Error is an error Hammerhead answered with.
type Error struct {
Status int
Message string
}
func (e *Error) Error() string { return e.Message }
// IsStatus reports whether err is a Hammerhead error with this HTTP status.
func IsStatus(err error, status int) bool {
var e *Error
return errors.As(err, &e) && e.Status == status
}
// Request is what to expose. Zero values mean "let Hammerhead choose".
type Request struct {
Proto string `json:"proto"` // http, https or tcp
Name string `json:"name,omitempty"`
TargetHost string `json:"targetHost,omitempty"`
TargetPort int `json:"targetPort"`
TTLSeconds int `json:"ttlSeconds,omitempty"`
Port int `json:"port,omitempty"`
Hostname string `json:"hostname,omitempty"`
EdgeID string `json:"edgeId,omitempty"`
Auth *Auth `json:"auth,omitempty"`
}
// Auth is the login in front of a website.
type Auth struct {
Password string `json:"password,omitempty"`
Pin string `json:"pin,omitempty"`
SSO bool `json:"sso,omitempty"`
}
// Exposure is an ephemeral site and port as Hammerhead describes it.
type Exposure struct {
ID string `json:"id"`
Proto string `json:"proto"`
URL string `json:"url"`
Host string `json:"host"`
Port int `json:"port"`
Hostname string `json:"hostname"`
SiteToken string `json:"siteToken"`
Hammerhead string `json:"hammerhead"`
Protected bool `json:"protected"`
ExpiresAt time.Time `json:"expiresAt"`
Live bool `json:"live"`
Error string `json:"error"`
}
// Address is what visitors use: the URL for websites, host:port for tcp.
func (e Exposure) Address() string {
if e.URL != "" {
return e.URL
}
return fmt.Sprintf("tcp://%s:%d", e.Host, e.Port)
}
func (c *Client) do(ctx context.Context, method, path string, in, out any) error {
var body io.Reader
if in != nil {
b, err := json.Marshal(in)
if err != nil {
return err
}
body = bytes.NewReader(b)
}
u, err := url.JoinPath(c.Base, path)
if err != nil {
return err
}
req, err := http.NewRequestWithContext(ctx, method, u, body)
if err != nil {
return err
}
req.Header.Set("Authorization", "Bearer "+c.Token)
if in != nil {
req.Header.Set("Content-Type", "application/json")
}
resp, err := c.HTTP.Do(req)
if err != nil {
return err
}
defer resp.Body.Close()
raw, _ := io.ReadAll(io.LimitReader(resp.Body, 1<<20))
if resp.StatusCode != http.StatusOK {
var e struct{ Error string }
json.Unmarshal(raw, &e)
if e.Error == "" {
e.Error = fmt.Sprintf("%s %s: %s", method, path, resp.Status)
}
if resp.StatusCode == http.StatusUnauthorized {
e.Error = "Hammerhead did not accept the token (" + e.Error + ")"
}
return &Error{Status: resp.StatusCode, Message: e.Error}
}
if out != nil {
return json.Unmarshal(raw, out)
}
return nil
}
func (c *Client) Create(ctx context.Context, r Request) (Exposure, error) {
var e Exposure
err := c.do(ctx, "POST", "/api/orgs/-/expose", r, &e)
return e, err
}
// Renew pushes the deadline out by ttl (0 = the server's default).
func (c *Client) Renew(ctx context.Context, id string, ttl time.Duration) (Exposure, error) {
var e Exposure
err := c.do(ctx, "POST", "/api/orgs/-/expose/"+id+"/renew", map[string]int{"ttlSeconds": int(ttl.Seconds())}, &e)
return e, err
}
func (c *Client) Get(ctx context.Context, id string) (Exposure, error) {
var e Exposure
err := c.do(ctx, "GET", "/api/orgs/-/expose/"+id, nil, &e)
return e, err
}
func (c *Client) List(ctx context.Context) ([]Exposure, error) {
var e []Exposure
err := c.do(ctx, "GET", "/api/orgs/-/expose", nil, &e)
return e, err
}
func (c *Client) Delete(ctx context.Context, id string) error {
return c.do(ctx, "DELETE", "/api/orgs/-/expose/"+id, nil, nil)
}
internal/cli/cli.go
+218
View File
@@ -0,0 +1,218 @@
// Package cli is the shark command line.
package cli
import (
"context"
"errors"
"flag"
"fmt"
"io"
"net"
"os"
"strconv"
"strings"
"time"
"git.veillax.com/Veillax/shark-expose/internal/api"
"git.veillax.com/Veillax/shark-expose/internal/config"
"git.veillax.com/Veillax/shark-expose/internal/expose"
)
// Version is set at build time by cmd/shark.
var Version = "dev"
const usage = `shark exposes a local port through your own Hammerhead.
Usage:
shark expose [http|https|tcp] <port | host:port> [flags]
shark login --hammerhead URL --token KEY
shark ls
shark version
Examples:
shark expose 3000 website on a random name under one of your domains
shark expose 3000 --password s3cret ...behind a shared password
shark expose tcp 25565 raw TCP on a free public port
Run "shark expose -h" for all flags.
`
// Run executes one command line and returns the exit code. Cancelling ctx is Ctrl+C.
func Run(ctx context.Context, args []string, stdout, stderr io.Writer) int {
if len(args) == 0 {
fmt.Fprint(stderr, usage)
return 2
}
var err error
switch args[0] {
case "expose":
err = cmdExpose(ctx, args[1:], stdout, stderr)
case "login":
err = cmdLogin(args[1:], stdout)
case "ls", "list":
err = cmdList(context.Background(), stdout)
case "version", "-v", "--version":
fmt.Fprintln(stdout, "shark", Version)
case "help", "-h", "--help":
fmt.Fprint(stdout, usage)
default:
fmt.Fprintf(stderr, "unknown command %q\n\n%s", args[0], usage)
return 2
}
if err != nil {
if errors.Is(err, flag.ErrHelp) {
return 0
}
fmt.Fprintln(stderr, "shark:", err)
return 1
}
return 0
}
func client() (*api.Client, error) {
cfg, err := config.Load()
if err != nil {
return nil, err
}
if cfg.Hammerhead == "" || cfg.Token == "" {
return nil, errors.New("not signed in: run `shark login --hammerhead https://your-hammerhead --token hhk_...` (make a key under Access in the dashboard), or set SHARK_HAMMERHEAD and SHARK_TOKEN")
}
return api.New(cfg.Hammerhead, cfg.Token), nil
}
func cmdLogin(args []string, out io.Writer) error {
fs := flag.NewFlagSet("login", flag.ContinueOnError)
hh := fs.String("hammerhead", "", "URL of your Hammerhead")
tok := fs.String("token", os.Getenv("SHARK_TOKEN"), "API key from Access in the dashboard (or set SHARK_TOKEN)")
if err := fs.Parse(args); err != nil {
return err
}
if *hh == "" || *tok == "" {
return errors.New("login needs --hammerhead and --token")
}
c := api.New(*hh, *tok)
if _, err := c.List(context.Background()); err != nil {
return fmt.Errorf("could not sign in: %w", err)
}
p, err := config.Save(config.Config{Hammerhead: c.Base, Token: *tok})
if err != nil {
return err
}
fmt.Fprintf(out, "Signed in to %s. Saved to %s\n", c.Base, p)
return nil
}
func cmdList(ctx context.Context, out io.Writer) error {
c, err := client()
if err != nil {
return err
}
list, err := c.List(ctx)
if err != nil {
return err
}
if len(list) == 0 {
fmt.Fprintln(out, "Nothing is exposed.")
}
for _, e := range list {
fmt.Fprintf(out, "%s %-5s %s (expires %s)\n", e.ID, e.Proto, e.Address(), time.Until(e.ExpiresAt).Round(time.Second))
}
return nil
}
// target parses "3000", ":3000" or "host:3000".
func target(s string) (string, int, error) {
host := "127.0.0.1"
if i := strings.LastIndex(s, ":"); i >= 0 {
if h := s[:i]; h != "" {
host = h
}
s = s[i+1:]
}
n, err := strconv.Atoi(s)
if err != nil || n < 1 || n > 65535 {
return "", 0, fmt.Errorf("%q is not a port between 1 and 65535", s)
}
return strings.Trim(host, "[]"), n, nil
}
// splitArgs lets flags come before or after the positional arguments.
func splitArgs(fs *flag.FlagSet, args []string) ([]string, error) {
var pos []string
for {
if err := fs.Parse(args); err != nil {
return nil, err
}
if fs.NArg() == 0 {
return pos, nil
}
pos = append(pos, fs.Arg(0))
args = fs.Args()[1:]
}
}
func cmdExpose(ctx context.Context, args []string, stdout, stderr io.Writer) error {
fs := flag.NewFlagSet("expose", flag.ContinueOnError)
fs.SetOutput(stderr)
name := fs.String("name", "", "label used in the public name and the dashboard")
ttl := fs.Duration("ttl", 5*time.Minute, "how long Hammerhead keeps the exposure if shark stops talking to it (30s-24h)")
hostname := fs.String("hostname", "", "website: the full public name (must be under one of your domains)")
port := fs.Int("port", 0, "public port (default: 80/443 for websites, a free one for tcp)")
edge := fs.String("edge", "", "edge ID to use (default: any online edge)")
password := fs.String("password", os.Getenv("SHARK_PASSWORD"), "website: require this password (6+ characters; or set SHARK_PASSWORD)")
pin := fs.String("pin", "", "website: require this 4-12 digit PIN")
sso := fs.Bool("sso", false, "website: require a Hammerhead account")
verbose := fs.Bool("verbose", false, "show the tunnel agent's log")
fs.Usage = func() {
fmt.Fprint(stderr, "Usage: shark expose [http|https|tcp] <port | host:port> [flags]\n\n")
fs.PrintDefaults()
}
pos, err := splitArgs(fs, args)
if err != nil {
return err
}
proto := "http"
if len(pos) == 2 {
proto, pos = strings.ToLower(pos[0]), pos[1:]
}
if len(pos) != 1 {
fs.Usage()
return errors.New("expected a port to expose")
}
if proto != "http" && proto != "https" && proto != "tcp" {
return fmt.Errorf("protocol must be http, https or tcp, not %q", proto)
}
host, tport, err := target(pos[0])
if err != nil {
return err
}
req := api.Request{Proto: proto, Name: *name, TargetHost: host, TargetPort: tport, Port: *port, Hostname: *hostname, EdgeID: *edge}
if *password != "" || *pin != "" || *sso {
if proto == "tcp" {
return errors.New("login protection works for websites, not tcp")
}
req.Auth = &api.Auth{Password: *password, Pin: *pin, SSO: *sso}
}
c, err := client()
if err != nil {
return err
}
if !expose.Listening(host, tport) {
fmt.Fprintf(stderr, "warning: nothing is listening on %s yet\n", net.JoinHostPort(host, strconv.Itoa(tport)))
}
o := expose.Options{Request: req, TTL: *ttl, Out: stderr, Verbose: *verbose}
err = expose.Run(ctx, c, o, func(e api.Exposure) {
fmt.Fprintf(stdout, "\nshark %s -> %s\n\n", e.Address(), net.JoinHostPort(host, strconv.Itoa(tport)))
if e.Protected {
fmt.Fprintln(stdout, "Visitors must sign in.")
}
if !e.Live {
fmt.Fprintln(stdout, "The edge has not confirmed the port yet; it may take a moment.")
}
fmt.Fprintln(stdout, "Press Ctrl+C to stop.")
})
if ctx.Err() != nil && err == nil {
fmt.Fprintln(stdout, "\nStopped. Removed from Hammerhead.")
}
return err
}
internal/cli/cli_test.go
+47
View File
@@ -0,0 +1,47 @@
package cli
import (
"bytes"
"context"
"fmt"
"strings"
"testing"
)
func TestTarget(t *testing.T) {
for in, want := range map[string]string{"3000": "127.0.0.1:3000", ":8080": "127.0.0.1:8080", "db.lan:5432": "db.lan:5432", "[::1]:80": "::1:80"} {
h, p, err := target(in)
if err != nil || fmt.Sprintf("%s:%d", h, p) != want {
t.Errorf("%q -> %s:%d, %v", in, h, p, err)
}
}
for _, bad := range []string{"", "abc", "0", "70000", "host:"} {
if _, _, err := target(bad); err == nil {
t.Errorf("%q accepted", bad)
}
}
}
func TestUsageErrors(t *testing.T) {
t.Setenv("SHARK_CONFIG", t.TempDir()+"/none.json")
t.Setenv("SHARK_HAMMERHEAD", "")
t.Setenv("SHARK_TOKEN", "")
for name, args := range map[string][]string{
"no command": {},
"unknown": {"fly"},
"no port": {"expose"},
"bad port": {"expose", "abc"},
"bad proto": {"expose", "udp", "5"},
"tcp password": {"expose", "tcp", "5", "--password", "secret1"},
"not signed in": {"expose", "3000"},
} {
var out, errb bytes.Buffer
if code := Run(context.Background(), args, &out, &errb); code == 0 {
t.Errorf("%s: exit 0", name)
}
}
var out, errb bytes.Buffer
if code := Run(context.Background(), []string{"expose", "3000"}, &out, &errb); code == 0 || !strings.Contains(errb.String(), "shark login") {
t.Errorf("signed-out hint missing: %q", errb.String())
}
}
internal/config/config.go
+66
View File
@@ -0,0 +1,66 @@
// Package config keeps the Hammerhead address and token between runs.
package config
import (
"encoding/json"
"errors"
"os"
"path/filepath"
"strings"
)
type Config struct {
Hammerhead string `json:"hammerhead"`
Token string `json:"token"`
}
// Path is where `shark login` saves the settings; SHARK_CONFIG overrides it.
func Path() (string, error) {
if p := os.Getenv("SHARK_CONFIG"); p != "" {
return p, nil
}
dir, err := os.UserConfigDir()
if err != nil {
return "", err
}
return filepath.Join(dir, "shark", "config.json"), nil
}
// Load reads the saved settings, then lets SHARK_HAMMERHEAD and SHARK_TOKEN override them.
// A missing file is not an error.
func Load() (Config, error) {
var c Config
p, err := Path()
if err == nil {
b, rerr := os.ReadFile(p)
switch {
case rerr == nil:
if err := json.Unmarshal(b, &c); err != nil {
return c, errors.New(p + " is not valid JSON: " + err.Error())
}
case !errors.Is(rerr, os.ErrNotExist):
return c, rerr
}
}
if v := os.Getenv("SHARK_HAMMERHEAD"); v != "" {
c.Hammerhead = v
}
if v := os.Getenv("SHARK_TOKEN"); v != "" {
c.Token = v
}
c.Hammerhead = strings.TrimRight(c.Hammerhead, "/")
return c, nil
}
// Save writes the settings so that only the user can read them (the token is a credential).
func Save(c Config) (string, error) {
p, err := Path()
if err != nil {
return "", err
}
if err := os.MkdirAll(filepath.Dir(p), 0o700); err != nil {
return "", err
}
b, _ := json.MarshalIndent(c, "", " ")
return p, os.WriteFile(p, append(b, '\n'), 0o600)
}
internal/expose/expose.go
+146
View File
@@ -0,0 +1,146 @@
// Package expose runs one exposure: ask Hammerhead for it, bring up the tunnel, keep it alive,
// and take everything down again when told to stop.
package expose
import (
"context"
"fmt"
"io"
"log"
"net"
"os"
"strconv"
"time"
"git.veillax.com/Veillax/bamboo"
"git.veillax.com/Veillax/shark-expose/internal/api"
)
type Options struct {
Request api.Request
TTL time.Duration
// LiveWait is how long to wait for the edge to start listening before giving up on a "live" confirmation.
LiveWait time.Duration
Out io.Writer // where status lines go; nil = discard
Verbose bool // let the tunnel agent log
}
func (o *Options) say(format string, a ...any) {
if o.Out != nil {
fmt.Fprintf(o.Out, format+"\n", a...)
}
}
// Run blocks until ctx is cancelled or the exposure is lost, and always removes what it created.
// onReady is called once with the exposure after the edge is listening (or LiveWait has passed).
func Run(ctx context.Context, c *api.Client, o Options, onReady func(api.Exposure)) error {
if o.TTL <= 0 {
o.TTL = 5 * time.Minute
}
if o.LiveWait <= 0 {
o.LiveWait = 20 * time.Second
}
o.Request.TTLSeconds = int(o.TTL.Seconds())
e, err := c.Create(ctx, o.Request)
if err != nil {
return err
}
// Whatever happens next, the exposure must not outlive us. The caller's ctx is probably
// cancelled by then, so cleanup gets its own.
defer func() {
cctx, cancel := context.WithTimeout(context.Background(), 8*time.Second)
defer cancel()
if err := c.Delete(cctx, e.ID); err != nil {
o.say("could not remove the exposure (it will expire by itself): %v", err)
}
}()
dir, err := os.MkdirTemp("", "shark-")
if err != nil {
return err
}
defer os.RemoveAll(dir)
if !o.Verbose {
log.SetOutput(io.Discard)
}
agent, err := bamboo.New(bamboo.Config{Hammerhead: c.Base, Token: e.SiteToken, DataDir: dir})
if err != nil {
return err
}
actx, stopAgent := context.WithCancel(ctx)
agentDone := make(chan struct{})
go func() { defer close(agentDone); agent.Run(actx) }()
defer func() {
stopAgent()
select {
case <-agentDone:
case <-time.After(5 * time.Second):
}
}()
// Hammerhead tells us when the edge has the port open.
deadline := time.Now().Add(o.LiveWait)
for !e.Live && time.Now().Before(deadline) {
select {
case <-ctx.Done():
return nil
case <-time.After(300 * time.Millisecond):
}
if got, err := c.Get(ctx, e.ID); err == nil {
e.Live, e.Error, e.ExpiresAt = got.Live, got.Error, got.ExpiresAt
}
}
if e.Error != "" {
return fmt.Errorf("the edge could not open the port: %s", e.Error)
}
if onReady != nil {
onReady(e)
}
return keepAlive(ctx, c, e.ID, o)
}
// keepAlive renews the exposure until ctx ends. It gives up once Hammerhead has forgotten the
// exposure, or when renewals have been failing for longer than the TTL (it has expired by then).
func keepAlive(ctx context.Context, c *api.Client, id string, o Options) error {
every := o.TTL / 3
if every < 5*time.Second {
every = 5 * time.Second
}
if every > time.Minute {
every = time.Minute
}
t := time.NewTicker(every)
defer t.Stop()
lastOK := time.Now()
for {
select {
case <-ctx.Done():
return nil
case <-t.C:
}
_, err := c.Renew(ctx, id, o.TTL)
switch {
case err == nil:
lastOK = time.Now()
case ctx.Err() != nil:
return nil
case api.IsStatus(err, 404):
return fmt.Errorf("Hammerhead no longer has this exposure (it expired or was removed)")
case time.Since(lastOK) > o.TTL:
return fmt.Errorf("lost contact with Hammerhead: %v", err)
default:
o.say("could not renew, will retry: %v", err)
}
}
}
// Listening reports whether something accepts connections at host:port.
func Listening(host string, port int) bool {
c, err := net.DialTimeout("tcp", net.JoinHostPort(host, strconv.Itoa(port)), time.Second)
if err != nil {
return false
}
c.Close()
return true
}
internal/expose/expose_test.go
+142
View File
@@ -0,0 +1,142 @@
package expose
import (
"context"
"encoding/json"
"net/http"
"net/http/httptest"
"sync"
"sync/atomic"
"testing"
"time"
"git.veillax.com/Veillax/shark-expose/internal/api"
)
// fakeHammerhead implements just enough of the expose API to watch what the client does.
type fakeHammerhead struct {
mu sync.Mutex
calls []string
renewErr int // status to answer renewals with; 0 = ok
gone atomic.Bool
srv *httptest.Server
created api.Request
}
func newFake(t *testing.T) *fakeHammerhead {
f := &fakeHammerhead{}
mux := http.NewServeMux()
reply := func(w http.ResponseWriter, code int, v any) {
w.WriteHeader(code)
json.NewEncoder(w).Encode(v)
}
exp := api.Exposure{ID: "abc", Proto: "tcp", Host: "edge.test", Port: 20001, SiteToken: "tok", Live: true}
mux.HandleFunc("POST /api/orgs/-/expose", func(w http.ResponseWriter, r *http.Request) {
f.mu.Lock()
defer f.mu.Unlock()
f.calls = append(f.calls, "create")
if r.Header.Get("Authorization") != "Bearer hhk_x_y" {
reply(w, 401, map[string]string{"error": "Sign in to continue."})
return
}
json.NewDecoder(r.Body).Decode(&f.created)
reply(w, 200, exp)
})
mux.HandleFunc("GET /api/orgs/-/expose/abc", func(w http.ResponseWriter, r *http.Request) { reply(w, 200, exp) })
mux.HandleFunc("POST /api/orgs/-/expose/abc/renew", func(w http.ResponseWriter, r *http.Request) {
f.mu.Lock()
defer f.mu.Unlock()
f.calls = append(f.calls, "renew")
if f.renewErr != 0 {
reply(w, f.renewErr, map[string]string{"error": "no such exposure"})
return
}
reply(w, 200, exp)
})
mux.HandleFunc("DELETE /api/orgs/-/expose/abc", func(w http.ResponseWriter, r *http.Request) {
f.mu.Lock()
f.calls = append(f.calls, "delete")
f.mu.Unlock()
f.gone.Store(true)
reply(w, 200, map[string]bool{"ok": true})
})
// the tunnel agent long-polls this; there is nothing for it to do
mux.HandleFunc("/site/", func(w http.ResponseWriter, r *http.Request) { w.WriteHeader(204) })
f.srv = httptest.NewServer(mux)
t.Cleanup(f.srv.Close)
return f
}
func (f *fakeHammerhead) count(call string) int {
f.mu.Lock()
defer f.mu.Unlock()
n := 0
for _, c := range f.calls {
if c == call {
n++
}
}
return n
}
func TestRunRenewsAndDeletesOnStop(t *testing.T) {
f := newFake(t)
c := api.New(f.srv.URL, "hhk_x_y")
ctx, cancel := context.WithCancel(context.Background())
ready := make(chan api.Exposure, 1)
done := make(chan error, 1)
go func() {
done <- Run(ctx, c, Options{Request: api.Request{Proto: "tcp", TargetPort: 3000}, TTL: 15 * time.Second}, func(e api.Exposure) { ready <- e })
}()
e := <-ready
if e.Address() != "tcp://edge.test:20001" {
t.Errorf("address %q", e.Address())
}
if f.created.TTLSeconds != 15 || f.created.TargetPort != 3000 {
t.Errorf("request %+v", f.created)
}
cancel()
if err := <-done; err != nil {
t.Fatalf("clean stop returned %v", err)
}
if !f.gone.Load() {
t.Fatal("exposure was not deleted on stop")
}
}
func TestRunStopsWhenHammerheadForgetsTheExposure(t *testing.T) {
f := newFake(t)
f.renewErr = 404
c := api.New(f.srv.URL, "hhk_x_y")
// renewals are never sooner than 5s; a short TTL is enough to reach one
err := Run(context.Background(), c, Options{Request: api.Request{Proto: "tcp", TargetPort: 1}, TTL: 3 * time.Second}, nil)
if err == nil {
t.Fatal("expected an error once the exposure expired")
}
if !f.gone.Load() {
t.Error("cleanup should still ask Hammerhead to delete")
}
}
func TestRunRejectedToken(t *testing.T) {
f := newFake(t)
err := Run(context.Background(), api.New(f.srv.URL, "wrong"), Options{Request: api.Request{Proto: "tcp", TargetPort: 1}}, nil)
if !api.IsStatus(err, 401) {
t.Fatalf("got %v", err)
}
if f.count("delete") != 0 {
t.Error("deleted something that was never created")
}
}
func TestRunLoopSurvivesFlakyRenewals(t *testing.T) {
f := newFake(t)
f.renewErr = 500
c := api.New(f.srv.URL, "hhk_x_y")
ctx, cancel := context.WithTimeout(context.Background(), 7*time.Second)
defer cancel()
err := keepAlive(ctx, c, "abc", Options{TTL: time.Minute})
if err != nil {
t.Fatalf("a failing renewal inside the TTL should not end the run: %v", err)
}
}