diff --git a/debian/db/checksums.db b/debian/db/checksums.db index 317d243..c9f3708 100644 Binary files a/debian/db/checksums.db and b/debian/db/checksums.db differ diff --git a/debian/db/packages.db b/debian/db/packages.db index fcee57d..4086a1e 100644 Binary files a/debian/db/packages.db and b/debian/db/packages.db differ diff --git a/debian/db/references.db b/debian/db/references.db index 6f5e442..8edcfc5 100644 Binary files a/debian/db/references.db and b/debian/db/references.db differ diff --git a/debian/db/release.caches.db b/debian/db/release.caches.db index a11f8d4..3eef664 100644 Binary files a/debian/db/release.caches.db and b/debian/db/release.caches.db differ diff --git a/debian/dists/jammy/InRelease b/debian/dists/jammy/InRelease new file mode 100644 index 0000000..c8c7368 --- /dev/null +++ b/debian/dists/jammy/InRelease @@ -0,0 +1,36 @@ +-----BEGIN PGP SIGNED MESSAGE----- +Hash: SHA512 + +Origin: Unofficial Innernet Debian repository +Label: innernet-debian +Codename: jammy +Date: Fri, 12 May 2023 14:35:13 UTC +Architectures: amd64 +Components: contrib +Description: APT repository for https://github.com/tonarino/innernet/. +MD5Sum: + a791101bd1252e7eed9e2639c95ca240 11445 contrib/binary-amd64/Packages + bfc99a59ee0ab62e4810978c80eb2832 4577 contrib/binary-amd64/Packages.gz + 77dc2b012f45038d5be68f81d464ee44 179 contrib/binary-amd64/Release +SHA1: + 8d4f806ac1a50d95fcf98a2228266a2dcb21a0fa 11445 contrib/binary-amd64/Packages + b6182f34ae185fea6e544a6b671aa149d8b143c0 4577 contrib/binary-amd64/Packages.gz + a4f6bbfd6fe4ab5a01909278c4e13b05d6b06f13 179 contrib/binary-amd64/Release +SHA256: + fea11b784a297ed5fbaaf79476a3c27609b15c6a077401b7f388a1d232d42bcd 11445 contrib/binary-amd64/Packages + 087f4de1d847f4b657e31baaf91cca2c8e5af7d2e828aa20053386ef5397ef36 4577 contrib/binary-amd64/Packages.gz + 67b3f0e511499d8b794eaf1524cea47d2263a1e8e43445c60f311dbef9a50e9c 179 contrib/binary-amd64/Release +-----BEGIN PGP SIGNATURE----- + +iQGzBAEBCgAdFiEEbYSVpa4ZFZQzkqZZZYKNdDzui2kFAmReTqMACgkQZYKNdDzu +i2kLegv8DtT754dLBvm8you3Yq04NYeLX8UrKBarJ+HhjMqWnjlaOPKkctkzNnSZ +cofG3bDNC6UJYwQg2lvU9FU9whyC3UoCj7x5qVM4Iq2+/0/xDrEwMiNxTo6epsCB +Fv1ri71GnDcS2Ktw2sOq5cJaL6l5ELvLeBmGa2hx+4VPkSD4FseeyNP+RRKGhzEU +Ot2ubP6c0ZigdT+JJ2afObYmpljO8vrULASjI98uUt3OH3Ns7R9jYLAqFf7i6KAL +SZt/KL1iVji4CruYBhZHnK6KJN7F+3WHt50rkVKFAUBZfmYS9N/YR9x/F6yyCFMp +nO5QpdA1M6egXXgof6qhOukZJzljI6OLwZ7zqBydjQLS0rf+w9DmGfa8lw6bpfuS +nZicjNQo3Sl2n9Oaxn+LNBpbRgbR9U0k8QayESNTPtnGP+plqyVO8MhqYKKc/u9Q +1ZCV3dDpZIkye7EcyoQdwtnM/aLoND+j1tejU1yJEvCg8P2X/wKH7QShMW2zM90c +V7g3lfDL +=TOhC +-----END PGP SIGNATURE----- diff --git a/debian/dists/jammy/Release b/debian/dists/jammy/Release new file mode 100644 index 0000000..150b4fa --- /dev/null +++ b/debian/dists/jammy/Release @@ -0,0 +1,19 @@ +Origin: Unofficial Innernet Debian repository +Label: innernet-debian +Codename: jammy +Date: Fri, 12 May 2023 14:35:13 UTC +Architectures: amd64 +Components: contrib +Description: APT repository for https://github.com/tonarino/innernet/. +MD5Sum: + a791101bd1252e7eed9e2639c95ca240 11445 contrib/binary-amd64/Packages + bfc99a59ee0ab62e4810978c80eb2832 4577 contrib/binary-amd64/Packages.gz + 77dc2b012f45038d5be68f81d464ee44 179 contrib/binary-amd64/Release +SHA1: + 8d4f806ac1a50d95fcf98a2228266a2dcb21a0fa 11445 contrib/binary-amd64/Packages + b6182f34ae185fea6e544a6b671aa149d8b143c0 4577 contrib/binary-amd64/Packages.gz + a4f6bbfd6fe4ab5a01909278c4e13b05d6b06f13 179 contrib/binary-amd64/Release +SHA256: + fea11b784a297ed5fbaaf79476a3c27609b15c6a077401b7f388a1d232d42bcd 11445 contrib/binary-amd64/Packages + 087f4de1d847f4b657e31baaf91cca2c8e5af7d2e828aa20053386ef5397ef36 4577 contrib/binary-amd64/Packages.gz + 67b3f0e511499d8b794eaf1524cea47d2263a1e8e43445c60f311dbef9a50e9c 179 contrib/binary-amd64/Release diff --git a/debian/dists/jammy/Release.gpg b/debian/dists/jammy/Release.gpg new file mode 100644 index 0000000..194de7a --- /dev/null +++ b/debian/dists/jammy/Release.gpg @@ -0,0 +1,14 @@ +-----BEGIN PGP SIGNATURE----- + +iQGzBAABCgAdFiEEbYSVpa4ZFZQzkqZZZYKNdDzui2kFAmReTqEACgkQZYKNdDzu +i2nbdQv/c0qJ/kjsnncCYKJBxtgaBEfbA5tTDqpfEsCCeJkcYpqJt1gEgdYlosEE +rOYHuYanWhYzyBGkm2PfypeHeW0+bTtfCHGos1TFnRsX1sE6qhgXkHz6zx20L8+V +OBBAABy9fIbXyeFp2L0npNm2rf2UtX1GE9MaLyMG+H7CwLTfxxV87QCr6KI/67QZ +uGR38JTVOnkZFTBW9l6V0iwSI6pg/YODaAWzqH5xnozy/soZ1WOb7BvMJsIVlEAS +xu3PPhUqeeI1STD+dRLq+bO4F+PDSXcXih6edgZ0lI6EdHGyn7L+sGsnEgOFcKoL +f47QmCKyZ1pVp6sWu+OY9PVXTG1YnarzHOnjpUB23pBSXsNbOhSkqMcoDfwTb49d +8yYSe56iIpZv/bYdQxqOa59Qhv1Z+dNZoE66x/LaQSpbvxyAqFLMFIC2qf3RlQfH +b9W2uHKjj2diBlej9dPvDwMWTNesBQlu+JiU3cLhr0jZWg9M0EG3swfV/hN7qM4B +0miOvwNE +=6ig8 +-----END PGP SIGNATURE----- diff --git a/debian/dists/jammy/contrib/binary-amd64/Packages b/debian/dists/jammy/contrib/binary-amd64/Packages new file mode 100644 index 0000000..de1acf5 --- /dev/null +++ b/debian/dists/jammy/contrib/binary-amd64/Packages @@ -0,0 +1,369 @@ +Package: innernet +Version: 1.5.5-0ubuntu0~jammy +Architecture: amd64 +Vcs-Browser: https://github.com/tonarino/innernet +Vcs-Git: https://github.com/tonarino/innernet +Homepage: https://github.com/tonarino/innernet +Maintainer: tonari +Installed-Size: 5759 +Depends: libgcc1, systemd, libc6 +Recommends: wireguard +Priority: optional +Section: net +Filename: pool/contrib/i/innernet/innernet_1.5.5-0ubuntu0~jammy_amd64.deb +Size: 939712 +SHA256: 2b535a9dc4a91eb3123bfcda3287ef5c143b3e9e0239b2f161eac417548d061f +SHA1: 5df465a599f2a8616cfaaf36c545fe22531bd10e +MD5sum: 800c58e71d219e218d9dba60e8d06713 +Description: A client to manage innernet network interfaces. + innernet client binary for fetching peer information and conducting admin tasks + such as adding a new peer. + +Package: innernet-server +Version: 1.5.5-0ubuntu0~jammy +Architecture: amd64 +Maintainer: tonari +Installed-Size: 3937 +Depends: systemd, libgcc1, libsqlite3-0, libc6, zlib1g +Recommends: wireguard +Source: innernet +Priority: optional +Section: net +Filename: pool/contrib/i/innernet-server/innernet-server_1.5.5-0ubuntu0~jammy_amd64.deb +Size: 1419844 +SHA256: 40a5f6641c298a0adc53a5bc246df2c0266a89f16619f9fd6c5fbf63b5ec4564 +SHA1: 7124285d17106e4e44b39bd77bf40b2fbc5c7d38 +MD5sum: 1fa06dd1e6714ccb70c050057e34d317 +Description: A server to coordinate innernet networks. + # innernet + . + A private network system that uses [WireGuard](https://wireguard.com) under the + hood. See the [announcement blog + post](https://blog.tonari.no/introducing-innernet) for a longer-winded + explanation. + . + + . + `innernet` is similar in its goals to Slack's + [nebula](https://github.com/slackhq/nebula) or + [Tailscale](https://tailscale.com/), but takes a bit of a different approach. + It aims to take advantage of existing networking concepts like CIDRs and the + security properties of WireGuard to turn your computer's basic IP networking + into more powerful ACL primitives. + . + `innernet` is not an official WireGuard project, and WireGuard is a registered + trademark of Jason A. Donenfeld. + . + This has not received an independent security audit, and should be considered + experimental software at this early point in its lifetime. + . + ## Usage + . + ### Server Creation + . + Every `innernet` network needs a coordination server to manage peers and + provide endpoint information so peers can directly connect to each other. + Create a new one with + . + ```sh + sudo innernet-server new + ``` + . + The init wizard will ask you questions about your network and give you some + reasonable defaults. It's good to familiarize yourself with [network + CIDRs](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) as a lot + of innernet's access control is based upon them. As an example, let's say the + root CIDR for this network is `10.60.0.0/16`. Server initialization creates a + special "infra" CIDR which contains the `innernet` server itself and is + reachable from all CIDRs on the network. + . + Next we'll also create a `humans` CIDR where we can start adding some peers. + . + ```sh + sudo innernet-server add-cidr + ``` + . + For the parent CIDR, you can simply choose your network's root CIDR. The name + will be `humans`, and the CIDR will be `10.60.64.0/24` (not a great example + unless you only want to support 256 humans, but it works for now...). + . + By default, peers which exist in this new CIDR will only be able to contact + peers in the same CIDR, and the special "infra" CIDR which was created when the + server was initialized. + . + A typical workflow for creating a new network is to create an admin peer from + the `innernet-server` CLI, and then continue using that admin peer via the + `innernet` client CLI to add any further peers or network CIDRs. + . + ```sh + sudo innernet-server add-peer + ``` + . + Select the `humans` CIDR, and the CLI will automatically suggest the next + available IP address. Any name is fine, just answer "yes" when asked if you + would like to make the peer an admin. The process of adding a peer results in + an invitation file. This file contains just enough information for the new peer + to contact the `innernet` server and redeem its invitation. It should be + transferred securely to the new peer, and it can only be used once to + initialize the peer. + . + You can run the server with `innernet-server serve `, or if you're + on Linux and want to run it via `systemctl`, run `systemctl enable --now + innernet-server@`. If you're on a home network, don't forget to + configure port forwarding to the `Listen Port` you specified when creating the + `innernet` server. + . + ### Peer Initialization + . + Let's assume the invitation file generated in the steps above have been + transferred to the machine a network admin will be using. + . + You can initialize the client with + . + ```sh + sudo innernet install /path/to/invitation.toml + ``` + . + You can customize the network name if you want to, or leave it at the default. + `innernet` will then connect to the `innernet` server via WireGuard, generate a + new key pair, and register that pair with the server. The private key in the + invitation file can no longer be used. + . + If everything was successful, the new peer is on the network. You can run + things like + . + ```sh + sudo innernet list + ``` + . + or + . + ```sh + sudo innernet list --tree + ``` + . + to view the current network and all CIDRs visible to this peer. + . + Since we created an admin peer, we can also add new peers and CIDRs from this + peer via `innernet` instead of having to always run commands on the server. + . + ### Adding Associations between CIDRs + . + In order for peers from one CIDR to be able to contact peers in another CIDR, + those two CIDRs must be "associated" with each other. + . + With the admin peer we created above, let's add a new CIDR for some theoretical + CI servers we have. + . + ```sh + sudo innernet add-cidr + ``` + . + The name is `ci-servers` and the CIDR is `10.60.64.0/24`, but for this example + it can be anything. + . + For now, we want peers in the `humans` CIDR to be able to access peers in the + `ci-servers` CIDR. + . + ```sh + sudo innernet add-association + ``` + . + The CLI will ask you to select the two CIDRs you want to associate. That's all + it takes to allow peers in two different CIDRs to communicate! + . + You can verify the association with + . + ```sh + sudo innernet list-associations + ``` + . + and associations can be deleted with + . + ```sh + sudo innernet delete-associations + ``` + . + ### Enabling/Disabling Peers + . + For security reasons, IP addresses cannot be re-used by new peers, and + therefore peers cannot be deleted. However, they can be disabled. Disabled + peers will not show up in the list of peers when fetching the config for an + interface. + . + Disable a peer with + . + ```su + sudo innernet disable-peer + ``` + . + Or re-enable a peer with + . + ```su + sudo innernet enable-peer + ``` + . + ### Specifying a Manual Endpoint + . + The `innernet` server will try to use the internet endpoint it sees from a peer + so other peers can connect to that peer as well. This doesn't always work and + you may want to set an endpoint explicitly. To set an endpoint, use + . + ```sh + sudo innernet override-endpoint + ``` + . + You can go back to automatic endpoint discovery with + . + ```sh + sudo innernet override-endpoint -u + ``` + . + ### Setting the Local WireGuard Listen Port + . + If you want to change the port which WireGuard listens on, use + . + ```sh + sudo innernet set-listen-port + ``` + . + or unset the port and use a randomized port with + . + ```sh + sudo innernet set-listen-port -u + ``` + . + ### Remove Network + . + To permanently uninstall a created network, use + . + ```sh + sudo innernet-server uninstall + ``` + . + Use with care! + . + ## Security recommendations + . + If you're running a service on innernet, there are some important security + considerations. + . + ### Enable strict Reverse Path Filtering ([RFC + 3704](https://tools.ietf.org/html/rfc3704)) + . + Strict RPF prevents packets from _other_ interfaces from having internal source + IP addresses. This is _not_ the default on Linux, even though it is the right + choice for 99.99% of situations. You can enable it by adding the following to a + `/etc/sysctl.d/60-network-security.conf`: + . + ``` + net.ipv4.conf.all.rp_filter=1 + net.ipv4.conf.default.rp_filter=1 + ``` + . + ### Bind to the WireGuard device + . + If possible, to _ensure_ that packets are only ever transmitted over the + WireGuard interface, it's recommended that you use `SO_BINDTODEVICE` on Linux + or `IP_BOUND_IF` on macOS/BSDs. If you have strict reverse path filtering, + though, this is less of a concern. + . + ### IP addresses alone often aren't enough authentication + . + Even following all the above precautions, rogue applications on a peer's + machines could be able to make requests on their behalf unless you add extra + layers of authentication to mitigate this CSRF-type vector. + . + It's recommended that you carefully consider this possibility before deciding + that the source IP is sufficient for your authentication needs on a service. + . + ## Installation + . + innernet has only officially been tested on Linux and MacOS, but we hope to + support as many platforms as is feasible! + . + ### Runtime Dependencies + . + It's assumed that WireGuard is installed on your system, either via the kernel + module in Linux 5.6 and later, or via the + [`wireguard-go`](https://git.zx2c4.com/wireguard-go/about/) userspace + implementation. + . + [WireGuard Installation Instructions](https://www.wireguard.com/install/) + . + ### Arch Linux + . + ```sh + pacman -S innernet + ``` + . + ### Ubuntu + . + Fetch the appropriate `.deb` packages from + https://github.com/tonarino/innernet/releases and install with + . + ```sh + sudo apt install ./innernet*.deb + ``` + . + ### macOS + . + ```sh + brew install tonarino/innernet/innernet + ``` + . + ### Cargo + . + ```sh + # to install innernet: + cargo install --git https://github.com/tonarino/innernet --tag v1.5.5 client + . + # to install innernet-server: + cargo install --git https://github.com/tonarino/innernet --tag v1.5.5 server + ``` + . + Note that you'll be responsible for updating manually. + . + ## Development + . + ### `innernet-server` Build dependencies + . + - `rustc` / `cargo` (version 1.50.0 or higher) + - `libclang` (see more info at + [https://crates.io/crates/clang-sys](https://crates.io/crates/clang-sys)) + - `libsqlite3` + . + Build: + . + ```sh + cargo build --release --bin innernet-server + ``` + . + The resulting binary will be located at `./target/release/innernet-server` + . + ### `innernet` Client CLI Build dependencies + . + - `rustc` / `cargo` (version 1.50.0 or higher) + - `libclang` (see more info at + [https://crates.io/crates/clang-sys](https://crates.io/crates/clang-sys)) + . + Build: + . + ```sh + cargo build --release --bin innernet + ``` + . + The resulting binary will be located at `./target/release/innernet` + . + ### Releases + . + 1. Run `cargo release [--dry-run] [minor|major|patch|...]` to automatically + bump the crates appropriately. + 2. Create a new git tag (ex. `v0.6.0`). + 3. Push (with tags) to the repo. + . + innernet uses GitHub Actions to automatically produce a debian package for the + [releases page](https://github.com/tonarino/innernet/releases). + diff --git a/debian/dists/jammy/contrib/binary-amd64/Packages.gz b/debian/dists/jammy/contrib/binary-amd64/Packages.gz new file mode 100644 index 0000000..bc6ffd9 Binary files /dev/null and b/debian/dists/jammy/contrib/binary-amd64/Packages.gz differ diff --git a/debian/dists/jammy/contrib/binary-amd64/Release b/debian/dists/jammy/contrib/binary-amd64/Release new file mode 100644 index 0000000..e3ef659 --- /dev/null +++ b/debian/dists/jammy/contrib/binary-amd64/Release @@ -0,0 +1,5 @@ +Component: contrib +Origin: Unofficial Innernet Debian repository +Label: innernet-debian +Architecture: amd64 +Description: APT repository for https://github.com/tonarino/innernet/. diff --git a/debian/pool/contrib/i/innernet-server/innernet-server_1.5.5-0ubuntu0~jammy_amd64.deb b/debian/pool/contrib/i/innernet-server/innernet-server_1.5.5-0ubuntu0~jammy_amd64.deb new file mode 100644 index 0000000..dcf8526 Binary files /dev/null and b/debian/pool/contrib/i/innernet-server/innernet-server_1.5.5-0ubuntu0~jammy_amd64.deb differ diff --git a/debian/pool/contrib/i/innernet/innernet_1.5.5-0ubuntu0~jammy_amd64.deb b/debian/pool/contrib/i/innernet/innernet_1.5.5-0ubuntu0~jammy_amd64.deb new file mode 100644 index 0000000..0be015d Binary files /dev/null and b/debian/pool/contrib/i/innernet/innernet_1.5.5-0ubuntu0~jammy_amd64.deb differ