moved data storage from hazelcast to postgres database

Author: tobiasholler

captchaservice-backend/pom.xml

@@ -313,11 +313,6 @@
             <artifactId>altcha</artifactId>
             <version>1.1.2</version>
         </dependency>
-        <dependency>
-            <groupId>com.hazelcast</groupId>
-            <artifactId>hazelcast</artifactId>
-            <version>5.3.8</version>
-        </dependency>
     </dependencies>
 
     <scm>

captchaservice-backend/src/main/java/de/muenchen/captchaservice/common/HazelcastConstants.java

@@ -0,0 +1,44 @@
+package de.muenchen.captchaservice.entity;
+
+import de.muenchen.captchaservice.common.BaseEntity;
+import jakarta.persistence.Column;
+import jakarta.persistence.Entity;
+import jakarta.persistence.Index;
+import jakarta.persistence.Table;
+import jakarta.validation.constraints.NotNull;
+import jakarta.validation.constraints.Size;
+import lombok.*;
+
+import java.time.Instant;
+
+@Entity
+@Table(
+        indexes = {
+                @Index(name = "idx_captcha_request_source_address_hash", columnList = "sourceAddressHash")
+        }
+)
+
+// Definition of getter, setter, ...
+@Getter
+@Setter
+@ToString(callSuper = true)
+@EqualsAndHashCode(callSuper = true)
+@NoArgsConstructor
+@AllArgsConstructor
+public class CaptchaRequest extends BaseEntity {
+
+    private static final long serialVersionUID = 1L;
+
+    // ========= //
+    // Variables //
+    // ========= //
+
+    @Column(nullable = false, length = 64)
+    @NotNull
+    @Size(min = 64, max = 64)
+    private String sourceAddressHash;
+
+    @NotNull
+    private Instant validUntil;
+
+}

captchaservice-backend/src/main/java/de/muenchen/captchaservice/configuration/hazelcast/HazelcastConfiguration.java

@@ -0,0 +1,43 @@
+package de.muenchen.captchaservice.entity;
+
+import de.muenchen.captchaservice.common.BaseEntity;
+import jakarta.persistence.Column;
+import jakarta.persistence.Entity;
+import jakarta.persistence.Index;
+import jakarta.persistence.Table;
+import jakarta.validation.constraints.NotNull;
+import jakarta.validation.constraints.Size;
+import lombok.*;
+
+import java.time.Instant;
+
+@Entity
+@Table(
+        indexes = {
+                @Index(name = "idx_invalidated_payload_payload_hash", columnList = "payloadHash")
+        }
+)
+// Definition of getter, setter, ...
+@Getter
+@Setter
+@ToString(callSuper = true)
+@EqualsAndHashCode(callSuper = true)
+@NoArgsConstructor
+@AllArgsConstructor
+public class InvalidatedPayload extends BaseEntity {
+
+    private static final long serialVersionUID = 1L;
+
+    // ========= //
+    // Variables //
+    // ========= //
+
+    @Column(nullable = false, length = 64)
+    @NotNull
+    @Size(min = 64, max = 64)
+    private String payloadHash;
+
+    @NotNull
+    private Instant validUntil;
+
+}

captchaservice-backend/src/main/java/de/muenchen/captchaservice/configuration/hazelcast/HazelcastProperties.java

@@ -0,0 +1,12 @@
+package de.muenchen.captchaservice.repository;
+
+import de.muenchen.captchaservice.entity.CaptchaRequest;
+import org.springframework.data.repository.CrudRepository;
+import org.springframework.data.repository.PagingAndSortingRepository;
+
+import java.time.Instant;
+import java.util.UUID;
+
+public interface CaptchaRequestRepository extends PagingAndSortingRepository<CaptchaRequest, UUID>, CrudRepository<CaptchaRequest, UUID> {
+    long countBySourceAddressHashIgnoreCaseAndValidUntilGreaterThanEqual(String sourceAddressHash, Instant validUntil);
+}

captchaservice-backend/src/main/java/de/muenchen/captchaservice/entity/CaptchaRequest.java

