chore: rename licence file

.gitignore

@@ -4,4 +4,9 @@
 /.env
 /socks
 /host.key
-/custom
+/custom
+/dist
+tools/
+/CHANGELOG.md
+/.chglog
+/stats.json

.goreleaser.yaml

@@ -0,0 +1,95 @@
+project_name: rebound
+before:
+  hooks:
+    - go mod tidy
+builds:
+  - id: rebound
+    env:
+      - CGO_ENABLED=0
+    ldflags:
+      - -s
+      - -w
+      - -X "main.Version={{ .Env.GORELEASER_CURRENT_TAG }}"
+    gcflags:
+      - -trimpath="${PWD}"
+    asmflags:
+      - -trimpath="${PWD}"
+    goos:
+      - linux
+    goarch:
+      - amd64
+      - "386"
+    main: ./cmd/server
+archives:
+  - id: rebound
+    builds: ["rebound"]
+    name_template: '{{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}{{ with .Arm }}v{{ . }}{{ end }}{{ with .Mips }}_{{ . }}{{ end }}{{ if not (eq .Amd64 "v1") }}{{ .Amd64 }}{{ end }}'
+    files:
+      - README.md
+checksum:
+  name_template: 'checksums.txt'
+snapshot:
+  name_template: "{{ .Version }}"
+changelog:
+  sort: asc
+  filters:
+    exclude:
+      - '^docs:'
+      - '^test:'
+nfpms:
+  - id: rebound
+    builds:
+      - "rebound"
+    package_name: rebound
+    homepage: https://forge.cadoles.com/wpetit/rebound
+    maintainer: William Petit <wpetit@cadoles.com>
+    description: |-
+      SSH tunneling for machines behind NATs.
+    license: AGPL-3.0
+    formats:
+      - apk
+      - deb
+      - rpm
+    contents:
+      # Deb
+      - src: misc/packaging/systemd/rebound.systemd.service
+        dst: /usr/lib/systemd/system/rebound.service
+        packager: deb
+      - src: misc/packaging/systemd/rebound.env
+        dst: /etc/rebound/environ
+        type: config|noreplace
+        packager: deb
+
+      # RPM
+      - src: misc/packaging/systemd/rebound.systemd.service
+        dst: /usr/lib/systemd/system/rebound.service
+        packager: rpm    
+      - src: misc/packaging/systemd/rebound.env
+        type: config|noreplace
+        dst: /etc/rebound/environ
+        packager: rpm
+
+      # APK
+      - src: misc/packaging/openrc/rebound.openrc.sh
+        dst: /etc/init.d/rebound
+        file_info:
+          mode: 0755
+        packager: apk
+      - src: misc/packaging/openrc/rebound.conf
+        type: config|noreplace
+        dst: /etc/conf.d/rebound
+        file_info:
+          mode: 0755
+        packager: apk
+
+      # All
+      - dst: /var/lib/rebound
+        type: dir
+        file_info:
+          mode: 0700
+      - dst: /var/log/rebound
+        type: dir
+        file_info:
+          mode: 0700
+    scripts:
+      postinstall: "misc/packaging/common/postinstall-rebound.sh"

LICENCE

@@ -0,0 +1,661 @@
+                    GNU AFFERO GENERAL PUBLIC LICENSE
+                       Version 3, 19 November 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://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.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    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 <https://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
+<https://www.gnu.org/licenses/>.

Makefile

@@ -1,6 +1,15 @@
 SHELL := /bin/bash
 DOKKU_URL := dokku@dev.lookingfora.name:rebound
 
+GORELEASER_VERSION ?= v1.13.1
+GORELEASER_ARGS ?= release --snapshot  --clean
+
+MKT_GITEA_RELEASE_ORG ?= wpetit
+MKT_GITEA_RELEASE_PROJECT ?= rebound
+MKT_GITEA_RELEASE_VERSION ?= $(MKT_PROJECT_VERSION)
+
+DEPLOY_TARGET ?= root@cadoles-rebound
+
 all: build
 
 watch: tools/modd/bin/modd
@@ -34,6 +43,25 @@ dokku-deploy:
 	$(if $(shell git config remote.dokku.url),, git remote add dokku $(DOKKU_URL))
 	git push -f dokku $(shell git rev-parse HEAD):refs/heads/master
 
