Merge pull request parallaxsecond#489 from tgonzalezorlandoarm/tg/backport-fix-lint-errors

Backport lint error fixes for rust 1.75

Author: gowthamsk-arm

.github/workflows/ci.yml

@@ -46,8 +46,6 @@ jobs:
         run: docker run -v $(pwd):/tmp/rust-tss-esapi -w /tmp/rust-tss-esapi/tss-esapi ubuntucontainer /tmp/rust-tss-esapi/tss-esapi/tests/all-ubuntu.sh
       - name: Run the cross-compilation script
         run: docker run -v $(pwd):/tmp/rust-tss-esapi -w /tmp/rust-tss-esapi/tss-esapi ubuntucontainer /tmp/rust-tss-esapi/tss-esapi/tests/cross-compile.sh
-      - name: Check the documentation
-        run: docker run -v $(pwd):/tmp/rust-tss-esapi -w /tmp/rust-tss-esapi/tss-esapi ubuntucontainer cargo doc
 
   tests-ubuntu-v3:
     name: Ubuntu tests on v3.x.y of tpm2-tss
@@ -68,7 +66,7 @@ jobs:
       - name: Build the container
         run: docker build -t fedoracontainer tss-esapi/tests/ --file tss-esapi/tests/Dockerfile-fedora
       - name: Run the tests
-        run: docker run -v $(pwd):/tmp/rust-tss-esapi -w /tmp/rust-tss-esapi/tss-esapi fedoracontainer dbus-run-session -- /tmp/rust-tss-esapi/tss-esapi/tests/all-fedora.sh
+        run: docker run -v $(pwd):/tmp/rust-tss-esapi -w /tmp/rust-tss-esapi/tss-esapi --env USE_FROZEN_LOCKFILE=1 fedoracontainer dbus-run-session -- /tmp/rust-tss-esapi/tss-esapi/tests/all-fedora.sh
 
   tests-fedora-rawhide:
     name: Fedora rawhide tests
@@ -90,3 +88,27 @@ jobs:
         run: docker build -t ubuntucontainer tss-esapi/tests/ --file tss-esapi/tests/Dockerfile-ubuntu
       - name: Run the tests
         run: docker run -v $(pwd):/tmp/rust-tss-esapi -w /tmp/rust-tss-esapi/tss-esapi ubuntucontainer /tmp/rust-tss-esapi/tss-esapi/tests/valgrind.sh
+
+  # Check that the documentation builds as well.
+  docs:
+    name: Check documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Build the container
+        run: docker build -t ubuntucontainer tss-esapi/tests/ --file tss-esapi/tests/Dockerfile-ubuntu
+      - name: Check documentation
+        run: docker run -v $(pwd):/tmp/rust-tss-esapi -w /tmp/rust-tss-esapi/tss-esapi -e RUSTDOCFLAGS="-Dwarnings" ubuntucontainer cargo doc --document-private-items --no-deps
+
+  # Check that there are no Clippy lint errors.
+  clippy:
+    name: Check Clippy lints
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Build the container
+        run: docker build -t ubuntucontainer tss-esapi/tests/ --file tss-esapi/tests/Dockerfile-ubuntu  --target tpm2-tss
+      - name: Check Clippy lints MSRV
+        run: docker run -v $(pwd):/tmp/rust-tss-esapi -w /tmp/rust-tss-esapi/tss-esapi --env RUST_TOOLCHAIN_VERSION=1.66.0 ubuntucontainer /tmp/rust-tss-esapi/tss-esapi/tests/lint-checks.sh
+      - name: Check Clippy lints latest
+        run: docker run -v $(pwd):/tmp/rust-tss-esapi -w /tmp/rust-tss-esapi/tss-esapi ubuntucontainer /tmp/rust-tss-esapi/tss-esapi/tests/lint-checks.sh

README.md

@@ -11,6 +11,7 @@ At the moment we test (via CI) and support the following Rust compiler versions:
     - The latest stable compiler version, as accessible through `rustup`.
     - The 1.66 compiler version.
 * On Fedora we test with the compiler version included with the Fedora 36 release.
+* On Fedora rawhide we test with the compiler version included.
 
 If you need support for other versions of the compiler, get in touch with us to see what we can do!
 

tss-esapi/src/context/tpm_commands/symmetric_primitives.rs