@@ -0,0 +1,12 @@
+package de.muenchen.captchaservice.repository;
+
+import de.muenchen.captchaservice.entity.InvalidatedPayload;
+import org.springframework.data.repository.CrudRepository;
+import org.springframework.data.repository.PagingAndSortingRepository;
+
+import java.time.Instant;
+import java.util.UUID;
+
+public interface InvalidatedPayloadRepository extends PagingAndSortingRepository<InvalidatedPayload, UUID>, CrudRepository<InvalidatedPayload, UUID> {
+    long countByPayloadHashIgnoreCaseAndValidUntilGreaterThanEqual(String payloadHash, Instant validUntil);
+}

captchaservice-backend/src/main/java/de/muenchen/captchaservice/entity/InvalidatedPayload.java

@@ -1,37 +1,36 @@
 package de.muenchen.captchaservice.service.captcha;
 
-import com.hazelcast.core.HazelcastInstance;
-import com.hazelcast.map.IMap;
-import de.muenchen.captchaservice.common.HazelcastConstants;
 import de.muenchen.captchaservice.configuration.captcha.CaptchaProperties;
 import de.muenchen.captchaservice.configuration.captcha.CaptchaSite;
 import de.muenchen.captchaservice.data.SourceAddress;
+import de.muenchen.captchaservice.entity.InvalidatedPayload;
+import de.muenchen.captchaservice.repository.InvalidatedPayloadRepository;
 import de.muenchen.captchaservice.service.difficulty.DifficultyService;
 import lombok.extern.slf4j.Slf4j;
 import org.altcha.altcha.Altcha;
 import org.apache.commons.codec.digest.DigestUtils;
 import org.springframework.stereotype.Service;
 