+.PHONY: dist
+dist: .mktools
+	( set -o allexport && source .env && set +o allexport && VERSION=$(GORELEASER_VERSION) curl -sfL https://goreleaser.com/static/run | GORELEASER_CURRENT_TAG="$(MKT_PROJECT_VERSION)" bash /dev/stdin $(GORELEASER_ARGS) )
+
+.PHONY: release
+release: changelog
+	$(MAKE) MKT_GITEA_RELEASE_ATTACHMENTS="$$(find dist/* -type f -name '*.apk' -or -name '*.deb' -or -name '*.rpm' -or -name 'checksums.txt' -or -name 'CHANGELOG.md' | tr '\n' ' ')" mkt-gitea-release
+
+.PHONY: changelog
+changelog: .mktools
+	$(MAKE) MKT_GIT_CHGLOG_ARGS='--next-tag $(MKT_PROJECT_VERSION) --tag-filter-pattern $(MKT_PROJECT_VERSION_CHANNEL) --output CHANGELOG.md' mkt-changelog
+
+.PHONY: deploy
+deploy: dist
+	FILE=$$(find ./dist -name '*amd64.deb') \
+		&& ssh $(DEPLOY_TARGET) rm -f ~/rebound_*amd64.deb \
+		&& scp $${FILE} $(DEPLOY_TARGET):~/ \
+		&& ssh $(DEPLOY_TARGET) dpkg -i $$(basename $${FILE})
+
 .PHONY: mktools
 mktools:
 	rm -rf .mktools

README.md

@@ -1,19 +1,23 @@
 # Rebound
 
-Serveur utilisant le protocole SSH pour créer des tunnels TCP/IP.
+An TCP tunneling server requiring only a SSH client.
 
 ## Usage
 
-### Ouvrir un tunnel sur un port local
+We want to access `<local_address>:<local_port>` from machine A's network as `<target_port>` on machine B.
+
+### Opening the tunnel on machine A
 
 ```shell
-ssh -R 0:<target_address>:<target_port> root@rebound.lookingfora.name -p 2222
+ssh -R 0:<local_address>:<local_port> root@rebound-server -p 80
 ```
 
-### Se connecter à un tunnel ouvert
+### Connecting to the tunnel on machine B
 
-```
-ssh -L <local_port>:0.0.0.0:1 <secret>@rebound.lookingfora.name -p 2222
+```shell
+ssh -L <target_port>:0.0.0.0:1 <secret>@rebound-server -p 80
 ```
 
-Vous pourrez ensuite accéder au service sur `127.0.0.1:<local_port>` comme si c'était `<target_address>:<target_port>`.
+## Licence
+
+[AGPL-3.0](./LICENCE)

cmd/server/main.go

@@ -1,7 +1,6 @@
 package main
 
 import (
-	"flag"
 	"log"
 	"os"
 	"os/signal"
@@ -12,6 +11,8 @@ import (
 	"github.com/pkg/errors"
 )
 
+var Version string = "unknown"
+
 func main() {
 	opts := rebound.DefaultOptions()
 
@@ -19,30 +20,21 @@ func main() {
 		log.Fatalf("[ERROR] %+v", errors.WithStack(err))
 	}
 
-	// Global Options
-	address := flag.String("address", opts.Address, "server listening address")
-
-	// SSH Options
-	sockDir := flag.String("ssh-sock-dir", opts.SSH.SockDir, "ssh sock directory")
-	publicPort := flag.Uint("ssh-public-port", opts.SSH.PublicPort, "ssh public port")
-	publicHost := flag.String("ssh-public-host", opts.SSH.PublicHost, "ssh public host")
-	hostKey := flag.String("ssh-host-key", opts.SSH.HostKey, "ssh host key")
-
-	// HTTP Options
-	customDir := flag.String("http-custom-dir", opts.HTTP.CustomDir, "http custom templates/assets directory")
-
-	flag.Parse()
+	opts.HTTP.TemplateData.Version = Version
 
 	server := rebound.NewServer(
-		rebound.WithAddress(*address),
+		rebound.WithAddress(opts.Address),
+		rebound.WithStatsFile(opts.StatsFile),
+		rebound.WithStatsFileSaveInterval(opts.StatsFileSaveInterval),
 		rebound.WithSSHOption(
-			ssh.WithSockDir(*sockDir),
-			ssh.WithPublicHost(*publicHost),
-			ssh.WithPublicPort(*publicPort),
-			ssh.WithHostKey(*hostKey),
+			ssh.WithSockDir(opts.SSH.SockDir),
+			ssh.WithPublicHost(opts.SSH.PublicHost),
+			ssh.WithPublicPort(opts.SSH.PublicPort),
+			ssh.WithHostKey(opts.SSH.HostKey),
 		),
 		rebound.WitHTTPOption(
-			http.WithCustomDir(*customDir),
+			http.WithCustomDir(opts.HTTP.CustomDir),
+			http.WithTemplateData(opts.HTTP.TemplateData),
 		),
 	)
 

http/options.go

@@ -1,10 +1,23 @@
 package http
 
-import "log"
+import (
+	"log"
+
+	"forge.cadoles.com/wpetit/rebound/stat"
+)
 
 type Options struct {
-	Logger    func(message string, args ...any)
-	CustomDir string `env:"CUSTOM_DIR"`
+	Logger       func(message string, args ...any)
+	CustomDir    string        `env:"CUSTOM_DIR"`
+	TemplateData *TemplateData `envPrefix:"TEMPLATE_DATA_"`
+	Stats        *stat.Store
+}
+
+type TemplateData struct {
+	Title         string `env:"TITLE"`
+	Version       string
+	SSHPublicHost string `env:"SSH_PUBLIC_HOST"`
+	SSHPublicPort int    `env:"SSH_PUBLIC_PORT"`
 }
 
 type OptionFunc func(*Options)
@@ -13,6 +26,12 @@ func DefaultOptions() *Options {
 	return &Options{
 		Logger:    log.Printf,
 		CustomDir: "",
+		TemplateData: &TemplateData{
+			Title:         "Rebound",
+			SSHPublicHost: "127.0.0.1",
+			SSHPublicPort: 2222,
+		},
+		Stats: stat.NewStore(),
 	}
 }
 
@@ -27,3 +46,15 @@ func WithCustomDir(customDir string) func(*Options) {
 		opts.CustomDir = customDir
 	}
 }
+
+func WithTemplateData(templateData *TemplateData) func(*Options) {
+	return func(opts *Options) {
+		opts.TemplateData = templateData
+	}
+}
+
+func WithStats(stats *stat.Store) func(*Options) {
+	return func(opts *Options) {
+		opts.Stats = stats
+	}
+}

http/server.go

@@ -3,9 +3,11 @@ package http
 import (
 	"bytes"
 	"embed"
+	"fmt"
 	"html/template"
 	"io"
 	"io/fs"
+	"log/slog"
 	"net"
 	"net/http"
 	"os"
@@ -29,13 +31,44 @@ type Server struct {
 	templates template.Template
 }
 
+var templateFuncs = template.FuncMap{
+	"humanSize": func(b float64) string {
+		const unit = 1000
+		if b < unit {
+			return fmt.Sprintf("%d B", int64(b))
+		}
+
+		div, exp := int64(unit), 0
+
+		for n := b / unit; n >= unit; n /= unit {
+			div *= unit
+			exp++
+		}
+
+		return fmt.Sprintf("%.1f %cB",
+			float64(b)/float64(div), "kMGTPE"[exp])
+	},
+}
+
 func (s *Server) serveHomepage(w http.ResponseWriter, r *http.Request) {
-	data := struct {
-		Title string
-	}{
-		Title: "Rebound",
+	stats, err := s.opts.Stats.Snapshot()
+	if err != nil {
+		slog.Error("could not make stats snapshot", slog.Any("error", errors.WithStack(err)))
+		http.Error(w, http.StatusText(http.StatusInternalServerError), http.StatusInternalServerError)
+
+		return
 	}
 
+	data := struct {
+		TemplateData
+		Stats map[string]float64
+	}{
+		TemplateData: *s.opts.TemplateData,
+		Stats:        stats,
+	}
+
+	s.opts.Stats.Add(StatTotalPageView, 1, 0)
+
 	s.renderTemplate(w, "index", data)
 }
 
@@ -73,7 +106,7 @@ func (s *Server) Serve(l net.Listener) error {
 }
 
 func (s *Server) parseTemplates(fs fs.FS) error {
-	templates, err := template.ParseFS(fs, "templates/*.html")
+	templates, err := template.New("").Funcs(templateFuncs).ParseFS(fs, "templates/*.html")
 	if err != nil {
 		return errors.WithStack(err)
 	}

http/stats.go

@@ -0,0 +1,5 @@
+package http
+
+const (
+	StatTotalPageView = "total_page_view"
+)

http/templates/footer.html

@@ -2,7 +2,7 @@
 <footer class="footer">
     <div class="container">
         <div class="content has-text-centered">
-            Ce service est propulsé par Rebound, un logiciel libre diffusé sous licence <a href="#">AGPL-3.0</a>.
+            Ce service est propulsé par <a href="https://forge.cadoles.com/wpetit/rebound" title="Rebound repository">rebound@{{ .Version }}</a>, un logiciel libre diffusé sous licence <a href="https://www.gnu.org/licenses/agpl-3.0.en.html#license-text">AGPL-3.0</a>.
         </div>
     </div>
 </footer>

http/templates/index.html

@@ -13,14 +13,46 @@
             <p class="subtitle is-size-3">
                 Bienvenue sur <strong>Rebound</strong>!
             </p>
-            <div class="content">
-                <p>Rebound est un serveur SSH permettant de créer des tunnels TCP/IP éphémères et privés entre 2 machines positionnées
-                    derrière un <abbr title="Network Address Traversal">NAT</abbr>.</p>
-                <p>Pour l'utiliser <strong>un simple client SSH suffit !</strong></p>
-                <pre class="has-background-dark	has-text-white-ter is-family-monospace">ssh -R 0:127.0.0.1:<span class="has-text-info">&lt;port&gt;</span> rebound@rebound.cadol.es</pre>
-                <p class="is-italic">Où <span class="has-text-info">&lt;port&gt;</span> est à remplacer par le port du service
-                    s'exécutant sur votre machine en local.</span>
-                <p>Une fois connecté, suivez les instructions. 😉</p>
+            <div class="block">
+                <div class="content">
+                    <p>Rebound est un serveur SSH permettant de créer des tunnels TCP/IP éphémères et privés entre 2 machines positionnées
+                        derrière un <abbr title="Network Address Traversal">NAT</abbr>.</p>
+                    <p>Pour l'utiliser <strong>un simple client SSH suffit !</strong></p>
+                    <pre class="has-background-dark	has-text-white-ter is-family-monospace">ssh -R 0:127.0.0.1:<span class="has-text-info">&lt;port&gt;</span> rebound@{{ .SSHPublicHost }} -p {{ .SSHPublicPort }}</pre>
+                    <p class="is-italic">Où <span class="has-text-info">&lt;port&gt;</span> est à remplacer par le port du service
+                        s'exécutant sur votre machine en local.</span>
+                    <p>Une fois connecté, suivez les instructions. 😉</p>
+                </div>
+            </div>
+            <hr />
+            <div class="block">
+                <div class="columns">
+                    <div class="column is-4">
+                        <h3 class="title is-size-4">En savoir plus</h3>
+                        <div class="content">
+                            À venir...
+                        </div>
+                    </div>
+                    <div class="column is-4">
+                        <h3 class="title is-size-4">Statistiques</h3>
+                        <table class="table is-bordered is-striped is-fullwidth">
+                            <tbody>
+                                <tr>
+                                    <td><strong>Total tunnels ouverts</strong></td>
+                                    <td>{{ index .Stats "total_opened_tunnels" }}</td>
+                                </tr>
+                                <tr>
+                                    <td><strong>Total données entrantes</strong></td>
+                                    <td>{{ humanSize ( index .Stats "total_rx_bytes" ) }}</td>
+                                </tr>
+                                <tr>
+                                    <td><strong>Total données sortantes</strong></td>
+                                    <td>{{ humanSize ( index .Stats "total_tx_bytes" ) }}</td>
+                                </tr>
+                            </tbody>
+                        </table>
+                    </div>
+                </div>
             </div>
         </div>
     </section>

misc/packaging/common/postinstall-rebound.sh

@@ -0,0 +1,75 @@
+#!/bin/sh
+
+use_systemctl="True"
+systemd_version=0
+if ! command -V systemctl >/dev/null 2>&1; then
+  use_systemctl="False"
+else
+  systemd_version=$(systemctl --version | head -1 | cut -d ' ' -f 2)
+fi
+
+service_name=rebound
+
+cleanup() {
+  if [ "${use_systemctl}" = "False" ]; then
+    rm -f /usr/lib/systemd/system/${service_name}.service
+  else
+    rm -f /etc/chkconfig/${service_name}
+    rm -f /etc/init.d/${service_name}
+  fi
+}
+
+cleanInstall() {
+  printf "\033[32m Post Install of an clean install\033[0m\n"
+  if [ "${use_systemctl}" = "False" ]; then
+    if command -V chkconfig >/dev/null 2>&1; then
+      chkconfig --add ${service_name}
+    fi
+
+    service ${service_name} restart || :
+  else
+    if [[ "${systemd_version}" -lt 231 ]]; then
+      printf "\033[31m systemd version %s is less then 231, fixing the service file \033[0m\n" "${systemd_version}"
+      sed -i "s/=+/=/g" /usr/lib/systemd/system/${service_name}.service
+    fi
+    printf "\033[32m Reload the service unit from disk\033[0m\n"
+    systemctl daemon-reload || :
+    printf "\033[32m Unmask the service\033[0m\n"
+    systemctl unmask ${service_name} || :
+    printf "\033[32m Set the preset flag for the service unit\033[0m\n"
+    systemctl preset ${service_name} || :
+    printf "\033[32m Set the enabled flag for the service unit\033[0m\n"
+    systemctl enable ${service_name} || :
+    systemctl restart ${service_name} || :
+  fi
+}
+
+upgrade() {
+  printf "\033[32m Post Install of an upgrade\033[0m\n"
+  systemctl daemon-reload || :
+  systemctl restart ${service_name} || :
+}
+
+# Step 2, check if this is a clean install or an upgrade
+action="$1"
+if [ "$1" = "configure" ] && [ -z "$2" ]; then
+  action="install"
+elif [ "$1" = "configure" ] && [ -n "$2" ]; then
+  action="upgrade"
+fi
+
+case "$action" in
+"1" | "install")
+  cleanInstall
+  ;;
+"2" | "upgrade")
+  printf "\033[32m Post Install of an upgrade\033[0m\n"
+  upgrade
+  ;;
+*)
+  printf "\033[32m Alpine\033[0m"
+  cleanInstall
+  ;;
+esac
+
+cleanup

misc/packaging/openrc/rebound.conf

@@ -0,0 +1,10 @@
+export REBOUND_ADDRESS=:2222
+export REBOUND_HTTP_CUSTOM_DIR=/etc/rebound/custom
+export REBOUND_SSH_PUBLIC_HOST=rebound
+export REBOUND_SSH_PUBLIC_PORT=2222
+export REBOUND_SSH_SOCK_DIR=/var/lib/rebound/socks
+export REBOUND_SSH_HOST_KEY=/etc/rebound/host.key
+export REBOUND_STATS_FILE=/var/lib/rebound/stats.json
+export REBOUND_HTTP_TEMPLATE_DATA_TITLE=Rebound
+export REBOUND_HTTP_TEMPLATE_DATA_SSH_PUBLIC_HOST=127.0.0.1
+export REBOUND_HTTP_TEMPLATE_DATA_SSH_PUBLIC_PORT=8080

misc/packaging/openrc/rebound.openrc.sh

@@ -0,0 +1,11 @@
+#!/sbin/openrc-run
+  
+command="/usr/bin/rebound"
+command_args=""
+supervisor=supervise-daemon
+output_log="/var/log/rebound.log"
+error_log="$output_log"
+
+depend() {
+    need net
+}

misc/packaging/systemd/rebound.env

@@ -0,0 +1,10 @@
+REBOUND_ADDRESS=:8080
+REBOUND_HTTP_CUSTOM_DIR=/var/lib/rebound/custom
+REBOUND_SSH_PUBLIC_HOST=rebound
+REBOUND_SSH_PUBLIC_PORT=8080
+REBOUND_SSH_SOCK_DIR=/var/lib/rebound/socks
+REBOUND_SSH_HOST_KEY=/var/lib/rebound/host.key
+REBOUND_STATS_FILE=/var/lib/rebound/stats.json
+REBOUND_HTTP_TEMPLATE_DATA_TITLE=Rebound
+REBOUND_HTTP_TEMPLATE_DATA_SSH_PUBLIC_HOST=127.0.0.1
+REBOUND_HTTP_TEMPLATE_DATA_SSH_PUBLIC_PORT=8080

misc/packaging/systemd/rebound.systemd.service

@@ -0,0 +1,35 @@
+[Unit]
+Description=rebound service
+After=network.target
+
+[Service]
+Type=simple
+Restart=on-failure
+EnvironmentFile=/etc/rebound/environ
+ExecStart=/usr/bin/rebound
+EnvironmentFile=/etc/rebound/environ
+NoNewPrivileges=yes
+PrivateTmp=yes
+PrivateDevices=yes
+PrivateUsers=yes
+DynamicUser=yes
+StateDirectory=rebound
+DevicePolicy=closed
+ProtectSystem=true
+ProtectHome=read-only
+ProtectKernelLogs=yes
+ProtectProc=invisible
+ProtectClock=yes
+ProtectControlGroups=yes
+ProtectKernelModules=yes
+ProtectKernelTunables=yes
+RestrictAddressFamilies=AF_UNIX AF_INET AF_INET6 AF_NETLINK
+RestrictNamespaces=yes
+RestrictRealtime=yes
+RestrictSUIDSGID=yes
+MemoryDenyWriteExecute=yes
+LockPersonality=yes
+CapabilityBoundingSet=~CAP_SETUID CAP_SETGID CAP_SETPCAP CAP_SYS_ADMIN CAP_SYS_PTRACE CAP_CHOWN CAP_FSETID CAP_SETFCAP CAP_DAC_OVERRIDE CAP_DAC_READ_SEARCH  CAP_FOWNER CAP_IPC_OWNER CAP_NET_ADMIN CAP_WAKE_ALARM CAP_SYS_TTY_CONFIG 
+
+[Install]
+WantedBy=multi-user.target

options.go

@@ -2,6 +2,7 @@ package rebound
 
 import (
 	"log"
+	"time"
 
 	"forge.cadoles.com/wpetit/rebound/http"
 	"forge.cadoles.com/wpetit/rebound/ssh"
@@ -10,10 +11,12 @@ import (
 )
 
 type Options struct {
-	Address string `env:"REBOUND_ADDRESS"`
-	Logger  func(message string, args ...any)
-	SSH     *ssh.Options  `envPrefix:"REBOUND_SSH_"`
-	HTTP    *http.Options `envPrefix:"REBOUND_HTTP_"`
+	Address               string        `env:"REBOUND_ADDRESS"`
+	StatsFile             string        `env:"REBOUND_STATS_FILE"`
+	StatsFileSaveInterval time.Duration `env:"REBOUND_STATS_FILE_SAVE_INTERVAL"`
+	Logger                func(message string, args ...any)
+	SSH                   *ssh.Options  `envPrefix:"REBOUND_SSH_"`
+	HTTP                  *http.Options `envPrefix:"REBOUND_HTTP_"`
 }
 
 func (o *Options) ParseEnv() error {
@@ -28,10 +31,12 @@ type OptionFunc func(*Options)
 
 func DefaultOptions() *Options {
 	return &Options{
-		Address: "127.0.0.1:2222",
-		Logger:  log.Printf,
-		SSH:     ssh.DefaultOptions(),
-		HTTP:    http.DefaultOptions(),
+		Address:               "127.0.0.1:2222",
+		StatsFile:             "stats.json",
+		StatsFileSaveInterval: 30 * time.Second,
+		Logger:                log.Printf,
+		SSH:                   ssh.DefaultOptions(),
+		HTTP:                  http.DefaultOptions(),
 	}
 }
 
@@ -49,6 +54,18 @@ func WithLogger(logger func(message string, args ...any)) func(*Options) {
 	}
 }
 
+func WithStatsFile(path string) func(*Options) {
+	return func(o *Options) {
+		o.StatsFile = path
+	}
+}
+
+func WithStatsFileSaveInterval(interval time.Duration) func(*Options) {
+	return func(o *Options) {
+		o.StatsFileSaveInterval = interval
+	}
+}
+
 func WithSSHOption(funcs ...ssh.OptionFunc) func(*Options) {
 	return func(o *Options) {
 		for _, fn := range funcs {

server.go

@@ -1,21 +1,34 @@
 package rebound
 
 import (
+	"log/slog"
 	"net"
+	"os"
+	"time"
 
 	"forge.cadoles.com/wpetit/rebound/http"
 	"forge.cadoles.com/wpetit/rebound/ssh"
+	"forge.cadoles.com/wpetit/rebound/stat"
 	"github.com/pkg/errors"
 )
 
 type Server struct {
 	listener net.Listener
 	opts     *Options
+	stats    *stat.Store
 }
 
 func (s *Server) Start() error {
 	s.log("[INFO] listening on %s", s.opts.Address)
 
+	if err := s.stats.Load(s.opts.StatsFile); err != nil {
+		if errors.Is(err, os.ErrNotExist) {
+			s.log("[INFO] stats file does not exist. ignoring.")
+		} else {
+			return errors.WithStack(err)
+		}
+	}
+
 	listener, err := net.Listen("tcp", s.opts.Address)
 	if err != nil {
 		return errors.WithStack(err)
@@ -34,6 +47,7 @@ func (s *Server) Start() error {
 			ssh.WithPublicPort(s.opts.SSH.PublicPort),
 			ssh.WithSockDir(s.opts.SSH.SockDir),
 			ssh.WithLogger(s.opts.SSH.Logger),
+			ssh.WithStats(s.stats),
 		)
 
 		if err := server.Serve(sshListener); err != nil {
@@ -47,7 +61,9 @@ func (s *Server) Start() error {
 
 		server := http.NewServer(
 			http.WithCustomDir(s.opts.HTTP.CustomDir),
+			http.WithTemplateData(s.opts.HTTP.TemplateData),
 			http.WithLogger(s.opts.HTTP.Logger),
+			http.WithStats(s.stats),
 		)
 
 		if err := server.Serve(httpListener); err != nil {
@@ -56,6 +72,23 @@ func (s *Server) Start() error {
 		}
 	}()
 
+	go func() {
+		defer listener.Close()
+
+		ticker := time.NewTicker(s.opts.StatsFileSaveInterval)
+
+		for {
+			<-ticker.C
+
+			slog.Info("saving stats", slog.String("file", s.opts.StatsFile), slog.Duration("interval", s.opts.StatsFileSaveInterval))
+			if err := s.stats.Save(s.opts.StatsFile); err != nil {
+				slog.Error("could not save stat file", slog.Any("error", errors.WithStack(err)))
+
+				return
+			}
+		}
+	}()
+
 	return nil
 }
 
@@ -84,6 +117,7 @@ func NewServer(funcs ...OptionFunc) *Server {
 	}
 
 	return &Server{
-		opts: opts,
+		opts:  opts,
+		stats: stat.NewStore(),
 	}
 }

ssh/direct_tcp_handler.go

@@ -77,7 +77,13 @@ func (s *Server) handleDirectTCP(srv *ssh.Server, conn *gossh.ServerConn, newCha
 		defer dconn.Close()
 		defer ch.Close()
 
-		if _, err := io.Copy(ch, dconn); err != nil {
+		reader := &instrumentedReader{
+			internal: dconn,
+			stats:    s.opts.Stats,
+			name:     StatTotalRxBytes,
+		}
+
+		if _, err := io.Copy(ch, reader); err != nil {
 			if errors.Is(err, net.ErrClosed) {
 				return
 			}
@@ -90,7 +96,13 @@ func (s *Server) handleDirectTCP(srv *ssh.Server, conn *gossh.ServerConn, newCha
 		defer dconn.Close()
 		defer ch.Close()
 
-		if _, err := io.Copy(dconn, ch); err != nil {
+		writer := &instrumentedWriter{
+			internal: dconn,
+			stats:    s.opts.Stats,
+			name:     StatTotalTxBytes,
+		}
+
+		if _, err := io.Copy(writer, ch); err != nil {
 			s.log("[ERROR] %+v", errors.WithStack(err))
 		}
 	}()

ssh/options.go

@@ -1,6 +1,10 @@
 package ssh
 
-import "log"
+import (
+	"log"
+
+	"forge.cadoles.com/wpetit/rebound/stat"
+)
 
 type Options struct {
 	Logger     func(message string, args ...any)
@@ -8,6 +12,7 @@ type Options struct {
 	PublicPort uint   `env:"PUBLIC_PORT"`
 	PublicHost string `env:"PUBLIC_HOST"`
 	HostKey    string `env:"HOST_KEY"`
+	Stats      *stat.Store
 }
 
 type OptionFunc func(*Options)
@@ -19,6 +24,7 @@ func DefaultOptions() *Options {
 		PublicPort: 2222,
 		PublicHost: "127.0.0.1",
 		HostKey:    "./host.key",
+		Stats:      stat.NewStore(),
 	}
 }
 
@@ -51,3 +57,9 @@ func WithLogger(logger func(message string, args ...any)) func(*Options) {
 		opts.Logger = logger
 	}
 }
+
+func WithStats(stats *stat.Store) func(*Options) {
+	return func(opts *Options) {
+		opts.Stats = stats
+	}
+}

ssh/request_handler.go

@@ -80,12 +80,19 @@ func (s *Server) handleRequest(ctx ssh.Context, srv *ssh.Server, req *gossh.Requ
 
 		addr := s.getSocketPath(sessionID)
 
+		if err := s.ensureFileDir(addr); err != nil {
+			s.log("[ERROR] %+v", errors.WithStack(err))
+			return false, []byte("internal server error")
+		}
+
 		ln, err := net.Listen("unix", addr)
 		if err != nil {
 			s.log("[ERROR] %+v", errors.WithStack(err))
 			return false, []byte{}
 		}
 
+		s.opts.Stats.Add(StatTotalOpenedTunnels, 1, 0)
+
 		destPort := 1
 
 		s.requestHandlerLock.Lock()
@@ -200,6 +207,15 @@ func (s *Server) getSocketPath(sessionID SessionID) string {
 	return filepath.Join(s.opts.SockDir, fmt.Sprintf("%s.sock", sessionID))
 }
 
+func (s *Server) ensureFileDir(file string) error {
+	dir := filepath.Dir(file)
+	if err := os.MkdirAll(dir, os.FileMode(0750)); err != nil {
+		return errors.WithStack(err)
+	}
+
+	return nil
+}
+
 func generateToken(length int) (string, error) {
 	chars := []rune(
 		"ABCDEFGHIJKLMNOPQRSTUVWXYZ" +

ssh/stats.go

@@ -0,0 +1,43 @@
+package ssh
+
+import (
+	"io"
+
+	"forge.cadoles.com/wpetit/rebound/stat"
+)
+
+const (
+	StatTotalOpenedTunnels = "total_opened_tunnels"
+	StatTotalTxBytes       = "total_tx_bytes"
+	StatTotalRxBytes       = "total_rx_bytes"
+)
+
+type instrumentedWriter struct {
+	name     string
+	stats    *stat.Store
+	internal io.Writer
+}
+
+// Write implements io.Writer.
+func (w *instrumentedWriter) Write(p []byte) (n int, err error) {
+	n, err = w.internal.Write(p)
+	w.stats.Add(w.name, float64(n), 0)
+	return n, err
+}
+
+var _ io.Writer = &instrumentedWriter{}
+
+type instrumentedReader struct {
+	name     string
+	stats    *stat.Store
+	internal io.Reader
+}
+
+// Read implements io.Reader.
+func (w *instrumentedReader) Read(p []byte) (n int, err error) {
+	n, err = w.internal.Read(p)
+	w.stats.Add(w.name, float64(n), 0)
+	return n, err
+}
+
+var _ io.Reader = &instrumentedReader{}

stat/store.go

@@ -0,0 +1,154 @@
+package stat
+
+import (
+	"encoding/json"
+	"os"
+	"path/filepath"
+	"sync"
+
+	"log/slog"
+
+	"github.com/pkg/errors"
+)
+
+type Store struct {
+	data         sync.Map
+	loadSaveLock sync.Mutex
+}
+
+func (s *Store) Load(path string) error {
+	s.loadSaveLock.Lock()
+	defer s.loadSaveLock.Unlock()
+
+	file, err := os.OpenFile(path, os.O_RDONLY, os.ModePerm)
+	if err != nil {
+		return errors.WithStack(err)
+	}
+
+	decoder := json.NewDecoder(file)
+	data := map[string]any{}
+
+	if err := decoder.Decode(&data); err != nil {
+		return errors.WithStack(err)
+	}
+
+	s.data.Range(func(key, value any) bool {
+		s.data.Delete(key)
+		return true
+	})
+
+	for k, v := range data {
+		s.data.Store(k, v)
+	}
+
+	return nil
+}
+
+func (s *Store) Save(path string) error {
+	s.loadSaveLock.Lock()
+	defer s.loadSaveLock.Unlock()
+
+	data, err := s.Snapshot()
+	if err != nil {
+		return errors.WithStack(err)
+	}
+
+	dir := filepath.Dir(path)
+	filename := filepath.Base(path)
+
+	temp, err := os.CreateTemp(dir, filename+".new*")
+	if err != nil {
+		return errors.WithStack(err)
+	}
+
+	defer func() {
+		if err := os.Remove(temp.Name()); err != nil && !errors.Is(err, os.ErrNotExist) {
+			slog.Error("could not remove temporary file",
+				slog.String("file", temp.Name()),
+				slog.Any("error", errors.WithStack(err)),
+			)
+		}
+	}()
+
+	encoder := json.NewEncoder(temp)
+	if err := encoder.Encode(data); err != nil {
+		return errors.WithStack(err)
+	}
+
+	if err := os.Rename(temp.Name(), path); err != nil {
+		return errors.WithStack(err)
+	}
+
+	return nil
+}
+
+func (s *Store) Snapshot() (map[string]float64, error) {
+	data := map[string]float64{}
+
+	var err error
+	s.data.Range(func(rawKey, rawValue any) bool {
+		key, ok := rawKey.(string)
+		if !ok {
+			err = errors.Errorf("unexpected stat key of '%v'", rawKey)
+
+			return false
+		}
+
+		value, ok := rawValue.(float64)
+		if !ok {
+			err = errors.Errorf("unexpected stat value of '%v'", rawValue)
+
+			return false
+		}
+
+		data[key] = value
+
+		return true
+	})
+	if err != nil {
+		return nil, errors.WithStack(err)
+	}
+
+	return data, nil
+}
+
+func (s *Store) Add(name string, added float64, defaultValue float64) float64 {
+	for {
+		value := s.Get(name, defaultValue)
+		if value == defaultValue {
+			s.data.Store(name, defaultValue)
+		}
+
+		sum := value + added
+		if s.data.CompareAndSwap(name, value, value+added) {
+			return sum
+		}
+	}
+}
+
+func (s *Store) Set(name string, value float64) float64 {
+	s.data.Store(name, value)
+
+	return value
+}
+
+func (s *Store) Get(name string, defaultValue float64) float64 {
+	rawValue, ok := s.data.Load(name)
+	if !ok {
+		return defaultValue
+	}
+
+	value, ok := rawValue.(float64)
+	if !ok {
+		return defaultValue
+	}
+
+	return value
+}
+
+func NewStore() *Store {
+	return &Store{
+		data:         sync.Map{},
+		loadSaveLock: sync.Mutex{},
+	}
+}