More tuf updates for conformance

- don't persist N.root.json, could clash with a delegation - validate at parsetime the type of meta file - generify metastore a bit more, force updater to clear the right meta - validate any bootstrapped root at update start time Signed-off-by: Appu Goundan <[email protected]>
sigstore · Nov 4, 2024 · f6144d3 · f6144d3
1 parent 90d958b
commit f6144d3
Show file tree

Hide file tree

Showing 56 changed files with 453 additions and 122 deletions.
diff --git a/bin/tuf-cli b/bin/tuf-cli
@@ -0,0 +1,251 @@
+#!/bin/sh
+
+#
+# Copyright © 2015-2021 the original authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+
+##############################################################################
+#
+#   tuf-cli start up script for POSIX generated by Gradle.
+#
+#   Important for running:
+#
+#   (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
+#       noncompliant, but you have some other compliant shell such as ksh or
+#       bash, then to run this script, type that shell name before the whole
+#       command line, like:
+#
+#           ksh tuf-cli
+#
+#       Busybox and similar reduced shells will NOT work, because this script
+#       requires all of these POSIX shell features:
+#         * functions;
+#         * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
+#           «${var#prefix}», «${var%suffix}», and «$( cmd )»;
+#         * compound commands having a testable exit status, especially «case»;
+#         * various built-in commands including «command», «set», and «ulimit».
+#
+#   Important for patching:
+#
+#   (2) This script targets any POSIX shell, so it avoids extensions provided
+#       by Bash, Ksh, etc; in particular arrays are avoided.
+#
+#       The "traditional" practice of packing multiple parameters into a
+#       space-separated string is a well documented source of bugs and security
+#       problems, so this is (mostly) avoided, by progressively accumulating
+#       options in "$@", and eventually passing that to Java.
+#
+#       Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
+#       and TUF_CLI_OPTS) rely on word-splitting, this is performed explicitly;
+#       see the in-line comments for details.
+#
+#       There are tweaks for specific operating systems such as AIX, CygWin,
+#       Darwin, MinGW, and NonStop.
+#
+#   (3) This script is generated from the Groovy template
+#       https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       within the Gradle project.
+#
+#       You can find Gradle at https://github.com/gradle/gradle/.
+#
+##############################################################################
+
+# Attempt to set APP_HOME
+
+# Resolve links: $0 may be a link
+app_path=$0
+
+# Need this for daisy-chained symlinks.
+while
+    APP_HOME=${app_path%"${app_path##*/}"}  # leaves a trailing /; empty if no leading path
+    [ -h "$app_path" ]
+do
+    ls=$( ls -ld "$app_path" )
+    link=${ls#*' -> '}
+    case $link in             #(
+      /*)   app_path=$link ;; #(
+      *)    app_path=$APP_HOME$link ;;
+    esac
+done
+
+# This is normally unused
+# shellcheck disable=SC2034
+APP_BASE_NAME=${0##*/}
+# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
+APP_HOME=$( cd -P "${APP_HOME:-./}.." > /dev/null && printf '%s
+' "$PWD" ) || exit
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD=maximum
+
+warn () {
+    echo "$*"
+} >&2
+
+die () {
+    echo
+    echo "$*"
+    echo
+    exit 1
+} >&2
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "$( uname )" in                #(
+  CYGWIN* )         cygwin=true  ;; #(
+  Darwin* )         darwin=true  ;; #(
+  MSYS* | MINGW* )  msys=true    ;; #(
+  NONSTOP* )        nonstop=true ;;
+esac
+
+CLASSPATH=$APP_HOME/lib/tuf-cli-1.1.0-SNAPSHOT.jar:$APP_HOME/lib/sigstore-java-1.1.0-SNAPSHOT.jar:$APP_HOME/lib/picocli-4.7.6.jar:$APP_HOME/lib/google-oauth-client-jetty-1.36.0.jar:$APP_HOME/lib/google-oauth-client-java6-1.36.0.jar:$APP_HOME/lib/google-oauth-client-1.36.0.jar:$APP_HOME/lib/google-http-client-apache-v2-1.45.0.jar:$APP_HOME/lib/google-http-client-gson-1.45.0.jar:$APP_HOME/lib/google-http-client-1.45.0.jar:$APP_HOME/lib/protobuf-java-util-4.28.2.jar:$APP_HOME/lib/grpc-netty-shaded-1.68.0.jar:$APP_HOME/lib/grpc-protobuf-1.68.0.jar:$APP_HOME/lib/grpc-stub-1.68.0.jar:$APP_HOME/lib/opencensus-contrib-http-util-0.31.1.jar:$APP_HOME/lib/grpc-util-1.68.0.jar:$APP_HOME/lib/grpc-core-1.68.0.jar:$APP_HOME/lib/opencensus-api-0.31.1.jar:$APP_HOME/lib/grpc-context-1.68.0.jar:$APP_HOME/lib/grpc-protobuf-lite-1.68.0.jar:$APP_HOME/lib/grpc-api-1.68.0.jar:$APP_HOME/lib/guava-33.3.1-jre.jar:$APP_HOME/lib/java-json-canonicalization-1.1.jar:$APP_HOME/lib/httpclient-4.5.14.jar:$APP_HOME/lib/commons-codec-1.17.1.jar:$APP_HOME/lib/gson-2.11.0.jar:$APP_HOME/lib/bcpkix-jdk18on-1.78.1.jar:$APP_HOME/lib/bcutil-jdk18on-1.78.1.jar:$APP_HOME/lib/failureaccess-1.0.2.jar:$APP_HOME/lib/listenablefuture-9999.0-empty-to-avoid-conflict-with-guava.jar:$APP_HOME/lib/jsr305-3.0.2.jar:$APP_HOME/lib/checker-qual-3.43.0.jar:$APP_HOME/lib/error_prone_annotations-2.30.0.jar:$APP_HOME/lib/j2objc-annotations-3.0.0.jar:$APP_HOME/lib/proto-google-common-protos-2.41.0.jar:$APP_HOME/lib/protobuf-java-4.28.2.jar:$APP_HOME/lib/bcprov-jdk18on-1.78.1.jar:$APP_HOME/lib/httpcore-4.4.16.jar:$APP_HOME/lib/perfmark-api-0.27.0.jar:$APP_HOME/lib/commons-logging-1.2.jar:$APP_HOME/lib/animal-sniffer-annotations-1.24.jar:$APP_HOME/lib/annotations-4.1.1.4.jar
+
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+        # IBM's JDK on AIX uses strange locations for the executables
+        JAVACMD=$JAVA_HOME/jre/sh/java
+    else
+        JAVACMD=$JAVA_HOME/bin/java
+    fi
+    if [ ! -x "$JAVACMD" ] ; then
+        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+    fi
+else
+    JAVACMD=java
+    if ! command -v java >/dev/null 2>&1
+    then
+        die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+    fi
+fi
+
+# Increase the maximum file descriptors if we can.
+if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
+    case $MAX_FD in #(
+      max*)
+        # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC2039,SC3045
+        MAX_FD=$( ulimit -H -n ) ||
+            warn "Could not query maximum file descriptor limit"
+    esac
+    case $MAX_FD in  #(
+      '' | soft) :;; #(
+      *)
+        # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC2039,SC3045
+        ulimit -n "$MAX_FD" ||
+            warn "Could not set maximum file descriptor limit to $MAX_FD"
+    esac
+fi
+
+# Collect all arguments for the java command, stacking in reverse order:
+#   * args from the command line
+#   * the main class name
+#   * -classpath
+#   * -D...appname settings
+#   * --module-path (only if needed)
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, and TUF_CLI_OPTS environment variables.
+
+# For Cygwin or MSYS, switch paths to Windows format before running java
+if "$cygwin" || "$msys" ; then
+    APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
+    CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
+
+    JAVACMD=$( cygpath --unix "$JAVACMD" )
+
+    # Now convert the arguments - kludge to limit ourselves to /bin/sh
+    for arg do
+        if
+            case $arg in                                #(
+              -*)   false ;;                            # don't mess with options #(
+              /?*)  t=${arg#/} t=/${t%%/*}              # looks like a POSIX filepath
+                    [ -e "$t" ] ;;                      #(
+              *)    false ;;
+            esac
+        then
+            arg=$( cygpath --path --ignore --mixed "$arg" )
+        fi
+        # Roll the args list around exactly as many times as the number of
+        # args, so each arg winds up back in the position where it started, but
+        # possibly modified.
+        #
+        # NB: a `for` loop captures its iteration list before it begins, so
+        # changing the positional parameters here affects neither the number of
+        # iterations, nor the values presented in `arg`.
+        shift                   # remove old arg
+        set -- "$@" "$arg"      # push replacement arg
+    done
+fi
+
+
+# Add default JVM options here. You can also use JAVA_OPTS and TUF_CLI_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS=""
+
+# Collect all arguments for the java command:
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
+#     and any embedded shellness will be escaped.
+#   * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
+#     treated as '${Hostname}' itself on the command line.
+
+set -- \
+        -classpath "$CLASSPATH" \
+        dev.sigstore.tuf.cli.Tuf \
+        "$@"
+
+# Stop when "xargs" is not available.
+if ! command -v xargs >/dev/null 2>&1
+then
+    die "xargs is not available"
+fi
+
+# Use "xargs" to parse quoted args.
+#
+# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
+#
+# In Bash we could simply go:
+#
+#   readarray ARGS < <( xargs -n1 <<<"$var" ) &&
+#   set -- "${ARGS[@]}" "$@"
+#
+# but POSIX shell has neither arrays nor command substitution, so instead we
+# post-process each arg (as a line of input to sed) to backslash-escape any
+# character that might be a shell metacharacter, then use eval to reverse
+# that process (while maintaining the separation between arguments), and wrap
+# the whole thing up as a single "set" statement.
+#
+# This will of course break if any of these variables contains a newline or
+# an unmatched quote.
+#
+
+eval "set -- $(
+        printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $TUF_CLI_OPTS" |
+        xargs -n1 |
+        sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
+        tr '\n' ' '
+    )" '"$@"'
+
+exec "$JAVACMD" "$@"
diff --git a/bin/tuf-cli.bat b/bin/tuf-cli.bat
@@ -0,0 +1,94 @@
+@rem
+@rem Copyright 2015 the original author or authors.
+@rem
+@rem Licensed under the Apache License, Version 2.0 (the "License");
+@rem you may not use this file except in compliance with the License.
+@rem You may obtain a copy of the License at
+@rem
+@rem      https://www.apache.org/licenses/LICENSE-2.0
+@rem
+@rem Unless required by applicable law or agreed to in writing, software
+@rem distributed under the License is distributed on an "AS IS" BASIS,
+@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+@rem See the License for the specific language governing permissions and
+@rem limitations under the License.
+@rem
+@rem SPDX-License-Identifier: Apache-2.0
+@rem
+
+@if "%DEBUG%"=="" @echo off
+@rem ##########################################################################
+@rem
+@rem  tuf-cli startup script for Windows
+@rem
+@rem ##########################################################################
+
+@rem Set local scope for the variables with windows NT shell
+if "%OS%"=="Windows_NT" setlocal
+
+set DIRNAME=%~dp0
+if "%DIRNAME%"=="" set DIRNAME=.
+@rem This is normally unused
+set APP_BASE_NAME=%~n0
+set APP_HOME=%DIRNAME%..
+
+@rem Resolve any "." and ".." in APP_HOME to make it shorter.
+for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
+
+@rem Add default JVM options here. You can also use JAVA_OPTS and TUF_CLI_OPTS to pass JVM options to this script.
+set DEFAULT_JVM_OPTS=
+
+@rem Find java.exe
+if defined JAVA_HOME goto findJavaFromJavaHome
+
+set JAVA_EXE=java.exe
+%JAVA_EXE% -version >NUL 2>&1
+if %ERRORLEVEL% equ 0 goto execute
+
+echo. 1>&2
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
+
+goto fail
+
+:findJavaFromJavaHome
+set JAVA_HOME=%JAVA_HOME:"=%
+set JAVA_EXE=%JAVA_HOME%/bin/java.exe
+
+if exist "%JAVA_EXE%" goto execute
+
+echo. 1>&2
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
+
+goto fail
+
+:execute
+@rem Setup the command line
+
+set CLASSPATH=%APP_HOME%\lib\tuf-cli-1.1.0-SNAPSHOT.jar;%APP_HOME%\lib\sigstore-java-1.1.0-SNAPSHOT.jar;%APP_HOME%\lib\picocli-4.7.6.jar;%APP_HOME%\lib\google-oauth-client-jetty-1.36.0.jar;%APP_HOME%\lib\google-oauth-client-java6-1.36.0.jar;%APP_HOME%\lib\google-oauth-client-1.36.0.jar;%APP_HOME%\lib\google-http-client-apache-v2-1.45.0.jar;%APP_HOME%\lib\google-http-client-gson-1.45.0.jar;%APP_HOME%\lib\google-http-client-1.45.0.jar;%APP_HOME%\lib\protobuf-java-util-4.28.2.jar;%APP_HOME%\lib\grpc-netty-shaded-1.68.0.jar;%APP_HOME%\lib\grpc-protobuf-1.68.0.jar;%APP_HOME%\lib\grpc-stub-1.68.0.jar;%APP_HOME%\lib\opencensus-contrib-http-util-0.31.1.jar;%APP_HOME%\lib\grpc-util-1.68.0.jar;%APP_HOME%\lib\grpc-core-1.68.0.jar;%APP_HOME%\lib\opencensus-api-0.31.1.jar;%APP_HOME%\lib\grpc-context-1.68.0.jar;%APP_HOME%\lib\grpc-protobuf-lite-1.68.0.jar;%APP_HOME%\lib\grpc-api-1.68.0.jar;%APP_HOME%\lib\guava-33.3.1-jre.jar;%APP_HOME%\lib\java-json-canonicalization-1.1.jar;%APP_HOME%\lib\httpclient-4.5.14.jar;%APP_HOME%\lib\commons-codec-1.17.1.jar;%APP_HOME%\lib\gson-2.11.0.jar;%APP_HOME%\lib\bcpkix-jdk18on-1.78.1.jar;%APP_HOME%\lib\bcutil-jdk18on-1.78.1.jar;%APP_HOME%\lib\failureaccess-1.0.2.jar;%APP_HOME%\lib\listenablefuture-9999.0-empty-to-avoid-conflict-with-guava.jar;%APP_HOME%\lib\jsr305-3.0.2.jar;%APP_HOME%\lib\checker-qual-3.43.0.jar;%APP_HOME%\lib\error_prone_annotations-2.30.0.jar;%APP_HOME%\lib\j2objc-annotations-3.0.0.jar;%APP_HOME%\lib\proto-google-common-protos-2.41.0.jar;%APP_HOME%\lib\protobuf-java-4.28.2.jar;%APP_HOME%\lib\bcprov-jdk18on-1.78.1.jar;%APP_HOME%\lib\httpcore-4.4.16.jar;%APP_HOME%\lib\perfmark-api-0.27.0.jar;%APP_HOME%\lib\commons-logging-1.2.jar;%APP_HOME%\lib\animal-sniffer-annotations-1.24.jar;%APP_HOME%\lib\annotations-4.1.1.4.jar
+
+
+@rem Execute tuf-cli
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %TUF_CLI_OPTS%  -classpath "%CLASSPATH%" dev.sigstore.tuf.cli.Tuf %*
+
+:end
+@rem End local scope for the variables with windows NT shell
+if %ERRORLEVEL% equ 0 goto mainEnd
+
+:fail
+rem Set variable TUF_CLI_EXIT_CONSOLE if you need the _script_ return code instead of
+rem the _cmd.exe /c_ return code!
+set EXIT_CODE=%ERRORLEVEL%
+if %EXIT_CODE% equ 0 set EXIT_CODE=1
+if not ""=="%TUF_CLI_EXIT_CONSOLE%" exit %EXIT_CODE%
+exit /b %EXIT_CODE%
+
+:mainEnd
+if "%OS%"=="Windows_NT" endlocal
+
+:omega
diff --git a/bin/tuf-cli.xfails b/bin/tuf-cli.xfails
@@ -0,0 +1,47 @@
+test_metadata_bytes_match
+test_expired_local_root
+test_expired_local_timestamp
+test_client_downloads_expected_file
+test_client_downloads_expected_file_in_sub_dir
+test_duplicate_sig_keyids
+test_keytype_and_scheme[rsa/rsassa-pss-sha256]
+test_keytype_and_scheme[ed25519/ed25519]
+test_unusual_role_name[?]
+test_unusual_role_name[#]
+test_unusual_role_name[/delegatedrole]
+test_unusual_role_name[../delegatedrole]
+test_snapshot_rollback[basic]
+test_snapshot_rollback[with
+test_static_repository[tuf-on-ci-0.11]
+test_graph_traversal[basic-delegation]
+test_graph_traversal[single-level-delegations]
+test_graph_traversal[two-level-delegations]
+test_graph_traversal[two-level-test-DFS-order-of-traversal]
+test_graph_traversal[three-level-delegation-test-DFS-order-of-traversal]
+test_graph_traversal[two-level-terminating-ignores-all-but-roles-descendants]
+test_graph_traversal[three-level-terminating-ignores-all-but-roles-descendants]
+test_graph_traversal[two-level-ignores-all-branches-not-matching-paths]
+test_graph_traversal[three-level-ignores-all-branches-not-matching-paths]
+test_graph_traversal[cyclic-graph]
+test_graph_traversal[two-roles-delegating-to-a-third]
+test_graph_traversal[two-roles-delegating-to-a-third-different-paths]
+test_targetfile_search[targetpath matches wildcard]
+test_targetfile_search[targetpath with separators x]
+test_targetfile_search[targetpath with separators y]
+test_targetfile_search[targetpath is not delegated by all roles in the chain]
+test_root_rotation[1-of-1-key-rotation]
+test_root_rotation[1-of-1-key-rotation-unused-signatures]
+test_root_rotation[3-of-5-sign-with-different-keycombos]
+test_root_rotation[3-of-5-one-key-rotated]
+test_root_rotation[3-of-5-one-key-rotated-with-intermediate-step]
+test_root_rotation[3-of-5-all-keys-rotated-with-intermediate-step]
+test_root_rotation[1-of-3-threshold-increase-to-2-of-3]
+test_root_rotation[2-of-3-threshold-decrease-to-1-of-3]
+test_root_rotation[1-of-2-threshold-increase-to-2-of-2]
+test_non_root_rotations[1-of-1-key-rotation]
+test_non_root_rotations[1-of-1-key-rotation-unused-signatures]
+test_non_root_rotations[3-of-5-sign-first-combo]
+test_non_root_rotations[3-of-5-sign-second-combo]
+test_non_root_rotations[3-of-5-sign-third-combo]
+test_non_root_rotations[3-of-5-sign-fourth-combo]
+test_snapshot_rollback[with hashes]