Fix #971: Add column for signature metadata

docs/db/changelog/changesets/powerauth-java-server/1.5.x/20230323-add-column-signature-metadata.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<databaseChangeLog xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
+                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                   xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-4.9.xsd">
+
+    <changeSet id="1" logicalFilePath="powerauth-java-server/1.5.x/20230323-add-column-signature-metadata" author="Lubos Racansky">
+        <preConditions onFail="MARK_RAN">
+            <not>
+                <columnExists tableName="pa_signature_audit" columnName="signature_metadata"/>
+            </not>
+        </preConditions>
+        <comment>Add signature_metadata column of type Clob</comment>
+        <addColumn tableName="pa_signature_audit">
+            <column name="signature_metadata" type="clob"/>
+        </addColumn>
+    </changeSet>
+
+</databaseChangeLog>

docs/db/changelog/changesets/powerauth-java-server/1.5.x/db.changelog-version.xml

@@ -3,7 +3,7 @@
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                    xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-4.9.xsd">
 
-    <include file="20230323-add-columns-signature-data.xml" relativeToChangelogFile="true" />
+    <include file="20230323-add-column-signature-metadata.xml" relativeToChangelogFile="true" />
     <include file="20230426-add-column-totp-seed.xml" relativeToChangelogFile="true" />
     <include file="20230723-add-table-unique-value.xml" relativeToChangelogFile="true" />
 

powerauth-java-server/src/main/java/io/getlime/security/powerauth/app/server/database/model/PowerAuthSignatureMetadata.java

@@ -0,0 +1,59 @@
+/*
+ * PowerAuth Server and related software components
+ * Copyright (C) 2023 Wultra s.r.o.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package io.getlime.security.powerauth.app.server.database.model;
+
+import lombok.AllArgsConstructor;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.io.Serializable;
+import java.util.Objects;
+
+
+/**
+ * Concrete implementation of the {@link SignatureMetadata} interface for PowerAuth.
+ * Contains metadata parameters specific to PowerAuth Signature.
+ *
+ * @author Jan Dusil
+ */
+@AllArgsConstructor
+@NoArgsConstructor
+@Data
+public class PowerAuthSignatureMetadata implements SignatureMetadata<String, String>, Serializable {
+
+    @JsonProperty("signatureDataMethod")
+    private String signatureDataMethod;
+    @JsonProperty("signatureDataUriId")
+    private String signatureDataUriId;
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        PowerAuthSignatureMetadata that = (PowerAuthSignatureMetadata) o;
+        return Objects.equals(signatureDataMethod, that.signatureDataMethod) &&
+                Objects.equals(signatureDataUriId, that.signatureDataUriId);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(signatureDataMethod, signatureDataUriId);
+    }
+}

powerauth-java-server/src/main/java/io/getlime/security/powerauth/app/server/database/model/SignatureMetadata.java

@@ -0,0 +1,43 @@
+/*
+ * PowerAuth Server and related software components
+ * Copyright (C) 2023 Wultra s.r.o.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package io.getlime.security.powerauth.app.server.database.model;
+
+import com.fasterxml.jackson.annotation.JsonSubTypes;
+import com.fasterxml.jackson.annotation.JsonTypeInfo;
+import io.getlime.security.powerauth.app.server.database.model.enumeration.SignatureMetadataType;
+
+import java.io.Serializable;
+
+/**
+ * Represents a generic interface for metadata related to different types of signatures.
+ * The interface allows for defining various metadata attributes as type parameters T1 and T2.
+ *
+ * @param <T1> The type of the first metadata parameter.
+ * @param <T2> The type of the second metadata parameter.
+ * @author Jan Dusil
+ */
+@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "type")
+@JsonSubTypes({
+        @JsonSubTypes.Type(value = PowerAuthSignatureMetadata.class,
+                name = SignatureMetadataType.POWER_AUTH)
+})
+public interface SignatureMetadata<T1, T2> extends Serializable {
+
+}
+

powerauth-java-server/src/main/java/io/getlime/security/powerauth/app/server/database/model/converter/SignatureMetadataConverter.java

@@ -0,0 +1,93 @@
+/*
+ * PowerAuth Server and related software components
+ * Copyright (C) 2023 Wultra s.r.o.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package io.getlime.security.powerauth.app.server.database.model.converter;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.core.type.TypeReference;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import io.getlime.security.powerauth.app.server.database.model.SignatureMetadata;
+import jakarta.persistence.AttributeConverter;
+import jakarta.persistence.Converter;
+import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.lang3.StringUtils;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Component;
+
+/**
+ * A JPA attribute converter for converting SignatureMetadata objects to and from JSON representations.
+ * This class enables storing SignatureMetadata in the database as a JSON column.
+ *
+ * @author Jan Dusil
+ */
+@Converter
+@Component
+@Slf4j
+public class SignatureMetadataConverter implements AttributeConverter<SignatureMetadata<?, ?>, String> {
+
+    private final ObjectMapper objectMapper;
+
+    /**
+     * Constructor that initializes the ObjectMapper.
+     *
+     * @param objectMapper The Jackson ObjectMapper.
+     */
+    @Autowired
+    public SignatureMetadataConverter(ObjectMapper objectMapper) {
+        this.objectMapper = objectMapper;
+    }
+
+    /**
+     * Converts a SignatureMetadata object to its JSON string representation.
+     *
+     * @param attribute The SignatureMetadata object to convert.
+     * @return The JSON string representation of the object.
+     */
+    @Override
+    public String convertToDatabaseColumn(SignatureMetadata<?, ?> attribute) {
+        if (attribute == null) {
+            return "{}";
+        }
+        try {
+            return objectMapper.writeValueAsString(attribute);
+        } catch (JsonProcessingException ex) {
+            logger.warn("JSON writing error", ex);
+            return "{}";
+        }
+    }
+
+    /**
+     * Converts a JSON string representation to a SignatureMetadata object.
+     *
+     * @param s The JSON string to convert.
+     * @return The converted SignatureMetadata object.
+     */
+    @Override
+    public SignatureMetadata<?, ?> convertToEntityAttribute(String s) {
+        if (StringUtils.isBlank(s)) {
+            return null;
+        }
+        try {
+            return objectMapper.readValue(s, new TypeReference<>() {
+            });
+        } catch (JsonProcessingException ex) {
+            logger.warn("Conversion failed for SignatureMetadata, error: " + ex.getMessage(), ex);
+            return null;
+        }
+    }
+}