@@ -86,7 +86,7 @@ impl Context {
     /// # context
     /// #     .tr_set_auth(primary_key_handle.into(), primary_key_auth)
     /// #     .expect("Failed to set auth from primary key handle.");
-    /// # // Create symmetric key objhect attributes
+    /// # // Create symmetric key object attributes
     /// # let symmetric_key_object_attributes = ObjectAttributesBuilder::new()
     /// #     .with_user_with_auth(true)
     /// #     .with_sign_encrypt(true)
@@ -162,7 +162,7 @@ impl Context {
     ///             false,                // false, indicates that the data should be encrypted.
     ///             SymmetricMode::Cfb,   // The symmetric mode of the encryption.
     ///             data.clone(),                // The data that is to be encrypted.
-    ///             initial_value.clone(),       // Initial value needed by the algorithmen.
+    ///             initial_value.clone(),       // Initial value needed by the algorithm.
     ///         )
     ///         .expect("Call to encrypt_decrypt_2 failed when encrypting data")
     ///     });

tss-esapi/src/interface_types/session_handles.rs

@@ -92,7 +92,7 @@ pub enum AuthSession {
 }
 
 impl AuthSession {
-    /// Function that creates a Option<Session>.
+    /// Function that creates a `Option<Session>`.
     ///
     /// If a Session is created from the NoneHandle
     /// then the returned value from the function will be None.

tss-esapi/src/lib.rs

@@ -9,7 +9,6 @@
     overflowing_literals,
     path_statements,
     patterns_in_fns_without_body,
-    private_in_public,
     unconditional_recursion,
     unused,
     unused_allocation,

tss-esapi/src/structures/lists/pcr_selection.rs

@@ -52,7 +52,7 @@ impl PcrSelectionList {
         Ok(())
     }
 
-    /// Function for retrieving the PcrSelectionList from Option<PcrSelectionList>
+    /// Function for retrieving the PcrSelectionList from `Option<PcrSelectionList>`
     ///
     /// This returns an empty list if None is passed
     pub fn list_from_option(pcr_list: Option<PcrSelectionList>) -> PcrSelectionList {

tss-esapi/src/utils/mod.rs

@@ -59,13 +59,9 @@ impl TryFrom<TPMS_CONTEXT> for TpmsContext {
             hierarchy: tss2_context.hierarchy,
             context_blob: tss2_context.contextBlob.buffer.to_vec(),
         };
-        context.context_blob.truncate(
-            tss2_context
-                .contextBlob
-                .size
-                .try_into()
-                .map_err(|_| Error::local_error(WrapperErrorKind::WrongParamSize))?,
-        );
+        context
+            .context_blob
+            .truncate(tss2_context.contextBlob.size.into());
         Ok(context)
     }
 }
@@ -323,7 +319,7 @@ pub fn get_tpm_vendor(context: &mut Context) -> Result<String> {
     ]
     .iter()
     // Retrieve property values
-    .map(|propid| context.get_tpm_property(*propid))
+    .map(|prop_id| context.get_tpm_property(*prop_id))
     // Collect and return an error if we got one
     .collect::<Result<Vec<Option<u32>>>>()?
     .iter()

tss-esapi/tests/Dockerfile-fedora-rawhide

@@ -2,7 +2,7 @@ FROM fedora:rawhide
 
 RUN dnf install -y \
 	tpm2-tss-devel tpm2-abrmd tpm2-tools \
-	swtpm swtpm-tools \
+	swtpm swtpm-tools swtpm-selinux\
 	rust clippy cargo \
 	llvm llvm-devel clang pkg-config \
-	dbus-daemon
+	dbus-daemon rust-gobject-sys-devel

tss-esapi/tests/Dockerfile-ubuntu

@@ -1,10 +1,15 @@
-FROM ghcr.io/tpm2-software/ubuntu-18.04:latest
+FROM ghcr.io/tpm2-software/ubuntu-18.04:latest AS base
 
+FROM base AS rust-toolchain
+# Install Rust toolchain
+RUN curl https://sh.rustup.rs -sSf | bash -s -- -y
+ENV PATH="/root/.cargo/bin:${PATH}"
+
+FROM rust-toolchain AS tpm2-tss
+# Download and install the TSS library
 ARG TPM2_TSS_VERSION=2.4.6
 ENV TPM2_TSS_VERSION=$TPM2_TSS_VERSION
 ENV PKG_CONFIG_PATH /usr/local/lib/pkgconfig
-
-# Download and install the TSS library
 RUN git clone https://github.com/tpm2-software/tpm2-tss.git --branch $TPM2_TSS_VERSION
 RUN cd tpm2-tss \
 	&& ./bootstrap \
@@ -13,13 +18,10 @@ RUN cd tpm2-tss \
 	&& make install \
 	&& ldconfig
 
+FROM tpm2-tss AS tpm2-tools
 # Download and install TPM2 tools
 RUN git clone https://github.com/tpm2-software/tpm2-tools.git --branch 4.1
 RUN cd tpm2-tools \
 	&& ./bootstrap \
 	&& ./configure --enable-unit \
 	&& make install
-
-# Install Rust toolchain
-RUN curl https://sh.rustup.rs -sSf | bash -s -- -y
-ENV PATH="/root/.cargo/bin:${PATH}"

tss-esapi/tests/all-fedora.sh

@@ -3,13 +3,20 @@
 # Copyright 2019 Contributors to the Parsec project.
 # SPDX-License-Identifier: Apache-2.0
 
-# This script executes static checks and tests for the tss-esapi crate.
+# This script executes tests for the tss-esapi crate.
 # It can be run inside the container which Dockerfile is in the same folder.
 #
 # Usage: ./tests/all.sh
 
 set -euf -o pipefail
 
+if [[ ! -z ${USE_FROZEN_LOCKFILE:+x} ]]; then
+	# Some versions of Fedora that are used during testing are old
+    # so in order to prevent any drift from the versions available
+    # in the old versions the frozen Cargo lock is used.
+	cp tests/Cargo.lock.frozen ../Cargo.lock
+fi
+
 ############################
 # Run the TPM SWTPM server #
 ############################
@@ -33,11 +40,6 @@ tpm2-abrmd \
     --session \
     --flush-all &
 
-##################
-# Execute clippy #
-##################
-cargo clippy --all-targets --all-features -- -D clippy::all -D clippy::cargo
-
 ###################
 # Build the crate #
 ###################