feat: add system metadata assertion

sdk/pom.xml

@@ -1,5 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <name>io.opentdf.platform:sdk</name>
     <artifactId>sdk</artifactId>
@@ -11,7 +13,8 @@
     <packaging>jar</packaging>
     <properties>
         <jazzer.version>0.22.1</jazzer.version>
-        <jazzer.baseurl>https://github.com/CodeIntelligenceTesting/jazzer/releases/download/v${jazzer.version}</jazzer.baseurl>
+        <jazzer.baseurl>
+            https://github.com/CodeIntelligenceTesting/jazzer/releases/download/v${jazzer.version}</jazzer.baseurl>
         <kotlin.version>2.1.0</kotlin.version>
         <connect.version>0.7.2</connect.version>
         <okhttp.version>4.12.0</okhttp.version>
@@ -287,6 +290,12 @@
         </dependency>
     </dependencies>
     <build>
+        <resources>
+            <resource>
+                <directory>src/main/resources</directory>
+                <filtering>true</filtering>
+            </resource>
+        </resources>
         <plugins>
             <!-- Plugin to create source JAR -->
             <plugin>
@@ -362,17 +371,18 @@
                             <target>
                                 <!-- Generate OpenTDF Platform Protobuf -->
                                 <exec executable="buf" dir="." failOnError="true">
-                                    <arg value="generate"/>
-                                    <arg value="https://github.com/opentdf/platform.git#branch=${platform.branch},subdir=service"/>
-                                    <arg value="-o"/>
-                                    <arg value="target"/>
+                                    <arg value="generate" />
+                                    <arg
+                                        value="https://github.com/opentdf/platform.git#branch=${platform.branch},subdir=service" />
+                                    <arg value="-o" />
+                                    <arg value="target" />
                                 </exec>
                                 <!-- Generate gRPC Protobuf -->
                                 <exec executable="buf" dir="." failOnError="true">
-                                    <arg value="generate"/>
-                                    <arg value="buf.build/grpc-ecosystem/grpc-gateway"/>
-                                    <arg value="-o"/>
-                                    <arg value="target"/>
+                                    <arg value="generate" />
+                                    <arg value="buf.build/grpc-ecosystem/grpc-gateway" />
+                                    <arg value="-o" />
+                                    <arg value="target" />
                                 </exec>
                             </target>
                         </configuration>
@@ -475,7 +485,8 @@
             </plugin>
         </plugins>
     </build>
-    <!--profile to execute fuzz test -->
+    <!--profile
+    to execute fuzz test -->
     <profiles>
         <profile>
             <id>fuzz</id>
@@ -499,18 +510,21 @@
                                 <configuration>
                                     <target>
                                         <condition property="jazzer.os" value="windows">
-                                            <os family="windows"/>
+                                            <os family="windows" />
                                         </condition>
                                         <condition property="jazzer.os" value="macos">
-                                            <os family="mac"/>
+                                            <os family="mac" />
                                         </condition>
                                         <condition property="jazzer.os" value="linux">
-                                            <os family="unix"/>
+                                            <os family="unix" />
                                         </condition>
-                                        <echo message="Detected OS: ${jazzer.os}"/>
-                                        <mkdir dir="${project.build.directory}/jazzer"/>
-                                        <get src="${jazzer.baseurl}/jazzer-${jazzer.os}.tar.gz" dest="${project.build.directory}/jazzer/jazzer.tar.gz"/>
-                                        <untar compression="gzip" src="${project.build.directory}/jazzer/jazzer.tar.gz" dest="${project.build.directory}/jazzer"/>
+                                        <echo message="Detected OS: ${jazzer.os}" />
+                                        <mkdir dir="${project.build.directory}/jazzer" />
+                                        <get src="${jazzer.baseurl}/jazzer-${jazzer.os}.tar.gz"
+                                            dest="${project.build.directory}/jazzer/jazzer.tar.gz" />
+                                        <untar compression="gzip"
+                                            src="${project.build.directory}/jazzer/jazzer.tar.gz"
+                                            dest="${project.build.directory}/jazzer" />
                                     </target>
                                 </configuration>
                                 <goals>
@@ -552,22 +566,28 @@
                                 <configuration>
                                     <target>
                                         <path id="project.classpath">
-                                            <pathelement location="${project.build.directory}/classes"/>
-                                            <pathelement location="${project.build.directory}/test-classes"/>
-                                            <fileset dir="${project.build.directory}/dependency-jars">
-                                                <include name="**/*.jar"/>
+                                            <pathelement
+                                                location="${project.build.directory}/classes" />
+                                            <pathelement
+                                                location="${project.build.directory}/test-classes" />
+                                            <fileset
+                                                dir="${project.build.directory}/dependency-jars">
+                                                <include name="**/*.jar" />
                                             </fileset>
                                         </path>
