CTAP library move (#602)

* Moves all CTAP logic into its own library

* workflows fix test

* more coveralls workflow tests

Author: kaczmarczyck

.github/workflows/cargo_fmt.yml

@@ -22,6 +22,10 @@ jobs:
           submodules: "true"
       - name: Install Rust toolchain
         run: rustup show
+      - name: Install nightly toolchain
+        run: rustup toolchain install nightly
+      - name: Install nightly cargo fmt
+        run: rustup component add rustfmt --toolchain nightly
       - uses: actions/setup-python@v1
         with:
           python-version: 3.7
@@ -34,46 +38,59 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: fmt
-          args: --all -- --check
+          args: -- --check
 
-      - name: Cargo format fuzz/
+      - name: Cargo format libraries/opensk
         uses: actions-rs/cargo@v1
         with:
+          toolchain: nightly
           command: fmt
-          args: --manifest-path fuzz/Cargo.toml --all -- --check
+          args: --manifest-path libraries/opensk/Cargo.toml -- --check
+
+      - name: Cargo format libraries/opensk/fuzz
+        uses: actions-rs/cargo@v1
+        with:
+          toolchain: nightly
+          command: fmt
+          args: --manifest-path libraries/opensk/fuzz/Cargo.toml -- --check
 
       - name: Cargo format libraries/cbor
         uses: actions-rs/cargo@v1
         with:
+          toolchain: nightly
           command: fmt
-          args: --manifest-path libraries/cbor/Cargo.toml --all -- --check
+          args: --manifest-path libraries/cbor/Cargo.toml -- --check
 
       - name: Cargo format libraries/cbor/fuzz
         uses: actions-rs/cargo@v1
         with:
+          toolchain: nightly
           command: fmt
-          args: --manifest-path libraries/cbor/fuzz/Cargo.toml --all -- --check
+          args: --manifest-path libraries/cbor/fuzz/Cargo.toml -- --check
 
       - name: Cargo format libraries/crypto
         uses: actions-rs/cargo@v1
         with:
+          toolchain: nightly
           command: fmt
-          args: --manifest-path libraries/crypto/Cargo.toml --all -- --check
+          args: --manifest-path libraries/crypto/Cargo.toml -- --check
 
       - name: Cargo format libraries/persistent_store
         uses: actions-rs/cargo@v1
         with:
+          toolchain: nightly
           command: fmt
-          args: --manifest-path libraries/persistent_store/Cargo.toml --all -- --check
+          args: --manifest-path libraries/persistent_store/Cargo.toml -- --check
 
       - name: Cargo format tools/heapviz
         uses: actions-rs/cargo@v1
         with:
+          toolchain: nightly
           command: fmt
-          args: --manifest-path tools/heapviz/Cargo.toml --all -- --check
+          args: --manifest-path tools/heapviz/Cargo.toml -- --check
 
       - name: Cargo format bootloader
         uses: actions-rs/cargo@v1
         with:
           command: fmt
-          args: --manifest-path bootloader/Cargo.toml --all -- --check
+          args: --manifest-path bootloader/Cargo.toml -- --check

.github/workflows/cargo_fuzz.yml

@@ -11,6 +11,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
         with:
+          toolchain: nightly
           submodules: "true"
       - name: Install Rust toolchain
         run: rustup show
@@ -25,8 +26,8 @@ jobs:
         run: ./fuzzing_setup.sh
 
       - name: Cargo fuzz build
-        run: cargo fuzz build
+        run: cd libraries/opensk && cargo +nightly fuzz build
       - name: Cargo fuzz build (libraries/cbor)
-        run: cd libraries/cbor && cargo fuzz build && cd ../..
+        run: cd libraries/cbor && cargo +nightly fuzz build
       - name: Cargo fuzz build (libraries/persistent_store)
-        run: cd libraries/persistent_store && cargo fuzz build && cd ../..
+        run: cd libraries/persistent_store && cargo +nightly fuzz build

.github/workflows/coveralls.yml

@@ -3,7 +3,6 @@ name: OpenSK code coverage report
 on:
   push:
     paths:
-      - 'src/**/*.rs'
       - 'libraries/**/*.rs'
   pull_request:
     types: [opened, synchronize, reopened]
@@ -27,22 +26,24 @@ jobs:
       - name: Set up OpenSK
         run: ./setup.sh
       - name: Install llvm tools
-        run: rustup component add llvm-tools-preview
+        run: rustup +nightly component add llvm-tools-preview
 
       - name: Install grcov
         run: if [[ ! -e ~/.cargo/bin/grcov ]]; then cargo +stable install grcov; fi
       - uses: actions-rs/cargo@v1
         with:
+          toolchain: nightly
           command: test
-          args: --features "with_ctap1,vendor_hid,ed25519,with_nfc,std" --no-fail-fast
+          args: --manifest-path libraries/opensk/Cargo.toml --features "std,with_ctap1,vendor_hid,ed25519" --no-fail-fast
         env:
-          RUSTFLAGS: "-Zinstrument-coverage"
+          RUSTFLAGS: "-Cinstrument-coverage"
           LLVM_PROFILE_FILE: "opensk-%p-%m.profraw"
       - name: Run grcov
-        run: grcov . --binary-path ./target/debug/ --source-dir . --output-type lcov --ignore-not-existing ---output-path ./lcov.info --ignore "/*" --ignore "examples/*" --ignore "third_party/*"
+        run: RUSTUP_TOOLCHAIN=nightly grcov . --binary-path ./libraries/opensk/target/debug/ --source-dir libraries/opensk/ --output-type lcov --ignore-not-existing ---output-path ./lcov.info --ignore "/*" --ignore "examples/*" --ignore "third_party/*"
       - uses: coverallsapp/[email protected]
         name: upload report to coveralls
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           path-to-lcov: "./lcov.info"
+          base-path: "libraries/opensk"
 

.github/workflows/crypto_test.yml

@@ -31,11 +31,13 @@ jobs:
       - name: Unit testing of crypto library (release mode)
         uses: actions-rs/cargo@v1
         with:
+          toolchain: nightly
           command: test
           args: --manifest-path libraries/crypto/Cargo.toml --release --features std
 
       - name: Unit testing of crypto library (debug mode)
         uses: actions-rs/cargo@v1
         with:
+          toolchain: nightly
           command: test
           args: --manifest-path libraries/crypto/Cargo.toml --features std

.github/workflows/opensk_test.yml

@@ -29,24 +29,28 @@ jobs:
       - name: Unit testing of CTAP2 (release mode)
         uses: actions-rs/cargo@v1
         with:
+          toolchain: nightly
           command: test
-          args: --release --features std
+          args: --manifest-path libraries/opensk/Cargo.toml --release --features std
 
       - name: Unit testing of CTAP2 (debug mode)
         uses: actions-rs/cargo@v1
         with:
+          toolchain: nightly
           command: test
-          args: --features std
+          args: --manifest-path libraries/opensk/Cargo.toml --features std
 
-      - name: Unit testing of CTAP2 (release mode + CTAP1)
+      - name: Unit testing of CTAP2 (release mode + all features)
         uses: actions-rs/cargo@v1
         with:
+          toolchain: nightly
           command: test
-          args: --release --features std,with_ctap1
+          args: --manifest-path libraries/opensk/Cargo.toml --release --features std,debug_ctap,with_ctap1,vendor_hid,ed25519
 
-      - name: Unit testing of CTAP2 (debug mode + CTAP1)
+      - name: Unit testing of CTAP2 (debug mode + all features)
         uses: actions-rs/cargo@v1
         with:
+          toolchain: nightly
           command: test
-          args: --features std,with_ctap1
+          args: --manifest-path libraries/opensk/Cargo.toml --features std,debug_ctap,with_ctap1,vendor_hid,ed25519
 

.gitignore

@@ -1,6 +1,4 @@
-fuzz/artifacts
-fuzz/corpus
-fuzz/coverage
+libraries/**/Cargo.lock
 target/
 
 # Local installation of elf2tab.

Cargo.lock

@@ -14,6 +14,7 @@ edition = "2018"
 libtock_core = { path = "third_party/libtock-rs/core" }
 libtock_drivers = { path = "third_party/libtock-drivers" }
 lang_items = { path = "third_party/lang-items" }
+opensk = { path = "libraries/opensk" }
 sk-cbor = { path = "libraries/cbor" }
 crypto = { path = "libraries/crypto" }
 rng256 = { path = "libraries/rng256" }
@@ -27,15 +28,14 @@ ed25519-compact = { version = "1", default-features = false, optional = true }
 
 [features]
 debug_allocations = ["lang_items/debug_allocations"]
-debug_ctap = ["libtock_drivers/debug_ctap"]
+debug_ctap = ["libtock_drivers/debug_ctap", "opensk/debug_ctap"]
 panic_console = ["lang_items/panic_console"]
-std = ["crypto/std", "lang_items/std", "persistent_store/std", "rng256/std", "rand"]
+std = ["crypto/std", "lang_items/std", "persistent_store/std", "rng256/std", "rand", "opensk/std"]
 verbose = ["debug_ctap", "libtock_drivers/verbose_usb"]
-with_ctap1 = ["crypto/with_ctap1"]
+with_ctap1 = ["crypto/with_ctap1", "opensk/with_ctap1"]
 with_nfc = ["libtock_drivers/with_nfc"]
-vendor_hid = []
-fuzz = ["arbitrary", "std"]
-ed25519 = ["ed25519-compact"]
+vendor_hid = ["opensk/vendor_hid"]
+ed25519 = ["ed25519-compact", "opensk/ed25519"]
 
 [dev-dependencies]
 enum-iterator = "0.6.0"