-import java.util.UUID;
-import java.util.concurrent.TimeUnit;
+import java.time.Instant;
 
 @Service
 @Slf4j
 public class CaptchaService {
 
     private final CaptchaProperties captchaProperties;
-    private final IMap<String, String> invalidatedPayloads;
+    private final InvalidatedPayloadRepository invalidatedPayloadRepository;
     private final DifficultyService difficultyService;
 
-    public CaptchaService(final CaptchaProperties captchaProperties, final DifficultyService difficultyService, final HazelcastInstance hazelcastInstance) {
+    public CaptchaService(final CaptchaProperties captchaProperties, final DifficultyService difficultyService,
+            InvalidatedPayloadRepository invalidatedPayloadRepository) {
         this.captchaProperties = captchaProperties;
+        this.invalidatedPayloadRepository = invalidatedPayloadRepository;
         this.difficultyService = difficultyService;
-        invalidatedPayloads = hazelcastInstance.getMap(HazelcastConstants.INVALIDATED_PAYLOADS);
     }
 
     public Altcha.Challenge createChallenge(final String siteKey, final SourceAddress sourceAddress) {
         final long difficulty = difficultyService.getDifficultyForSourceAddress(siteKey, sourceAddress);
-        difficultyService.pokeSourceAddress(sourceAddress);
+        difficultyService.registerRequest(sourceAddress);
         final Altcha.ChallengeOptions options = new Altcha.ChallengeOptions();
         options.algorithm = Altcha.Algorithm.SHA256;
         options.hmacKey = captchaProperties.hmacKey();
@@ -63,15 +62,15 @@ public boolean verify(final String siteKey, final Altcha.Payload payload) {
 
     public void invalidatePayload(final Altcha.Payload payload) {
         final String payloadHash = getPayloadHash(payload);
-        invalidatedPayloads.set(String.format("%s_%s_%s", payloadHash, System.currentTimeMillis(), UUID.randomUUID()), "",
-                captchaProperties.captchaTimeoutSeconds(), TimeUnit.SECONDS);
+        final InvalidatedPayload invalidatedPayload = new InvalidatedPayload(payloadHash, Instant.now().plusSeconds(captchaProperties.captchaTimeoutSeconds()));
+        invalidatedPayloadRepository.save(invalidatedPayload);
         log.debug("Invalidated payloadHash: {}", payloadHash);
     }
 
     public boolean isPayloadInvalidated(final String siteKey, final Altcha.Payload payload) {
         final CaptchaSite site = captchaProperties.sites().get(siteKey);
         final String payloadHash = getPayloadHash(payload);
-        final long payloadHashCount = invalidatedPayloads.keySet().stream().filter(s -> s.startsWith(String.format("%s_", payloadHash))).count();
+        final long payloadHashCount = invalidatedPayloadRepository.countByPayloadHashIgnoreCaseAndValidUntilGreaterThanEqual(payloadHash, Instant.now());
         return payloadHashCount >= site.maxVerifiesPerPayload();
     }
 

captchaservice-backend/src/main/java/de/muenchen/captchaservice/repository/CaptchaRequestRepository.java

@@ -1,35 +1,36 @@
 package de.muenchen.captchaservice.service.difficulty;
 
-import com.hazelcast.core.HazelcastInstance;
-import com.hazelcast.map.IMap;
-import de.muenchen.captchaservice.common.HazelcastConstants;
 import de.muenchen.captchaservice.configuration.captcha.CaptchaProperties;
 import de.muenchen.captchaservice.configuration.captcha.CaptchaSite;
 import de.muenchen.captchaservice.configuration.captcha.DifficultyItem;
 import de.muenchen.captchaservice.data.SourceAddress;
+import de.muenchen.captchaservice.entity.CaptchaRequest;
+import de.muenchen.captchaservice.repository.CaptchaRequestRepository;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.stereotype.Service;
 
+import java.time.Instant;
 import java.util.Optional;
-import java.util.UUID;
-import java.util.concurrent.TimeUnit;
 
 @Service
 @Slf4j
 public class DifficultyService {
 
     private final CaptchaProperties captchaProperties;
-    private final IMap<String, String> sourceAddresses;
 
-    public DifficultyService(final CaptchaProperties captchaProperties, final HazelcastInstance hazelcastInstance) {
+    private final CaptchaRequestRepository captchaRequestRepository;
+
+    public DifficultyService(final CaptchaProperties captchaProperties, CaptchaRequestRepository captchaRequestRepository) {
         this.captchaProperties = captchaProperties;
-        sourceAddresses = hazelcastInstance.getMap(HazelcastConstants.SOURCE_ADDRESSES);
+        this.captchaRequestRepository = captchaRequestRepository;
     }
 
-    public void pokeSourceAddress(final SourceAddress sourceAddress) {
+    public void registerRequest(final SourceAddress sourceAddress) {
         final String sourceAddressHash = sourceAddress.getHash();
-        sourceAddresses.set(String.format("%s_%s_%s", sourceAddressHash, System.currentTimeMillis(), UUID.randomUUID()), "",
-                captchaProperties.sourceAddressWindowSeconds(), TimeUnit.SECONDS);
+        final CaptchaRequest captchaRequest = new CaptchaRequest(sourceAddressHash,
+                Instant.now().plusSeconds(captchaProperties.sourceAddressWindowSeconds()));
+        captchaRequestRepository.save(captchaRequest);
+        log.debug("Poked source address with hash {}", sourceAddressHash);
     }
 
     public long getDifficultyForSourceAddress(final String siteKey, final SourceAddress sourceAddress) {
@@ -38,7 +39,8 @@ public long getDifficultyForSourceAddress(final String siteKey, final SourceAddr
             throw new IllegalArgumentException("siteKey not found");
         }
         final String sourceAddressHash = sourceAddress.getHash();
-        final long sourceVisitCount = sourceAddresses.keySet().stream().filter(s -> s.startsWith(String.format("%s_", sourceAddressHash))).count();
+        final long sourceVisitCount = captchaRequestRepository.countBySourceAddressHashIgnoreCaseAndValidUntilGreaterThanEqual(sourceAddressHash,
+                Instant.now());
         final Optional<DifficultyItem> difficultyItem = captchaSite
                 .difficultyMap()
                 .stream()