-                                        <pathconvert property="project.classpath.string" pathsep="${path.separator}">
-                                            <path refid="project.classpath"/>
+                                        <pathconvert property="project.classpath.string"
+                                            pathsep="${path.separator}">
+                                            <path refid="project.classpath" />
                                         </pathconvert>
-                                        <property environment="env"/>
+                                        <property environment="env" />
 
-                                        <chmod file="${project.build.directory}/jazzer/jazzer" perm="777"/>
+                                        <chmod file="${project.build.directory}/jazzer/jazzer"
+                                            perm="777" />
 
                                         <exec executable="bash">
-                                            <arg value="-c"/>
-                                            <arg value="if [ -z &quot;${JAVA_HOME}&quot; ]; then JAVA_HOME=$(dirname $(dirname $(which java))); fi; DYLD_LIBRARY_PATH=$(find &quot;${JAVA_HOME}&quot; -type d | grep 'libexec/openjdk.jdk/Contents/Home/lib/server' 2&gt;/dev/null | head -n 1); if [ -z &quot;${DYLD_LIBRARY_PATH}&quot; ]; then DYLD_LIBRARY_PATH=&quot;${JAVA_HOME}/lib/server&quot;; fi; export DYLD_LIBRARY_PATH=${DYLD_LIBRARY_PATH}; ${project.build.directory}/jazzer/jazzer --cp='${project.classpath.string}' --target_class='io.opentdf.platform.sdk.Fuzzing' --instrumentation_includes='io.opentdf.platform.sdk.**' ${jazzer.testDir}"/>
+                                            <arg value="-c" />
+                                            <arg
+                                                value="if [ -z &quot;${JAVA_HOME}&quot; ]; then JAVA_HOME=$(dirname $(dirname $(which java))); fi; DYLD_LIBRARY_PATH=$(find &quot;${JAVA_HOME}&quot; -type d | grep 'libexec/openjdk.jdk/Contents/Home/lib/server' 2&gt;/dev/null | head -n 1); if [ -z &quot;${DYLD_LIBRARY_PATH}&quot; ]; then DYLD_LIBRARY_PATH=&quot;${JAVA_HOME}/lib/server&quot;; fi; export DYLD_LIBRARY_PATH=${DYLD_LIBRARY_PATH}; ${project.build.directory}/jazzer/jazzer --cp='${project.classpath.string}' --target_class='io.opentdf.platform.sdk.Fuzzing' --instrumentation_includes='io.opentdf.platform.sdk.**' ${jazzer.testDir}" />
                                         </exec>
                                     </target>
                                 </configuration>
@@ -581,4 +601,4 @@
             </build>
         </profile>
     </profiles>
-</project>
+</project>

sdk/src/main/java/io/opentdf/platform/sdk/AssertionConfig.java

@@ -1,10 +1,17 @@
 package io.opentdf.platform.sdk;
 
+import com.google.gson.Gson;
+import com.google.gson.annotations.SerializedName;
 
