Add connlib basic implementation

.github/workflows/build.yml

@@ -34,27 +34,21 @@ jobs:
           - macos-12
           - windows-2019
           - windows-2022
+        # FIXME: There's this weird cargo thing where it stops finding the webrtc's related crates
+        # probably has to do with the cache + some cargo bug. 
+        exclude:
+          - rust: nightly
+            runs-on: ubuntu-20.04
     runs-on: ${{ matrix.runs-on }}
     steps:
       - name: Checkout
         uses: actions/checkout@v3
-      - uses: actions/cache@v3
-        with:
-          path: |
-            ~/.cargo/.crates.toml
-            ~/.cargo/.crates2.json
-            ~/.cargo/.package-cache
-            ~/.cargo/bin/
-            ~/.cargo/registry/index/
-            ~/.cargo/registry/cache/
-            ~/.cargo/git/db/
-            target/
-          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
       - name: Update toolchain
         run: rustup update --no-self-update ${{ matrix.rust }} && rustup default ${{ matrix.rust }} && rustup component add clippy
+      - uses: Swatinem/rust-cache@v2
       - name: Run cargo static analysis checks
         run: |
-          cargo check
+          cargo check --workspace
           cargo clippy -- -D clippy::all
           cargo test
 
@@ -70,18 +64,7 @@ jobs:
         rust: [stable]
     steps:
       - uses: actions/checkout@v3
-      - uses: actions/cache@v3
-        with:
-          path: |
-            ~/.cargo/.crates.toml
-            ~/.cargo/.crates2.json
-            ~/.cargo/.package-cache
-            ~/.cargo/bin/
-            ~/.cargo/registry/index/
-            ~/.cargo/registry/cache/
-            ~/.cargo/git/db/
-            target/
-          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+      - uses: Swatinem/rust-cache@v2
       - name: Setup toolchain
         run: |
           rustup update --no-self-update ${{ matrix.rust }} \
@@ -92,8 +75,8 @@ jobs:
       - uses: actions/cache@v3
         with:
           path: |
-            ~/.gradle/caches
-            ~/.gradle/wrapper
+            ~/clients/android/.gradle/caches
+            ~/clients/android/.gradle/wrapper
           key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
           restore-keys: |
             ${{ runner.os }}-gradle-
@@ -107,10 +90,10 @@ jobs:
         uses: gradle/gradle-build-action@v2
         with:
           arguments: build assembleRelease
-          build-root-directory: android
+          build-root-directory: clients/android
       - name: Move artifact
         run: |
-          mv ./android/lib/build/outputs/aar/lib-release.aar ./connlib-${{ needs.draft-release.outputs.tag_name }}.aar
+          mv ./clients/android/lib/build/outputs/aar/lib-release.aar ./connlib-${{ needs.draft-release.outputs.tag_name }}.aar
       - uses: actions/upload-artifact@v3
         with:
           name: connlib-android
@@ -129,18 +112,7 @@ jobs:
         rust: [stable]
     steps:
       - uses: actions/checkout@v3
-      - uses: actions/cache@v3
-        with:
-          path: |
-            ~/.cargo/.crates.toml
-            ~/.cargo/.crates2.json
-            ~/.cargo/.package-cache
-            ~/.cargo/bin/
-            ~/.cargo/registry/index/
-            ~/.cargo/registry/cache/
-            ~/.cargo/git/db/
-            target/
-          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+      - uses: Swatinem/rust-cache@v2
       - name: Setup toolchain
         run: |
           rustup update --no-self-update ${{ matrix.rust }} \
@@ -160,8 +132,8 @@ jobs:
         env:
           CONFIGURATION: Release
           PROJECT_DIR: .
+        working-directory: ./clients/apple
         run: |
-          cd apple
           # build-xcframework.sh calls build-rust.sh indirectly via `xcodebuild`, but it pollutes the environment
           # to the point that it causes the `ring` build to fail for the aarch64-apple-darwin target. So, explicitly
           # build first. See https://github.com/briansmith/ring/issues/1332

.gitignore

@@ -1,13 +1,12 @@
 ### Rust ###
-/target
+target/
 # Libraries shouldn't lock their dependencies
-/Cargo.lock
+Cargo.lock
 
 ### Android ###
 # Gradle files
 .gradle/
 build/
-android/target/
 
 # Local configuration file (sdk path, etc)
 local.properties
@@ -101,11 +100,10 @@ proguard/
 # Log Files
 
 # Android Studio
-/*/build/
+build/
 /*/local.properties
-/*/out
-/*/*/build
-/*/*/production
+out/
+production/
 .navigation/
 *.ipr
 *~
@@ -126,7 +124,6 @@ obj/
 
 # IntelliJ IDEA
 *.iws
-/out/
 
 # User-specific configurations
 .idea/caches/
@@ -167,14 +164,13 @@ fabric.properties
 
 ### AndroidStudio Patch ###
 
-!/gradle/wrapper/gradle-wrapper.jar
+!clients/android/gradle/wrapper/gradle-wrapper.jar
 
 ### Apple ###
 .DS_Store
 .build/
-build/
 DerivedData/
 xcuserdata/
-**/*.xcuserstate
+*.xcuserstate
 
 Firezone/Developer.xcconfig

Cargo.toml

@@ -1,24 +1,12 @@
-[package]
-name = "firezone-connlib"
-version = "0.1.6"
-edition = "2021"
-
-[dependencies]
-# Apple tunnel dependencies
-[target.'cfg(any(target_os = "macos", target_os = "ios"))'.dependencies]
-boringtun = { git = "https://github.com/cloudflare/boringtun", rev = "878385f", features = ["device"] }
-
-# Linux tunnel dependencies
-[target.'cfg(target_os = "linux")'.dependencies]
-boringtun = { git = "https://github.com/cloudflare/boringtun", rev = "878385f", features = ["device"] }
-
-# Android tunnel dependencies
-[target.'cfg(target_os = "android")'.dependencies]
-boringtun = { git = "https://github.com/cloudflare/boringtun", rev = "878385f", features = ["jni-bindings"] }
-android_logger = "0.13"
-log = "0.4.14"
-
-# Windows tunnel dependencies
-[target.'cfg(target_os = "windows")'.dependencies]
-boringtun = { git = "https://github.com/cloudflare/boringtun", rev = "878385f" }
-wintun = "0.2.1"
+[workspace]
+members = [
+  "clients/android",
+  "clients/apple",
+  "clients/headless",
+  "libs/tunnel",
+  "libs/client",
+  "libs/gateway",
+  "libs/common",
+  "gateway",
+  "macros",
+]

NOTICE.txt

@@ -0,0 +1,20 @@
+NOTICES AND INFORMATION
+Do Not Translate or Localize
+
+This software incorporates material from third parties.
+
+Please refer to this document for the license terms of the components that this product depends and use.
+
+===
+
+This product depends on and uses Boringtun source code:
+
+Copyright (c) 2019 Cloudflare, Inc. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+    1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+    2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+    3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.