+import java.net.InetAddress;
+import java.net.UnknownHostException;
+import java.time.OffsetDateTime;
+import java.time.format.DateTimeFormatter;
 import java.util.Objects;
 
 /**
- * Represents the configuration for assertions, encapsulating various types, scopes, states, keys,
+ * Represents the configuration for assertions, encapsulating various types,
+ * scopes, states, keys,
  * and statements involved in assertion handling.
  */
 public class AssertionConfig {
@@ -120,4 +127,83 @@ public int hashCode() {
     public AppliesToState appliesToState;
     public Statement statement;
     public AssertionKey signingKey;
+
+    /**
+     * Inner class to hold system metadata for assertion.
+     * Fields are named to match the JSON output of the original Go function.
+     */
+    static private class SystemMetadata {
+        @SerializedName("tdf_spec_version")
+        final String tdfSpecVersion;
+
+        @SerializedName("creation_date")
+        final String creationDate;
+
+        @SerializedName("operating_system")
+        final String operatingSystem;
+
+        @SerializedName("sdk_version")
+        final String sdkVersion;
+
+        @SerializedName("java_version") // Corresponds to "go_version" in the Go example
+        final String javaVersion;
+
+        @SerializedName("architecture")
+        final String architecture;
+
+        SystemMetadata(String tdfSpecVersion, String creationDate, String operatingSystem,
+                String sdkVersion, String javaVersion, String architecture) {
+            this.tdfSpecVersion = tdfSpecVersion;
+            this.creationDate = creationDate;
+            this.operatingSystem = operatingSystem;
+            this.sdkVersion = sdkVersion;
+            this.javaVersion = javaVersion;
+            this.architecture = architecture;
+        }
+    }
+
+    /**
+     * Returns a default assertion configuration with predefined system metadata.
+     * This method mimics the behavior of the Go function
+     * GetSystemMetadataAssertionConfig.
+     *
+     * @param tdfSpecVersionFromSDK The TDF specification version (e.g., "4.3.0").
+     * @param sdkInternalVersion    The internal version of this SDK (e.g.,
+     *                              "1.0.0"), which will be prefixed with "Java-".
+     * @return An {@link AssertionConfig} populated with system metadata.
+     * @throws SDKException if there's an error marshalling the metadata to JSON.
+     */
+    public static AssertionConfig getSystemMetadataAssertionConfig(String tdfSpecVersionFromSDK,
+            String sdkInternalVersion) {
+        String creationDate = OffsetDateTime.now().format(DateTimeFormatter.ISO_OFFSET_DATE_TIME);
+        String operatingSystem = System.getProperty("os.name");
+        String sdkVersion = "Java-" + sdkInternalVersion;
+        String javaVersion = System.getProperty("java.version");
+        String architecture = System.getProperty("os.arch");
+
+        SystemMetadata metadata = new SystemMetadata(tdfSpecVersionFromSDK, creationDate, operatingSystem,
+                sdkVersion, javaVersion, architecture);
+
+        Gson gson = new Gson(); // A new Gson instance is used for simplicity here.
+        String metadataJSON;
+        try {
+            metadataJSON = gson.toJson(metadata);
+        } catch (com.google.gson.JsonIOException | com.google.gson.JsonSyntaxException e) {
+            throw new SDKException("Failed to marshal system metadata to JSON", e);
+        }
+
+        AssertionConfig config = new AssertionConfig();
+        config.id = "default-assertion";
+        config.type = Type.BaseAssertion;
+        config.scope = Scope.Payload; // Maps from Go's PayloadScope
+        config.appliesToState = AppliesToState.Unencrypted;
+
+        Statement statement = new Statement();
+        statement.format = "json";
+        statement.schema = "metadata";
+        statement.value = metadataJSON;
+        config.statement = statement;
+
+        return config;
+    }
 }

sdk/src/main/java/io/opentdf/platform/sdk/Config.java

@@ -160,6 +160,7 @@ public static class TDFConfig {
         public KeyType wrappingKeyType;
         public boolean hexEncodeRootAndSegmentHashes;
         public boolean renderVersionInfoInManifest;
+        public boolean systemMetadataAssertion;
 
         public TDFConfig() {
             this.autoconfigure = true;
@@ -176,6 +177,7 @@ public TDFConfig() {
             this.wrappingKeyType = KeyType.RSA2048Key;
             this.hexEncodeRootAndSegmentHashes = false;
             this.renderVersionInfoInManifest = true;
+            this.systemMetadataAssertion = false;
         }
     }
 
@@ -297,6 +299,10 @@ public static Consumer<TDFConfig> withMimeType(String mimeType) {
         return (TDFConfig config) -> config.mimeType = mimeType;
     }
 
+    public static Consumer<TDFConfig> withSystemMetadataAssertion() {
+        return (TDFConfig config) -> config.systemMetadataAssertion = true;
+    }
+
     public static class NanoTDFConfig {
         public ECCMode eccMode;
         public NanoTDFType.Cipher cipher;

sdk/src/main/java/io/opentdf/platform/sdk/SdkInfo.java

@@ -0,0 +1,43 @@
+package io.opentdf.platform.sdk;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Properties;
+
+/**
+ * Provides information about the SDK, such as its version.
+ * The version is read from a properties file populated during the Maven build
+ * process.
+ */
+public final class SdkInfo {
+    private static final Logger logger = LoggerFactory.getLogger(SdkInfo.class);
+    private static final String VERSION_PROPERTIES_FILE = "version.properties"; // Relative to this class's package
+    private static final String SDK_VERSION_PROPERTY = "sdk.version";
+
+    public static final String VERSION;
+
+    static {
+        String versionString = "unknown"; // Default if properties can't be read
+        Properties props = new Properties();
+        try (InputStream input = SdkInfo.class.getResourceAsStream(VERSION_PROPERTIES_FILE)) {
+            if (input == null) {
+                logger.error("Unable to find " + VERSION_PROPERTIES_FILE
+                        + ". SDK version will be 'unknown'. Ensure it's in src/main/resources/io/opentdf/platform/sdk/");
+            } else {
+                props.load(input);
+                versionString = props.getProperty(SDK_VERSION_PROPERTY, "unknown");
+            }
+        } catch (IOException ex) {
+            logger.error("Error loading " + VERSION_PROPERTIES_FILE + ". SDK version will be 'unknown'.", ex);
+        }
+        VERSION = versionString;
+        logger.info("OpenTDF SDK Version: {}", VERSION);
+    }
+
+    private SdkInfo() {
+        // Private constructor to prevent instantiation of this utility class
+    }
+}