Datasets:

feedback-to-code

/

cwa-server-task-instances

like 0

Follow

Feedback-2-Code 7

corona-warn-app/cwa-server

corona-warn-app__cwa-server-45

e8ca246da1ab3620b6340383d4a59fe2041af562

diff --git a/common/persistence/src/main/java/app/coronawarn/server/services/common/persistence/service/DiagnosisKeyService.java b/common/persistence/src/main/java/app/coronawarn/server/services/common/persistence/service/DiagnosisKeyService.java --- a/common/persistence/src/main/java/app/coronawarn/server/services/common/persistence/service/DiagnosisKeyService.java +++ b/common/persistence/src/main/java/app/coronawarn/server/services/common/persistence/service/DiagnosisKeyService.java @@ -13,16 +13,12 @@ public class DiagnosisKeyService { private DiagnosisKeyRepository keyRepository; /** - * Persists the specified collection of {@link DiagnosisKey} instances. Use the returned - * collection for further operations as the saveDiagnosisKeys operation might have changed the - * {@link DiagnosisKey} instances completely. + * Persists the specified collection of {@link DiagnosisKey} instances. * * @param diagnosisKeys must not contain {@literal null}. - * @return a collection of the saved keys; will never contain {@literal null}. * @throws IllegalArgumentException in case the given collection contains {@literal null}. */ - public Collection<DiagnosisKey> saveDiagnosisKeys( - Collection<DiagnosisKey> diagnosisKeys) { - return keyRepository.saveAll(diagnosisKeys); + public void saveDiagnosisKeys(Collection<DiagnosisKey> diagnosisKeys) { + keyRepository.saveAll(diagnosisKeys); } } diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/SubmissionController.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/SubmissionController.java --- a/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/SubmissionController.java +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/SubmissionController.java @@ -1,23 +1,22 @@ package app.coronawarn.server.services.submission.controller; -import java.util.Collection; -import java.util.Collections; -import java.util.stream.Collectors; import app.coronawarn.server.common.protocols.generated.ExposureKeys.TemporaryExposureKey; import app.coronawarn.server.services.common.persistence.domain.DiagnosisKey; import app.coronawarn.server.services.common.persistence.service.DiagnosisKeyService; import app.coronawarn.server.services.submission.verification.TanVerifier; +import java.util.Collection; +import java.util.Collections; +import java.util.stream.Collectors; import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.GetMapping; -import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RequestHeader; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; -// TODO Implement Unit Tests @RestController @RequestMapping("/version/v1") public class SubmissionController { @@ -34,9 +33,8 @@ public ResponseEntity<String> hello() { } // TODO update protoSpec and endpoint to Collection<TemporaryExposureKey> - @PostMapping(value = "/diagnosis-keys/country/{country}") - public ResponseEntity<String> submitDiagnosisKey( - @PathVariable String country, + @PostMapping(value = "/diagnosis-keys") + public ResponseEntity<Void> submitDiagnosisKey( @RequestBody TemporaryExposureKey exposureKeys, @RequestHeader(value = "cwa-fake") Integer fake, @RequestHeader(value = "cwa-authorization") String tan) { @@ -56,15 +54,14 @@ public ResponseEntity<String> submitDiagnosisKey( /** * @return A response that indicates that an invalid TAN was specified in the request. */ - private ResponseEntity<String> buildTanInvalidResponseEntity() { - // TODO implement - return null; + private ResponseEntity<Void> buildTanInvalidResponseEntity() { + return ResponseEntity.status(HttpStatus.FORBIDDEN).build(); } /** * @return A response that indicates successful request processing. */ - private ResponseEntity<String> buildSuccessResponseEntity() { + private ResponseEntity<Void> buildSuccessResponseEntity() { return ResponseEntity.ok().build(); } diff --git a/services/submission/src/main/resources/application.properties b/services/submission/src/main/resources/application.properties --- a/services/submission/src/main/resources/application.properties +++ b/services/submission/src/main/resources/application.properties @@ -1,3 +1,3 @@ logging.level.org.springframework.web=DEBUG -spring.jpa.hibernate.ddl-auto = create +spring.jpa.hibernate.ddl-auto=create spring.flyway.enabled=false

diff --git a/services/distribution/src/test/resources/application.properties b/services/distribution/src/test/resources/application.properties --- a/services/distribution/src/test/resources/application.properties +++ b/services/distribution/src/test/resources/application.properties @@ -1,5 +1,4 @@ -spring.datasource.driver-class-name=org.hsqldb.jdbc.JDBCDriver -spring.datasource.url=jdbc:hsqldb:mem:testdb;DB_CLOSE_DELAY=-1 -spring.datasource.username=cwa -spring.datasource.password=cwa -spring.jpa.hibernate.ddl-auto=create \ No newline at end of file +spring.jpa.hibernate.ddl-auto=create +logging.level.org.springframework=off +logging.level.root=warn +spring.main.banner-mode=off diff --git a/services/distribution/src/test/resources/logback-test.xml b/services/distribution/src/test/resources/logback-test.xml new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/resources/logback-test.xml @@ -0,0 +1,5 @@ +<?xml version="1.0" encoding="UTF-8"?> +<configuration> + <include resource="org/springframework/boot/logging/logback/base.xml" /> + <logger name="org.springframework" level="off"/> +</configuration> diff --git a/services/submission/src/test/java/app/coronawarn/server/services/submission/ServerApplicationTests.java b/services/submission/src/test/java/app/coronawarn/server/services/submission/ServerApplicationTests.java --- a/services/submission/src/test/java/app/coronawarn/server/services/submission/ServerApplicationTests.java +++ b/services/submission/src/test/java/app/coronawarn/server/services/submission/ServerApplicationTests.java @@ -1,13 +1,20 @@ package app.coronawarn.server.services.submission; +import static org.junit.jupiter.api.Assertions.assertNotNull; + +import app.coronawarn.server.services.submission.controller.SubmissionController; import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; @SpringBootTest class ServerApplicationTests { - @Test - void contextLoads() { - } + @Autowired + private SubmissionController controller; + @Test + public void contextLoads() { + assertNotNull(this.controller); + } } diff --git a/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/SubmissionControllerTest.java b/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/SubmissionControllerTest.java new file mode 100644 --- /dev/null +++ b/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/SubmissionControllerTest.java @@ -0,0 +1,159 @@ +package app.coronawarn.server.services.submission.controller; + + +import static app.coronawarn.server.common.protocols.generated.ExposureKeys.TemporaryExposureKey; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.mockito.Mockito.any; +import static org.mockito.Mockito.anyCollection; +import static org.mockito.Mockito.anyString; +import static org.mockito.Mockito.atLeastOnce; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +import app.coronawarn.server.services.common.persistence.service.DiagnosisKeyService; +import app.coronawarn.server.services.submission.verification.TanVerifier; +import com.google.protobuf.ByteString; +import java.net.URI; +import java.util.HashSet; +import java.util.Set; +import java.util.stream.Collectors; +import java.util.stream.Stream; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.Arguments; +import org.junit.jupiter.params.provider.MethodSource; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.boot.test.mock.mockito.MockBean; +import org.springframework.boot.test.web.client.TestRestTemplate; +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpMethod; +import org.springframework.http.HttpStatus; +import org.springframework.http.MediaType; +import org.springframework.http.RequestEntity; +import org.springframework.http.ResponseEntity; + +@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) +public class SubmissionControllerTest { + + private static final URI SUBMISSION_URL = URI.create("/version/v1/diagnosis-keys"); + + @MockBean + private DiagnosisKeyService diagnosisKeyService; + + @MockBean + private TanVerifier tanVerifier; + + @Autowired + private TestRestTemplate testRestTemplate; + + @BeforeEach + public void setUpMocks() { + when(tanVerifier.verifyTan(anyString())).thenReturn(true); + } + + @Test + public void checkResponseStatusForValidParameters() { + ResponseEntity<Void> actResponse = + executeRequest(buildTemporaryExposureKey(), buildOkHeaders()); + + assertEquals(HttpStatus.OK, actResponse.getStatusCode()); + } + + @Test + public void checkSaveOperationCallForValidParameters() { + executeRequest(buildTemporaryExposureKey(), buildOkHeaders()); + + verify(diagnosisKeyService, atLeastOnce()).saveDiagnosisKeys(anyCollection()); + } + + @ParameterizedTest + @MethodSource("createIncompleteHeaders") + public void badRequestIfCwaHeadersMissing(HttpHeaders headers) { + ResponseEntity<Void> actResponse = executeRequest(buildTemporaryExposureKey(), headers); + + verify(diagnosisKeyService, never()).saveDiagnosisKeys(any()); + assertEquals(HttpStatus.BAD_REQUEST, actResponse.getStatusCode()); + } + + private static Stream<Arguments> createIncompleteHeaders() { + return Stream.of( + Arguments.of(setContentTypeProtoBufHeader(new HttpHeaders())), + Arguments.of(setContentTypeProtoBufHeader(setCwaFakeHeader(new HttpHeaders(), "0"))), + Arguments.of(setContentTypeProtoBufHeader(setCwaAuthHeader(new HttpHeaders())))); + } + + @Test + public void checkAcceptedHttpMethods() { + Set<HttpMethod> expAllowedMethods = + Stream.of(HttpMethod.POST, HttpMethod.OPTIONS) + .collect(Collectors.toCollection(HashSet::new)); + + Set<HttpMethod> actAllowedMethods = testRestTemplate.optionsForAllow(SUBMISSION_URL.toString()); + + assertEquals(expAllowedMethods, actAllowedMethods); + } + + @Test + public void invalidTanHandling() { + when(tanVerifier.verifyTan(anyString())).thenReturn(false); + + ResponseEntity<Void> actResponse = + executeRequest(buildTemporaryExposureKey(), buildOkHeaders()); + + verify(diagnosisKeyService, never()).saveDiagnosisKeys(any()); + assertEquals(HttpStatus.FORBIDDEN, actResponse.getStatusCode()); + } + + @Test + public void fakeRequestHandling() { + HttpHeaders headers = buildOkHeaders(); + setCwaFakeHeader(headers, "1"); + + ResponseEntity<Void> actResponse = executeRequest(buildTemporaryExposureKey(), headers); + + verify(diagnosisKeyService, never()).saveDiagnosisKeys(any()); + assertEquals(HttpStatus.OK, actResponse.getStatusCode()); + } + + private static HttpHeaders buildOkHeaders() { + HttpHeaders headers = setCwaAuthHeader(setContentTypeProtoBufHeader(new HttpHeaders())); + + return setCwaFakeHeader(headers, "0"); + } + + private static HttpHeaders setContentTypeProtoBufHeader(HttpHeaders headers) { + headers.setContentType(MediaType.valueOf("application/x-protobuf")); + return headers; + } + + private static HttpHeaders setCwaAuthHeader(HttpHeaders headers) { + headers.set("cwa-authorization", "okTan"); + return headers; + } + + private static HttpHeaders setCwaFakeHeader(HttpHeaders headers, String value) { + headers.set("cwa-fake", value); + return headers; + } + + private static TemporaryExposureKey buildTemporaryExposureKey() { + return buildTemporaryExposureKey("testKey123456789", 3L, 2); + } + + private static TemporaryExposureKey buildTemporaryExposureKey( + String keyData, long rollingStartNumber, int riskLevelValue) { + return TemporaryExposureKey.newBuilder() + .setKeyData(ByteString.copyFromUtf8(keyData)) + .setRollingStartNumber(rollingStartNumber) + .setRiskLevelValue(riskLevelValue).build(); + } + + private ResponseEntity<Void> executeRequest(TemporaryExposureKey body, HttpHeaders headers) { + RequestEntity<TemporaryExposureKey> request = + new RequestEntity<>(body, headers, HttpMethod.POST, SUBMISSION_URL); + return testRestTemplate.postForEntity(SUBMISSION_URL, request, Void.class); + } +} diff --git a/services/submission/src/test/resources/application.properties b/services/submission/src/test/resources/application.properties --- a/services/submission/src/test/resources/application.properties +++ b/services/submission/src/test/resources/application.properties @@ -1,5 +1,4 @@ -spring.datasource.driver-class-name=org.hsqldb.jdbc.JDBCDriver -spring.datasource.url=jdbc:hsqldb:mem:testdb;DB_CLOSE_DELAY=-1 -spring.datasource.username=cwa -spring.datasource.password=cwa -spring.jpa.hibernate.ddl-auto=create \ No newline at end of file +spring.jpa.hibernate.ddl-auto=create +logging.level.org.springframework=off +logging.level.root=warn +spring.main.banner-mode=off diff --git a/services/submission/src/test/resources/logback-test.xml b/services/submission/src/test/resources/logback-test.xml new file mode 100644 --- /dev/null +++ b/services/submission/src/test/resources/logback-test.xml @@ -0,0 +1,5 @@ +<?xml version="1.0" encoding="UTF-8"?> +<configuration> + <include resource="org/springframework/boot/logging/logback/base.xml" /> + <logger name="org.springframework" level="off"/> +</configuration>

Diagnosis key submission unit tests Implement unit tests for the diagnosis key submission service according to best practices.

corona-warn-app/cwa-server

corona-warn-app__cwa-server-106

23b492fe7b9f0821f2a8c34516cb858efcfaa55b

diff --git a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/repository/DiagnosisKeyRepository.java b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/repository/DiagnosisKeyRepository.java --- a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/repository/DiagnosisKeyRepository.java +++ b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/repository/DiagnosisKeyRepository.java @@ -1,9 +1,18 @@ package app.coronawarn.server.common.persistence.repository; import app.coronawarn.server.common.persistence.domain.DiagnosisKey; +import javax.transaction.Transactional; import org.springframework.data.jpa.repository.JpaRepository; import org.springframework.stereotype.Repository; @Repository public interface DiagnosisKeyRepository extends JpaRepository<DiagnosisKey, Long> { + + /** + * Deletes all entries that have a submission timestamp lesser or equal to the specified one. + * + * @param submissionTimestamp the submission timestamp up to which entries will be deleted. + */ + @Transactional + public void deleteBySubmissionTimestampIsLessThanEqual(long submissionTimestamp); } diff --git a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyService.java b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyService.java --- a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyService.java +++ b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyService.java @@ -1,7 +1,11 @@ package app.coronawarn.server.common.persistence.service; +import static java.time.ZoneOffset.UTC; + import app.coronawarn.server.common.persistence.domain.DiagnosisKey; import app.coronawarn.server.common.persistence.repository.DiagnosisKeyRepository; +import java.time.Instant; +import java.time.LocalDateTime; import java.util.Collection; import java.util.List; import org.springframework.beans.factory.annotation.Autowired; @@ -30,4 +34,18 @@ public void saveDiagnosisKeys(Collection<DiagnosisKey> diagnosisKeys) { public List<DiagnosisKey> getDiagnosisKeys() { return keyRepository.findAll(Sort.by(Sort.Direction.ASC, "submissionTimestamp")); } + + /** + * Deletes all diagnosis key entries which have a submission timestamp that is older than the + * specified number of days. + * + * @param daysToRetain the number of days until which diagnosis keys will be retained. + */ + public void applyRetentionPolicy(int daysToRetain) { + long threshold = LocalDateTime + .ofInstant(Instant.now(), UTC) + .minusDays(daysToRetain) + .toEpochSecond(UTC) / 3600L; + keyRepository.deleteBySubmissionTimestampIsLessThanEqual(threshold); + } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/DiagnosisKeyDistributionRunner.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/DiagnosisKeyDistributionRunner.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/DiagnosisKeyDistributionRunner.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/DiagnosisKeyDistributionRunner.java @@ -24,7 +24,7 @@ import org.springframework.stereotype.Component; @Component -@Order(2) +@Order(3) /** * This runner retrieves stored diagnosis keys, the generates and persists the respective diagnosis * key bundles. diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/ExposureConfigurationDistributionRunner.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/ExposureConfigurationDistributionRunner.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/ExposureConfigurationDistributionRunner.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/ExposureConfigurationDistributionRunner.java @@ -23,7 +23,7 @@ import org.springframework.stereotype.Component; @Component -@Order(1) +@Order(2) /** * Reads the exposure configuration parameters from the respective file in the class path, then * generates and persists the respective exposure configuration bundle. diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/RetentionPolicyRunner.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/RetentionPolicyRunner.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/RetentionPolicyRunner.java @@ -0,0 +1,37 @@ +package app.coronawarn.server.services.distribution.runner; + +import app.coronawarn.server.common.persistence.service.DiagnosisKeyService; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.boot.ApplicationArguments; +import org.springframework.boot.ApplicationRunner; +import org.springframework.core.annotation.Order; +import org.springframework.stereotype.Component; + +/** + * This runner removes any diagnosis keys from the database that were submitted before a configured + * threshold of days. + */ +@Component +@Order(1) +public class RetentionPolicyRunner implements ApplicationRunner { + + private static final Logger logger = LoggerFactory + .getLogger(RetentionPolicyRunner.class); + + @Autowired + private DiagnosisKeyService diagnosisKeyService; + + @Value("${app.coronawarn.server.services.distribution.retention_days}") + private Integer rententionDays; + + @Override + public void run(ApplicationArguments args) { + diagnosisKeyService.applyRetentionPolicy(rententionDays); + + logger.debug("Retention policy applied successfully. Deleted all entries older that {} days.", + rententionDays); + } +} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/S3DistributionRunner.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/S3DistributionRunner.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/S3DistributionRunner.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/S3DistributionRunner.java @@ -16,7 +16,7 @@ * This runner will sync the base working directory to the S3. */ @Component -@Order(3) +@Order(4) public class S3DistributionRunner implements ApplicationRunner { private Logger logger = LoggerFactory.getLogger(this.getClass()); diff --git a/services/distribution/src/main/resources/application.properties b/services/distribution/src/main/resources/application.properties --- a/services/distribution/src/main/resources/application.properties +++ b/services/distribution/src/main/resources/application.properties @@ -2,6 +2,7 @@ logging.level.org.springframework.web=INFO logging.level.app.coronawarn=INFO spring.main.web-application-type=NONE +app.coronawarn.server.services.distribution.retention_days=14 app.coronawarn.server.services.distribution.version=v1 app.coronawarn.server.services.distribution.paths.output=out app.coronawarn.server.services.distribution.paths.privatekey=classpath:certificates/client/private.pem

diff --git a/common/persistence/src/test/java/app/coronawarn/server/common/persistence/TestApplication.java b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/TestApplication.java new file mode 100644 --- /dev/null +++ b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/TestApplication.java @@ -0,0 +1,15 @@ +package app.coronawarn.server.common.persistence; + +import app.coronawarn.server.common.persistence.service.DiagnosisKeyService; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +@SpringBootApplication +@Configuration +public class TestApplication { + @Bean + DiagnosisKeyService createDiagnosisKeyService() { + return new DiagnosisKeyService(); + } +} diff --git a/common/persistence/src/test/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyServiceTest.java b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyServiceTest.java new file mode 100644 --- /dev/null +++ b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyServiceTest.java @@ -0,0 +1,125 @@ +package app.coronawarn.server.common.persistence.service; + +import static java.time.ZoneOffset.UTC; +import static org.junit.jupiter.api.Assertions.assertEquals; + +import app.coronawarn.server.common.persistence.domain.DiagnosisKey; +import app.coronawarn.server.common.persistence.repository.DiagnosisKeyRepository; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import org.assertj.core.util.Lists; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest; + +@DataJpaTest +public class DiagnosisKeyServiceTest { + + @Autowired + private DiagnosisKeyService diagnosisKeyService; + + @Autowired + private DiagnosisKeyRepository diagnosisKeyRepository; + + @AfterEach + public void tearDown() { + diagnosisKeyRepository.deleteAll(); + } + + @Test + void testRetrievalForEmptyDB() { + var actKeys = diagnosisKeyService.getDiagnosisKeys(); + assertDiagnosisKeysEqual(Lists.emptyList(), actKeys); + } + + @Test + void testSaveAndRetrieve() { + var expKeys = List.of(buildDiagnosisKeyForSubmissionTimestamp(0L)); + + diagnosisKeyService.saveDiagnosisKeys(expKeys); + var actKeys = diagnosisKeyService.getDiagnosisKeys(); + + assertDiagnosisKeysEqual(expKeys, actKeys); + } + + @Test + void testSortedRetrievalResult() { + var expKeys = new ArrayList<>(List.of( + buildDiagnosisKeyForSubmissionTimestamp(1L), + buildDiagnosisKeyForSubmissionTimestamp(0L))); + + diagnosisKeyService.saveDiagnosisKeys(expKeys); + + // reverse to match expected sort order + Collections.reverse(expKeys); + var actKeys = diagnosisKeyService.getDiagnosisKeys(); + + assertDiagnosisKeysEqual(expKeys, actKeys); + } + + @Test + void testApplyRetentionPolicyForEmptyDb() { + diagnosisKeyService.applyRetentionPolicy(1); + var actKeys = diagnosisKeyService.getDiagnosisKeys(); + assertDiagnosisKeysEqual(Lists.emptyList(), actKeys); + } + + @Test + void testApplyRetentionPolicyForOneNotApplicableEntry() { + var expKeys = List.of(buildDiagnosisKeyForDateTime(OffsetDateTime.now(UTC).minusHours(23))); + + diagnosisKeyService.saveDiagnosisKeys(expKeys); + diagnosisKeyService.applyRetentionPolicy(1); + var actKeys = diagnosisKeyService.getDiagnosisKeys(); + + assertDiagnosisKeysEqual(expKeys, actKeys); + } + + @Test + void testApplyRetentionPolicyForOneApplicableEntry() { + var keys = List.of(buildDiagnosisKeyForDateTime(OffsetDateTime.now(UTC).minusDays(1L))); + + diagnosisKeyService.saveDiagnosisKeys(keys); + diagnosisKeyService.applyRetentionPolicy(1); + var actKeys = diagnosisKeyService.getDiagnosisKeys(); + + assertDiagnosisKeysEqual(Lists.emptyList(), actKeys); + } + + private void assertDiagnosisKeysEqual(List<DiagnosisKey> expDiagKeys, + List<DiagnosisKey> actDiagKeys) { + assertEquals(expDiagKeys.size(), actDiagKeys.size(), "Cardinality mismatch"); + + for (int i = 0; i < expDiagKeys.size(); i++) { + var expDiagKey = expDiagKeys.get(i); + var actDiagKey = actDiagKeys.get(i); + + assertEquals( + expDiagKey.getKeyData(), actDiagKey.getKeyData(), "keyData mismatch"); + assertEquals(expDiagKey.getRollingStartNumber(), actDiagKey.getRollingStartNumber(), + "rollingStartNumber mismatch"); + assertEquals(expDiagKey.getRollingPeriod(), actDiagKey.getRollingPeriod(), + "rollingPeriod mismatch"); + assertEquals(expDiagKey.getTransmissionRiskLevel(), actDiagKey.getTransmissionRiskLevel(), + "transmissionRiskLevel mismatch"); + assertEquals(expDiagKey.getSubmissionTimestamp(), actDiagKey.getSubmissionTimestamp(), + "submissionTimestamp mismatch"); + } + } + + public static DiagnosisKey buildDiagnosisKeyForSubmissionTimestamp(long submissionTimeStamp) { + return DiagnosisKey.builder() + .withKeyData(new byte[16]) + .withRollingStartNumber(0L) + .withRollingPeriod(1L) + .withTransmissionRiskLevel(2) + .withSubmissionTimestamp(submissionTimeStamp).build(); + } + + public static DiagnosisKey buildDiagnosisKeyForDateTime(OffsetDateTime dateTime) { + return buildDiagnosisKeyForSubmissionTimestamp(dateTime.toEpochSecond() / 3600); + } +} diff --git a/common/persistence/src/test/resources/application.properties b/common/persistence/src/test/resources/application.properties new file mode 100644 --- /dev/null +++ b/common/persistence/src/test/resources/application.properties @@ -0,0 +1,6 @@ +spring.flyway.enabled=false +spring.jpa.hibernate.ddl-auto=create +spring.jpa.properties.hibernate.show_sql=false +spring.main.banner-mode=off +logging.level.org.springframework=off +logging.level.root=off \ No newline at end of file diff --git a/common/persistence/src/test/resources/logback-test.xml b/common/persistence/src/test/resources/logback-test.xml new file mode 100644 --- /dev/null +++ b/common/persistence/src/test/resources/logback-test.xml @@ -0,0 +1,6 @@ +<?xml version="1.0" encoding="UTF-8"?> +<configuration> + <include resource="org/springframework/boot/logging/logback/base.xml" /> + <logger name="org.springframework" level="off"/> + <logger name="root" level="ERROR"/> +</configuration> diff --git a/services/distribution/src/test/resources/application.properties b/services/distribution/src/test/resources/application.properties --- a/services/distribution/src/test/resources/application.properties +++ b/services/distribution/src/test/resources/application.properties @@ -3,6 +3,7 @@ logging.level.org.springframework=off logging.level.root=off spring.main.banner-mode=off +app.coronawarn.server.services.distribution.retention_days=14 app.coronawarn.server.services.distribution.version=v1 app.coronawarn.server.services.distribution.paths.output=out app.coronawarn.server.services.distribution.paths.privatekey=classpath:certificates/client/private.pem

Set Retention Days to 14 Any key data that is associated to a point in time older than 14 days shall be removed from the database and will also be removed from the CDN and therefore the index file.

corona-warn-app/cwa-server

corona-warn-app__cwa-server-113

ac44b28ad79130bd39e2d002cddf3a67799a80fb

diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/crypto/CryptoProvider.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/CryptoProvider.java similarity index 89% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/crypto/CryptoProvider.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/CryptoProvider.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/crypto/CryptoProvider.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/CryptoProvider.java @@ -1,4 +1,4 @@ -package app.coronawarn.server.services.distribution.crypto; +package app.coronawarn.server.services.distribution.assembly.component; import java.io.ByteArrayInputStream; import java.io.IOException; @@ -22,7 +22,7 @@ import org.springframework.stereotype.Component; /** - * Wrapper class for a {@link CryptoProvider#getPrivateKey() private key} and a {@link + * Wrapper component for a {@link CryptoProvider#getPrivateKey() private key} and a {@link * CryptoProvider#getCertificate()} certificate} from the application properties. */ @Component @@ -30,10 +30,10 @@ public class CryptoProvider { private static final Logger logger = LoggerFactory.getLogger(CryptoProvider.class); - @Value("${app.coronawarn.server.services.distribution.paths.privatekey}") + @Value("${services.distribution.paths.privatekey}") private String privateKeyPath; - @Value("${app.coronawarn.server.services.distribution.paths.certificate}") + @Value("${services.distribution.paths.certificate}") private String certificatePath; @Autowired @@ -72,10 +72,10 @@ private static Certificate getCertificateFromBytes(final byte[] bytes) * Reads and returns the {@link PrivateKey} configured in the application properties. */ public PrivateKey getPrivateKey() { - if (this.privateKey == null) { + if (privateKey == null) { Resource privateKeyResource = resourceLoader.getResource(privateKeyPath); try (InputStream privateKeyStream = privateKeyResource.getInputStream()) { - this.privateKey = getPrivateKeyFromStream(privateKeyStream); + privateKey = getPrivateKeyFromStream(privateKeyStream); } catch (IOException e) { logger.error("Failed to load private key from {}", privateKeyPath, e); throw new RuntimeException(e); diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/CwaApiStructureProvider.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/CwaApiStructureProvider.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/CwaApiStructureProvider.java @@ -0,0 +1,35 @@ +package app.coronawarn.server.services.distribution.assembly.component; + +import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; +import app.coronawarn.server.services.distribution.assembly.structure.directory.IndexDirectory; +import app.coronawarn.server.services.distribution.assembly.structure.directory.IndexDirectoryImpl; +import app.coronawarn.server.services.distribution.assembly.structure.directory.decorator.IndexingDecorator; +import java.util.Set; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Component; + +/** + * Assembles the content underneath the {@code /version} path of the CWA API. + */ +@Component +public class CwaApiStructureProvider { + + private final String VERSION_DIRECTORY = "version"; + private final String VERSION_V1 = "v1"; + + @Autowired + private ExposureConfigurationStructureProvider exposureConfigurationStructureProvider; + + @Autowired + private DiagnosisKeysStructureProvider diagnosisKeysStructureProvider; + + public Directory getDirectory() { + IndexDirectory<?> versionDirectory = + new IndexDirectoryImpl<>(VERSION_DIRECTORY, __ -> Set.of(VERSION_V1), Object::toString); + + versionDirectory.addDirectoryToAll(__ -> exposureConfigurationStructureProvider.getExposureConfiguration()); + versionDirectory.addDirectoryToAll(__ -> diagnosisKeysStructureProvider.getDiagnosisKeys()); + + return new IndexingDecorator<>(versionDirectory); + } +} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/DiagnosisKeysStructureProvider.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/DiagnosisKeysStructureProvider.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/DiagnosisKeysStructureProvider.java @@ -0,0 +1,37 @@ +package app.coronawarn.server.services.distribution.assembly.component; + +import app.coronawarn.server.common.persistence.domain.DiagnosisKey; +import app.coronawarn.server.common.persistence.service.DiagnosisKeyService; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory.DiagnosisKeysDirectoryImpl; +import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; +import java.util.Collection; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Component; + +/** + * Retrieves stored diagnosis keys and builds a {@link DiagnosisKeysDirectoryImpl} with them. + */ +@Component +public class DiagnosisKeysStructureProvider { + + private static final Logger logger = LoggerFactory.getLogger(DiagnosisKeysStructureProvider.class); + + @Autowired + private DiagnosisKeyService diagnosisKeyService; + + @Autowired + private CryptoProvider cryptoProvider; + + public Directory getDiagnosisKeys() { + Collection<DiagnosisKey> diagnosisKeys = readDiagnosisKeys(); + return new DiagnosisKeysDirectoryImpl(diagnosisKeys, cryptoProvider); + } + + private Collection<DiagnosisKey> readDiagnosisKeys() { + logger.debug("Querying diagnosis keys from the database..."); + return diagnosisKeyService.getDiagnosisKeys(); + } + +} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/ExposureConfigurationStructureProvider.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/ExposureConfigurationStructureProvider.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/ExposureConfigurationStructureProvider.java @@ -0,0 +1,40 @@ +package app.coronawarn.server.services.distribution.assembly.component; + +import app.coronawarn.server.common.protocols.internal.RiskScoreParameters; +import app.coronawarn.server.services.distribution.assembly.exposureconfig.ExposureConfigurationProvider; +import app.coronawarn.server.services.distribution.assembly.exposureconfig.UnableToLoadFileException; +import app.coronawarn.server.services.distribution.assembly.exposureconfig.structure.directory.ExposureConfigurationDirectoryImpl; +import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Component; + +/** + * Reads the exposure configuration parameters from the respective file in the class path and builds + * a {@link ExposureConfigurationDirectoryImpl} with them. + */ +@Component +public class ExposureConfigurationStructureProvider { + + private static final Logger logger = LoggerFactory + .getLogger(ExposureConfigurationStructureProvider.class); + + @Autowired + private CryptoProvider cryptoProvider; + + public Directory getExposureConfiguration() { + var riskScoreParameters = readExposureConfiguration(); + return new ExposureConfigurationDirectoryImpl(riskScoreParameters, cryptoProvider); + } + + private RiskScoreParameters readExposureConfiguration() { + logger.debug("Reading exposure configuration..."); + try { + return ExposureConfigurationProvider.readMasterFile(); + } catch (UnableToLoadFileException e) { + logger.error("Could not load exposure configuration parameters", e); + throw new RuntimeException(e); + } + } +} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/OutputDirectoryProvider.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/OutputDirectoryProvider.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/OutputDirectoryProvider.java @@ -0,0 +1,37 @@ +package app.coronawarn.server.services.distribution.assembly.component; + +import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; +import app.coronawarn.server.services.distribution.assembly.structure.directory.DirectoryImpl; +import java.io.IOException; +import org.apache.commons.io.FileUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.stereotype.Component; + +/** + * Creates and clears a {@link Directory} on disk, which is defined by the application properties. + */ +@Component +public class OutputDirectoryProvider { + + private static final Logger logger = LoggerFactory.getLogger(OutputDirectoryProvider.class); + + @Value("${services.distribution.paths.output}") + private String outputPath; + + public Directory getDirectory() { + return new DirectoryImpl(getFileOnDisk()); + } + + public java.io.File getFileOnDisk() { + return new java.io.File(outputPath); + } + + public void clear() throws IOException { + logger.debug("Clearing output directory..."); + java.io.File outputDirectory = getFileOnDisk(); + FileUtils.deleteDirectory(outputDirectory); + outputDirectory.mkdirs(); + } +} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/diagnosiskeys/structure/directory/DiagnosisKeysCountryDirectoryImpl.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysCountryDirectoryImpl.java similarity index 55% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/diagnosiskeys/structure/directory/DiagnosisKeysCountryDirectoryImpl.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysCountryDirectoryImpl.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/diagnosiskeys/structure/directory/DiagnosisKeysCountryDirectoryImpl.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysCountryDirectoryImpl.java @@ -1,13 +1,13 @@ -package app.coronawarn.server.services.distribution.diagnosiskeys.structure.directory; +package app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory; import app.coronawarn.server.common.persistence.domain.DiagnosisKey; -import app.coronawarn.server.services.distribution.crypto.CryptoProvider; -import app.coronawarn.server.services.distribution.diagnosiskeys.structure.directory.decorator.DateAggregatingDecorator; -import app.coronawarn.server.services.distribution.structure.directory.Directory; -import app.coronawarn.server.services.distribution.structure.directory.IndexDirectory; -import app.coronawarn.server.services.distribution.structure.directory.IndexDirectoryImpl; -import app.coronawarn.server.services.distribution.structure.directory.decorator.IndexingDecorator; -import app.coronawarn.server.services.distribution.structure.util.ImmutableStack; +import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory.decorator.DateAggregatingDecorator; +import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; +import app.coronawarn.server.services.distribution.assembly.structure.directory.IndexDirectory; +import app.coronawarn.server.services.distribution.assembly.structure.directory.IndexDirectoryImpl; +import app.coronawarn.server.services.distribution.assembly.structure.directory.decorator.IndexingDecorator; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; import java.time.LocalDate; import java.util.Collection; import java.util.Set; @@ -17,8 +17,8 @@ public class DiagnosisKeysCountryDirectoryImpl extends IndexDirectoryImpl<String private static final String COUNTRY_DIRECTORY = "country"; private static final String COUNTRY = "DE"; - private Collection<DiagnosisKey> diagnosisKeys; - private CryptoProvider cryptoProvider; + private final Collection<DiagnosisKey> diagnosisKeys; + private final CryptoProvider cryptoProvider; public DiagnosisKeysCountryDirectoryImpl(Collection<DiagnosisKey> diagnosisKeys, CryptoProvider cryptoProvider) { diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectoryImpl.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectoryImpl.java similarity index 59% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectoryImpl.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectoryImpl.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectoryImpl.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectoryImpl.java @@ -1,13 +1,13 @@ -package app.coronawarn.server.services.distribution.diagnosiskeys.structure.directory; +package app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory; import app.coronawarn.server.common.persistence.domain.DiagnosisKey; -import app.coronawarn.server.services.distribution.crypto.CryptoProvider; -import app.coronawarn.server.services.distribution.diagnosiskeys.util.DateTime; -import app.coronawarn.server.services.distribution.structure.directory.Directory; -import app.coronawarn.server.services.distribution.structure.directory.IndexDirectory; -import app.coronawarn.server.services.distribution.structure.directory.IndexDirectoryImpl; -import app.coronawarn.server.services.distribution.structure.directory.decorator.IndexingDecorator; -import app.coronawarn.server.services.distribution.structure.util.ImmutableStack; +import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.util.DateTime; +import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; +import app.coronawarn.server.services.distribution.assembly.structure.directory.IndexDirectory; +import app.coronawarn.server.services.distribution.assembly.structure.directory.IndexDirectoryImpl; +import app.coronawarn.server.services.distribution.assembly.structure.directory.decorator.IndexingDecorator; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; import java.time.LocalDate; import java.time.LocalDateTime; import java.time.format.DateTimeFormatter; @@ -18,14 +18,14 @@ public class DiagnosisKeysDateDirectoryImpl extends IndexDirectoryImpl<LocalDate private static final String DATE_DIRECTORY = "date"; private static final DateTimeFormatter ISO8601 = DateTimeFormatter.ofPattern("yyyy-MM-dd"); - private Collection<DiagnosisKey> diagnosisKeys; - private CryptoProvider cryptoProvider; + private final Collection<DiagnosisKey> diagnosisKeys; + private final CryptoProvider cryptoProvider; public DiagnosisKeysDateDirectoryImpl(Collection<DiagnosisKey> diagnosisKeys, CryptoProvider cryptoProvider) { super(DATE_DIRECTORY, __ -> DateTime.getDates(diagnosisKeys), ISO8601::format); - this.diagnosisKeys = diagnosisKeys; this.cryptoProvider = cryptoProvider; + this.diagnosisKeys = diagnosisKeys; } @Override diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/diagnosiskeys/structure/directory/DiagnosisKeysDirectoryImpl.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDirectoryImpl.java similarity index 69% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/diagnosiskeys/structure/directory/DiagnosisKeysDirectoryImpl.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDirectoryImpl.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/diagnosiskeys/structure/directory/DiagnosisKeysDirectoryImpl.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDirectoryImpl.java @@ -1,12 +1,12 @@ -package app.coronawarn.server.services.distribution.diagnosiskeys.structure.directory; +package app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory; import app.coronawarn.server.common.persistence.domain.DiagnosisKey; -import app.coronawarn.server.services.distribution.crypto.CryptoProvider; -import app.coronawarn.server.services.distribution.structure.directory.Directory; -import app.coronawarn.server.services.distribution.structure.directory.DirectoryImpl; -import app.coronawarn.server.services.distribution.structure.directory.IndexDirectory; -import app.coronawarn.server.services.distribution.structure.directory.decorator.IndexingDecorator; -import app.coronawarn.server.services.distribution.structure.util.ImmutableStack; +import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; +import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; +import app.coronawarn.server.services.distribution.assembly.structure.directory.DirectoryImpl; +import app.coronawarn.server.services.distribution.assembly.structure.directory.IndexDirectory; +import app.coronawarn.server.services.distribution.assembly.structure.directory.decorator.IndexingDecorator; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; import java.util.Collection; /** diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectoryImpl.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectoryImpl.java similarity index 61% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectoryImpl.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectoryImpl.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectoryImpl.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectoryImpl.java @@ -1,13 +1,13 @@ -package app.coronawarn.server.services.distribution.diagnosiskeys.structure.directory; +package app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory; import app.coronawarn.server.common.persistence.domain.DiagnosisKey; -import app.coronawarn.server.services.distribution.crypto.CryptoProvider; -import app.coronawarn.server.services.distribution.diagnosiskeys.structure.file.HourFileImpl; -import app.coronawarn.server.services.distribution.diagnosiskeys.util.DateTime; -import app.coronawarn.server.services.distribution.structure.directory.IndexDirectoryImpl; -import app.coronawarn.server.services.distribution.structure.file.File; -import app.coronawarn.server.services.distribution.structure.file.decorator.SigningDecorator; -import app.coronawarn.server.services.distribution.structure.util.ImmutableStack; +import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.file.HourFileImpl; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.util.DateTime; +import app.coronawarn.server.services.distribution.assembly.structure.directory.IndexDirectoryImpl; +import app.coronawarn.server.services.distribution.assembly.structure.file.File; +import app.coronawarn.server.services.distribution.assembly.structure.file.decorator.SigningDecorator; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; import java.time.LocalDate; import java.time.LocalDateTime; import java.util.Collection; @@ -16,9 +16,9 @@ public class DiagnosisKeysHourDirectoryImpl extends IndexDirectoryImpl<LocalDate private static final String HOUR_DIRECTORY = "hour"; - private Collection<DiagnosisKey> diagnosisKeys; - private LocalDate currentDate; - private CryptoProvider cryptoProvider; + private final Collection<DiagnosisKey> diagnosisKeys; + private final LocalDate currentDate; + private final CryptoProvider cryptoProvider; public DiagnosisKeysHourDirectoryImpl(Collection<DiagnosisKey> diagnosisKeys, LocalDate currentDate, CryptoProvider cryptoProvider) { diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/diagnosiskeys/structure/directory/decorator/DateAggregatingDecorator.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/DateAggregatingDecorator.java similarity index 77% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/diagnosiskeys/structure/directory/decorator/DateAggregatingDecorator.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/DateAggregatingDecorator.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/diagnosiskeys/structure/directory/decorator/DateAggregatingDecorator.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/DateAggregatingDecorator.java @@ -1,16 +1,16 @@ -package app.coronawarn.server.services.distribution.diagnosiskeys.structure.directory.decorator; +package app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory.decorator; import app.coronawarn.server.common.protocols.internal.FileBucket; import app.coronawarn.server.common.protocols.internal.SignedPayload; -import app.coronawarn.server.services.distribution.crypto.CryptoProvider; -import app.coronawarn.server.services.distribution.structure.Writable; -import app.coronawarn.server.services.distribution.structure.directory.Directory; -import app.coronawarn.server.services.distribution.structure.directory.decorator.DirectoryDecorator; -import app.coronawarn.server.services.distribution.structure.file.File; -import app.coronawarn.server.services.distribution.structure.file.FileImpl; -import app.coronawarn.server.services.distribution.structure.file.decorator.SigningDecorator; -import app.coronawarn.server.services.distribution.structure.functional.CheckedFunction; -import app.coronawarn.server.services.distribution.structure.util.ImmutableStack; +import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; +import app.coronawarn.server.services.distribution.assembly.structure.Writable; +import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; +import app.coronawarn.server.services.distribution.assembly.structure.directory.decorator.DirectoryDecorator; +import app.coronawarn.server.services.distribution.assembly.structure.file.File; +import app.coronawarn.server.services.distribution.assembly.structure.file.FileImpl; +import app.coronawarn.server.services.distribution.assembly.structure.file.decorator.SigningDecorator; +import app.coronawarn.server.services.distribution.assembly.structure.functional.CheckedFunction; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; import java.util.ArrayList; import java.util.Comparator; import java.util.List; diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/diagnosiskeys/structure/file/HourFileImpl.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/file/HourFileImpl.java similarity index 86% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/diagnosiskeys/structure/file/HourFileImpl.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/file/HourFileImpl.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/diagnosiskeys/structure/file/HourFileImpl.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/file/HourFileImpl.java @@ -1,13 +1,13 @@ -package app.coronawarn.server.services.distribution.diagnosiskeys.structure.file; +package app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.file; import app.coronawarn.server.common.persistence.domain.DiagnosisKey; import app.coronawarn.server.common.protocols.external.exposurenotification.File; import app.coronawarn.server.common.protocols.external.exposurenotification.Key; import app.coronawarn.server.common.protocols.internal.FileBucket; -import app.coronawarn.server.services.distribution.diagnosiskeys.util.Batch; -import app.coronawarn.server.services.distribution.diagnosiskeys.util.DateTime; -import app.coronawarn.server.services.distribution.structure.file.FileImpl; -import app.coronawarn.server.services.distribution.structure.util.ImmutableStack; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.util.Batch; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.util.DateTime; +import app.coronawarn.server.services.distribution.assembly.structure.file.FileImpl; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; import com.google.protobuf.ByteString; import java.time.Instant; import java.time.LocalDateTime; diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/diagnosiskeys/util/Batch.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/util/Batch.java similarity index 97% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/diagnosiskeys/util/Batch.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/util/Batch.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/diagnosiskeys/util/Batch.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/util/Batch.java @@ -1,4 +1,4 @@ -package app.coronawarn.server.services.distribution.diagnosiskeys.util; +package app.coronawarn.server.services.distribution.assembly.diagnosiskeys.util; import app.coronawarn.server.common.protocols.external.exposurenotification.File; import app.coronawarn.server.common.protocols.external.exposurenotification.Header; diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/diagnosiskeys/util/DateTime.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/util/DateTime.java similarity index 95% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/diagnosiskeys/util/DateTime.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/util/DateTime.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/diagnosiskeys/util/DateTime.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/util/DateTime.java @@ -1,4 +1,4 @@ -package app.coronawarn.server.services.distribution.diagnosiskeys.util; +package app.coronawarn.server.services.distribution.assembly.diagnosiskeys.util; import app.coronawarn.server.common.persistence.domain.DiagnosisKey; import java.time.LocalDate; diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/diagnosiskeys/util/Maths.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/util/Maths.java similarity index 64% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/diagnosiskeys/util/Maths.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/util/Maths.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/diagnosiskeys/util/Maths.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/util/Maths.java @@ -1,4 +1,4 @@ -package app.coronawarn.server.services.distribution.diagnosiskeys.util; +package app.coronawarn.server.services.distribution.assembly.diagnosiskeys.util; public class Maths { diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/ExposureConfigurationProvider.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/ExposureConfigurationProvider.java similarity index 92% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/ExposureConfigurationProvider.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/ExposureConfigurationProvider.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/ExposureConfigurationProvider.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/ExposureConfigurationProvider.java @@ -1,8 +1,8 @@ -package app.coronawarn.server.services.distribution.exposureconfig; +package app.coronawarn.server.services.distribution.assembly.exposureconfig; import app.coronawarn.server.common.protocols.internal.RiskScoreParameters; import app.coronawarn.server.common.protocols.internal.RiskScoreParameters.Builder; -import app.coronawarn.server.services.distribution.exposureconfig.parsing.YamlConstructorForProtoBuf; +import app.coronawarn.server.services.distribution.assembly.exposureconfig.parsing.YamlConstructorForProtoBuf; import java.io.IOException; import java.io.InputStream; import org.springframework.core.io.ClassPathResource; diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/UnableToLoadFileException.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/UnableToLoadFileException.java similarity index 79% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/UnableToLoadFileException.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/UnableToLoadFileException.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/UnableToLoadFileException.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/UnableToLoadFileException.java @@ -1,4 +1,4 @@ -package app.coronawarn.server.services.distribution.exposureconfig; +package app.coronawarn.server.services.distribution.assembly.exposureconfig; /** * The file could not be loaded/parsed correctly. diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/parsing/YamlConstructorForProtoBuf.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/parsing/YamlConstructorForProtoBuf.java similarity index 85% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/parsing/YamlConstructorForProtoBuf.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/parsing/YamlConstructorForProtoBuf.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/parsing/YamlConstructorForProtoBuf.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/parsing/YamlConstructorForProtoBuf.java @@ -1,4 +1,4 @@ -package app.coronawarn.server.services.distribution.exposureconfig.parsing; +package app.coronawarn.server.services.distribution.assembly.exposureconfig.parsing; import java.util.Arrays; import org.yaml.snakeyaml.constructor.Constructor; @@ -20,9 +20,9 @@ public YamlConstructorForProtoBuf() { setPropertyUtils(new ProtoBufPropertyUtils()); } - private class ProtoBufPropertyUtils extends PropertyUtils { + private static class ProtoBufPropertyUtils extends PropertyUtils { - public Property getProperty(Class<? extends Object> type, String name, BeanAccess bAccess) { + public Property getProperty(Class<?> type, String name, BeanAccess bAccess) { return super.getProperty(type, transformToProtoNaming(name), bAccess); } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/structure/ExposureConfigurationDirectoryImpl.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/structure/ExposureConfigurationDirectoryImpl.java similarity index 69% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/structure/ExposureConfigurationDirectoryImpl.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/structure/ExposureConfigurationDirectoryImpl.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/structure/ExposureConfigurationDirectoryImpl.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/structure/ExposureConfigurationDirectoryImpl.java @@ -1,12 +1,12 @@ -package app.coronawarn.server.services.distribution.exposureconfig.structure; +package app.coronawarn.server.services.distribution.assembly.exposureconfig.structure; import app.coronawarn.server.common.protocols.internal.RiskScoreParameters; -import app.coronawarn.server.services.distribution.crypto.CryptoProvider; -import app.coronawarn.server.services.distribution.structure.directory.DirectoryImpl; -import app.coronawarn.server.services.distribution.structure.directory.IndexDirectoryImpl; -import app.coronawarn.server.services.distribution.structure.directory.decorator.IndexingDecorator; -import app.coronawarn.server.services.distribution.structure.file.FileImpl; -import app.coronawarn.server.services.distribution.structure.file.decorator.SigningDecorator; +import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; +import app.coronawarn.server.services.distribution.assembly.structure.directory.DirectoryImpl; +import app.coronawarn.server.services.distribution.assembly.structure.directory.IndexDirectoryImpl; +import app.coronawarn.server.services.distribution.assembly.structure.directory.decorator.IndexingDecorator; +import app.coronawarn.server.services.distribution.assembly.structure.file.FileImpl; +import app.coronawarn.server.services.distribution.assembly.structure.file.decorator.SigningDecorator; import java.util.Set; /** diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/structure/directory/ExposureConfigurationDirectoryImpl.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/structure/directory/ExposureConfigurationDirectoryImpl.java similarity index 68% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/structure/directory/ExposureConfigurationDirectoryImpl.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/structure/directory/ExposureConfigurationDirectoryImpl.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/structure/directory/ExposureConfigurationDirectoryImpl.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/structure/directory/ExposureConfigurationDirectoryImpl.java @@ -1,12 +1,12 @@ -package app.coronawarn.server.services.distribution.exposureconfig.structure.directory; +package app.coronawarn.server.services.distribution.assembly.exposureconfig.structure.directory; import app.coronawarn.server.common.protocols.internal.RiskScoreParameters; -import app.coronawarn.server.services.distribution.crypto.CryptoProvider; -import app.coronawarn.server.services.distribution.structure.directory.DirectoryImpl; -import app.coronawarn.server.services.distribution.structure.directory.IndexDirectoryImpl; -import app.coronawarn.server.services.distribution.structure.directory.decorator.IndexingDecorator; -import app.coronawarn.server.services.distribution.structure.file.FileImpl; -import app.coronawarn.server.services.distribution.structure.file.decorator.SigningDecorator; +import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; +import app.coronawarn.server.services.distribution.assembly.structure.directory.DirectoryImpl; +import app.coronawarn.server.services.distribution.assembly.structure.directory.IndexDirectoryImpl; +import app.coronawarn.server.services.distribution.assembly.structure.directory.decorator.IndexingDecorator; +import app.coronawarn.server.services.distribution.assembly.structure.file.FileImpl; +import app.coronawarn.server.services.distribution.assembly.structure.file.decorator.SigningDecorator; import java.util.Set; /** diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/validation/ExposureConfigurationValidator.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ExposureConfigurationValidator.java similarity index 93% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/validation/ExposureConfigurationValidator.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ExposureConfigurationValidator.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/validation/ExposureConfigurationValidator.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ExposureConfigurationValidator.java @@ -1,8 +1,8 @@ -package app.coronawarn.server.services.distribution.exposureconfig.validation; +package app.coronawarn.server.services.distribution.assembly.exposureconfig.validation; import app.coronawarn.server.common.protocols.internal.RiskLevel; import app.coronawarn.server.common.protocols.internal.RiskScoreParameters; -import app.coronawarn.server.services.distribution.exposureconfig.validation.WeightValidationError.ErrorType; +import app.coronawarn.server.services.distribution.assembly.exposureconfig.validation.WeightValidationError.ErrorType; import java.beans.BeanInfo; import java.beans.IntrospectionException; import java.beans.Introspector; @@ -19,7 +19,7 @@ */ public class ExposureConfigurationValidator { - private RiskScoreParameters config; + private final RiskScoreParameters config; private ValidationResult errors; diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/validation/ParameterSpec.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ParameterSpec.java similarity index 85% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/validation/ParameterSpec.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ParameterSpec.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/validation/ParameterSpec.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ParameterSpec.java @@ -1,4 +1,4 @@ -package app.coronawarn.server.services.distribution.exposureconfig.validation; +package app.coronawarn.server.services.distribution.assembly.exposureconfig.validation; /** * Definition of the spec according to Apple/Google: diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/validation/RiskLevelValidationError.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/RiskLevelValidationError.java similarity index 93% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/validation/RiskLevelValidationError.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/RiskLevelValidationError.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/validation/RiskLevelValidationError.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/RiskLevelValidationError.java @@ -1,4 +1,4 @@ -package app.coronawarn.server.services.distribution.exposureconfig.validation; +package app.coronawarn.server.services.distribution.assembly.exposureconfig.validation; import java.util.Objects; diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/validation/ValidationError.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ValidationError.java similarity index 67% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/validation/ValidationError.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ValidationError.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/validation/ValidationError.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ValidationError.java @@ -1,4 +1,4 @@ -package app.coronawarn.server.services.distribution.exposureconfig.validation; +package app.coronawarn.server.services.distribution.assembly.exposureconfig.validation; /** * A validation error, found during the process of validating the Exposure Configuration. Can either diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/validation/ValidationFailedException.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ValidationFailedException.java similarity index 78% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/validation/ValidationFailedException.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ValidationFailedException.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/validation/ValidationFailedException.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ValidationFailedException.java @@ -1,4 +1,4 @@ -package app.coronawarn.server.services.distribution.exposureconfig.validation; +package app.coronawarn.server.services.distribution.assembly.exposureconfig.validation; /** * The validation could not be executed. Find more information about the root cause in the cause diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/validation/ValidationResult.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ValidationResult.java similarity index 87% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/validation/ValidationResult.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ValidationResult.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/validation/ValidationResult.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ValidationResult.java @@ -1,4 +1,4 @@ -package app.coronawarn.server.services.distribution.exposureconfig.validation; +package app.coronawarn.server.services.distribution.assembly.exposureconfig.validation; import java.util.HashSet; diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/validation/WeightValidationError.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/WeightValidationError.java similarity index 94% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/validation/WeightValidationError.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/WeightValidationError.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/exposureconfig/validation/WeightValidationError.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/WeightValidationError.java @@ -1,4 +1,4 @@ -package app.coronawarn.server.services.distribution.exposureconfig.validation; +package app.coronawarn.server.services.distribution.assembly.exposureconfig.validation; import java.util.Objects; diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/io/IO.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/io/IO.java similarity index 96% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/io/IO.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/io/IO.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/io/IO.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/io/IO.java @@ -1,4 +1,4 @@ -package app.coronawarn.server.services.distribution.io; +package app.coronawarn.server.services.distribution.assembly.io; import java.io.File; import java.io.FileOutputStream; diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/Writable.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/Writable.java similarity index 74% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/Writable.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/Writable.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/Writable.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/Writable.java @@ -1,7 +1,7 @@ -package app.coronawarn.server.services.distribution.structure; +package app.coronawarn.server.services.distribution.assembly.structure; -import app.coronawarn.server.services.distribution.structure.directory.Directory; -import app.coronawarn.server.services.distribution.structure.util.ImmutableStack; +import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; /** * Something that can be written to disk. diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/WritableImpl.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/WritableImpl.java similarity index 82% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/WritableImpl.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/WritableImpl.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/WritableImpl.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/WritableImpl.java @@ -1,6 +1,6 @@ -package app.coronawarn.server.services.distribution.structure; +package app.coronawarn.server.services.distribution.assembly.structure; -import app.coronawarn.server.services.distribution.structure.directory.Directory; +import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; import java.util.Objects; public abstract class WritableImpl implements Writable { diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/directory/Directory.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/Directory.java similarity index 75% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/directory/Directory.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/Directory.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/directory/Directory.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/Directory.java @@ -1,7 +1,7 @@ -package app.coronawarn.server.services.distribution.structure.directory; +package app.coronawarn.server.services.distribution.assembly.structure.directory; -import app.coronawarn.server.services.distribution.structure.Writable; -import app.coronawarn.server.services.distribution.structure.file.File; +import app.coronawarn.server.services.distribution.assembly.structure.Writable; +import app.coronawarn.server.services.distribution.assembly.structure.file.File; import java.util.Set; /** diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/directory/DirectoryImpl.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/DirectoryImpl.java similarity index 87% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/directory/DirectoryImpl.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/DirectoryImpl.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/directory/DirectoryImpl.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/DirectoryImpl.java @@ -1,8 +1,8 @@ -package app.coronawarn.server.services.distribution.structure.directory; +package app.coronawarn.server.services.distribution.assembly.structure.directory; -import app.coronawarn.server.services.distribution.structure.WritableImpl; -import app.coronawarn.server.services.distribution.structure.file.File; -import app.coronawarn.server.services.distribution.structure.util.ImmutableStack; +import app.coronawarn.server.services.distribution.assembly.structure.WritableImpl; +import app.coronawarn.server.services.distribution.assembly.structure.file.File; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; import java.util.HashSet; import java.util.Set; diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/directory/IndexDirectory.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectory.java similarity index 77% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/directory/IndexDirectory.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectory.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/directory/IndexDirectory.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectory.java @@ -1,9 +1,9 @@ -package app.coronawarn.server.services.distribution.structure.directory; +package app.coronawarn.server.services.distribution.assembly.structure.directory; -import app.coronawarn.server.services.distribution.structure.functional.DirectoryFunction; -import app.coronawarn.server.services.distribution.structure.functional.FileFunction; -import app.coronawarn.server.services.distribution.structure.functional.Formatter; -import app.coronawarn.server.services.distribution.structure.util.ImmutableStack; +import app.coronawarn.server.services.distribution.assembly.structure.functional.DirectoryFunction; +import app.coronawarn.server.services.distribution.assembly.structure.functional.FileFunction; +import app.coronawarn.server.services.distribution.assembly.structure.functional.Formatter; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; import java.util.Set; import java.util.Stack; @@ -32,7 +32,7 @@ public interface IndexDirectory<T> extends Directory { void addDirectoryToAll(DirectoryFunction directoryFunction); /** - * Calls the {@link app.coronawarn.server.services.distribution.structure.functional.IndexFunction} + * Calls the {@link app.coronawarn.server.services.distribution.assembly.structure.functional.IndexFunction} * with the {@code indices} to calculate and return the elements of the index of this {@link * IndexDirectory}. * diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/directory/IndexDirectoryImpl.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectoryImpl.java similarity index 85% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/directory/IndexDirectoryImpl.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectoryImpl.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/directory/IndexDirectoryImpl.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectoryImpl.java @@ -1,11 +1,11 @@ -package app.coronawarn.server.services.distribution.structure.directory; +package app.coronawarn.server.services.distribution.assembly.structure.directory; -import app.coronawarn.server.services.distribution.structure.file.File; -import app.coronawarn.server.services.distribution.structure.functional.DirectoryFunction; -import app.coronawarn.server.services.distribution.structure.functional.FileFunction; -import app.coronawarn.server.services.distribution.structure.functional.Formatter; -import app.coronawarn.server.services.distribution.structure.functional.IndexFunction; -import app.coronawarn.server.services.distribution.structure.util.ImmutableStack; +import app.coronawarn.server.services.distribution.assembly.structure.file.File; +import app.coronawarn.server.services.distribution.assembly.structure.functional.DirectoryFunction; +import app.coronawarn.server.services.distribution.assembly.structure.functional.FileFunction; +import app.coronawarn.server.services.distribution.assembly.structure.functional.Formatter; +import app.coronawarn.server.services.distribution.assembly.structure.functional.IndexFunction; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; import java.util.HashSet; import java.util.Set; import java.util.Stack; @@ -61,7 +61,7 @@ public void addDirectoryToAll(DirectoryFunction directoryFunction) { * Creates a new subdirectory for every element of the {@link IndexDirectory#getIndex index} and * writes {@link IndexDirectory#addFileToAll files} and {@link IndexDirectory#addDirectory * directories} to those. The respective element of the index will be pushed onto the Stack for - * subsequent {@link app.coronawarn.server.services.distribution.structure.Writable#prepare} calls + * subsequent {@link app.coronawarn.server.services.distribution.assembly.structure.Writable#prepare} calls * on those files and directories. * * @param indices A {@link Stack} of parameters from all {@link IndexDirectory IndexDirectories} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/directory/decorator/DirectoryDecorator.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/decorator/DirectoryDecorator.java similarity index 75% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/directory/decorator/DirectoryDecorator.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/decorator/DirectoryDecorator.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/directory/decorator/DirectoryDecorator.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/decorator/DirectoryDecorator.java @@ -1,9 +1,9 @@ -package app.coronawarn.server.services.distribution.structure.directory.decorator; +package app.coronawarn.server.services.distribution.assembly.structure.directory.decorator; -import app.coronawarn.server.services.distribution.structure.Writable; -import app.coronawarn.server.services.distribution.structure.directory.Directory; -import app.coronawarn.server.services.distribution.structure.file.File; -import app.coronawarn.server.services.distribution.structure.util.ImmutableStack; +import app.coronawarn.server.services.distribution.assembly.structure.Writable; +import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; +import app.coronawarn.server.services.distribution.assembly.structure.file.File; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; import java.util.Set; /** diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/directory/decorator/IndexingDecorator.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/decorator/IndexingDecorator.java similarity index 72% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/directory/decorator/IndexingDecorator.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/decorator/IndexingDecorator.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/directory/decorator/IndexingDecorator.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/decorator/IndexingDecorator.java @@ -1,9 +1,9 @@ -package app.coronawarn.server.services.distribution.structure.directory.decorator; +package app.coronawarn.server.services.distribution.assembly.structure.directory.decorator; -import app.coronawarn.server.services.distribution.structure.directory.IndexDirectory; -import app.coronawarn.server.services.distribution.structure.directory.IndexDirectoryImpl; -import app.coronawarn.server.services.distribution.structure.file.FileImpl; -import app.coronawarn.server.services.distribution.structure.util.ImmutableStack; +import app.coronawarn.server.services.distribution.assembly.structure.directory.IndexDirectory; +import app.coronawarn.server.services.distribution.assembly.structure.directory.IndexDirectoryImpl; +import app.coronawarn.server.services.distribution.assembly.structure.file.FileImpl; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; import java.util.List; import java.util.Set; import java.util.stream.Collectors; @@ -14,7 +14,7 @@ /** * A {@link DirectoryDecorator} that writes a file called {@code "index"}, containing a JSON array * containing all elements returned {@link IndexDirectoryImpl#getIndex}, formatted with the {@link - * IndexDirectoryImpl#getIndexFormatter} on {@link app.coronawarn.server.services.distribution.structure.Writable#prepare}. + * IndexDirectoryImpl#getIndexFormatter} on {@link app.coronawarn.server.services.distribution.assembly.structure.Writable#prepare}. */ public class IndexingDecorator<T> extends DirectoryDecorator { diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/file/File.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/file/File.java similarity index 64% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/file/File.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/file/File.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/file/File.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/file/File.java @@ -1,6 +1,6 @@ -package app.coronawarn.server.services.distribution.structure.file; +package app.coronawarn.server.services.distribution.assembly.structure.file; -import app.coronawarn.server.services.distribution.structure.Writable; +import app.coronawarn.server.services.distribution.assembly.structure.Writable; /** * A {@link Writable} containing some bytes. diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/file/FileImpl.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/file/FileImpl.java similarity index 69% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/file/FileImpl.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/file/FileImpl.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/file/FileImpl.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/file/FileImpl.java @@ -1,9 +1,9 @@ -package app.coronawarn.server.services.distribution.structure.file; +package app.coronawarn.server.services.distribution.assembly.structure.file; -import app.coronawarn.server.services.distribution.io.IO; -import app.coronawarn.server.services.distribution.structure.Writable; -import app.coronawarn.server.services.distribution.structure.WritableImpl; -import app.coronawarn.server.services.distribution.structure.util.ImmutableStack; +import app.coronawarn.server.services.distribution.assembly.io.IO; +import app.coronawarn.server.services.distribution.assembly.structure.Writable; +import app.coronawarn.server.services.distribution.assembly.structure.WritableImpl; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; /** * Implementation of {@link File} that interfaces with {@link java.io.File Files} on disk. diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/file/decorator/FileDecorator.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/file/decorator/FileDecorator.java similarity index 70% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/file/decorator/FileDecorator.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/file/decorator/FileDecorator.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/file/decorator/FileDecorator.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/file/decorator/FileDecorator.java @@ -1,9 +1,9 @@ -package app.coronawarn.server.services.distribution.structure.file.decorator; +package app.coronawarn.server.services.distribution.assembly.structure.file.decorator; -import app.coronawarn.server.services.distribution.structure.Writable; -import app.coronawarn.server.services.distribution.structure.directory.Directory; -import app.coronawarn.server.services.distribution.structure.file.File; -import app.coronawarn.server.services.distribution.structure.util.ImmutableStack; +import app.coronawarn.server.services.distribution.assembly.structure.Writable; +import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; +import app.coronawarn.server.services.distribution.assembly.structure.file.File; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; /** * Decorates a {@link File} (e.g. to modify its content) on {@link Writable#prepare}. This class diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/file/decorator/SigningDecorator.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/file/decorator/SigningDecorator.java similarity index 85% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/file/decorator/SigningDecorator.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/file/decorator/SigningDecorator.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/file/decorator/SigningDecorator.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/file/decorator/SigningDecorator.java @@ -1,9 +1,9 @@ -package app.coronawarn.server.services.distribution.structure.file.decorator; +package app.coronawarn.server.services.distribution.assembly.structure.file.decorator; import app.coronawarn.server.common.protocols.internal.SignedPayload; -import app.coronawarn.server.services.distribution.crypto.CryptoProvider; -import app.coronawarn.server.services.distribution.structure.file.File; -import app.coronawarn.server.services.distribution.structure.util.ImmutableStack; +import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; +import app.coronawarn.server.services.distribution.assembly.structure.file.File; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; import com.google.protobuf.ByteString; import java.security.GeneralSecurityException; import java.security.PrivateKey; diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/functional/CheckedFunction.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/functional/CheckedFunction.java similarity index 85% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/functional/CheckedFunction.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/functional/CheckedFunction.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/functional/CheckedFunction.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/functional/CheckedFunction.java @@ -1,4 +1,4 @@ -package app.coronawarn.server.services.distribution.structure.functional; +package app.coronawarn.server.services.distribution.assembly.structure.functional; import java.util.function.Function; diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/functional/DirectoryFunction.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/functional/DirectoryFunction.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/functional/DirectoryFunction.java @@ -0,0 +1,14 @@ +package app.coronawarn.server.services.distribution.assembly.structure.functional; + +import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; +import java.util.function.Function; + +/** + * A {@code Function<Stack<Object>, Directory>}. + */ +@FunctionalInterface +public interface DirectoryFunction extends Function<ImmutableStack<Object>, Directory> { + + Directory apply(ImmutableStack<Object> t); +} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/functional/FileFunction.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/functional/FileFunction.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/functional/FileFunction.java @@ -0,0 +1,14 @@ +package app.coronawarn.server.services.distribution.assembly.structure.functional; + +import app.coronawarn.server.services.distribution.assembly.structure.file.File; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; +import java.util.function.Function; + +/** + * A {@code Function<Stack<Object>, File>}. + */ +@FunctionalInterface +public interface FileFunction extends Function<ImmutableStack<Object>, File> { + + File apply(ImmutableStack<Object> t); +} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/functional/Formatter.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/functional/Formatter.java similarity index 74% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/functional/Formatter.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/functional/Formatter.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/functional/Formatter.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/functional/Formatter.java @@ -1,4 +1,4 @@ -package app.coronawarn.server.services.distribution.structure.functional; +package app.coronawarn.server.services.distribution.assembly.structure.functional; import java.util.function.Function; diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/functional/IndexFunction.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/functional/IndexFunction.java similarity index 64% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/functional/IndexFunction.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/functional/IndexFunction.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/functional/IndexFunction.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/functional/IndexFunction.java @@ -1,6 +1,6 @@ -package app.coronawarn.server.services.distribution.structure.functional; +package app.coronawarn.server.services.distribution.assembly.structure.functional; -import app.coronawarn.server.services.distribution.structure.util.ImmutableStack; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; import java.util.Set; import java.util.function.Function; diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/util/ImmutableStack.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/util/ImmutableStack.java similarity index 84% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/util/ImmutableStack.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/util/ImmutableStack.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/util/ImmutableStack.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/util/ImmutableStack.java @@ -1,10 +1,10 @@ -package app.coronawarn.server.services.distribution.structure.util; +package app.coronawarn.server.services.distribution.assembly.structure.util; import java.util.Stack; public class ImmutableStack<T> { - private Stack<T> stack; + private final Stack<T> stack; public ImmutableStack() { this.stack = new Stack<>(); diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccess.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccess.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccess.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccess.java @@ -36,9 +36,9 @@ @Component public class ObjectStoreAccess { - private Logger logger = LoggerFactory.getLogger(this.getClass()); + private final Logger logger = LoggerFactory.getLogger(this.getClass()); - private String bucket; + private final String bucket; private S3Client client; diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3Publisher.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3Publisher.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3Publisher.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3Publisher.java @@ -16,14 +16,14 @@ @Component public class S3Publisher { - private Logger logger = LoggerFactory.getLogger(this.getClass()); + private final Logger logger = LoggerFactory.getLogger(this.getClass()); /** * prefix path on S3, enforced for all methods on this class. */ private String prefixPath = "cwa/"; - private ObjectStoreAccess objectStoreAccess; + private final ObjectStoreAccess objectStoreAccess; @Autowired public S3Publisher(ObjectStoreAccess objectStoreAccess) { diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/Assembly.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/Assembly.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/Assembly.java @@ -0,0 +1,42 @@ +package app.coronawarn.server.services.distribution.runner; + +import app.coronawarn.server.services.distribution.assembly.component.CwaApiStructureProvider; +import app.coronawarn.server.services.distribution.assembly.component.OutputDirectoryProvider; +import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; +import java.io.IOException; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.ApplicationArguments; +import org.springframework.boot.ApplicationRunner; +import org.springframework.core.annotation.Order; +import org.springframework.stereotype.Component; + +/** + * This runner assembles and writes diagnosis key bundles and the parameter configuration. + */ +@Component +@Order(2) +public class Assembly implements ApplicationRunner { + + private static final Logger logger = LoggerFactory.getLogger(Assembly.class); + + @Autowired + private OutputDirectoryProvider outputDirectoryProvider; + + @Autowired + private CwaApiStructureProvider cwaApiStructureProvider; + + @Override + public void run(ApplicationArguments args) throws IOException { + Directory outputDirectory = this.outputDirectoryProvider.getDirectory(); + outputDirectory.addDirectory(cwaApiStructureProvider.getDirectory()); + this.outputDirectoryProvider.clear(); + logger.debug("Preparing files..."); + outputDirectory.prepare(new ImmutableStack<>()); + logger.debug("Writing files..."); + outputDirectory.write(); + logger.debug("Distribution run finished successfully."); + } +} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/DiagnosisKeyDistributionRunner.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/DiagnosisKeyDistributionRunner.java deleted file mode 100644 --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/DiagnosisKeyDistributionRunner.java +++ /dev/null @@ -1,78 +0,0 @@ -package app.coronawarn.server.services.distribution.runner; - -import app.coronawarn.server.common.persistence.domain.DiagnosisKey; -import app.coronawarn.server.common.persistence.service.DiagnosisKeyService; -import app.coronawarn.server.services.distribution.crypto.CryptoProvider; -import app.coronawarn.server.services.distribution.diagnosiskeys.structure.directory.DiagnosisKeysDirectoryImpl; -import app.coronawarn.server.services.distribution.structure.directory.DirectoryImpl; -import app.coronawarn.server.services.distribution.structure.directory.IndexDirectory; -import app.coronawarn.server.services.distribution.structure.directory.IndexDirectoryImpl; -import app.coronawarn.server.services.distribution.structure.directory.decorator.IndexingDecorator; -import app.coronawarn.server.services.distribution.structure.util.ImmutableStack; -import java.io.File; -import java.io.IOException; -import java.util.Collection; -import java.util.Set; -import org.apache.commons.io.FileUtils; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.annotation.Value; -import org.springframework.boot.ApplicationArguments; -import org.springframework.boot.ApplicationRunner; -import org.springframework.core.annotation.Order; -import org.springframework.stereotype.Component; - -@Component -@Order(3) -/** - * This runner retrieves stored diagnosis keys, the generates and persists the respective diagnosis - * key bundles. - */ -public class DiagnosisKeyDistributionRunner implements ApplicationRunner { - - private static final Logger logger = LoggerFactory - .getLogger(DiagnosisKeyDistributionRunner.class); - - private static final String VERSION_DIRECTORY = "version"; - - @Value("${app.coronawarn.server.services.distribution.version}") - private String version; - - @Value("${app.coronawarn.server.services.distribution.paths.output}") - private String outputPath; - - @Autowired - private CryptoProvider cryptoProvider; - - @Autowired - private DiagnosisKeyService diagnosisKeyService; - - - @Override - public void run(ApplicationArguments args) throws IOException { - Collection<DiagnosisKey> diagnosisKeys = diagnosisKeyService.getDiagnosisKeys(); - - DiagnosisKeysDirectoryImpl diagnosisKeysDirectory = - new DiagnosisKeysDirectoryImpl(diagnosisKeys, cryptoProvider); - - IndexDirectory<?> versionDirectory = - new IndexDirectoryImpl<>(VERSION_DIRECTORY, __ -> Set.of(version), Object::toString); - - versionDirectory.addDirectoryToAll(__ -> diagnosisKeysDirectory); - - java.io.File outputDirectory = new File(outputPath); - clearDirectory(outputDirectory); - DirectoryImpl root = new DirectoryImpl(outputDirectory); - root.addDirectory(new IndexingDecorator<>(versionDirectory)); - - root.prepare(new ImmutableStack<>()); - root.write(); - logger.debug("Diagnosis key distribution structure written successfully."); - } - - private static void clearDirectory(File directory) throws IOException { - FileUtils.deleteDirectory(directory); - directory.mkdirs(); - } -} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/ExposureConfigurationDistributionRunner.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/ExposureConfigurationDistributionRunner.java deleted file mode 100644 --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/ExposureConfigurationDistributionRunner.java +++ /dev/null @@ -1,70 +0,0 @@ -package app.coronawarn.server.services.distribution.runner; - -import app.coronawarn.server.common.protocols.internal.RiskScoreParameters; -import app.coronawarn.server.services.distribution.crypto.CryptoProvider; -import app.coronawarn.server.services.distribution.exposureconfig.ExposureConfigurationProvider; -import app.coronawarn.server.services.distribution.exposureconfig.UnableToLoadFileException; -import app.coronawarn.server.services.distribution.exposureconfig.structure.directory.ExposureConfigurationDirectoryImpl; -import app.coronawarn.server.services.distribution.structure.directory.Directory; -import app.coronawarn.server.services.distribution.structure.directory.DirectoryImpl; -import app.coronawarn.server.services.distribution.structure.directory.IndexDirectory; -import app.coronawarn.server.services.distribution.structure.directory.IndexDirectoryImpl; -import app.coronawarn.server.services.distribution.structure.directory.decorator.IndexingDecorator; -import app.coronawarn.server.services.distribution.structure.util.ImmutableStack; -import java.io.File; -import java.util.Set; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.annotation.Value; -import org.springframework.boot.ApplicationArguments; -import org.springframework.boot.ApplicationRunner; -import org.springframework.core.annotation.Order; -import org.springframework.stereotype.Component; - -@Component -@Order(2) -/** - * Reads the exposure configuration parameters from the respective file in the class path, then - * generates and persists the respective exposure configuration bundle. - */ -public class ExposureConfigurationDistributionRunner implements ApplicationRunner { - - private static final Logger logger = - LoggerFactory.getLogger(ExposureConfigurationDistributionRunner.class); - - @Value("${app.coronawarn.server.services.distribution.version}") - private String version; - - @Value("${app.coronawarn.server.services.distribution.paths.output}") - private String outputPath; - - @Autowired - private CryptoProvider cryptoProvider; - - private static final String VERSION_DIRECTORY = "version"; - - @Override - public void run(ApplicationArguments args) { - var riskScoreParameters = readExposureConfiguration(); - IndexDirectory<?> versionDirectory = - new IndexDirectoryImpl<>(VERSION_DIRECTORY, __ -> Set.of(version), Object::toString); - ExposureConfigurationDirectoryImpl parametersDirectory = - new ExposureConfigurationDirectoryImpl(riskScoreParameters, cryptoProvider); - Directory root = new DirectoryImpl(new File(outputPath)); - versionDirectory.addDirectoryToAll(__ -> parametersDirectory); - root.addDirectory(new IndexingDecorator<>(versionDirectory)); - root.prepare(new ImmutableStack<>()); - root.write(); - logger.debug("Exposure configuration structure written successfully."); - } - - private RiskScoreParameters readExposureConfiguration() { - try { - return ExposureConfigurationProvider.readMasterFile(); - } catch (UnableToLoadFileException e) { - logger.error("Could not load exposure configuration parameters", e); - throw new RuntimeException(e); - } - } -} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/RetentionPolicyRunner.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/RetentionPolicy.java similarity index 85% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/RetentionPolicyRunner.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/RetentionPolicy.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/RetentionPolicyRunner.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/RetentionPolicy.java @@ -16,15 +16,15 @@ */ @Component @Order(1) -public class RetentionPolicyRunner implements ApplicationRunner { +public class RetentionPolicy implements ApplicationRunner { private static final Logger logger = LoggerFactory - .getLogger(RetentionPolicyRunner.class); + .getLogger(RetentionPolicy.class); @Autowired private DiagnosisKeyService diagnosisKeyService; - @Value("${app.coronawarn.server.services.distribution.retention_days}") + @Value("${services.distribution.retention_days}") private Integer rententionDays; @Override diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/S3DistributionRunner.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/S3Distribution.java similarity index 69% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/S3DistributionRunner.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/S3Distribution.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/S3DistributionRunner.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/S3Distribution.java @@ -1,12 +1,12 @@ package app.coronawarn.server.services.distribution.runner; +import app.coronawarn.server.services.distribution.assembly.component.OutputDirectoryProvider; import app.coronawarn.server.services.distribution.objectstore.S3Publisher; import java.io.IOException; import java.nio.file.Path; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.annotation.Value; import org.springframework.boot.ApplicationArguments; import org.springframework.boot.ApplicationRunner; import org.springframework.core.annotation.Order; @@ -16,13 +16,13 @@ * This runner will sync the base working directory to the S3. */ @Component -@Order(4) -public class S3DistributionRunner implements ApplicationRunner { +@Order(3) +public class S3Distribution implements ApplicationRunner { - private Logger logger = LoggerFactory.getLogger(this.getClass()); + private final Logger logger = LoggerFactory.getLogger(this.getClass()); - @Value("${app.coronawarn.server.services.distribution.paths.output}") - private String workdir; + @Autowired + private OutputDirectoryProvider outputDirectoryProvider; @Autowired private S3Publisher s3Publisher; @@ -30,8 +30,7 @@ public class S3DistributionRunner implements ApplicationRunner { @Override public void run(ApplicationArguments args) { try { - Path pathToDistribute = Path.of(workdir).toAbsolutePath(); - + Path pathToDistribute = outputDirectoryProvider.getFileOnDisk().toPath().toAbsolutePath(); s3Publisher.publishFolder(pathToDistribute); } catch (IOException | UnsupportedOperationException e) { logger.error("Distribution failed.", e); diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/functional/DirectoryFunction.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/functional/DirectoryFunction.java deleted file mode 100644 --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/functional/DirectoryFunction.java +++ /dev/null @@ -1,14 +0,0 @@ -package app.coronawarn.server.services.distribution.structure.functional; - -import app.coronawarn.server.services.distribution.structure.directory.Directory; -import app.coronawarn.server.services.distribution.structure.util.ImmutableStack; -import java.util.function.Function; - -/** - * A {@code Function<Stack<Object>, Directory>}. - */ -@FunctionalInterface -public interface DirectoryFunction extends Function<ImmutableStack<Object>, Directory> { - - Directory apply(ImmutableStack<Object> t); -} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/functional/FileFunction.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/functional/FileFunction.java deleted file mode 100644 --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/structure/functional/FileFunction.java +++ /dev/null @@ -1,14 +0,0 @@ -package app.coronawarn.server.services.distribution.structure.functional; - -import app.coronawarn.server.services.distribution.structure.file.File; -import app.coronawarn.server.services.distribution.structure.util.ImmutableStack; -import java.util.function.Function; - -/** - * A {@code Function<Stack<Object>, File>}. - */ -@FunctionalInterface -public interface FileFunction extends Function<ImmutableStack<Object>, File> { - - File apply(ImmutableStack<Object> t); -} diff --git a/services/distribution/src/main/resources/application.properties b/services/distribution/src/main/resources/application.properties --- a/services/distribution/src/main/resources/application.properties +++ b/services/distribution/src/main/resources/application.properties @@ -2,11 +2,10 @@ logging.level.org.springframework.web=INFO logging.level.app.coronawarn=INFO spring.main.web-application-type=NONE -app.coronawarn.server.services.distribution.retention_days=14 -app.coronawarn.server.services.distribution.version=v1 -app.coronawarn.server.services.distribution.paths.output=out -app.coronawarn.server.services.distribution.paths.privatekey=classpath:certificates/client/private.pem -app.coronawarn.server.services.distribution.paths.certificate=classpath:certificates/chain/certificate.crt +services.distribution.retention_days=14 +services.distribution.paths.output=out +services.distribution.paths.privatekey=classpath:certificates/client/private.pem +services.distribution.paths.certificate=classpath:certificates/chain/certificate.crt spring.flyway.enabled=false spring.jpa.hibernate.ddl-auto=validate

diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/ApplicationInitializationTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/ApplicationInitializationTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/ApplicationInitializationTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/ApplicationInitializationTest.java @@ -3,7 +3,7 @@ import static org.junit.jupiter.api.Assertions.assertNotNull; import app.coronawarn.server.common.persistence.service.DiagnosisKeyService; -import app.coronawarn.server.services.distribution.crypto.CryptoProvider; +import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; import app.coronawarn.server.services.distribution.objectstore.S3Publisher; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.ExtendWith; diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/crypto/CryptoProviderTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/component/CryptoProviderTest.java similarity index 92% rename from services/distribution/src/test/java/app/coronawarn/server/services/distribution/crypto/CryptoProviderTest.java rename to services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/component/CryptoProviderTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/crypto/CryptoProviderTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/component/CryptoProviderTest.java @@ -1,4 +1,4 @@ -package app.coronawarn.server.services.distribution.crypto; +package app.coronawarn.server.services.distribution.assembly.component; import static org.junit.jupiter.api.Assertions.assertNotNull; diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/diagnosiskeys/structure/directory/DiagnosisKeysDirectoryTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysStructureProviderDirectoryTest.java similarity index 93% rename from services/distribution/src/test/java/app/coronawarn/server/services/distribution/diagnosiskeys/structure/directory/DiagnosisKeysDirectoryTest.java rename to services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysStructureProviderDirectoryTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/diagnosiskeys/structure/directory/DiagnosisKeysDirectoryTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysStructureProviderDirectoryTest.java @@ -1,14 +1,14 @@ -package app.coronawarn.server.services.distribution.diagnosiskeys.structure.directory; +package app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory; import static app.coronawarn.server.services.distribution.common.Helpers.buildDiagnosisKeyForSubmissionTimestamp; import static java.lang.String.join; import static org.junit.jupiter.api.Assertions.assertEquals; import app.coronawarn.server.common.persistence.domain.DiagnosisKey; -import app.coronawarn.server.services.distribution.crypto.CryptoProvider; -import app.coronawarn.server.services.distribution.structure.directory.Directory; -import app.coronawarn.server.services.distribution.structure.directory.DirectoryImpl; -import app.coronawarn.server.services.distribution.structure.util.ImmutableStack; +import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; +import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; +import app.coronawarn.server.services.distribution.assembly.structure.directory.DirectoryImpl; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; import java.io.File; import java.io.IOException; import java.util.ArrayList; @@ -31,7 +31,7 @@ @ExtendWith(SpringExtension.class) @ContextConfiguration(classes = {CryptoProvider.class}, initializers = ConfigFileApplicationContextInitializer.class) -public class DiagnosisKeysDirectoryTest { +public class DiagnosisKeysStructureProviderDirectoryTest { @Autowired CryptoProvider cryptoProvider; diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/diagnosiskeys/util/DateTimeTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/util/DateTimeTest.java similarity index 97% rename from services/distribution/src/test/java/app/coronawarn/server/services/distribution/diagnosiskeys/util/DateTimeTest.java rename to services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/util/DateTimeTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/diagnosiskeys/util/DateTimeTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/util/DateTimeTest.java @@ -1,4 +1,4 @@ -package app.coronawarn.server.services.distribution.diagnosiskeys.util; +package app.coronawarn.server.services.distribution.assembly.diagnosiskeys.util; import static app.coronawarn.server.services.distribution.common.Helpers.buildDiagnosisKeyForDateTime; import static java.util.Collections.emptyList; diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/exposureconfig/ExposureConfigurationMasterFileTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/ExposureConfigurationStructureProviderMasterFileTest.java similarity index 64% rename from services/distribution/src/test/java/app/coronawarn/server/services/distribution/exposureconfig/ExposureConfigurationMasterFileTest.java rename to services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/ExposureConfigurationStructureProviderMasterFileTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/exposureconfig/ExposureConfigurationMasterFileTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/ExposureConfigurationStructureProviderMasterFileTest.java @@ -1,9 +1,9 @@ -package app.coronawarn.server.services.distribution.exposureconfig; +package app.coronawarn.server.services.distribution.assembly.exposureconfig; import static org.junit.jupiter.api.Assertions.assertEquals; -import app.coronawarn.server.services.distribution.exposureconfig.validation.ExposureConfigurationValidator; -import app.coronawarn.server.services.distribution.exposureconfig.validation.ValidationResult; +import app.coronawarn.server.services.distribution.assembly.exposureconfig.validation.ExposureConfigurationValidator; +import app.coronawarn.server.services.distribution.assembly.exposureconfig.validation.ValidationResult; import org.junit.jupiter.api.Test; /** @@ -12,7 +12,7 @@ * * There should never be any deployment when this test is failing. */ -public class ExposureConfigurationMasterFileTest { +public class ExposureConfigurationStructureProviderMasterFileTest { private static final ValidationResult SUCCESS = new ValidationResult(); diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/exposureconfig/ExposureConfigurationProviderTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/ExposureConfigurationStructureProviderProviderTest.java similarity index 87% rename from services/distribution/src/test/java/app/coronawarn/server/services/distribution/exposureconfig/ExposureConfigurationProviderTest.java rename to services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/ExposureConfigurationStructureProviderProviderTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/exposureconfig/ExposureConfigurationProviderTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/ExposureConfigurationStructureProviderProviderTest.java @@ -1,4 +1,4 @@ -package app.coronawarn.server.services.distribution.exposureconfig; +package app.coronawarn.server.services.distribution.assembly.exposureconfig; import static org.junit.jupiter.api.Assertions.assertNotNull; import static org.junit.jupiter.api.Assertions.assertThrows; @@ -6,7 +6,7 @@ import app.coronawarn.server.common.protocols.internal.RiskScoreParameters; import org.junit.jupiter.api.Test; -public class ExposureConfigurationProviderTest { +public class ExposureConfigurationStructureProviderProviderTest { @Test public void okFile() throws UnableToLoadFileException { diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/exposureconfig/validation/ExposureConfigurationValidatorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ExposureConfigurationStructureProviderValidatorTest.java similarity index 87% rename from services/distribution/src/test/java/app/coronawarn/server/services/distribution/exposureconfig/validation/ExposureConfigurationValidatorTest.java rename to services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ExposureConfigurationStructureProviderValidatorTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/exposureconfig/validation/ExposureConfigurationValidatorTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ExposureConfigurationStructureProviderValidatorTest.java @@ -1,18 +1,18 @@ -package app.coronawarn.server.services.distribution.exposureconfig.validation; +package app.coronawarn.server.services.distribution.assembly.exposureconfig.validation; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertThrows; -import app.coronawarn.server.services.distribution.exposureconfig.ExposureConfigurationProvider; -import app.coronawarn.server.services.distribution.exposureconfig.UnableToLoadFileException; -import app.coronawarn.server.services.distribution.exposureconfig.validation.WeightValidationError.ErrorType; +import app.coronawarn.server.services.distribution.assembly.exposureconfig.ExposureConfigurationProvider; +import app.coronawarn.server.services.distribution.assembly.exposureconfig.UnableToLoadFileException; +import app.coronawarn.server.services.distribution.assembly.exposureconfig.validation.WeightValidationError.ErrorType; import java.util.stream.Stream; import org.junit.jupiter.api.Test; import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.Arguments; import org.junit.jupiter.params.provider.MethodSource; -public class ExposureConfigurationValidatorTest { +public class ExposureConfigurationStructureProviderValidatorTest { private static final ValidationResult SUCCESS = new ValidationResult(); diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/exposureconfig/validation/TestWithExpectedResult.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/TestWithExpectedResult.java similarity index 83% rename from services/distribution/src/test/java/app/coronawarn/server/services/distribution/exposureconfig/validation/TestWithExpectedResult.java rename to services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/TestWithExpectedResult.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/exposureconfig/validation/TestWithExpectedResult.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/TestWithExpectedResult.java @@ -1,4 +1,4 @@ -package app.coronawarn.server.services.distribution.exposureconfig.validation; +package app.coronawarn.server.services.distribution.assembly.exposureconfig.validation; public class TestWithExpectedResult { diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/structure/WritableTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/WritableTest.java similarity index 81% rename from services/distribution/src/test/java/app/coronawarn/server/services/distribution/structure/WritableTest.java rename to services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/WritableTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/structure/WritableTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/WritableTest.java @@ -1,11 +1,11 @@ -package app.coronawarn.server.services.distribution.structure; +package app.coronawarn.server.services.distribution.assembly.structure; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertThrows; -import app.coronawarn.server.services.distribution.structure.directory.Directory; -import app.coronawarn.server.services.distribution.structure.directory.DirectoryImpl; -import app.coronawarn.server.services.distribution.structure.util.ImmutableStack; +import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; +import app.coronawarn.server.services.distribution.assembly.structure.directory.DirectoryImpl; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; import java.io.File; import org.junit.jupiter.api.Test; diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/structure/directory/DirectoryTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/DirectoryTest.java similarity index 90% rename from services/distribution/src/test/java/app/coronawarn/server/services/distribution/structure/directory/DirectoryTest.java rename to services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/DirectoryTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/structure/directory/DirectoryTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/DirectoryTest.java @@ -1,13 +1,13 @@ -package app.coronawarn.server.services.distribution.structure.directory; +package app.coronawarn.server.services.distribution.assembly.structure.directory; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertThrows; import static org.mockito.Mockito.spy; import static org.mockito.Mockito.verify; -import app.coronawarn.server.services.distribution.structure.file.File; -import app.coronawarn.server.services.distribution.structure.file.FileImpl; -import app.coronawarn.server.services.distribution.structure.util.ImmutableStack; +import app.coronawarn.server.services.distribution.assembly.structure.file.File; +import app.coronawarn.server.services.distribution.assembly.structure.file.FileImpl; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; import java.io.IOException; import java.util.Set; import org.junit.Rule; diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/structure/directory/IndexDirectoryTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectoryTest.java similarity index 85% rename from services/distribution/src/test/java/app/coronawarn/server/services/distribution/structure/directory/IndexDirectoryTest.java rename to services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectoryTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/structure/directory/IndexDirectoryTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectoryTest.java @@ -1,13 +1,13 @@ -package app.coronawarn.server.services.distribution.structure.directory; +package app.coronawarn.server.services.distribution.assembly.structure.directory; import static org.junit.jupiter.api.Assertions.assertEquals; -import app.coronawarn.server.services.distribution.structure.Writable; -import app.coronawarn.server.services.distribution.structure.file.File; -import app.coronawarn.server.services.distribution.structure.file.FileImpl; -import app.coronawarn.server.services.distribution.structure.functional.Formatter; -import app.coronawarn.server.services.distribution.structure.functional.IndexFunction; -import app.coronawarn.server.services.distribution.structure.util.ImmutableStack; +import app.coronawarn.server.services.distribution.assembly.structure.Writable; +import app.coronawarn.server.services.distribution.assembly.structure.file.File; +import app.coronawarn.server.services.distribution.assembly.structure.file.FileImpl; +import app.coronawarn.server.services.distribution.assembly.structure.functional.Formatter; +import app.coronawarn.server.services.distribution.assembly.structure.functional.IndexFunction; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; import java.io.IOException; import java.util.ArrayList; import java.util.Arrays; diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/structure/directory/decorators/DirectoryDecoratorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/decorators/DirectoryDecoratorTest.java similarity index 63% rename from services/distribution/src/test/java/app/coronawarn/server/services/distribution/structure/directory/decorators/DirectoryDecoratorTest.java rename to services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/decorators/DirectoryDecoratorTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/structure/directory/decorators/DirectoryDecoratorTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/decorators/DirectoryDecoratorTest.java @@ -1,14 +1,14 @@ -package app.coronawarn.server.services.distribution.structure.directory.decorators; +package app.coronawarn.server.services.distribution.assembly.structure.directory.decorators; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.verify; -import app.coronawarn.server.services.distribution.structure.directory.Directory; -import app.coronawarn.server.services.distribution.structure.directory.DirectoryImpl; -import app.coronawarn.server.services.distribution.structure.directory.decorator.DirectoryDecorator; -import app.coronawarn.server.services.distribution.structure.file.File; -import app.coronawarn.server.services.distribution.structure.file.FileImpl; -import app.coronawarn.server.services.distribution.structure.util.ImmutableStack; +import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; +import app.coronawarn.server.services.distribution.assembly.structure.directory.DirectoryImpl; +import app.coronawarn.server.services.distribution.assembly.structure.directory.decorator.DirectoryDecorator; +import app.coronawarn.server.services.distribution.assembly.structure.file.File; +import app.coronawarn.server.services.distribution.assembly.structure.file.FileImpl; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; import org.junit.jupiter.api.Test; public class DirectoryDecoratorTest { @@ -52,7 +52,7 @@ public void checkProxiesAllMethods() { verify(decoree).getFileOnDisk(); } - private class TestDirectoryDecorator extends DirectoryDecorator { + private static class TestDirectoryDecorator extends DirectoryDecorator { protected TestDirectoryDecorator(Directory directory) { super(directory); diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/structure/directory/decorators/IndexingDecoratorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/decorators/IndexingDecoratorTest.java similarity index 77% rename from services/distribution/src/test/java/app/coronawarn/server/services/distribution/structure/directory/decorators/IndexingDecoratorTest.java rename to services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/decorators/IndexingDecoratorTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/structure/directory/decorators/IndexingDecoratorTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/decorators/IndexingDecoratorTest.java @@ -1,13 +1,13 @@ -package app.coronawarn.server.services.distribution.structure.directory.decorators; +package app.coronawarn.server.services.distribution.assembly.structure.directory.decorators; import static app.coronawarn.server.services.distribution.common.Helpers.prepareAndWrite; import static org.junit.jupiter.api.Assertions.assertTrue; -import app.coronawarn.server.services.distribution.structure.directory.Directory; -import app.coronawarn.server.services.distribution.structure.directory.DirectoryImpl; -import app.coronawarn.server.services.distribution.structure.directory.IndexDirectory; -import app.coronawarn.server.services.distribution.structure.directory.IndexDirectoryImpl; -import app.coronawarn.server.services.distribution.structure.directory.decorator.IndexingDecorator; +import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; +import app.coronawarn.server.services.distribution.assembly.structure.directory.DirectoryImpl; +import app.coronawarn.server.services.distribution.assembly.structure.directory.IndexDirectory; +import app.coronawarn.server.services.distribution.assembly.structure.directory.IndexDirectoryImpl; +import app.coronawarn.server.services.distribution.assembly.structure.directory.decorator.IndexingDecorator; import java.io.File; import java.io.FileReader; import java.io.IOException; diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/structure/file/FileTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/file/FileTest.java similarity index 81% rename from services/distribution/src/test/java/app/coronawarn/server/services/distribution/structure/file/FileTest.java rename to services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/file/FileTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/structure/file/FileTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/file/FileTest.java @@ -1,11 +1,11 @@ -package app.coronawarn.server.services.distribution.structure.file; +package app.coronawarn.server.services.distribution.assembly.structure.file; import static org.junit.jupiter.api.Assertions.assertArrayEquals; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertThrows; -import app.coronawarn.server.services.distribution.structure.directory.Directory; -import app.coronawarn.server.services.distribution.structure.directory.DirectoryImpl; +import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; +import app.coronawarn.server.services.distribution.assembly.structure.directory.DirectoryImpl; import java.io.IOException; import java.nio.file.Files; import org.junit.Rule; @@ -15,7 +15,7 @@ public class FileTest { - private byte[] bytes = "World".getBytes(); + private final byte[] bytes = "World".getBytes(); private File file; @Rule diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/structure/file/decorators/FileDecoratorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/file/decorators/FileDecoratorTest.java similarity index 62% rename from services/distribution/src/test/java/app/coronawarn/server/services/distribution/structure/file/decorators/FileDecoratorTest.java rename to services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/file/decorators/FileDecoratorTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/structure/file/decorators/FileDecoratorTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/file/decorators/FileDecoratorTest.java @@ -1,13 +1,13 @@ -package app.coronawarn.server.services.distribution.structure.file.decorators; +package app.coronawarn.server.services.distribution.assembly.structure.file.decorators; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.verify; -import app.coronawarn.server.services.distribution.structure.directory.Directory; -import app.coronawarn.server.services.distribution.structure.directory.DirectoryImpl; -import app.coronawarn.server.services.distribution.structure.file.File; -import app.coronawarn.server.services.distribution.structure.file.decorator.FileDecorator; -import app.coronawarn.server.services.distribution.structure.util.ImmutableStack; +import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; +import app.coronawarn.server.services.distribution.assembly.structure.directory.DirectoryImpl; +import app.coronawarn.server.services.distribution.assembly.structure.file.File; +import app.coronawarn.server.services.distribution.assembly.structure.file.decorator.FileDecorator; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; import org.junit.jupiter.api.Test; public class FileDecoratorTest { @@ -45,7 +45,7 @@ public void checkProxiesAllMethods() { verify(decoree).getFileOnDisk(); } - private class TestFileDecorator extends FileDecorator { + private static class TestFileDecorator extends FileDecorator { protected TestFileDecorator(File file) { super(file); diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/structure/file/decorators/SigningDecoratorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/file/decorators/SigningDecoratorTest.java similarity index 84% rename from services/distribution/src/test/java/app/coronawarn/server/services/distribution/structure/file/decorators/SigningDecoratorTest.java rename to services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/file/decorators/SigningDecoratorTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/structure/file/decorators/SigningDecoratorTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/file/decorators/SigningDecoratorTest.java @@ -1,16 +1,16 @@ -package app.coronawarn.server.services.distribution.structure.file.decorators; +package app.coronawarn.server.services.distribution.assembly.structure.file.decorators; import static app.coronawarn.server.services.distribution.common.Helpers.prepareAndWrite; import static org.junit.jupiter.api.Assertions.assertArrayEquals; import static org.junit.jupiter.api.Assertions.assertTrue; import app.coronawarn.server.common.protocols.internal.SignedPayload; -import app.coronawarn.server.services.distribution.crypto.CryptoProvider; -import app.coronawarn.server.services.distribution.structure.directory.Directory; -import app.coronawarn.server.services.distribution.structure.directory.DirectoryImpl; -import app.coronawarn.server.services.distribution.structure.file.File; -import app.coronawarn.server.services.distribution.structure.file.FileImpl; -import app.coronawarn.server.services.distribution.structure.file.decorator.SigningDecorator; +import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; +import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; +import app.coronawarn.server.services.distribution.assembly.structure.directory.DirectoryImpl; +import app.coronawarn.server.services.distribution.assembly.structure.file.File; +import app.coronawarn.server.services.distribution.assembly.structure.file.FileImpl; +import app.coronawarn.server.services.distribution.assembly.structure.file.decorator.SigningDecorator; import java.io.ByteArrayInputStream; import java.io.IOException; import java.io.InputStream; diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/common/Helpers.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/common/Helpers.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/common/Helpers.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/common/Helpers.java @@ -1,8 +1,8 @@ package app.coronawarn.server.services.distribution.common; import app.coronawarn.server.common.persistence.domain.DiagnosisKey; -import app.coronawarn.server.services.distribution.structure.directory.Directory; -import app.coronawarn.server.services.distribution.structure.util.ImmutableStack; +import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; import java.time.LocalDateTime; import java.time.ZoneOffset; diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccessTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccessTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccessTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccessTest.java @@ -20,11 +20,11 @@ public class ObjectStoreAccessTest { - private Logger logger = LoggerFactory.getLogger(this.getClass()); + private final Logger logger = LoggerFactory.getLogger(this.getClass()); - private String testRunId = "testing/cwa/" + UUID.randomUUID().toString() + "/"; + private final String testRunId = "testing/cwa/" + UUID.randomUUID().toString() + "/"; - private String textFile = "objectstore/store-test-file"; + private final String textFile = "objectstore/store-test-file"; @Autowired private ObjectStoreAccess objectStoreAccess; diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherTest.java @@ -23,11 +23,11 @@ @TestInstance(Lifecycle.PER_CLASS) public class S3PublisherTest { - private String testRunId = "testing/cwa/" + UUID.randomUUID().toString() + "/"; + private final String testRunId = "testing/cwa/" + UUID.randomUUID().toString() + "/"; - private String rootTestFolder = "objectstore/publisher/"; + private final String rootTestFolder = "objectstore/publisher/"; - private String exampleFile = rootTestFolder + "rootfile"; + private final String exampleFile = rootTestFolder + "rootfile"; @Autowired private S3Publisher s3Publisher; diff --git a/services/distribution/src/test/resources/application.properties b/services/distribution/src/test/resources/application.properties --- a/services/distribution/src/test/resources/application.properties +++ b/services/distribution/src/test/resources/application.properties @@ -3,10 +3,9 @@ logging.level.org.springframework=off logging.level.root=off spring.main.banner-mode=off -app.coronawarn.server.services.distribution.retention_days=14 -app.coronawarn.server.services.distribution.version=v1 -app.coronawarn.server.services.distribution.paths.output=out -app.coronawarn.server.services.distribution.paths.privatekey=classpath:certificates/client/private.pem -app.coronawarn.server.services.distribution.paths.certificate=classpath:certificates/chain/certificate.crt +services.distribution.retention_days=14 +services.distribution.paths.output=out +services.distribution.paths.privatekey=classpath:certificates/client/private.pem +services.distribution.paths.certificate=classpath:certificates/chain/certificate.crt spring.flyway.enabled=false

DiagnosisKeyDistributionRunner deletes exposure configuration ``DiagnosisKeyDistributionRunner`` deletes the files written by ``ExposureConfigurationDistributionRunner`` before they are published.

corona-warn-app/cwa-server

corona-warn-app__cwa-server-135

8655863c4c989c437ad9b5ef84c7e2afb699be8d

diff --git a/services/submission/pom.xml b/services/submission/pom.xml --- a/services/submission/pom.xml +++ b/services/submission/pom.xml @@ -22,6 +22,12 @@ <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-security</artifactId> </dependency> + <dependency> + <groupId>org.apache.commons</groupId> + <artifactId>commons-math3</artifactId> + <version>3.2</version> + <scope>compile</scope> + </dependency> </dependencies> </project> \ No newline at end of file diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/SubmissionController.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/SubmissionController.java --- a/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/SubmissionController.java +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/SubmissionController.java @@ -5,15 +5,23 @@ import app.coronawarn.server.common.protocols.internal.SubmissionPayload; import app.coronawarn.server.services.submission.verification.TanVerifier; import java.util.Collection; +import java.util.concurrent.Executors; +import java.util.concurrent.ForkJoinPool; +import java.util.concurrent.ScheduledExecutorService; +import java.util.concurrent.TimeUnit; import java.util.stream.Collectors; +import org.apache.commons.math3.distribution.PoissonDistribution; import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.beans.factory.annotation.Value; import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; +import org.springframework.util.StopWatch; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RequestHeader; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; +import org.springframework.web.context.request.async.DeferredResult; @RestController @RequestMapping("/version/v1") @@ -24,27 +32,57 @@ public class SubmissionController { */ public static final String SUBMISSION_ROUTE = "/diagnosis-keys"; + @Value("${services.submission.fake_delay_moving_average_samples}") + private Double fakeDelayMovingAverageSamples; + + // Exponential moving average of the last N real request durations (in ms), where + // N = fakeDelayMovingAverageSamples. + @Value("${services.submission.initial_fake_delay_milliseconds}") + private Double fakeDelay; + @Autowired private DiagnosisKeyService diagnosisKeyService; @Autowired private TanVerifier tanVerifier; + private ScheduledExecutorService scheduledExecutor = Executors.newSingleThreadScheduledExecutor(); + private ForkJoinPool forkJoinPool = ForkJoinPool.commonPool(); + @PostMapping(SUBMISSION_ROUTE) - public ResponseEntity<Void> submitDiagnosisKey( + public DeferredResult<ResponseEntity<Void>> submitDiagnosisKey( @RequestBody SubmissionPayload exposureKeys, @RequestHeader(value = "cwa-fake") Integer fake, @RequestHeader(value = "cwa-authorization") String tan) { + final DeferredResult<ResponseEntity<Void>> deferredResult = new DeferredResult<>(); if (fake != 0) { - return buildSuccessResponseEntity(); - } - if (!this.tanVerifier.verifyTan(tan)) { - return buildTanInvalidResponseEntity(); + setFakeDeferredResult(deferredResult); + } else { + setRealDeferredResult(deferredResult, exposureKeys, tan); } + return deferredResult; + } - persistDiagnosisKeysPayload(exposureKeys); + private void setFakeDeferredResult(DeferredResult<ResponseEntity<Void>> deferredResult) { + long delay = new PoissonDistribution(fakeDelay).sample(); + scheduledExecutor.schedule(() -> deferredResult.setResult(buildSuccessResponseEntity()), + delay, TimeUnit.MILLISECONDS); + } - return buildSuccessResponseEntity(); + private void setRealDeferredResult(DeferredResult<ResponseEntity<Void>> deferredResult, + SubmissionPayload exposureKeys, String tan) { + forkJoinPool.submit(() -> { + StopWatch stopWatch = new StopWatch(); + stopWatch.start(); + if (!this.tanVerifier.verifyTan(tan)) { + deferredResult.setResult(buildTanInvalidResponseEntity()); + } else { + persistDiagnosisKeysPayload(exposureKeys); + deferredResult.setResult(buildSuccessResponseEntity()); + } + stopWatch.stop(); + updateFakeDelay(stopWatch.getTotalTimeMillis()); + }); } /** @@ -74,4 +112,8 @@ private void persistDiagnosisKeysPayload(SubmissionPayload protoBufDiagnosisKeys this.diagnosisKeyService.saveDiagnosisKeys(diagnosisKeys); } + + private synchronized void updateFakeDelay(long realRequestDuration) { + fakeDelay = fakeDelay + (1 / fakeDelayMovingAverageSamples) * (realRequestDuration - fakeDelay); + } } diff --git a/services/submission/src/main/resources/application.properties b/services/submission/src/main/resources/application.properties --- a/services/submission/src/main/resources/application.properties +++ b/services/submission/src/main/resources/application.properties @@ -1,5 +1,10 @@ logging.level.org.springframework.web=INFO +# The initial value of the moving average for fake request delays. +services.submission.initial_fake_delay_milliseconds=10 +# The number of samples for the calculation of the moving average for fake request delays. +services.submission.fake_delay_moving_average_samples=10 + spring.flyway.locations=classpath:db/migration/h2 spring.flyway.enabled=true spring.jpa.hibernate.ddl-auto=validate

diff --git a/services/submission/src/test/resources/application.properties b/services/submission/src/test/resources/application.properties --- a/services/submission/src/test/resources/application.properties +++ b/services/submission/src/test/resources/application.properties @@ -3,4 +3,7 @@ logging.level.org.springframework=off logging.level.root=off spring.main.banner-mode=off +services.submission.initial_fake_delay_milliseconds=1 +services.submission.fake_delay_moving_average_samples=1 + spring.flyway.enabled=false

Submission Service: Enable waiting for Fake Requests When fake requests are send to the submission service, ensure that the duration of the fake requests take as long as normal requests, so attackers sniffing the traffic are unable to distinguish between fake/normal requests.

corona-warn-app/cwa-server

corona-warn-app__cwa-server-232

9a5ae8bbf8872b63578dcca32b3258c012a63866

diff --git a/.env b/.env --- a/.env +++ b/.env @@ -10,9 +10,9 @@ POSTGRES_PASSWORD=postgres [email protected] PGADMIN_DEFAULT_PASSWORD=password -# Docker Compose MinIO settings -MINIO_ACCESS_KEY=minioadmin -MINIO_SECRET_KEY=minioadmin +# Docker Compose objectstore settings +OBJECTSTORE_ACCESSKEY=accessKey1 +OBJECTSTORE_SECRETKEY=verySecretKey1 # Docker Compose Secrets settings SECRET_PRIVATE=file:/secrets/private.pem diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ If you want to use Docker-based deployment, you need to install Docker on your l #### Running the Full CWA Backend Using Docker Compose -For your convenience, a full setup including the generation of test data has been prepared using [Docker Compose](https://docs.docker.com/compose/reference/overview/). To build the backend services, run ```docker-compose build``` in the repository's root directory. A default configuration file can be found under ```.env```in the root folder of the repository. The default values for the local Postgres and MinIO-build should be changed in this file before docker-compose is run. +For your convenience, a full setup including the generation of test data has been prepared using [Docker Compose](https://docs.docker.com/compose/reference/overview/). To build the backend services, run ```docker-compose build``` in the repository's root directory. A default configuration file can be found under ```.env```in the root folder of the repository. The default values for the local Postgres and Zenko Cloudserver should be changed in this file before docker-compose is run. Once the services are built, you can start the whole backend using ```docker-compose up```. The distribution service runs once and then finishes. If you want to trigger additional distribution runs, run ```docker-compose start distribution```. @@ -57,11 +57,11 @@ The docker-compose contains the following services: Service | Description | Endpoint and Default Credentials --------------|-------------|----------- -submission | The Corona-Warn-App submission service | http://localhost:8080 -distribution | The Corona-Warn-App distribution service | NO ENDPOINT -postgres | A [postgres] database installation | postgres:5432 <br> Username: postgres <br> Password: postgres -pgadmin | A [pgadmin](https://www.pgadmin.org/) installation for the postgres database | http://localhost:8081 <br> Username: [email protected] <br> Password: password -minio | [MinIO] is an S3-compliant object store | http://localhost:8082/ <br> Access key: minioadmin <br> Secret key: minioadmin +submission | The Corona-Warn-App submission service | http://localhost:8000 +distribution | The Corona-Warn-App distribution service | NO ENDPOINT +postgres | A [postgres] database installation | postgres:8001 <br> Username: postgres <br> Password: postgres +pgadmin | A [pgadmin](https://www.pgadmin.org/) installation for the postgres database | http://localhost:8002 <br> Username: [email protected] <br> Password: password +cloudserver | [Zenko CloudServer] is a S3-compliant object store | http://localhost:8003/ <br> Access key: accessKey1 <br> Secret key: verySecretKey1 #### Running Single CWA Services Using Docker @@ -89,7 +89,7 @@ To prepare your machine to run the CWA project locally, we recommend that you fi * Minimum JDK Version 11: [OpenJDK](https://openjdk.java.net/) / [SapMachine](https://sap.github.io/SapMachine/) * [Maven 3.6](https://maven.apache.org/) * [Postgres] -* [MinIO] +* [Zenko CloudServer] #### Configure @@ -167,8 +167,8 @@ The following public repositories are currently available for the Corona-Warn-Ap [cwa-documentation]: https://github.com/corona-warn-app/cwa-documentation [cwa-server]: https://github.com/corona-warn-app/cwa-server [Postgres]: https://www.postgresql.org/ -[MinIO]: https://min.io/ [HSQLDB]: http://hsqldb.org/ +[Zenko CloudServer]: https://github.com/scality/cloudserver ## Licensing diff --git a/THIRD-PARTY-NOTICES b/THIRD-PARTY-NOTICES --- a/THIRD-PARTY-NOTICES +++ b/THIRD-PARTY-NOTICES @@ -74,9 +74,15 @@ Component: Spring Boot Licensor: VMWare Inc. Website: https://spring.io/ License: Apache License 2.0 + +Component: Zenko CloudServer +Licensor: Zenko +Website: https://github.com/scality/cloudserver +License: Apache License 2.0 + -------------------------------------------------------------------------------- Apache License 2.0 (Commons IO, Commons Math 3, flyway, JSON-Simple, -Maven, MinIO Object Storage, snakeyaml, Spring Boot) +Maven, MinIO Object Storage, snakeyaml, Spring Boot, Zenko CloudServer) Apache License Version 2.0, January 2004 diff --git a/create-bucket.sh b/create-bucket.sh new file mode 100755 --- /dev/null +++ b/create-bucket.sh @@ -0,0 +1,6 @@ +# Prerequisite - install aws cli + +export AWS_ACCESS_KEY_ID=accessKey1 +export AWS_SECRET_ACCESS_KEY=verySecretKey1 + +aws s3api create-bucket --bucket cwa --endpoint-url http://localhost:8000 --acl public-read diff --git a/docker-compose.yml b/docker-compose.yml --- a/docker-compose.yml +++ b/docker-compose.yml @@ -7,49 +7,46 @@ services: depends_on: - postgres ports: - - "8080:8080" + - "8000:8080" environment: - SPRING_PROFILES_ACTIVE: cloud,dev + SPRING_PROFILES_ACTIVE: dev POSTGRESQL_SERVICE_PORT: '5432' POSTGRESQL_SERVICE_HOST: postgres POSTGRESQL_DATABASE: ${POSTGRES_DB} POSTGRESQL_PASSWORD: ${POSTGRES_PASSWORD} POSTGRESQL_USER: ${POSTGRES_USER} - networks: - - cwa distribution: build: context: ./ dockerfile: ./services/distribution/Dockerfile depends_on: - postgres - - minio + - objectstore + - create-bucket environment: - SPRING_PROFILES_ACTIVE: cloud,dev,testdata + SPRING_PROFILES_ACTIVE: dev,testdata POSTGRESQL_SERVICE_PORT: '5432' POSTGRESQL_SERVICE_HOST: postgres POSTGRESQL_DATABASE: ${POSTGRES_DB} POSTGRESQL_PASSWORD: ${POSTGRES_PASSWORD} POSTGRESQL_USER: ${POSTGRES_USER} - # Settings for the S3 compatible MinIO object storage - CWA_OBJECTSTORE_ACCESSKEY: ${MINIO_ACCESS_KEY} - CWA_OBJECTSTORE_SECRETKEY: ${MINIO_SECRET_KEY} - CWA_OBJECTSTORE_ENDPOINT: http://minio + # Settings for the S3 compatible objectstore + CWA_OBJECTSTORE_ACCESSKEY: ${OBJECTSTORE_ACCESSKEY} + CWA_OBJECTSTORE_SECRETKEY: ${OBJECTSTORE_SECRETKEY} + CWA_OBJECTSTORE_ENDPOINT: http://objectstore CWA_OBJECTSTORE_BUCKET: cwa - CWA_OBJECTSTORE_PORT: 9000 + CWA_OBJECTSTORE_PORT: 8000 services.distribution.paths.output: /tmp/distribution # Settings for cryptographic artefacts VAULT_FILESIGNING_SECRET: ${SECRET_PRIVATE} VAULT_FILESIGNING_CERT: ${SECRET_CERTIFICATE} volumes: - ./docker-compose-test-secrets:/secrets - networks: - - cwa postgres: image: postgres:9.6 restart: always ports: - - "5432:5432" + - "8001:5432" environment: PGDATA: /data/postgres POSTGRES_DB: ${POSTGRES_DB} @@ -57,41 +54,39 @@ services: POSTGRES_PASSWORD: ${POSTGRES_PASSWORD} volumes: - postgres_volume:/data/postgres - networks: - - cwa pgadmin: container_name: pgadmin_container image: dpage/pgadmin4 volumes: - pgadmin_volume:/root/.pgadmin ports: - - "8081:80" + - "8002:80" restart: unless-stopped - networks: - - cwa depends_on: - postgres environment: PGADMIN_DEFAULT_EMAIL: ${PGADMIN_DEFAULT_EMAIL} PGADMIN_DEFAULT_PASSWORD: ${PGADMIN_DEFAULT_PASSWORD} - minio: - image: "minio/minio" + objectstore: + image: "zenko/cloudserver" volumes: - - minio_volume:/data + - objectstore_volume:/data ports: - - "8082:9000" + - "8003:8000" environment: - MINIO_ACCESS_KEY: ${MINIO_ACCESS_KEY} - MINIO_SECRET_KEY: ${MINIO_SECRET_KEY} - entrypoint: sh - command: -c 'mkdir -p /data/cwa && minio server /data' - networks: - - cwa + ENDPOINT: objectstore + REMOTE_MANAGEMENT_DISABLE: 1 + SCALITY_ACCESS_KEY_ID: ${OBJECTSTORE_ACCESSKEY} + SCALITY_SECRET_ACCESS_KEY: ${OBJECTSTORE_SECRETKEY} + create-bucket: + image: amazon/aws-cli + environment: + - AWS_ACCESS_KEY_ID=${OBJECTSTORE_ACCESSKEY} + - AWS_SECRET_ACCESS_KEY=${OBJECTSTORE_SECRETKEY} + command: s3api create-bucket --bucket cwa --endpoint-url http://objectstore:8000 --acl public-read + depends_on: + - objectstore volumes: - logvolume01: {} - minio_volume: postgres_volume: pgadmin_volume: -networks: - cwa: - driver: bridge \ No newline at end of file + objectstore_volume: diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccess.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccess.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccess.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccess.java @@ -59,10 +59,11 @@ public class ObjectStoreAccess { private static final String DEFAULT_REGION = "eu-west-1"; - private final String bucket; + private final boolean isSetPublicReadAclOnPutObject; - private MinioClient client; + private final String bucket; + private final MinioClient client; /** * Constructs an {@link ObjectStoreAccess} instance for communication with the specified object @@ -79,6 +80,7 @@ public ObjectStoreAccess(ObjectStoreConfigurationProperties configurationPropert this.client = createClient(configurationProperties); this.bucket = configurationProperties.getBucket(); + this.isSetPublicReadAclOnPutObject = configurationProperties.isSetPublicReadAclOnPutObject(); if (!this.client.bucketExists(this.bucket)) { throw new IllegalArgumentException("Supplied bucket does not exist " + bucket); @@ -116,10 +118,7 @@ private boolean isSsl(ObjectStoreConfigurationProperties configurationProperties public void putObject(LocalFile localFile) throws IOException, GeneralSecurityException, MinioException { String s3Key = localFile.getS3Key(); - - - var options = new PutObjectOptions(localFile.getFile().toFile().length(), -1); - options.setHeaders(createMetadataFor(localFile)); + PutObjectOptions options = createOptionsFor(localFile); logger.info("... uploading " + s3Key); this.client.putObject(bucket, s3Key, localFile.getFile().toString(), options); @@ -158,7 +157,7 @@ public List<DeleteError> deleteObjectsWithPrefix(String prefix) */ public List<S3Object> getObjectsWithPrefix(String prefix) throws IOException, GeneralSecurityException, MinioException { - var objects = this.client.listObjects(bucket, prefix, true, true, false); + var objects = this.client.listObjects(bucket, prefix, true); var list = new ArrayList<S3Object>(); for (Result<Item> item : objects) { @@ -168,7 +167,14 @@ public List<S3Object> getObjectsWithPrefix(String prefix) return list; } - private Map<String, String> createMetadataFor(LocalFile file) { - return Map.of("cwa.hash", file.getHash()); + private PutObjectOptions createOptionsFor(LocalFile file) { + var options = new PutObjectOptions(file.getFile().toFile().length(), -1); + + if (this.isSetPublicReadAclOnPutObject) { + options.setHeaders(Map.of("x-amz-acl", "public-read")); + } + + return options; } + } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreConfigurationProperties.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreConfigurationProperties.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreConfigurationProperties.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreConfigurationProperties.java @@ -34,6 +34,16 @@ public class ObjectStoreConfigurationProperties { private String bucket; + private boolean setPublicReadAclOnPutObject; + + public boolean isSetPublicReadAclOnPutObject() { + return setPublicReadAclOnPutObject; + } + + public void setSetPublicReadAclOnPutObject(boolean setPublicReadAclOnPutObject) { + this.setPublicReadAclOnPutObject = setPublicReadAclOnPutObject; + } + public int getPort() { return port; } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3Object.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3Object.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3Object.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3Object.java @@ -38,6 +38,9 @@ public class S3Object { */ private Map<String, String> metadata = new HashMap<>(); + /** The e-Tag of this S3 Object. */ + private String etag; + /** * Constructs a new S3Object for the given object name. * @@ -55,6 +58,10 @@ public Map<String, String> getMetadata() { return metadata; } + public String getEtag() { + return etag; + } + /** * Returns a new instance of an S3Object based on the given item. * @@ -68,6 +75,8 @@ public static S3Object of(Item item) { s3Object.metadata = item.userMetadata(); } + s3Object.etag = item.etag().replaceAll("\"",""); + return s3Object; } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/LocalFile.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/LocalFile.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/LocalFile.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/LocalFile.java @@ -19,26 +19,35 @@ package app.coronawarn.server.services.distribution.objectstore.publish; +import com.google.common.io.BaseEncoding; import java.io.IOException; import java.nio.file.Files; import java.nio.file.Path; -import java.security.MessageDigest; -import java.security.NoSuchAlgorithmException; -import java.util.Base64; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.util.DigestUtils; /** * Represents a file, which is subject for publishing to S3. */ public abstract class LocalFile { - /** the path to the file to be represented. */ + private static final Logger logger = LoggerFactory.getLogger(LocalFile.class); + + /** + * the path to the file to be represented. + */ private final Path file; - /** the assigned S3 key. */ + /** + * the assigned S3 key. + */ private final String s3Key; - /** the hash of this file. */ - private final String hash; + /** + * the etag of this file. + */ + private final String etag; /** * Constructs a new file representing a file on the disk. @@ -48,7 +57,7 @@ public abstract class LocalFile { */ public LocalFile(Path file, Path basePath) { this.file = file; - this.hash = hash(); + this.etag = computeS3ETag(); this.s3Key = createS3Key(file, basePath); } @@ -56,23 +65,25 @@ public String getS3Key() { return s3Key; } - public String getHash() { - return hash; + public String getEtag() { + return etag; } public Path getFile() { return file; } - private String hash() { + private String computeS3ETag() { try { - MessageDigest digester = MessageDigest.getInstance("SHA-256"); - digester.update(Files.readAllBytes(file)); + String md5 = DigestUtils.md5DigestAsHex(Files.readAllBytes(file)); + byte[] raw = BaseEncoding.base16().decode(md5.toUpperCase()); - return Base64.getEncoder().encodeToString(digester.digest()); - } catch (IOException | NoSuchAlgorithmException e) { - throw new RuntimeException("Unable to compute hashes due to ", e); + return DigestUtils.md5DigestAsHex(raw) + "-1"; + } catch (IOException e) { + logger.warn("Unable to compute E-Tag", e); } + + return ""; } protected String createS3Key(Path file, Path rootFolder) { diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/LocalIndexFile.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/LocalIndexFile.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/LocalIndexFile.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/LocalIndexFile.java @@ -51,9 +51,7 @@ public LocalIndexFile(Path file, Path basePath) { @Override protected String createS3Key(Path file, Path rootFolder) { String s3Key = super.createS3Key(file, rootFolder); - - // Deactivate index mapping for now - // return s3Key.substring(0, s3Key.length() - INDEX_FILE_SUFFIX.length()); - return s3Key; + + return s3Key.substring(0, s3Key.length() - INDEX_FILE_SUFFIX.length()); } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/PublishedFileSet.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/PublishedFileSet.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/PublishedFileSet.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/PublishedFileSet.java @@ -62,15 +62,7 @@ public boolean isNotYetPublished(LocalFile file) { return true; } - return !hasSameHashAsPublishedFile(file); - } - - private boolean hasSameHashAsPublishedFile(LocalFile file) { - var metaData = s3Objects.get(file.getS3Key()).getMetadata(); - - String s3FileHash = metaData.get("X-Amz-Meta-Cwa.hash"); - - return file.getHash().equals(s3FileHash); + return !file.getEtag().equals(published.getEtag()); } } diff --git a/services/distribution/src/main/java/io/minio/messages/Item.java b/services/distribution/src/main/java/io/minio/messages/Item.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/java/io/minio/messages/Item.java @@ -0,0 +1,132 @@ +/* + * MinIO Java SDK for Amazon S3 Compatible Cloud Storage, (C) 2015 MinIO, Inc. + * + * 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 + * + * http://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. + */ + +package io.minio.messages; + +import java.time.ZonedDateTime; +import java.util.Map; +import org.simpleframework.xml.Element; +import org.simpleframework.xml.Root; + +/* ---------------------------------------------------------------- + * Copied from MinIO due to patch not yet available. + * https://github.com/minio/minio-java/pull/921 + * Waiting for new release version: 7.0.3 + * ---------------------------------------------------------------- + */ + +/** + * Helper class to denote Object information in {@link ListBucketResult} and {@link + * ListBucketResultV1}. + */ +@Root(name = "Contents", strict = false) +public class Item { + + @Element(name = "Key") + private String objectName; + + @Element(name = "LastModified") + private ResponseDate lastModified; + + @Element(name = "ETag") + private String etag; + + @Element(name = "Size") + private long size; + + @Element(name = "StorageClass") + private String storageClass; + + @Element(name = "Owner", required = false) /* Monkeypatch: Owner should be optional */ + private Owner owner; + + @Element(name = "UserMetadata", required = false) + private Metadata userMetadata; + + private boolean isDir = false; + + public Item() { + + } + + /** + * Constructs a new Item for prefix i.e. directory. + */ + public Item(String prefix) { + this.objectName = prefix; + this.isDir = true; + } + + /** + * Returns object name. + */ + public String objectName() { + return objectName; + } + + /** + * Returns last modified time of the object. + */ + public ZonedDateTime lastModified() { + return lastModified.zonedDateTime(); + } + + /** + * Returns ETag of the object. + */ + public String etag() { + return etag; + } + + /** + * Returns object size. + */ + public long size() { + return size; + } + + /** + * Returns storage class of the object. + */ + public String storageClass() { + return storageClass; + } + + /** + * Returns owner object of given the object. + */ + public Owner owner() { + return owner; + } + + /** + * Returns user metadata. This is MinIO specific extension to ListObjectsV2. + */ + public Map<String, String> userMetadata() { + if (userMetadata == null) { + return null; + } + + return userMetadata.get(); + } + + /** + * Returns whether the object is a directory or not. + */ + public boolean isDir() { + return isDir; + } +} diff --git a/services/distribution/src/main/resources/application-cloud.properties b/services/distribution/src/main/resources/application-cloud.properties --- a/services/distribution/src/main/resources/application-cloud.properties +++ b/services/distribution/src/main/resources/application-cloud.properties @@ -13,3 +13,4 @@ cwa.objectstore.secretKey=${CWA_OBJECTSTORE_SECRETKEY} cwa.objectstore.endpoint=${CWA_OBJECTSTORE_ENDPOINT} cwa.objectstore.bucket=${CWA_OBJECTSTORE_BUCKET} cwa.objectstore.port=${CWA_OBJECTSTORE_PORT} +cwa.objectstore.set-public-read-acl-on-put-object=false diff --git a/services/distribution/src/main/resources/application.properties b/services/distribution/src/main/resources/application.properties --- a/services/distribution/src/main/resources/application.properties +++ b/services/distribution/src/main/resources/application.properties @@ -8,11 +8,12 @@ services.distribution.paths.privatekey=${VAULT_FILESIGNING_SECRET} services.distribution.paths.certificate=${VAULT_FILESIGNING_CERT} # Configuration for the S3 compatible object storage hosted by Telekom in Germany -cwa.objectstore.accessKey=${CWA_OBJECTSTORE_ACCESSKEY:minioadmin} -cwa.objectstore.secretKey=${CWA_OBJECTSTORE_SECRETKEY:minioadmin} -cwa.objectstore.endpoint=${CWA_OBJECTSTORE_ENDPOINT:http\://localhost\:9000} +cwa.objectstore.access-key=${CWA_OBJECTSTORE_ACCESSKEY:accessKey1} +cwa.objectstore.secret-key=${CWA_OBJECTSTORE_SECRETKEY:verySecretKey1} +cwa.objectstore.endpoint=${CWA_OBJECTSTORE_ENDPOINT:http\://localhost\:8003} cwa.objectstore.bucket=${CWA_OBJECTSTORE_BUCKET:cwa} -cwa.objectstore.port=${CWA_OBJECTSTORE_PORT:9000} +cwa.objectstore.port=${CWA_OBJECTSTORE_PORT:8003} +cwa.objectstore.set-public-read-acl-on-put-object=true # Postgres configuration spring.jpa.hibernate.ddl-auto=validate

diff --git a/services/distribution/src/test/resources/application.properties b/services/distribution/src/test/resources/application.properties --- a/services/distribution/src/test/resources/application.properties +++ b/services/distribution/src/test/resources/application.properties @@ -14,9 +14,9 @@ spring.flyway.locations=classpath:db/migration/h2 spring.jpa.hibernate.ddl-auto=validate # S3 object store configuration -cwa.objectstore.accessKey=${CWA_OBJECTSTORE_ACCESSKEY:minioadmin} -cwa.objectstore.secretKey=${CWA_OBJECTSTORE_SECRETKEY:minioadmin} -cwa.objectstore.endpoint=${CWA_OBJECTSTORE_ENDPOINT:http\://localhost\:9000} +cwa.objectstore.access-key=${CWA_OBJECTSTORE_ACCESSKEY:accessKey1} +cwa.objectstore.secret-key=${CWA_OBJECTSTORE_SECRETKEY:verySecretKey1} +cwa.objectstore.endpoint=${CWA_OBJECTSTORE_ENDPOINT:http\://localhost\:8003} cwa.objectstore.bucket=${CWA_OBJECTSTORE_BUCKET:cwa} -cwa.objectstore.port=${CWA_OBJECTSTORE_PORT:9000} - +cwa.objectstore.port=${CWA_OBJECTSTORE_PORT:8003} +cwa.objectstore.set-public-read-acl-on-put-object=true diff --git a/services/distribution/src/test/resources/objectstore/publisher/version/v1/indexfile b/services/distribution/src/test/resources/objectstore/publisher/version/v1/index similarity index 100% rename from services/distribution/src/test/resources/objectstore/publisher/version/v1/indexfile rename to services/distribution/src/test/resources/objectstore/publisher/version/v1/index

Open MinIO read access ## Current Implementation Receiving files from local MinIO requires access key and secret key. ## Suggested Enhancement Add a security policy to the MinIO configuration to only protect write access, but have open read access. ## Expected Benefits Mobile colleagues can use local setup for end-to-end testing.

corona-warn-app/cwa-server

corona-warn-app__cwa-server-260

218e0c75d3890fd6c1166fc63ce287f3b9d51fa7

diff --git a/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/risk_score_classification.proto b/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/risk_score_classification.proto new file mode 100644 --- /dev/null +++ b/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/risk_score_classification.proto @@ -0,0 +1,15 @@ +syntax = "proto3"; +package app.coronawarn.server.common.protocols.internal; +option java_package = "app.coronawarn.server.common.protocols.internal"; +option java_multiple_files = true; + +message RiskScoreClassification { + repeated RiskScoreClass risk_classes = 1; +} + +message RiskScoreClass { + string label = 1; + int32 min = 2; + int32 max = 3; + string url = 4; +} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/ExposureConfigurationProvider.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/ExposureConfigurationProvider.java similarity index 60% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/ExposureConfigurationProvider.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/ExposureConfigurationProvider.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/ExposureConfigurationProvider.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/ExposureConfigurationProvider.java @@ -17,18 +17,9 @@ * under the License. */ -package app.coronawarn.server.services.distribution.assembly.exposureconfig; +package app.coronawarn.server.services.distribution.assembly.appconfig; import app.coronawarn.server.common.protocols.internal.RiskScoreParameters; -import app.coronawarn.server.common.protocols.internal.RiskScoreParameters.Builder; -import app.coronawarn.server.services.distribution.assembly.exposureconfig.parsing.YamlConstructorForProtoBuf; -import java.io.IOException; -import java.io.InputStream; -import org.springframework.core.io.ClassPathResource; -import org.springframework.core.io.Resource; -import org.yaml.snakeyaml.Yaml; -import org.yaml.snakeyaml.error.YAMLException; -import org.yaml.snakeyaml.introspector.BeanAccess; /** * Provides the Exposure Configuration based on a file in the file system.<br> The existing file must be a valid YAML @@ -62,21 +53,6 @@ public static RiskScoreParameters readMasterFile() throws UnableToLoadFileExcept * @throws UnableToLoadFileException when the file/transformation did not succeed */ public static RiskScoreParameters readFile(String path) throws UnableToLoadFileException { - Yaml yaml = new Yaml(new YamlConstructorForProtoBuf()); - yaml.setBeanAccess(BeanAccess.FIELD); /* no setters on RiskScoreParameters available */ - - Resource riskScoreParametersResource = new ClassPathResource(path); - try (InputStream inputStream = riskScoreParametersResource.getInputStream()) { - Builder loaded = yaml.loadAs(inputStream, RiskScoreParameters.newBuilder().getClass()); - if (loaded == null) { - throw new UnableToLoadFileException(path); - } - - return loaded.build(); - } catch (YAMLException e) { - throw new UnableToLoadFileException("Parsing failed", e); - } catch (IOException e) { - throw new UnableToLoadFileException("Failed to load file " + path, e); - } + return YamlLoader.loadYamlIntoProtobufBuilder(path, RiskScoreParameters.Builder.class).build(); } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/RiskScoreClassificationProvider.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/RiskScoreClassificationProvider.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/RiskScoreClassificationProvider.java @@ -0,0 +1,58 @@ +/* + * Corona-Warn-App + * + * SAP SE and all other contributors / + * copyright owners license this file to you 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 + * + * http://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. + */ + +package app.coronawarn.server.services.distribution.assembly.appconfig; + +import app.coronawarn.server.common.protocols.internal.RiskScoreClassification; + +/** + * Provides the risk score classification based on a file on the file system. The existing file must be a valid YAML + * file, and must match the specification of the proto file risk_score_classification.proto. + */ +public class RiskScoreClassificationProvider { + + private RiskScoreClassificationProvider() { + } + + /** + * The location of the risk score classification master file. + */ + public static final String MASTER_FILE = "risk-score-classification/master.yaml"; + + /** + * Fetches the master configuration as a {@link RiskScoreClassification} instance. + * + * @return the risk score classification as {@link RiskScoreClassification} + * @throws UnableToLoadFileException when the file/transformation did not succeed + */ + public static RiskScoreClassification readMasterFile() throws UnableToLoadFileException { + return readFile(MASTER_FILE); + } + + /** + * Fetches a risk score classification file based on the given path. The path must be available in the classloader. + * + * @param path The path, e.g. folder/my-risk-score-classification.yaml + * @return the RiskScoreClassification + * @throws UnableToLoadFileException when the file access/transformation did not succeed + */ + public static RiskScoreClassification readFile(String path) throws UnableToLoadFileException { + return YamlLoader.loadYamlIntoProtobufBuilder(path, RiskScoreClassification.Builder.class).build(); + } +} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/UnableToLoadFileException.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/UnableToLoadFileException.java similarity index 92% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/UnableToLoadFileException.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/UnableToLoadFileException.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/UnableToLoadFileException.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/UnableToLoadFileException.java @@ -17,7 +17,7 @@ * under the License. */ -package app.coronawarn.server.services.distribution.assembly.exposureconfig; +package app.coronawarn.server.services.distribution.assembly.appconfig; /** * The file could not be loaded/parsed correctly. diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/YamlLoader.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/YamlLoader.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/YamlLoader.java @@ -0,0 +1,66 @@ +/* + * Corona-Warn-App + * + * SAP SE and all other contributors / + * copyright owners license this file to you 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 + * + * http://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. + */ + +package app.coronawarn.server.services.distribution.assembly.appconfig; + +import app.coronawarn.server.services.distribution.assembly.appconfig.parsing.YamlConstructorForProtoBuf; +import com.google.protobuf.Message; +import java.io.IOException; +import java.io.InputStream; +import org.springframework.core.io.ClassPathResource; +import org.springframework.core.io.Resource; +import org.yaml.snakeyaml.Yaml; +import org.yaml.snakeyaml.error.YAMLException; +import org.yaml.snakeyaml.introspector.BeanAccess; + +public class YamlLoader { + + private YamlLoader() { + } + + /** + * Returns a protobuf {@link Message.Builder message builder} of the specified type, whose fields have been set to the + * corresponding values from the yaml file at the specified path. + * + * @param path The absolute path of the yaml file within the class path. + * @param builderType The specific {@link com.google.protobuf.Message.Builder} implementation that will be returned. + * @return A prepared protobuf {@link Message.Builder message builder} of the specified type. + * @throws UnableToLoadFileException if either the file access or subsequent yaml parsing fails. + */ + public static <T extends Message.Builder> T loadYamlIntoProtobufBuilder(String path, Class<T> builderType) + throws UnableToLoadFileException { + Yaml yaml = new Yaml(new YamlConstructorForProtoBuf()); + // no setters for generated message classes available + yaml.setBeanAccess(BeanAccess.FIELD); + + Resource riskScoreParametersResource = new ClassPathResource(path); + try (InputStream inputStream = riskScoreParametersResource.getInputStream()) { + T loaded = yaml.loadAs(inputStream, builderType); + if (loaded == null) { + throw new UnableToLoadFileException(path); + } + + return loaded; + } catch (YAMLException e) { + throw new UnableToLoadFileException("Parsing failed", e); + } catch (IOException e) { + throw new UnableToLoadFileException("Failed to load file " + path, e); + } + } +} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/parsing/YamlConstructorForProtoBuf.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/parsing/YamlConstructorForProtoBuf.java similarity index 95% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/parsing/YamlConstructorForProtoBuf.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/parsing/YamlConstructorForProtoBuf.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/parsing/YamlConstructorForProtoBuf.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/parsing/YamlConstructorForProtoBuf.java @@ -17,7 +17,7 @@ * under the License. */ -package app.coronawarn.server.services.distribution.assembly.exposureconfig.parsing; +package app.coronawarn.server.services.distribution.assembly.appconfig.parsing; import java.util.Arrays; import org.yaml.snakeyaml.constructor.Constructor; @@ -39,6 +39,7 @@ public YamlConstructorForProtoBuf() { private static class ProtoBufPropertyUtils extends PropertyUtils { + @Override public Property getProperty(Class<?> type, String name, BeanAccess beanAccess) { return super.getProperty(type, transformToProtoNaming(name), beanAccess); } @@ -55,5 +56,4 @@ private String snakeToCamelCase(String snakeCase) { return Character.toLowerCase(camelCase.charAt(0)) + camelCase.substring(1); } } - } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/structure/directory/AppConfigurationDirectory.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/structure/directory/AppConfigurationDirectory.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/structure/directory/AppConfigurationDirectory.java @@ -0,0 +1,113 @@ +/* + * Corona-Warn-App + * + * SAP SE and all other contributors / + * copyright owners license this file to you 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 + * + * http://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. + */ + +package app.coronawarn.server.services.distribution.assembly.appconfig.structure.directory; + +import app.coronawarn.server.common.protocols.internal.RiskScoreClassification; +import app.coronawarn.server.common.protocols.internal.RiskScoreParameters; +import app.coronawarn.server.services.distribution.assembly.appconfig.ExposureConfigurationProvider; +import app.coronawarn.server.services.distribution.assembly.appconfig.RiskScoreClassificationProvider; +import app.coronawarn.server.services.distribution.assembly.appconfig.UnableToLoadFileException; +import app.coronawarn.server.services.distribution.assembly.appconfig.structure.directory.decorator.AppConfigurationSigningDecorator; +import app.coronawarn.server.services.distribution.assembly.appconfig.validation.AppConfigurationValidator; +import app.coronawarn.server.services.distribution.assembly.appconfig.validation.ExposureConfigurationValidator; +import app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidator; +import app.coronawarn.server.services.distribution.assembly.appconfig.validation.ValidationResult; +import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; +import app.coronawarn.server.services.distribution.assembly.structure.archive.ArchiveOnDisk; +import app.coronawarn.server.services.distribution.assembly.structure.directory.DirectoryOnDisk; +import app.coronawarn.server.services.distribution.assembly.structure.directory.IndexDirectoryOnDisk; +import app.coronawarn.server.services.distribution.assembly.structure.directory.decorator.indexing.IndexingDecoratorOnDisk; +import app.coronawarn.server.services.distribution.assembly.structure.file.FileOnDisk; +import com.google.protobuf.Message; +import java.util.Set; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Creates the directory structure {@code /parameters/country/:country} and writes two files. One containing {@link + * RiskScoreParameters} and the another containing the {@link RiskScoreClassification}, wrapped in a signed zip + * archive. + */ +public class AppConfigurationDirectory extends DirectoryOnDisk { + + private static final Logger logger = LoggerFactory.getLogger(AppConfigurationDirectory.class); + private static final String PARAMETERS_DIRECTORY = "configuration"; + private static final String COUNTRY_DIRECTORY = "country"; + private static final String COUNTRY = "DE"; + private static final String EXPOSURE_CONFIGURATION_FILE_NAME = "exposure_configuration"; + private static final String RISK_SCORE_CLASSIFICATION_FILE_NAME = "risk_score_classification"; + + private final IndexDirectoryOnDisk<String> countryDirectory = + new IndexDirectoryOnDisk<>(COUNTRY_DIRECTORY, __ -> Set.of(COUNTRY), Object::toString); + + private final CryptoProvider cryptoProvider; + + /** + * Creates an {@link AppConfigurationDirectory} for the exposure configuration and risk score classification. + * + * @param cryptoProvider The {@link CryptoProvider} whose artifacts to use for creating the signature. + */ + public AppConfigurationDirectory(CryptoProvider cryptoProvider) { + super(PARAMETERS_DIRECTORY); + + this.cryptoProvider = cryptoProvider; + addExposureConfigurationIfValid(); + addRiskScoreClassificationIfValid(); + + this.addWritable(new IndexingDecoratorOnDisk<>(countryDirectory)); + } + + private void addExposureConfigurationIfValid() { + try { + RiskScoreParameters exposureConfig = ExposureConfigurationProvider.readMasterFile(); + AppConfigurationValidator validator = new ExposureConfigurationValidator(exposureConfig); + addArchiveIfMessageValid(EXPOSURE_CONFIGURATION_FILE_NAME, exposureConfig, validator); + } catch (UnableToLoadFileException e) { + logger.error("Exposure configuration will not be published! Unable to read configuration file from disk."); + } + } + + private void addRiskScoreClassificationIfValid() { + try { + RiskScoreClassification riskScoreClassification = RiskScoreClassificationProvider.readMasterFile(); + AppConfigurationValidator validator = new RiskScoreClassificationValidator(riskScoreClassification); + addArchiveIfMessageValid(RISK_SCORE_CLASSIFICATION_FILE_NAME, riskScoreClassification, validator); + } catch (UnableToLoadFileException e) { + logger.error("Risk score classification will not be published! Unable to read configuration file from disk."); + } + } + + /** + * If validation of the {@link Message} succeeds, it is written into a file, put into an archive with the specified + * name and added to the specified parent directory. + */ + private void addArchiveIfMessageValid(String archiveName, Message message, AppConfigurationValidator validator) { + ValidationResult validationResult = validator.validate(); + + if (validationResult.hasErrors()) { + logger.error("App configuration file creation failed. Validation failed for {}./n{}", + archiveName, validationResult); + } + + ArchiveOnDisk appConfigurationFile = new ArchiveOnDisk(archiveName); + appConfigurationFile.addWritable(new FileOnDisk("export.bin", message.toByteArray())); + countryDirectory.addWritableToAll(__ -> new AppConfigurationSigningDecorator(appConfigurationFile, cryptoProvider)); + } +} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/structure/directory/decorator/ExposureConfigSigningDecorator.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/structure/directory/decorator/AppConfigurationSigningDecorator.java similarity index 78% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/structure/directory/decorator/ExposureConfigSigningDecorator.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/structure/directory/decorator/AppConfigurationSigningDecorator.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/structure/directory/decorator/ExposureConfigSigningDecorator.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/structure/directory/decorator/AppConfigurationSigningDecorator.java @@ -1,4 +1,4 @@ -package app.coronawarn.server.services.distribution.assembly.exposureconfig.structure.directory.decorator; +package app.coronawarn.server.services.distribution.assembly.appconfig.structure.directory.decorator; import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; import app.coronawarn.server.services.distribution.assembly.structure.Writable; @@ -7,9 +7,9 @@ import app.coronawarn.server.services.distribution.assembly.structure.archive.decorator.signing.SigningDecoratorOnDisk; import app.coronawarn.server.services.distribution.assembly.structure.file.FileOnDisk; -public class ExposureConfigSigningDecorator extends SigningDecoratorOnDisk { +public class AppConfigurationSigningDecorator extends SigningDecoratorOnDisk { - public ExposureConfigSigningDecorator(Archive<WritableOnDisk> archive, CryptoProvider cryptoProvider) { + public AppConfigurationSigningDecorator(Archive<WritableOnDisk> archive, CryptoProvider cryptoProvider) { super(archive, cryptoProvider); } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/AppConfigurationValidator.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/AppConfigurationValidator.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/AppConfigurationValidator.java @@ -0,0 +1,37 @@ +/* + * Corona-Warn-App + * + * SAP SE and all other contributors / + * copyright owners license this file to you 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 + * + * http://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. + */ + +package app.coronawarn.server.services.distribution.assembly.appconfig.validation; + +/** + * Classes that extend {@link AppConfigurationValidator} validate the values of an associated {@link + * com.google.protobuf.Message} instance. + */ +public abstract class AppConfigurationValidator { + + protected ValidationResult errors; + + /** + * Performs a validation of the associated {@link com.google.protobuf.Message} instance and returns information about + * validation failures. + * + * @return The ValidationResult instance, containing information about possible errors. + */ + public abstract ValidationResult validate(); +} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ExposureConfigurationValidator.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ExposureConfigurationValidator.java similarity index 93% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ExposureConfigurationValidator.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ExposureConfigurationValidator.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ExposureConfigurationValidator.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ExposureConfigurationValidator.java @@ -17,11 +17,11 @@ * under the License. */ -package app.coronawarn.server.services.distribution.assembly.exposureconfig.validation; +package app.coronawarn.server.services.distribution.assembly.appconfig.validation; import app.coronawarn.server.common.protocols.internal.RiskLevel; import app.coronawarn.server.common.protocols.internal.RiskScoreParameters; -import app.coronawarn.server.services.distribution.assembly.exposureconfig.validation.WeightValidationError.ErrorType; +import app.coronawarn.server.services.distribution.assembly.appconfig.validation.WeightValidationError.ErrorType; import java.beans.BeanInfo; import java.beans.IntrospectionException; import java.beans.Introspector; @@ -36,12 +36,10 @@ * <br> * Weights must be in the range of 0.001 to 100.<br> Scores must be in the range of 1 to 8.<br> */ -public class ExposureConfigurationValidator { +public class ExposureConfigurationValidator extends AppConfigurationValidator { private final RiskScoreParameters config; - private ValidationResult errors; - public ExposureConfigurationValidator(RiskScoreParameters config) { this.config = config; } @@ -52,6 +50,7 @@ public ExposureConfigurationValidator(RiskScoreParameters config) { * @return the ValidationResult instance, containing information about possible errors. * @throws ValidationExecutionException in case the validation could not be performed */ + @Override public ValidationResult validate() { this.errors = new ValidationResult(); diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ParameterSpec.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ParameterSpec.java similarity index 93% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ParameterSpec.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ParameterSpec.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ParameterSpec.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ParameterSpec.java @@ -17,7 +17,7 @@ * under the License. */ -package app.coronawarn.server.services.distribution.assembly.exposureconfig.validation; +package app.coronawarn.server.services.distribution.assembly.appconfig.validation; /** * Definition of the spec according to Apple/Google: diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/RiskLevelValidationError.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskLevelValidationError.java similarity index 95% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/RiskLevelValidationError.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskLevelValidationError.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/RiskLevelValidationError.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskLevelValidationError.java @@ -17,7 +17,7 @@ * under the License. */ -package app.coronawarn.server.services.distribution.assembly.exposureconfig.validation; +package app.coronawarn.server.services.distribution.assembly.appconfig.validation; import java.util.Objects; diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidationError.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidationError.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidationError.java @@ -0,0 +1,81 @@ +/* + * Corona-Warn-App + * + * SAP SE and all other contributors / + * copyright owners license this file to you 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 + * + * http://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. + */ + +package app.coronawarn.server.services.distribution.assembly.appconfig.validation; + +import java.util.Objects; + +public class RiskScoreClassificationValidationError implements ValidationError { + + private final String errorSource; + + private final Object value; + + private final ErrorType reason; + + /** + * Creates a {@link RiskScoreClassificationValidationError} that stores the specified validation error source, + * erroneous value and a reason for the error to occur. + * + * @param errorSource A label that describes the property associated with this validation error. + * @param value The value that caused the validation error. + * @param reason A validation error specifier. + */ + public RiskScoreClassificationValidationError(String errorSource, Object value, ErrorType reason) { + this.errorSource = errorSource; + this.value = value; + this.reason = reason; + } + + @Override + public String toString() { + return "RiskScoreClassificationValidationError{" + + "errorType=" + reason + + ", parameter='" + errorSource + '\'' + + ", givenValue=" + value + + '}'; + } + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + RiskScoreClassificationValidationError that = (RiskScoreClassificationValidationError) o; + return Objects.equals(errorSource, that.errorSource) + && Objects.equals(value, that.value) + && Objects.equals(reason, that.reason); + } + + @Override + public int hashCode() { + return Objects.hash(errorSource, value, reason); + } + + public enum ErrorType { + BLANK_LABEL, + MIN_GREATER_THAN_MAX, + VALUE_OUT_OF_BOUNDS, + INVALID_URL, + INVALID_PARTITIONING + } +} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidator.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidator.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidator.java @@ -0,0 +1,113 @@ +/* + * Corona-Warn-App + * + * SAP SE and all other contributors / + * copyright owners license this file to you 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 + * + * http://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. + */ + +package app.coronawarn.server.services.distribution.assembly.appconfig.validation; + +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidationError.ErrorType.BLANK_LABEL; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidationError.ErrorType.INVALID_PARTITIONING; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidationError.ErrorType.INVALID_URL; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidationError.ErrorType.MIN_GREATER_THAN_MAX; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidationError.ErrorType.VALUE_OUT_OF_BOUNDS; + +import app.coronawarn.server.common.protocols.internal.RiskScoreClass; +import app.coronawarn.server.common.protocols.internal.RiskScoreClassification; +import java.net.MalformedURLException; +import java.net.URL; + +/** + * The RiskScoreClassificationValidator validates the values of an associated {@link RiskScoreClassification} instance. + */ +public class RiskScoreClassificationValidator extends AppConfigurationValidator { + + /** + * This defines the number of possible values (0 ... RISK_SCORE_VALUE_RANGE - 1) for the total risk score. + */ + public static final int RISK_SCORE_VALUE_RANGE = 256; + + private final RiskScoreClassification riskScoreClassification; + + public RiskScoreClassificationValidator(RiskScoreClassification riskScoreClassification) { + this.riskScoreClassification = riskScoreClassification; + } + + /** + * Performs a validation of the associated {@link RiskScoreClassification} instance and returns information about + * validation failures. + * + * @return The ValidationResult instance, containing information about possible errors. + */ + @Override + public ValidationResult validate() { + errors = new ValidationResult(); + + validateValues(); + validateValueRangeCoverage(); + + return errors; + } + + private void validateValues() { + for (RiskScoreClass riskScoreClass : riskScoreClassification.getRiskClassesList()) { + int minRiskLevel = riskScoreClass.getMin(); + int maxRiskLevel = riskScoreClass.getMax(); + + validateLabel(riskScoreClass.getLabel()); + validateRiskScoreValueBounds(minRiskLevel); + validateRiskScoreValueBounds(maxRiskLevel); + validateUrl(riskScoreClass.getUrl()); + + if (minRiskLevel > maxRiskLevel) { + errors.add(new RiskScoreClassificationValidationError( + "minRiskLevel, maxRiskLevel", minRiskLevel + ", " + maxRiskLevel, MIN_GREATER_THAN_MAX)); + } + } + } + + private void validateLabel(String label) { + if (label.isBlank()) { + errors.add(new RiskScoreClassificationValidationError("label", label, BLANK_LABEL)); + } + } + + private void validateRiskScoreValueBounds(int value) { + if (value < 0 || value > RISK_SCORE_VALUE_RANGE - 1) { + errors.add(new RiskScoreClassificationValidationError("minRiskLevel/maxRiskLevel", value, VALUE_OUT_OF_BOUNDS)); + } + } + + private void validateUrl(String url) { + if (!url.isBlank()) { + try { + new URL(url); + } catch (MalformedURLException e) { + errors.add(new RiskScoreClassificationValidationError("url", url, INVALID_URL)); + } + } + } + + private void validateValueRangeCoverage() { + int partitionSum = riskScoreClassification.getRiskClassesList().stream() + .mapToInt(riskScoreClass -> (riskScoreClass.getMax() - riskScoreClass.getMin() + 1)) + .sum(); + + if (partitionSum != RISK_SCORE_VALUE_RANGE) { + errors.add(new RiskScoreClassificationValidationError("covered value range", partitionSum, INVALID_PARTITIONING)); + } + } +} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ValidationError.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ValidationError.java similarity index 76% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ValidationError.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ValidationError.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ValidationError.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ValidationError.java @@ -17,11 +17,10 @@ * under the License. */ -package app.coronawarn.server.services.distribution.assembly.exposureconfig.validation; +package app.coronawarn.server.services.distribution.assembly.appconfig.validation; /** - * A validation error, found during the process of validating the Exposure Configuration. Can either be score or weight - * related. + * A validation error, found during validation of a generated protocol buffers message class instance. */ public interface ValidationError { diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ValidationExecutionException.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ValidationExecutionException.java similarity index 91% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ValidationExecutionException.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ValidationExecutionException.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ValidationExecutionException.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ValidationExecutionException.java @@ -17,7 +17,7 @@ * under the License. */ -package app.coronawarn.server.services.distribution.assembly.exposureconfig.validation; +package app.coronawarn.server.services.distribution.assembly.appconfig.validation; /** * The validation could not be executed. Find more information about the root cause in the cause element, and in the diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ValidationResult.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ValidationResult.java similarity index 87% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ValidationResult.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ValidationResult.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ValidationResult.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ValidationResult.java @@ -17,7 +17,7 @@ * under the License. */ -package app.coronawarn.server.services.distribution.assembly.exposureconfig.validation; +package app.coronawarn.server.services.distribution.assembly.appconfig.validation; import java.util.HashSet; import java.util.Objects; @@ -40,11 +40,6 @@ public boolean add(ValidationError error) { return this.errors.add(error); } - @Override - public String toString() { - return errors.toString(); - } - /** * Checks whether this validation result instance has at least one error. * @@ -54,13 +49,9 @@ public boolean hasErrors() { return !this.errors.isEmpty(); } - /** - * Checks whether this validation result instance has no errors. - * - * @return true if yes, false otherwise - */ - public boolean isSuccessful() { - return !hasErrors(); + @Override + public String toString() { + return errors.toString(); } @Override diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/WeightValidationError.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/WeightValidationError.java similarity index 96% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/WeightValidationError.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/WeightValidationError.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/WeightValidationError.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/WeightValidationError.java @@ -17,7 +17,7 @@ * under the License. */ -package app.coronawarn.server.services.distribution.assembly.exposureconfig.validation; +package app.coronawarn.server.services.distribution.assembly.appconfig.validation; import java.util.Objects; diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/AppConfigurationStructureProvider.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/AppConfigurationStructureProvider.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/AppConfigurationStructureProvider.java @@ -0,0 +1,45 @@ +/* + * Corona-Warn-App + * + * SAP SE and all other contributors / + * copyright owners license this file to you 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 + * + * http://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. + */ + +package app.coronawarn.server.services.distribution.assembly.component; + +import app.coronawarn.server.services.distribution.assembly.appconfig.structure.directory.AppConfigurationDirectory; +import app.coronawarn.server.services.distribution.assembly.structure.WritableOnDisk; +import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Component; + +/** + * Reads configuration parameters from the respective files in the class path and builds a {@link + * AppConfigurationDirectory} with them. + */ +@Component +public class AppConfigurationStructureProvider { + + private final CryptoProvider cryptoProvider; + + @Autowired + public AppConfigurationStructureProvider(CryptoProvider cryptoProvider) { + this.cryptoProvider = cryptoProvider; + } + + public Directory<WritableOnDisk> getAppConfiguration() { + return new AppConfigurationDirectory(cryptoProvider); + } +} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/CwaApiStructureProvider.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/CwaApiStructureProvider.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/CwaApiStructureProvider.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/CwaApiStructureProvider.java @@ -36,15 +36,15 @@ public class CwaApiStructureProvider { public static final String VERSION_DIRECTORY = "version"; public static final String VERSION_V1 = "v1"; - private final ExposureConfigurationStructureProvider exposureConfigurationStructureProvider; + private final AppConfigurationStructureProvider appConfigurationStructureProvider; private final DiagnosisKeysStructureProvider diagnosisKeysStructureProvider; @Autowired public CwaApiStructureProvider( - ExposureConfigurationStructureProvider exposureConfigurationStructureProvider, + AppConfigurationStructureProvider appConfigurationStructureProvider, DiagnosisKeysStructureProvider diagnosisKeysStructureProvider) { - this.exposureConfigurationStructureProvider = exposureConfigurationStructureProvider; + this.appConfigurationStructureProvider = appConfigurationStructureProvider; this.diagnosisKeysStructureProvider = diagnosisKeysStructureProvider; } @@ -56,7 +56,7 @@ public Directory<WritableOnDisk> getDirectory() { new IndexDirectoryOnDisk<>(VERSION_DIRECTORY, __ -> Set.of(VERSION_V1), Object::toString); versionDirectory - .addWritableToAll(__ -> exposureConfigurationStructureProvider.getExposureConfiguration()); + .addWritableToAll(__ -> appConfigurationStructureProvider.getAppConfiguration()); versionDirectory.addWritableToAll(__ -> diagnosisKeysStructureProvider.getDiagnosisKeys()); return new IndexingDecoratorOnDisk<>(versionDirectory); diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/ExposureConfigurationStructureProvider.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/ExposureConfigurationStructureProvider.java deleted file mode 100644 --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/ExposureConfigurationStructureProvider.java +++ /dev/null @@ -1,64 +0,0 @@ -/* - * Corona-Warn-App - * - * SAP SE and all other contributors / - * copyright owners license this file to you 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 - * - * http://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. - */ - -package app.coronawarn.server.services.distribution.assembly.component; - -import app.coronawarn.server.common.protocols.internal.RiskScoreParameters; -import app.coronawarn.server.services.distribution.assembly.exposureconfig.ExposureConfigurationProvider; -import app.coronawarn.server.services.distribution.assembly.exposureconfig.UnableToLoadFileException; -import app.coronawarn.server.services.distribution.assembly.exposureconfig.structure.directory.ExposureConfigurationDirectory; -import app.coronawarn.server.services.distribution.assembly.structure.WritableOnDisk; -import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.stereotype.Component; - -/** - * Reads the exposure configuration parameters from the respective file in the class path and builds a {@link - * ExposureConfigurationDirectory} with them. - */ -@Component -public class ExposureConfigurationStructureProvider { - - private static final Logger logger = LoggerFactory - .getLogger(ExposureConfigurationStructureProvider.class); - - private final CryptoProvider cryptoProvider; - - @Autowired - public ExposureConfigurationStructureProvider(CryptoProvider cryptoProvider) { - this.cryptoProvider = cryptoProvider; - } - - public Directory<WritableOnDisk> getExposureConfiguration() { - var riskScoreParameters = readExposureConfiguration(); - return new ExposureConfigurationDirectory(riskScoreParameters, cryptoProvider); - } - - private RiskScoreParameters readExposureConfiguration() { - logger.debug("Reading exposure configuration..."); - try { - return ExposureConfigurationProvider.readMasterFile(); - } catch (UnableToLoadFileException e) { - logger.error("Could not load exposure configuration parameters", e); - throw new RuntimeException(e); - } - } -} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/structure/directory/ExposureConfigurationDirectory.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/structure/directory/ExposureConfigurationDirectory.java deleted file mode 100644 --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/structure/directory/ExposureConfigurationDirectory.java +++ /dev/null @@ -1,63 +0,0 @@ -/* - * Corona-Warn-App - * - * SAP SE and all other contributors / - * copyright owners license this file to you 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 - * - * http://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. - */ - -package app.coronawarn.server.services.distribution.assembly.exposureconfig.structure.directory; - -import app.coronawarn.server.common.protocols.internal.RiskScoreParameters; -import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; -import app.coronawarn.server.services.distribution.assembly.exposureconfig.structure.directory.decorator.ExposureConfigSigningDecorator; -import app.coronawarn.server.services.distribution.assembly.structure.archive.ArchiveOnDisk; -import app.coronawarn.server.services.distribution.assembly.structure.directory.DirectoryOnDisk; -import app.coronawarn.server.services.distribution.assembly.structure.directory.IndexDirectoryOnDisk; -import app.coronawarn.server.services.distribution.assembly.structure.directory.decorator.indexing.IndexingDecoratorOnDisk; -import app.coronawarn.server.services.distribution.assembly.structure.file.FileOnDisk; -import java.util.Set; - -/** - * Creates the directory structure {@code /parameters/country/:country} and writes a file called {@code index} - * containing {@link RiskScoreParameters} wrapped in a signed zip archive. - */ -public class ExposureConfigurationDirectory extends DirectoryOnDisk { - - private static final String PARAMETERS_DIRECTORY = "parameters"; - private static final String COUNTRY_DIRECTORY = "country"; - private static final String COUNTRY = "DE"; - private static final String INDEX_FILE_NAME = "index"; - - /** - * Constructor. - * - * @param exposureConfig The {@link RiskScoreParameters} to sign and write. - * @param cryptoProvider The {@link CryptoProvider} whose artifacts to use for creating the signature. - */ - public ExposureConfigurationDirectory(RiskScoreParameters exposureConfig, - CryptoProvider cryptoProvider) { - super(PARAMETERS_DIRECTORY); - - ArchiveOnDisk archive = new ArchiveOnDisk(INDEX_FILE_NAME); - archive.addWritable(new FileOnDisk("export.bin", exposureConfig.toByteArray())); - - IndexDirectoryOnDisk<String> country = - new IndexDirectoryOnDisk<>(COUNTRY_DIRECTORY, __ -> Set.of(COUNTRY), Object::toString); - country.addWritableToAll(__ -> - new ExposureConfigSigningDecorator(archive, cryptoProvider)); - - this.addWritable(new IndexingDecoratorOnDisk<>(country)); - } -} diff --git a/services/distribution/src/main/resources/risk-score-classification/master.yaml b/services/distribution/src/main/resources/risk-score-classification/master.yaml new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/resources/risk-score-classification/master.yaml @@ -0,0 +1,27 @@ +# This is the Risk Score Classification master file which partitions the risk +# score value range (0-255) into distinct risk classes that will be used to by +# the app in order to present the correct risk classification in a user +# friendly manner, based on the underlying total risk score, to the user. +# +# The risk classes must not overlap and +# cover the full risk score value range (0-255). +# +# Change this file with caution! + +risk_classes: + - + label: "LOW" + min: 0 + max: 100 + url: "https://www..." + - + label: "MID" + min: 101 + max: 200 + url: "https://www..." + - + label: "HIGH" + min: 201 + max: 255 + url: "https://www..." + \ No newline at end of file

diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/ExposureConfigurationProviderMasterFileTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/ExposureConfigurationProviderMasterFileTest.java similarity index 82% rename from services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/ExposureConfigurationProviderMasterFileTest.java rename to services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/ExposureConfigurationProviderMasterFileTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/ExposureConfigurationProviderMasterFileTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/ExposureConfigurationProviderMasterFileTest.java @@ -17,12 +17,12 @@ * under the License. */ -package app.coronawarn.server.services.distribution.assembly.exposureconfig; +package app.coronawarn.server.services.distribution.assembly.appconfig; import static org.assertj.core.api.Assertions.assertThat; -import app.coronawarn.server.services.distribution.assembly.exposureconfig.validation.ExposureConfigurationValidator; -import app.coronawarn.server.services.distribution.assembly.exposureconfig.validation.ValidationResult; +import app.coronawarn.server.services.distribution.assembly.appconfig.validation.ExposureConfigurationValidator; +import app.coronawarn.server.services.distribution.assembly.appconfig.validation.ValidationResult; import org.junit.jupiter.api.Test; /** diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/ExposureConfigurationProviderTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/ExposureConfigurationProviderTest.java similarity index 95% rename from services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/ExposureConfigurationProviderTest.java rename to services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/ExposureConfigurationProviderTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/ExposureConfigurationProviderTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/ExposureConfigurationProviderTest.java @@ -17,7 +17,7 @@ * under the License. */ -package app.coronawarn.server.services.distribution.assembly.exposureconfig; +package app.coronawarn.server.services.distribution.assembly.appconfig; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.catchThrowable; diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/RiskScoreClassificationProviderMasterFileTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/RiskScoreClassificationProviderMasterFileTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/RiskScoreClassificationProviderMasterFileTest.java @@ -0,0 +1,46 @@ +/* + * Corona-Warn-App + * + * SAP SE and all other contributors / + * copyright owners license this file to you 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 + * + * http://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. + */ + +package app.coronawarn.server.services.distribution.assembly.appconfig; + +import static org.assertj.core.api.Assertions.assertThat; + +import app.coronawarn.server.services.distribution.assembly.appconfig.validation.ExposureConfigurationValidator; +import app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidator; +import app.coronawarn.server.services.distribution.assembly.appconfig.validation.ValidationResult; +import org.junit.jupiter.api.Test; + +/** + * This test will verify that the provided risk score classification master file is syntactically correct and according + * to spec. + * There should never be any deployment when this test is failing. + */ +public class RiskScoreClassificationProviderMasterFileTest { + + private static final ValidationResult SUCCESS = new ValidationResult(); + + @Test + public void testMasterFile() throws UnableToLoadFileException { + var config = RiskScoreClassificationProvider.readMasterFile(); + + var validator = new RiskScoreClassificationValidator(config); + + assertThat(validator.validate()).isEqualTo(SUCCESS); + } +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ExposureConfigurationValidatorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ExposureConfigurationValidatorTest.java similarity index 91% rename from services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ExposureConfigurationValidatorTest.java rename to services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ExposureConfigurationValidatorTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/ExposureConfigurationValidatorTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ExposureConfigurationValidatorTest.java @@ -17,14 +17,14 @@ * under the License. */ -package app.coronawarn.server.services.distribution.assembly.exposureconfig.validation; +package app.coronawarn.server.services.distribution.assembly.appconfig.validation; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.catchThrowable; -import app.coronawarn.server.services.distribution.assembly.exposureconfig.ExposureConfigurationProvider; -import app.coronawarn.server.services.distribution.assembly.exposureconfig.UnableToLoadFileException; -import app.coronawarn.server.services.distribution.assembly.exposureconfig.validation.WeightValidationError.ErrorType; +import app.coronawarn.server.services.distribution.assembly.appconfig.ExposureConfigurationProvider; +import app.coronawarn.server.services.distribution.assembly.appconfig.UnableToLoadFileException; +import app.coronawarn.server.services.distribution.assembly.appconfig.validation.WeightValidationError.ErrorType; import java.util.stream.Stream; import org.junit.jupiter.api.Test; import org.junit.jupiter.params.ParameterizedTest; diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidatorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidatorTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidatorTest.java @@ -0,0 +1,173 @@ +/* + * Corona-Warn-App + * + * SAP SE and all other contributors / + * copyright owners license this file to you 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 + * + * http://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. + */ + +package app.coronawarn.server.services.distribution.assembly.appconfig.validation; + +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidator.RISK_SCORE_VALUE_RANGE; +import static java.util.Arrays.asList; +import static org.assertj.core.api.Assertions.assertThat; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidationError.ErrorType.*; + +import app.coronawarn.server.common.protocols.internal.RiskScoreClass; +import app.coronawarn.server.common.protocols.internal.RiskScoreClassification; +import app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidationError.ErrorType; +import java.util.Arrays; +import java.util.stream.Stream; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.Arguments; +import org.junit.jupiter.params.provider.MethodSource; +import org.junit.jupiter.params.provider.ValueSource; + +public class RiskScoreClassificationValidatorTest { + + private final static int MAX_SCORE = RISK_SCORE_VALUE_RANGE - 1; + private final static String VALID_LABEL = "myLabel"; + private final static String VALID_URL = ""; + + @ParameterizedTest + @ValueSource(strings = {"", " "}) + void failsForBlankLabels(String invalidLabel) { + var validator = buildValidator(buildRiskClass(invalidLabel, 0, MAX_SCORE, "")); + var expectedResult = buildExpectedResult(buildError("label", invalidLabel, ErrorType.BLANK_LABEL)); + + assertThat(validator.validate()).isEqualTo(expectedResult); + } + + @ParameterizedTest + @ValueSource(strings = {"invalid.Url", "invalid-url", "$$$://invalid.url"}) + void failsForInvalidUrl(String invalidUrl) { + var validator = buildValidator(buildRiskClass(VALID_LABEL, 0, MAX_SCORE, invalidUrl)); + var expectedResult = buildExpectedResult(buildError("url", invalidUrl, ErrorType.INVALID_URL)); + + assertThat(validator.validate()).isEqualTo(expectedResult); + } + + @Test + void failsForNegativeRiskValues() { + // must cover value range of equal size in order to avoid INVALID_PARTITIONING error + int negativeMin = -MAX_SCORE - 1; + int negativeMax = -1; + var validator = buildValidator(buildRiskClass(VALID_LABEL, negativeMin, negativeMax, VALID_URL)); + var expectedResult = buildExpectedResult( + buildError("minRiskLevel/maxRiskLevel", negativeMin, ErrorType.VALUE_OUT_OF_BOUNDS), + buildError("minRiskLevel/maxRiskLevel", negativeMax, ErrorType.VALUE_OUT_OF_BOUNDS)); + + assertThat(validator.validate()).isEqualTo(expectedResult); + } + + @Test + void failsForTooLargeRiskValues() { + // must cover value range of equal size in order to avoid INVALID_PARTITIONING error + int tooLargeMin = MAX_SCORE + 1; + int tooLargeMax = 2 * MAX_SCORE + 1; + var validator = buildValidator(buildRiskClass(VALID_LABEL, tooLargeMin, tooLargeMax, VALID_URL)); + var expectedResult = buildExpectedResult( + buildError("minRiskLevel/maxRiskLevel", tooLargeMin, ErrorType.VALUE_OUT_OF_BOUNDS), + buildError("minRiskLevel/maxRiskLevel", tooLargeMax, ErrorType.VALUE_OUT_OF_BOUNDS)); + + assertThat(validator.validate()).isEqualTo(expectedResult); + } + + @Test + void failsIfMinGreaterThanMax() { + int min = 1; + int max = 0; + // Note: additional classes have to be added in order to reach the expected value range size + var validator = buildValidator(buildRiskClass(VALID_LABEL, min, max, VALID_URL), + buildRiskClass(VALID_LABEL, 0, MAX_SCORE, VALID_URL)); + var expectedResult = buildExpectedResult( + buildError("minRiskLevel, maxRiskLevel", (min + ", " + max), MIN_GREATER_THAN_MAX)); + + assertThat(validator.validate()).isEqualTo(expectedResult); + } + + @ParameterizedTest + @MethodSource("createInvalidPartitionings") + void failsIfPartitioningInvalid(RiskScoreClassification invalidClassification) { + var validator = new RiskScoreClassificationValidator(invalidClassification); + int coveredRange = invalidClassification.getRiskClassesList().stream() + .mapToInt(riskScoreClass -> (riskScoreClass.getMax() - riskScoreClass.getMin() + 1)) + .sum(); + var expectedResult = buildExpectedResult( + buildError("covered value range", coveredRange, INVALID_PARTITIONING)); + + assertThat(validator.validate()).isEqualTo(expectedResult); + } + + private static Stream<Arguments> createInvalidPartitionings() { + return Stream.of( + buildClassification(buildRiskClass(VALID_LABEL, 0, 0, VALID_URL)), + buildClassification( + buildRiskClass(VALID_LABEL, 0, MAX_SCORE / 2, VALID_URL), + buildRiskClass(VALID_LABEL, MAX_SCORE / 2 + 1, MAX_SCORE, VALID_URL), + buildRiskClass(VALID_LABEL, 0, MAX_SCORE, VALID_URL)), + buildClassification( + buildRiskClass(VALID_LABEL, 0, MAX_SCORE, VALID_URL), + buildRiskClass(VALID_LABEL, 0, MAX_SCORE, VALID_URL)) + ).map(Arguments::of); + } + + @ParameterizedTest + @MethodSource("createValidClassifications") + void doesNotFailForValidClassification(RiskScoreClassification validClassification) { + var validator = new RiskScoreClassificationValidator(validClassification); + assertThat(validator.validate()).isEqualTo(new ValidationResult()); + } + + private static Stream<Arguments> createValidClassifications() { + return Stream.of( + // blank url + buildClassification(buildRiskClass(VALID_LABEL, 0, MAX_SCORE, "")), + // legit url + buildClassification(buildRiskClass(VALID_LABEL, 0, MAX_SCORE, "http://www.sap.com")), + // [0:MAX_SCORE/2][MAX_SCORE/2:MAX_SCORE] + buildClassification( + buildRiskClass(VALID_LABEL, 0, MAX_SCORE / 2, VALID_URL), + buildRiskClass(VALID_LABEL, MAX_SCORE / 2 + 1, MAX_SCORE, VALID_URL)), + // [0:MAX_SCORE-10][MAX_SCORE-9][MAX_SCORE-8:MAX_SCORE] + buildClassification( + buildRiskClass(VALID_LABEL, 0, MAX_SCORE - 10, VALID_URL), + buildRiskClass(VALID_LABEL, MAX_SCORE - 9, MAX_SCORE - 9, VALID_URL), + buildRiskClass(VALID_LABEL, MAX_SCORE - 8, MAX_SCORE, VALID_URL)) + ).map(Arguments::of); + } + + private static RiskScoreClassificationValidationError buildError(String parameter, Object value, ErrorType reason) { + return new RiskScoreClassificationValidationError(parameter, value, reason); + } + + private static RiskScoreClassificationValidator buildValidator(RiskScoreClass... riskScoreClasses) { + return new RiskScoreClassificationValidator(buildClassification(riskScoreClasses)); + } + + private static RiskScoreClassification buildClassification(RiskScoreClass... riskScoreClasses) { + return RiskScoreClassification.newBuilder().addAllRiskClasses(asList(riskScoreClasses)).build(); + } + + private static RiskScoreClass buildRiskClass(String label, int min, int max, String url) { + return RiskScoreClass.newBuilder().setLabel(label).setMin(min).setMax(max).setUrl(url).build(); + } + + private static ValidationResult buildExpectedResult(RiskScoreClassificationValidationError... errors) { + var validationResult = new ValidationResult(); + Arrays.stream(errors).forEach(validationResult::add); + return validationResult; + } +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/TestWithExpectedResult.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/TestWithExpectedResult.java similarity index 92% rename from services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/TestWithExpectedResult.java rename to services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/TestWithExpectedResult.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/exposureconfig/validation/TestWithExpectedResult.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/TestWithExpectedResult.java @@ -17,7 +17,7 @@ * under the License. */ -package app.coronawarn.server.services.distribution.assembly.exposureconfig.validation; +package app.coronawarn.server.services.distribution.assembly.appconfig.validation; public class TestWithExpectedResult {

Exposure configuration parameters not validated The exposure configuration parameters are currently not validated after being read from the respective yml file. The validation code in ``ExposureConfigurationValidator`` is currently used in tests only. However, the expected behavior shall be the following: - The ``RiskScoreParameters`` object is constructed based on yml file. (✅) - ``ExposureConfigurationValidator`` performs validation of the parameters. - In case of a failed validation, **do not** publish the exposure configuration parameters, **but do** generate and publish the diagnosis key bundles. - Clarify whether to keep any previously present (valid) configuration parameters on the object store if a validation error occurs. - Any validation errors shall be logged appropriately.

corona-warn-app/cwa-server

corona-warn-app__cwa-server-264

a04308e1e7f96d43224fe3b1c58125f2575a7bb7

diff --git a/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/risk_score_classification.proto b/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/risk_score_classification.proto new file mode 100644 --- /dev/null +++ b/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/risk_score_classification.proto @@ -0,0 +1,15 @@ +syntax = "proto3"; +package app.coronawarn.server.common.protocols.internal; +option java_package = "app.coronawarn.server.common.protocols.internal"; +option java_multiple_files = true; + +message RiskScoreClassification { + repeated RiskScoreClass risk_classes = 1; +} + +message RiskScoreClass { + string label = 1; + int32 min = 2; + int32 max = 3; + string url = 4; +} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/RiskScoreClassificationProvider.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/RiskScoreClassificationProvider.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/RiskScoreClassificationProvider.java @@ -0,0 +1,58 @@ +/* + * Corona-Warn-App + * + * SAP SE and all other contributors / + * copyright owners license this file to you 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 + * + * http://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. + */ + +package app.coronawarn.server.services.distribution.assembly.appconfig; + +import app.coronawarn.server.common.protocols.internal.RiskScoreClassification; + +/** + * Provides the risk score classification based on a file on the file system. The existing file must be a valid YAML + * file, and must match the specification of the proto file risk_score_classification.proto. + */ +public class RiskScoreClassificationProvider { + + private RiskScoreClassificationProvider() { + } + + /** + * The location of the risk score classification master file. + */ + public static final String MASTER_FILE = "risk-score-classification/master.yaml"; + + /** + * Fetches the master configuration as a {@link RiskScoreClassification} instance. + * + * @return the risk score classification as {@link RiskScoreClassification} + * @throws UnableToLoadFileException when the file/transformation did not succeed + */ + public static RiskScoreClassification readMasterFile() throws UnableToLoadFileException { + return readFile(MASTER_FILE); + } + + /** + * Fetches a risk score classification file based on the given path. The path must be available in the classloader. + * + * @param path The path, e.g. folder/my-risk-score-classification.yaml + * @return the RiskScoreClassification + * @throws UnableToLoadFileException when the file access/transformation did not succeed + */ + public static RiskScoreClassification readFile(String path) throws UnableToLoadFileException { + return YamlLoader.loadYamlIntoProtobufBuilder(path, RiskScoreClassification.Builder.class).build(); + } +} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/parsing/YamlConstructorForProtoBuf.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/parsing/YamlConstructorForProtoBuf.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/parsing/YamlConstructorForProtoBuf.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/parsing/YamlConstructorForProtoBuf.java @@ -56,5 +56,4 @@ private String snakeToCamelCase(String snakeCase) { return Character.toLowerCase(camelCase.charAt(0)) + camelCase.substring(1); } } - } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/structure/directory/AppConfigurationDirectory.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/structure/directory/AppConfigurationDirectory.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/structure/directory/AppConfigurationDirectory.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/structure/directory/AppConfigurationDirectory.java @@ -19,12 +19,15 @@ package app.coronawarn.server.services.distribution.assembly.appconfig.structure.directory; +import app.coronawarn.server.common.protocols.internal.RiskScoreClassification; import app.coronawarn.server.common.protocols.internal.RiskScoreParameters; import app.coronawarn.server.services.distribution.assembly.appconfig.ExposureConfigurationProvider; +import app.coronawarn.server.services.distribution.assembly.appconfig.RiskScoreClassificationProvider; import app.coronawarn.server.services.distribution.assembly.appconfig.UnableToLoadFileException; import app.coronawarn.server.services.distribution.assembly.appconfig.structure.directory.decorator.AppConfigurationSigningDecorator; import app.coronawarn.server.services.distribution.assembly.appconfig.validation.AppConfigurationValidator; import app.coronawarn.server.services.distribution.assembly.appconfig.validation.ExposureConfigurationValidator; +import app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidator; import app.coronawarn.server.services.distribution.assembly.appconfig.validation.ValidationResult; import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; import app.coronawarn.server.services.distribution.assembly.structure.archive.ArchiveOnDisk; @@ -38,8 +41,9 @@ import org.slf4j.LoggerFactory; /** - * Creates the directory structure {@code /parameters/country/:country} and writes a file containing {@link - * RiskScoreParameters}, wrapped in a signed zip archive. + * Creates the directory structure {@code /parameters/country/:country} and writes two files. One containing {@link + * RiskScoreParameters} and the another containing the {@link RiskScoreClassification}, wrapped in a signed zip + * archive. */ public class AppConfigurationDirectory extends DirectoryOnDisk { @@ -48,6 +52,7 @@ public class AppConfigurationDirectory extends DirectoryOnDisk { private static final String COUNTRY_DIRECTORY = "country"; private static final String COUNTRY = "DE"; private static final String EXPOSURE_CONFIGURATION_FILE_NAME = "exposure_configuration"; + private static final String RISK_SCORE_CLASSIFICATION_FILE_NAME = "risk_score_classification"; private final IndexDirectoryOnDisk<String> countryDirectory = new IndexDirectoryOnDisk<>(COUNTRY_DIRECTORY, __ -> Set.of(COUNTRY), Object::toString); @@ -55,7 +60,7 @@ public class AppConfigurationDirectory extends DirectoryOnDisk { private final CryptoProvider cryptoProvider; /** - * Creates an {@link AppConfigurationDirectory} for the exposure configuration. + * Creates an {@link AppConfigurationDirectory} for the exposure configuration and risk score classification. * * @param cryptoProvider The {@link CryptoProvider} whose artifacts to use for creating the signature. */ @@ -64,6 +69,8 @@ public AppConfigurationDirectory(CryptoProvider cryptoProvider) { this.cryptoProvider = cryptoProvider; addExposureConfigurationIfValid(); + addRiskScoreClassificationIfValid(); + this.addWritable(new IndexingDecoratorOnDisk<>(countryDirectory)); } @@ -77,6 +84,16 @@ private void addExposureConfigurationIfValid() { } } + private void addRiskScoreClassificationIfValid() { + try { + RiskScoreClassification riskScoreClassification = RiskScoreClassificationProvider.readMasterFile(); + AppConfigurationValidator validator = new RiskScoreClassificationValidator(riskScoreClassification); + addArchiveIfMessageValid(RISK_SCORE_CLASSIFICATION_FILE_NAME, riskScoreClassification, validator); + } catch (UnableToLoadFileException e) { + logger.error("Risk score classification will not be published! Unable to read configuration file from disk."); + } + } + /** * If validation of the {@link Message} succeeds, it is written into a file, put into an archive with the specified * name and added to the specified parent directory. diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidationError.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidationError.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidationError.java @@ -0,0 +1,81 @@ +/* + * Corona-Warn-App + * + * SAP SE and all other contributors / + * copyright owners license this file to you 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 + * + * http://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. + */ + +package app.coronawarn.server.services.distribution.assembly.appconfig.validation; + +import java.util.Objects; + +public class RiskScoreClassificationValidationError implements ValidationError { + + private final String errorSource; + + private final Object value; + + private final ErrorType reason; + + /** + * Creates a {@link RiskScoreClassificationValidationError} that stores the specified validation error source, + * erroneous value and a reason for the error to occur. + * + * @param errorSource A label that describes the property associated with this validation error. + * @param value The value that caused the validation error. + * @param reason A validation error specifier. + */ + public RiskScoreClassificationValidationError(String errorSource, Object value, ErrorType reason) { + this.errorSource = errorSource; + this.value = value; + this.reason = reason; + } + + @Override + public String toString() { + return "RiskScoreClassificationValidationError{" + + "errorType=" + reason + + ", parameter='" + errorSource + '\'' + + ", givenValue=" + value + + '}'; + } + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + RiskScoreClassificationValidationError that = (RiskScoreClassificationValidationError) o; + return Objects.equals(errorSource, that.errorSource) + && Objects.equals(value, that.value) + && Objects.equals(reason, that.reason); + } + + @Override + public int hashCode() { + return Objects.hash(errorSource, value, reason); + } + + public enum ErrorType { + BLANK_LABEL, + MIN_GREATER_THAN_MAX, + VALUE_OUT_OF_BOUNDS, + INVALID_URL, + INVALID_PARTITIONING + } +} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidator.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidator.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidator.java @@ -0,0 +1,113 @@ +/* + * Corona-Warn-App + * + * SAP SE and all other contributors / + * copyright owners license this file to you 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 + * + * http://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. + */ + +package app.coronawarn.server.services.distribution.assembly.appconfig.validation; + +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidationError.ErrorType.BLANK_LABEL; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidationError.ErrorType.INVALID_PARTITIONING; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidationError.ErrorType.INVALID_URL; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidationError.ErrorType.MIN_GREATER_THAN_MAX; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidationError.ErrorType.VALUE_OUT_OF_BOUNDS; + +import app.coronawarn.server.common.protocols.internal.RiskScoreClass; +import app.coronawarn.server.common.protocols.internal.RiskScoreClassification; +import java.net.MalformedURLException; +import java.net.URL; + +/** + * The RiskScoreClassificationValidator validates the values of an associated {@link RiskScoreClassification} instance. + */ +public class RiskScoreClassificationValidator extends AppConfigurationValidator { + + /** + * This defines the number of possible values (0 ... RISK_SCORE_VALUE_RANGE - 1) for the total risk score. + */ + public static final int RISK_SCORE_VALUE_RANGE = 256; + + private final RiskScoreClassification riskScoreClassification; + + public RiskScoreClassificationValidator(RiskScoreClassification riskScoreClassification) { + this.riskScoreClassification = riskScoreClassification; + } + + /** + * Performs a validation of the associated {@link RiskScoreClassification} instance and returns information about + * validation failures. + * + * @return The ValidationResult instance, containing information about possible errors. + */ + @Override + public ValidationResult validate() { + errors = new ValidationResult(); + + validateValues(); + validateValueRangeCoverage(); + + return errors; + } + + private void validateValues() { + for (RiskScoreClass riskScoreClass : riskScoreClassification.getRiskClassesList()) { + int minRiskLevel = riskScoreClass.getMin(); + int maxRiskLevel = riskScoreClass.getMax(); + + validateLabel(riskScoreClass.getLabel()); + validateRiskScoreValueBounds(minRiskLevel); + validateRiskScoreValueBounds(maxRiskLevel); + validateUrl(riskScoreClass.getUrl()); + + if (minRiskLevel > maxRiskLevel) { + errors.add(new RiskScoreClassificationValidationError( + "minRiskLevel, maxRiskLevel", minRiskLevel + ", " + maxRiskLevel, MIN_GREATER_THAN_MAX)); + } + } + } + + private void validateLabel(String label) { + if (label.isBlank()) { + errors.add(new RiskScoreClassificationValidationError("label", label, BLANK_LABEL)); + } + } + + private void validateRiskScoreValueBounds(int value) { + if (value < 0 || value > RISK_SCORE_VALUE_RANGE - 1) { + errors.add(new RiskScoreClassificationValidationError("minRiskLevel/maxRiskLevel", value, VALUE_OUT_OF_BOUNDS)); + } + } + + private void validateUrl(String url) { + if (!url.isBlank()) { + try { + new URL(url); + } catch (MalformedURLException e) { + errors.add(new RiskScoreClassificationValidationError("url", url, INVALID_URL)); + } + } + } + + private void validateValueRangeCoverage() { + int partitionSum = riskScoreClassification.getRiskClassesList().stream() + .mapToInt(riskScoreClass -> (riskScoreClass.getMax() - riskScoreClass.getMin() + 1)) + .sum(); + + if (partitionSum != RISK_SCORE_VALUE_RANGE) { + errors.add(new RiskScoreClassificationValidationError("covered value range", partitionSum, INVALID_PARTITIONING)); + } + } +} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ValidationResult.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ValidationResult.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ValidationResult.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ValidationResult.java @@ -40,11 +40,6 @@ public boolean add(ValidationError error) { return this.errors.add(error); } - @Override - public String toString() { - return errors.toString(); - } - /** * Checks whether this validation result instance has at least one error. * @@ -54,13 +49,9 @@ public boolean hasErrors() { return !this.errors.isEmpty(); } - /** - * Checks whether this validation result instance has no errors. - * - * @return true if yes, false otherwise - */ - public boolean isSuccessful() { - return !hasErrors(); + @Override + public String toString() { + return errors.toString(); } @Override diff --git a/services/distribution/src/main/resources/risk-score-classification/master.yaml b/services/distribution/src/main/resources/risk-score-classification/master.yaml new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/resources/risk-score-classification/master.yaml @@ -0,0 +1,27 @@ +# This is the Risk Score Classification master file which partitions the risk +# score value range (0-255) into distinct risk classes that will be used to by +# the app in order to present the correct risk classification in a user +# friendly manner, based on the underlying total risk score, to the user. +# +# The risk classes must not overlap and +# cover the full risk score value range (0-255). +# +# Change this file with caution! + +risk_classes: + - + label: "LOW" + min: 0 + max: 100 + url: "https://www..." + - + label: "MID" + min: 101 + max: 200 + url: "https://www..." + - + label: "HIGH" + min: 201 + max: 255 + url: "https://www..." + \ No newline at end of file

diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/RiskScoreClassificationProviderMasterFileTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/RiskScoreClassificationProviderMasterFileTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/RiskScoreClassificationProviderMasterFileTest.java @@ -0,0 +1,46 @@ +/* + * Corona-Warn-App + * + * SAP SE and all other contributors / + * copyright owners license this file to you 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 + * + * http://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. + */ + +package app.coronawarn.server.services.distribution.assembly.appconfig; + +import static org.assertj.core.api.Assertions.assertThat; + +import app.coronawarn.server.services.distribution.assembly.appconfig.validation.ExposureConfigurationValidator; +import app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidator; +import app.coronawarn.server.services.distribution.assembly.appconfig.validation.ValidationResult; +import org.junit.jupiter.api.Test; + +/** + * This test will verify that the provided risk score classification master file is syntactically correct and according + * to spec. + * There should never be any deployment when this test is failing. + */ +public class RiskScoreClassificationProviderMasterFileTest { + + private static final ValidationResult SUCCESS = new ValidationResult(); + + @Test + public void testMasterFile() throws UnableToLoadFileException { + var config = RiskScoreClassificationProvider.readMasterFile(); + + var validator = new RiskScoreClassificationValidator(config); + + assertThat(validator.validate()).isEqualTo(SUCCESS); + } +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidatorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidatorTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidatorTest.java @@ -0,0 +1,173 @@ +/* + * Corona-Warn-App + * + * SAP SE and all other contributors / + * copyright owners license this file to you 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 + * + * http://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. + */ + +package app.coronawarn.server.services.distribution.assembly.appconfig.validation; + +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidator.RISK_SCORE_VALUE_RANGE; +import static java.util.Arrays.asList; +import static org.assertj.core.api.Assertions.assertThat; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidationError.ErrorType.*; + +import app.coronawarn.server.common.protocols.internal.RiskScoreClass; +import app.coronawarn.server.common.protocols.internal.RiskScoreClassification; +import app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidationError.ErrorType; +import java.util.Arrays; +import java.util.stream.Stream; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.Arguments; +import org.junit.jupiter.params.provider.MethodSource; +import org.junit.jupiter.params.provider.ValueSource; + +public class RiskScoreClassificationValidatorTest { + + private final static int MAX_SCORE = RISK_SCORE_VALUE_RANGE - 1; + private final static String VALID_LABEL = "myLabel"; + private final static String VALID_URL = ""; + + @ParameterizedTest + @ValueSource(strings = {"", " "}) + void failsForBlankLabels(String invalidLabel) { + var validator = buildValidator(buildRiskClass(invalidLabel, 0, MAX_SCORE, "")); + var expectedResult = buildExpectedResult(buildError("label", invalidLabel, ErrorType.BLANK_LABEL)); + + assertThat(validator.validate()).isEqualTo(expectedResult); + } + + @ParameterizedTest + @ValueSource(strings = {"invalid.Url", "invalid-url", "$$$://invalid.url"}) + void failsForInvalidUrl(String invalidUrl) { + var validator = buildValidator(buildRiskClass(VALID_LABEL, 0, MAX_SCORE, invalidUrl)); + var expectedResult = buildExpectedResult(buildError("url", invalidUrl, ErrorType.INVALID_URL)); + + assertThat(validator.validate()).isEqualTo(expectedResult); + } + + @Test + void failsForNegativeRiskValues() { + // must cover value range of equal size in order to avoid INVALID_PARTITIONING error + int negativeMin = -MAX_SCORE - 1; + int negativeMax = -1; + var validator = buildValidator(buildRiskClass(VALID_LABEL, negativeMin, negativeMax, VALID_URL)); + var expectedResult = buildExpectedResult( + buildError("minRiskLevel/maxRiskLevel", negativeMin, ErrorType.VALUE_OUT_OF_BOUNDS), + buildError("minRiskLevel/maxRiskLevel", negativeMax, ErrorType.VALUE_OUT_OF_BOUNDS)); + + assertThat(validator.validate()).isEqualTo(expectedResult); + } + + @Test + void failsForTooLargeRiskValues() { + // must cover value range of equal size in order to avoid INVALID_PARTITIONING error + int tooLargeMin = MAX_SCORE + 1; + int tooLargeMax = 2 * MAX_SCORE + 1; + var validator = buildValidator(buildRiskClass(VALID_LABEL, tooLargeMin, tooLargeMax, VALID_URL)); + var expectedResult = buildExpectedResult( + buildError("minRiskLevel/maxRiskLevel", tooLargeMin, ErrorType.VALUE_OUT_OF_BOUNDS), + buildError("minRiskLevel/maxRiskLevel", tooLargeMax, ErrorType.VALUE_OUT_OF_BOUNDS)); + + assertThat(validator.validate()).isEqualTo(expectedResult); + } + + @Test + void failsIfMinGreaterThanMax() { + int min = 1; + int max = 0; + // Note: additional classes have to be added in order to reach the expected value range size + var validator = buildValidator(buildRiskClass(VALID_LABEL, min, max, VALID_URL), + buildRiskClass(VALID_LABEL, 0, MAX_SCORE, VALID_URL)); + var expectedResult = buildExpectedResult( + buildError("minRiskLevel, maxRiskLevel", (min + ", " + max), MIN_GREATER_THAN_MAX)); + + assertThat(validator.validate()).isEqualTo(expectedResult); + } + + @ParameterizedTest + @MethodSource("createInvalidPartitionings") + void failsIfPartitioningInvalid(RiskScoreClassification invalidClassification) { + var validator = new RiskScoreClassificationValidator(invalidClassification); + int coveredRange = invalidClassification.getRiskClassesList().stream() + .mapToInt(riskScoreClass -> (riskScoreClass.getMax() - riskScoreClass.getMin() + 1)) + .sum(); + var expectedResult = buildExpectedResult( + buildError("covered value range", coveredRange, INVALID_PARTITIONING)); + + assertThat(validator.validate()).isEqualTo(expectedResult); + } + + private static Stream<Arguments> createInvalidPartitionings() { + return Stream.of( + buildClassification(buildRiskClass(VALID_LABEL, 0, 0, VALID_URL)), + buildClassification( + buildRiskClass(VALID_LABEL, 0, MAX_SCORE / 2, VALID_URL), + buildRiskClass(VALID_LABEL, MAX_SCORE / 2 + 1, MAX_SCORE, VALID_URL), + buildRiskClass(VALID_LABEL, 0, MAX_SCORE, VALID_URL)), + buildClassification( + buildRiskClass(VALID_LABEL, 0, MAX_SCORE, VALID_URL), + buildRiskClass(VALID_LABEL, 0, MAX_SCORE, VALID_URL)) + ).map(Arguments::of); + } + + @ParameterizedTest + @MethodSource("createValidClassifications") + void doesNotFailForValidClassification(RiskScoreClassification validClassification) { + var validator = new RiskScoreClassificationValidator(validClassification); + assertThat(validator.validate()).isEqualTo(new ValidationResult()); + } + + private static Stream<Arguments> createValidClassifications() { + return Stream.of( + // blank url + buildClassification(buildRiskClass(VALID_LABEL, 0, MAX_SCORE, "")), + // legit url + buildClassification(buildRiskClass(VALID_LABEL, 0, MAX_SCORE, "http://www.sap.com")), + // [0:MAX_SCORE/2][MAX_SCORE/2:MAX_SCORE] + buildClassification( + buildRiskClass(VALID_LABEL, 0, MAX_SCORE / 2, VALID_URL), + buildRiskClass(VALID_LABEL, MAX_SCORE / 2 + 1, MAX_SCORE, VALID_URL)), + // [0:MAX_SCORE-10][MAX_SCORE-9][MAX_SCORE-8:MAX_SCORE] + buildClassification( + buildRiskClass(VALID_LABEL, 0, MAX_SCORE - 10, VALID_URL), + buildRiskClass(VALID_LABEL, MAX_SCORE - 9, MAX_SCORE - 9, VALID_URL), + buildRiskClass(VALID_LABEL, MAX_SCORE - 8, MAX_SCORE, VALID_URL)) + ).map(Arguments::of); + } + + private static RiskScoreClassificationValidationError buildError(String parameter, Object value, ErrorType reason) { + return new RiskScoreClassificationValidationError(parameter, value, reason); + } + + private static RiskScoreClassificationValidator buildValidator(RiskScoreClass... riskScoreClasses) { + return new RiskScoreClassificationValidator(buildClassification(riskScoreClasses)); + } + + private static RiskScoreClassification buildClassification(RiskScoreClass... riskScoreClasses) { + return RiskScoreClassification.newBuilder().addAllRiskClasses(asList(riskScoreClasses)).build(); + } + + private static RiskScoreClass buildRiskClass(String label, int min, int max, String url) { + return RiskScoreClass.newBuilder().setLabel(label).setMin(min).setMax(max).setUrl(url).build(); + } + + private static ValidationResult buildExpectedResult(RiskScoreClassificationValidationError... errors) { + var validationResult = new ValidationResult(); + Arrays.stream(errors).forEach(validationResult::add); + return validationResult; + } +}

Add mobile configuration Mobile needs to be able to fetch additional configuration/settings from the server. The process should be similar to the exposure configuration. Therefore, add a new app-config.yaml to the codebase. The app-config should contain ```yaml risk_classes: - class: LOW max: 3 min: 1 uri: "https://www..." - class: MID max: 5 min: 3 uri: "https://www..." - class: HIGH max: 8 min: 5 uri: "https://www..." ``` We need validations & tests (also similar to exposure config). The YAML needs to be parsed to the proto message, so it can used in the distribution service for pushing to CDN.

corona-warn-app/cwa-server

corona-warn-app__cwa-server-272

73b566ec755cc61fc4c08da274c133535adb6ae7

diff --git a/docker-compose-test-secrets/certificate.crt b/docker-compose-test-secrets/certificate.crt --- a/docker-compose-test-secrets/certificate.crt +++ b/docker-compose-test-secrets/certificate.crt @@ -1,16 +1,18 @@ -----BEGIN CERTIFICATE----- -MIHxMIGkAgFkMAUGAytlcDAkMSIwIAYDVQQDDBlFTkEgVGVzdCBSb290IENlcnRp -ZmljYXRlMB4XDTIwMDQzMDE0MDQ1NVoXDTIxMDQzMDE0MDQ1NVowJjEkMCIGA1UE -AwwbRU5BIFRlc3QgQ2xpZW50IENlcnRpZmljYXRlMCowBQYDK2VwAyEAKb/6ocYD -5sIoiGUjHSCiHP3oAZxwtBicRxQVhqZhZIUwBQYDK2VwA0EAw6EUybzXxad6U39C -d1AwMBQ8b2k0pgd2VeJHn46hr5uByJ/MB+fHkgj0SkFhVbfhffcjq23FQKu7lZ/Z -HxakDA== +MIIBMjCB2AIBZDAKBggqhkjOPQQDAjAkMSIwIAYDVQQDDBlDV0EgVGVzdCBSb290 +IENlcnRpZmljYXRlMB4XDTIwMDUyMzExMzAzOFoXDTIxMDUyMzExMzAzOFowJjEk +MCIGA1UEAwwbQ1dBIFRlc3QgQ2xpZW50IENlcnRpZmljYXRlMFkwEwYHKoZIzj0C +AQYIKoZIzj0DAQcDQgAEYQJ+sReY1L8z851VFRpLu4PCusj/7Ruvi879KjrQJ12k +KKsfeRWytmrE65Jok1lsYqpFhRWcxG6VV5FX0yG+EjAKBggqhkjOPQQDAgNJADBG +AiEAwP/VKVIhOuiIczrPFg0o4ns39Wu1vBpIXu+/psI/3LECIQD0FAXo5chuUkQy +LeUtwsQaC8v2KA96ew3PfCoTilvU1Q== -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- -MIIBAjCBtQIULaMo9wOjHWZrpxuH+sN3ZPeT9EUwBQYDK2VwMCQxIjAgBgNVBAMM -GUVOQSBUZXN0IFJvb3QgQ2VydGlmaWNhdGUwHhcNMjAwNDMwMTQwNDU1WhcNMjEw -NDMwMTQwNDU1WjAkMSIwIAYDVQQDDBlFTkEgVGVzdCBSb290IENlcnRpZmljYXRl -MCowBQYDK2VwAyEADapVfRHr20spX2u6Wx8ImeoUZiJJU5cyG3zhqOl1pJAwBQYD -K2VwA0EA9MRmDLKz60SiPAWtD6HDEZB7wCEC/vUm6rMZ9+VcEXQlBlGbiIabkX8C -9pJ00fNzlbftmI8SiO/kjWSnwyCRBA== +MIIBQzCB6QIUN7Z6IofaE0qtz2X1xz/IUDCUXd0wCgYIKoZIzj0EAwIwJDEiMCAG +A1UEAwwZQ1dBIFRlc3QgUm9vdCBDZXJ0aWZpY2F0ZTAeFw0yMDA1MjMxMTMwMzha +Fw0yMTA1MjMxMTMwMzhaMCQxIjAgBgNVBAMMGUNXQSBUZXN0IFJvb3QgQ2VydGlm +aWNhdGUwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAATBH0/vPsD62wE9jk5JZZd+ +Yf4WXZ3sKZUGbdqJssc4lxjyZJvpPLCirRQT6XWwhmBhoL8mRL5tpZ/93o+jzULe +MAoGCCqGSM49BAMCA0kAMEYCIQCNPEtoC1QtgnncZzV/rgIoO6tktCiAkybBhHMB +1SISZQIhAPguoBWCscYwNHtEgTDx2sQ8UZ79KvWvpHFlwDEyiHAv -----END CERTIFICATE----- diff --git a/docker-compose-test-secrets/private.pem b/docker-compose-test-secrets/private.pem --- a/docker-compose-test-secrets/private.pem +++ b/docker-compose-test-secrets/private.pem @@ -1,3 +1,5 @@ ------BEGIN PRIVATE KEY----- -MC4CAQAwBQYDK2VwBCIEICW8533MLMm66KvHObhk7Q/gUYAJ4h/+GoO/oe5e/CbU ------END PRIVATE KEY----- +-----BEGIN EC PRIVATE KEY----- +MHcCAQEEILQRQFlGcfeTAclubtjQ1rBjtmIOB/d7PITZyDe1r81/oAoGCCqGSM49 +AwEHoUQDQgAEYQJ+sReY1L8z851VFRpLu4PCusj/7Ruvi879KjrQJ12kKKsfeRWy +tmrE65Jok1lsYqpFhRWcxG6VV5FX0yG+Eg== +-----END EC PRIVATE KEY----- diff --git a/scripts/generate_certificates.sh b/scripts/generate_certificates.sh --- a/scripts/generate_certificates.sh +++ b/scripts/generate_certificates.sh @@ -14,8 +14,10 @@ pushd certificates > /dev/null || exit # $1 = OUT Private key file generate_private_key() { - openssl genpkey \ - -algorithm ED25519 \ + openssl ecparam \ + -name prime256v1 \ + -genkey \ + -noout \ -out "$1" } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/CryptoProvider.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/CryptoProvider.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/CryptoProvider.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/CryptoProvider.java @@ -23,13 +23,14 @@ import java.io.IOException; import java.io.InputStream; import java.io.InputStreamReader; +import java.security.KeyPair; import java.security.PrivateKey; import java.security.Security; import java.security.cert.Certificate; import java.security.cert.CertificateException; import java.security.cert.CertificateFactory; -import org.bouncycastle.asn1.pkcs.PrivateKeyInfo; import org.bouncycastle.jce.provider.BouncyCastleProvider; +import org.bouncycastle.openssl.PEMKeyPair; import org.bouncycastle.openssl.PEMParser; import org.bouncycastle.openssl.jcajce.JcaPEMKeyConverter; import org.slf4j.Logger; @@ -69,11 +70,11 @@ public CryptoProvider(ResourceLoader resourceLoader) { Security.addProvider(new BouncyCastleProvider()); } - private static PrivateKey getPrivateKeyFromStream(final InputStream privateKeyStream) - throws IOException { - PEMParser pemParser = new PEMParser(new InputStreamReader(privateKeyStream)); - PrivateKeyInfo privateKeyInfo = (PrivateKeyInfo) pemParser.readObject(); - return new JcaPEMKeyConverter().getPrivateKey(privateKeyInfo); + private static PrivateKey getPrivateKeyFromStream(final InputStream privateKeyStream) throws IOException { + InputStreamReader privateKeyStreamReader = new InputStreamReader(privateKeyStream); + Object parsed = new PEMParser(privateKeyStreamReader).readObject(); + KeyPair pair = new JcaPEMKeyConverter().getKeyPair((PEMKeyPair) parsed); + return pair.getPrivate(); } private static Certificate getCertificateFromStream(final InputStream certificateStream) diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/archive/decorator/signing/AbstractSigningDecorator.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/archive/decorator/signing/AbstractSigningDecorator.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/archive/decorator/signing/AbstractSigningDecorator.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/archive/decorator/signing/AbstractSigningDecorator.java @@ -37,7 +37,7 @@ public abstract class AbstractSigningDecorator<W extends Writable<W>> extends Ar SigningDecorator<W> { private static final String SIGNATURE_FILE_NAME = "export.sig"; - private static final String SIGNATURE_ALGORITHM = "Ed25519"; + private static final String SIGNATURE_ALGORITHM = "SHA256withECDSA"; private static final String SECURITY_PROVIDER = "BC"; private static final Logger logger = LoggerFactory.getLogger(AbstractSigningDecorator.class);

diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/RiskScoreClassificationProviderMasterFileTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/RiskScoreClassificationProviderMasterFileTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/RiskScoreClassificationProviderMasterFileTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/RiskScoreClassificationProviderMasterFileTest.java @@ -21,15 +21,13 @@ import static org.assertj.core.api.Assertions.assertThat; -import app.coronawarn.server.services.distribution.assembly.appconfig.validation.ExposureConfigurationValidator; import app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidator; import app.coronawarn.server.services.distribution.assembly.appconfig.validation.ValidationResult; import org.junit.jupiter.api.Test; /** * This test will verify that the provided risk score classification master file is syntactically correct and according - * to spec. - * There should never be any deployment when this test is failing. + * to spec. There should never be any deployment when this test is failing. */ public class RiskScoreClassificationProviderMasterFileTest { diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/archive/decorator/signing/SigningDecoratorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/archive/decorator/signing/SigningDecoratorTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/archive/decorator/signing/SigningDecoratorTest.java @@ -0,0 +1,135 @@ +package app.coronawarn.server.services.distribution.assembly.structure.archive.decorator.signing; + +import static org.assertj.core.api.Assertions.assertThat; + +import app.coronawarn.server.common.protocols.external.exposurenotification.SignatureInfo; +import app.coronawarn.server.common.protocols.external.exposurenotification.TEKSignature; +import app.coronawarn.server.common.protocols.external.exposurenotification.TEKSignatureList; +import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; +import app.coronawarn.server.services.distribution.assembly.structure.WritableOnDisk; +import app.coronawarn.server.services.distribution.assembly.structure.archive.Archive; +import app.coronawarn.server.services.distribution.assembly.structure.archive.ArchiveOnDisk; +import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; +import app.coronawarn.server.services.distribution.assembly.structure.directory.DirectoryOnDisk; +import app.coronawarn.server.services.distribution.assembly.structure.file.File; +import app.coronawarn.server.services.distribution.assembly.structure.file.FileOnDisk; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; +import java.io.IOException; +import java.security.InvalidKeyException; +import java.security.NoSuchAlgorithmException; +import java.security.NoSuchProviderException; +import java.security.Signature; +import java.security.SignatureException; +import java.util.List; +import org.junit.Rule; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.junit.rules.TemporaryFolder; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.ConfigFileApplicationContextInitializer; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit.jupiter.SpringExtension; + +@ExtendWith(SpringExtension.class) +@ContextConfiguration(classes = {CryptoProvider.class}, + initializers = ConfigFileApplicationContextInitializer.class) +class SigningDecoratorTest { + + @Autowired + CryptoProvider cryptoProvider; + + private File<WritableOnDisk> fileToSign; + private TEKSignatureList signatureList; + + @Rule + private TemporaryFolder outputFolder = new TemporaryFolder(); + + @BeforeEach + void setup() throws IOException { + Archive<WritableOnDisk> archive = new ArchiveOnDisk("export.zip"); + fileToSign = new FileOnDisk("export.bin", "123456".getBytes()); + archive.addWritable(fileToSign); + + SigningDecorator<WritableOnDisk> signingDecorator = new TestSigningDecorator(archive, cryptoProvider); + + outputFolder.create(); + java.io.File outputDir = outputFolder.newFolder(); + Directory<WritableOnDisk> directory = new DirectoryOnDisk(outputDir); + directory.addWritable(signingDecorator); + directory.prepare(new ImmutableStack<>()); + + File<WritableOnDisk> signatureFile = archive.getWritables().stream() + .filter(writable -> writable.getName().equals("export.sig")) + .map(writable -> (File<WritableOnDisk>) writable) + .findFirst() + .orElseThrow(); + + signatureList = TEKSignatureList.parseFrom(signatureFile.getBytes()); + } + + @Test + void checkSignatureFileStructure() { + + assertThat(signatureList).isNotNull(); + + List<TEKSignature> signatures = signatureList.getSignaturesList(); + assertThat(signatures).hasSize(1); + + TEKSignature signature = signatures.get(0); + assertThat(signature.getSignatureInfo()).isNotNull(); + assertThat(signature.getBatchNum()).isEqualTo(1); + assertThat(signature.getBatchSize()).isEqualTo(1); + assertThat(signature.getSignature()).isNotEmpty(); + } + + @Test + void checkSignatureInfo() { + SignatureInfo signatureInfo = signatureList.getSignaturesList().get(0).getSignatureInfo(); + + assertThat(signatureInfo.getAppBundleId()).isEqualTo("de.rki.coronawarnapp"); + assertThat(signatureInfo.getAndroidPackage()).isEqualTo("de.rki.coronawarnapp"); + assertThat(signatureInfo.getSignatureAlgorithm()).isEqualTo("1.2.840.10045.4.3.2"); + assertThat(signatureInfo.getVerificationKeyId()).isEmpty(); + assertThat(signatureInfo.getVerificationKeyVersion()).isEmpty(); + } + + @Test + void checkSignature() + throws NoSuchProviderException, NoSuchAlgorithmException, InvalidKeyException, SignatureException { + byte[] fileBytes = fileToSign.getBytes(); + byte[] signatureBytes = signatureList.getSignaturesList().get(0).getSignature().toByteArray(); + + Signature payloadSignature = Signature.getInstance("SHA256withECDSA", "BC"); + payloadSignature.initVerify(cryptoProvider.getCertificate()); + payloadSignature.update(fileBytes); + assertThat(payloadSignature.verify(signatureBytes)).isTrue(); + } + + private static class TestSigningDecorator extends SigningDecoratorOnDisk { + + public TestSigningDecorator(Archive<WritableOnDisk> archive, CryptoProvider cryptoProvider) { + super(archive, cryptoProvider); + } + + @Override + public byte[] getBytesToSign() { + return this.getWritables().stream() + .filter(writable -> writable.getName().equals("export.bin")) + .map(writable -> (File<WritableOnDisk>) writable) + .map(File::getBytes) + .findFirst() + .orElseThrow(); + } + + @Override + public int getBatchNum() { + return 1; + } + + @Override + public int getBatchSize() { + return 1; + } + } +} diff --git a/services/distribution/src/test/resources/certificates/chain/certificate.crt b/services/distribution/src/test/resources/certificates/chain/certificate.crt --- a/services/distribution/src/test/resources/certificates/chain/certificate.crt +++ b/services/distribution/src/test/resources/certificates/chain/certificate.crt @@ -1,16 +1,18 @@ -----BEGIN CERTIFICATE----- -MIHxMIGkAgFkMAUGAytlcDAkMSIwIAYDVQQDDBlFTkEgVGVzdCBSb290IENlcnRp -ZmljYXRlMB4XDTIwMDQzMDE0MDQ1NVoXDTIxMDQzMDE0MDQ1NVowJjEkMCIGA1UE -AwwbRU5BIFRlc3QgQ2xpZW50IENlcnRpZmljYXRlMCowBQYDK2VwAyEAKb/6ocYD -5sIoiGUjHSCiHP3oAZxwtBicRxQVhqZhZIUwBQYDK2VwA0EAw6EUybzXxad6U39C -d1AwMBQ8b2k0pgd2VeJHn46hr5uByJ/MB+fHkgj0SkFhVbfhffcjq23FQKu7lZ/Z -HxakDA== +MIIBMjCB2AIBZDAKBggqhkjOPQQDAjAkMSIwIAYDVQQDDBlDV0EgVGVzdCBSb290 +IENlcnRpZmljYXRlMB4XDTIwMDUyMzExMzAzOFoXDTIxMDUyMzExMzAzOFowJjEk +MCIGA1UEAwwbQ1dBIFRlc3QgQ2xpZW50IENlcnRpZmljYXRlMFkwEwYHKoZIzj0C +AQYIKoZIzj0DAQcDQgAEYQJ+sReY1L8z851VFRpLu4PCusj/7Ruvi879KjrQJ12k +KKsfeRWytmrE65Jok1lsYqpFhRWcxG6VV5FX0yG+EjAKBggqhkjOPQQDAgNJADBG +AiEAwP/VKVIhOuiIczrPFg0o4ns39Wu1vBpIXu+/psI/3LECIQD0FAXo5chuUkQy +LeUtwsQaC8v2KA96ew3PfCoTilvU1Q== -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- -MIIBAjCBtQIULaMo9wOjHWZrpxuH+sN3ZPeT9EUwBQYDK2VwMCQxIjAgBgNVBAMM -GUVOQSBUZXN0IFJvb3QgQ2VydGlmaWNhdGUwHhcNMjAwNDMwMTQwNDU1WhcNMjEw -NDMwMTQwNDU1WjAkMSIwIAYDVQQDDBlFTkEgVGVzdCBSb290IENlcnRpZmljYXRl -MCowBQYDK2VwAyEADapVfRHr20spX2u6Wx8ImeoUZiJJU5cyG3zhqOl1pJAwBQYD -K2VwA0EA9MRmDLKz60SiPAWtD6HDEZB7wCEC/vUm6rMZ9+VcEXQlBlGbiIabkX8C -9pJ00fNzlbftmI8SiO/kjWSnwyCRBA== +MIIBQzCB6QIUN7Z6IofaE0qtz2X1xz/IUDCUXd0wCgYIKoZIzj0EAwIwJDEiMCAG +A1UEAwwZQ1dBIFRlc3QgUm9vdCBDZXJ0aWZpY2F0ZTAeFw0yMDA1MjMxMTMwMzha +Fw0yMTA1MjMxMTMwMzhaMCQxIjAgBgNVBAMMGUNXQSBUZXN0IFJvb3QgQ2VydGlm +aWNhdGUwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAATBH0/vPsD62wE9jk5JZZd+ +Yf4WXZ3sKZUGbdqJssc4lxjyZJvpPLCirRQT6XWwhmBhoL8mRL5tpZ/93o+jzULe +MAoGCCqGSM49BAMCA0kAMEYCIQCNPEtoC1QtgnncZzV/rgIoO6tktCiAkybBhHMB +1SISZQIhAPguoBWCscYwNHtEgTDx2sQ8UZ79KvWvpHFlwDEyiHAv -----END CERTIFICATE----- diff --git a/services/distribution/src/test/resources/certificates/client/private.pem b/services/distribution/src/test/resources/certificates/client/private.pem --- a/services/distribution/src/test/resources/certificates/client/private.pem +++ b/services/distribution/src/test/resources/certificates/client/private.pem @@ -1,3 +1,5 @@ ------BEGIN PRIVATE KEY----- -MC4CAQAwBQYDK2VwBCIEICW8533MLMm66KvHObhk7Q/gUYAJ4h/+GoO/oe5e/CbU ------END PRIVATE KEY----- +-----BEGIN EC PRIVATE KEY----- +MHcCAQEEILQRQFlGcfeTAclubtjQ1rBjtmIOB/d7PITZyDe1r81/oAoGCCqGSM49 +AwEHoUQDQgAEYQJ+sReY1L8z851VFRpLu4PCusj/7Ruvi879KjrQJ12kKKsfeRWy +tmrE65Jok1lsYqpFhRWcxG6VV5FX0yG+Eg== +-----END EC PRIVATE KEY-----

Update signature algorithm to SHA-256 + ECDSA P-256 ## Feature description The current CWA server implementation signs diagnosis key packages with the ``Ed25519`` algorithm. However, the current [Google/Apple spec](https://developer.apple.com/documentation/exposurenotification/setting_up_an_exposure_notification_server) demands ``SHA-256`` hash with ``ECDSA P-256`` signature ([OID 1.2.840.10045.4.3.2](http://oid-info.com/get/1.2.840.10045.4.3.2))

corona-warn-app/cwa-server

corona-warn-app__cwa-server-277

576fd8b20079374458ffb650fe63ca6002e84a39

diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ <a href="https://github.com/corona-warn-app/cwa-server/commits/" title="Last Commit"><img src="https://img.shields.io/github/last-commit/corona-warn-app/cwa-server?style=flat"></a> <a href="https://github.com/corona-warn-app/cwa-server/issues" title="Open Issues"><img src="https://img.shields.io/github/issues/corona-warn-app/cwa-server?style=flat"></a> <a href="https://circleci.com/gh/corona-warn-app/cwa-server" title="Build Status"><img src="https://circleci.com/gh/corona-warn-app/cwa-server.svg?style=shield&circle-token=4ab059989d10709df19eb4b98ab7c121a25e981a"></a> - <a href="https://sonarcloud.io/dashboard?id=corona-warn-app_cwa-server" title="Quality Gate"><img src="https://sonarcloud.io/api/project_badges/measure?project=corona-warn-app_cwa-server&metric=alert_status"></a> + <a href="https://sonarcloud.io/dashboard?id=corona-warn-app_cwa-server" title="Quality Gate"><img src="https://sonarcloud.io/api/project_badges/measure?project=corona-warn-app_cwa-server&metric=alert_status"></a> <a href="https://sonarcloud.io/component_measures?id=corona-warn-app_cwa-server&metric=Coverage&view=list" title="Coverage"><img src="https://sonarcloud.io/api/project_badges/measure?project=corona-warn-app_cwa-server&metric=coverage"></a> <a href="https://github.com/corona-warn-app/cwa-server/blob/master/LICENSE" title="License"><img src="https://img.shields.io/badge/License-Apache%202.0-green.svg?style=flat"></a> </p> @@ -57,7 +57,7 @@ The docker-compose contains the following services: Service | Description | Endpoint and Default Credentials --------------|-------------|----------- -submission | The Corona-Warn-App submission service | http://localhost:8000 +submission | The Corona-Warn-App submission service | http://localhost:8000 distribution | The Corona-Warn-App distribution service | NO ENDPOINT postgres | A [postgres] database installation | postgres:8001 <br> Username: postgres <br> Password: postgres pgadmin | A [pgadmin](https://www.pgadmin.org/) installation for the postgres database | http://localhost:8002 <br> Username: [email protected] <br> Password: password @@ -99,8 +99,8 @@ To prepare your machine to run the CWA project locally, we recommend that you fi After you made sure that the specified dependencies are running, configure them in the respective configuration files. -* Configure the Postgres connection in the [submission config](./services/submission/src/main/resources/application.properties) and in the [distribution config](./services/distribution/src/main/resources/application.properties) -* Configure the S3 compatible object storage in the [distribution config](./services/distribution/src/main/resources/application.properties) +* Configure the Postgres connection in the [submission config](./services/submission/src/main/resources/application.yaml) and in the [distribution config](./services/distribution/src/main/resources/application.yaml) +* Configure the S3 compatible object storage in the [distribution config](./services/distribution/src/main/resources/application.yaml) * Configure the certificate and private key for the distribution service, the paths need to be prefixed with `file:` * `VAULT_FILESIGNING_SECRET` should be the path to the private key, example available in `<repo-root>/docker-compose-test-secrets/private.pem` * `VAULT_FILESIGNING_CERT` should be the path to the certificate, example available in `<repo-root>/docker-compose-test-secrets/certificate.cert` @@ -181,7 +181,7 @@ The following public repositories are currently available for the Corona-Warn-Ap Copyright (c) 2020 SAP SE or an SAP affiliate company. -Licensed under the **Apache License, Version 2.0** (the "License"); you may not use this file except in compliance with the License. +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. diff --git a/services/distribution/src/main/resources/application-cloud.properties b/services/distribution/src/main/resources/application-cloud.properties deleted file mode 100644 --- a/services/distribution/src/main/resources/application-cloud.properties +++ /dev/null @@ -1,9 +0,0 @@ -spring.flyway.enabled=true -spring.flyway.locations=classpath:db/migration/postgres - -spring.datasource.driver-class-name=org.postgresql.Driver -spring.datasource.url=jdbc:postgresql://${POSTGRESQL_SERVICE_HOST}:${POSTGRESQL_SERVICE_PORT}/${POSTGRESQL_DATABASE} -spring.datasource.username=${POSTGRESQL_USER} -spring.datasource.password=${POSTGRESQL_PASSWORD} - -services.distribution.paths.output=/tmp/distribution \ No newline at end of file diff --git a/services/distribution/src/main/resources/application-cloud.yaml b/services/distribution/src/main/resources/application-cloud.yaml new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/resources/application-cloud.yaml @@ -0,0 +1,22 @@ +--- +spring: + flyway: + enabled: true + locations: classpath:db/migration/postgres + datasource: + driver-class-name: org.postgresql.Driver + url: jdbc:postgresql://${POSTGRESQL_SERVICE_HOST}:${POSTGRESQL_SERVICE_PORT}/${POSTGRESQL_DATABASE} + username: ${POSTGRESQL_USER} + password: ${POSTGRESQL_PASSWORD} + +services: + distribution: + paths: + output: /tmp/distribution + objectstore: + access-key: ${CWA_OBJECTSTORE_ACCESSKEY} + secret-key: ${CWA_OBJECTSTORE_SECRETKEY} + endpoint: ${CWA_OBJECTSTORE_ENDPOINT} + bucket: ${CWA_OBJECTSTORE_BUCKET} + port: ${CWA_OBJECTSTORE_PORT} + set-public-read-acl-on-put-object: false diff --git a/services/distribution/src/main/resources/application-dev.properties b/services/distribution/src/main/resources/application-dev.properties deleted file mode 100644 --- a/services/distribution/src/main/resources/application-dev.properties +++ /dev/null @@ -1,2 +0,0 @@ -logging.level.org.springframework.web=DEBUG -logging.level.app.coronawarn=DEBUG \ No newline at end of file diff --git a/services/distribution/src/main/resources/application-dev.yaml b/services/distribution/src/main/resources/application-dev.yaml new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/resources/application-dev.yaml @@ -0,0 +1,8 @@ +--- +logging: + level: + org: + springframework: + web: DEBUG + app: + coronawarn: DEBUG diff --git a/services/distribution/src/main/resources/application-testdata.properties b/services/distribution/src/main/resources/application-testdata.properties deleted file mode 100644 --- a/services/distribution/src/main/resources/application-testdata.properties +++ /dev/null @@ -1,2 +0,0 @@ -services.distribution.testdata.seed=123456 -services.distribution.testdata.exposures-per-hour=1000 \ No newline at end of file diff --git a/services/distribution/src/main/resources/application-testdata.yaml b/services/distribution/src/main/resources/application-testdata.yaml new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/resources/application-testdata.yaml @@ -0,0 +1,6 @@ +--- +services: + distribution: + testdata: + seed: 123456 + exposures-per-hour: 1000 diff --git a/services/distribution/src/main/resources/application.properties b/services/distribution/src/main/resources/application.properties deleted file mode 100644 --- a/services/distribution/src/main/resources/application.properties +++ /dev/null @@ -1,52 +0,0 @@ -logging.level.org.springframework.web=INFO -logging.level.app.coronawarn=INFO -spring.main.web-application-type=NONE - -services.distribution.retention-days=14 -services.distribution.output-file-name=index -services.distribution.tek-export.file-name=export.bin -services.distribution.tek-export.file-header=EK Export v1 -services.distribution.tek-export.file-header-width=16 - -services.distribution.paths.output=out -services.distribution.paths.privatekey=${VAULT_FILESIGNING_SECRET} -services.distribution.paths.certificate=${VAULT_FILESIGNING_CERT} - -services.distribution.api.version-path=version -services.distribution.api.version-v1=v1 -services.distribution.api.country-path=country -services.distribution.api.country-germany=DE -services.distribution.api.date-path=date -services.distribution.api.hour-path=hour -services.distribution.api.diagnosis-keys-path=diagnosis-keys -services.distribution.api.parameters-path=configuration -services.distribution.api.parameters-exposure-configuration-file-name=exposure_configuration -services.distribution.api.parameters-risk-score-classification-file-name=risk_score_classification - -services.distribution.signature.app-bundle-id=de.rki.coronawarnapp -services.distribution.signature.android-package=de.rki.coronawarnapp -services.distribution.signature.verification-key-id= -services.distribution.signature.verification-key-version= -services.distribution.signature.algorithm-oid=1.2.840.10045.4.3.2 -services.distribution.signature.algorithm-name=SHA256withECDSA -services.distribution.signature.file-name=export.sig -services.distribution.signature.security-provider=BC - -# Configuration for the S3 compatible object storage hosted by Telekom in Germany -services.distribution.objectstore.access-key=${CWA_OBJECTSTORE_ACCESSKEY:accessKey1} -services.distribution.objectstore.secret-key=${CWA_OBJECTSTORE_SECRETKEY:verySecretKey1} -services.distribution.objectstore.endpoint=${CWA_OBJECTSTORE_ENDPOINT:http\://localhost\:8003} -services.distribution.objectstore.bucket=${CWA_OBJECTSTORE_BUCKET:cwa} -services.distribution.objectstore.port=${CWA_OBJECTSTORE_PORT:8003} -services.distribution.objectstore.set-public-read-acl-on-put-object=true - -# Postgres configuration -spring.jpa.hibernate.ddl-auto=validate - -spring.flyway.enabled=true -spring.flyway.locations=classpath:db/migration/postgres - -spring.datasource.driver-class-name=org.postgresql.Driver -spring.datasource.url=jdbc:postgresql://${POSTGRESQL_SERVICE_HOST:localhost}:${POSTGRESQL_SERVICE_PORT:5432}/${POSTGRESQL_DATABASE:cwa} -spring.datasource.username=${POSTGRESQL_USER:postgres} -spring.datasource.password=${POSTGRESQL_PASSWORD:postgres} diff --git a/services/distribution/src/main/resources/application.yaml b/services/distribution/src/main/resources/application.yaml new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/resources/application.yaml @@ -0,0 +1,66 @@ +--- +logging: + level: + org: + springframework: + web: INFO + app: + coronawarn: INFO + +services: + distribution: + output-file-name: index + retention-days: 14 + paths: + output: out + privatekey: ${VAULT_FILESIGNING_SECRET} + certificate: ${VAULT_FILESIGNING_CERT} + tek-export: + file-name: export.bin + file-header: EK Export v1 + file-header-width: 16 + api: + version-path: version + version-v1: v1 + country-path: country + country-germany: DE + date-path: date + hour-path: hour + diagnosis-keys-path: diagnosis-keys + parameters-path: configuration + parameters-exposure-configuration-file-name: exposure_configuration + parameters-risk-score-classification-file-name: risk_score_classification + signature: + app-bundle-id: de.rki.coronawarnapp + android-package: de.rki.coronawarnapp + verification-key-id: + verification-key-version: + algorithm-oid: 1.2.840.10045.4.3.2 + algorithm-name: SHA256withECDSA + file-name: export.sig + security-provider: BC + # Configuration for the S3 compatible object storage hosted by Telekom in Germany + objectstore: + access-key: ${CWA_OBJECTSTORE_ACCESSKEY:accessKey1} + secret-key: ${CWA_OBJECTSTORE_SECRETKEY:verySecretKey1} + endpoint: ${CWA_OBJECTSTORE_ENDPOINT:http\://localhost\:8003} + bucket: ${CWA_OBJECTSTORE_BUCKET:cwa} + port: ${CWA_OBJECTSTORE_PORT:8003} + set-public-read-acl-on-put-object: true + +spring: + main: + web-application-type: NONE +# Postgres configuration + jpa: + hibernate: + ddl-auto: validate + flyway: + enabled: true + locations: classpath:db/migration/postgres + + datasource: + driver-class-name: org.postgresql.Driver + url: jdbc:postgresql://${POSTGRESQL_SERVICE_HOST:localhost}:${POSTGRESQL_SERVICE_PORT:5432}/${POSTGRESQL_DATABASE:cwa} + username: ${POSTGRESQL_USER:postgres} + password: ${POSTGRESQL_PASSWORD:postgres} diff --git a/services/submission/src/main/resources/application-cloud.properties b/services/submission/src/main/resources/application-cloud.properties deleted file mode 100644 --- a/services/submission/src/main/resources/application-cloud.properties +++ /dev/null @@ -1,6 +0,0 @@ -spring.flyway.locations=classpath:db/migration/postgres - -spring.datasource.driver-class-name=org.postgresql.Driver -spring.datasource.url=jdbc:postgresql://${POSTGRESQL_SERVICE_HOST}:${POSTGRESQL_SERVICE_PORT}/${POSTGRESQL_DATABASE} -spring.datasource.username=${POSTGRESQL_USER} -spring.datasource.password=${POSTGRESQL_PASSWORD} \ No newline at end of file diff --git a/services/submission/src/main/resources/application-cloud.yaml b/services/submission/src/main/resources/application-cloud.yaml new file mode 100644 --- /dev/null +++ b/services/submission/src/main/resources/application-cloud.yaml @@ -0,0 +1,9 @@ +--- +spring: + flyway: + locations: classpath:db/migration/postgres + datasource: + driver-class-name: org.postgresql.Driver + url: jdbc:postgresql://${POSTGRESQL_SERVICE_HOST}:${POSTGRESQL_SERVICE_PORT}/${POSTGRESQL_DATABASE} + username: ${POSTGRESQL_USER} + password: ${POSTGRESQL_PASSWORD} diff --git a/services/submission/src/main/resources/application-config-test.properties b/services/submission/src/main/resources/application-config-test.properties deleted file mode 100644 --- a/services/submission/src/main/resources/application-config-test.properties +++ /dev/null @@ -1,4 +0,0 @@ -services.submission.initial_fake_delay_milliseconds=100.0 -services.submission.fake_delay_moving_average_samples=1.0 -services.submission.retention-days=10 -services.submission.payload.max-number-of-keys=1000 \ No newline at end of file diff --git a/services/submission/src/main/resources/application-dev.properties b/services/submission/src/main/resources/application-dev.properties deleted file mode 100644 --- a/services/submission/src/main/resources/application-dev.properties +++ /dev/null @@ -1 +0,0 @@ -logging.level.org.springframework.web=DEBUG diff --git a/services/submission/src/main/resources/application-dev.yaml b/services/submission/src/main/resources/application-dev.yaml new file mode 100644 --- /dev/null +++ b/services/submission/src/main/resources/application-dev.yaml @@ -0,0 +1,6 @@ +--- +logging: + level: + org: + springframework: + web: DEBUG diff --git a/services/submission/src/main/resources/application.properties b/services/submission/src/main/resources/application.properties deleted file mode 100644 --- a/services/submission/src/main/resources/application.properties +++ /dev/null @@ -1,20 +0,0 @@ -logging.level.org.springframework.web=INFO - -# The initial value of the moving average for fake request delays. -services.submission.initial_fake_delay_milliseconds=10 -# The number of samples for the calculation of the moving average for fake request delays. -services.submission.fake_delay_moving_average_samples=10 - -services.submission.retention-days=14 -services.submission.payload.max-number-of-keys=14 - -spring.jpa.hibernate.ddl-auto=validate -spring.flyway.enabled=true - -spring.flyway.locations=classpath:db/migration/postgres - -# Postgres configuration -spring.datasource.driver-class-name=org.postgresql.Driver -spring.datasource.url=jdbc:postgresql://${POSTGRESQL_SERVICE_HOST:localhost}:${POSTGRESQL_SERVICE_PORT:5432}/${POSTGRESQL_DATABASE:cwa} -spring.datasource.username=${POSTGRESQL_USER:postgres} -spring.datasource.password=${POSTGRESQL_PASSWORD:postgres} diff --git a/services/submission/src/main/resources/application.yaml b/services/submission/src/main/resources/application.yaml new file mode 100644 --- /dev/null +++ b/services/submission/src/main/resources/application.yaml @@ -0,0 +1,30 @@ +--- +logging: + level: + org: + springframework: + web: INFO + +# The initial value of the moving average for fake request delays. +services: + submission: + initial-fake-delay-milliseconds: 10 + # The number of samples for the calculation of the moving average for fake request delays. + fake-delay-moving-average-samples: 10 + retention-days: 14 + payload: + max-number-of-keys: 14 + +spring: + jpa: + hibernate: + ddl-auto: validate + flyway: + enabled: true + locations: classpath:db/migration/postgres +# Postgres configuration + datasource: + driver-class-name: org.postgresql.Driver + url: jdbc:postgresql://${POSTGRESQL_SERVICE_HOST:localhost}:${POSTGRESQL_SERVICE_PORT:5432}/${POSTGRESQL_DATABASE:cwa} + username: ${POSTGRESQL_USER:postgres} + password: ${POSTGRESQL_PASSWORD:postgres}

diff --git a/common/persistence/src/test/resources/application.properties b/common/persistence/src/test/resources/application.properties deleted file mode 100644 --- a/common/persistence/src/test/resources/application.properties +++ /dev/null @@ -1,6 +0,0 @@ -spring.flyway.enabled=false -spring.jpa.hibernate.ddl-auto=create -spring.jpa.properties.hibernate.show_sql=false -spring.main.banner-mode=off -logging.level.org.springframework=off -logging.level.root=off \ No newline at end of file diff --git a/common/persistence/src/test/resources/application.yaml b/common/persistence/src/test/resources/application.yaml new file mode 100644 --- /dev/null +++ b/common/persistence/src/test/resources/application.yaml @@ -0,0 +1,17 @@ +--- +spring: + flyway: + enabled: false + jpa: + hibernate: + ddl-auto: create + properties: + hibernate: + show-sql: false + main: + banner-mode: off +logging: + level: + org: + springframework: off + root: off diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/component/CryptoProviderTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/component/CryptoProviderTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/component/CryptoProviderTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/component/CryptoProviderTest.java @@ -28,7 +28,6 @@ import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.boot.test.context.ConfigFileApplicationContextInitializer; import org.springframework.test.context.ContextConfiguration; -import org.springframework.test.context.TestPropertySource; import org.springframework.test.context.junit.jupiter.SpringExtension; @EnableConfigurationProperties(value = DistributionServiceConfig.class) diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDirectoryTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDirectoryTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDirectoryTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDirectoryTest.java @@ -50,7 +50,6 @@ import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.boot.test.context.ConfigFileApplicationContextInitializer; import org.springframework.test.context.ContextConfiguration; -import org.springframework.test.context.TestPropertySource; import org.springframework.test.context.junit.jupiter.SpringExtension; @EnableConfigurationProperties(value = DistributionServiceConfig.class) diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/config/DistributionServiceConfigTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/config/DistributionServiceConfigTest.java deleted file mode 100644 --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/config/DistributionServiceConfigTest.java +++ /dev/null @@ -1,91 +0,0 @@ -package app.coronawarn.server.services.distribution.config; - -import static org.springframework.test.util.AssertionErrors.assertNotNull; -import static org.springframework.test.util.AssertionErrors.assertNull; - -import static org.assertj.core.api.Assertions.assertThat; -import java.io.IOException; -import java.io.InputStream; -import java.util.HashMap; -import java.util.Map; -import java.util.Properties; -import org.junit.jupiter.api.AfterEach; -import org.junit.jupiter.api.BeforeEach; -import org.junit.jupiter.api.Test; -import org.junit.jupiter.api.extension.ExtendWith; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.boot.context.properties.EnableConfigurationProperties; -import org.springframework.test.context.TestPropertySource; -import org.springframework.test.context.junit.jupiter.SpringExtension; - -@ExtendWith(SpringExtension.class) -@EnableConfigurationProperties(value = DistributionServiceConfig.class) -@TestPropertySource("classpath:application.properties") -public class DistributionServiceConfigTest { - - @Autowired - private DistributionServiceConfig dsc; - - private final Properties properties = new Properties(); - - @BeforeEach - public void setup() throws IOException { - InputStream is = getClass().getClassLoader().getResourceAsStream("application.properties"); - properties.load(is); - } - - @AfterEach - public void tearDown() { - properties.clear(); - } - - @Test - void whenDistributionConfigBeanCreatedThenPropertiesLoadedCorrectly() { - - assertNotNull("Configuration should not be null", dsc); - assertNotNull("Paths should not be null", dsc.getPaths()); - assertNull("TestData should be null", dsc.getTestData()); - assertNotNull("Signature should not be null", dsc.getSignature()); - assertNotNull("API should not be null", dsc.getApi()); - - Map<String, String> cp = new HashMap<>(); - cp.put("services.distribution.retention-days", dsc.getRetentionDays().toString()); - cp.put("services.distribution.output-file-name", dsc.getOutputFileName()); - cp.put("services.distribution.tek-export.file-name", dsc.getTekExport().getFileName()); - cp.put("services.distribution.tek-export.file-header", dsc.getTekExport().getFileHeader()); - cp.put("services.distribution.tek-export.file-header-width", dsc.getTekExport().getFileHeaderWidth().toString()); - cp.put("services.distribution.paths.privatekey", dsc.getPaths().getPrivateKey()); - cp.put("services.distribution.paths.certificate", dsc.getPaths().getCertificate()); - cp.put("services.distribution.paths.output", dsc.getPaths().getOutput()); - cp.put("services.distribution.signature.app-bundle-id", dsc.getSignature().getAppBundleId()); - cp.put("services.distribution.signature.android-package", dsc.getSignature().getAndroidPackage()); - cp.put("services.distribution.signature.verification-key-id", dsc.getSignature().getVerificationKeyId()); - cp.put("services.distribution.signature.verification-key-version", dsc.getSignature().getVerificationKeyVersion()); - cp.put("services.distribution.signature.algorithm-oid", dsc.getSignature().getAlgorithmOid()); - cp.put("services.distribution.signature.algorithm-name", dsc.getSignature().getAlgorithmName()); - cp.put("services.distribution.signature.file-name", dsc.getSignature().getFileName()); - cp.put("services.distribution.signature.security-provider", dsc.getSignature().getSecurityProvider()); - cp.put("services.distribution.api.version-path", dsc.getApi().getVersionPath()); - cp.put("services.distribution.api.version-v1", dsc.getApi().getVersionV1()); - cp.put("services.distribution.api.country-path", dsc.getApi().getCountryPath()); - cp.put("services.distribution.api.country-germany", dsc.getApi().getCountryGermany()); - cp.put("services.distribution.api.date-path", dsc.getApi().getDatePath()); - cp.put("services.distribution.api.hour-path", dsc.getApi().getHourPath()); - cp.put("services.distribution.api.diagnosis-keys-path", dsc.getApi().getDiagnosisKeysPath()); - cp.put("services.distribution.api.parameters-path", dsc.getApi().getParametersPath()); - cp.put("services.distribution.api.parameters-exposure-configuration-file-name", - dsc.getApi().getParametersExposureConfigurationFileName()); - cp.put("services.distribution.api.parameters-risk-score-classification-file-name", - dsc.getApi().getParametersRiskScoreClassificationFileName()); - cp.put("services.distribution.objectstore.access-key", dsc.getObjectStore().getAccessKey()); - cp.put("services.distribution.objectstore.secret-key", dsc.getObjectStore().getSecretKey()); - cp.put("services.distribution.objectstore.endpoint", dsc.getObjectStore().getEndpoint()); - cp.put("services.distribution.objectstore.bucket", dsc.getObjectStore().getBucket()); - cp.put("services.distribution.objectstore.port", dsc.getObjectStore().getPort().toString()); - cp.put("services.distribution.objectstore.set-public-read-acl-on-put-object", - dsc.getObjectStore().isSetPublicReadAclOnPutObject().toString()); - - cp.forEach((key, value) -> assertThat(properties.getProperty(key)).isEqualTo(value)); - } - -} diff --git a/services/distribution/src/test/resources/application.properties b/services/distribution/src/test/resources/application.properties deleted file mode 100644 --- a/services/distribution/src/test/resources/application.properties +++ /dev/null @@ -1,47 +0,0 @@ -logging.level.org.springframework=off -logging.level.root=info -spring.main.banner-mode=off - -services.distribution.retention-days=14 -services.distribution.output-file-name=index -services.distribution.tek-export.file-name=export.bin -services.distribution.tek-export.file-header=EK Export v1 -services.distribution.tek-export.file-header-width=16 - -services.distribution.paths.output=out -services.distribution.paths.privatekey=classpath:certificates/client/private.pem -services.distribution.paths.certificate=classpath:certificates/chain/certificate.crt - -services.distribution.api.version-path=version -services.distribution.api.version-v1=v1 -services.distribution.api.country-path=country -services.distribution.api.country-germany=DE -services.distribution.api.date-path=date -services.distribution.api.hour-path=hour -services.distribution.api.diagnosis-keys-path=diagnosis-keys -services.distribution.api.parameters-path=configuration -services.distribution.api.parameters-exposure-configuration-file-name=exposure_configuration -services.distribution.api.parameters-risk-score-classification-file-name=risk_score_classification - -services.distribution.signature.app-bundle-id=de.rki.coronawarnapp -services.distribution.signature.android-package=de.rki.coronawarnapp -services.distribution.signature.verification-key-id= -services.distribution.signature.verification-key-version= -services.distribution.signature.algorithm-oid=1.2.840.10045.4.3.2 -services.distribution.signature.algorithm-name=SHA256withECDSA -services.distribution.signature.file-name=export.sig -services.distribution.signature.security-provider=BC - -spring.flyway.enabled=true -# default case is H2 - value will be overwritten by profile cloud or postgres -spring.flyway.locations=classpath:db/migration/h2 - -spring.jpa.hibernate.ddl-auto=validate - -# S3 object store configuration -services.distribution.objectstore.access-key=accessKey1 -services.distribution.objectstore.secret-key=verySecretKey1 -services.distribution.objectstore.endpoint=http\://localhost\:8003 -services.distribution.objectstore.bucket=cwa -services.distribution.objectstore.port=8003 -services.distribution.objectstore.set-public-read-acl-on-put-object=true diff --git a/services/distribution/src/test/resources/application.yaml b/services/distribution/src/test/resources/application.yaml new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/resources/application.yaml @@ -0,0 +1,57 @@ +--- +logging: + level: + org: + springframework: off + root: info + +services: + distribution: + output-file-name: index + retention-days: 14 + paths: + output: out + privatekey: classpath:certificates/client/private.pem + certificate: classpath:certificates/chain/certificate.crt + tek-export: + file-name: export.bin + file-header: EK Export v1 + file-header-width: 16 + api: + version-path: version + version-v1: v1 + country-path: country + country-germany: DE + date-path: date + hour-path: hour + diagnosis-keys-path: diagnosis-keys + parameters-path: configuration + parameters-exposure-configuration-file-name: exposure_configuration + parameters-risk-score-classification-file-name: risk_score_classification + signature: + app-bundle-id: de.rki.coronawarnapp + android-package: de.rki.coronawarnapp + verification-key-id: + verification-key-version: + algorithm-oid: 1.2.840.10045.4.3.2 + algorithm-name: SHA256withECDSA + file-name: export.sig + security-provider: BC + # S3 object store configuration + objectstore: + access-key: ${CWA_OBJECTSTORE_ACCESSKEY:accessKey1} + secret-key: ${CWA_OBJECTSTORE_SECRETKEY:verySecretKey1} + endpoint: ${WA_OBJECTSTORE_ENDPOINT:http\://localhost\:8003} + bucket: ${CWA_OBJECTSTORE_BUCKET:cwa} + port: ${CWA_OBJECTSTORE_PORT:8003} + set-public-read-acl-on-put-object: true +spring: + main: + banner-mode: off + flyway: + enabled: true +# default case is H2 - value will be overwritten by profile cloud or postgres + locations: classpath:db/migration/h2 + jpa: + hibernate: + ddl-auto: validate diff --git a/services/submission/src/test/java/app/coronawarn/server/services/submission/config/SubmissionServiceConfigTest.java b/services/submission/src/test/java/app/coronawarn/server/services/submission/config/SubmissionServiceConfigTest.java deleted file mode 100644 --- a/services/submission/src/test/java/app/coronawarn/server/services/submission/config/SubmissionServiceConfigTest.java +++ /dev/null @@ -1,59 +0,0 @@ -package app.coronawarn.server.services.submission.config; - -import static org.springframework.test.util.AssertionErrors.assertEquals; -import static org.springframework.test.util.AssertionErrors.assertNotNull; - -import java.io.IOException; -import java.io.InputStream; -import java.util.Properties; -import org.junit.jupiter.api.AfterEach; -import org.junit.jupiter.api.BeforeEach; -import org.junit.jupiter.api.Test; -import org.junit.jupiter.api.extension.ExtendWith; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.boot.context.properties.EnableConfigurationProperties; -import org.springframework.test.context.TestPropertySource; -import org.springframework.test.context.junit.jupiter.SpringExtension; - -@ExtendWith(SpringExtension.class) -@EnableConfigurationProperties(value = SubmissionServiceConfig.class) -@TestPropertySource("classpath:application-config-test.properties") -public class SubmissionServiceConfigTest { - - @Autowired - private SubmissionServiceConfig config; - - private final Properties properties = new Properties(); - - @BeforeEach - public void setup() throws IOException { - InputStream is = getClass().getClassLoader() - .getResourceAsStream("application-config-test.properties"); - properties.load(is); - } - - @AfterEach - public void tearDown() { - properties.clear(); - } - - @Test - void whenDistributionConfigBeanCreatedThenPropertiesLoadedCorrectly() { - - assertNotNull("Configuration should not be null", config); - - assertEquals("Fake Delay value should be loaded correctly.", - properties.getProperty("services.submission.initial_fake_delay_milliseconds"), - String.valueOf(config.getInitialFakeDelayMilliseconds())); - assertEquals("Fake Delay Moving Average value should be loaded correctly.", - properties.getProperty("services.submission.fake_delay_moving_average_samples"), - String.valueOf(config.getFakeDelayMovingAverageSamples())); - assertEquals("Retention Days should be loaded correctly.", - properties.getProperty("services.submission.retention-days"), - String.valueOf(config.getRetentionDays())); - assertEquals("Max Number of Days value should be loaded correctly.", - properties.getProperty("services.submission.payload.max-number-of-keys"), - String.valueOf(config.getMaxNumberOfKeys())); - - } -} \ No newline at end of file diff --git a/services/submission/src/test/resources/application.properties b/services/submission/src/test/resources/application.properties deleted file mode 100644 --- a/services/submission/src/test/resources/application.properties +++ /dev/null @@ -1,15 +0,0 @@ -logging.level.org.springframework=off -logging.level.root=off -spring.main.banner-mode=off - -services.submission.initial_fake_delay_milliseconds=1 -services.submission.fake_delay_moving_average_samples=1 - -spring.flyway.enabled=true -# default case is H2 - value will be overwritten by profile cloud or postgres -spring.flyway.locations=classpath:db/migration/h2 - -spring.jpa.hibernate.ddl-auto=validate - -services.submission.retention-days=14 -services.submission.payload.max-number-of-keys=14 diff --git a/services/submission/src/test/resources/application.yaml b/services/submission/src/test/resources/application.yaml new file mode 100644 --- /dev/null +++ b/services/submission/src/test/resources/application.yaml @@ -0,0 +1,25 @@ +--- +logging: + level: + org: + springframework: off + root: off +spring: + main: + banner-mode: off + flyway: + enabled: true + # default case is H2 - value will be overwritten by profile cloud or postgres + locations: classpath:db/migration/h2 + + jpa: + hibernate: + ddl-auto: validate + +services: + submission: + initial-fake-delay-milliseconds: 1 + fake-delay-moving-average-samples: 1 + retention-days: 14 + payload: + max-number-of-keys: 14

Switch application*.properties files to Yaml Let's switch over to YAML for better readability. Affected files: common/persistence/src/test/resources/application.properties services/submission/src/main/resources/application.properties services/submission/src/test/resources/application.properties services/distribution/src/main/resources/application.properties services/distribution/src/test/resources/application.properties services/submission/src/main/resources/application-dev.properties services/distribution/src/main/resources/application-dev.properties services/submission/src/main/resources/application-cloud.properties services/distribution/src/main/resources/application-cloud.properties services/distribution/src/main/resources/application-testdata.properties

corona-warn-app/cwa-server

corona-warn-app__cwa-server-299

c5991b2fcb894aa4a8eec41c51a2f2cc366a13b5

diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ExposureConfigurationValidator.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ExposureConfigurationValidator.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ExposureConfigurationValidator.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ExposureConfigurationValidator.java @@ -82,7 +82,7 @@ private void validateScore( try { RiskLevel level = (RiskLevel) propertyDescriptor.getReadMethod().invoke(object); - if (level == RiskLevel.UNRECOGNIZED || level == RiskLevel.RISK_LEVEL_UNSPECIFIED) { + if (level == RiskLevel.UNRECOGNIZED) { this.errors.add(new RiskLevelValidationError(parameter, propertyDescriptor.getName())); } } catch (IllegalAccessException | InvocationTargetException e) { diff --git a/services/distribution/src/main/resources/master-config/exposure-config.yaml b/services/distribution/src/main/resources/master-config/exposure-config.yaml --- a/services/distribution/src/main/resources/master-config/exposure-config.yaml +++ b/services/distribution/src/main/resources/master-config/exposure-config.yaml @@ -2,7 +2,7 @@ # Change this file with caution. # # Weights must be in range of 0.001 to 100 -# Parameter Scores must be in range of 1 to 8. +# Parameter Scores must be in range of 0 to 8. # # Further documentation: # https://developer.apple.com/documentation/exposurenotification/enexposureconfiguration @@ -28,31 +28,31 @@ transmission: app_defined_8: 8 duration: - eq_0_min: 1 - gt_0_le_5_min: 2 - gt_5_le_10_min: 3 + eq_0_min: 0 + gt_0_le_5_min: 1 + gt_5_le_10_min: 2 gt_10_le_15_min: 4 gt_15_le_20_min: 5 - gt_20_le_25_min: 6 - gt_25_le_30_min: 7 + gt_20_le_25_min: 7 + gt_25_le_30_min: 8 gt_30_min: 8 days_since_last_exposure: ge_14_days: 1 - ge_12_lt_14_days: 2 - ge_10_lt_12_days: 3 - ge_8_lt_10_days: 4 - ge_6_lt_8_days: 5 + ge_12_lt_14_days: 1 + ge_10_lt_12_days: 1 + ge_8_lt_10_days: 1 + ge_6_lt_8_days: 2 ge_4_lt_6_days: 6 - ge_2_lt_4_days: 7 - ge_0_lt_2_days: 8 + ge_2_lt_4_days: 8 + ge_0_lt_2_days: 6 attenuation: - gt_73_dbm: 1 - gt_63_le_73_dbm: 2 - gt_51_le_63_dbm: 3 - gt_33_le_51_dbm: 4 + gt_73_dbm: 0 + gt_63_le_73_dbm: 0 + gt_51_le_63_dbm: 1 + gt_33_le_51_dbm: 2 gt_27_le_33_dbm: 5 - gt_15_le_27_dbm: 6 - gt_10_le_15_dbm: 7 - lt_10_dbm: 8 \ No newline at end of file + gt_15_le_27_dbm: 7 + gt_10_le_15_dbm: 8 + lt_10_dbm: 8

diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ExposureConfigurationValidatorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ExposureConfigurationValidatorTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ExposureConfigurationValidatorTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ExposureConfigurationValidatorTest.java @@ -72,7 +72,8 @@ private static Stream<Arguments> createOkTests() { private static Stream<Arguments> createFailedTests() { return Stream.of( ScoreTooHigh(), - ScoreNegative(), + // TODO cwa-server/#320 Validate that no attributes are missing in .yaml + // ScoreNegative(), WeightNegative(), WeightTooHigh() ).map(Arguments::of); @@ -107,9 +108,8 @@ public static TestWithExpectedResult WeightTooHigh() { public static TestWithExpectedResult ScoreNegative() { return new TestWithExpectedResult("score_negative.yaml") - .with(new RiskLevelValidationError("transmission", "appDefined1")) - .with(new RiskLevelValidationError("transmission", "appDefined2")) - .with(new RiskLevelValidationError("transmission", "appDefined3")); + .with(new RiskLevelValidationError("transmission", "appDefined1")) + .with(new RiskLevelValidationError("transmission", "appDefined3")); } public static TestWithExpectedResult ScoreTooHigh() { diff --git a/services/distribution/src/test/resources/parameters/score_negative.yaml b/services/distribution/src/test/resources/parameters/score_negative.yaml --- a/services/distribution/src/test/resources/parameters/score_negative.yaml +++ b/services/distribution/src/test/resources/parameters/score_negative.yaml @@ -5,7 +5,7 @@ attenuation_weight: 80 transmission: app_defined_1: -2 # not ok, negative - app_defined_2: 0 # not ok, unspecified + app_defined_2: 0 #app_defined_3: 3 # not ok (missing -> unspecified) app_defined_4: 5 app_defined_5: 5

RKI: Adjust Risk Score Parameters in master config RKI decided for the following risk score parameter values: ``` 1 2 3 4 5 6 7 8 // Bucket No. ---------------------------------------------------------- 0 1 2 4 5 7 8 8 // Duration 0 0 1 2 5 7 8 8 // Attenuation 1 1 1 1 2 6 8 6 // Days 1 2 3 4 5 6 7 8 // Transmission Risk ```

Config file that needs updating: [master.yaml](https://github.com/corona-warn-app/cwa-server/blob/master/services/distribution/src/main/resources/exposure-config/master.yaml)

corona-warn-app/cwa-server

corona-warn-app__cwa-server-308

9ef96cbec24163360512f3d4748a248d6eddd078

diff --git a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKey.java b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKey.java --- a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKey.java +++ b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKey.java @@ -36,7 +36,6 @@ import javax.validation.ConstraintViolation; import javax.validation.Validation; import javax.validation.Validator; -import javax.validation.constraints.Min; import javax.validation.constraints.Size; import org.hibernate.validator.constraints.Range; @@ -46,6 +45,14 @@ @Entity @Table(name = "diagnosis_key") public class DiagnosisKey { + + /** + * According to "Setting Up an Exposure Notification Server" by Apple, exposure notification servers are expected to + * reject any diagnosis keys that do not have a rolling period of a certain fixed value. See + * https://developer.apple.com/documentation/exposurenotification/setting_up_an_exposure_notification_server + */ + public static final int EXPECTED_ROLLING_PERIOD = 144; + private static final Validator VALIDATOR = Validation.buildDefaultValidatorFactory().getValidator(); @Id @@ -58,7 +65,8 @@ public class DiagnosisKey { @ValidRollingStartIntervalNumber private int rollingStartIntervalNumber; - @Min(value = 1, message = "Rolling period must be greater than 0.") + @Range(min = EXPECTED_ROLLING_PERIOD, max = EXPECTED_ROLLING_PERIOD, + message = "Rolling period must be " + EXPECTED_ROLLING_PERIOD + ".") private int rollingPeriod; @Range(min = 0, max = 8, message = "Risk level must be between 0 and 8.") @@ -135,7 +143,7 @@ public long getSubmissionTimestamp() { * Checks if this diagnosis key falls into the period between now, and the retention threshold. * * @param daysToRetain the number of days before a key is outdated - * @return true, if the rolling start number is in the time span between now, and the given days to retain + * @return true, if the rolling start interval number is within the time between now, and the given days to retain * @throws IllegalArgumentException if {@code daysToRetain} is negative. */ public boolean isYoungerThanRetentionThreshold(int daysToRetain) { @@ -155,7 +163,7 @@ public boolean isYoungerThanRetentionThreshold(int daysToRetain) { * * <p><ul> * <li>Risk level must be between 0 and 8 - * <li>Rolling start number must be greater than 0 + * <li>Rolling start interval number must be greater than 0 * <li>Rolling start number cannot be in the future * <li>Rolling period must be positive number * <li>Key data must be byte array of length 16 diff --git a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyBuilder.java b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyBuilder.java --- a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyBuilder.java +++ b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyBuilder.java @@ -21,7 +21,6 @@ import static app.coronawarn.server.common.persistence.domain.DiagnosisKeyBuilders.Builder; import static app.coronawarn.server.common.persistence.domain.DiagnosisKeyBuilders.FinalBuilder; -import static app.coronawarn.server.common.persistence.domain.DiagnosisKeyBuilders.RollingPeriodBuilder; import static app.coronawarn.server.common.persistence.domain.DiagnosisKeyBuilders.RollingStartIntervalNumberBuilder; import static app.coronawarn.server.common.persistence.domain.DiagnosisKeyBuilders.TransmissionRiskLevelBuilder; @@ -38,14 +37,14 @@ * An instance of this builder can be retrieved by calling {@link DiagnosisKey#builder()}. A {@link DiagnosisKey} can * then be build by either providing the required member values or by passing the respective protocol buffer object. */ -public class DiagnosisKeyBuilder implements Builder, RollingStartIntervalNumberBuilder, - RollingPeriodBuilder, TransmissionRiskLevelBuilder, FinalBuilder { +public class DiagnosisKeyBuilder implements + Builder, RollingStartIntervalNumberBuilder, TransmissionRiskLevelBuilder, FinalBuilder { private static final Logger logger = LoggerFactory.getLogger(DiagnosisKeyBuilder.class); private byte[] keyData; private int rollingStartIntervalNumber; - private int rollingPeriod; + private int rollingPeriod = DiagnosisKey.EXPECTED_ROLLING_PERIOD; private int transmissionRiskLevel; private long submissionTimestamp = -1L; @@ -59,17 +58,11 @@ public RollingStartIntervalNumberBuilder withKeyData(byte[] keyData) { } @Override - public RollingPeriodBuilder withRollingStartIntervalNumber(int rollingStartIntervalNumber) { + public TransmissionRiskLevelBuilder withRollingStartIntervalNumber(int rollingStartIntervalNumber) { this.rollingStartIntervalNumber = rollingStartIntervalNumber; return this; } - @Override - public TransmissionRiskLevelBuilder withRollingPeriod(int rollingPeriod) { - this.rollingPeriod = rollingPeriod; - return this; - } - @Override public FinalBuilder withTransmissionRiskLevel(int transmissionRiskLevel) { this.transmissionRiskLevel = transmissionRiskLevel; @@ -81,8 +74,8 @@ public FinalBuilder fromProtoBuf(TemporaryExposureKey protoBufObject) { return this .withKeyData(protoBufObject.getKeyData().toByteArray()) .withRollingStartIntervalNumber(protoBufObject.getRollingStartIntervalNumber()) - .withRollingPeriod(protoBufObject.getRollingPeriod()) - .withTransmissionRiskLevel(protoBufObject.getTransmissionRiskLevel()); + .withTransmissionRiskLevel(protoBufObject.getTransmissionRiskLevel()) + .withRollingPeriod(protoBufObject.getRollingPeriod()); } @Override @@ -91,6 +84,12 @@ public FinalBuilder withSubmissionTimestamp(long submissionTimestamp) { return this; } + @Override + public FinalBuilder withRollingPeriod(int rollingPeriod) { + this.rollingPeriod = rollingPeriod; + return this; + } + @Override public DiagnosisKey build() { if (submissionTimestamp < 0) { diff --git a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyBuilders.java b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyBuilders.java --- a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyBuilders.java +++ b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyBuilders.java @@ -48,25 +48,13 @@ interface Builder { interface RollingStartIntervalNumberBuilder { /** - * Adds the specified rolling start number to this builder. + * Adds the specified rolling start interval number to this builder. * * @param rollingStartIntervalNumber number describing when a key starts. It is equal to * startTimeOfKeySinceEpochInSecs / (60 * 10). * @return this Builder instance. */ - RollingPeriodBuilder withRollingStartIntervalNumber(int rollingStartIntervalNumber); - } - - interface RollingPeriodBuilder { - - /** - * Adds the specified rolling period to this builder. - * - * @param rollingPeriod Number describing how long a key is valid. It is expressed in increments - * of 10 minutes (e.g. 144 for 24 hours). - * @return this Builder instance. - */ - TransmissionRiskLevelBuilder withRollingPeriod(int rollingPeriod); + TransmissionRiskLevelBuilder withRollingStartIntervalNumber(int rollingStartIntervalNumber); } interface TransmissionRiskLevelBuilder { @@ -90,6 +78,16 @@ interface FinalBuilder { */ FinalBuilder withSubmissionTimestamp(long submissionTimestamp); + /** + * Adds the specified rolling period to this builder. If not specified, the rolling period defaults to {@link + * DiagnosisKey#EXPECTED_ROLLING_PERIOD} + * + * @param rollingPeriod Number describing how long a key is valid. It is expressed in increments of 10 minutes (e.g. + * 144 for 24 hours). + * @return this Builder instance. + */ + FinalBuilder withRollingPeriod(int rollingPeriod); + /** * Builds a {@link DiagnosisKey} instance. If no submission timestamp has been specified it will be set to "now" as * hours since epoch. diff --git a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/validation/ValidRollingStartIntervalNumber.java b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/validation/ValidRollingStartIntervalNumber.java --- a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/validation/ValidRollingStartIntervalNumber.java +++ b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/validation/ValidRollingStartIntervalNumber.java @@ -35,7 +35,7 @@ * * @return the error message */ - String message() default "Rolling start number must be greater 0 and cannot be in the future."; + String message() default "Rolling start interval number must be greater 0 and cannot be in the future."; /** * Groups. diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/TestDataGeneration.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/TestDataGeneration.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/TestDataGeneration.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/TestDataGeneration.java @@ -71,7 +71,7 @@ public class TestDataGeneration implements ApplicationRunner { // The submission timestamp is counted in 1 hour intervals since epoch private static final long ONE_HOUR_INTERVAL_SECONDS = TimeUnit.HOURS.toSeconds(1); - // The rolling start number is counted in 10 minute intervals since epoch + // The rolling start interval number is counted in 10 minute intervals since epoch private static final long TEN_MINUTES_INTERVAL_SECONDS = TimeUnit.MINUTES.toSeconds(10); /** @@ -166,7 +166,6 @@ private DiagnosisKey generateDiagnosisKey(long submissionTimestamp) { return DiagnosisKey.builder() .withKeyData(generateDiagnosisKeyBytes()) .withRollingStartIntervalNumber(generateRollingStartIntervalNumber(submissionTimestamp)) - .withRollingPeriod(generateRollingPeriod()) .withTransmissionRiskLevel(generateTransmissionRiskLevel()) .withSubmissionTimestamp(submissionTimestamp) .build(); @@ -182,8 +181,8 @@ private byte[] generateDiagnosisKeyBytes() { } /** - * Returns a random rolling start number (timestamp since when a key was active, represented by a 10 minute interval - * counter.) between a specific submission timestamp and the beginning of the retention period. + * Returns a random rolling start interval number (timestamp since when a key was active, represented by a 10 minute + * interval counter) between a specific submission timestamp and the beginning of the retention period. */ private int generateRollingStartIntervalNumber(long submissionTimestamp) { long maxRollingStartIntervalNumber = @@ -194,13 +193,6 @@ private int generateRollingStartIntervalNumber(long submissionTimestamp) { return Math.toIntExact(getRandomBetween(minRollingStartIntervalNumber, maxRollingStartIntervalNumber)); } - /** - * Returns a rolling period (number of 10 minute intervals that a key was active for) of 1 day. - */ - private int generateRollingPeriod() { - return Math.toIntExact(TimeUnit.DAYS.toSeconds(1) / TEN_MINUTES_INTERVAL_SECONDS); - } - /** * Returns a random number between {@link RiskLevel#RISK_LEVEL_LOWEST_VALUE} and {@link * RiskLevel#RISK_LEVEL_HIGHEST_VALUE}. diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/ApiExceptionHandler.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/ApiExceptionHandler.java --- a/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/ApiExceptionHandler.java +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/ApiExceptionHandler.java @@ -20,8 +20,8 @@ package app.coronawarn.server.services.submission.controller; import app.coronawarn.server.common.persistence.exception.InvalidDiagnosisKeyException; -import app.coronawarn.server.services.submission.exception.InvalidPayloadException; import com.google.protobuf.InvalidProtocolBufferException; +import javax.validation.ConstraintViolationException; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.http.HttpStatus; @@ -50,7 +50,7 @@ public void bindingExceptions(Exception ex, WebRequest wr) { logger.error("Binding failed {}", wr.getDescription(false), ex); } - @ExceptionHandler({InvalidDiagnosisKeyException.class, InvalidPayloadException.class}) + @ExceptionHandler({InvalidDiagnosisKeyException.class, ConstraintViolationException.class}) @ResponseStatus(HttpStatus.BAD_REQUEST) public void diagnosisKeyExceptions(Exception ex, WebRequest wr) { logger.error("Erroneous Submission Payload {}", wr.getDescription(false), ex); diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/SubmissionController.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/SubmissionController.java --- a/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/SubmissionController.java +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/SubmissionController.java @@ -24,7 +24,7 @@ import app.coronawarn.server.common.protocols.external.exposurenotification.TemporaryExposureKey; import app.coronawarn.server.common.protocols.internal.SubmissionPayload; import app.coronawarn.server.services.submission.config.SubmissionServiceConfig; -import app.coronawarn.server.services.submission.exception.InvalidPayloadException; +import app.coronawarn.server.services.submission.validation.ValidSubmissionPayload; import app.coronawarn.server.services.submission.verification.TanVerifier; import java.util.ArrayList; import java.util.List; @@ -39,6 +39,7 @@ import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; import org.springframework.util.StopWatch; +import org.springframework.validation.annotation.Validated; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RequestHeader; @@ -48,6 +49,7 @@ @RestController @RequestMapping("/version/v1") +@Validated public class SubmissionController { private static final Logger logger = LoggerFactory.getLogger(SubmissionController.class); @@ -62,7 +64,6 @@ public class SubmissionController { private final TanVerifier tanVerifier; private final Double fakeDelayMovingAverageSamples; private final Integer retentionDays; - private final Integer maxNumberOfKeys; private Double fakeDelay; @Autowired @@ -73,7 +74,6 @@ public class SubmissionController { fakeDelay = submissionServiceConfig.getInitialFakeDelayMilliseconds(); fakeDelayMovingAverageSamples = submissionServiceConfig.getFakeDelayMovingAverageSamples(); retentionDays = submissionServiceConfig.getRetentionDays(); - maxNumberOfKeys = submissionServiceConfig.getMaxNumberOfKeys(); } /** @@ -86,7 +86,7 @@ public class SubmissionController { */ @PostMapping(SUBMISSION_ROUTE) public DeferredResult<ResponseEntity<Void>> submitDiagnosisKey( - @RequestBody SubmissionPayload exposureKeys, + @ValidSubmissionPayload @RequestBody SubmissionPayload exposureKeys, @RequestHeader("cwa-fake") Integer fake, @RequestHeader("cwa-authorization") String tan) { if (fake != 0) { @@ -147,9 +147,8 @@ private ResponseEntity<Void> buildTanInvalidResponseEntity() { */ public void persistDiagnosisKeysPayload(SubmissionPayload protoBufDiagnosisKeys) { List<TemporaryExposureKey> protoBufferKeysList = protoBufDiagnosisKeys.getKeysList(); - validatePayload(protoBufferKeysList); - List<DiagnosisKey> diagnosisKeys = new ArrayList<>(); + for (TemporaryExposureKey protoBufferKey : protoBufferKeysList) { DiagnosisKey diagnosisKey = DiagnosisKey.builder().fromProtoBuf(protoBufferKey).build(); if (diagnosisKey.isYoungerThanRetentionThreshold(retentionDays)) { @@ -162,13 +161,6 @@ public void persistDiagnosisKeysPayload(SubmissionPayload protoBufDiagnosisKeys) diagnosisKeyService.saveDiagnosisKeys(diagnosisKeys); } - private void validatePayload(List<TemporaryExposureKey> protoBufKeysList) { - if (protoBufKeysList.isEmpty() || protoBufKeysList.size() > maxNumberOfKeys) { - throw new InvalidPayloadException( - String.format("Number of keys must be between 1 and %s, but is %s.", maxNumberOfKeys, protoBufKeysList)); - } - } - private synchronized void updateFakeDelay(long realRequestDuration) { fakeDelay = fakeDelay + (1 / fakeDelayMovingAverageSamples) * (realRequestDuration - fakeDelay); } diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/exception/InvalidPayloadException.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/exception/InvalidPayloadException.java deleted file mode 100644 --- a/services/submission/src/main/java/app/coronawarn/server/services/submission/exception/InvalidPayloadException.java +++ /dev/null @@ -1,32 +0,0 @@ -/* - * Corona-Warn-App - * - * SAP SE and all other contributors / - * copyright owners license this file to you 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 - * - * http://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. - */ - -package app.coronawarn.server.services.submission.exception; - -/** - * Exception thrown to indicate an invalid payload of a - * {@link app.coronawarn.server.common.protocols.external.exposurenotification.TemporaryExposureKey}. - */ -public class InvalidPayloadException extends RuntimeException { - - public InvalidPayloadException(String message) { - super(message); - } - -} diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/validation/ValidSubmissionPayload.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/validation/ValidSubmissionPayload.java new file mode 100644 --- /dev/null +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/validation/ValidSubmissionPayload.java @@ -0,0 +1,148 @@ +/* + * Corona-Warn-App + * SAP SE and all other contributors / + * copyright owners license this file to you 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 + * http://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. + */ + +package app.coronawarn.server.services.submission.validation; + +import app.coronawarn.server.common.persistence.domain.DiagnosisKey; +import app.coronawarn.server.common.protocols.external.exposurenotification.TemporaryExposureKey; +import app.coronawarn.server.common.protocols.internal.SubmissionPayload; +import app.coronawarn.server.services.submission.config.SubmissionServiceConfig; +import java.lang.annotation.Documented; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; +import java.util.Arrays; +import java.util.List; +import java.util.Objects; +import javax.validation.Constraint; +import javax.validation.ConstraintValidator; +import javax.validation.ConstraintValidatorContext; +import javax.validation.Payload; + +@Constraint(validatedBy = ValidSubmissionPayload.SubmissionPayloadValidator.class) +@Target({ElementType.PARAMETER}) +@Retention(RetentionPolicy.RUNTIME) +@Documented +public @interface ValidSubmissionPayload { + + /** + * Error message. + * + * @return the error message + */ + String message() default "Invalid diagnosis key submission payload."; + + /** + * Groups. + * + * @return + */ + Class<?>[] groups() default {}; + + /** + * Payload. + * + * @return + */ + Class<? extends Payload>[] payload() default {}; + + class SubmissionPayloadValidator implements + ConstraintValidator<ValidSubmissionPayload, SubmissionPayload> { + + private final int maxNumberOfKeys; + + public SubmissionPayloadValidator(SubmissionServiceConfig submissionServiceConfig) { + maxNumberOfKeys = submissionServiceConfig.getMaxNumberOfKeys(); + } + + /** + * Validates the following constraints. + * <ul> + * <li>StartIntervalNumber values from the same {@link SubmissionPayload} shall be unique.</li> + * <li>There must be no gaps for StartIntervalNumber values for a user.</li> + * <li>There must not be any keys in the {@link SubmissionPayload} have overlapping time windows.</li> + * <li>The period of time covered by the data file must not exceed the configured maximum number of days.</li> + * </ul> + */ + @Override + public boolean isValid(SubmissionPayload submissionPayload, ConstraintValidatorContext validatorContext) { + List<TemporaryExposureKey> exposureKeys = submissionPayload.getKeysList(); + validatorContext.disableDefaultConstraintViolation(); + + if (Objects.isNull(exposureKeys)) { + addViolation(validatorContext, "Field 'keys' points to Null."); + return false; + } + + boolean isValid = checkKeyCollectionSize(exposureKeys, validatorContext); + isValid &= checkUniqueStartIntervalNumbers(exposureKeys, validatorContext); + isValid &= checkNoGapsInTimeWindow(exposureKeys, validatorContext); + + return isValid; + } + + private void addViolation(ConstraintValidatorContext validatorContext, String message) { + validatorContext.buildConstraintViolationWithTemplate(message).addConstraintViolation(); + } + + private boolean checkKeyCollectionSize(List<TemporaryExposureKey> exposureKeys, + ConstraintValidatorContext validatorContext) { + if (exposureKeys.isEmpty() || exposureKeys.size() > maxNumberOfKeys) { + addViolation(validatorContext, String.format( + "Number of keys must be between 1 and %s, but is %s.", maxNumberOfKeys, exposureKeys.size())); + return false; + } + return true; + } + + private boolean checkUniqueStartIntervalNumbers(List<TemporaryExposureKey> exposureKeys, + ConstraintValidatorContext validatorContext) { + Integer[] startIntervalNumbers = exposureKeys.stream() + .mapToInt(TemporaryExposureKey::getRollingStartIntervalNumber).boxed().toArray(Integer[]::new); + long distinctSize = Arrays.stream(startIntervalNumbers) + .distinct() + .count(); + + if (distinctSize < exposureKeys.size()) { + addViolation(validatorContext, String.format( + "Duplicate StartIntervalNumber found. StartIntervalNumbers: %s", startIntervalNumbers)); + return false; + } + return true; + } + + private boolean checkNoGapsInTimeWindow(List<TemporaryExposureKey> exposureKeys, + ConstraintValidatorContext validatorContext) { + if (exposureKeys.size() < 2) { + return true; + } + + Integer[] sortedStartIntervalNumbers = exposureKeys.stream() + .mapToInt(TemporaryExposureKey::getRollingStartIntervalNumber) + .sorted().boxed().toArray(Integer[]::new); + + for (int i = 1; i < sortedStartIntervalNumbers.length; i++) { + if (sortedStartIntervalNumbers[i] != sortedStartIntervalNumbers[i - 1] + DiagnosisKey.EXPECTED_ROLLING_PERIOD) { + addViolation(validatorContext, String.format( + "Subsequent intervals do not align. StartIntervalNumbers: %s", sortedStartIntervalNumbers)); + return false; + } + } + return true; + } + } +}

diff --git a/common/persistence/src/test/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyBuilderTest.java b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyBuilderTest.java --- a/common/persistence/src/test/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyBuilderTest.java +++ b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyBuilderTest.java @@ -38,7 +38,6 @@ class DiagnosisKeyBuilderTest { private final byte[] expKeyData = "16-bytelongarray".getBytes(Charset.defaultCharset()); private final int expRollingStartIntervalNumber = 73800; - private final int expRollingPeriod = 144; private final int expTransmissionRiskLevel = 1; private final long expSubmissionTimestamp = 2L; @@ -48,7 +47,7 @@ void buildFromProtoBufObjWithSubmissionTimestamp() { .newBuilder() .setKeyData(ByteString.copyFrom(this.expKeyData)) .setRollingStartIntervalNumber(this.expRollingStartIntervalNumber) - .setRollingPeriod(this.expRollingPeriod) + .setRollingPeriod(DiagnosisKey.EXPECTED_ROLLING_PERIOD) .setTransmissionRiskLevel(this.expTransmissionRiskLevel) .build(); @@ -66,7 +65,7 @@ void buildFromProtoBufObjWithoutSubmissionTimestamp() { .newBuilder() .setKeyData(ByteString.copyFrom(this.expKeyData)) .setRollingStartIntervalNumber(this.expRollingStartIntervalNumber) - .setRollingPeriod(this.expRollingPeriod) + .setRollingPeriod(DiagnosisKey.EXPECTED_ROLLING_PERIOD) .setTransmissionRiskLevel(this.expTransmissionRiskLevel) .build(); @@ -80,7 +79,6 @@ void buildSuccessivelyWithSubmissionTimestamp() { DiagnosisKey actDiagnosisKey = DiagnosisKey.builder() .withKeyData(this.expKeyData) .withRollingStartIntervalNumber(this.expRollingStartIntervalNumber) - .withRollingPeriod(this.expRollingPeriod) .withTransmissionRiskLevel(this.expTransmissionRiskLevel) .withSubmissionTimestamp(this.expSubmissionTimestamp).build(); @@ -92,18 +90,27 @@ void buildSuccessivelyWithoutSubmissionTimestamp() { DiagnosisKey actDiagnosisKey = DiagnosisKey.builder() .withKeyData(this.expKeyData) .withRollingStartIntervalNumber(this.expRollingStartIntervalNumber) - .withRollingPeriod(this.expRollingPeriod) .withTransmissionRiskLevel(this.expTransmissionRiskLevel).build(); assertDiagnosisKeyEquals(actDiagnosisKey); } @Test - void rollingStartIntervalNumberDoesNotThrowForValid() { - assertThatCode(() -> keyWithRollingStartIntervalNumber(4200)).doesNotThrowAnyException(); + void buildSuccessivelyWithRollingPeriod() { + DiagnosisKey actDiagnosisKey = DiagnosisKey.builder() + .withKeyData(this.expKeyData) + .withRollingStartIntervalNumber(this.expRollingStartIntervalNumber) + .withTransmissionRiskLevel(this.expTransmissionRiskLevel) + .withSubmissionTimestamp(this.expSubmissionTimestamp) + .withRollingPeriod(DiagnosisKey.EXPECTED_ROLLING_PERIOD).build(); - // Timestamp: 05/16/2020 @ 00:00 in hours - assertThatCode(() -> keyWithRollingStartIntervalNumber(441552)).doesNotThrowAnyException(); + assertDiagnosisKeyEquals(actDiagnosisKey, this.expSubmissionTimestamp); + } + + @ParameterizedTest + @ValueSource(ints = {4200, 441552}) + void rollingStartIntervalNumberDoesNotThrowForValid(int validRollingStartIntervalNumber) { + assertThatCode(() -> keyWithRollingStartIntervalNumber(validRollingStartIntervalNumber)).doesNotThrowAnyException(); } @Test @@ -111,7 +118,7 @@ void rollingStartIntervalNumberCannotBeInFuture() { assertThat(catchThrowable(() -> keyWithRollingStartIntervalNumber(Integer.MAX_VALUE))) .isInstanceOf(InvalidDiagnosisKeyException.class) .hasMessage( - "[Rolling start number must be greater 0 and cannot be in the future. Invalid Value: " + "[Rolling start interval number must be greater 0 and cannot be in the future. Invalid Value: " + Integer.MAX_VALUE + "]"); long tomorrow = LocalDate @@ -123,7 +130,7 @@ void rollingStartIntervalNumberCannotBeInFuture() { .isInstanceOf(InvalidDiagnosisKeyException.class) .hasMessage( String.format( - "[Rolling start number must be greater 0 and cannot be in the future. Invalid Value: %s]", + "[Rolling start interval number must be greater 0 and cannot be in the future. Invalid Value: %s]", tomorrow)); } @@ -133,7 +140,6 @@ void failsForInvalidRollingStartIntervalNumber() { catchThrowable(() -> DiagnosisKey.builder() .withKeyData(this.expKeyData) .withRollingStartIntervalNumber(0) - .withRollingPeriod(this.expRollingPeriod) .withTransmissionRiskLevel(this.expTransmissionRiskLevel).build() ) ).isInstanceOf(InvalidDiagnosisKeyException.class); @@ -155,17 +161,17 @@ void transmissionRiskLevelDoesNotThrowForValid(int validRiskLevel) { } @ParameterizedTest - @ValueSource(ints = {0, -3}) - void rollingPeriodMustBeLargerThanZero(int invalidRollingPeriod) { + @ValueSource(ints = {-3, 143, 145}) + void rollingPeriodMustBeEpectedValue(int invalidRollingPeriod) { assertThat(catchThrowable(() -> keyWithRollingPeriod(invalidRollingPeriod))) .isInstanceOf(InvalidDiagnosisKeyException.class) - .hasMessage( - "[Rolling period must be greater than 0. Invalid Value: " + invalidRollingPeriod + "]"); + .hasMessage("[Rolling period must be " + DiagnosisKey.EXPECTED_ROLLING_PERIOD + + ". Invalid Value: " + invalidRollingPeriod + "]"); } @Test void rollingPeriodDoesNotThrowForValid() { - assertThatCode(() -> keyWithRollingPeriod(144)).doesNotThrowAnyException(); + assertThatCode(() -> keyWithRollingPeriod(DiagnosisKey.EXPECTED_ROLLING_PERIOD)).doesNotThrowAnyException(); } @ParameterizedTest @@ -186,7 +192,6 @@ private DiagnosisKey keyWithKeyData(byte[] expKeyData) { return DiagnosisKey.builder() .withKeyData(expKeyData) .withRollingStartIntervalNumber(expRollingStartIntervalNumber) - .withRollingPeriod(expRollingPeriod) .withTransmissionRiskLevel(expTransmissionRiskLevel).build(); } @@ -194,7 +199,6 @@ private DiagnosisKey keyWithRollingStartIntervalNumber(int expRollingStartInterv return DiagnosisKey.builder() .withKeyData(expKeyData) .withRollingStartIntervalNumber(expRollingStartIntervalNumber) - .withRollingPeriod(expRollingPeriod) .withTransmissionRiskLevel(expTransmissionRiskLevel).build(); } @@ -202,15 +206,14 @@ private DiagnosisKey keyWithRollingPeriod(int expRollingPeriod) { return DiagnosisKey.builder() .withKeyData(expKeyData) .withRollingStartIntervalNumber(expRollingStartIntervalNumber) - .withRollingPeriod(expRollingPeriod) - .withTransmissionRiskLevel(expTransmissionRiskLevel).build(); + .withTransmissionRiskLevel(expTransmissionRiskLevel) + .withRollingPeriod(expRollingPeriod).build(); } private DiagnosisKey keyWithRiskLevel(int expTransmissionRiskLevel) { return DiagnosisKey.builder() .withKeyData(expKeyData) .withRollingStartIntervalNumber(expRollingStartIntervalNumber) - .withRollingPeriod(expRollingPeriod) .withTransmissionRiskLevel(expTransmissionRiskLevel).build(); } @@ -226,7 +229,7 @@ private void assertDiagnosisKeyEquals(DiagnosisKey actDiagnosisKey, long expSubm assertThat(actDiagnosisKey.getSubmissionTimestamp()).isEqualTo(expSubmissionTimestamp); assertThat(actDiagnosisKey.getKeyData()).isEqualTo(this.expKeyData); assertThat(actDiagnosisKey.getRollingStartIntervalNumber()).isEqualTo(this.expRollingStartIntervalNumber); - assertThat(actDiagnosisKey.getRollingPeriod()).isEqualTo(this.expRollingPeriod); + assertThat(actDiagnosisKey.getRollingPeriod()).isEqualTo(DiagnosisKey.EXPECTED_ROLLING_PERIOD); assertThat(actDiagnosisKey.getTransmissionRiskLevel()).isEqualTo(this.expTransmissionRiskLevel); } } diff --git a/common/persistence/src/test/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyServiceMockedRepositoryTest.java b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyServiceMockedRepositoryTest.java --- a/common/persistence/src/test/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyServiceMockedRepositoryTest.java +++ b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyServiceMockedRepositoryTest.java @@ -37,7 +37,6 @@ class DiagnosisKeyServiceMockedRepositoryTest { static final byte[] expKeyData = "16-bytelongarray".getBytes(Charset.defaultCharset()); static final int expRollingStartIntervalNumber = 73800; - static final int expRollingPeriod = 144; static final int expTransmissionRiskLevel = 1; @Autowired @@ -82,12 +81,12 @@ private void mockInvalidKeyInDb(List<DiagnosisKey> keys) { private DiagnosisKey validKey(long expSubmissionTimestamp) { return new DiagnosisKey(expKeyData, expRollingStartIntervalNumber, - expRollingPeriod, expTransmissionRiskLevel, expSubmissionTimestamp); + DiagnosisKey.EXPECTED_ROLLING_PERIOD, expTransmissionRiskLevel, expSubmissionTimestamp); } private DiagnosisKey invalidKey(long expSubmissionTimestamp) { byte[] expKeyData = "17--bytelongarray".getBytes(Charset.defaultCharset()); return new DiagnosisKey(expKeyData, expRollingStartIntervalNumber, - expRollingPeriod, expTransmissionRiskLevel, expSubmissionTimestamp); + DiagnosisKey.EXPECTED_ROLLING_PERIOD, expTransmissionRiskLevel, expSubmissionTimestamp); } } diff --git a/common/persistence/src/test/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyServiceTest.java b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyServiceTest.java --- a/common/persistence/src/test/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyServiceTest.java +++ b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyServiceTest.java @@ -137,7 +137,6 @@ void testNoPersistOnValidationError() { var keys = List.of(DiagnosisKey.builder() .withKeyData(new byte[16]) .withRollingStartIntervalNumber((int) (OffsetDateTime.now(UTC).toEpochSecond() / 600)) - .withRollingPeriod(1) .withTransmissionRiskLevel(2) .withSubmissionTimestamp(0L).build()); @@ -153,7 +152,6 @@ public static DiagnosisKey buildDiagnosisKeyForSubmissionTimestamp(long submissi return DiagnosisKey.builder() .withKeyData(new byte[16]) .withRollingStartIntervalNumber(600) - .withRollingPeriod(1) .withTransmissionRiskLevel(2) .withSubmissionTimestamp(submissionTimeStamp).build(); } diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/common/Helpers.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/common/Helpers.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/common/Helpers.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/common/Helpers.java @@ -36,7 +36,6 @@ public static DiagnosisKey buildDiagnosisKeyForSubmissionTimestamp(long submissi return DiagnosisKey.builder() .withKeyData(new byte[16]) .withRollingStartIntervalNumber(600) - .withRollingPeriod(1) .withTransmissionRiskLevel(2) .withSubmissionTimestamp(submissionTimeStamp).build(); } diff --git a/services/submission/src/test/java/app/coronawarn/server/services/submission/ServerApplicationTests.java b/services/submission/src/test/java/app/coronawarn/server/services/submission/ServerApplicationTests.java --- a/services/submission/src/test/java/app/coronawarn/server/services/submission/ServerApplicationTests.java +++ b/services/submission/src/test/java/app/coronawarn/server/services/submission/ServerApplicationTests.java @@ -25,6 +25,8 @@ import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.boot.test.mock.mockito.MockBean; +import org.springframework.boot.test.web.client.TestRestTemplate; @SpringBootTest class ServerApplicationTests { @@ -32,6 +34,9 @@ class ServerApplicationTests { @Autowired private SubmissionController controller; + @MockBean + private TestRestTemplate testRestTemplate; + @Test void contextLoads() { assertThat(this.controller).isNotNull(); diff --git a/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/PayloadValidationTest.java b/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/PayloadValidationTest.java new file mode 100644 --- /dev/null +++ b/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/PayloadValidationTest.java @@ -0,0 +1,136 @@ +/* + * Corona-Warn-App + * + * SAP SE and all other contributors / + * copyright owners license this file to you 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 + * + * http://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. + */ + +package app.coronawarn.server.services.submission.controller; + +import static app.coronawarn.server.services.submission.controller.RequestExecutor.VALID_KEY_DATA_1; +import static app.coronawarn.server.services.submission.controller.RequestExecutor.VALID_KEY_DATA_2; +import static app.coronawarn.server.services.submission.controller.RequestExecutor.VALID_KEY_DATA_3; +import static app.coronawarn.server.services.submission.controller.RequestExecutor.buildOkHeaders; +import static app.coronawarn.server.services.submission.controller.RequestExecutor.buildTemporaryExposureKey; +import static app.coronawarn.server.services.submission.controller.RequestExecutor.createRollingStartIntervalNumber; +import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.ArgumentMatchers.anyString; +import static org.mockito.Mockito.when; +import static org.springframework.http.HttpStatus.BAD_REQUEST; +import static org.springframework.http.HttpStatus.OK; + +import app.coronawarn.server.common.persistence.domain.DiagnosisKey; +import app.coronawarn.server.common.protocols.external.exposurenotification.TemporaryExposureKey; +import app.coronawarn.server.services.submission.verification.TanVerifier; +import java.util.ArrayList; +import java.util.Collection; +import org.assertj.core.util.Lists; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.boot.test.mock.mockito.MockBean; +import org.springframework.http.ResponseEntity; + +@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) +class PayloadValidationTest { + + @MockBean + private TanVerifier tanVerifier; + + @BeforeEach + public void setUpMocks() { + when(tanVerifier.verifyTan(anyString())).thenReturn(true); + } + + @Autowired + RequestExecutor executor; + + @Test + void check400ResponseStatusForMissingKeys() { + ResponseEntity<Void> actResponse = executor.executeRequest(Lists.emptyList(), buildOkHeaders()); + assertThat(actResponse.getStatusCode()).isEqualTo(BAD_REQUEST); + } + + @Test + void check400ResponseStatusForTooManyKeys() { + ResponseEntity<Void> actResponse = executor.executeRequest(buildPayloadWithTooManyKeys(), buildOkHeaders()); + + assertThat(actResponse.getStatusCode()).isEqualTo(BAD_REQUEST); + } + + private Collection<TemporaryExposureKey> buildPayloadWithTooManyKeys() { + ArrayList<TemporaryExposureKey> tooMany = new ArrayList<>(); + for (int i = 0; i <= 20; i++) { + tooMany.add(buildTemporaryExposureKey(VALID_KEY_DATA_1, createRollingStartIntervalNumber(2), 3)); + } + return tooMany; + } + + @Test + void check400ResponseStatusForDuplicateStartIntervalNumber() { + int rollingStartIntervalNumber = createRollingStartIntervalNumber(2); + var keysWithDuplicateStartIntervalNumber = Lists.list( + buildTemporaryExposureKey(VALID_KEY_DATA_1, rollingStartIntervalNumber, 1), + buildTemporaryExposureKey(VALID_KEY_DATA_2, rollingStartIntervalNumber, 2)); + + ResponseEntity<Void> actResponse = executor.executeRequest(keysWithDuplicateStartIntervalNumber, buildOkHeaders()); + + assertThat(actResponse.getStatusCode()).isEqualTo(BAD_REQUEST); + } + + @Test + void check400ResponseStatusForGapsInTimeIntervals() { + int rollingStartIntervalNumber1 = createRollingStartIntervalNumber(6); + int rollingStartIntervalNumber2 = rollingStartIntervalNumber1 + DiagnosisKey.EXPECTED_ROLLING_PERIOD; + int rollingStartIntervalNumber3 = rollingStartIntervalNumber2 + 2 * DiagnosisKey.EXPECTED_ROLLING_PERIOD; + var keysWithDuplicateStartIntervalNumber = Lists.list( + buildTemporaryExposureKey(VALID_KEY_DATA_1, rollingStartIntervalNumber1, 1), + buildTemporaryExposureKey(VALID_KEY_DATA_3, rollingStartIntervalNumber3, 3), + buildTemporaryExposureKey(VALID_KEY_DATA_2, rollingStartIntervalNumber2, 2)); + + ResponseEntity<Void> actResponse = executor.executeRequest(keysWithDuplicateStartIntervalNumber, buildOkHeaders()); + + assertThat(actResponse.getStatusCode()).isEqualTo(BAD_REQUEST); + } + + @Test + void check400ResponseStatusForOverlappingTimeIntervals() { + int rollingStartIntervalNumber1 = createRollingStartIntervalNumber(6); + int rollingStartIntervalNumber2 = rollingStartIntervalNumber1 + (DiagnosisKey.EXPECTED_ROLLING_PERIOD / 2); + var keysWithDuplicateStartIntervalNumber = Lists.list( + buildTemporaryExposureKey(VALID_KEY_DATA_1, rollingStartIntervalNumber1, 1), + buildTemporaryExposureKey(VALID_KEY_DATA_2, rollingStartIntervalNumber2, 2)); + + ResponseEntity<Void> actResponse = executor.executeRequest(keysWithDuplicateStartIntervalNumber, buildOkHeaders()); + + assertThat(actResponse.getStatusCode()).isEqualTo(BAD_REQUEST); + } + + @Test + void check200ResponseStatusForValidSubmissionPayload() { + int rollingStartIntervalNumber1 = createRollingStartIntervalNumber(6); + int rollingStartIntervalNumber2 = rollingStartIntervalNumber1 + DiagnosisKey.EXPECTED_ROLLING_PERIOD; + int rollingStartIntervalNumber3 = rollingStartIntervalNumber2 + DiagnosisKey.EXPECTED_ROLLING_PERIOD; + var keysWithDuplicateStartIntervalNumber = Lists.list( + buildTemporaryExposureKey(VALID_KEY_DATA_1, rollingStartIntervalNumber1, 1), + buildTemporaryExposureKey(VALID_KEY_DATA_3, rollingStartIntervalNumber3, 3), + buildTemporaryExposureKey(VALID_KEY_DATA_2, rollingStartIntervalNumber2, 2)); + + ResponseEntity<Void> actResponse = executor.executeRequest(keysWithDuplicateStartIntervalNumber, buildOkHeaders()); + + assertThat(actResponse.getStatusCode()).isEqualTo(OK); + } +} diff --git a/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/RequestExecutor.java b/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/RequestExecutor.java new file mode 100644 --- /dev/null +++ b/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/RequestExecutor.java @@ -0,0 +1,99 @@ +/* + * Corona-Warn-App + * + * SAP SE and all other contributors / + * copyright owners license this file to you 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 + * + * http://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. + */ + +package app.coronawarn.server.services.submission.controller; + +import static java.time.ZoneOffset.UTC; + +import app.coronawarn.server.common.protocols.external.exposurenotification.TemporaryExposureKey; +import app.coronawarn.server.common.protocols.internal.SubmissionPayload; +import com.google.protobuf.ByteString; +import java.net.URI; +import java.time.Instant; +import java.time.LocalDate; +import java.util.Collection; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.web.client.TestRestTemplate; +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpMethod; +import org.springframework.http.MediaType; +import org.springframework.http.RequestEntity; +import org.springframework.http.ResponseEntity; +import org.springframework.stereotype.Component; + +/** + * RequestExecutor executes requests against the diagnosis key submission endpoint and holds a various methods for test + * request generation. + */ +@Component +public class RequestExecutor { + public static final String VALID_KEY_DATA_1 = "testKey111111111"; + public static final String VALID_KEY_DATA_2 = "testKey222222222"; + public static final String VALID_KEY_DATA_3 = "testKey333333333"; + private static final URI SUBMISSION_URL = URI.create("/version/v1/diagnosis-keys"); + private final TestRestTemplate testRestTemplate; + + @Autowired + public RequestExecutor(TestRestTemplate testRestTemplate) { + this.testRestTemplate = testRestTemplate; + } + + public ResponseEntity<Void> executeRequest(Collection<TemporaryExposureKey> keys, HttpHeaders headers) { + SubmissionPayload body = SubmissionPayload.newBuilder().addAllKeys(keys).build(); + RequestEntity<SubmissionPayload> request = + new RequestEntity<>(body, headers, HttpMethod.POST, SUBMISSION_URL); + return testRestTemplate.postForEntity(SUBMISSION_URL, request, Void.class); + } + + public static HttpHeaders buildOkHeaders() { + HttpHeaders headers = setCwaAuthHeader(setContentTypeProtoBufHeader(new HttpHeaders())); + + return setCwaFakeHeader(headers, "0"); + } + + public static HttpHeaders setContentTypeProtoBufHeader(HttpHeaders headers) { + headers.setContentType(MediaType.valueOf("application/x-protobuf")); + return headers; + } + + public static HttpHeaders setCwaAuthHeader(HttpHeaders headers) { + headers.set("cwa-authorization", "TAN okTan"); + return headers; + } + + public static HttpHeaders setCwaFakeHeader(HttpHeaders headers, String value) { + headers.set("cwa-fake", value); + return headers; + } + + public static TemporaryExposureKey buildTemporaryExposureKey( + String keyData, int rollingStartIntervalNumber, int transmissionRiskLevel) { + return TemporaryExposureKey.newBuilder() + .setKeyData(ByteString.copyFromUtf8(keyData)) + .setRollingStartIntervalNumber(rollingStartIntervalNumber) + .setTransmissionRiskLevel(transmissionRiskLevel).build(); + } + + public static int createRollingStartIntervalNumber(Integer daysAgo) { + return Math.toIntExact(LocalDate + .ofInstant(Instant.now(), UTC) + .minusDays(daysAgo).atStartOfDay() + .toEpochSecond(UTC) / (60 * 10)); + } +} diff --git a/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/SubmissionControllerTest.java b/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/SubmissionControllerTest.java --- a/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/SubmissionControllerTest.java +++ b/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/SubmissionControllerTest.java @@ -19,7 +19,15 @@ package app.coronawarn.server.services.submission.controller; -import static java.time.ZoneOffset.UTC; +import static app.coronawarn.server.services.submission.controller.RequestExecutor.VALID_KEY_DATA_1; +import static app.coronawarn.server.services.submission.controller.RequestExecutor.VALID_KEY_DATA_2; +import static app.coronawarn.server.services.submission.controller.RequestExecutor.VALID_KEY_DATA_3; +import static app.coronawarn.server.services.submission.controller.RequestExecutor.buildOkHeaders; +import static app.coronawarn.server.services.submission.controller.RequestExecutor.buildTemporaryExposureKey; +import static app.coronawarn.server.services.submission.controller.RequestExecutor.createRollingStartIntervalNumber; +import static app.coronawarn.server.services.submission.controller.RequestExecutor.setContentTypeProtoBufHeader; +import static app.coronawarn.server.services.submission.controller.RequestExecutor.setCwaAuthHeader; +import static app.coronawarn.server.services.submission.controller.RequestExecutor.setCwaFakeHeader; import static org.assertj.core.api.Assertions.assertThat; import static org.mockito.Mockito.any; import static org.mockito.Mockito.anyString; @@ -36,12 +44,10 @@ import app.coronawarn.server.common.persistence.domain.DiagnosisKey; import app.coronawarn.server.common.persistence.service.DiagnosisKeyService; import app.coronawarn.server.common.protocols.external.exposurenotification.TemporaryExposureKey; -import app.coronawarn.server.common.protocols.internal.SubmissionPayload; +import app.coronawarn.server.services.submission.config.SubmissionServiceConfig; import app.coronawarn.server.services.submission.verification.TanVerifier; import com.google.protobuf.ByteString; import java.net.URI; -import java.time.Instant; -import java.time.LocalDate; import java.util.ArrayList; import java.util.Arrays; import java.util.Collection; @@ -63,8 +69,6 @@ import org.springframework.http.HttpHeaders; import org.springframework.http.HttpMethod; import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; -import org.springframework.http.RequestEntity; import org.springframework.http.ResponseEntity; @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) @@ -81,6 +85,12 @@ class SubmissionControllerTest { @Autowired private TestRestTemplate testRestTemplate; + @Autowired + private RequestExecutor executor; + + @Autowired + private SubmissionServiceConfig config; + @BeforeEach public void setUpMocks() { when(tanVerifier.verifyTan(anyString())).thenReturn(true); @@ -88,33 +98,13 @@ public void setUpMocks() { @Test void checkResponseStatusForValidParameters() { - ResponseEntity<Void> actResponse = - executeRequest(buildPayloadWithMultipleKeys(), buildOkHeaders()); - + ResponseEntity<Void> actResponse = executor.executeRequest(buildPayloadWithMultipleKeys(), buildOkHeaders()); assertThat(actResponse.getStatusCode()).isEqualTo(OK); } @Test void check400ResponseStatusForInvalidParameters() { - ResponseEntity<Void> actResponse = - executeRequest(buildPayloadWithInvalidKey(), buildOkHeaders()); - - assertThat(actResponse.getStatusCode()).isEqualTo(BAD_REQUEST); - } - - @Test - void check400ResponseStatusForMissingKeys() { - ResponseEntity<Void> actResponse = - executeRequest(new ArrayList<>(), buildOkHeaders()); - - assertThat(actResponse.getStatusCode()).isEqualTo(BAD_REQUEST); - } - - @Test - void check400ResponseStatusForTooManyKeys() { - ResponseEntity<Void> actResponse = - executeRequest(buildPayloadWithTooManyKeys(), buildOkHeaders()); - + ResponseEntity<Void> actResponse = executor.executeRequest(buildPayloadWithInvalidKey(), buildOkHeaders()); assertThat(actResponse.getStatusCode()).isEqualTo(BAD_REQUEST); } @@ -123,7 +113,7 @@ void singleKeyWithOutdatedRollingStartIntervalNumberDoesNotGetSaved() { Collection<TemporaryExposureKey> keys = buildPayloadWithSingleOutdatedKey(); ArgumentCaptor<Collection<DiagnosisKey>> argument = ArgumentCaptor.forClass(Collection.class); - executeRequest(keys, buildOkHeaders()); + executor.executeRequest(keys, buildOkHeaders()); verify(diagnosisKeyService, atLeastOnce()).saveDiagnosisKeys(argument.capture()); assertThat(argument.getValue()).isEmpty(); @@ -136,7 +126,7 @@ void keysWithOutdatedRollingStartIntervalNumberDoNotGetSaved() { keys.add(outdatedKey); ArgumentCaptor<Collection<DiagnosisKey>> argument = ArgumentCaptor.forClass(Collection.class); - executeRequest(keys, buildOkHeaders()); + executor.executeRequest(keys, buildOkHeaders()); verify(diagnosisKeyService, atLeastOnce()).saveDiagnosisKeys(argument.capture()); keys.remove(outdatedKey); @@ -148,7 +138,7 @@ void checkSaveOperationCallForValidParameters() { Collection<TemporaryExposureKey> keys = buildPayloadWithMultipleKeys(); ArgumentCaptor<Collection<DiagnosisKey>> argument = ArgumentCaptor.forClass(Collection.class); - executeRequest(keys, buildOkHeaders()); + executor.executeRequest(keys, buildOkHeaders()); verify(diagnosisKeyService, atLeastOnce()).saveDiagnosisKeys(argument.capture()); assertElementsCorrespondToEachOther(keys, argument.getValue()); @@ -157,7 +147,7 @@ void checkSaveOperationCallForValidParameters() { @ParameterizedTest @MethodSource("createIncompleteHeaders") void badRequestIfCwaHeadersMissing(HttpHeaders headers) { - ResponseEntity<Void> actResponse = executeRequest(buildPayloadWithOneKey(), headers); + ResponseEntity<Void> actResponse = executor.executeRequest(buildPayloadWithOneKey(), headers); verify(diagnosisKeyService, never()).saveDiagnosisKeys(any()); assertThat(actResponse.getStatusCode()).isEqualTo(BAD_REQUEST); @@ -197,8 +187,7 @@ private static Stream<Arguments> createDeniedHttpMethods() { void invalidTanHandling() { when(tanVerifier.verifyTan(anyString())).thenReturn(false); - ResponseEntity<Void> actResponse = - executeRequest(buildPayloadWithOneKey(), buildOkHeaders()); + ResponseEntity<Void> actResponse = executor.executeRequest(buildPayloadWithOneKey(), buildOkHeaders()); verify(diagnosisKeyService, never()).saveDiagnosisKeys(any()); assertThat(actResponse.getStatusCode()).isEqualTo(FORBIDDEN); @@ -209,90 +198,44 @@ void fakeRequestHandling() { HttpHeaders headers = buildOkHeaders(); setCwaFakeHeader(headers, "1"); - ResponseEntity<Void> actResponse = executeRequest(buildPayloadWithOneKey(), headers); + ResponseEntity<Void> actResponse = executor.executeRequest(buildPayloadWithOneKey(), headers); verify(diagnosisKeyService, never()).saveDiagnosisKeys(any()); assertThat(actResponse.getStatusCode()).isEqualTo(OK); } - private static HttpHeaders buildOkHeaders() { - HttpHeaders headers = setCwaAuthHeader(setContentTypeProtoBufHeader(new HttpHeaders())); - - return setCwaFakeHeader(headers, "0"); - } - - private static HttpHeaders setContentTypeProtoBufHeader(HttpHeaders headers) { - headers.setContentType(MediaType.valueOf("application/x-protobuf")); - return headers; - } - - private static HttpHeaders setCwaAuthHeader(HttpHeaders headers) { - headers.set("cwa-authorization", "TAN okTan"); - return headers; - } - - private static HttpHeaders setCwaFakeHeader(HttpHeaders headers, String value) { - headers.set("cwa-fake", value); - return headers; - } - private static Collection<TemporaryExposureKey> buildPayloadWithOneKey() { - return Collections.singleton(buildTemporaryExposureKey("testKey111111111", 1, 2, 3)); + return Collections.singleton(buildTemporaryExposureKey(VALID_KEY_DATA_1, 1, 3)); } - private static Collection<TemporaryExposureKey> buildPayloadWithMultipleKeys() { + private Collection<TemporaryExposureKey> buildPayloadWithMultipleKeys() { + int rollingStartIntervalNumber1 = createRollingStartIntervalNumber(config.getRetentionDays() - 1); + int rollingStartIntervalNumber2 = rollingStartIntervalNumber1 + DiagnosisKey.EXPECTED_ROLLING_PERIOD; + int rollingStartIntervalNumber3 = rollingStartIntervalNumber2 + DiagnosisKey.EXPECTED_ROLLING_PERIOD; return Stream.of( - buildTemporaryExposureKey("testKey111111111", createRollingStartIntervalNumber(2), 2, 3), - buildTemporaryExposureKey("testKey222222222", createRollingStartIntervalNumber(4), 5, 6), - buildTemporaryExposureKey("testKey333333333", createRollingStartIntervalNumber(10), 8, 8)) + buildTemporaryExposureKey(VALID_KEY_DATA_1, rollingStartIntervalNumber1, 3), + buildTemporaryExposureKey(VALID_KEY_DATA_2, rollingStartIntervalNumber3, 6), + buildTemporaryExposureKey(VALID_KEY_DATA_3, rollingStartIntervalNumber2, 8)) .collect(Collectors.toCollection(ArrayList::new)); } - private static Collection<TemporaryExposureKey> buildPayloadWithSingleOutdatedKey() { + private Collection<TemporaryExposureKey> buildPayloadWithSingleOutdatedKey() { TemporaryExposureKey outdatedKey = createOutdatedKey(); return Stream.of(outdatedKey).collect(Collectors.toCollection(ArrayList::new)); } - private static TemporaryExposureKey createOutdatedKey() { + private TemporaryExposureKey createOutdatedKey() { return TemporaryExposureKey.newBuilder() - .setKeyData(ByteString.copyFromUtf8("testKey222222222")) - .setRollingStartIntervalNumber(createRollingStartIntervalNumber(99)) - .setRollingPeriod(10) + .setKeyData(ByteString.copyFromUtf8(VALID_KEY_DATA_2)) + .setRollingStartIntervalNumber(createRollingStartIntervalNumber(config.getRetentionDays())) + .setRollingPeriod(DiagnosisKey.EXPECTED_ROLLING_PERIOD) .setTransmissionRiskLevel(5).build(); } - - private Collection<TemporaryExposureKey> buildPayloadWithTooManyKeys() { - ArrayList<TemporaryExposureKey> tooMany = new ArrayList<>(); - for (int i = 0; i <= 99; i++) { - tooMany.add( - buildTemporaryExposureKey("testKey111111111", createRollingStartIntervalNumber(2), 2, 3)); - } - - return tooMany; - } - private static Collection<TemporaryExposureKey> buildPayloadWithInvalidKey() { return Stream.of( - buildTemporaryExposureKey("testKey111111111", createRollingStartIntervalNumber(2), 2, 999)) + buildTemporaryExposureKey(VALID_KEY_DATA_1, createRollingStartIntervalNumber(2), 999)) .collect(Collectors.toCollection(ArrayList::new)); } - - private static int createRollingStartIntervalNumber(Integer daysAgo) { - return Math.toIntExact(LocalDate - .ofInstant(Instant.now(), UTC) - .minusDays(daysAgo).atStartOfDay() - .toEpochSecond(UTC) / (60 * 10)); - } - - private static TemporaryExposureKey buildTemporaryExposureKey( - String keyData, int rollingStartIntervalNumber, int rollingPeriod, int transmissionRiskLevel) { - return TemporaryExposureKey.newBuilder() - .setKeyData(ByteString.copyFromUtf8(keyData)) - .setRollingStartIntervalNumber(rollingStartIntervalNumber) - .setRollingPeriod(rollingPeriod) - .setTransmissionRiskLevel(transmissionRiskLevel).build(); - } - private void assertElementsCorrespondToEachOther (Collection<TemporaryExposureKey> submittedKeys, Collection<DiagnosisKey> keyEntities) { Set<DiagnosisKey> expKeys = submittedKeys.stream() @@ -307,11 +250,4 @@ private static TemporaryExposureKey buildTemporaryExposureKey( .contains(anActKey) ); } - - private ResponseEntity<Void> executeRequest(Collection<TemporaryExposureKey> keys, HttpHeaders headers) { - SubmissionPayload body = SubmissionPayload.newBuilder().addAllKeys(keys).build(); - RequestEntity<SubmissionPayload> request = - new RequestEntity<>(body, headers, HttpMethod.POST, SUBMISSION_URL); - return testRestTemplate.postForEntity(SUBMISSION_URL, request, Void.class); - } }

Apple's Proposal for Exposure Key Validation #92 Current Implementation We used sensible assumptions for key validation. ## Suggested Enhancement [Apple proposes](https://developer.apple.com/documentation/exposurenotification/setting_up_an_exposure_notification_server?changes=latest_beta): > An EN server must reject invalid key files uploaded from a client app. Uploaded key data is considered invalid if: > > Any ENIntervalNumber values from the same user are not unique > > There are any gaps in the ENIntervalNumber values for a user > > Any keys in the file have overlapping time windows > > The period of time covered by the data file exceeds 14 days > > The TEKRollingPeriod value is not 144 > > You may optionally want to validate the clock time the device submits. ## Expected Benefits Adherence to reference implementations.

Part of https://github.com/corona-warn-app/cwa-server/issues/168

corona-warn-app/cwa-server

corona-warn-app__cwa-server-346

92f3c9bd98420cd26c4216cace3e481874be6140

diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccess.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccess.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccess.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccess.java @@ -129,7 +129,7 @@ public void putObject(LocalFile localFile) * * @param prefix the prefix, e.g. my/folder/ */ - public List<DeleteError> deleteObjectsWithPrefix(String prefix) + public void deleteObjectsWithPrefix(String prefix) throws MinioException, GeneralSecurityException, IOException { List<String> toDelete = getObjectsWithPrefix(prefix) .stream() @@ -144,9 +144,9 @@ public List<DeleteError> deleteObjectsWithPrefix(String prefix) errors.add(deleteErrorResult.get()); } - logger.info("Deletion result: {}", errors.size()); - - return errors; + if (!errors.isEmpty()) { + throw new MinioException("Can't delete files, number of errors: " + errors.size()); + } } /** diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3RetentionPolicy.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3RetentionPolicy.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3RetentionPolicy.java @@ -0,0 +1,90 @@ +/* + * Corona-Warn-App + * + * SAP SE and all other contributors / + * copyright owners license this file to you 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 + * + * http://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. + */ + +package app.coronawarn.server.services.distribution.objectstore; + +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig.Api; +import io.minio.errors.MinioException; +import java.io.IOException; +import java.io.UncheckedIOException; +import java.security.GeneralSecurityException; +import java.time.LocalDate; +import java.time.ZoneOffset; +import java.time.format.DateTimeFormatter; +import java.util.List; +import java.util.regex.Matcher; +import java.util.regex.Pattern; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Component; + +/** + * Creates an S3RetentionPolicy object, which applies the retention policy to the S3 compatible storage. + */ +@Component +public class S3RetentionPolicy { + + private final ObjectStoreAccess objectStoreAccess; + private final Api api; + + @Autowired + public S3RetentionPolicy(ObjectStoreAccess objectStoreAccess, DistributionServiceConfig distributionServiceConfig) { + this.objectStoreAccess = objectStoreAccess; + this.api = distributionServiceConfig.getApi(); + } + + /** + * Deletes all diagnosis-key files from S3 that are older than retentionDays. + * + * @param retentionDays the number of days, that files should be retained on S3. + */ + public void applyRetentionPolicy(int retentionDays) throws MinioException, GeneralSecurityException, IOException { + List<S3Object> diagnosisKeysObjects = objectStoreAccess.getObjectsWithPrefix("version/v1/" + + api.getDiagnosisKeysPath() + "/" + + api.getCountryPath() + "/" + + api.getCountryGermany() + "/" + + api.getDatePath() + "/"); + final String regex = ".*([0-9]{4}-[0-9]{2}-[0-9]{2}).*"; + final Pattern pattern = Pattern.compile(regex); + + final LocalDate cutOffDate = LocalDate.now(ZoneOffset.UTC).minusDays(retentionDays); + + diagnosisKeysObjects.stream() + .filter(diagnosisKeysObject -> { + Matcher matcher = pattern.matcher(diagnosisKeysObject.getObjectName()); + return matcher.matches() && LocalDate.parse(matcher.group(1), DateTimeFormatter.ISO_LOCAL_DATE) + .isBefore(cutOffDate); + }) + .forEach(this::deleteDiagnosisKey); + } + + /** + * Java stream do not support checked exceptions within streams. This helper method rethrows them as unchecked + * expressions, so they can be passed up to the Retention Policy. + * + * @param diagnosisKey the diagnosis key, that should be deleted. + */ + public void deleteDiagnosisKey(S3Object diagnosisKey) { + try { + objectStoreAccess.deleteObjectsWithPrefix(diagnosisKey.getObjectName()); + } catch (Exception e) { + throw new UncheckedIOException(new IOException(e)); + } + } +} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/RetentionPolicy.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/RetentionPolicy.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/RetentionPolicy.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/RetentionPolicy.java @@ -22,6 +22,7 @@ import app.coronawarn.server.common.persistence.service.DiagnosisKeyService; import app.coronawarn.server.services.distribution.Application; import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import app.coronawarn.server.services.distribution.objectstore.S3RetentionPolicy; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.boot.ApplicationArguments; @@ -46,27 +47,32 @@ public class RetentionPolicy implements ApplicationRunner { private final Integer retentionDays; + private final S3RetentionPolicy s3RetentionPolicy; + /** * Creates a new RetentionPolicy. */ RetentionPolicy(DiagnosisKeyService diagnosisKeyService, ApplicationContext applicationContext, - DistributionServiceConfig distributionServiceConfig) { + DistributionServiceConfig distributionServiceConfig, + S3RetentionPolicy s3RetentionPolicy) { this.diagnosisKeyService = diagnosisKeyService; this.applicationContext = applicationContext; this.retentionDays = distributionServiceConfig.getRetentionDays(); + this.s3RetentionPolicy = s3RetentionPolicy; } @Override public void run(ApplicationArguments args) { try { diagnosisKeyService.applyRetentionPolicy(retentionDays); + s3RetentionPolicy.applyRetentionPolicy(retentionDays); } catch (Exception e) { logger.error("Application of retention policy failed.", e); Application.killApplication(applicationContext); } - logger.debug("Retention policy applied successfully. Deleted all entries older that {} days.", + logger.debug("Retention policy applied successfully. Deleted all entries older than {} days.", retentionDays); } }

diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3RetentionPolicyTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3RetentionPolicyTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3RetentionPolicyTest.java @@ -0,0 +1,92 @@ +/* + * Corona-Warn-App + * + * SAP SE and all other contributors / + * copyright owners license this file to you 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 + * + * http://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. + */ + +package app.coronawarn.server.services.distribution.objectstore; + +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.Mockito.atLeastOnce; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig.ObjectStore; +import io.minio.errors.MinioException; +import java.io.IOException; +import java.security.GeneralSecurityException; +import java.time.LocalDate; +import java.util.List; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.boot.test.context.ConfigFileApplicationContextInitializer; +import org.springframework.boot.test.mock.mockito.MockBean; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit.jupiter.SpringExtension; + +@EnableConfigurationProperties(value = DistributionServiceConfig.class) +@ExtendWith(SpringExtension.class) +@ContextConfiguration(classes = {S3RetentionPolicy.class, ObjectStore.class}, + initializers = ConfigFileApplicationContextInitializer.class) +class S3RetentionPolicyTest { + + @MockBean + private ObjectStoreAccess objectStoreAccess; + + @Autowired + private S3RetentionPolicy s3RetentionPolicy; + + @Autowired DistributionServiceConfig distributionServiceConfig; + + @Test + void shouldDeleteOldFiles() throws IOException, GeneralSecurityException, MinioException { + String expectedFileToBeDeleted = generateFileName(LocalDate.now().minusDays(2)); + + when(objectStoreAccess.getObjectsWithPrefix(any())).thenReturn(List.of( + new S3Object(expectedFileToBeDeleted), + new S3Object(generateFileName(LocalDate.now())), + new S3Object("version/v1/configuration/country/DE/app_config"))); + + s3RetentionPolicy.applyRetentionPolicy(1); + + verify(objectStoreAccess, atLeastOnce()).deleteObjectsWithPrefix(eq(expectedFileToBeDeleted)); + } + + @Test + void shouldNotDeleteFilesIfAllAreValid() throws IOException, GeneralSecurityException, MinioException { + when(objectStoreAccess.getObjectsWithPrefix(any())).thenReturn(List.of( + new S3Object(generateFileName(LocalDate.now().minusDays(1))), + new S3Object(generateFileName(LocalDate.now().plusDays(1))), + new S3Object(generateFileName(LocalDate.now())), + new S3Object("version/v1/configuration/country/DE/app_config"))); + + s3RetentionPolicy.applyRetentionPolicy(1); + + verify(objectStoreAccess, never()).deleteObjectsWithPrefix(any()); + } + + private String generateFileName(LocalDate date) { + var api = distributionServiceConfig.getApi(); + + return "version/v1/" + api.getDiagnosisKeysPath() + "/" + api.getCountryPath() + "/" + + api.getCountryGermany() + "/" + api.getDatePath() + "/" + date.toString() + "/hour/0"; + } +}

Retention: Enforce period on Object Store Currently, the retention period is only enforced for keys on the database, but it should be enforced on the S3 as well. Therefore, we need to delete the items on the S3, when the retention policy is reached. When the retention mechanism is kicked off, and then delete the following keys with the prefix: `version/v1/diagnosis-keys/country/DE/date/<RETENTIONDATE>` Where RETENTIONDATE is `current date - retention period`. Ideally, we should also try to delete older items as well, in case the retention run did not succeed or did not run at all.

I propose to just remove the "delta upload" feature from the S3Publisher (see [here](https://github.com/corona-warn-app/cwa-server/blob/master/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3Publisher.java#L75)) and instead just wipe the whole bucket on every distribution run and to upload everything anew. This way, the only place where retention policies need to be applied is the DB as a single source of truth (which is already done) and we remove some moving parts and complexity that could potentially cause problems. Also see review comment [here](https://github.com/corona-warn-app/cwa-server/pull/147#discussion_r426311639).

corona-warn-app/cwa-server

corona-warn-app__cwa-server-349

ef4edb4c92fb9bf65544e22e2b4f2e8f8a55fa97

diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccess.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccess.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccess.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccess.java @@ -20,19 +20,17 @@ package app.coronawarn.server.services.distribution.objectstore; import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; -import app.coronawarn.server.services.distribution.config.DistributionServiceConfig.ObjectStore; import app.coronawarn.server.services.distribution.objectstore.publish.LocalFile; import io.minio.MinioClient; import io.minio.PutObjectOptions; import io.minio.Result; -import io.minio.errors.InvalidEndpointException; -import io.minio.errors.InvalidPortException; import io.minio.errors.MinioException; import io.minio.messages.DeleteError; import io.minio.messages.Item; import java.io.IOException; import java.security.GeneralSecurityException; import java.util.ArrayList; +import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.stream.Collectors; @@ -58,7 +56,11 @@ public class ObjectStoreAccess { private static final Logger logger = LoggerFactory.getLogger(ObjectStoreAccess.class); - private static final String DEFAULT_REGION = "eu-west-1"; + /** + * Specifies the default maximum amount of time in seconds that a published resource can be considered "fresh" when + * held in a cache. + */ + public static final int DEFAULT_MAX_CACHE_AGE = 300; private final boolean isSetPublicReadAclOnPutObject; @@ -71,14 +73,14 @@ public class ObjectStoreAccess { * bucket. * * @param distributionServiceConfig The config properties + * @param minioClient The client used for interaction with the object store * @throws IOException When there were problems creating the S3 client * @throws GeneralSecurityException When there were problems creating the S3 client * @throws MinioException When there were problems creating the S3 client */ - ObjectStoreAccess(DistributionServiceConfig distributionServiceConfig) + ObjectStoreAccess(DistributionServiceConfig distributionServiceConfig, MinioClient minioClient) throws IOException, GeneralSecurityException, MinioException { - this.client = createClient(distributionServiceConfig.getObjectStore()); - + this.client = minioClient; this.bucket = distributionServiceConfig.getObjectStore().getBucket(); this.isSetPublicReadAclOnPutObject = distributionServiceConfig.getObjectStore().isSetPublicReadAclOnPutObject(); @@ -87,38 +89,25 @@ public class ObjectStoreAccess { } } - private MinioClient createClient(ObjectStore objectStore) - throws InvalidPortException, InvalidEndpointException { - if (isSsl(objectStore)) { - return new MinioClient( - objectStore.getEndpoint(), - objectStore.getPort(), - objectStore.getAccessKey(), objectStore.getSecretKey(), - DEFAULT_REGION, - true - ); - } else { - return new MinioClient( - objectStore.getEndpoint(), - objectStore.getPort(), - objectStore.getAccessKey(), objectStore.getSecretKey() - ); - } - } - - private boolean isSsl(ObjectStore objectStore) { - return objectStore.getEndpoint().startsWith("https://"); + /** + * Stores the target file on the S3 and sets cache control headers according to the default maximum age value. + * + * @param localFile The file to be published. + */ + public void putObject(LocalFile localFile) throws IOException, GeneralSecurityException, MinioException { + putObject(localFile, DEFAULT_MAX_CACHE_AGE); } /** - * Stores the target file on the S3. + * Stores the target file on the S3 and sets cache control headers according to the specified maximum age value. * - * @param localFile the file to be published + * @param localFile The file to be published. + * @param maxAge A cache control parameter that specifies the maximum amount of time in seconds that a resource can + * be considered "fresh" when held in a cache. */ - public void putObject(LocalFile localFile) - throws IOException, GeneralSecurityException, MinioException { + public void putObject(LocalFile localFile, int maxAge) throws IOException, GeneralSecurityException, MinioException { String s3Key = localFile.getS3Key(); - PutObjectOptions options = createOptionsFor(localFile); + PutObjectOptions options = createOptionsFor(localFile, maxAge); logger.info("... uploading {}", s3Key); this.client.putObject(bucket, s3Key, localFile.getFile().toString(), options); @@ -167,12 +156,14 @@ public List<S3Object> getObjectsWithPrefix(String prefix) return list; } - private PutObjectOptions createOptionsFor(LocalFile file) { + private PutObjectOptions createOptionsFor(LocalFile file, int maxAge) { var options = new PutObjectOptions(file.getFile().toFile().length(), -1); + Map<String, String> headers = new HashMap<>(Map.of("cache-control", "public,max-age=" + maxAge)); if (this.isSetPublicReadAclOnPutObject) { - options.setHeaders(Map.of("x-amz-acl", "public-read")); + headers.put("x-amz-acl", "public-read"); } + options.setHeaders(headers); return options; } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreClientConfig.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreClientConfig.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreClientConfig.java @@ -0,0 +1,66 @@ +/* + * Corona-Warn-App + * + * SAP SE and all other contributors / + * copyright owners license this file to you 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 + * + * http://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. + */ + +package app.coronawarn.server.services.distribution.objectstore; + +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig.ObjectStore; +import io.minio.MinioClient; +import io.minio.errors.InvalidEndpointException; +import io.minio.errors.InvalidPortException; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +/** + * Manages the instantiation of the {@link MinioClient} bean. + */ +@Configuration +public class ObjectStoreClientConfig { + + private static final String DEFAULT_REGION = "eu-west-1"; + + @Bean + public MinioClient createMinioClient(DistributionServiceConfig distributionServiceConfig) + throws InvalidPortException, InvalidEndpointException { + return createClient(distributionServiceConfig.getObjectStore()); + } + + private MinioClient createClient(ObjectStore objectStore) + throws InvalidPortException, InvalidEndpointException { + if (isSsl(objectStore)) { + return new MinioClient( + objectStore.getEndpoint(), + objectStore.getPort(), + objectStore.getAccessKey(), objectStore.getSecretKey(), + DEFAULT_REGION, + true + ); + } else { + return new MinioClient( + objectStore.getEndpoint(), + objectStore.getPort(), + objectStore.getAccessKey(), objectStore.getSecretKey() + ); + } + } + + private boolean isSsl(ObjectStore objectStore) { + return objectStore.getEndpoint().startsWith("https://"); + } +}

diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccessUnitTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccessUnitTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccessUnitTest.java @@ -0,0 +1,113 @@ +/* + * Corona-Warn-App + * + * SAP SE and all other contributors / + * copyright owners license this file to you 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 + * + * http://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. + */ + +package app.coronawarn.server.services.distribution.objectstore; + +import static java.util.Map.entry; +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.Mockito.any; +import static org.mockito.Mockito.atLeastOnce; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import app.coronawarn.server.services.distribution.objectstore.publish.LocalFile; +import io.minio.MinioClient; +import io.minio.PutObjectOptions; +import java.io.File; +import java.nio.file.Path; +import org.assertj.core.api.Assertions; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.mockito.ArgumentCaptor; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.boot.test.context.ConfigFileApplicationContextInitializer; +import org.springframework.boot.test.mock.mockito.MockBean; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit.jupiter.SpringExtension; + +@EnableConfigurationProperties(value = DistributionServiceConfig.class) +@ExtendWith(SpringExtension.class) +@ContextConfiguration(classes = {MinioClient.class}, initializers = ConfigFileApplicationContextInitializer.class) +class ObjectStoreAccessUnitTest { + + private static final String EXP_S3_KEY = "fooS3Key"; + private static final String EXP_FILE_CONTENT = "barFileContent"; + + private final DistributionServiceConfig distributionServiceConfig; + private final String expBucketName; + private LocalFile testLocalFile; + private ObjectStoreAccess objectStoreAccess; + + @MockBean + private MinioClient minioClient; + + @Autowired + public ObjectStoreAccessUnitTest(DistributionServiceConfig distributionServiceConfig) { + this.distributionServiceConfig = distributionServiceConfig; + this.expBucketName = distributionServiceConfig.getObjectStore().getBucket(); + } + + @BeforeEach + public void setUpMocks() throws Exception { + when(minioClient.bucketExists(any())).thenReturn(true); + this.objectStoreAccess = new ObjectStoreAccess(distributionServiceConfig, minioClient); + this.testLocalFile = setUpLocalFileMock(); + } + + private LocalFile setUpLocalFileMock() { + var testLocalFile = mock(LocalFile.class); + var testPath = mock(Path.class); + + when(testLocalFile.getS3Key()).thenReturn(EXP_S3_KEY); + when(testLocalFile.getFile()).thenReturn(testPath); + when(testPath.toFile()).thenReturn(mock(File.class)); + when(testPath.toString()).thenReturn(EXP_FILE_CONTENT); + + return testLocalFile; + } + + @Test + void testPutObjectSetsDefaultCacheControlHeader() throws Exception { + ArgumentCaptor<PutObjectOptions> options = ArgumentCaptor.forClass(PutObjectOptions.class); + var expHeader = entry("cache-control", "public,max-age=" + ObjectStoreAccess.DEFAULT_MAX_CACHE_AGE); + + objectStoreAccess.putObject(testLocalFile); + + verify(minioClient, atLeastOnce()) + .putObject(eq(expBucketName), eq(EXP_S3_KEY), eq(EXP_FILE_CONTENT), options.capture()); + Assertions.assertThat(options.getValue().headers()).contains(expHeader); + } + + @Test + void testPutObjectSetsSpecifiedCacheControlHeader() throws Exception { + ArgumentCaptor<PutObjectOptions> options = ArgumentCaptor.forClass(PutObjectOptions.class); + var expMaxAge = 1337; + var expHeader = entry("cache-control", "public,max-age=" + expMaxAge); + + objectStoreAccess.putObject(testLocalFile, expMaxAge); + + verify(minioClient, atLeastOnce()) + .putObject(eq(expBucketName), eq(EXP_S3_KEY), eq(EXP_FILE_CONTENT), options.capture()); + Assertions.assertThat(options.getValue().headers()).contains(expHeader); + } +}

S3Publisher should set Cache Control Headers The S3Publisher is currently not setting Cache Control Headers. We should cache-control: public, maxage=N N depends on the type of file: - for hours index files, it should be rather low (5 minutes) - for days index files, it should be higher (2 hours) - for all generated aggregate files, it should be 24 hours E-Tag should already been set, but should also be verified.

For the sake of simplicity, I think we can get away with just setting everything to 5 minutes. In the worst case, we need to expect requests for all available files by all 4 CDN master cache servers every 5 minutes. We serve a peak total of 356‬ files (1 version index, 1 version OpenAPI JSON, 2 country indices for diagnosis keys and parameters, 1 date index, 14 date aggregates, 14 hour indices, 14*24 hour aggregates, 1 parameter configuration). If we set everything to 5 minutes, this would lead to an average of: * 1424‬ requests per 5 minutes * ~285 requests per minute * ~5 requests per second I think the object storage should easily be able to handle that, even if for some reason the CDN edge cache servers decided to request stuff themselves. 5 Minutes is OK for now - let's keep it simple in the first iteration.

corona-warn-app/cwa-server

corona-warn-app__cwa-server-350

8d8a0a5e16bc252364812017a85418b054d739f7

diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidator.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidator.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidator.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidator.java @@ -87,12 +87,10 @@ private void validateRiskScoreValueBounds(int value) { } private void validateUrl(String url) { - if (!url.isBlank()) { - try { - new URL(url); - } catch (MalformedURLException e) { - errors.add(new RiskScoreClassificationValidationError("url", url, INVALID_URL)); - } + try { + new URL(url.trim()); + } catch (MalformedURLException e) { + errors.add(new RiskScoreClassificationValidationError("url", url, INVALID_URL)); } }

diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidatorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidatorTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidatorTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidatorTest.java @@ -39,19 +39,19 @@ class RiskScoreClassificationValidatorTest { private final static int MAX_SCORE = ParameterSpec.RISK_SCORE_MAX; private final static String VALID_LABEL = "myLabel"; - private final static String VALID_URL = ""; + private final static String VALID_URL = "https://www.my.url"; @ParameterizedTest @ValueSource(strings = {"", " "}) void failsForBlankLabels(String invalidLabel) { - var validator = buildValidator(buildRiskClass(invalidLabel, 0, MAX_SCORE, "")); + var validator = buildValidator(buildRiskClass(invalidLabel, 0, MAX_SCORE, VALID_URL)); var expectedResult = buildExpectedResult(buildError("label", invalidLabel, ErrorType.BLANK_LABEL)); assertThat(validator.validate()).isEqualTo(expectedResult); } @ParameterizedTest - @ValueSource(strings = {"invalid.Url", "invalid-url", "$$$://invalid.url"}) + @ValueSource(strings = {"invalid.Url", "invalid-url", "$$$://invalid.url", "", " "}) void failsForInvalidUrl(String invalidUrl) { var validator = buildValidator(buildRiskClass(VALID_LABEL, 0, MAX_SCORE, invalidUrl)); var expectedResult = buildExpectedResult(buildError("url", invalidUrl, ErrorType.INVALID_URL)); @@ -133,10 +133,8 @@ void doesNotFailForValidClassification(RiskScoreClassification validClassificati private static Stream<Arguments> createValidClassifications() { return Stream.of( - // blank url - buildClassification(buildRiskClass(VALID_LABEL, 0, MAX_SCORE, "")), - // legit url - buildClassification(buildRiskClass(VALID_LABEL, 0, MAX_SCORE, "http://www.sap.com")), + // valid url + buildClassification(buildRiskClass(VALID_LABEL, 0, MAX_SCORE, VALID_URL)), // [0:MAX_SCORE/2][MAX_SCORE/2:MAX_SCORE] buildClassification( buildRiskClass(VALID_LABEL, 0, MAX_SCORE / 2, VALID_URL),

Blank URL in RiskScoreClassificationValidator In `app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidator#validateUrl` [(link to source code)](https://github.com/corona-warn-app/cwa-server/blob/63dda0c2a5e1ff09fe998dd05637d76dea2e3833/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidator.java#L89) an empty URL does not lead to an error. This is not in line with e.g. validation of a label. In case the label is blank, an error is added. Maybe you can check that this is implemented as intended.

Confirmed URL should **not** be empty - It should be a valid URL with http/https as allowed protocol

corona-warn-app/cwa-server

corona-warn-app__cwa-server-352

207bdd8d4d701ab8df608db7caa9f2613fa86b84

diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectory.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectory.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectory.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectory.java @@ -24,7 +24,6 @@ import app.coronawarn.server.services.distribution.assembly.structure.util.functional.Formatter; import app.coronawarn.server.services.distribution.assembly.structure.util.functional.WritableFunction; import java.util.Set; -import java.util.Stack; /** * A "meta {@link Directory directory}" that maps its on-disk subdirectories to some list of elements. This list of @@ -38,7 +37,7 @@ public interface IndexDirectory<T, W extends Writable<W>> extends Directory<W> { /** * Adds a writable under the name {@code name}, whose content is calculated by the {@code writableFunction} to each * one of the directories created from the index. The {@code fileFunction} calculates the file content from a {@link - * java.util.Stack} of parent {@link IndexDirectoryOnDisk} indices. File content calculation happens on {@link + * ImmutableStack} of parent {@link IndexDirectoryOnDisk} indices. File content calculation happens on {@link * DirectoryOnDisk#write}. * * @param writableFunction A function that can output a new writable. diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectoryOnDisk.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectoryOnDisk.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectoryOnDisk.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectoryOnDisk.java @@ -27,7 +27,6 @@ import app.coronawarn.server.services.distribution.assembly.structure.util.functional.WritableFunction; import java.util.HashSet; import java.util.Set; -import java.util.Stack; /** * An {@link IndexDirectory} that can be written to disk. @@ -47,7 +46,7 @@ public class IndexDirectoryOnDisk<T> extends DirectoryOnDisk implements IndexDir * * @param name The name that this directory should have on disk. * @param indexFunction An {@link IndexFunction} that calculates the index of this {@link IndexDirectoryOnDisk} from - * a {@link java.util.Stack} of parent {@link IndexDirectoryOnDisk} indices. The top element of + * a {@link ImmutableStack} of parent {@link IndexDirectoryOnDisk} indices. The top element of * the stack is from the closest {@link IndexDirectoryOnDisk} in the parent chain. * @param indexFormatter A {@link Formatter} used to format the directory name for each index element returned by the * {@link IndexDirectoryOnDisk#indexFunction}. @@ -78,9 +77,9 @@ public void addWritableToAll(WritableFunction<WritableOnDisk> writableFunction) * {@link IndexDirectory#addWritableToAll writables} to those. The respective element of the index will be pushed * onto the Stack for subsequent {@link Writable#prepare} calls. * - * @param indices A {@link Stack} of parameters from all {@link IndexDirectory IndexDirectories} further up in the - * hierarchy. The Stack may contain different types, depending on the types {@code T} of - * {@link IndexDirectory IndexDirectories} further up in the hierarchy. + * @param indices A {@link ImmutableStack} of parameters from all {@link IndexDirectory IndexDirectories} further up + * in the hierarchy. The Stack may contain different types, depending on the types {@code T} of {@link + * IndexDirectory IndexDirectories} further up in the hierarchy. */ @Override public void prepare(ImmutableStack<Object> indices) { diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/util/ImmutableStack.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/util/ImmutableStack.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/util/ImmutableStack.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/util/ImmutableStack.java @@ -19,21 +19,22 @@ package app.coronawarn.server.services.distribution.assembly.structure.util; -import java.util.Stack; +import java.util.ArrayDeque; +import java.util.Deque; public class ImmutableStack<T> { - private final Stack<T> stack; + private final Deque<T> stack; public ImmutableStack() { - this.stack = new Stack<>(); + this.stack = new ArrayDeque<>(); } /** * Creates a clone of the specified {@link ImmutableStack}. */ public ImmutableStack(ImmutableStack<T> other) { - this.stack = (Stack<T>) other.stack.clone(); + this.stack = new ArrayDeque<>(other.stack); } /**

diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/util/ImmutableStackTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/util/ImmutableStackTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/util/ImmutableStackTest.java @@ -0,0 +1,69 @@ +/* + * Corona-Warn-App + * + * SAP SE and all other contributors / + * copyright owners license this file to you 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 + * + * http://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. + */ + +package app.coronawarn.server.services.distribution.assembly.structure.util; + +import org.assertj.core.api.Assertions; +import org.junit.jupiter.api.Test; + +import java.util.ArrayDeque; +import java.util.NoSuchElementException; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatExceptionOfType; + +class ImmutableStackTest { + + private final ImmutableStack<String> stack = + new ImmutableStack<String>().push("Joker").push("Queen").push("King"); + + @Test + void checkPushes() { + var newStack = stack.push("Ace"); + + assertThat(newStack).isNotSameAs(stack); + assertThat(newStack.peek()).isEqualTo("Ace"); + assertThat(stack.peek()).isEqualTo("King"); + } + + @Test + void checkPops() { + var newStack = stack.pop(); + + assertThat(newStack).isNotSameAs(stack); + assertThat(newStack.peek()).isEqualTo("Queen"); + assertThat(stack.peek()).isEqualTo("King"); + } + + @Test + void checkPeeks() { + assertThat(stack.peek()).isEqualTo("King"); + } + + @Test + void checksEmptyStackHasNoting() { + assertThat(new ImmutableStack<>().peek()).isNull(); + } + + @Test + void throwsExceptionWhenPopsFromEmptyStack() { + assertThatExceptionOfType(NoSuchElementException.class) + .isThrownBy(() -> new ImmutableStack<>().pop()); + } +}

Sonar - Mitigate/Audit synchronized class "Stack" See https://sonarcloud.io/project/issues?id=corona-warn-app_cwa-server&issues=AXI3CJu7vPFV4POpyUFA&open=AXI3CJu7vPFV4POpyUFA Strongly consider using existing [data structure implementations.](https://www.eclipse.org/collections/javadoc/9.2.0/org/eclipse/collections/api/stack/ImmutableStack.html)

corona-warn-app/cwa-server

corona-warn-app__cwa-server-378

79eef3fa06e3e6bd1bfa9a97c0959d62551295b8

diff --git a/services/distribution/pom.xml b/services/distribution/pom.xml --- a/services/distribution/pom.xml +++ b/services/distribution/pom.xml @@ -54,9 +54,9 @@ <artifactId>distribution</artifactId> <dependencies> <dependency> - <groupId>io.minio</groupId> - <artifactId>minio</artifactId> - <version>7.0.2</version> + <groupId>software.amazon.awssdk</groupId> + <artifactId>s3</artifactId> + <version>2.13.25</version> </dependency> <dependency> <artifactId>bcpkix-jdk15on</artifactId> diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/MinioClientWrapper.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/MinioClientWrapper.java deleted file mode 100644 --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/MinioClientWrapper.java +++ /dev/null @@ -1,106 +0,0 @@ -/*- - * ---license-start - * Corona-Warn-App - * --- - * Copyright (C) 2020 SAP SE and all other contributors - * --- - * 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 - * - * http://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. - * ---license-end - */ - -package app.coronawarn.server.services.distribution.objectstore.client; - -import io.minio.MinioClient; -import io.minio.PutObjectOptions; -import io.minio.Result; -import io.minio.errors.ErrorResponseException; -import io.minio.errors.InsufficientDataException; -import io.minio.errors.InternalException; -import io.minio.errors.InvalidBucketNameException; -import io.minio.errors.InvalidResponseException; -import io.minio.errors.XmlParserException; -import io.minio.messages.Item; -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; -import java.security.InvalidKeyException; -import java.security.NoSuchAlgorithmException; -import java.util.ArrayList; -import java.util.List; -import java.util.Map; -import java.util.Map.Entry; -import java.util.stream.Collectors; - -/** - * Implementation of {@link ObjectStoreClient} that encapsulates a {@link MinioClient}. - */ -public class MinioClientWrapper implements ObjectStoreClient { - - private final MinioClient minioClient; - - public MinioClientWrapper(MinioClient minioClient) { - this.minioClient = minioClient; - } - - @Override - public List<S3Object> getObjects(String bucket, String prefix) { - Iterable<Result<Item>> objects = this.minioClient.listObjects(bucket, prefix, true); - - var list = new ArrayList<S3Object>(); - for (Result<Item> item : objects) { - try { - list.add(S3Object.of(item.get())); - } catch (ErrorResponseException | NoSuchAlgorithmException | InternalException | IOException | InvalidKeyException - | InvalidResponseException | InvalidBucketNameException | InsufficientDataException | XmlParserException - | IllegalArgumentException e) { - throw new ObjectStoreOperationFailedException("Failed to download objects from object store.", e); - } - } - return list; - } - - @Override - public void putObject(String bucket, String objectName, Path filePath, Map<HeaderKey, String> headers) { - try { - var options = new PutObjectOptions(Files.size(filePath), -1); - Map<String, String> minioHeaders = headers.entrySet().stream() - .map(entry -> Map.entry(entry.getKey().keyValue, entry.getValue())) - .collect(Collectors.toMap(Entry::getKey, Entry::getValue)); - - options.setHeaders(minioHeaders); - minioClient.putObject(bucket, objectName, filePath.toString(), options); - } catch (ErrorResponseException | NoSuchAlgorithmException | InternalException | IOException | InvalidKeyException - | InvalidResponseException | InvalidBucketNameException | InsufficientDataException | XmlParserException - | IllegalArgumentException e) { - throw new ObjectStoreOperationFailedException("Failed to upload object to object store.", e); - } - } - - @Override - public void removeObjects(String bucket, List<String> objectNames) { - if (!objectNames.isEmpty() && minioClient.removeObjects(bucket, objectNames).iterator().hasNext()) { - throw new ObjectStoreOperationFailedException("Failed to remove objects from object store"); - } - } - - @Override - public boolean bucketExists(String bucket) { - try { - return minioClient.bucketExists(bucket); - } catch (ErrorResponseException | NoSuchAlgorithmException | InternalException | IOException | InvalidKeyException - | InvalidResponseException | InvalidBucketNameException | InsufficientDataException | XmlParserException - | IllegalArgumentException e) { - throw new ObjectStoreOperationFailedException("Failed to check if object store bucket exists.", e); - } - } -} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/ObjectStoreClientConfig.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/ObjectStoreClientConfig.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/ObjectStoreClientConfig.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/ObjectStoreClientConfig.java @@ -22,14 +22,16 @@ import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; import app.coronawarn.server.services.distribution.config.DistributionServiceConfig.ObjectStore; -import io.minio.MinioClient; -import io.minio.errors.InvalidEndpointException; -import io.minio.errors.InvalidPortException; +import java.net.URI; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; +import software.amazon.awssdk.auth.credentials.AwsCredentials; +import software.amazon.awssdk.auth.credentials.AwsCredentialsProvider; +import software.amazon.awssdk.regions.Region; +import software.amazon.awssdk.services.s3.S3Client; /** - * Manages the instantiation of the {@link MinioClient} bean. + * Manages the instantiation of the {@link ObjectStoreClient} bean. */ @Configuration public class ObjectStoreClientConfig { @@ -37,29 +39,44 @@ public class ObjectStoreClientConfig { private static final String DEFAULT_REGION = "eu-west-1"; @Bean - public ObjectStoreClient createObjectStoreClient(DistributionServiceConfig distributionServiceConfig) - throws InvalidPortException, InvalidEndpointException { + public ObjectStoreClient createObjectStoreClient(DistributionServiceConfig distributionServiceConfig) { return createClient(distributionServiceConfig.getObjectStore()); } - private MinioClientWrapper createClient(ObjectStore objectStore) - throws InvalidPortException, InvalidEndpointException { - if (isSsl(objectStore)) { - return new MinioClientWrapper(new MinioClient( - objectStore.getEndpoint(), - objectStore.getPort(), - objectStore.getAccessKey(), objectStore.getSecretKey(), - DEFAULT_REGION, - true)); - } else { - return new MinioClientWrapper(new MinioClient( - objectStore.getEndpoint(), - objectStore.getPort(), - objectStore.getAccessKey(), objectStore.getSecretKey())); - } + private ObjectStoreClient createClient(ObjectStore objectStore) { + return new S3ClientWrapper(S3Client.builder() + .region(Region.of(DEFAULT_REGION)) + .endpointOverride(URI.create(objectStore.getEndpoint() + ":" + objectStore.getPort())) + .credentialsProvider(new CredentialsProvider(objectStore.getAccessKey(), objectStore.getSecretKey())) + .build()); } - private boolean isSsl(ObjectStore objectStore) { - return objectStore.getEndpoint().startsWith("https://"); + /** + * Statically serves credentials based on construction arguments. + */ + static class CredentialsProvider implements AwsCredentialsProvider { + + final String accessKeyId; + final String secretAccessKey; + + public CredentialsProvider(String accessKeyId, String secretAccessKey) { + this.accessKeyId = accessKeyId; + this.secretAccessKey = secretAccessKey; + } + + @Override + public AwsCredentials resolveCredentials() { + return new AwsCredentials() { + @Override + public String accessKeyId() { + return accessKeyId; + } + + @Override + public String secretAccessKey() { + return secretAccessKey; + } + }; + } } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapper.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapper.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapper.java @@ -0,0 +1,123 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.objectstore.client; + +import static java.util.stream.Collectors.toList; + +import java.nio.file.Path; +import java.util.Collection; +import java.util.List; +import java.util.Map; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import software.amazon.awssdk.core.exception.SdkException; +import software.amazon.awssdk.core.sync.RequestBody; +import software.amazon.awssdk.services.s3.S3Client; +import software.amazon.awssdk.services.s3.model.Delete; +import software.amazon.awssdk.services.s3.model.DeleteObjectsRequest; +import software.amazon.awssdk.services.s3.model.DeleteObjectsResponse; +import software.amazon.awssdk.services.s3.model.ListObjectsV2Request; +import software.amazon.awssdk.services.s3.model.ListObjectsV2Response; +import software.amazon.awssdk.services.s3.model.ObjectIdentifier; +import software.amazon.awssdk.services.s3.model.PutObjectRequest; + +/** + * Implementation of {@link ObjectStoreClient} that encapsulates an {@link S3Client}. + */ +public class S3ClientWrapper implements ObjectStoreClient { + + private static final Logger logger = LoggerFactory.getLogger(S3ClientWrapper.class); + + private final S3Client s3Client; + + public S3ClientWrapper(S3Client s3Client) { + this.s3Client = s3Client; + } + + @Override + public boolean bucketExists(String bucketName) { + try { + return !s3Client.listBuckets().buckets().stream().findFirst().isEmpty(); + } catch (SdkException e) { + throw new ObjectStoreOperationFailedException("Failed to determine if bucket exists.", e); + } + } + + @Override + public List<S3Object> getObjects(String bucket, String prefix) { + try { + ListObjectsV2Response response = + s3Client.listObjectsV2(ListObjectsV2Request.builder().prefix(prefix).bucket(bucket).build()); + return response.contents().stream().map(S3ClientWrapper::buildS3Object).collect(toList()); + } catch (SdkException e) { + throw new ObjectStoreOperationFailedException("Failed to upload object to object store", e); + } + } + + @Override + public void putObject(String bucket, String objectName, Path filePath, Map<HeaderKey, String> headers) { + RequestBody bodyFile = RequestBody.fromFile(filePath); + + var requestBuilder = PutObjectRequest.builder().bucket(bucket).key(objectName); + if (headers.containsKey(HeaderKey.AMZ_ACL)) { + requestBuilder.acl(headers.get(HeaderKey.AMZ_ACL)); + } + if (headers.containsKey(HeaderKey.CACHE_CONTROL)) { + requestBuilder.cacheControl(headers.get(HeaderKey.CACHE_CONTROL)); + } + + try { + s3Client.putObject(requestBuilder.build(), bodyFile); + } catch (SdkException e) { + throw new ObjectStoreOperationFailedException("Failed to upload object to object store", e); + } + } + + @Override + public void removeObjects(String bucket, List<String> objectNames) { + if (objectNames.isEmpty()) { + return; + } + + Collection<ObjectIdentifier> identifiers = objectNames.stream() + .map(key -> ObjectIdentifier.builder().key(key).build()).collect(toList()); + + try { + DeleteObjectsResponse response = s3Client.deleteObjects( + DeleteObjectsRequest.builder() + .bucket(bucket) + .delete(Delete.builder().objects(identifiers).build()).build()); + + if (response.hasErrors()) { + String errMessage = "Failed to remove objects from object store."; + logger.error("{} {}", errMessage, response.errors()); + throw new ObjectStoreOperationFailedException(errMessage); + } + } catch (SdkException e) { + throw new ObjectStoreOperationFailedException("Failed to remove objects from object store.", e); + } + } + + private static S3Object buildS3Object(software.amazon.awssdk.services.s3.model.S3Object s3Object) { + String etag = s3Object.eTag().replaceAll("\"", ""); + return new S3Object(s3Object.key(), etag); + } +} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/S3Object.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/S3Object.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/S3Object.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/S3Object.java @@ -20,7 +20,6 @@ package app.coronawarn.server.services.distribution.objectstore.client; -import io.minio.messages.Item; import java.util.Objects; /** @@ -64,17 +63,6 @@ public String getEtag() { return etag; } - /** - * Returns a new instance of an S3Object based on the given item. - * - * @param item the item (as provided by MinIO) - * @return the S3Object representation - */ - public static S3Object of(Item item) { - String etag = item.etag().replaceAll("\"", ""); - return new S3Object(item.objectName(), etag); - } - @Override public boolean equals(Object o) { if (this == o) { diff --git a/services/distribution/src/main/java/io/minio/messages/Item.java b/services/distribution/src/main/java/io/minio/messages/Item.java deleted file mode 100644 --- a/services/distribution/src/main/java/io/minio/messages/Item.java +++ /dev/null @@ -1,131 +0,0 @@ -/* - * MinIO Java SDK for Amazon S3 Compatible Cloud Storage, (C) 2015 MinIO, Inc. - * - * 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 - * - * http://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. - */ - -package io.minio.messages; - -import java.time.ZonedDateTime; -import java.util.Map; -import org.simpleframework.xml.Element; -import org.simpleframework.xml.Root; - -/* ---------------------------------------------------------------- - * Copied from MinIO due to patch not yet available. - * https://github.com/minio/minio-java/pull/921 - * Waiting for new release version: 7.0.3 - * ---------------------------------------------------------------- - */ - -/** - * Helper class to denote Object information in {@link ListBucketResult} and {@link ListBucketResultV1}. - */ -@Root(name = "Contents", strict = false) -public class Item { - - @Element(name = "Key") - private String objectName; - - @Element(name = "LastModified") - private ResponseDate lastModified; - - @Element(name = "ETag") - private String etag; - - @Element(name = "Size") - private long size; - - @Element(name = "StorageClass") - private String storageClass; - - @Element(name = "Owner", required = false) /* Monkeypatch: Owner should be optional */ - private Owner owner; - - @Element(name = "UserMetadata", required = false) - private Metadata userMetadata; - - private boolean isDir = false; - - public Item() { - - } - - /** - * Constructs a new Item for prefix i.e. directory. - */ - public Item(String prefix) { - this.objectName = prefix; - this.isDir = true; - } - - /** - * Returns object name. - */ - public String objectName() { - return objectName; - } - - /** - * Returns last modified time of the object. - */ - public ZonedDateTime lastModified() { - return lastModified.zonedDateTime(); - } - - /** - * Returns ETag of the object. - */ - public String etag() { - return etag; - } - - /** - * Returns object size. - */ - public long size() { - return size; - } - - /** - * Returns storage class of the object. - */ - public String storageClass() { - return storageClass; - } - - /** - * Returns owner object of given the object. - */ - public Owner owner() { - return owner; - } - - /** - * Returns user metadata. This is MinIO specific extension to ListObjectsV2. - */ - public Map<String, String> userMetadata() { - if (userMetadata == null) { - return null; - } - - return userMetadata.get(); - } - - /** - * Returns whether the object is a directory or not. - */ - public boolean isDir() { - return isDir; - } -}

diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/client/MinioClientWrapperTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/client/MinioClientWrapperTest.java deleted file mode 100644 --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/client/MinioClientWrapperTest.java +++ /dev/null @@ -1,235 +0,0 @@ -/*- - * ---license-start - * Corona-Warn-App - * --- - * Copyright (C) 2020 SAP SE and all other contributors - * --- - * 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 - * - * http://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. - * ---license-end - */ - -package app.coronawarn.server.services.distribution.objectstore.client; - -import static java.util.Collections.emptyMap; -import static java.util.Map.entry; -import static org.assertj.core.api.Assertions.assertThat; -import static org.assertj.core.api.Assertions.assertThatExceptionOfType; -import static org.assertj.core.util.IterableUtil.iterable; -import static org.assertj.core.util.Lists.list; -import static org.assertj.core.util.Maps.newHashMap; -import static org.mockito.ArgumentMatchers.any; -import static org.mockito.ArgumentMatchers.anyBoolean; -import static org.mockito.ArgumentMatchers.anyList; -import static org.mockito.ArgumentMatchers.anyString; -import static org.mockito.ArgumentMatchers.eq; -import static org.mockito.Mockito.atLeastOnce; -import static org.mockito.Mockito.doThrow; -import static org.mockito.Mockito.mock; -import static org.mockito.Mockito.verify; -import static org.mockito.Mockito.when; - -import app.coronawarn.server.services.distribution.objectstore.client.ObjectStoreClient.HeaderKey; -import com.fasterxml.jackson.core.JsonParseException; -import com.fasterxml.jackson.databind.JsonMappingException; -import io.minio.MinioClient; -import io.minio.PutObjectOptions; -import io.minio.Result; -import io.minio.errors.ErrorResponseException; -import io.minio.errors.InsufficientDataException; -import io.minio.errors.InternalException; -import io.minio.errors.InvalidBucketNameException; -import io.minio.errors.InvalidResponseException; -import io.minio.errors.XmlParserException; -import io.minio.messages.DeleteError; -import io.minio.messages.Item; -import java.io.IOException; -import java.nio.file.Path; -import java.security.InvalidKeyException; -import java.security.NoSuchAlgorithmException; -import java.util.ArrayList; -import java.util.List; -import java.util.stream.Stream; -import org.assertj.core.util.Lists; -import org.junit.jupiter.api.BeforeEach; -import org.junit.jupiter.api.Test; -import org.junit.jupiter.params.ParameterizedTest; -import org.junit.jupiter.params.provider.Arguments; -import org.junit.jupiter.params.provider.MethodSource; -import org.junit.jupiter.params.provider.ValueSource; -import org.mockito.ArgumentCaptor; - -class MinioClientWrapperTest { - - private static final String VALID_BUCKET_NAME = "myBucket"; - private static final String VALID_PREFIX = "prefix"; - private static final String VALID_NAME = "object key"; - - private MinioClient minioClient; - private MinioClientWrapper minioClientWrapper; - - @BeforeEach - public void setUpMocks() { - minioClient = mock(MinioClient.class); - minioClientWrapper = new MinioClientWrapper(minioClient); - } - - @Test - void testBucketExistsIfBucketExists() throws Exception { - when(minioClient.bucketExists(any())).thenReturn(true); - assertThat(minioClientWrapper.bucketExists(VALID_BUCKET_NAME)).isTrue(); - } - - @Test - void testBucketExistsIfBucketDoesNotExist() throws Exception { - when(minioClient.bucketExists(any())).thenReturn(false); - assertThat(minioClientWrapper.bucketExists(VALID_BUCKET_NAME)).isFalse(); - } - - @ParameterizedTest - @ValueSource(classes = {ErrorResponseException.class, InsufficientDataException.class, - InternalException.class, IllegalArgumentException.class, InvalidBucketNameException.class, - InvalidKeyException.class, InvalidResponseException.class, - IOException.class, NoSuchAlgorithmException.class, XmlParserException.class}) - void bucketExistsThrowsObjectStoreOperationFailedExceptionIfClientThrows(Class<Exception> cause) throws Exception { - when(minioClient.bucketExists(any())).thenThrow(cause); - assertThatExceptionOfType(ObjectStoreOperationFailedException.class) - .isThrownBy(() -> minioClientWrapper.bucketExists(VALID_BUCKET_NAME)); - } - - @Test - void testGetObjectsSendsCorrectRequest() { - when(minioClient.listObjects(anyString(), anyString(), anyBoolean())).thenReturn(iterable()); - minioClientWrapper.getObjects(VALID_BUCKET_NAME, VALID_PREFIX); - verify(minioClient, atLeastOnce()).listObjects(eq(VALID_BUCKET_NAME), eq(VALID_PREFIX), eq(true)); - } - - @ParameterizedTest - @MethodSource("createGetObjectsResults") - void testGetObjects(List<S3Object> expResult) throws Exception { - Iterable<Result<Item>> actResponse = buildListObjectsResponse(expResult); - when(minioClient.listObjects(anyString(), anyString(), anyBoolean())).thenReturn(actResponse); - - List<S3Object> actResult = minioClientWrapper.getObjects(VALID_BUCKET_NAME, VALID_PREFIX); - - assertThat(actResult).isEqualTo(expResult); - } - - private static Stream<Arguments> createGetObjectsResults() { - return Stream.of( - Lists.emptyList(), - list(new S3Object("objName", "eTag")), - list(new S3Object("objName1", "eTag1"), new S3Object("objName2", "eTag2")) - ).map(Arguments::of); - } - - private Iterable<Result<Item>> buildListObjectsResponse(List<S3Object> s3Objects) throws Exception { - List<Result<Item>> response = new ArrayList<>(s3Objects.size()); - - for (S3Object s3Object : s3Objects) { - Item item = mock(Item.class); - Result<Item> result = mock(Result.class); - when(result.get()).thenReturn(item); - when(item.etag()).thenReturn(s3Object.getEtag()); - when(item.objectName()).thenReturn(s3Object.getObjectName()); - response.add(result); - } - - return iterable(response.toArray(new Result[response.size()])); - } - - @Test - void getObjectsRemovesDoubleQuotesFromEtags() throws Exception { - String expEtag = "eTag"; - Iterable<Result<Item>> actResponse = buildListObjectsResponse( - List.of(new S3Object(VALID_NAME, "\"" + expEtag + "\""))); - when(minioClient.listObjects(anyString(), anyString(), anyBoolean())).thenReturn(actResponse); - - List<S3Object> actResult = minioClientWrapper.getObjects(VALID_BUCKET_NAME, VALID_PREFIX); - - assertThat(actResult).isEqualTo(List.of(new S3Object(VALID_NAME, expEtag))); - } - - @ParameterizedTest - @ValueSource(classes = {ErrorResponseException.class, InsufficientDataException.class, XmlParserException.class, - InternalException.class, InvalidBucketNameException.class, InvalidKeyException.class, JsonParseException.class, - InvalidResponseException.class, JsonMappingException.class, IOException.class, NoSuchAlgorithmException.class, - IllegalArgumentException.class}) - void getObjectsThrowsObjectStoreOperationFailedExceptionIfClientThrows(Class<Exception> cause) throws Exception { - Result<Item> actResult = mock(Result.class); - when(actResult.get()).thenThrow(cause); - when(minioClient.listObjects(anyString(), anyString(), anyBoolean())).thenReturn(iterable(actResult)); - assertThatExceptionOfType(ObjectStoreOperationFailedException.class) - .isThrownBy(() -> minioClientWrapper.getObjects(VALID_BUCKET_NAME, VALID_PREFIX)); - } - - @Test - void testPutObjectForNoHeaders() throws Exception { - minioClientWrapper.putObject(VALID_BUCKET_NAME, VALID_NAME, Path.of(""), emptyMap()); - ArgumentCaptor<PutObjectOptions> options = ArgumentCaptor.forClass(PutObjectOptions.class); - verify(minioClient, atLeastOnce()).putObject(eq(VALID_BUCKET_NAME), eq(VALID_NAME), eq(""), options.capture()); - assertThat(options.getValue().headers()).isEmpty(); - } - - @Test - void testPutObjectForCacheControlHeader() throws Exception { - String expCacheControl = "foo-cache-control"; - - minioClientWrapper.putObject(VALID_BUCKET_NAME, VALID_NAME, Path.of(""), - newHashMap(HeaderKey.CACHE_CONTROL, expCacheControl)); - - ArgumentCaptor<PutObjectOptions> options = ArgumentCaptor.forClass(PutObjectOptions.class); - verify(minioClient, atLeastOnce()).putObject(eq(VALID_BUCKET_NAME), eq(VALID_NAME), eq(""), options.capture()); - assertThat(options.getValue().headers()).hasSize(1); - assertThat(options.getValue().headers()).contains(entry(HeaderKey.CACHE_CONTROL.keyValue, expCacheControl)); - } - - @Test - void testPutObjectForAmzAclHeader() throws Exception { - String expAcl = "foo-acl"; - - minioClientWrapper.putObject(VALID_BUCKET_NAME, VALID_NAME, Path.of(""), newHashMap(HeaderKey.AMZ_ACL, expAcl)); - - ArgumentCaptor<PutObjectOptions> options = ArgumentCaptor.forClass(PutObjectOptions.class); - verify(minioClient, atLeastOnce()).putObject(eq(VALID_BUCKET_NAME), eq(VALID_NAME), eq(""), options.capture()); - assertThat(options.getValue().headers()).hasSize(1); - assertThat(options.getValue().headers()).contains(entry(HeaderKey.AMZ_ACL.keyValue, expAcl)); - } - - @ParameterizedTest - @ValueSource(classes = {ErrorResponseException.class, IllegalArgumentException.class, InsufficientDataException.class, - InternalException.class, InvalidBucketNameException.class, InvalidKeyException.class, XmlParserException.class, - IOException.class, NoSuchAlgorithmException.class, InvalidResponseException.class}) - void putObjectsThrowsObjectStoreOperationFailedExceptionIfClientThrows(Class<Exception> cause) throws Exception { - doThrow(cause).when(minioClient).putObject(anyString(), anyString(), anyString(), any(PutObjectOptions.class)); - assertThatExceptionOfType(ObjectStoreOperationFailedException.class) - .isThrownBy(() -> minioClientWrapper.putObject(VALID_BUCKET_NAME, VALID_PREFIX, Path.of(""), emptyMap())); - } - - @Test - void testRemoveObjects() { - when(minioClient.removeObjects(anyString(), anyList())).thenReturn(iterable()); - List<String> expObjectNames = List.of("obj1", "obj2"); - - minioClientWrapper.removeObjects(VALID_BUCKET_NAME, expObjectNames); - - verify(minioClient, atLeastOnce()).removeObjects(eq(VALID_BUCKET_NAME), eq(expObjectNames)); - } - - @Test - void removeObjectsThrowsObjectStoreOperationFailedExceptionOnDeleteErrors() { - Result<DeleteError> result = mock(Result.class); - when(minioClient.removeObjects(anyString(), anyList())).thenReturn(iterable(result)); - assertThatExceptionOfType(ObjectStoreOperationFailedException.class) - .isThrownBy(() -> minioClientWrapper.removeObjects(VALID_BUCKET_NAME, list(VALID_NAME))); - } -} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapperTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapperTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapperTest.java @@ -0,0 +1,238 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.objectstore.client; + +import static java.util.Collections.emptyMap; +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatExceptionOfType; +import static org.assertj.core.util.Maps.newHashMap; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.Mockito.atLeastOnce; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +import app.coronawarn.server.services.distribution.objectstore.client.ObjectStoreClient.HeaderKey; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.List; +import java.util.stream.Collectors; +import java.util.stream.Stream; +import org.assertj.core.util.Lists; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.Arguments; +import org.junit.jupiter.params.provider.MethodSource; +import org.junit.jupiter.params.provider.ValueSource; +import org.springframework.test.context.junit.jupiter.SpringExtension; +import software.amazon.awssdk.core.exception.SdkClientException; +import software.amazon.awssdk.core.exception.SdkException; +import software.amazon.awssdk.core.sync.RequestBody; +import software.amazon.awssdk.services.s3.S3Client; +import software.amazon.awssdk.services.s3.model.Bucket; +import software.amazon.awssdk.services.s3.model.Delete; +import software.amazon.awssdk.services.s3.model.DeleteObjectsRequest; +import software.amazon.awssdk.services.s3.model.DeleteObjectsResponse; +import software.amazon.awssdk.services.s3.model.ListBucketsResponse; +import software.amazon.awssdk.services.s3.model.ListObjectsV2Request; +import software.amazon.awssdk.services.s3.model.ListObjectsV2Response; +import software.amazon.awssdk.services.s3.model.NoSuchBucketException; +import software.amazon.awssdk.services.s3.model.ObjectIdentifier; +import software.amazon.awssdk.services.s3.model.PutObjectRequest; +import software.amazon.awssdk.services.s3.model.S3Error; +import software.amazon.awssdk.services.s3.model.S3Exception; +import software.amazon.awssdk.utils.builder.SdkBuilder; + +@ExtendWith(SpringExtension.class) +class S3ClientWrapperTest { + + private static final String VALID_BUCKET_NAME = "myBucket"; + private static final String VALID_PREFIX = "prefix"; + private static final String VALID_NAME = "object key"; + + private S3Client s3Client; + private S3ClientWrapper s3ClientWrapper; + private List<Bucket> existingBuckets; + + @BeforeEach + public void setUpMocks() { + s3Client = mock(S3Client.class); + s3ClientWrapper = new S3ClientWrapper(s3Client); + existingBuckets = new ArrayList<>(); + ListBucketsResponse listBucketsResponse = mock(ListBucketsResponse.class); + + when(listBucketsResponse.buckets()).thenReturn(existingBuckets); + when(s3Client.listBuckets()).thenReturn(listBucketsResponse); + } + + @Test + void testBucketExistsIfBucketExists() { + existingBuckets.add(Bucket.builder().name(VALID_BUCKET_NAME).build()); + assertThat(s3ClientWrapper.bucketExists(VALID_BUCKET_NAME)).isTrue(); + } + + @Test + void testBucketExistsIfBucketDoesNotExist() { + assertThat(s3ClientWrapper.bucketExists(VALID_BUCKET_NAME)).isFalse(); + } + + @ParameterizedTest + @ValueSource(classes = {S3Exception.class, SdkClientException.class, SdkException.class}) + void bucketExistsThrowsObjectStoreOperationFailedExceptionIfClientThrows(Class<Exception> cause) { + when(s3Client.listBuckets()).thenThrow(cause); + assertThatExceptionOfType(ObjectStoreOperationFailedException.class) + .isThrownBy(() -> s3ClientWrapper.bucketExists(VALID_BUCKET_NAME)); + } + + @Test + void testGetObjectsSendsCorrectRequest() { + when(s3Client.listObjectsV2(any(ListObjectsV2Request.class))).thenReturn(ListObjectsV2Response.builder().build()); + + s3ClientWrapper.getObjects(VALID_BUCKET_NAME, VALID_PREFIX); + + ListObjectsV2Request expRequest = ListObjectsV2Request.builder() + .prefix(VALID_PREFIX).bucket(VALID_BUCKET_NAME).build(); + verify(s3Client, atLeastOnce()).listObjectsV2(eq(expRequest)); + } + + @ParameterizedTest + @MethodSource("createGetObjectsResults") + void testGetObjects(List<S3Object> expResult) { + ListObjectsV2Response actResponse = buildListObjectsResponse(expResult); + when(s3Client.listObjectsV2(any(ListObjectsV2Request.class))).thenReturn(actResponse); + + List<S3Object> actResult = s3ClientWrapper.getObjects(VALID_BUCKET_NAME, VALID_PREFIX); + + assertThat(actResult).isEqualTo(expResult); + } + + private static Stream<Arguments> createGetObjectsResults() { + return Stream.of( + Lists.emptyList(), + Lists.list(new S3Object("objName", "eTag")), + Lists.list(new S3Object("objName1", "eTag1"), new S3Object("objName2", "eTag2")) + ).map(Arguments::of); + } + + private ListObjectsV2Response buildListObjectsResponse(List<S3Object> s3Objects) { + var responseObjects = s3Objects.stream().map( + s3Object -> software.amazon.awssdk.services.s3.model.S3Object.builder() + .key(s3Object.getObjectName()) + .eTag(s3Object.getEtag())) + .map(SdkBuilder::build).collect(Collectors.toList()); + return ListObjectsV2Response.builder().contents(responseObjects).build(); + } + + @Test + void getObjectsRemovesDoubleQuotesFromEtags() { + String expEtag = "eTag"; + ListObjectsV2Response actResponse = + buildListObjectsResponse(List.of(new S3Object(VALID_NAME, "\"" + expEtag + "\""))); + when(s3Client.listObjectsV2(any(ListObjectsV2Request.class))).thenReturn(actResponse); + + List<S3Object> actResult = s3ClientWrapper.getObjects(VALID_BUCKET_NAME, VALID_PREFIX); + + assertThat(actResult).isEqualTo(List.of(new S3Object(VALID_NAME, expEtag))); + } + + @ParameterizedTest + @ValueSource(classes = {NoSuchBucketException.class, S3Exception.class, SdkClientException.class, SdkException.class}) + void getObjectsThrowsObjectStoreOperationFailedExceptionIfClientThrows(Class<Exception> cause) { + when(s3Client.listObjectsV2(any(ListObjectsV2Request.class))).thenThrow(cause); + assertThatExceptionOfType(ObjectStoreOperationFailedException.class) + .isThrownBy(() -> s3ClientWrapper.getObjects(VALID_BUCKET_NAME, VALID_PREFIX)); + } + + @Test + void testPutObjectForNoHeaders() { + s3ClientWrapper.putObject(VALID_BUCKET_NAME, VALID_NAME, Path.of(""), emptyMap()); + + PutObjectRequest expRequest = PutObjectRequest.builder().bucket(VALID_BUCKET_NAME).key(VALID_NAME).build(); + verify(s3Client, atLeastOnce()).putObject(eq(expRequest), any(RequestBody.class)); + } + + @Test + void testPutObjectForCacheControlHeader() { + var expCacheControl = "foo-cache-control"; + s3ClientWrapper + .putObject(VALID_BUCKET_NAME, VALID_NAME, Path.of(""), newHashMap(HeaderKey.CACHE_CONTROL, expCacheControl)); + + PutObjectRequest expRequest = + PutObjectRequest.builder().bucket(VALID_BUCKET_NAME).key(VALID_NAME).cacheControl(expCacheControl).build(); + verify(s3Client, atLeastOnce()).putObject(eq(expRequest), any(RequestBody.class)); + } + + @Test + void testPutObjectForAmzAclHeader() { + String expAcl = "foo-acl"; + s3ClientWrapper.putObject(VALID_BUCKET_NAME, VALID_NAME, Path.of(""), newHashMap(HeaderKey.AMZ_ACL, expAcl)); + + PutObjectRequest expRequest = + PutObjectRequest.builder().bucket(VALID_BUCKET_NAME).key(VALID_NAME).acl(expAcl).build(); + verify(s3Client, atLeastOnce()).putObject(eq(expRequest), any(RequestBody.class)); + } + + @ParameterizedTest + @ValueSource(classes = {NoSuchBucketException.class, S3Exception.class, SdkClientException.class, SdkException.class}) + void putObjectsThrowsObjectStoreOperationFailedExceptionIfClientThrows(Class<Exception> cause) { + when(s3Client.putObject(any(PutObjectRequest.class), any(RequestBody.class))).thenThrow(cause); + assertThatExceptionOfType(ObjectStoreOperationFailedException.class) + .isThrownBy(() -> s3ClientWrapper.putObject(VALID_BUCKET_NAME, VALID_PREFIX, Path.of(""), emptyMap())); + } + + @Test + void testRemoveObjects() { + when(s3Client.deleteObjects(any(DeleteObjectsRequest.class))).thenReturn(DeleteObjectsResponse.builder().build()); + List<String> expObjectNames = List.of("obj1", "obj2"); + + s3ClientWrapper.removeObjects(VALID_BUCKET_NAME, expObjectNames); + + DeleteObjectsRequest expRequest = DeleteObjectsRequest.builder() + .bucket(VALID_BUCKET_NAME).delete(buildDeleteObject(expObjectNames)).build(); + verify(s3Client, atLeastOnce()).deleteObjects(eq(expRequest)); + } + + private Delete buildDeleteObject(List<String> objectNames) { + return Delete.builder().objects(objectNames.stream().map( + key -> ObjectIdentifier.builder().key(key).build()).collect(Collectors.toList())).build(); + } + + @Test + void removeObjectsThrowsOnDeletionErrors() { + DeleteObjectsResponse actResponse = DeleteObjectsResponse.builder().errors(S3Error.builder().build()).build(); + + when(s3Client.deleteObjects(any(DeleteObjectsRequest.class))).thenReturn(actResponse); + + assertThatExceptionOfType(ObjectStoreOperationFailedException.class) + .isThrownBy(() -> s3ClientWrapper.removeObjects(VALID_BUCKET_NAME, List.of(VALID_NAME))); + } + + @ParameterizedTest + @ValueSource(classes = {NoSuchBucketException.class, S3Exception.class, SdkClientException.class, SdkException.class}) + void removeObjectsThrowsObjectStoreOperationFailedExceptionIfClientThrows(Class<Exception> cause) { + when(s3Client.deleteObjects(any(DeleteObjectsRequest.class))).thenThrow(cause); + assertThatExceptionOfType(ObjectStoreOperationFailedException.class) + .isThrownBy(() -> s3ClientWrapper.removeObjects(VALID_BUCKET_NAME, List.of(VALID_NAME))); + } +}

Remove MinIO SDK and use AWS SDK instead Since MinIO SDK still hasn't released a fix version for fixing the XML vulnerability in the SimpleXML library, we need to consider alternative S3 SDK's. Therefore, prepare an alternative approach with AWS SDK, which is then used by the ObjectStoreAccess class.

corona-warn-app/cwa-server

corona-warn-app__cwa-server-386

943a9cea975f6395f99217bb380e526e937f093e

diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectory.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectory.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectory.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectory.java @@ -88,9 +88,7 @@ public void prepare(ImmutableStack<Object> indices) { private Set<DiagnosisKey> getDiagnosisKeysForHour(LocalDateTime hour) { return this.diagnosisKeys.stream() - .filter(diagnosisKey -> DateTime - .getLocalDateTimeFromHoursSinceEpoch(diagnosisKey.getSubmissionTimestamp()) - .equals(hour)) + .filter(diagnosisKey -> DistributionDateTimeCalculator.getDistributionDateTime(diagnosisKey).equals(hour)) .collect(Collectors.toSet()); } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DistributionDateTimeCalculator.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DistributionDateTimeCalculator.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DistributionDateTimeCalculator.java @@ -0,0 +1,62 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory; + +import static app.coronawarn.server.services.distribution.assembly.diagnosiskeys.util.DateTime.ONE_HOUR_INTERVAL_SECONDS; +import static app.coronawarn.server.services.distribution.assembly.diagnosiskeys.util.DateTime.TEN_MINUTES_INTERVAL_SECONDS; +import static java.time.ZoneOffset.UTC; + +import app.coronawarn.server.common.persistence.domain.DiagnosisKey; +import java.time.Duration; +import java.time.LocalDateTime; +import java.time.temporal.ChronoUnit; + +public class DistributionDateTimeCalculator { + + /** + * Minimum time in minutes after key expiration after which it can be distributed. + */ + public static final long DISTRIBUTION_PADDING = 120L; + + private DistributionDateTimeCalculator() { + } + + /** + * Calculates the earliest point in time at which the specified {@link DiagnosisKey} can be distributed. Before keys + * are allowed to be distributed, they must be expired for a configured amount of time. + * + * @return {@link LocalDateTime} at which the specified {@link DiagnosisKey} can be distributed. + */ + public static LocalDateTime getDistributionDateTime(DiagnosisKey diagnosisKey) { + LocalDateTime submissionDateTime = LocalDateTime + .ofEpochSecond(diagnosisKey.getSubmissionTimestamp() * ONE_HOUR_INTERVAL_SECONDS, 0, UTC); + LocalDateTime keyExpiryDateTime = LocalDateTime + .ofEpochSecond(diagnosisKey.getRollingStartIntervalNumber() * TEN_MINUTES_INTERVAL_SECONDS, 0, UTC) + .plusMinutes(diagnosisKey.getRollingPeriod() * 10L); + + if (Duration.between(keyExpiryDateTime, submissionDateTime).toMinutes() <= DISTRIBUTION_PADDING) { + // truncatedTo floors the value, so we need to add an hour to the DISTRIBUTION_PADDING to compensate that. + return keyExpiryDateTime.plusMinutes(DISTRIBUTION_PADDING + 60).truncatedTo(ChronoUnit.HOURS); + } + + return submissionDateTime; + } +} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/util/DateTime.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/util/DateTime.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/util/DateTime.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/util/DateTime.java @@ -34,6 +34,16 @@ */ public class DateTime { + /** + * The submission timestamp is counted in 1 hour intervals since epoch. + */ + public static final long ONE_HOUR_INTERVAL_SECONDS = TimeUnit.HOURS.toSeconds(1); + + /** + * The rolling start interval number is counted in 10 minute intervals since epoch. + */ + public static final long TEN_MINUTES_INTERVAL_SECONDS = TimeUnit.MINUTES.toSeconds(10); + private DateTime() { } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/TestDataGeneration.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/TestDataGeneration.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/TestDataGeneration.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/TestDataGeneration.java @@ -20,6 +20,9 @@ package app.coronawarn.server.services.distribution.runner; +import static app.coronawarn.server.services.distribution.assembly.diagnosiskeys.util.DateTime.ONE_HOUR_INTERVAL_SECONDS; +import static app.coronawarn.server.services.distribution.assembly.diagnosiskeys.util.DateTime.TEN_MINUTES_INTERVAL_SECONDS; + import app.coronawarn.server.common.persistence.domain.DiagnosisKey; import app.coronawarn.server.common.persistence.service.DiagnosisKeyService; import app.coronawarn.server.common.protocols.internal.RiskLevel; @@ -69,12 +72,6 @@ public class TestDataGeneration implements ApplicationRunner { private static final int POISSON_MAX_ITERATIONS = 10_000_000; private static final double POISSON_EPSILON = 1e-12; - // The submission timestamp is counted in 1 hour intervals since epoch - private static final long ONE_HOUR_INTERVAL_SECONDS = TimeUnit.HOURS.toSeconds(1); - - // The rolling start interval number is counted in 10 minute intervals since epoch - private static final long TEN_MINUTES_INTERVAL_SECONDS = TimeUnit.MINUTES.toSeconds(10); - /** * Creates a new TestDataGeneration runner. */

diff --git a/common/persistence/src/test/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyTest.java b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyTest.java --- a/common/persistence/src/test/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyTest.java +++ b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyTest.java @@ -33,7 +33,6 @@ import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.ValueSource; - class DiagnosisKeyTest { final static byte[] expKeyData = "testKey111111111".getBytes(Charset.defaultCharset()); diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/DistributionDateTimeCalculatorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/DistributionDateTimeCalculatorTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/DistributionDateTimeCalculatorTest.java @@ -0,0 +1,72 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.assembly.structure.directory; + +import static app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory.DistributionDateTimeCalculator.getDistributionDateTime; +import static org.assertj.core.api.Assertions.assertThat; + +import app.coronawarn.server.common.persistence.domain.DiagnosisKey; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.ValueSource; + +class DistributionDateTimeCalculatorTest { + + @ParameterizedTest + @ValueSource(longs = {0L, 24L, 24L + 2L}) + void testLastPeriodOfHourAndSubmissionLessThanDistributionDateTime(long submissionTimestamp) { + var diagnosisKey = buildDiagnosisKey(5, submissionTimestamp); + assertThat(getDistributionDateTime(diagnosisKey)).isEqualTo("1970-01-02T03:00"); + } + + @Test + void testLastPeriodOfHourAndSubmissionEqualsDistributionDateTime() { + var diagnosisKey = buildDiagnosisKey(5, 24L + 3L); + assertThat(getDistributionDateTime(diagnosisKey)).isEqualTo("1970-01-02T03:00"); + } + + @ParameterizedTest + @ValueSource(longs = {0L, 24L, 24L + 2L, 24L + 3L}) + void testFirstPeriodOfHourAndSubmissionLessThanDistributionDateTime(long submissionTimestamp) { + var diagnosisKey = buildDiagnosisKey(6, submissionTimestamp); + assertThat(getDistributionDateTime(diagnosisKey)).isEqualTo("1970-01-02T04:00"); + } + + @Test + void testFirstPeriodOfHourAndSubmissionEqualsDistributionDateTime() { + var diagnosisKey = buildDiagnosisKey(6, 24L + 4L); + assertThat(getDistributionDateTime(diagnosisKey)).isEqualTo("1970-01-02T04:00"); + } + + @Test + void testLastPeriodOfHourAndSubmissionGreaterDistributionDateTime() { + var diagnosisKey = buildDiagnosisKey(5, 24L + 4L); + assertThat(getDistributionDateTime(diagnosisKey)).isEqualTo("1970-01-02T04:00"); + } + + private DiagnosisKey buildDiagnosisKey(int startIntervalNumber, long submissionTimestamp) { + return DiagnosisKey.builder() + .withKeyData(new byte[16]) + .withRollingStartIntervalNumber(startIntervalNumber) + .withTransmissionRiskLevel(2) + .withSubmissionTimestamp(submissionTimestamp).build(); + } +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/util/ImmutableStackTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/util/ImmutableStackTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/util/ImmutableStackTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/util/ImmutableStackTest.java @@ -20,15 +20,12 @@ package app.coronawarn.server.services.distribution.assembly.structure.util; -import org.assertj.core.api.Assertions; -import org.junit.jupiter.api.Test; - -import java.util.ArrayDeque; -import java.util.NoSuchElementException; - import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatExceptionOfType; +import java.util.NoSuchElementException; +import org.junit.jupiter.api.Test; + class ImmutableStackTest { private final ImmutableStack<String> stack =

TEK Exports should not contain any keys which recently expired Currently the system also packages keys, which expired recently. Instead, only keys which have been expired since at least 2 hours should be part of the export. Can also be a nice prework for https://github.com/corona-warn-app/cwa-server/issues/108. Probably should change this already when the diagnosis keys are queried for distribution: https://github.com/corona-warn-app/cwa-server/blob/master/common/persistence/src/main/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyService.java#L64

[Apple spec](https://developer.apple.com/documentation/exposurenotification/setting_up_an_exposure_notification_server) states: > [Your EN Server...] must not distribute temporary exposure key data until at least 2 hours after the end of the keyʼs expiration window I think this is a subtle but important difference to just excluding (+2h) by submission timestamp. As far as I know, the TEK API on-device does not give out "still active" keys to the app. This just leaves a 2 hour window that depends on the rolling start interval number and the rolling period, but not on the submission timestamp. You are right Pit - I just talked to DPP to clarify whether this is OK for them, and it is. I'll update the description of the issue accordingly.

corona-warn-app/cwa-server

corona-warn-app__cwa-server-387

db3d5faa1fe2702ef32ee0e3a965d0097c394df7

diff --git a/THIRD-PARTY-NOTICES b/THIRD-PARTY-NOTICES --- a/THIRD-PARTY-NOTICES +++ b/THIRD-PARTY-NOTICES @@ -80,6 +80,11 @@ Licensor: VMWare Inc. Website: https://spring.io/ License: Apache License 2.0 +Component: Spring Cloud +Licensor: VMWare Inc. +Website: https://spring.io/ +License: Apache License 2.0 + Component: wait-for-it Licensor: Giles Hall Website: https://github.com/vishnubob/wait-for-it @@ -90,9 +95,14 @@ Licensor: Zenko Website: https://github.com/scality/cloudserver License: Apache License 2.0 +Component: Wiremock +Licensor: Tom Akehurst +Website: http://wiremock.org/ +License: Apache License 2.0 + -------------------------------------------------------------------------------- Apache License 2.0 (Commons IO, Commons Math 3, flyway, JSON-Simple, -Maven, MinIO Object Storage, MojoHaus Flatten Maven Plugin, snakeyaml, Spring Boot, Zenko CloudServer) +Maven, MinIO Object Storage, MojoHaus Flatten Maven Plugin, snakeyaml, Spring Boot, Spring Cloud, Zenko CloudServer, Wiremock) Apache License Version 2.0, January 2004 diff --git a/services/submission/pom.xml b/services/submission/pom.xml --- a/services/submission/pom.xml +++ b/services/submission/pom.xml @@ -26,9 +26,9 @@ <artifactId>spring-boot-starter-security</artifactId> </dependency> <dependency> - <groupId>org.springframework.security</groupId> - <artifactId>spring-security-test</artifactId> - <scope>test</scope> + <groupId>org.springframework.cloud</groupId> + <artifactId>spring-cloud-starter-openfeign</artifactId> + <version>2.2.3.RELEASE</version> </dependency> <dependency> <groupId>org.apache.commons</groupId> @@ -48,6 +48,18 @@ <groupId>io.micrometer</groupId> <artifactId>micrometer-registry-prometheus</artifactId> </dependency> + <dependency> + <groupId>org.springframework.security</groupId> + <artifactId>spring-security-test</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>com.github.tomakehurst</groupId> + <artifactId>wiremock-jre8</artifactId> + <version>2.26.3</version> + <scope>test</scope> + </dependency> + </dependencies> <build> diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/ServerApplication.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/ServerApplication.java --- a/services/submission/src/main/java/app/coronawarn/server/services/submission/ServerApplication.java +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/ServerApplication.java @@ -25,6 +25,7 @@ import org.springframework.boot.autoconfigure.domain.EntityScan; import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.boot.web.servlet.ServletComponentScan; +import org.springframework.cloud.openfeign.EnableFeignClients; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.ComponentScan; import org.springframework.data.jpa.repository.config.EnableJpaRepositories; @@ -37,6 +38,7 @@ @ComponentScan({"app.coronawarn.server.common.persistence", "app.coronawarn.server.services.submission"}) @EnableConfigurationProperties +@EnableFeignClients public class ServerApplication { @Bean diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/Tan.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/Tan.java new file mode 100644 --- /dev/null +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/Tan.java @@ -0,0 +1,82 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.submission.verification; + +import java.util.Objects; +import java.util.UUID; + +/** + * A representation of a tan. + */ +class Tan { + private final UUID tan; + + private Tan(UUID tan) { + this.tan = tan; + } + + /** + * Creates a new {@link #Tan} instance for the given tan string. + * + * @param tanString A valid UUID string representation. + * @return The Tan instance + * @throws IllegalArgumentException when the given tan string is not a valid UUID. + */ + public static Tan of(String tanString) { + UUID tan = UUID.fromString(tanString.trim()); + return new Tan(tan); + } + + /** + * Returns the tan entity as UUID. + * @return the tan. + */ + public UUID getTan() { + return tan; + } + + /** + * Returns the TAN in it's string representation. + * + * @return the tan UUID as a string. + */ + @Override + public String toString() { + return tan.toString(); + } + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Tan tan1 = (Tan) o; + return tan.equals(tan1.tan); + } + + @Override + public int hashCode() { + return Objects.hash(tan); + } +} diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/TanVerifier.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/TanVerifier.java --- a/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/TanVerifier.java +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/TanVerifier.java @@ -20,20 +20,12 @@ package app.coronawarn.server.services.submission.verification; -import app.coronawarn.server.services.submission.config.SubmissionServiceConfig; -import java.util.UUID; +import feign.FeignException; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.boot.web.client.RestTemplateBuilder; -import org.springframework.http.HttpEntity; -import org.springframework.http.HttpHeaders; -import org.springframework.http.MediaType; -import org.springframework.http.ResponseEntity; import org.springframework.stereotype.Service; -import org.springframework.web.client.HttpClientErrorException; import org.springframework.web.client.RestClientException; -import org.springframework.web.client.RestTemplate; /** * The TanVerifier performs the verification of submission TANs. @@ -42,54 +34,32 @@ public class TanVerifier { private static final Logger logger = LoggerFactory.getLogger(TanVerifier.class); - private final String verificationServiceUrl; - private final RestTemplate restTemplate; - private final HttpHeaders requestHeader = new HttpHeaders(); + private final VerificationServerClient verificationServerClient; /** * This class can be used to verify a TAN against a configured verification service. * - * @param submissionServiceConfig A submission service configuration - * @param restTemplateBuilder A rest template builder + * @param verificationServerClient The REST client to communicate with the verification server */ @Autowired - public TanVerifier(SubmissionServiceConfig submissionServiceConfig, RestTemplateBuilder restTemplateBuilder) { - this.verificationServiceUrl = submissionServiceConfig.getVerificationBaseUrl() - + submissionServiceConfig.getVerificationPath(); - this.restTemplate = restTemplateBuilder.build(); - this.requestHeader.setContentType(MediaType.APPLICATION_JSON); + public TanVerifier(VerificationServerClient verificationServerClient) { + this.verificationServerClient = verificationServerClient; } /** * Verifies the specified TAN. Returns {@literal true} if the specified TAN is valid, {@literal false} otherwise. * - * @param tan Submission Authorization TAN + * @param tanString Submission Authorization TAN * @return {@literal true} if the specified TAN is valid, {@literal false} otherwise. * @throws RestClientException if status code is neither 2xx nor 4xx */ - public boolean verifyTan(String tan) { - String trimmedTan = tan.trim(); - - if (!checkTanSyntax(trimmedTan)) { - logger.debug("TAN Syntax check failed for TAN: {}", trimmedTan); - return false; - } - - return verifyWithVerificationService(trimmedTan); - } - - /** - * Verifies if the provided TAN can be parsed as a UUID. - * - * @param tan Submission Authorization TAN - * @return {@literal true} if tan can be parsed as a UUID, {@literal false} otherwise - */ - private boolean checkTanSyntax(String tan) { + public boolean verifyTan(String tanString) { try { - UUID.fromString(tan); - return true; + Tan tan = Tan.of(tanString); + + return verifyWithVerificationService(tan); } catch (IllegalArgumentException e) { - logger.debug("UUID creation failed for value: {}", tan, e); + logger.debug("TAN Syntax check failed for TAN: {}", tanString.trim()); return false; } } @@ -101,16 +71,11 @@ private boolean checkTanSyntax(String tan) { * @return {@literal true} if verification service is able to verify the provided TAN, {@literal false} otherwise * @throws RestClientException if http status code is neither 2xx nor 404 */ - private boolean verifyWithVerificationService(String tan) { - String json = "{ \"tan\": \"" + tan + "\" }"; - HttpEntity<String> entity = new HttpEntity<>(json, requestHeader); - + private boolean verifyWithVerificationService(Tan tan) { try { - ResponseEntity<String> response = restTemplate.postForEntity(verificationServiceUrl, entity, String.class); - return response.getStatusCode().is2xxSuccessful(); - } catch (HttpClientErrorException.NotFound e) { - // The verification service returns http status 404 if the TAN is invalid - logger.debug("TAN verification failed"); + verificationServerClient.verifyTan(tan); + return true; + } catch (FeignException.NotFound e) { return false; } } diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/VerificationServerClient.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/VerificationServerClient.java new file mode 100644 --- /dev/null +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/VerificationServerClient.java @@ -0,0 +1,42 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.submission.verification; + +import org.springframework.cloud.openfeign.FeignClient; +import org.springframework.http.MediaType; +import org.springframework.web.bind.annotation.PostMapping; + +/** + * This is a Spring Cloud Feign based HTTP client that allows type-safe HTTP calls + * and abstract the implementation away. + */ +@FeignClient(name = "verification-server", url = "${services.submission.verification.base-url}") +public interface VerificationServerClient { + + /** + * This methods calls the verification service with the given + * {#link tan}. + * @param tan the tan to verify. + * @return 404 when the tan is not valid. + */ + @PostMapping(value = "${services.submission.verification.path}", consumes = MediaType.APPLICATION_JSON_VALUE) + String verifyTan(Tan tan); +}

diff --git a/services/submission/src/test/java/app/coronawarn/server/services/submission/verification/FeignTestConfiguration.java b/services/submission/src/test/java/app/coronawarn/server/services/submission/verification/FeignTestConfiguration.java new file mode 100644 --- /dev/null +++ b/services/submission/src/test/java/app/coronawarn/server/services/submission/verification/FeignTestConfiguration.java @@ -0,0 +1,35 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.submission.verification; + +import org.springframework.boot.autoconfigure.http.HttpMessageConverters; +import org.springframework.boot.test.context.TestConfiguration; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Profile; + +@TestConfiguration +@Profile("feign") +public class FeignTestConfiguration { + @Bean + public HttpMessageConverters httpMessageConverters() { + return new HttpMessageConverters(); + } +} diff --git a/services/submission/src/test/java/app/coronawarn/server/services/submission/verification/TanTest.java b/services/submission/src/test/java/app/coronawarn/server/services/submission/verification/TanTest.java new file mode 100644 --- /dev/null +++ b/services/submission/src/test/java/app/coronawarn/server/services/submission/verification/TanTest.java @@ -0,0 +1,49 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.submission.verification; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatThrownBy; + +import java.util.UUID; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.ValueSource; + +class TanTest { + @ParameterizedTest + @ValueSource(strings = { + "ANY SYNTAX", "123456", "ABCD23X", "ZZZZZZZ", "Bearer 3123fe", "", "&%$§&%&$%/%&", + "LOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOONG" + }) + void invalidTanShouldThrowException(String invalidSyntaxTan) { + assertThatThrownBy(() -> Tan.of(invalidSyntaxTan)).isInstanceOf(IllegalArgumentException.class); + } + + @Test + void validTanShouldReturnTanInstance() { + String tanString = UUID.randomUUID().toString(); + Tan tan = Tan.of(tanString); + + assertThat(tan).isNotNull(); + assertThat(tan.toString()).isEqualTo(tanString); + } +} diff --git a/services/submission/src/test/java/app/coronawarn/server/services/submission/verification/TanVerifierTest.java b/services/submission/src/test/java/app/coronawarn/server/services/submission/verification/TanVerifierTest.java --- a/services/submission/src/test/java/app/coronawarn/server/services/submission/verification/TanVerifierTest.java +++ b/services/submission/src/test/java/app/coronawarn/server/services/submission/verification/TanVerifierTest.java @@ -7,9 +7,9 @@ * 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 - * + * * http://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. @@ -21,87 +21,99 @@ package app.coronawarn.server.services.submission.verification; -import static org.assertj.core.api.Assertions.assertThat; -import static org.assertj.core.api.Assertions.assertThatExceptionOfType; -import static org.springframework.test.web.client.match.MockRestRequestMatchers.method; -import static org.springframework.test.web.client.match.MockRestRequestMatchers.requestTo; -import static org.springframework.test.web.client.response.MockRestResponseCreators.withStatus; - import app.coronawarn.server.services.submission.config.SubmissionServiceConfig; -import java.util.UUID; +import com.github.tomakehurst.wiremock.WireMockServer; +import feign.FeignException; +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; -import org.junit.jupiter.params.ParameterizedTest; -import org.junit.jupiter.params.provider.ValueSource; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.context.properties.EnableConfigurationProperties; -import org.springframework.boot.test.autoconfigure.web.client.RestClientTest; -import org.springframework.boot.test.context.ConfigFileApplicationContextInitializer; -import org.springframework.http.HttpMethod; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.cloud.openfeign.EnableFeignClients; +import org.springframework.cloud.openfeign.FeignAutoConfiguration; +import org.springframework.context.annotation.Import; import org.springframework.http.HttpStatus; -import org.springframework.test.context.ContextConfiguration; -import org.springframework.test.web.client.ExpectedCount; -import org.springframework.test.web.client.MockRestServiceServer; -import org.springframework.web.client.HttpServerErrorException; +import org.springframework.http.MediaType; +import org.springframework.test.context.ActiveProfiles; -@EnableConfigurationProperties(value = SubmissionServiceConfig.class) -@ContextConfiguration(classes = {TanVerifier.class}, - initializers = ConfigFileApplicationContextInitializer.class) -@RestClientTest -class TanVerifierTest { +import java.util.UUID; - @Autowired - private MockRestServiceServer server; +import static com.github.tomakehurst.wiremock.client.WireMock.*; +import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.options; +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatExceptionOfType; +import static org.springframework.http.HttpHeaders.CONTENT_TYPE; +@SpringBootTest( + classes = {FeignAutoConfiguration.class, TanVerifier.class}) +@EnableConfigurationProperties(value = SubmissionServiceConfig.class) +@EnableFeignClients +@Import(FeignTestConfiguration.class) +@ActiveProfiles("feign") +class TanVerifierTest { @Autowired private TanVerifier tanVerifier; @Autowired private SubmissionServiceConfig submissionServiceConfig; - private String verificationUrl; + private String verificationPath; private String randomUUID; + private static WireMockServer server; + + @BeforeAll + static void setupWireMock() { + server = new WireMockServer(options().port(1234)); + server.start(); + } @BeforeEach void setup() { - this.verificationUrl = submissionServiceConfig.getVerificationBaseUrl() - + submissionServiceConfig.getVerificationPath(); + this.verificationPath = submissionServiceConfig.getVerificationPath(); this.randomUUID = UUID.randomUUID().toString(); + server.resetAll(); } - @ParameterizedTest - @ValueSource(strings = { - "ANY SYNTAX", "123456", "ABCD23X", "ZZZZZZZ", "Bearer 3123fe", "", "&%$§&%&$%/%&", - "LOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOONG" - }) - void checkWrongTanSyntax(String invalidSyntaxTan) { - assertThat(tanVerifier.verifyTan(invalidSyntaxTan)).isFalse(); + @AfterAll + static void tearDown() { + server.stop(); } @Test void checkValidTan() { - this.server - .expect(ExpectedCount.once(), requestTo(verificationUrl)) - .andExpect(method(HttpMethod.POST)) - .andRespond(withStatus(HttpStatus.OK)); - assertThat(tanVerifier.verifyTan(randomUUID)).isTrue(); + server.stubFor( + post(urlEqualTo(verificationPath)) + .withRequestBody(matchingJsonPath("tan", equalTo(randomUUID))) + .withHeader(CONTENT_TYPE, equalTo(MediaType.APPLICATION_JSON.toString())) + .willReturn(aResponse().withStatus(HttpStatus.OK.value()))); + + boolean tanVerificationResponse = tanVerifier.verifyTan(randomUUID); + + assertThat(tanVerificationResponse).isTrue(); } @Test void checkInvalidTan() { - this.server - .expect(ExpectedCount.once(), requestTo(verificationUrl)) - .andExpect(method(HttpMethod.POST)) - .andRespond(withStatus(HttpStatus.NOT_FOUND)); - assertThat(tanVerifier.verifyTan(randomUUID)).isFalse(); + server.stubFor( + post(urlEqualTo(verificationPath)) + .withHeader(CONTENT_TYPE, equalTo(MediaType.APPLICATION_JSON.toString())) + .willReturn(aResponse().withStatus(HttpStatus.NOT_FOUND.value()))); + + boolean tanVerificationResponse = tanVerifier.verifyTan(randomUUID); + + assertThat(tanVerificationResponse).isFalse(); } @Test void checkInternalServerError() { - this.server - .expect(ExpectedCount.once(), requestTo(verificationUrl)) - .andExpect(method(HttpMethod.POST)) - .andRespond(withStatus(HttpStatus.INTERNAL_SERVER_ERROR)); - assertThatExceptionOfType(HttpServerErrorException.class).isThrownBy(() -> tanVerifier.verifyTan(randomUUID)); + server.stubFor( + post(urlEqualTo(verificationPath)) + .withHeader(CONTENT_TYPE, equalTo(MediaType.APPLICATION_JSON.toString())) + .willReturn(aResponse().withStatus(HttpStatus.INTERNAL_SERVER_ERROR.value()))); + + assertThatExceptionOfType(FeignException.class).isThrownBy(() -> tanVerifier.verifyTan(randomUUID)); } + } diff --git a/services/submission/src/test/resources/application.yaml b/services/submission/src/test/resources/application.yaml --- a/services/submission/src/test/resources/application.yaml +++ b/services/submission/src/test/resources/application.yaml @@ -30,5 +30,5 @@ services: payload: max-number-of-keys: 14 verification: - base-url: http://verificationService:1234 + base-url: http://localhost:1234 path: /version/v1/tan/verify

Use typed client and entities for tan verification ## Current Implementation The current tan verification look like this: https://github.com/corona-warn-app/cwa-server/blob/3b98beb268bac511c00f8e13bcbb4978a8cdb4fd/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/TanVerifier.java#L102-L115 There are a couple of issues I would see here: 1. The tan entity is build from a string which can cause bugs, encoding issues an more. 2. When the interface of the verification server changes (and this a repo owned by the same organization) this has to be modified as well and can cause runtime bugs without proper system testing ## Suggested Enhancement I would suggest two things 1. Create a DTO (Pojo) for the tan payload and pass that to the rest template to let Jackson handle serialization 2. If a dependency between cwa projects is "allowed" (which I would think is perfectly fine) I would actually move that entity to the verification server project in a separate maven module. I would add [Spring Feign client ](https://cloud.spring.io/spring-cloud-netflix/multi/multi_spring-cloud-feign.html) and use that in the CWA server. Feign is like the reverse version of `@RestController` and supports the same annotations. It will create the client implementation from the given interface at runtime. The client would look like this: ``` @FeignClient(name = "verification-server", url = "${services.submission.verification.baseUrl}") public interface StoreClient { @RequestMapping(method = RequestMethod.POST, value = "${services.submission.verification.path}", consumes = "application/json") ValidationResult validateTan(Tan tan); // both classes should be Pojos } ``` The usage would look like this (I did not actually implemented that!): ``` private boolean verifyWithVerificationService(String tanString) { Tan tan = Tan.from(tanString); // This should also do the UUID verification! ValidationResult result = verificationServer.validateTan(tan); return result != null; } ``` ## Expected Benefits - Compilation breaks when interface changes - Less risk of bugs

I like those suggestions. The introduction of a value object for a TAN is something I thought about suggesting as well. Would bind the verification logic into a value and make the using code more expressive and safe. Although I am more of a hypermedia guy and thus not a big fan of hard coding URIs in clients, I think Feign would be fine here, although I think that – unless also used in other places – the benefit of using that over `RestTemplate`/`WebClient` is not that significant. What I do think needs improvement is the setup of whatever client API is ended up being used. Remote calls definitely need a timeout as otherwise the system is stuck in case the downstream service is not answering at all for whatever reasons. Also, from a security perspective this implementation shall be changed. When building the json string this way, a malicious tan can inject arbitrary fields to the json object. Even if the tan is previously checked for the correct syntax in another method, this implementation is error-prone. The syntax check for the tan can be called directly before creating the json string or the tan can be filtered with an whitelist approach. I assume the previously mentioned changes will also tackle the injection issue. I haven't really looked at the verification server but calling as POST to verify a TAN seems to me a bit unRESTy to be honest. But this is probably worth another issue... > I haven't really looked at the verification server but calling as POST to verify a TAN seems to me a bit unRESTy to be honest. But this is probably worth another issue... It actually explained in the documentation: > The HTTP method POST is used instead of GET for added security, so data (e.g. the registration token or the TAN) can be transferred in the body. However, I would still doubt that it's necessary. Correct me if I'm wrong, but when doing backend-to-backend http call, the whole request - both URL params and and body - are within the same TCP packet. So as long as either: - Both backends are within a secure environment or - The use TLS I don't think moving the tan to the body helps to improve security in any way. This is probably only important when doing a frontend-to-backend call which is not the case here. We have discussed and would like to proceed with the FeignClient, however, with the approach of keeping the java class entity on cwa-server, simply having one attribute 'tan' > > I haven't really looked at the verification server but calling as POST to verify a TAN seems to me a bit unRESTy to be honest. But this is probably worth another issue... > > It actually explained in the documentation: > > > The HTTP method POST is used instead of GET for added security, so data (e.g. the registration token or the TAN) can be transferred in the body. > > However, I would still doubt that it's necessary. > > Correct me if I'm wrong, but when doing backend-to-backend http call, the whole request - both URL params and and body - are within the same TCP packet. So as long as either: > > * Both backends are within a secure environment or > * The use TLS > I don't think moving the tan to the body helps to improve security in any way. > > This is probably only important when doing a frontend-to-backend call which is not the case here. The main reason to go with POST here (which transports the secret in the http body) is due to the sensitive nature of the TAN. We don't want the TAN to come up in any of our infrastructure / http access logs by chance. This does not only apply to TANs but to all other sensitive data we are processing. I'm working on a PR.

corona-warn-app/cwa-server

corona-warn-app__cwa-server-388

00a342298942773ee49eeea9387a2acd164c3d49

diff --git a/common/persistence/pom.xml b/common/persistence/pom.xml --- a/common/persistence/pom.xml +++ b/common/persistence/pom.xml @@ -78,7 +78,7 @@ <dependency> <groupId>com.h2database</groupId> <artifactId>h2</artifactId> - <version>1.4.199</version> + <version>1.4.200</version> <scope>runtime</scope> </dependency> <dependency> diff --git a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKey.java b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKey.java --- a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKey.java +++ b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKey.java @@ -29,9 +29,8 @@ import java.util.Arrays; import java.util.Objects; import java.util.Set; +import javax.persistence.Column; import javax.persistence.Entity; -import javax.persistence.GeneratedValue; -import javax.persistence.GenerationType; import javax.persistence.Id; import javax.persistence.Table; import javax.validation.ConstraintViolation; @@ -57,10 +56,8 @@ public class DiagnosisKey { private static final Validator VALIDATOR = Validation.buildDefaultValidatorFactory().getValidator(); @Id - @GeneratedValue(strategy = GenerationType.IDENTITY) - private Long id; - @Size(min = 16, max = 16, message = "Key data must be a byte array of length 16.") + @Column(unique = true) private byte[] keyData; @ValidRollingStartIntervalNumber @@ -100,10 +97,6 @@ public static Builder builder() { return new DiagnosisKeyBuilder(); } - public Long getId() { - return id; - } - /** * Returns the diagnosis key. */ @@ -189,14 +182,13 @@ public boolean equals(Object o) { && rollingPeriod == that.rollingPeriod && transmissionRiskLevel == that.transmissionRiskLevel && submissionTimestamp == that.submissionTimestamp - && Objects.equals(id, that.id) && Arrays.equals(keyData, that.keyData); } @Override public int hashCode() { int result = Objects - .hash(id, rollingStartIntervalNumber, rollingPeriod, transmissionRiskLevel, submissionTimestamp); + .hash(rollingStartIntervalNumber, rollingPeriod, transmissionRiskLevel, submissionTimestamp); result = 31 * result + Arrays.hashCode(keyData); return result; } diff --git a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/repository/DiagnosisKeyRepository.java b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/repository/DiagnosisKeyRepository.java --- a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/repository/DiagnosisKeyRepository.java +++ b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/repository/DiagnosisKeyRepository.java @@ -22,6 +22,8 @@ import app.coronawarn.server.common.persistence.domain.DiagnosisKey; import org.springframework.data.jpa.repository.JpaRepository; +import org.springframework.data.jpa.repository.Modifying; +import org.springframework.data.jpa.repository.Query; import org.springframework.stereotype.Repository; @Repository @@ -33,4 +35,22 @@ public interface DiagnosisKeyRepository extends JpaRepository<DiagnosisKey, Long * @param submissionTimestamp the submission timestamp up to which entries will be deleted. */ void deleteBySubmissionTimestampIsLessThanEqual(long submissionTimestamp); + + /** + * Attempts to write the specified diagnosis key information into the database. If a row with the specified key data + * already exists, no data is inserted. + * + * @param keyData The key data of the diagnosis key. + * @param rollingStartIntervalNumber The rolling start interval number of the diagnosis key. + * @param rollingPeriod The rolling period of the diagnosis key. + * @param submissionTimestamp The submission timestamp of the diagnosis key. + * @param transmissionRisk The transmission risk level of the diagnosis key. + */ + @Modifying + @Query(nativeQuery = true, value = + "INSERT INTO diagnosis_key" + + "(key_data, rolling_start_interval_number, rolling_period, submission_timestamp, transmission_risk_level)" + + " VALUES(?, ?, ?, ?, ?) ON CONFLICT DO NOTHING;") + void saveDoNothingOnConflict(byte[] keyData, int rollingStartIntervalNumber, int rollingPeriod, + long submissionTimestamp, int transmissionRisk); } diff --git a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyService.java b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyService.java --- a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyService.java +++ b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyService.java @@ -50,13 +50,19 @@ public DiagnosisKeyService(DiagnosisKeyRepository keyRepository) { } /** - * Persists the specified collection of {@link DiagnosisKey} instances. + * Persists the specified collection of {@link DiagnosisKey} instances. If the key data of a particular diagnosis key + * already exists in the database, this diagnosis key is not persisted. * * @param diagnosisKeys must not contain {@literal null}. * @throws IllegalArgumentException in case the given collection contains {@literal null}. */ + @Transactional public void saveDiagnosisKeys(Collection<DiagnosisKey> diagnosisKeys) { - keyRepository.saveAll(diagnosisKeys); + for (DiagnosisKey diagnosisKey : diagnosisKeys) { + keyRepository.saveDoNothingOnConflict( + diagnosisKey.getKeyData(), diagnosisKey.getRollingStartIntervalNumber(), diagnosisKey.getRollingPeriod(), + diagnosisKey.getSubmissionTimestamp(), diagnosisKey.getTransmissionRiskLevel()); + } } /** diff --git a/common/persistence/src/main/resources/db/migration/h2/V3__makeKeyDataPrimaryKey.sql b/common/persistence/src/main/resources/db/migration/h2/V3__makeKeyDataPrimaryKey.sql new file mode 100644 --- /dev/null +++ b/common/persistence/src/main/resources/db/migration/h2/V3__makeKeyDataPrimaryKey.sql @@ -0,0 +1,3 @@ +ALTER TABLE diagnosis_key DROP COLUMN id; +ALTER TABLE diagnosis_key ALTER COLUMN key_data SET NOT NULL; +ALTER TABLE diagnosis_key ADD PRIMARY KEY (key_data); \ No newline at end of file diff --git a/common/persistence/src/main/resources/db/migration/postgres/V3__makeKeyDataPrimaryKey.sql b/common/persistence/src/main/resources/db/migration/postgres/V3__makeKeyDataPrimaryKey.sql new file mode 100644 --- /dev/null +++ b/common/persistence/src/main/resources/db/migration/postgres/V3__makeKeyDataPrimaryKey.sql @@ -0,0 +1,3 @@ +ALTER TABLE diagnosis_key DROP COLUMN id; +ALTER TABLE diagnosis_key ALTER COLUMN key_data SET NOT NULL; +ALTER TABLE diagnosis_key ADD PRIMARY KEY (key_data); \ No newline at end of file

diff --git a/common/persistence/src/test/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyServiceTest.java b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyServiceTest.java --- a/common/persistence/src/test/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyServiceTest.java +++ b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyServiceTest.java @@ -33,6 +33,7 @@ import java.util.ArrayList; import java.util.Collections; import java.util.List; +import java.util.Random; import org.assertj.core.util.Lists; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.DisplayName; @@ -149,9 +150,34 @@ void testNoPersistOnValidationError() { assertDiagnosisKeysEqual(Lists.emptyList(), actKeys); } + @Test + void shouldNotUpdateExistingKey() { + var keyData = "1234567890123456"; + var keys = List.of(DiagnosisKey.builder() + .withKeyData(keyData.getBytes()) + .withRollingStartIntervalNumber(600) + .withTransmissionRiskLevel(2) + .withSubmissionTimestamp(0L).build(), + DiagnosisKey.builder() + .withKeyData(keyData.getBytes()) + .withRollingStartIntervalNumber(600) + .withTransmissionRiskLevel(3) + .withSubmissionTimestamp(0L).build()); + + diagnosisKeyService.saveDiagnosisKeys(keys); + + var actKeys = diagnosisKeyService.getDiagnosisKeys(); + + assertThat(actKeys.size()).isEqualTo(1); + assertThat(actKeys.iterator().next().getTransmissionRiskLevel()).isEqualTo(2); + } + public static DiagnosisKey buildDiagnosisKeyForSubmissionTimestamp(long submissionTimeStamp) { + byte[] randomBytes = new byte[16]; + Random random = new Random(submissionTimeStamp); + random.nextBytes(randomBytes); return DiagnosisKey.builder() - .withKeyData(new byte[16]) + .withKeyData(randomBytes) .withRollingStartIntervalNumber(600) .withTransmissionRiskLevel(2) .withSubmissionTimestamp(submissionTimeStamp).build(); diff --git a/common/persistence/src/test/resources/application.yaml b/common/persistence/src/test/resources/application.yaml --- a/common/persistence/src/test/resources/application.yaml +++ b/common/persistence/src/test/resources/application.yaml @@ -1,5 +1,8 @@ --- spring: + test: + database: + replace: none flyway: enabled: false jpa: @@ -8,6 +11,10 @@ spring: properties: hibernate: show_sql: false + datasource: + url: jdbc:h2:mem:test;MODE=PostgreSQL + driverClassName: org.h2.Driver + platform: h2 main: banner-mode: off logging: diff --git a/services/submission/src/test/resources/application.yaml b/services/submission/src/test/resources/application.yaml --- a/services/submission/src/test/resources/application.yaml +++ b/services/submission/src/test/resources/application.yaml @@ -11,7 +11,13 @@ spring: enabled: true # default case is H2 - value will be overwritten by profile cloud or postgres locations: classpath:db/migration/h2 - + datasource: + url: jdbc:h2:mem:test;MODE=PostgreSQL + driverClassName: org.h2.Driver + platform: h2 + test: + database: + replace: none jpa: hibernate: ddl-auto: validate

Ensure uniqueness of diagnosis keys ## Current Implementation The uniqueness of diagnosis keys is neither guaranteed by the database, nor by validation logic. ## Suggested Enhancement Ensure that diagnosis keys in the database are unique (there are no duplicates). What needs to be decided: - [x] Is it sufficient to guarantee the uniqueness of the diagnosis key or should the uniqueness of diagnosis key + submission timestamp (+maybe even more fields) be guaranteed? - [x] Should the duplicate check happen on the database (`UNIQUE` constraint) or in the server logic (e.g. during the validation of submitted keys)? - [x] If the check happens on the database: Should the `id` column be removed and replaced with the diagnosis key (+submission timestamp) as (composite) primary key? - [x] How should the server react when a duplicate diagnosis key is submitted (update, error, etc.)? **Edit:** Decisions are below.

Decisions made by @christian-kirschnick: - Ensuring the uniqueness of the diagnosis key is sufficient - Duplicate check should happen on the database - `id` column should be removed - `key_data` column should become primary key - If we encounter problems with the current type (`bytea`) of `key_data` as primary key, then change the type to a base64 encoded String - When duplicate keys are submitted, the server should just ignore them (no update, no error). @pithumke Was referenced back to here from a different issue, What would be the value of base64 encoding the UUID? it'll just take up even more space than even using char(32). there is a UUID type already in pg that'll give better seek performance and cost 16 bytes per entry instead of 32 About the risk of collision itself, with UUIDv4 that is quite unlikely even with billions of records, However if you don't want to suffer the occasional exception on the server side you can just add `ON CONFLICT DO NOTHING` to swallow the error Hi @oiime, thank you for the remarks! Good point with the UUID type, I'll bring it up in the team discussions and report back. However, please note that, to my knowledge, the type of the diagnosis keys is not explicitly stated as UUID by the Google/Apple spec, but only as "Data" (see [here](https://developer.apple.com/documentation/exposurenotification/entemporaryexposurekey/3583679-keydata)) containing 16 bytes (see [here](https://www.blog.google/documents/60/Exposure_Notification_-_Cryptography_Specification_v1.1.pdf)). This can, in theory, be mapped to a UUID, but I would like to investigate if the PG UUID type implies any restrictions. For example, UUIDv4 reserves 6 of the 128 bits for version information, leaving only 122 bits for the payload (see [here](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random))) - and this would cause major problems for us. Regarding the collisions: we currently also don't see this as a major risk. Our current strategy, as you proposed, is to simply ignore duplicates. @pithumke Well, you're the one defining both the client and the server side, the EN API is agnostic to its content to allow that freedom of implementation, so you can define that key to be whatever you want it to be, currently you are validating it as UUID in the server and the test case generates a UUIDv4. the UUID data type follows RFC 4122 as you would expect and would naturally cover UUIDv4. All UUID versions reserve a place for version information. _please_ do not try to come up with your own UUID variant if that is what is suggested here Hi @oiime, thank you for your comment. > Well, you're the one defining both the client and the server side, the EN API is agnostic to its content to allow that freedom of implementation, so you can define that key to be whatever you want it to be Yes, we do specify and develop both the CWA server and client. However, we neither specify nor develop the on-device APIs - that is done by Apple and Google. Inside those on-device APIs is where the keys are being generated and that does not give us much freedom regarding data types on our end. In the specification it is stated, that the key data consists of 16 bytes (= 128 bits). Since the use of UUID would restrict that to 122 bits, we can not use it as the column type on postgres. > currently you are validating it as UUID in the server and the test case generates a UUIDv4 I am not aware of any UUID handling in our current code base, besides for TANs (which are not stored on the server). Can you please link which specific code you are referring to? > please do not try to come up with your own UUID variant if that is what is suggested here I didn't mean to suggest that and we don't want to come up with an own UUID variant. This is why we decided to go for a base64 encoded string for now (if bytea turns out to cause problems). @pithumke > However, we neither specify nor develop the on-device API I guess I rely on looking at the API itself, perhaps apple or google or both have a specific implementation they mandate or suggest, if that is the case then using UUID is wrong anyway > I am not aware of any UUID handling in our current code base, besides for TANs I am likely conflating the two, I have only skimmed through the code and what I recalled was the test generating UUIDv4 > I didn't mean to suggest that and we don't want to come up with an own UUID variant. This is why we decided to go for a base64 encoded string for now (if bytea turns out to cause problems). base64 seems like an unnecessary step that'll just take up more space and computation, you do it to avoid just storing it in a char(16) as-is? though I don't see why bytea wouldn't work as a PK, especially as you'd never update it

corona-warn-app/cwa-server

corona-warn-app__cwa-server-406

fd114fd04e36c36c8081e0286e3f3fd27170777e

diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -148,7 +148,7 @@ Profile | Effect -----------------|------------- `dev` | Turns the log level to `DEBUG`. `cloud` | Removes default values for the `datasource` and `objectstore` configurations. -`demo` | Includes incomplete days and hours into the distribution run, thus creating aggregates for the current day and the current hour (and including both in the respective indices). When running multiple distributions in one hour with this profile, the date aggregate for today and the hours aggregate for the current hour will be updated and overwritten. +`demo` | Includes incomplete days and hours into the distribution run, thus creating aggregates for the current day and the current hour (and including both in the respective indices). When running multiple distributions in one hour with this profile, the date aggregate for today and the hours aggregate for the current hour will be updated and overwritten. This profile also turns off the expiry policy (Keys must be expired for at least 2 hours before distribution) and the shifting policy (there must be at least 140 keys in a distribution). `testdata` | Causes test data to be inserted into the database before each distribution run. By default, around 1000 random diagnosis keys will be generated per hour. If there are no diagnosis keys in the database yet, random keys will be generated for every hour from the beginning of the retention period (14 days ago at 00:00 UTC) until one hour before the present hour. If there are already keys in the database, the random keys will be generated for every hour from the latest diagnosis key in the database (by submission timestamp) until one hour before the present hour (or none at all, if the latest diagnosis key in the database was submitted one hour ago or later). `signature-dev` | Sets the app package ID in the export packages' signature info to `de.rki.coronawarnapp-dev` so that test certificates (instead of production certificates) will be used for client-side validation. `signature-prod` | Provides production app package IDs for the signature info diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/DiagnosisKeysStructureProvider.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/DiagnosisKeysStructureProvider.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/DiagnosisKeysStructureProvider.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/DiagnosisKeysStructureProvider.java @@ -22,6 +22,7 @@ import app.coronawarn.server.common.persistence.domain.DiagnosisKey; import app.coronawarn.server.common.persistence.service.DiagnosisKeyService; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.DiagnosisKeyBundler; import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory.DiagnosisKeysDirectory; import app.coronawarn.server.services.distribution.assembly.structure.WritableOnDisk; import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; @@ -29,6 +30,7 @@ import java.util.Collection; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Component; /** @@ -40,6 +42,8 @@ public class DiagnosisKeysStructureProvider { private static final Logger logger = LoggerFactory .getLogger(DiagnosisKeysStructureProvider.class); + @Autowired + private DiagnosisKeyBundler diagnosisKeyBundler; private final DiagnosisKeyService diagnosisKeyService; private final CryptoProvider cryptoProvider; private final DistributionServiceConfig distributionServiceConfig; @@ -56,11 +60,13 @@ public class DiagnosisKeysStructureProvider { /** * Get directory for diagnosis keys from database. + * * @return the directory */ public Directory<WritableOnDisk> getDiagnosisKeys() { logger.debug("Querying diagnosis keys from the database..."); Collection<DiagnosisKey> diagnosisKeys = diagnosisKeyService.getDiagnosisKeys(); - return new DiagnosisKeysDirectory(diagnosisKeys, cryptoProvider, distributionServiceConfig); + diagnosisKeyBundler.setDiagnosisKeys(diagnosisKeys); + return new DiagnosisKeysDirectory(diagnosisKeyBundler, cryptoProvider, distributionServiceConfig); } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/DemoDiagnosisKeyBundler.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/DemoDiagnosisKeyBundler.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/DemoDiagnosisKeyBundler.java @@ -0,0 +1,61 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.assembly.diagnosiskeys; + +import static java.util.stream.Collectors.groupingBy; + +import app.coronawarn.server.common.persistence.domain.DiagnosisKey; +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import java.time.LocalDateTime; +import java.util.Collection; +import java.util.List; +import org.springframework.context.annotation.Profile; + +/** + * An instance of this class contains a collection of {@link DiagnosisKey DiagnosisKeys}, that will be distributed + * in the same hour they have been submitted. + */ +@Profile("demo") +public class DemoDiagnosisKeyBundler extends DiagnosisKeyBundler { + + public DemoDiagnosisKeyBundler(DistributionServiceConfig distributionServiceConfig) { + super(distributionServiceConfig); + } + + /** + * Initializes the internal {@code distributableDiagnosisKeys} map, grouping the diagnosis keys by the submission + * timestamp, thus ignoring the expiry policy. + */ + @Override + protected void createDiagnosisKeyDistributionMap(Collection<DiagnosisKey> diagnosisKeys) { + this.distributableDiagnosisKeys.clear(); + this.distributableDiagnosisKeys.putAll(diagnosisKeys.stream().collect(groupingBy(this::getSubmissionDateTime))); + } + + /** + * Returns all diagnosis keys that should be distributed in a specific hour, without respecting the shifting and + * expiry policies. + */ + @Override + public List<DiagnosisKey> getDiagnosisKeysDistributableAt(LocalDateTime hour) { + return this.getDiagnosisKeysForHour(hour); + } +} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/DiagnosisKeyBundler.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/DiagnosisKeyBundler.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/DiagnosisKeyBundler.java @@ -0,0 +1,98 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.assembly.diagnosiskeys; + +import static app.coronawarn.server.services.distribution.assembly.diagnosiskeys.util.DateTime.ONE_HOUR_INTERVAL_SECONDS; +import static java.time.ZoneOffset.UTC; +import static java.util.Collections.emptyList; + +import app.coronawarn.server.common.persistence.domain.DiagnosisKey; +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import java.time.LocalDateTime; +import java.util.Collection; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.stream.Collectors; +import org.springframework.stereotype.Component; + +/** + * An instance of this class contains a collection of {@link DiagnosisKey DiagnosisKeys}. + */ +@Component +public abstract class DiagnosisKeyBundler { + + protected final int minNumberOfKeysPerBundle; + protected final long expiryPolicyMinutes; + + // A map containing diagnosis keys, grouped by the LocalDateTime on which they may be distributed + protected final Map<LocalDateTime, List<DiagnosisKey>> distributableDiagnosisKeys = new HashMap<>(); + + public DiagnosisKeyBundler(DistributionServiceConfig distributionServiceConfig) { + this.minNumberOfKeysPerBundle = distributionServiceConfig.getShiftingPolicyThreshold(); + this.expiryPolicyMinutes = distributionServiceConfig.getExpiryPolicyMinutes(); + } + + /** + * Sets the {@link DiagnosisKey DiagnosisKeys} contained by this {@link DiagnosisKeyBundler} and calls {@link + * DiagnosisKeyBundler#createDiagnosisKeyDistributionMap}. + */ + public void setDiagnosisKeys(Collection<DiagnosisKey> diagnosisKeys) { + createDiagnosisKeyDistributionMap(diagnosisKeys); + } + + /** + * Returns all {@link DiagnosisKey DiagnosisKeys} contained by this {@link DiagnosisKeyBundler}. + */ + public List<DiagnosisKey> getAllDiagnosisKeys() { + return this.distributableDiagnosisKeys.values().stream() + .flatMap(List::stream) + .collect(Collectors.toList()); + } + + /** + * Initializes the internal {@code distributableDiagnosisKeys} map, which should contain all diagnosis keys, grouped + * by the LocalDateTime on which they may be distributed. + */ + protected abstract void createDiagnosisKeyDistributionMap(Collection<DiagnosisKey> diagnosisKeys); + + /** + * Returns all diagnosis keys that should be distributed in a specific hour. + */ + public abstract List<DiagnosisKey> getDiagnosisKeysDistributableAt(LocalDateTime hour); + + /** + * Returns the submission timestamp of a {@link DiagnosisKey} as a {@link LocalDateTime}. + */ + protected LocalDateTime getSubmissionDateTime(DiagnosisKey diagnosisKey) { + return LocalDateTime.ofEpochSecond(diagnosisKey.getSubmissionTimestamp() * ONE_HOUR_INTERVAL_SECONDS, 0, UTC); + } + + /** + * Returns all diagnosis keys that should be distributed in a specific hour. + */ + protected List<DiagnosisKey> getDiagnosisKeysForHour(LocalDateTime hour) { + return Optional + .ofNullable(this.distributableDiagnosisKeys.get(hour)) + .orElse(emptyList()); + } +} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundler.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundler.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundler.java @@ -0,0 +1,135 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.assembly.diagnosiskeys; + +import static app.coronawarn.server.services.distribution.assembly.diagnosiskeys.util.DateTime.TEN_MINUTES_INTERVAL_SECONDS; +import static java.time.ZoneOffset.UTC; +import static java.util.Collections.emptyList; +import static java.util.stream.Collectors.groupingBy; + +import app.coronawarn.server.common.persistence.domain.DiagnosisKey; +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import java.time.Duration; +import java.time.LocalDateTime; +import java.time.temporal.ChronoUnit; +import java.util.Collection; +import java.util.List; +import java.util.Optional; +import java.util.stream.Collectors; +import java.util.stream.Stream; +import org.springframework.context.annotation.Profile; + +/** + * An instance of this class contains a collection of {@link DiagnosisKey DiagnosisKeys}, that will be distributed while + * respecting expiry policy (keys must be expired for a configurable amount of time before distribution) and shifting + * policy (there must be at least a configurable number of keys in a distribution). The policies are configurable + * through the properties {@code expiry-policy-minutes} and {@code shifting-policy-threshold}. + */ +@Profile("!demo") +public class ProdDiagnosisKeyBundler extends DiagnosisKeyBundler { + + /** + * Creates a new {@link ProdDiagnosisKeyBundler}. + */ + public ProdDiagnosisKeyBundler(DistributionServiceConfig distributionServiceConfig) { + super(distributionServiceConfig); + } + + /** + * Initializes the internal {@code distributableDiagnosisKeys} map, grouping the diagnosis keys by the date on which + * they may be distributed, while respecting the expiry policy. + */ + @Override + protected void createDiagnosisKeyDistributionMap(Collection<DiagnosisKey> diagnosisKeys) { + this.distributableDiagnosisKeys.clear(); + this.distributableDiagnosisKeys.putAll(diagnosisKeys.stream().collect(groupingBy(this::getDistributionDateTime))); + } + + /** + * Returns all diagnosis keys that should be distributed in a specific hour, while respecting the shifting and expiry + * policies. + */ + @Override + public List<DiagnosisKey> getDiagnosisKeysDistributableAt(LocalDateTime hour) { + List<DiagnosisKey> keysSinceLastDistribution = getKeysSinceLastDistribution(hour); + if (keysSinceLastDistribution.size() >= minNumberOfKeysPerBundle) { + return keysSinceLastDistribution; + } else { + return emptyList(); + } + } + + /** + * Returns a all distributable keys between a specific hour and the last distribution (bundle that was above the + * shifting threshold) or the earliest distributable key. + */ + private List<DiagnosisKey> getKeysSinceLastDistribution(LocalDateTime hour) { + Optional<LocalDateTime> earliestDistributableTimestamp = getEarliestDistributableTimestamp(); + if (earliestDistributableTimestamp.isEmpty() || hour.isBefore(earliestDistributableTimestamp.get())) { + return emptyList(); + } + List<DiagnosisKey> distributableInCurrentHour = getDiagnosisKeysForHour(hour); + if (distributableInCurrentHour.size() >= minNumberOfKeysPerBundle) { + return distributableInCurrentHour; + } + LocalDateTime previousHour = hour.minusHours(1); + Collection<DiagnosisKey> distributableInPreviousHour = getDiagnosisKeysDistributableAt(previousHour); + if (distributableInPreviousHour.size() >= minNumberOfKeysPerBundle) { + // Last hour was distributed, so we can not combine the current hour with the last hour + return distributableInCurrentHour; + } else { + // Last hour was not distributed, so we can combine the current hour with the last hour + return Stream.concat(distributableInCurrentHour.stream(), getKeysSinceLastDistribution(previousHour).stream()) + .collect(Collectors.toList()); + } + } + + private Optional<LocalDateTime> getEarliestDistributableTimestamp() { + return this.distributableDiagnosisKeys.keySet().stream().min(LocalDateTime::compareTo); + } + + /** + * Returns the end of the rolling time window that a {@link DiagnosisKey} was active for as a {@link LocalDateTime}. + */ + private LocalDateTime getExpiryDateTime(DiagnosisKey diagnosisKey) { + return LocalDateTime + .ofEpochSecond(diagnosisKey.getRollingStartIntervalNumber() * TEN_MINUTES_INTERVAL_SECONDS, 0, UTC) + .plusMinutes(diagnosisKey.getRollingPeriod() * 10L); + } + + /** + * Calculates the earliest point in time at which the specified {@link DiagnosisKey} can be distributed. Before keys + * are allowed to be distributed, they must be expired for a configured amount of time. + * + * @return {@link LocalDateTime} at which the specified {@link DiagnosisKey} can be distributed. + */ + private LocalDateTime getDistributionDateTime(DiagnosisKey diagnosisKey) { + LocalDateTime submissionDateTime = getSubmissionDateTime(diagnosisKey); + LocalDateTime expiryDateTime = getExpiryDateTime(diagnosisKey); + long minutesBetweenExpiryAndSubmission = Duration.between(expiryDateTime, submissionDateTime).toMinutes(); + if (minutesBetweenExpiryAndSubmission <= expiryPolicyMinutes) { + // truncatedTo floors the value, so we need to add an hour to the DISTRIBUTION_PADDING to compensate that. + return expiryDateTime.plusMinutes(expiryPolicyMinutes + 60).truncatedTo(ChronoUnit.HOURS); + } else { + return submissionDateTime; + } + } +} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysCountryDirectory.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysCountryDirectory.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysCountryDirectory.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysCountryDirectory.java @@ -22,6 +22,7 @@ import app.coronawarn.server.common.persistence.domain.DiagnosisKey; import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.DiagnosisKeyBundler; import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory.decorator.DateAggregatingDecorator; import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory.decorator.DateIndexingDecorator; import app.coronawarn.server.services.distribution.assembly.structure.WritableOnDisk; @@ -30,12 +31,11 @@ import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; import java.time.LocalDate; -import java.util.Collection; import java.util.Set; public class DiagnosisKeysCountryDirectory extends IndexDirectoryOnDisk<String> { - private final Collection<DiagnosisKey> diagnosisKeys; + private final DiagnosisKeyBundler diagnosisKeyBundler; private final CryptoProvider cryptoProvider; private final DistributionServiceConfig distributionServiceConfig; @@ -43,14 +43,14 @@ public class DiagnosisKeysCountryDirectory extends IndexDirectoryOnDisk<String> * Constructs a {@link DiagnosisKeysCountryDirectory} instance that represents the {@code .../country/:country/...} * portion of the diagnosis key directory structure. * - * @param diagnosisKeys The diagnosis keys processed in the contained sub directories. - * @param cryptoProvider The {@link CryptoProvider} used for payload signing. + * @param diagnosisKeyBundler A {@link DiagnosisKeyBundler} containing the {@link DiagnosisKey DiagnosisKeys}. + * @param cryptoProvider The {@link CryptoProvider} used for payload signing. */ - public DiagnosisKeysCountryDirectory(Collection<DiagnosisKey> diagnosisKeys, + public DiagnosisKeysCountryDirectory(DiagnosisKeyBundler diagnosisKeyBundler, CryptoProvider cryptoProvider, DistributionServiceConfig distributionServiceConfig) { super(distributionServiceConfig.getApi().getCountryPath(), __ -> Set.of(distributionServiceConfig.getApi().getCountryGermany()), Object::toString); - this.diagnosisKeys = diagnosisKeys; + this.diagnosisKeyBundler = diagnosisKeyBundler; this.cryptoProvider = cryptoProvider; this.distributionServiceConfig = distributionServiceConfig; } @@ -58,7 +58,7 @@ public DiagnosisKeysCountryDirectory(Collection<DiagnosisKey> diagnosisKeys, @Override public void prepare(ImmutableStack<Object> indices) { this.addWritableToAll(__ -> { - DiagnosisKeysDateDirectory dateDirectory = new DiagnosisKeysDateDirectory(diagnosisKeys, cryptoProvider, + DiagnosisKeysDateDirectory dateDirectory = new DiagnosisKeysDateDirectory(diagnosisKeyBundler, cryptoProvider, distributionServiceConfig); return decorateDateDirectory(dateDirectory); }); diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectory.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectory.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectory.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectory.java @@ -22,6 +22,7 @@ import app.coronawarn.server.common.persistence.domain.DiagnosisKey; import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.DiagnosisKeyBundler; import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory.decorator.HourIndexingDecorator; import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.util.DateTime; import app.coronawarn.server.services.distribution.assembly.structure.WritableOnDisk; @@ -31,13 +32,12 @@ import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; import java.time.LocalDate; import java.time.format.DateTimeFormatter; -import java.util.Collection; public class DiagnosisKeysDateDirectory extends IndexDirectoryOnDisk<LocalDate> { private static final DateTimeFormatter ISO8601 = DateTimeFormatter.ofPattern("yyyy-MM-dd"); - private final Collection<DiagnosisKey> diagnosisKeys; + private final DiagnosisKeyBundler diagnosisKeyBundler; private final CryptoProvider cryptoProvider; private final DistributionServiceConfig distributionServiceConfig; @@ -45,14 +45,15 @@ public class DiagnosisKeysDateDirectory extends IndexDirectoryOnDisk<LocalDate> * Constructs a {@link DiagnosisKeysDateDirectory} instance associated with the specified {@link DiagnosisKey} * collection. Payload signing is be performed according to the specified {@link CryptoProvider}. * - * @param diagnosisKeys The diagnosis keys processed in the contained directories. + * @param diagnosisKeyBundler A {@link DiagnosisKeyBundler} containing the {@link DiagnosisKey DiagnosisKeys}. * @param cryptoProvider The {@link CryptoProvider} used for payload signing. */ - public DiagnosisKeysDateDirectory(Collection<DiagnosisKey> diagnosisKeys, + public DiagnosisKeysDateDirectory(DiagnosisKeyBundler diagnosisKeyBundler, CryptoProvider cryptoProvider, DistributionServiceConfig distributionServiceConfig) { - super(distributionServiceConfig.getApi().getDatePath(), __ -> DateTime.getDates(diagnosisKeys), ISO8601::format); + super(distributionServiceConfig.getApi().getDatePath(), + __ -> DateTime.getDates(diagnosisKeyBundler.getAllDiagnosisKeys()), ISO8601::format); this.cryptoProvider = cryptoProvider; - this.diagnosisKeys = diagnosisKeys; + this.diagnosisKeyBundler = diagnosisKeyBundler; this.distributionServiceConfig = distributionServiceConfig; } @@ -60,7 +61,7 @@ public DiagnosisKeysDateDirectory(Collection<DiagnosisKey> diagnosisKeys, public void prepare(ImmutableStack<Object> indices) { this.addWritableToAll(__ -> { DiagnosisKeysHourDirectory hourDirectory = - new DiagnosisKeysHourDirectory(diagnosisKeys, cryptoProvider, distributionServiceConfig); + new DiagnosisKeysHourDirectory(diagnosisKeyBundler, cryptoProvider, distributionServiceConfig); return decorateHourDirectory(hourDirectory); }); super.prepare(indices); diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDirectory.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDirectory.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDirectory.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDirectory.java @@ -22,6 +22,7 @@ import app.coronawarn.server.common.persistence.domain.DiagnosisKey; import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.DiagnosisKeyBundler; import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory.decorator.CountryIndexingDecorator; import app.coronawarn.server.services.distribution.assembly.structure.WritableOnDisk; import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; @@ -31,7 +32,6 @@ import app.coronawarn.server.services.distribution.assembly.structure.directory.decorator.indexing.IndexingDecoratorOnDisk; import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; -import java.util.Collection; /** * A {@link Directory} containing the file and directory structure that mirrors the API defined in the OpenAPI @@ -42,7 +42,7 @@ */ public class DiagnosisKeysDirectory extends DirectoryOnDisk { - private final Collection<DiagnosisKey> diagnosisKeys; + private final DiagnosisKeyBundler diagnosisKeyBundler; private final CryptoProvider cryptoProvider; private final DistributionServiceConfig distributionServiceConfig; @@ -50,13 +50,13 @@ public class DiagnosisKeysDirectory extends DirectoryOnDisk { * Constructs a {@link DiagnosisKeysDirectory} based on the specified {@link DiagnosisKey} collection. Cryptographic * signing is performed using the specified {@link CryptoProvider}. * - * @param diagnosisKeys The diagnosis keys processed in the contained sub directories. - * @param cryptoProvider The {@link CryptoProvider} used for payload signing. + * @param diagnosisKeyBundler A {@link DiagnosisKeyBundler} containing the {@link DiagnosisKey DiagnosisKeys}. + * @param cryptoProvider The {@link CryptoProvider} used for payload signing. */ - public DiagnosisKeysDirectory(Collection<DiagnosisKey> diagnosisKeys, CryptoProvider cryptoProvider, + public DiagnosisKeysDirectory(DiagnosisKeyBundler diagnosisKeyBundler, CryptoProvider cryptoProvider, DistributionServiceConfig distributionServiceConfig) { super(distributionServiceConfig.getApi().getDiagnosisKeysPath()); - this.diagnosisKeys = diagnosisKeys; + this.diagnosisKeyBundler = diagnosisKeyBundler; this.cryptoProvider = cryptoProvider; this.distributionServiceConfig = distributionServiceConfig; } @@ -64,7 +64,7 @@ public DiagnosisKeysDirectory(Collection<DiagnosisKey> diagnosisKeys, CryptoProv @Override public void prepare(ImmutableStack<Object> indices) { this.addWritable(decorateCountryDirectory( - new DiagnosisKeysCountryDirectory(diagnosisKeys, cryptoProvider, distributionServiceConfig))); + new DiagnosisKeysCountryDirectory(diagnosisKeyBundler, cryptoProvider, distributionServiceConfig))); super.prepare(indices); } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectory.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectory.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectory.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectory.java @@ -22,6 +22,7 @@ import app.coronawarn.server.common.persistence.domain.DiagnosisKey; import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.DiagnosisKeyBundler; import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.archive.decorator.singing.DiagnosisKeySigningDecorator; import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.file.TemporaryExposureKeyExportFile; import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.util.DateTime; @@ -36,28 +37,25 @@ import java.time.LocalDate; import java.time.LocalDateTime; import java.time.ZoneOffset; -import java.util.Collection; -import java.util.Set; -import java.util.stream.Collectors; +import java.util.List; public class DiagnosisKeysHourDirectory extends IndexDirectoryOnDisk<LocalDateTime> { - private final Collection<DiagnosisKey> diagnosisKeys; + private final DiagnosisKeyBundler diagnosisKeyBundler; private final CryptoProvider cryptoProvider; private final DistributionServiceConfig distributionServiceConfig; /** * Constructs a {@link DiagnosisKeysHourDirectory} instance for the specified date. * - * @param diagnosisKeys A collection of diagnosis keys. These will be filtered according to the specified current - * date. - * @param cryptoProvider The {@link CryptoProvider} used for cryptographic signing. + * @param diagnosisKeyBundler A {@link DiagnosisKeyBundler} containing the {@link DiagnosisKey DiagnosisKeys}. + * @param cryptoProvider The {@link CryptoProvider} used for cryptographic signing. */ - public DiagnosisKeysHourDirectory(Collection<DiagnosisKey> diagnosisKeys, CryptoProvider cryptoProvider, + public DiagnosisKeysHourDirectory(DiagnosisKeyBundler diagnosisKeyBundler, CryptoProvider cryptoProvider, DistributionServiceConfig distributionServiceConfig) { - super(distributionServiceConfig.getApi().getHourPath(), - indices -> DateTime.getHours(((LocalDate) indices.peek()), diagnosisKeys), LocalDateTime::getHour); - this.diagnosisKeys = diagnosisKeys; + super(distributionServiceConfig.getApi().getHourPath(), indices -> DateTime.getHours(((LocalDate) indices.peek()), + diagnosisKeyBundler.getAllDiagnosisKeys()), LocalDateTime::getHour); + this.diagnosisKeyBundler = diagnosisKeyBundler; this.cryptoProvider = cryptoProvider; this.distributionServiceConfig = distributionServiceConfig; } @@ -71,7 +69,8 @@ public void prepare(ImmutableStack<Object> indices) { // IndexDirectory. String region = (String) currentIndices.pop().pop().peek(); - Set<DiagnosisKey> diagnosisKeysForCurrentHour = getDiagnosisKeysForHour(currentHour); + List<DiagnosisKey> diagnosisKeysForCurrentHour = + this.diagnosisKeyBundler.getDiagnosisKeysDistributableAt(currentHour); long startTimestamp = currentHour.toEpochSecond(ZoneOffset.UTC); long endTimestamp = currentHour.plusHours(1).toEpochSecond(ZoneOffset.UTC); @@ -86,12 +85,6 @@ public void prepare(ImmutableStack<Object> indices) { super.prepare(indices); } - private Set<DiagnosisKey> getDiagnosisKeysForHour(LocalDateTime hour) { - return this.diagnosisKeys.stream() - .filter(diagnosisKey -> DistributionDateTimeCalculator.getDistributionDateTime(diagnosisKey).equals(hour)) - .collect(Collectors.toSet()); - } - private Directory<WritableOnDisk> decorateDiagnosisKeyArchive(Archive<WritableOnDisk> archive) { return new DiagnosisKeySigningDecorator(archive, cryptoProvider, distributionServiceConfig); } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DistributionDateTimeCalculator.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DistributionDateTimeCalculator.java deleted file mode 100644 --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DistributionDateTimeCalculator.java +++ /dev/null @@ -1,62 +0,0 @@ -/*- - * ---license-start - * Corona-Warn-App - * --- - * Copyright (C) 2020 SAP SE and all other contributors - * --- - * 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 - * - * http://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. - * ---license-end - */ - -package app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory; - -import static app.coronawarn.server.services.distribution.assembly.diagnosiskeys.util.DateTime.ONE_HOUR_INTERVAL_SECONDS; -import static app.coronawarn.server.services.distribution.assembly.diagnosiskeys.util.DateTime.TEN_MINUTES_INTERVAL_SECONDS; -import static java.time.ZoneOffset.UTC; - -import app.coronawarn.server.common.persistence.domain.DiagnosisKey; -import java.time.Duration; -import java.time.LocalDateTime; -import java.time.temporal.ChronoUnit; - -public class DistributionDateTimeCalculator { - - /** - * Minimum time in minutes after key expiration after which it can be distributed. - */ - public static final long DISTRIBUTION_PADDING = 120L; - - private DistributionDateTimeCalculator() { - } - - /** - * Calculates the earliest point in time at which the specified {@link DiagnosisKey} can be distributed. Before keys - * are allowed to be distributed, they must be expired for a configured amount of time. - * - * @return {@link LocalDateTime} at which the specified {@link DiagnosisKey} can be distributed. - */ - public static LocalDateTime getDistributionDateTime(DiagnosisKey diagnosisKey) { - LocalDateTime submissionDateTime = LocalDateTime - .ofEpochSecond(diagnosisKey.getSubmissionTimestamp() * ONE_HOUR_INTERVAL_SECONDS, 0, UTC); - LocalDateTime keyExpiryDateTime = LocalDateTime - .ofEpochSecond(diagnosisKey.getRollingStartIntervalNumber() * TEN_MINUTES_INTERVAL_SECONDS, 0, UTC) - .plusMinutes(diagnosisKey.getRollingPeriod() * 10L); - - if (Duration.between(keyExpiryDateTime, submissionDateTime).toMinutes() <= DISTRIBUTION_PADDING) { - // truncatedTo floors the value, so we need to add an hour to the DISTRIBUTION_PADDING to compensate that. - return keyExpiryDateTime.plusMinutes(DISTRIBUTION_PADDING + 60).truncatedTo(ChronoUnit.HOURS); - } - - return submissionDateTime; - } -} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/config/DistributionServiceConfig.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/config/DistributionServiceConfig.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/config/DistributionServiceConfig.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/config/DistributionServiceConfig.java @@ -31,6 +31,8 @@ public class DistributionServiceConfig { private Paths paths; private TestData testData; private Integer retentionDays; + private Integer expiryPolicyMinutes; + private Integer shiftingPolicyThreshold; private String outputFileName; private Boolean includeIncompleteDays; private Boolean includeIncompleteHours; @@ -63,6 +65,22 @@ public void setRetentionDays(Integer retentionDays) { this.retentionDays = retentionDays; } + public Integer getExpiryPolicyMinutes() { + return expiryPolicyMinutes; + } + + public void setExpiryPolicyMinutes(Integer expiryPolicyMinutes) { + this.expiryPolicyMinutes = expiryPolicyMinutes; + } + + public Integer getShiftingPolicyThreshold() { + return shiftingPolicyThreshold; + } + + public void setShiftingPolicyThreshold(Integer shiftingPolicyThreshold) { + this.shiftingPolicyThreshold = shiftingPolicyThreshold; + } + public String getOutputFileName() { return outputFileName; } diff --git a/services/distribution/src/main/resources/application.yaml b/services/distribution/src/main/resources/application.yaml --- a/services/distribution/src/main/resources/application.yaml +++ b/services/distribution/src/main/resources/application.yaml @@ -11,6 +11,8 @@ services: distribution: output-file-name: index retention-days: 14 + expiry-policy-minutes: 120 + shifting-policy-threshold: 140 include-incomplete-days: false include-incomplete-hours: false paths:

diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundlerTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundlerTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundlerTest.java @@ -0,0 +1,190 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.assembly.diagnosiskeys; + +import static org.assertj.core.api.Assertions.assertThat; + +import app.coronawarn.server.common.persistence.domain.DiagnosisKey; +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import java.time.LocalDateTime; +import java.util.List; +import java.util.stream.Collectors; +import java.util.stream.IntStream; +import java.util.stream.Stream; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Nested; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.ValueSource; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.boot.test.context.ConfigFileApplicationContextInitializer; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit.jupiter.SpringExtension; + +@EnableConfigurationProperties(value = DistributionServiceConfig.class) +@ExtendWith(SpringExtension.class) +@ContextConfiguration(classes = {DistributionServiceConfig.class, ProdDiagnosisKeyBundler.class}, + initializers = ConfigFileApplicationContextInitializer.class) +class ProdDiagnosisKeyBundlerTest { + + @Autowired + DistributionServiceConfig distributionServiceConfig; + + @Autowired + DiagnosisKeyBundler bundler; + + @Test + void testEmptyListWhenNoDiagnosisKeys() { + bundler.setDiagnosisKeys(List.of()); + assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 1, 0, 0, 0))).hasSize(0); + } + + @Test + void testEmptyListWhenGettingDistributableKeysBeforeEarliestDiagnosisKey() { + List<DiagnosisKey> diagnosisKeys = buildDiagnosisKeys(6, 50L, 5); + bundler.setDiagnosisKeys(diagnosisKeys); + assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 1, 0, 0, 0))).hasSize(0); + } + + @Nested + @DisplayName("Expiry policy") + class ProdDiagnosisKeyBundlerExpiryPolicyTest { + + @ParameterizedTest + @ValueSource(longs = {0L, 24L, 24L + 2L}) + void testLastPeriodOfHourAndSubmissionLessThanDistributionDateTime(long submissionTimestamp) { + List<DiagnosisKey> diagnosisKeys = buildDiagnosisKeys(5, submissionTimestamp, 10); + bundler.setDiagnosisKeys(diagnosisKeys); + assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 2, 3, 0, 0))).hasSize(10); + } + + @Test + void testLastPeriodOfHourAndSubmissionEqualsDistributionDateTime() { + List<DiagnosisKey> diagnosisKeys = buildDiagnosisKeys(5, 24L + 3L, 10); + bundler.setDiagnosisKeys(diagnosisKeys); + assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 2, 3, 0, 0))).hasSize(10); + } + + @ParameterizedTest + @ValueSource(longs = {0L, 24L, 24L + 2L, 24L + 3L}) + void testFirstPeriodOfHourAndSubmissionLessThanDistributionDateTime(long submissionTimestamp) { + List<DiagnosisKey> diagnosisKeys = buildDiagnosisKeys(6, submissionTimestamp, 10); + bundler.setDiagnosisKeys(diagnosisKeys); + assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 2, 4, 0, 0))).hasSize(10); + } + + @Test + void testFirstPeriodOfHourAndSubmissionEqualsDistributionDateTime() { + List<DiagnosisKey> diagnosisKeys = buildDiagnosisKeys(6, 24L + 4L, 10); + bundler.setDiagnosisKeys(diagnosisKeys); + assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 2, 4, 0, 0))).hasSize(10); + } + + @Test + void testLastPeriodOfHourAndSubmissionGreaterDistributionDateTime() { + List<DiagnosisKey> diagnosisKeys = buildDiagnosisKeys(5, 24L + 4L, 10); + bundler.setDiagnosisKeys(diagnosisKeys); + assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 2, 4, 0, 0))).hasSize(10); + } + } + + @Nested + @DisplayName("Shifting policy") + class ProdDiagnosisKeyBundlerShiftingPolicyTest { + + @Test + void testDoesNotShiftIfPackageSizeGreaterThanThreshold() { + List<DiagnosisKey> diagnosisKeys = buildDiagnosisKeys(6, 50L, 6); + bundler.setDiagnosisKeys(diagnosisKeys); + assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 2, 0, 0))).hasSize(6); + } + + @Test + void testDoesNotShiftIfPackageSizeEqualsThreshold() { + List<DiagnosisKey> diagnosisKeys = buildDiagnosisKeys(6, 50L, 5); + bundler.setDiagnosisKeys(diagnosisKeys); + assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 2, 0, 0))).hasSize(5); + } + + @Test + void testShiftsIfPackageSizeLessThanThreshold() { + List<DiagnosisKey> diagnosisKeys = Stream + .concat(buildDiagnosisKeys(6, 50L, 4).stream(), buildDiagnosisKeys(6, 51L, 1).stream()) + .collect(Collectors.toList()); + bundler.setDiagnosisKeys(diagnosisKeys); + assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 2, 0, 0))).hasSize(0); + assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 3, 0, 0))).hasSize(5); + } + + @Test + void testShiftsSinceLastDistribution() { + List<DiagnosisKey> diagnosisKeys = Stream + .of(buildDiagnosisKeys(6, 50L, 5), buildDiagnosisKeys(6, 51L, 2), buildDiagnosisKeys(6, 52L, 4)) + .flatMap(List::stream) + .collect(Collectors.toList()); + bundler.setDiagnosisKeys(diagnosisKeys); + assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 2, 0, 0))).hasSize(5); + assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 3, 0, 0))).hasSize(0); + assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 4, 0, 0))).hasSize(6); + assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 5, 0, 0))).hasSize(0); + } + + @Test + void testShiftIncludesPreviouslyUndistributedKeys() { + List<DiagnosisKey> diagnosisKeys = Stream + .concat(buildDiagnosisKeys(6, 50L, 1).stream(), buildDiagnosisKeys(6, 51L, 5).stream()) + .collect(Collectors.toList()); + bundler.setDiagnosisKeys(diagnosisKeys); + assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 2, 0, 0))).hasSize(0); + assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 3, 0, 0))).hasSize(5); + } + + @Test + void testShiftsSparseDistributions() { + List<DiagnosisKey> diagnosisKeys = Stream + .of(buildDiagnosisKeys(6, 50L, 1), buildDiagnosisKeys(6, 51L, 1), buildDiagnosisKeys(6, 52L, 1), + buildDiagnosisKeys(6, 53L, 0), buildDiagnosisKeys(6, 54L, 0), buildDiagnosisKeys(6, 55L, 1), + buildDiagnosisKeys(6, 56L, 1)) + .flatMap(List::stream) + .collect(Collectors.toList()); + bundler.setDiagnosisKeys(diagnosisKeys); + assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 2, 0, 0))).hasSize(0); + assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 3, 0, 0))).hasSize(0); + assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 4, 0, 0))).hasSize(0); + assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 5, 0, 0))).hasSize(0); + assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 6, 0, 0))).hasSize(0); + assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 7, 0, 0))).hasSize(0); + assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 8, 0, 0))).hasSize(5); + } + } + + public static List<DiagnosisKey> buildDiagnosisKeys(int startIntervalNumber, long submissionTimestamp, int number) { + return IntStream.range(0, number) + .mapToObj(__ -> DiagnosisKey.builder() + .withKeyData(new byte[16]) + .withRollingStartIntervalNumber(startIntervalNumber) + .withTransmissionRiskLevel(2) + .withSubmissionTimestamp(submissionTimestamp).build()) + .collect(Collectors.toList()); + } +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDirectoryTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDirectoryTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDirectoryTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDirectoryTest.java @@ -26,6 +26,8 @@ import app.coronawarn.server.common.persistence.domain.DiagnosisKey; import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.DemoDiagnosisKeyBundler; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.DiagnosisKeyBundler; import app.coronawarn.server.services.distribution.assembly.structure.WritableOnDisk; import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; import app.coronawarn.server.services.distribution.assembly.structure.directory.DirectoryOnDisk; @@ -33,7 +35,6 @@ import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; import java.io.File; import java.io.IOException; -import java.util.ArrayList; import java.util.Arrays; import java.util.List; import java.util.Objects; @@ -90,8 +91,8 @@ void setupAll() throws IOException { @Test void checkBuildsTheCorrectDirectoryStructureWhenNoKeys() { - diagnosisKeys = new ArrayList<>(); - Directory<WritableOnDisk> directory = new DiagnosisKeysDirectory(diagnosisKeys, cryptoProvider, + DiagnosisKeyBundler bundler = new DemoDiagnosisKeyBundler(distributionServiceConfig); + Directory<WritableOnDisk> directory = new DiagnosisKeysDirectory(bundler, cryptoProvider, distributionServiceConfig); parentDirectory.addWritable(directory); directory.prepare(new ImmutableStack<>()); @@ -111,7 +112,9 @@ void checkBuildsTheCorrectDirectoryStructureWhenNoKeys() { @Test void checkBuildsTheCorrectDirectoryStructure() { - Directory<WritableOnDisk> directory = new DiagnosisKeysDirectory(diagnosisKeys, cryptoProvider, + DiagnosisKeyBundler bundler = new DemoDiagnosisKeyBundler(distributionServiceConfig); + bundler.setDiagnosisKeys(diagnosisKeys); + Directory<WritableOnDisk> directory = new DiagnosisKeysDirectory(bundler, cryptoProvider, distributionServiceConfig); parentDirectory.addWritable(directory); directory.prepare(new ImmutableStack<>()); diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/DistributionDateTimeCalculatorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/DistributionDateTimeCalculatorTest.java deleted file mode 100644 --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/DistributionDateTimeCalculatorTest.java +++ /dev/null @@ -1,72 +0,0 @@ -/*- - * ---license-start - * Corona-Warn-App - * --- - * Copyright (C) 2020 SAP SE and all other contributors - * --- - * 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 - * - * http://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. - * ---license-end - */ - -package app.coronawarn.server.services.distribution.assembly.structure.directory; - -import static app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory.DistributionDateTimeCalculator.getDistributionDateTime; -import static org.assertj.core.api.Assertions.assertThat; - -import app.coronawarn.server.common.persistence.domain.DiagnosisKey; -import org.junit.jupiter.api.Test; -import org.junit.jupiter.params.ParameterizedTest; -import org.junit.jupiter.params.provider.ValueSource; - -class DistributionDateTimeCalculatorTest { - - @ParameterizedTest - @ValueSource(longs = {0L, 24L, 24L + 2L}) - void testLastPeriodOfHourAndSubmissionLessThanDistributionDateTime(long submissionTimestamp) { - var diagnosisKey = buildDiagnosisKey(5, submissionTimestamp); - assertThat(getDistributionDateTime(diagnosisKey)).isEqualTo("1970-01-02T03:00"); - } - - @Test - void testLastPeriodOfHourAndSubmissionEqualsDistributionDateTime() { - var diagnosisKey = buildDiagnosisKey(5, 24L + 3L); - assertThat(getDistributionDateTime(diagnosisKey)).isEqualTo("1970-01-02T03:00"); - } - - @ParameterizedTest - @ValueSource(longs = {0L, 24L, 24L + 2L, 24L + 3L}) - void testFirstPeriodOfHourAndSubmissionLessThanDistributionDateTime(long submissionTimestamp) { - var diagnosisKey = buildDiagnosisKey(6, submissionTimestamp); - assertThat(getDistributionDateTime(diagnosisKey)).isEqualTo("1970-01-02T04:00"); - } - - @Test - void testFirstPeriodOfHourAndSubmissionEqualsDistributionDateTime() { - var diagnosisKey = buildDiagnosisKey(6, 24L + 4L); - assertThat(getDistributionDateTime(diagnosisKey)).isEqualTo("1970-01-02T04:00"); - } - - @Test - void testLastPeriodOfHourAndSubmissionGreaterDistributionDateTime() { - var diagnosisKey = buildDiagnosisKey(5, 24L + 4L); - assertThat(getDistributionDateTime(diagnosisKey)).isEqualTo("1970-01-02T04:00"); - } - - private DiagnosisKey buildDiagnosisKey(int startIntervalNumber, long submissionTimestamp) { - return DiagnosisKey.builder() - .withKeyData(new byte[16]) - .withRollingStartIntervalNumber(startIntervalNumber) - .withTransmissionRiskLevel(2) - .withSubmissionTimestamp(submissionTimestamp).build(); - } -} diff --git a/services/distribution/src/test/resources/application.yaml b/services/distribution/src/test/resources/application.yaml --- a/services/distribution/src/test/resources/application.yaml +++ b/services/distribution/src/test/resources/application.yaml @@ -9,6 +9,8 @@ services: distribution: output-file-name: index retention-days: 14 + expiry-policy-minutes: 120 + shifting-policy-threshold: 5 include-incomplete-days: false include-incomplete-hours: false paths:

Aggregate File Creation: Skip packages if payload too small Change the aggregate file creation logic in a way, in which packages are skipped in case the payload (amount of keys) is too small. The threshold should be configurable, and defaulted to 50 for now.

Maybe combine with #140 **Alternative suggestion: Pad packages with random dummy keys if too small** Thinking a bit further into the hoped for future, when new infections are becoming rare, this might lead to unnecessary (possibly quite long) delays in notifications being sent. Could one instead use random dummy keys to pad every package that is too small to maybe 50 or 100 keys (or possibly padding to a randomised amount so an outsider can't even determine whether there any dummies are in the set). This would impact required data volumes marginally - in the worst case, if 75 dummy keys are added every hour, this would represent only 50 kiB per day (or 3% of your bandwidth example in the architecture document) if I did not miscalculate. Since this would only occur in a low load situation anyway, this should be acceptable. Threhold is now: 140 I like the padding idea - @MKusber do you think we can do this from a DPP/security perspective? Hey @MikeJayDee, after some investigation, @michael-burwig and me decided that we will go for the "shifting" approach instead of the "padding" approach for this release. For clarification: **"Shifting" approach:** - If a package is too small (number of keys submitted in a timeframe is below a configurable threshold), then it will not be distributed (there will be zero keys in that package) - The keys that would have been distributed in that run are "shifted" to the next distribution run - Rinse and repeat until a package can be assembled that contains enough keys (above the configurable threshold) **"Padding" approach:** - If a package is too small, then it will be padded with random / fake keys until the threshold is matched (or exceeded) As you have rightly pointed out, the main disadvantage of the "shifting" approach is that it introduces an artificial delay in the distribution of keys. This means that people will not be warned about a potential COVID exposure as quickly as possible, but that the CWA server will wait with the distribution until enough submissions have been made. Especially as the number of submissions decreases, this delay will become significant. This disadvantage, of course, doesn't exist with the "padding" approach. However, the purpose of this whole "threshold" feature is to preserve peoples anonymity and to not allow anyone to create movement profiles. In order to achieve that, it must be impossible to match a specific temporary exposure key (TEK) to any particular person. In the "shifting" approach, this is achieved by ensuring that a single person's TEKs are always mashed together with enough other people's real TEKs to get lost in the shuffle. In the "padding" approach, this is achieved by mashing a single person's TEKs together with artificially/randomly generated TEKs. In order to make the "padding" approach equally as secure and privacy preserving, we would need to make real TEKs and artificially/randomly generated TEKs absolutely indistinguishable from one another. We decided for the "shifting" approach for this release because we are not 100% certain that we can achieve that - for the following reasons: There are 4 fields in a TEK: - Key data - Transmission risk level - Rolling start interval number - Rolling period "Key data" is random by nature and can easily be generated - no problem there. "Rolling period" is always 144 - no problem here either. However, in the real world, "transmission risk levels" and "rolling start interval numbers" each follow some statistical distribution. In order to make real and fake TEKs indistinguishable to any reasonably certainty, we would need to make sure, that the fake TEKs follow the same distribution as the real ones. The problem is, that we are not sure what the exact properties of that distribution are (and how they change over time). We can thus not confidently guarantee that one wouldn't be able to distinguish random and real TEKs through statistical analysis. Since data privacy and protection are the foundation of this whole project, we decided to not take this risk and go with the safer but less accurate solution. Now, it might be entirely possible that there is a solution to this problem that we just don't see. But since time is of the essence right now (and we can not wait for a scientifically substantiated analysis of the "padding" approach), we decided to go for the "shifting" approach for the initial release. Anyways. Thank you very much for sharing your idea, @MikeJayDee. We forwarded your idea and the open questions outlined above to our scientific partners and will keep you posted on any updates 👍

corona-warn-app/cwa-server

corona-warn-app__cwa-server-419

896d24d3730d455ddc7a67bdaebd843ba7bd91dd

diff --git a/services/distribution/pom.xml b/services/distribution/pom.xml --- a/services/distribution/pom.xml +++ b/services/distribution/pom.xml @@ -78,6 +78,11 @@ <groupId>org.apache.commons</groupId> <version>3.2</version> </dependency> + <dependency> + <artifactId>spring-retry</artifactId> + <groupId>org.springframework.retry</groupId> + <version>1.3.0</version> + </dependency> </dependencies> </project> \ No newline at end of file diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/config/DistributionServiceConfig.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/config/DistributionServiceConfig.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/config/DistributionServiceConfig.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/config/DistributionServiceConfig.java @@ -394,6 +394,7 @@ public static class ObjectStore { private Integer port; private String bucket; private Boolean setPublicReadAclOnPutObject; + private Integer maxNumberOfFailedOperations; public String getAccessKey() { return accessKey; @@ -442,5 +443,13 @@ public Boolean isSetPublicReadAclOnPutObject() { public void setSetPublicReadAclOnPutObject(Boolean setPublicReadAclOnPutObject) { this.setPublicReadAclOnPutObject = setPublicReadAclOnPutObject; } + + public Integer getMaxNumberOfFailedOperations() { + return maxNumberOfFailedOperations; + } + + public void setMaxNumberOfFailedOperations(Integer maxNumberOfFailedOperations) { + this.maxNumberOfFailedOperations = maxNumberOfFailedOperations; + } } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/FailedObjectStoreOperationsCounter.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/FailedObjectStoreOperationsCounter.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/FailedObjectStoreOperationsCounter.java @@ -0,0 +1,58 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.objectstore; + +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import app.coronawarn.server.services.distribution.objectstore.client.ObjectStoreOperationFailedException; +import java.util.concurrent.atomic.AtomicInteger; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.stereotype.Component; + +/** + * Maintains the count and maximum number of failed object store operations in a thread-safe manner. + */ +@Component +public class FailedObjectStoreOperationsCounter { + + private static final Logger logger = LoggerFactory.getLogger(FailedObjectStoreOperationsCounter.class); + + private final int maxNumberOfFailedOperations; + private final AtomicInteger failedOperationsCounter = new AtomicInteger(0); + + public FailedObjectStoreOperationsCounter(DistributionServiceConfig distributionServiceConfig) { + maxNumberOfFailedOperations = distributionServiceConfig.getObjectStore().getMaxNumberOfFailedOperations(); + } + + /** + * Increments the internal failed operations counter and rethrows the specified exception if the configured maximum + * number of failed object store operation was exceeded. + * + * @param cause The {@link ObjectStoreOperationFailedException} that is associated with the failed operation. + */ + public void incrementAndCheckThreshold(ObjectStoreOperationFailedException cause) { + logger.error("Object store operation failed.", cause); + if (failedOperationsCounter.incrementAndGet() > maxNumberOfFailedOperations) { + logger.error("Number of failed object store operations exceeded threshold of {}.", maxNumberOfFailedOperations); + throw cause; + } + } +} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3Publisher.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3Publisher.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3Publisher.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3Publisher.java @@ -21,11 +21,13 @@ package app.coronawarn.server.services.distribution.objectstore; import app.coronawarn.server.services.distribution.assembly.component.CwaApiStructureProvider; +import app.coronawarn.server.services.distribution.objectstore.client.ObjectStoreOperationFailedException; import app.coronawarn.server.services.distribution.objectstore.publish.LocalFile; import app.coronawarn.server.services.distribution.objectstore.publish.PublishFileSet; import app.coronawarn.server.services.distribution.objectstore.publish.PublishedFileSet; import java.io.IOException; import java.nio.file.Path; +import java.util.List; import java.util.stream.Collectors; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -48,18 +50,29 @@ public class S3Publisher { private static final Logger logger = LoggerFactory.getLogger(S3Publisher.class); - /** The default CWA root folder, which contains all CWA related files. */ + /** + * The default CWA root folder, which contains all CWA related files. + */ private static final String CWA_S3_ROOT = CwaApiStructureProvider.VERSION_DIRECTORY; - /** root folder for the upload on the local disk. */ private final Path root; + private final ObjectStoreAccess objectStoreAccess; + private final FailedObjectStoreOperationsCounter failedOperationsCounter; - /** access to the object store. */ - private final ObjectStoreAccess access; - - public S3Publisher(Path root, ObjectStoreAccess access) { + /** + * Creates an {@link S3Publisher} instance that attempts to publish the files at the specified location to an object + * store. Object store operations are performed through the specified {@link ObjectStoreAccess} instance. + * + * @param root The path of the directory that shall be published. + * @param objectStoreAccess The {@link ObjectStoreAccess} used to communicate with the object store. + * @param failedOperationsCounter The {@link FailedObjectStoreOperationsCounter} that is used to monitor the number of + * failed operations. + */ + public S3Publisher(Path root, ObjectStoreAccess objectStoreAccess, + FailedObjectStoreOperationsCounter failedOperationsCounter) { this.root = root; - this.access = access; + this.objectStoreAccess = objectStoreAccess; + this.failedOperationsCounter = failedOperationsCounter; } /** @@ -68,18 +81,29 @@ public S3Publisher(Path root, ObjectStoreAccess access) { * @throws IOException in case there were problems reading files from the disk. */ public void publish() throws IOException { - var published = new PublishedFileSet(access.getObjectsWithPrefix(CWA_S3_ROOT)); - var toPublish = new PublishFileSet(root); + PublishedFileSet published; + List<LocalFile> toPublish = new PublishFileSet(root).getFiles(); + List<LocalFile> diff; - var diff = toPublish - .getFiles() - .stream() - .filter(published::isNotYetPublished) - .collect(Collectors.toList()); + try { + published = new PublishedFileSet(objectStoreAccess.getObjectsWithPrefix(CWA_S3_ROOT)); + diff = toPublish + .stream() + .filter(published::isNotYetPublished) + .collect(Collectors.toList()); + } catch (ObjectStoreOperationFailedException e) { + failedOperationsCounter.incrementAndCheckThreshold(e); + // failed to retrieve existing files; publish everything + diff = toPublish; + } logger.info("Beginning upload... "); for (LocalFile file : diff) { - this.access.putObject(file); + try { + this.objectStoreAccess.putObject(file); + } catch (ObjectStoreOperationFailedException e) { + failedOperationsCounter.incrementAndCheckThreshold(e); + } } logger.info("Upload completed."); } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3RetentionPolicy.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3RetentionPolicy.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3RetentionPolicy.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3RetentionPolicy.java @@ -22,6 +22,7 @@ import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; import app.coronawarn.server.services.distribution.config.DistributionServiceConfig.Api; +import app.coronawarn.server.services.distribution.objectstore.client.ObjectStoreOperationFailedException; import app.coronawarn.server.services.distribution.objectstore.client.S3Object; import java.time.LocalDate; import java.time.ZoneOffset; @@ -39,10 +40,16 @@ public class S3RetentionPolicy { private final ObjectStoreAccess objectStoreAccess; private final Api api; + private final FailedObjectStoreOperationsCounter failedObjectStoreOperationsCounter; - public S3RetentionPolicy(ObjectStoreAccess objectStoreAccess, DistributionServiceConfig distributionServiceConfig) { + /** + * Creates an {@link S3RetentionPolicy} instance with the specified parameters. + */ + public S3RetentionPolicy(ObjectStoreAccess objectStoreAccess, DistributionServiceConfig distributionServiceConfig, + FailedObjectStoreOperationsCounter failedOperationsCounter) { this.objectStoreAccess = objectStoreAccess; this.api = distributionServiceConfig.getApi(); + this.failedObjectStoreOperationsCounter = failedOperationsCounter; } /** @@ -77,6 +84,10 @@ public void applyRetentionPolicy(int retentionDays) { * @param diagnosisKey the diagnosis key, that should be deleted. */ public void deleteDiagnosisKey(S3Object diagnosisKey) { - objectStoreAccess.deleteObjectsWithPrefix(diagnosisKey.getObjectName()); + try { + objectStoreAccess.deleteObjectsWithPrefix(diagnosisKey.getObjectName()); + } catch (ObjectStoreOperationFailedException e) { + failedObjectStoreOperationsCounter.incrementAndCheckThreshold(e); + } } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/ObjectStoreClientConfig.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/ObjectStoreClientConfig.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/ObjectStoreClientConfig.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/ObjectStoreClientConfig.java @@ -25,6 +25,7 @@ import java.net.URI; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; +import org.springframework.retry.annotation.EnableRetry; import software.amazon.awssdk.auth.credentials.AwsBasicCredentials; import software.amazon.awssdk.auth.credentials.AwsCredentialsProvider; import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider; @@ -35,6 +36,7 @@ * Manages the instantiation of the {@link ObjectStoreClient} bean. */ @Configuration +@EnableRetry public class ObjectStoreClientConfig { private static final Region DEFAULT_REGION = Region.EU_CENTRAL_1; diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapper.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapper.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapper.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapper.java @@ -28,6 +28,10 @@ import java.util.Map; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +import org.springframework.retry.annotation.Backoff; +import org.springframework.retry.annotation.Recover; +import org.springframework.retry.annotation.Retryable; +import org.springframework.retry.support.RetrySynchronizationManager; import software.amazon.awssdk.core.exception.SdkException; import software.amazon.awssdk.core.sync.RequestBody; import software.amazon.awssdk.services.s3.S3Client; @@ -67,18 +71,29 @@ public boolean bucketExists(String bucketName) { } @Override + @Retryable( + value = SdkException.class, + maxAttemptsExpression = "${services.distribution.objectstore.retry-attempts}", + backoff = @Backoff(delayExpression = "${services.distribution.objectstore.retry-backoff}")) public List<S3Object> getObjects(String bucket, String prefix) { - try { - ListObjectsV2Response response = - s3Client.listObjectsV2(ListObjectsV2Request.builder().prefix(prefix).bucket(bucket).build()); - return response.contents().stream().map(S3ClientWrapper::buildS3Object).collect(toList()); - } catch (SdkException e) { - throw new ObjectStoreOperationFailedException("Failed to upload object to object store", e); - } + logRetryStatus("object download"); + ListObjectsV2Response response = + s3Client.listObjectsV2(ListObjectsV2Request.builder().prefix(prefix).bucket(bucket).build()); + return response.contents().stream().map(S3ClientWrapper::buildS3Object).collect(toList()); + } + + @Recover + public List<S3Object> skipReadOperation(Throwable cause) { + throw new ObjectStoreOperationFailedException("Failed to get objects from object store", cause); } @Override + @Retryable( + value = SdkException.class, + maxAttemptsExpression = "${services.distribution.objectstore.retry-attempts}", + backoff = @Backoff(delayExpression = "${services.distribution.objectstore.retry-backoff}")) public void putObject(String bucket, String objectName, Path filePath, Map<HeaderKey, String> headers) { + logRetryStatus("object upload"); RequestBody bodyFile = RequestBody.fromFile(filePath); var requestBuilder = PutObjectRequest.builder().bucket(bucket).key(objectName); @@ -89,40 +104,46 @@ public void putObject(String bucket, String objectName, Path filePath, Map<Heade requestBuilder.cacheControl(headers.get(HeaderKey.CACHE_CONTROL)); } - try { - s3Client.putObject(requestBuilder.build(), bodyFile); - } catch (SdkException e) { - throw new ObjectStoreOperationFailedException("Failed to upload object to object store", e); - } + s3Client.putObject(requestBuilder.build(), bodyFile); } @Override + @Retryable(value = {SdkException.class, ObjectStoreOperationFailedException.class}, + maxAttemptsExpression = "${services.distribution.objectstore.retry-attempts}", + backoff = @Backoff(delayExpression = "${services.distribution.objectstore.retry-backoff}")) public void removeObjects(String bucket, List<String> objectNames) { if (objectNames.isEmpty()) { return; } + logRetryStatus("object deletion"); Collection<ObjectIdentifier> identifiers = objectNames.stream() .map(key -> ObjectIdentifier.builder().key(key).build()).collect(toList()); - try { - DeleteObjectsResponse response = s3Client.deleteObjects( - DeleteObjectsRequest.builder() - .bucket(bucket) - .delete(Delete.builder().objects(identifiers).build()).build()); - - if (response.hasErrors()) { - String errMessage = "Failed to remove objects from object store."; - logger.error("{} {}", errMessage, response.errors()); - throw new ObjectStoreOperationFailedException(errMessage); - } - } catch (SdkException e) { - throw new ObjectStoreOperationFailedException("Failed to remove objects from object store.", e); + DeleteObjectsResponse response = s3Client.deleteObjects( + DeleteObjectsRequest.builder() + .bucket(bucket) + .delete(Delete.builder().objects(identifiers).build()).build()); + + if (response.hasErrors()) { + throw new ObjectStoreOperationFailedException("Failed to remove objects from object store."); } } + @Recover + private void skipModifyingOperation(Throwable cause) { + throw new ObjectStoreOperationFailedException("Failed to modify objects on object store.", cause); + } + private static S3Object buildS3Object(software.amazon.awssdk.services.s3.model.S3Object s3Object) { String etag = s3Object.eTag().replaceAll("\"", ""); return new S3Object(s3Object.key(), etag); } + + private void logRetryStatus(String action) { + int retryCount = RetrySynchronizationManager.getContext().getRetryCount(); + if (retryCount > 0) { + logger.warn("Retrying {} after {} failed attempt(s).", action, retryCount); + } + } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/S3Distribution.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/S3Distribution.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/S3Distribution.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/S3Distribution.java @@ -21,6 +21,7 @@ package app.coronawarn.server.services.distribution.runner; import app.coronawarn.server.services.distribution.assembly.component.OutputDirectoryProvider; +import app.coronawarn.server.services.distribution.objectstore.FailedObjectStoreOperationsCounter; import app.coronawarn.server.services.distribution.objectstore.ObjectStoreAccess; import app.coronawarn.server.services.distribution.objectstore.S3Publisher; import app.coronawarn.server.services.distribution.objectstore.client.ObjectStoreOperationFailedException; @@ -43,19 +44,21 @@ public class S3Distribution implements ApplicationRunner { private static final Logger logger = LoggerFactory.getLogger(S3Distribution.class); private final OutputDirectoryProvider outputDirectoryProvider; - private final ObjectStoreAccess objectStoreAccess; + private final FailedObjectStoreOperationsCounter failedOperationsCounter; - S3Distribution(OutputDirectoryProvider outputDirectoryProvider, ObjectStoreAccess objectStoreAccess) { + S3Distribution(OutputDirectoryProvider outputDirectoryProvider, ObjectStoreAccess objectStoreAccess, + FailedObjectStoreOperationsCounter failedOperationsCounter) { this.outputDirectoryProvider = outputDirectoryProvider; this.objectStoreAccess = objectStoreAccess; + this.failedOperationsCounter = failedOperationsCounter; } @Override public void run(ApplicationArguments args) { try { Path pathToDistribute = outputDirectoryProvider.getFileOnDisk().toPath().toAbsolutePath(); - S3Publisher s3Publisher = new S3Publisher(pathToDistribute, objectStoreAccess); + S3Publisher s3Publisher = new S3Publisher(pathToDistribute, objectStoreAccess, failedOperationsCounter); s3Publisher.publish(); logger.info("Data pushed to Object Store successfully."); diff --git a/services/distribution/src/main/resources/application.yaml b/services/distribution/src/main/resources/application.yaml --- a/services/distribution/src/main/resources/application.yaml +++ b/services/distribution/src/main/resources/application.yaml @@ -47,6 +47,9 @@ services: bucket: ${CWA_OBJECTSTORE_BUCKET:cwa} port: ${CWA_OBJECTSTORE_PORT:8003} set-public-read-acl-on-put-object: true + retry-attempts: 3 + retry-backoff: 2000 + max-number-of-failed-operations: 5 spring: main:

diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/ApplicationVersionConfigurationProviderMasterFileTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/ApplicationVersionConfigurationProviderMasterFileTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/ApplicationVersionConfigurationProviderMasterFileTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/ApplicationVersionConfigurationProviderMasterFileTest.java @@ -23,7 +23,6 @@ import static org.assertj.core.api.Assertions.assertThat; import app.coronawarn.server.services.distribution.assembly.appconfig.validation.ApplicationVersionConfigurationValidator; -import app.coronawarn.server.services.distribution.assembly.appconfig.validation.ExposureConfigurationValidator; import app.coronawarn.server.services.distribution.assembly.appconfig.validation.ValidationResult; import org.junit.jupiter.api.Test; diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/FailedObjectStoreOperationsCounterTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/FailedObjectStoreOperationsCounterTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/FailedObjectStoreOperationsCounterTest.java @@ -0,0 +1,58 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.objectstore; + +import static org.assertj.core.api.Assertions.assertThatCode; +import static org.assertj.core.api.Assertions.assertThatExceptionOfType; + +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import app.coronawarn.server.services.distribution.objectstore.client.ObjectStoreOperationFailedException; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.boot.test.context.ConfigFileApplicationContextInitializer; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit.jupiter.SpringExtension; + +@ExtendWith(SpringExtension.class) +@ContextConfiguration(classes = { + FailedObjectStoreOperationsCounter.class}, initializers = ConfigFileApplicationContextInitializer.class) +@EnableConfigurationProperties(value = DistributionServiceConfig.class) +class FailedObjectStoreOperationsCounterTest { + + @Autowired + private DistributionServiceConfig distributionServiceConfig; + + @Autowired + private FailedObjectStoreOperationsCounter failedObjectStoreOperationsCounter; + + @Test + void shouldThrowOnSixthAttempt() { + var exception = new ObjectStoreOperationFailedException("mock"); + for (int i = 0; i < distributionServiceConfig.getObjectStore().getMaxNumberOfFailedOperations(); i++) { + assertThatCode(() -> failedObjectStoreOperationsCounter.incrementAndCheckThreshold(exception)) + .doesNotThrowAnyException(); + } + assertThatExceptionOfType(ObjectStoreOperationFailedException.class) + .isThrownBy(() -> failedObjectStoreOperationsCounter.incrementAndCheckThreshold(exception)); + } +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccessTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccessTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccessTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccessTest.java @@ -24,7 +24,8 @@ import static org.mockito.Mockito.spy; import static org.mockito.Mockito.when; -import app.coronawarn.server.services.distribution.Application; +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import app.coronawarn.server.services.distribution.objectstore.client.ObjectStoreClientConfig; import app.coronawarn.server.services.distribution.objectstore.publish.LocalFile; import app.coronawarn.server.services.distribution.objectstore.publish.LocalGenericFile; import java.io.IOException; @@ -36,14 +37,14 @@ import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.ExtendWith; import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.boot.test.context.ConfigFileApplicationContextInitializer; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.boot.test.context.SpringBootTest; import org.springframework.core.io.ResourceLoader; -import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.junit.jupiter.SpringExtension; @ExtendWith(SpringExtension.class) -@ContextConfiguration(classes = {Application.class}, - initializers = ConfigFileApplicationContextInitializer.class) +@SpringBootTest(classes = {ObjectStoreAccess.class, ObjectStoreClientConfig.class}) +@EnableConfigurationProperties(value = DistributionServiceConfig.class) @Tag("s3-integration") class ObjectStoreAccessTest { diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherIntegrationTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherIntegrationTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherIntegrationTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherIntegrationTest.java @@ -21,6 +21,7 @@ package app.coronawarn.server.services.distribution.objectstore; import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.Mockito.mock; import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; import app.coronawarn.server.services.distribution.objectstore.client.ObjectStoreClientConfig; @@ -35,14 +36,12 @@ import org.junit.jupiter.api.extension.ExtendWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.context.properties.EnableConfigurationProperties; -import org.springframework.boot.test.context.ConfigFileApplicationContextInitializer; +import org.springframework.boot.test.context.SpringBootTest; import org.springframework.core.io.ResourceLoader; -import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.junit.jupiter.SpringExtension; @ExtendWith(SpringExtension.class) -@ContextConfiguration(classes = {ObjectStoreAccess.class, ObjectStoreClientConfig.class}, - initializers = ConfigFileApplicationContextInitializer.class) +@SpringBootTest(classes = {ObjectStoreAccess.class, ObjectStoreClientConfig.class}) @EnableConfigurationProperties(value = DistributionServiceConfig.class) @Tag("s3-integration") class S3PublisherIntegrationTest { @@ -57,7 +56,8 @@ class S3PublisherIntegrationTest { @Test void publishTestFolderOk() throws IOException { - S3Publisher publisher = new S3Publisher(getFolderAsPath(rootTestFolder), objectStoreAccess); + S3Publisher publisher = new S3Publisher( + getFolderAsPath(rootTestFolder), objectStoreAccess, mock(FailedObjectStoreOperationsCounter.class)); publisher.publish(); List<S3Object> s3Objects = objectStoreAccess.getObjectsWithPrefix("version"); diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherTest.java @@ -21,6 +21,7 @@ package app.coronawarn.server.services.distribution.objectstore; import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.mock; import static org.mockito.Mockito.times; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; @@ -115,6 +116,6 @@ private List<S3Object> twoIdenticalOneOtherOneChange() { private S3Publisher createTestPublisher() throws IOException { var publishPath = resourceLoader.getResource(PUBLISHING_PATH).getFile().toPath(); - return new S3Publisher(publishPath, objectStoreAccess); + return new S3Publisher(publishPath, objectStoreAccess, mock(FailedObjectStoreOperationsCounter.class)); } } diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3RetentionPolicyTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3RetentionPolicyTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3RetentionPolicyTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3RetentionPolicyTest.java @@ -23,12 +23,15 @@ import static org.mockito.ArgumentMatchers.any; import static org.mockito.ArgumentMatchers.eq; import static org.mockito.Mockito.atLeastOnce; +import static org.mockito.Mockito.doThrow; import static org.mockito.Mockito.never; +import static org.mockito.Mockito.times; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; import app.coronawarn.server.services.distribution.config.DistributionServiceConfig.ObjectStore; +import app.coronawarn.server.services.distribution.objectstore.client.ObjectStoreOperationFailedException; import app.coronawarn.server.services.distribution.objectstore.client.S3Object; import java.time.LocalDate; import java.time.ZoneOffset; @@ -44,17 +47,21 @@ @EnableConfigurationProperties(value = DistributionServiceConfig.class) @ExtendWith(SpringExtension.class) -@ContextConfiguration(classes = {S3RetentionPolicy.class, ObjectStore.class}, +@ContextConfiguration(classes = {S3RetentionPolicy.class, ObjectStore.class, FailedObjectStoreOperationsCounter.class}, initializers = ConfigFileApplicationContextInitializer.class) class S3RetentionPolicyTest { @MockBean private ObjectStoreAccess objectStoreAccess; + @MockBean + private FailedObjectStoreOperationsCounter failedObjectStoreOperationsCounter; + @Autowired private S3RetentionPolicy s3RetentionPolicy; - @Autowired DistributionServiceConfig distributionServiceConfig; + @Autowired + private DistributionServiceConfig distributionServiceConfig; @Test void shouldDeleteOldFiles() { @@ -83,6 +90,16 @@ void shouldNotDeleteFilesIfAllAreValid() { verify(objectStoreAccess, never()).deleteObjectsWithPrefix(any()); } + @Test + void deleteDiagnosisKeysUpdatesFailedOperationCounter() { + doThrow(ObjectStoreOperationFailedException.class).when(objectStoreAccess).deleteObjectsWithPrefix(any()); + + s3RetentionPolicy.deleteDiagnosisKey(new S3Object("foo")); + + verify(failedObjectStoreOperationsCounter, times(1)) + .incrementAndCheckThreshold(any(ObjectStoreOperationFailedException.class)); + } + private String generateFileName(LocalDate date) { var api = distributionServiceConfig.getApi(); diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapperTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapperTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapperTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapperTest.java @@ -27,10 +27,12 @@ import static org.mockito.ArgumentMatchers.any; import static org.mockito.ArgumentMatchers.eq; import static org.mockito.Mockito.atLeastOnce; -import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.reset; +import static org.mockito.Mockito.times; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; import app.coronawarn.server.services.distribution.objectstore.client.ObjectStoreClient.HeaderKey; import java.nio.file.Path; import java.util.List; @@ -44,6 +46,15 @@ import org.junit.jupiter.params.provider.Arguments; import org.junit.jupiter.params.provider.MethodSource; import org.junit.jupiter.params.provider.ValueSource; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.boot.test.context.ConfigFileApplicationContextInitializer; +import org.springframework.boot.test.mock.mockito.MockBean; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.retry.annotation.EnableRetry; +import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.junit.jupiter.SpringExtension; import software.amazon.awssdk.core.exception.SdkClientException; import software.amazon.awssdk.core.exception.SdkException; @@ -62,19 +73,36 @@ import software.amazon.awssdk.utils.builder.SdkBuilder; @ExtendWith(SpringExtension.class) +@ContextConfiguration(initializers = ConfigFileApplicationContextInitializer.class) +@EnableConfigurationProperties(value = DistributionServiceConfig.class) class S3ClientWrapperTest { private static final String VALID_BUCKET_NAME = "myBucket"; private static final String VALID_PREFIX = "prefix"; private static final String VALID_NAME = "object key"; + @Value("${services.distribution.objectstore.retry-attempts}") + private int configuredNumberOfRetries; + + @MockBean private S3Client s3Client; - private S3ClientWrapper s3ClientWrapper; + + @Autowired + private ObjectStoreClient s3ClientWrapper; + + @Configuration + @EnableRetry + public static class RetryS3ClientConfig { + + @Bean + public ObjectStoreClient createS3ClientWrapper(S3Client s3Client) { + return new S3ClientWrapper(s3Client); + } + } @BeforeEach public void setUpMocks() { - s3Client = mock(S3Client.class); - s3ClientWrapper = new S3ClientWrapper(s3Client); + reset(s3Client); } @Test @@ -156,6 +184,16 @@ void getObjectsThrowsObjectStoreOperationFailedExceptionIfClientThrows(Class<Exc .isThrownBy(() -> s3ClientWrapper.getObjects(VALID_BUCKET_NAME, VALID_PREFIX)); } + @ParameterizedTest + @ValueSource(classes = {NoSuchBucketException.class, S3Exception.class, SdkClientException.class, SdkException.class}) + void shouldRetryGettingObjectsAndThenThrow(Class<Exception> cause) { + when(s3Client.listObjectsV2(any(ListObjectsV2Request.class))).thenThrow(cause); + assertThatExceptionOfType(ObjectStoreOperationFailedException.class) + .isThrownBy(() -> s3ClientWrapper.getObjects(VALID_BUCKET_NAME, VALID_PREFIX)); + + verify(s3Client, times(configuredNumberOfRetries)).listObjectsV2(any(ListObjectsV2Request.class)); + } + @Test void testPutObjectForNoHeaders() { s3ClientWrapper.putObject(VALID_BUCKET_NAME, VALID_NAME, Path.of(""), emptyMap()); @@ -193,6 +231,16 @@ void putObjectsThrowsObjectStoreOperationFailedExceptionIfClientThrows(Class<Exc .isThrownBy(() -> s3ClientWrapper.putObject(VALID_BUCKET_NAME, VALID_PREFIX, Path.of(""), emptyMap())); } + @ParameterizedTest + @ValueSource(classes = {NoSuchBucketException.class, S3Exception.class, SdkClientException.class, SdkException.class}) + void shouldRetryUploadingObjectAndThenThrow(Class<Exception> cause) { + when(s3Client.putObject(any(PutObjectRequest.class), any(RequestBody.class))).thenThrow(cause); + assertThatExceptionOfType(ObjectStoreOperationFailedException.class) + .isThrownBy(() -> s3ClientWrapper.putObject(VALID_BUCKET_NAME, VALID_PREFIX, Path.of(""), emptyMap())); + + verify(s3Client, times(configuredNumberOfRetries)).putObject(any(PutObjectRequest.class), any(RequestBody.class)); + } + @Test void testRemoveObjects() { when(s3Client.deleteObjects(any(DeleteObjectsRequest.class))).thenReturn(DeleteObjectsResponse.builder().build()); @@ -227,4 +275,14 @@ void removeObjectsThrowsObjectStoreOperationFailedExceptionIfClientThrows(Class< assertThatExceptionOfType(ObjectStoreOperationFailedException.class) .isThrownBy(() -> s3ClientWrapper.removeObjects(VALID_BUCKET_NAME, List.of(VALID_NAME))); } + + @ParameterizedTest + @ValueSource(classes = {NoSuchBucketException.class, S3Exception.class, SdkClientException.class, SdkException.class}) + void shouldRetryRemovingObjectAndThenThrow(Class<Exception> cause) { + when(s3Client.deleteObjects(any(DeleteObjectsRequest.class))).thenThrow(cause); + assertThatExceptionOfType(ObjectStoreOperationFailedException.class) + .isThrownBy(() -> s3ClientWrapper.removeObjects(VALID_BUCKET_NAME, List.of(VALID_NAME))); + + verify(s3Client, times(configuredNumberOfRetries)).deleteObjects(any(DeleteObjectsRequest.class)); + } } diff --git a/services/distribution/src/test/resources/application.yaml b/services/distribution/src/test/resources/application.yaml --- a/services/distribution/src/test/resources/application.yaml +++ b/services/distribution/src/test/resources/application.yaml @@ -46,6 +46,9 @@ services: bucket: ${CWA_OBJECTSTORE_BUCKET:cwa} port: ${CWA_OBJECTSTORE_PORT:8003} set-public-read-acl-on-put-object: true + retry-attempts: 3 + retry-backoff: 1 + max-number-of-failed-operations: 5 spring: main: banner-mode: off

S3Publisher: Resilience The S3Publisher/ObjectStoreAccess is currently lacking resilience features, like re-trys and error handling.

corona-warn-app/cwa-server

corona-warn-app__cwa-server-422

1032f0e5950d2d6fa064da7026825e3c25260c79

diff --git a/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/app_config.proto b/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/app_config.proto --- a/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/app_config.proto +++ b/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/app_config.proto @@ -12,4 +12,11 @@ message ApplicationConfiguration { app.coronawarn.server.common.protocols.internal.RiskScoreClassification riskScoreClasses = 2; app.coronawarn.server.common.protocols.internal.RiskScoreParameters exposureConfig = 3; + + AttenuationDurationThresholds attenuationDurationThresholds = 4; +} + +message AttenuationDurationThresholds { + int32 lower = 1; + int32 upper = 2; } \ No newline at end of file diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ApplicationConfigurationValidator.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ApplicationConfigurationValidator.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ApplicationConfigurationValidator.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ApplicationConfigurationValidator.java @@ -20,6 +20,11 @@ package app.coronawarn.server.services.distribution.assembly.appconfig.validation; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.GeneralValidationError.ErrorType.MIN_GREATER_THAN_MAX; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.GeneralValidationError.ErrorType.VALUE_OUT_OF_BOUNDS; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ParameterSpec.ATTENUATION_DURATION_THRESHOLD_MAX; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ParameterSpec.ATTENUATION_DURATION_THRESHOLD_MIN; + import app.coronawarn.server.common.protocols.internal.ApplicationConfiguration; import app.coronawarn.server.common.protocols.internal.RiskScoreClassification; import app.coronawarn.server.common.protocols.internal.RiskScoreParameters; @@ -46,6 +51,7 @@ public ValidationResult validate() { this.errors = new ValidationResult(); validateMinRisk(); + validateAttenuationDurationThresholds(); ValidationResult exposureResult = new ExposureConfigurationValidator(config.getExposureConfig()).validate(); ValidationResult riskScoreResult = new RiskScoreClassificationValidator(config.getRiskScoreClasses()).validate(); @@ -60,4 +66,25 @@ private void validateMinRisk() { this.errors.add(new MinimumRiskLevelValidationError(minLevel)); } } + + private void validateAttenuationDurationThresholds() { + int lower = config.getAttenuationDurationThresholds().getLower(); + int upper = config.getAttenuationDurationThresholds().getUpper(); + + checkThresholdBound("lower", lower); + checkThresholdBound("upper", upper); + + if (lower > upper) { + String parameters = "attenuationDurationThreshold.lower, attenuationDurationThreshold.upper"; + String values = lower + ", " + upper; + this.errors.add(new GeneralValidationError(parameters, values, MIN_GREATER_THAN_MAX)); + } + } + + private void checkThresholdBound(String boundLabel, int boundValue) { + if (boundValue < ATTENUATION_DURATION_THRESHOLD_MIN || boundValue > ATTENUATION_DURATION_THRESHOLD_MAX) { + this.errors.add( + new GeneralValidationError("attenuationDurationThreshold." + boundLabel, boundValue, VALUE_OUT_OF_BOUNDS)); + } + } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidationError.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/GeneralValidationError.java similarity index 82% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidationError.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/GeneralValidationError.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidationError.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/GeneralValidationError.java @@ -22,23 +22,21 @@ import java.util.Objects; -public class RiskScoreClassificationValidationError implements ValidationError { +public class GeneralValidationError implements ValidationError { private final String errorSource; - private final Object value; - private final ErrorType reason; /** - * Creates a {@link RiskScoreClassificationValidationError} that stores the specified validation error source, + * Creates a {@link GeneralValidationError} that stores the specified validation error source, * erroneous value and a reason for the error to occur. * * @param errorSource A label that describes the property associated with this validation error. * @param value The value that caused the validation error. * @param reason A validation error specifier. */ - public RiskScoreClassificationValidationError(String errorSource, Object value, ErrorType reason) { + public GeneralValidationError(String errorSource, Object value, ErrorType reason) { this.errorSource = errorSource; this.value = value; this.reason = reason; @@ -46,7 +44,7 @@ public RiskScoreClassificationValidationError(String errorSource, Object value, @Override public String toString() { - return "RiskScoreClassificationValidationError{" + return "GeneralValidationError{" + "errorType=" + reason + ", parameter='" + errorSource + '\'' + ", givenValue=" + value @@ -61,7 +59,7 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - RiskScoreClassificationValidationError that = (RiskScoreClassificationValidationError) o; + GeneralValidationError that = (GeneralValidationError) o; return Objects.equals(errorSource, that.errorSource) && Objects.equals(value, that.value) && Objects.equals(reason, that.reason); diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ParameterSpec.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ParameterSpec.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ParameterSpec.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ParameterSpec.java @@ -53,4 +53,14 @@ private ParameterSpec() { * The allowed maximum value for a risk score. */ public static final int RISK_SCORE_MAX = 4096; + + /** + * The allowed minimum value for an attenuation threshold. + */ + public static final int ATTENUATION_DURATION_THRESHOLD_MIN = 0; + + /** + * The allowed maximum value for an attenuation threshold. + */ + public static final int ATTENUATION_DURATION_THRESHOLD_MAX = 100; } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidator.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidator.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidator.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidator.java @@ -20,11 +20,11 @@ package app.coronawarn.server.services.distribution.assembly.appconfig.validation; -import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidationError.ErrorType.BLANK_LABEL; -import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidationError.ErrorType.INVALID_PARTITIONING; -import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidationError.ErrorType.INVALID_URL; -import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidationError.ErrorType.MIN_GREATER_THAN_MAX; -import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidationError.ErrorType.VALUE_OUT_OF_BOUNDS; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.GeneralValidationError.ErrorType.BLANK_LABEL; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.GeneralValidationError.ErrorType.INVALID_PARTITIONING; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.GeneralValidationError.ErrorType.INVALID_URL; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.GeneralValidationError.ErrorType.MIN_GREATER_THAN_MAX; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.GeneralValidationError.ErrorType.VALUE_OUT_OF_BOUNDS; import app.coronawarn.server.common.protocols.internal.RiskScoreClass; import app.coronawarn.server.common.protocols.internal.RiskScoreClassification; @@ -69,7 +69,7 @@ private void validateValues() { validateUrl(riskScoreClass.getUrl()); if (minRiskLevel > maxRiskLevel) { - errors.add(new RiskScoreClassificationValidationError( + errors.add(new GeneralValidationError( "minRiskLevel, maxRiskLevel", minRiskLevel + ", " + maxRiskLevel, MIN_GREATER_THAN_MAX)); } } @@ -77,13 +77,13 @@ private void validateValues() { private void validateLabel(String label) { if (label.isBlank()) { - errors.add(new RiskScoreClassificationValidationError("label", label, BLANK_LABEL)); + errors.add(new GeneralValidationError("label", label, BLANK_LABEL)); } } private void validateRiskScoreValueBounds(int value) { if (!RiskScoreValidator.isInBounds(value)) { - errors.add(new RiskScoreClassificationValidationError("minRiskLevel/maxRiskLevel", value, VALUE_OUT_OF_BOUNDS)); + errors.add(new GeneralValidationError("minRiskLevel/maxRiskLevel", value, VALUE_OUT_OF_BOUNDS)); } } @@ -91,7 +91,7 @@ private void validateUrl(String url) { try { new URL(url.trim()); } catch (MalformedURLException e) { - errors.add(new RiskScoreClassificationValidationError("url", url, INVALID_URL)); + errors.add(new GeneralValidationError("url", url, INVALID_URL)); } } @@ -101,7 +101,7 @@ private void validateValueRangeCoverage() { .sum(); if (partitionSum != ParameterSpec.RISK_SCORE_MAX + 1) { - errors.add(new RiskScoreClassificationValidationError("covered value range", partitionSum, INVALID_PARTITIONING)); + errors.add(new GeneralValidationError("covered value range", partitionSum, INVALID_PARTITIONING)); } } } diff --git a/services/distribution/src/main/resources/master-config/app-config.yaml b/services/distribution/src/main/resources/master-config/app-config.yaml --- a/services/distribution/src/main/resources/master-config/app-config.yaml +++ b/services/distribution/src/main/resources/master-config/app-config.yaml @@ -9,5 +9,8 @@ # Change this file with caution! min-risk-score: 90 +attenuationDurationThresholds: + lower: 50 + upper: 70 risk-score-classes: !include risk-score-classification.yaml exposure-config: !include exposure-config.yaml \ No newline at end of file

diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ApplicationConfigurationValidatorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ApplicationConfigurationValidatorTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ApplicationConfigurationValidatorTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ApplicationConfigurationValidatorTest.java @@ -20,16 +20,26 @@ package app.coronawarn.server.services.distribution.assembly.appconfig.validation; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.GeneralValidationError.ErrorType.MIN_GREATER_THAN_MAX; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.GeneralValidationError.ErrorType.VALUE_OUT_OF_BOUNDS; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ParameterSpec.ATTENUATION_DURATION_THRESHOLD_MAX; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ParameterSpec.ATTENUATION_DURATION_THRESHOLD_MIN; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidatorTest.MINIMAL_RISK_SCORE_CLASSIFICATION; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidatorTest.buildExpectedResult; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatThrownBy; +import app.coronawarn.server.common.protocols.internal.ApplicationConfiguration; +import app.coronawarn.server.common.protocols.internal.AttenuationDurationThresholds; import app.coronawarn.server.services.distribution.assembly.appconfig.ApplicationConfigurationProvider; +import app.coronawarn.server.services.distribution.assembly.appconfig.ExposureConfigurationProvider; import app.coronawarn.server.services.distribution.assembly.appconfig.UnableToLoadFileException; import java.util.stream.Stream; import org.junit.jupiter.api.Test; import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.Arguments; import org.junit.jupiter.params.provider.MethodSource; +import org.junit.jupiter.params.provider.ValueSource; class ApplicationConfigurationValidatorTest { @@ -49,6 +59,43 @@ void negative(TestWithExpectedResult test) throws UnableToLoadFileException { assertThat(getResultForTest(test)).isEqualTo(test.result); } + @ParameterizedTest + @ValueSource(ints = {ATTENUATION_DURATION_THRESHOLD_MIN - 1, ATTENUATION_DURATION_THRESHOLD_MAX + 1}) + void negativeForAttenuationDurationThresholdOutOfBounds(int invalidThresholdValue) throws Exception { + ApplicationConfigurationValidator validator = getValidatorForAttenuationDurationThreshold( + invalidThresholdValue, invalidThresholdValue); + + ValidationResult expectedResult = buildExpectedResult( + new GeneralValidationError("attenuationDurationThreshold.upper", invalidThresholdValue, VALUE_OUT_OF_BOUNDS), + new GeneralValidationError("attenuationDurationThreshold.lower", invalidThresholdValue, VALUE_OUT_OF_BOUNDS)); + + assertThat(validator.validate()).isEqualTo(expectedResult); + } + + @Test + void negativeForUpperAttenuationDurationThresholdLesserThanLower() throws Exception { + ApplicationConfigurationValidator validator = getValidatorForAttenuationDurationThreshold( + ATTENUATION_DURATION_THRESHOLD_MAX, ATTENUATION_DURATION_THRESHOLD_MIN); + + ValidationResult expectedResult = buildExpectedResult( + new GeneralValidationError("attenuationDurationThreshold.lower, attenuationDurationThreshold.upper", + (ATTENUATION_DURATION_THRESHOLD_MAX + ", " + ATTENUATION_DURATION_THRESHOLD_MIN), MIN_GREATER_THAN_MAX)); + + assertThat(validator.validate()).isEqualTo(expectedResult); + } + + private ApplicationConfigurationValidator getValidatorForAttenuationDurationThreshold(int lower, int upper) + throws Exception { + ApplicationConfiguration appConfig = ApplicationConfiguration.newBuilder() + .setMinRiskScore(100) + .setRiskScoreClasses(MINIMAL_RISK_SCORE_CLASSIFICATION) + .setExposureConfig(ExposureConfigurationProvider.readFile("configtests/exposure-config_ok.yaml")) + .setAttenuationDurationThresholds(AttenuationDurationThresholds.newBuilder() + .setLower(lower) + .setUpper(upper)).build(); + return new ApplicationConfigurationValidator(appConfig); + } + @Test void circular() { assertThatThrownBy(() -> { diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidatorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidatorTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidatorTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidatorTest.java @@ -20,14 +20,14 @@ package app.coronawarn.server.services.distribution.assembly.appconfig.validation; -import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidationError.ErrorType.INVALID_PARTITIONING; -import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidationError.ErrorType.MIN_GREATER_THAN_MAX; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.GeneralValidationError.ErrorType.INVALID_PARTITIONING; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.GeneralValidationError.ErrorType.MIN_GREATER_THAN_MAX; import static java.util.Arrays.asList; import static org.assertj.core.api.Assertions.assertThat; import app.coronawarn.server.common.protocols.internal.RiskScoreClass; import app.coronawarn.server.common.protocols.internal.RiskScoreClassification; -import app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidationError.ErrorType; +import app.coronawarn.server.services.distribution.assembly.appconfig.validation.GeneralValidationError.ErrorType; import java.util.Arrays; import java.util.stream.Stream; import org.junit.jupiter.api.Test; @@ -42,6 +42,9 @@ class RiskScoreClassificationValidatorTest { private final static String VALID_LABEL = "myLabel"; private final static String VALID_URL = "https://www.my.url"; + public final static RiskScoreClassification MINIMAL_RISK_SCORE_CLASSIFICATION = + buildClassification(buildRiskClass(VALID_LABEL, 0, MAX_SCORE, VALID_URL)); + @ParameterizedTest @ValueSource(strings = {"", " "}) void failsForBlankLabels(String invalidLabel) { @@ -134,8 +137,7 @@ void doesNotFailForValidClassification(RiskScoreClassification validClassificati private static Stream<Arguments> createValidClassifications() { return Stream.of( - // valid url - buildClassification(buildRiskClass(VALID_LABEL, 0, MAX_SCORE, VALID_URL)), + MINIMAL_RISK_SCORE_CLASSIFICATION, // [0:MAX_SCORE/2][MAX_SCORE/2:MAX_SCORE] buildClassification( buildRiskClass(VALID_LABEL, 0, MAX_SCORE / 2, VALID_URL), @@ -148,8 +150,8 @@ private static Stream<Arguments> createValidClassifications() { ).map(Arguments::of); } - private static RiskScoreClassificationValidationError buildError(String parameter, Object value, ErrorType reason) { - return new RiskScoreClassificationValidationError(parameter, value, reason); + private static GeneralValidationError buildError(String parameter, Object value, ErrorType reason) { + return new GeneralValidationError(parameter, value, reason); } private static RiskScoreClassificationValidator buildValidator(RiskScoreClass... riskScoreClasses) { @@ -164,7 +166,7 @@ private static RiskScoreClass buildRiskClass(String label, int min, int max, Str return RiskScoreClass.newBuilder().setLabel(label).setMin(min).setMax(max).setUrl(url).build(); } - private static ValidationResult buildExpectedResult(RiskScoreClassificationValidationError... errors) { + public static ValidationResult buildExpectedResult(GeneralValidationError... errors) { var validationResult = new ValidationResult(); Arrays.stream(errors).forEach(validationResult::add); return validationResult; diff --git a/services/distribution/src/test/resources/configtests/app-config_ok.yaml b/services/distribution/src/test/resources/configtests/app-config_ok.yaml --- a/services/distribution/src/test/resources/configtests/app-config_ok.yaml +++ b/services/distribution/src/test/resources/configtests/app-config_ok.yaml @@ -1,3 +1,6 @@ min-risk-score: 100 +attenuationDurationThresholds: + lower: 50 + upper: 70 risk-score-classes: !include risk-score-class_ok.yaml exposure-config: !include exposure-config_ok.yaml \ No newline at end of file

Application Config: Add new Parameter attenuationDurationThresholds Add a new parameter to the application configuration, called "attenuationDurationTresholds". With the help of this parameter, we will be able to calculate the overall risk factor much better. Default values are: X=50, Y=70. There will be call with the RKI today night in which the values might be adjusted. ```yaml attenuation-duration-thresholds: lower: 50 upper: 70 ```

Are there any known constraints that define the validity of X/Y values? Should be: - type: integer - 0 to 100 (upper bound might change though, but use 100 for now) - x must by lower than y -> so would also be nice to make that more explicit, by calling them lower and upper. (edited description of ticket)

corona-warn-app/cwa-server

corona-warn-app__cwa-server-424

2be284e0518658dcb7ef8d1df5515fd5f962e242

diff --git a/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/app_config.proto b/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/app_config.proto --- a/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/app_config.proto +++ b/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/app_config.proto @@ -4,6 +4,7 @@ option java_package = "app.coronawarn.server.common.protocols.internal"; option java_multiple_files = true; import "app/coronawarn/server/common/protocols/internal/risk_score_classification.proto"; import "app/coronawarn/server/common/protocols/internal/risk_score_parameters.proto"; +import "app/coronawarn/server/common/protocols/internal/app_version_config.proto"; message ApplicationConfiguration { @@ -14,6 +15,8 @@ message ApplicationConfiguration { app.coronawarn.server.common.protocols.internal.RiskScoreParameters exposureConfig = 3; AttenuationDurationThresholds attenuationDurationThresholds = 4; + + app.coronawarn.server.common.protocols.internal.ApplicationVersionConfiguration appVersion = 5; } message AttenuationDurationThresholds { diff --git a/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/app_version_config.proto b/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/app_version_config.proto new file mode 100644 --- /dev/null +++ b/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/app_version_config.proto @@ -0,0 +1,20 @@ +syntax = "proto3"; +package app.coronawarn.server.common.protocols.internal; +option java_package = "app.coronawarn.server.common.protocols.internal"; +option java_multiple_files = true; + +message ApplicationVersionConfiguration { + ApplicationVersionInfo ios = 1; + ApplicationVersionInfo android = 2; +} + +message ApplicationVersionInfo { + SemanticVersion latest = 1; + SemanticVersion min = 2; +} + +message SemanticVersion { + uint32 major = 1; + uint32 minor = 2; + uint32 patch = 3; +} \ No newline at end of file diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/ApplicationVersionConfigurationProvider.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/ApplicationVersionConfigurationProvider.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/ApplicationVersionConfigurationProvider.java @@ -0,0 +1,56 @@ +/* + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.assembly.appconfig; + +import app.coronawarn.server.common.protocols.internal.ApplicationVersionConfiguration; + +/** + * Provides the mobile app version configuration based on a file in the file system.<br> The existing file must be a + * valid YAML file, and must match the specification of the proto file app_version_config.proto. + */ +public class ApplicationVersionConfigurationProvider { + + /** + * The location of the app version config master file. + */ + public static final String MASTER_FILE = "master-config/app-version-config.yaml"; + + /** + * Fetches the master configuration as an ApplicationVersionConfig instance. + * + * @return the mobile app version configuration as ApplicationVersionConfig + * @throws UnableToLoadFileException when the file/transformation did not succeed + */ + public static ApplicationVersionConfiguration readMasterFile() throws UnableToLoadFileException { + return readFile(MASTER_FILE); + } + + /** + * Fetches an app version configuration file based on the given path. The path must be available in the classloader. + * + * @param path the path, e.g. folder/my-app-version-config.yaml + * @return the ApplicationVersionConfig + * @throws UnableToLoadFileException when the file/transformation did not succeed + */ + public static ApplicationVersionConfiguration readFile(String path) throws UnableToLoadFileException { + return YamlLoader.loadYamlIntoProtobufBuilder(path, ApplicationVersionConfiguration.Builder.class).build(); + } +} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/YamlLoader.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/YamlLoader.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/YamlLoader.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/YamlLoader.java @@ -50,8 +50,8 @@ public static <T extends Message.Builder> T loadYamlIntoProtobufBuilder(String p // no setters for generated message classes available yaml.setBeanAccess(BeanAccess.FIELD); - Resource riskScoreParametersResource = new ClassPathResource(path); - try (InputStream inputStream = riskScoreParametersResource.getInputStream()) { + Resource configurationResource = new ClassPathResource(path); + try (InputStream inputStream = configurationResource.getInputStream()) { T loaded = yaml.loadAs(inputStream, builderType); if (loaded == null) { throw new UnableToLoadFileException(path); diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ApplicationVersionConfigurationValidator.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ApplicationVersionConfigurationValidator.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ApplicationVersionConfigurationValidator.java @@ -0,0 +1,81 @@ +/* + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.assembly.appconfig.validation; + +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.GeneralValidationError.ErrorType.MIN_GREATER_THAN_MAX; + +import app.coronawarn.server.common.protocols.internal.ApplicationVersionConfiguration; +import app.coronawarn.server.common.protocols.internal.ApplicationVersionInfo; +import app.coronawarn.server.common.protocols.internal.SemanticVersion; + +public class ApplicationVersionConfigurationValidator extends ConfigurationValidator { + + private final ApplicationVersionConfiguration config; + + public ApplicationVersionConfigurationValidator(ApplicationVersionConfiguration config) { + this.config = config; + } + + @Override + public ValidationResult validate() { + this.errors = new ValidationResult(); + validateApplicationVersionInfo("ios", config.getIos()); + validateApplicationVersionInfo("android", config.getAndroid()); + return this.errors; + } + + private void validateApplicationVersionInfo(String name, ApplicationVersionInfo appVersionInfo) { + SemanticVersion minVersion = appVersionInfo.getMin(); + ComparisonResult comparisonResult = compare(appVersionInfo.getLatest(), minVersion); + if (ComparisonResult.LOWER.equals(comparisonResult)) { + this.errors.add(new GeneralValidationError(name + ": latest/min", + minVersion.getMajor() + "." + minVersion.getMinor() + "." + minVersion.getPatch(), MIN_GREATER_THAN_MAX)); + } + } + + private ComparisonResult compare(SemanticVersion left, SemanticVersion right) { + if (left.getMajor() < right.getMajor()) { + return ComparisonResult.LOWER; + } + if (left.getMajor() > right.getMajor()) { + return ComparisonResult.HIGHER; + } + if (left.getMinor() < right.getMinor()) { + return ComparisonResult.LOWER; + } + if (left.getMinor() > right.getMinor()) { + return ComparisonResult.HIGHER; + } + if (left.getPatch() < right.getPatch()) { + return ComparisonResult.LOWER; + } + if (left.getPatch() > right.getPatch()) { + return ComparisonResult.HIGHER; + } + return ComparisonResult.EQUAL; + } + + private enum ComparisonResult { + LOWER, + EQUAL, + HIGHER + } +} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/GeneralValidationError.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/GeneralValidationError.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/GeneralValidationError.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/GeneralValidationError.java @@ -44,7 +44,7 @@ public GeneralValidationError(String errorSource, Object value, ErrorType reason @Override public String toString() { - return "GeneralValidationError{" + return "RiskScoreClassificationValidationError{" + "errorType=" + reason + ", parameter='" + errorSource + '\'' + ", givenValue=" + value diff --git a/services/distribution/src/main/resources/master-config/app-config.yaml b/services/distribution/src/main/resources/master-config/app-config.yaml --- a/services/distribution/src/main/resources/master-config/app-config.yaml +++ b/services/distribution/src/main/resources/master-config/app-config.yaml @@ -13,4 +13,5 @@ attenuationDurationThresholds: lower: 50 upper: 70 risk-score-classes: !include risk-score-classification.yaml -exposure-config: !include exposure-config.yaml \ No newline at end of file +exposure-config: !include exposure-config.yaml +app-version: !include app-version-config.yaml \ No newline at end of file diff --git a/services/distribution/src/main/resources/master-config/app-version-config.yaml b/services/distribution/src/main/resources/master-config/app-version-config.yaml new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/resources/master-config/app-version-config.yaml @@ -0,0 +1,25 @@ +# This is the Application Version Configuration master file which contains information for clients +# about the latest and minimum supported mobile app versions on Android and iOS. +# +# The latest version must not be lower than the min version. +# +# Change this file with caution! + +ios: + latest: + major: 1 + minor: 5 + patch: 2 + min: + major: 1 + minor: 2 + patch: 2 +android: + latest: + major: 1 + minor: 3 + patch: 2 + min: + major: 1 + minor: 1 + patch: 2 \ No newline at end of file

diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/ApplicationVersionConfigurationProviderMasterFileTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/ApplicationVersionConfigurationProviderMasterFileTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/ApplicationVersionConfigurationProviderMasterFileTest.java @@ -0,0 +1,49 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.assembly.appconfig; + +import static org.assertj.core.api.Assertions.assertThat; + +import app.coronawarn.server.services.distribution.assembly.appconfig.validation.ApplicationVersionConfigurationValidator; +import app.coronawarn.server.services.distribution.assembly.appconfig.validation.ExposureConfigurationValidator; +import app.coronawarn.server.services.distribution.assembly.appconfig.validation.ValidationResult; +import org.junit.jupiter.api.Test; + +/** + * This test will verify that the provided Exposure Configuration master file is syntactically + * correct and according to spec. + * <p> + * There should never be any deployment when this test is failing. + */ +class ApplicationVersionConfigurationProviderMasterFileTest { + + private static final ValidationResult SUCCESS = new ValidationResult(); + + @Test + void testMasterFile() throws UnableToLoadFileException { + var config = ApplicationVersionConfigurationProvider.readMasterFile(); + + var validator = new ApplicationVersionConfigurationValidator(config); + ValidationResult result = validator.validate(); + + assertThat(result).isEqualTo(SUCCESS); + } +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/ApplicationVersionConfigurationProviderTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/ApplicationVersionConfigurationProviderTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/ApplicationVersionConfigurationProviderTest.java @@ -0,0 +1,59 @@ +/* + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.assembly.appconfig; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.catchThrowable; + +import app.coronawarn.server.common.protocols.internal.ApplicationVersionConfiguration; +import org.junit.jupiter.api.Test; + +public class ApplicationVersionConfigurationProviderTest { + + @Test + void okFile() throws UnableToLoadFileException { + ApplicationVersionConfiguration result = + ApplicationVersionConfigurationProvider.readFile("app-version/all_ok.yaml"); + + assertThat(result).withFailMessage("File is null, indicating loading failed").isNotNull(); + } + + @Test + void wrongFile() { + assertUnableToLoadFile("app-version/wrong_file.yaml"); + } + + @Test + void brokenSyntax() { + assertUnableToLoadFile("app-version/broken_syntax.yaml"); + } + + @Test + void doesNotExist() { + assertUnableToLoadFile("file_does_not_exist_anywhere.yaml"); + } + + public static void assertUnableToLoadFile(String s) { + assertThat(catchThrowable(() -> + ApplicationVersionConfigurationProvider.readFile(s))) + .isInstanceOf(UnableToLoadFileException.class); + } +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ApplicationVersionConfigurationValidatorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ApplicationVersionConfigurationValidatorTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ApplicationVersionConfigurationValidatorTest.java @@ -0,0 +1,61 @@ +/* + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.assembly.appconfig.validation; + +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidatorTest.buildError; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidatorTest.buildExpectedResult; +import static org.assertj.core.api.Assertions.assertThat; + +import app.coronawarn.server.common.protocols.internal.ApplicationVersionConfiguration; +import app.coronawarn.server.services.distribution.assembly.appconfig.ApplicationVersionConfigurationProvider; +import app.coronawarn.server.services.distribution.assembly.appconfig.UnableToLoadFileException; +import app.coronawarn.server.services.distribution.assembly.appconfig.validation.GeneralValidationError.ErrorType; +import org.junit.jupiter.api.Test; + +public class ApplicationVersionConfigurationValidatorTest { + + private static final ValidationResult SUCCESS = new ValidationResult(); + + @Test + void succeedsIfLatestEqualsMin() throws UnableToLoadFileException { + ApplicationVersionConfiguration config = ApplicationVersionConfigurationProvider + .readFile("app-version/latest-equals-min.yaml"); + var validator = new ApplicationVersionConfigurationValidator(config); + assertThat(validator.validate()).isEqualTo(SUCCESS); + } + + @Test + void succeedsIfLatestHigherThanMin() throws UnableToLoadFileException { + ApplicationVersionConfiguration config = ApplicationVersionConfigurationProvider + .readFile("app-version/latest-higher-than-min.yaml"); + var validator = new ApplicationVersionConfigurationValidator(config); + assertThat(validator.validate()).isEqualTo(SUCCESS); + } + + @Test + void failsIfLatestLowerThanMin() throws UnableToLoadFileException { + ApplicationVersionConfiguration config = ApplicationVersionConfigurationProvider + .readFile("app-version/latest-lower-than-min.yaml"); + var validator = new ApplicationVersionConfigurationValidator(config); + assertThat(validator.validate()) + .isEqualTo(buildExpectedResult(buildError("ios: latest/min", "1.2.2", ErrorType.MIN_GREATER_THAN_MAX))); + } +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidatorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidatorTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidatorTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidatorTest.java @@ -150,7 +150,7 @@ private static Stream<Arguments> createValidClassifications() { ).map(Arguments::of); } - private static GeneralValidationError buildError(String parameter, Object value, ErrorType reason) { + public static GeneralValidationError buildError(String parameter, Object value, ErrorType reason) { return new GeneralValidationError(parameter, value, reason); } diff --git a/services/distribution/src/test/resources/app-version/all_ok.yaml b/services/distribution/src/test/resources/app-version/all_ok.yaml new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/resources/app-version/all_ok.yaml @@ -0,0 +1,18 @@ +ios: + latest: + major: 1 + minor: 5 + patch: 2 + min: + major: 1 + minor: 2 + patch: 2 +android: + latest: + major: 1 + minor: 3 + patch: 2 + min: + major: 1 + minor: 1 + patch: 2 diff --git a/services/distribution/src/test/resources/app-version/broken_syntax.yaml b/services/distribution/src/test/resources/app-version/broken_syntax.yaml new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/resources/app-version/broken_syntax.yaml @@ -0,0 +1,18 @@ +ios: + latest: + major: 1 # wrong syntax, indent too high + minor: 5 + patch: 2 + min: + major: 1 + minor: 2 + patch: 2 +android: + latest: + major: 1 + minor: 3 + patch: 2 + min: + major: 1 + minor: 1 + patch: 2 diff --git a/services/distribution/src/test/resources/app-version/empty.yaml b/services/distribution/src/test/resources/app-version/empty.yaml new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/resources/app-version/empty.yaml @@ -0,0 +1 @@ +# empty file \ No newline at end of file diff --git a/services/distribution/src/test/resources/app-version/latest-equals-min.yaml b/services/distribution/src/test/resources/app-version/latest-equals-min.yaml new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/resources/app-version/latest-equals-min.yaml @@ -0,0 +1,18 @@ +ios: + latest: + major: 1 + minor: 2 + patch: 2 + min: + major: 1 + minor: 2 + patch: 2 +android: + latest: + major: 1 + minor: 3 + patch: 2 + min: + major: 1 + minor: 3 + patch: 2 diff --git a/services/distribution/src/test/resources/app-version/latest-higher-than-min.yaml b/services/distribution/src/test/resources/app-version/latest-higher-than-min.yaml new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/resources/app-version/latest-higher-than-min.yaml @@ -0,0 +1,18 @@ +ios: + latest: + major: 1 + minor: 2 + patch: 3 + min: + major: 1 + minor: 2 + patch: 2 +android: + latest: + major: 1 + minor: 3 + patch: 2 + min: + major: 1 + minor: 3 + patch: 2 diff --git a/services/distribution/src/test/resources/app-version/latest-lower-than-min.yaml b/services/distribution/src/test/resources/app-version/latest-lower-than-min.yaml new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/resources/app-version/latest-lower-than-min.yaml @@ -0,0 +1,18 @@ +ios: + latest: + major: 1 + minor: 2 + patch: 1 + min: + major: 1 + minor: 2 + patch: 2 +android: + latest: + major: 1 + minor: 3 + patch: 2 + min: + major: 1 + minor: 3 + patch: 2 diff --git a/services/distribution/src/test/resources/app-version/wrong_file.yaml b/services/distribution/src/test/resources/app-version/wrong_file.yaml new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/resources/app-version/wrong_file.yaml @@ -0,0 +1,20 @@ +ID: com.acme.mta.sample +version: 1.0.1 +modules: + - name: pricing-ui + type: nodejs + path: ./ui + requires: + - name: thedatabase + + - name: pricing-backend + type: java + path: ./backend + provides: + - name: price_opt + properties: + protocol: http + uri: myhost.mydomain +resources: + - name: thedatabase + type: com.sap.xs.hdi-container \ No newline at end of file diff --git a/services/distribution/src/test/resources/configtests/app-config_ok.yaml b/services/distribution/src/test/resources/configtests/app-config_ok.yaml --- a/services/distribution/src/test/resources/configtests/app-config_ok.yaml +++ b/services/distribution/src/test/resources/configtests/app-config_ok.yaml @@ -3,4 +3,5 @@ attenuationDurationThresholds: lower: 50 upper: 70 risk-score-classes: !include risk-score-class_ok.yaml -exposure-config: !include exposure-config_ok.yaml \ No newline at end of file +exposure-config: !include exposure-config_ok.yaml +app-version: !include app-version-config_ok.yaml \ No newline at end of file diff --git a/services/distribution/src/test/resources/configtests/app-version-config_ok.yaml b/services/distribution/src/test/resources/configtests/app-version-config_ok.yaml new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/resources/configtests/app-version-config_ok.yaml @@ -0,0 +1,18 @@ +ios: + latest: + major: 1 + minor: 5 + patch: 2 + min: + major: 1 + minor: 2 + patch: 2 +android: + latest: + major: 1 + minor: 3 + patch: 2 + min: + major: 1 + minor: 1 + patch: 2

Application Configuration: Add version update support We would like to keep the mobile application informed about new releases/current release of the app. This information can then be presented to the user, in order to ask for applying updates. We would like to add new fields to the application config (example values): ```yaml app-version: ios: latest: 1.5.2 min: 1.2.2 android: latest: 1.3.2 min: 1.1.2 ``` After downloading the config, the app checks whether the signature can be verified. If that is the case, it will get the current & min values from the config based on the target platform. This information can now be used to prompt users for updating the app. The values for the versions must follow semantic versioning.

corona-warn-app/cwa-server

corona-warn-app__cwa-server-429

528b73595c202a8216bd321dafd431206a6fd2c0

diff --git a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyService.java b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyService.java --- a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyService.java +++ b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyService.java @@ -32,7 +32,6 @@ import javax.validation.ConstraintViolation; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.domain.Sort; import org.springframework.data.domain.Sort.Direction; import org.springframework.stereotype.Component; @@ -44,7 +43,6 @@ public class DiagnosisKeyService { private static final Logger logger = LoggerFactory.getLogger(DiagnosisKeyService.class); private final DiagnosisKeyRepository keyRepository; - @Autowired public DiagnosisKeyService(DiagnosisKeyRepository keyRepository) { this.keyRepository = keyRepository; } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/DiagnosisKeysStructureProvider.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/DiagnosisKeysStructureProvider.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/DiagnosisKeysStructureProvider.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/DiagnosisKeysStructureProvider.java @@ -30,7 +30,6 @@ import java.util.Collection; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Component; /** @@ -42,8 +41,7 @@ public class DiagnosisKeysStructureProvider { private static final Logger logger = LoggerFactory .getLogger(DiagnosisKeysStructureProvider.class); - @Autowired - private DiagnosisKeyBundler diagnosisKeyBundler; + private final DiagnosisKeyBundler diagnosisKeyBundler; private final DiagnosisKeyService diagnosisKeyService; private final CryptoProvider cryptoProvider; private final DistributionServiceConfig distributionServiceConfig; @@ -52,10 +50,11 @@ public class DiagnosisKeysStructureProvider { * Creates a new DiagnosisKeysStructureProvider. */ DiagnosisKeysStructureProvider(DiagnosisKeyService diagnosisKeyService, CryptoProvider cryptoProvider, - DistributionServiceConfig distributionServiceConfig) { + DistributionServiceConfig distributionServiceConfig, DiagnosisKeyBundler diagnosisKeyBundler) { this.diagnosisKeyService = diagnosisKeyService; this.cryptoProvider = cryptoProvider; this.distributionServiceConfig = distributionServiceConfig; + this.diagnosisKeyBundler = diagnosisKeyBundler; } /** diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3RetentionPolicy.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3RetentionPolicy.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3RetentionPolicy.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3RetentionPolicy.java @@ -29,7 +29,6 @@ import java.util.List; import java.util.regex.Matcher; import java.util.regex.Pattern; -import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Component; /** @@ -41,7 +40,6 @@ public class S3RetentionPolicy { private final ObjectStoreAccess objectStoreAccess; private final Api api; - @Autowired public S3RetentionPolicy(ObjectStoreAccess objectStoreAccess, DistributionServiceConfig distributionServiceConfig) { this.objectStoreAccess = objectStoreAccess; this.api = distributionServiceConfig.getApi(); diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/SubmissionController.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/SubmissionController.java --- a/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/SubmissionController.java +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/SubmissionController.java @@ -36,7 +36,6 @@ import org.apache.commons.math3.distribution.PoissonDistribution; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -import org.springframework.beans.factory.annotation.Autowired; import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; import org.springframework.util.StopWatch; @@ -67,7 +66,6 @@ public class SubmissionController { private final Integer retentionDays; private Double fakeDelay; - @Autowired SubmissionController(DiagnosisKeyService diagnosisKeyService, TanVerifier tanVerifier, SubmissionServiceConfig submissionServiceConfig) { this.diagnosisKeyService = diagnosisKeyService; diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/TanVerifier.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/TanVerifier.java --- a/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/TanVerifier.java +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/TanVerifier.java @@ -23,7 +23,6 @@ import feign.FeignException; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; import org.springframework.web.client.RestClientException; @@ -41,7 +40,6 @@ public class TanVerifier { * * @param verificationServerClient The REST client to communicate with the verification server */ - @Autowired public TanVerifier(VerificationServerClient verificationServerClient) { this.verificationServerClient = verificationServerClient; }

diff --git a/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/RequestExecutor.java b/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/RequestExecutor.java --- a/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/RequestExecutor.java +++ b/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/RequestExecutor.java @@ -29,7 +29,6 @@ import java.time.Instant; import java.time.LocalDate; import java.util.Collection; -import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.web.client.TestRestTemplate; import org.springframework.http.HttpHeaders; import org.springframework.http.HttpMethod; @@ -50,7 +49,6 @@ public class RequestExecutor { private static final URI SUBMISSION_URL = URI.create("/version/v1/diagnosis-keys"); private final TestRestTemplate testRestTemplate; - @Autowired public RequestExecutor(TestRestTemplate testRestTemplate) { this.testRestTemplate = testRestTemplate; }

Use Implicit Constructor Injection over Explicit The `@Autowired` annotation for Spring components can be omitted for constructors in case there is only one constructor present on the class. Therefore, remove all the unnecessary annotation for those cases.

I guess it should be doable for me to get started

corona-warn-app/cwa-server

corona-warn-app__cwa-server-431

20492aaed28176142700486f99877b602b9f1cde

diff --git a/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/app_config.proto b/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/app_config.proto --- a/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/app_config.proto +++ b/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/app_config.proto @@ -5,6 +5,7 @@ option java_multiple_files = true; import "app/coronawarn/server/common/protocols/internal/risk_score_classification.proto"; import "app/coronawarn/server/common/protocols/internal/risk_score_parameters.proto"; import "app/coronawarn/server/common/protocols/internal/app_version_config.proto"; +import "app/coronawarn/server/common/protocols/internal/attenuation_duration.proto"; message ApplicationConfiguration { @@ -14,12 +15,7 @@ message ApplicationConfiguration { app.coronawarn.server.common.protocols.internal.RiskScoreParameters exposureConfig = 3; - AttenuationDurationThresholds attenuationDurationThresholds = 4; + app.coronawarn.server.common.protocols.internal.AttenuationDuration attenuationDuration = 4; app.coronawarn.server.common.protocols.internal.ApplicationVersionConfiguration appVersion = 5; } - -message AttenuationDurationThresholds { - int32 lower = 1; - int32 upper = 2; -} \ No newline at end of file diff --git a/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/attenuation_duration.proto b/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/attenuation_duration.proto new file mode 100644 --- /dev/null +++ b/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/attenuation_duration.proto @@ -0,0 +1,20 @@ +syntax = "proto3"; +package app.coronawarn.server.common.protocols.internal; +option java_package = "app.coronawarn.server.common.protocols.internal"; +option java_multiple_files = true; + +message AttenuationDuration { + Thresholds thresholds = 1; + Weights weights = 2; +} + +message Thresholds { + int32 lower = 1; + int32 upper = 2; +} + +message Weights { + double low = 1; + double mid = 2; + double high = 3; +} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ApplicationConfigurationValidator.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ApplicationConfigurationValidator.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ApplicationConfigurationValidator.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ApplicationConfigurationValidator.java @@ -20,11 +20,6 @@ package app.coronawarn.server.services.distribution.assembly.appconfig.validation; -import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.GeneralValidationError.ErrorType.MIN_GREATER_THAN_MAX; -import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.GeneralValidationError.ErrorType.VALUE_OUT_OF_BOUNDS; -import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ParameterSpec.ATTENUATION_DURATION_THRESHOLD_MAX; -import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ParameterSpec.ATTENUATION_DURATION_THRESHOLD_MIN; - import app.coronawarn.server.common.protocols.internal.ApplicationConfiguration; import app.coronawarn.server.common.protocols.internal.RiskScoreClassification; import app.coronawarn.server.common.protocols.internal.RiskScoreParameters; @@ -51,12 +46,13 @@ public ValidationResult validate() { this.errors = new ValidationResult(); validateMinRisk(); - validateAttenuationDurationThresholds(); - ValidationResult exposureResult = new ExposureConfigurationValidator(config.getExposureConfig()).validate(); - ValidationResult riskScoreResult = new RiskScoreClassificationValidator(config.getRiskScoreClasses()).validate(); + errors.with(new ExposureConfigurationValidator(config.getExposureConfig()).validate()); + errors.with(new RiskScoreClassificationValidator(config.getRiskScoreClasses()).validate()); + errors.with(new ApplicationVersionConfigurationValidator(config.getAppVersion()).validate()); + errors.with(new AttenuationDurationValidator(config.getAttenuationDuration()).validate()); - return errors.with(exposureResult).with(riskScoreResult); + return errors; } private void validateMinRisk() { @@ -66,25 +62,4 @@ private void validateMinRisk() { this.errors.add(new MinimumRiskLevelValidationError(minLevel)); } } - - private void validateAttenuationDurationThresholds() { - int lower = config.getAttenuationDurationThresholds().getLower(); - int upper = config.getAttenuationDurationThresholds().getUpper(); - - checkThresholdBound("lower", lower); - checkThresholdBound("upper", upper); - - if (lower > upper) { - String parameters = "attenuationDurationThreshold.lower, attenuationDurationThreshold.upper"; - String values = lower + ", " + upper; - this.errors.add(new GeneralValidationError(parameters, values, MIN_GREATER_THAN_MAX)); - } - } - - private void checkThresholdBound(String boundLabel, int boundValue) { - if (boundValue < ATTENUATION_DURATION_THRESHOLD_MIN || boundValue > ATTENUATION_DURATION_THRESHOLD_MAX) { - this.errors.add( - new GeneralValidationError("attenuationDurationThreshold." + boundLabel, boundValue, VALUE_OUT_OF_BOUNDS)); - } - } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/AttenuationDurationValidator.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/AttenuationDurationValidator.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/AttenuationDurationValidator.java @@ -0,0 +1,94 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.assembly.appconfig.validation; + +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.GeneralValidationError.ErrorType.MIN_GREATER_THAN_MAX; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.GeneralValidationError.ErrorType.VALUE_OUT_OF_BOUNDS; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ParameterSpec.ATTENUATION_DURATION_THRESHOLD_MAX; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ParameterSpec.ATTENUATION_DURATION_THRESHOLD_MIN; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ParameterSpec.ATTENUATION_DURATION_WEIGHT_MAX; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ParameterSpec.ATTENUATION_DURATION_WEIGHT_MIN; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.WeightValidationError.ErrorType.OUT_OF_RANGE; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.WeightValidationError.ErrorType.TOO_MANY_DECIMAL_PLACES; + +import app.coronawarn.server.common.protocols.internal.AttenuationDuration; +import java.math.BigDecimal; + +/** + * The AttenuationDurationValidator validates the values of an associated {@link AttenuationDuration} instance. + */ +public class AttenuationDurationValidator extends ConfigurationValidator { + + private final AttenuationDuration attenuationDuration; + + public AttenuationDurationValidator(AttenuationDuration attenuationDuration) { + this.attenuationDuration = attenuationDuration; + } + + @Override + public ValidationResult validate() { + errors = new ValidationResult(); + + validateThresholds(); + validateWeights(); + + return errors; + } + + private void validateThresholds() { + int lower = attenuationDuration.getThresholds().getLower(); + int upper = attenuationDuration.getThresholds().getUpper(); + + checkThresholdBound("lower", lower); + checkThresholdBound("upper", upper); + + if (lower > upper) { + String parameters = "attenuation-duration.thresholds.lower, attenuation-duration.thresholds.upper"; + String values = lower + ", " + upper; + this.errors.add(new GeneralValidationError(parameters, values, MIN_GREATER_THAN_MAX)); + } + } + + private void checkThresholdBound(String thresholdLabel, int thresholdValue) { + if (thresholdValue < ATTENUATION_DURATION_THRESHOLD_MIN || thresholdValue > ATTENUATION_DURATION_THRESHOLD_MAX) { + this.errors.add(new GeneralValidationError( + "attenuation-duration.thresholds." + thresholdLabel, thresholdValue, VALUE_OUT_OF_BOUNDS)); + } + } + + private void validateWeights() { + checkWeight("low", attenuationDuration.getWeights().getLow()); + checkWeight("mid", attenuationDuration.getWeights().getMid()); + checkWeight("high", attenuationDuration.getWeights().getHigh()); + } + + private void checkWeight(String weightLabel, double weightValue) { + if (weightValue < ATTENUATION_DURATION_WEIGHT_MIN || weightValue > ATTENUATION_DURATION_WEIGHT_MAX) { + this.errors.add(new WeightValidationError( + "attenuation-duration.weights." + weightLabel, weightValue, OUT_OF_RANGE)); + } + + if (BigDecimal.valueOf(weightValue).scale() > ParameterSpec.ATTENUATION_DURATION_WEIGHT_MAX_DECIMALS) { + this.errors.add(new WeightValidationError( + "attenuation-duration.weights." + weightLabel, weightValue, TOO_MANY_DECIMAL_PLACES)); + } + } +} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ParameterSpec.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ParameterSpec.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ParameterSpec.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ParameterSpec.java @@ -63,4 +63,19 @@ private ParameterSpec() { * The allowed maximum value for an attenuation threshold. */ public static final int ATTENUATION_DURATION_THRESHOLD_MAX = 100; + + /** + * The allowed minimum value for an attenuation weight. + */ + public static final double ATTENUATION_DURATION_WEIGHT_MIN = .0; + + /** + * The allowed maximum value for an attenuation weight. + */ + public static final double ATTENUATION_DURATION_WEIGHT_MAX = 1.; + + /** + * Maximum number of allowed decimals for an attenuation weight. + */ + public static final int ATTENUATION_DURATION_WEIGHT_MAX_DECIMALS = 3; } diff --git a/services/distribution/src/main/resources/master-config/app-config.yaml b/services/distribution/src/main/resources/master-config/app-config.yaml --- a/services/distribution/src/main/resources/master-config/app-config.yaml +++ b/services/distribution/src/main/resources/master-config/app-config.yaml @@ -9,9 +9,7 @@ # Change this file with caution! min-risk-score: 90 -attenuationDurationThresholds: - lower: 50 - upper: 70 +attenuation-duration: !include attenuation-duration.yaml risk-score-classes: !include risk-score-classification.yaml exposure-config: !include exposure-config.yaml -app-version: !include app-version-config.yaml \ No newline at end of file +app-version: !include app-version-config.yaml diff --git a/services/distribution/src/main/resources/master-config/attenuation-duration.yaml b/services/distribution/src/main/resources/master-config/attenuation-duration.yaml new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/resources/master-config/attenuation-duration.yaml @@ -0,0 +1,15 @@ +# This is the attenuation and duration parameter thresholds. The lower and +# upper threshold partitions the value range into 3 subsets: low, mid, high +# +# Each of the aforementioned partitions has a weight in the range of [0, 1] +# assigned to it. The number of decimal places is restricted to 3. +# +# Change this file with caution! + +thresholds: + lower: 50 + upper: 70 +weights: + low: 1.0 + mid: 0.5 + high: 0.0

diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/AttenuationDurationMasterFileTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/AttenuationDurationMasterFileTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/AttenuationDurationMasterFileTest.java @@ -0,0 +1,47 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.assembly.appconfig; + +import static org.assertj.core.api.Assertions.assertThat; + +import app.coronawarn.server.common.protocols.internal.AttenuationDuration; +import app.coronawarn.server.services.distribution.assembly.appconfig.validation.AttenuationDurationValidator; +import app.coronawarn.server.services.distribution.assembly.appconfig.validation.ConfigurationValidator; +import app.coronawarn.server.services.distribution.assembly.appconfig.validation.ValidationResult; +import org.junit.jupiter.api.Test; + +/** + * This test will verify that the provided attenuation/duration parameters master file is syntactically correct and + * according to spec. There should never be any deployment when this test is failing. + */ +class AttenuationDurationMasterFileTest { + + private static final ValidationResult SUCCESS = new ValidationResult(); + + @Test + void testMasterFile() throws UnableToLoadFileException { + AttenuationDuration config = ApplicationConfigurationProvider.readMasterFile().getAttenuationDuration(); + + ConfigurationValidator validator = new AttenuationDurationValidator(config); + + assertThat(validator.validate()).isEqualTo(SUCCESS); + } +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ApplicationConfigurationValidatorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ApplicationConfigurationValidatorTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ApplicationConfigurationValidatorTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ApplicationConfigurationValidatorTest.java @@ -20,26 +20,16 @@ package app.coronawarn.server.services.distribution.assembly.appconfig.validation; -import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.GeneralValidationError.ErrorType.MIN_GREATER_THAN_MAX; -import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.GeneralValidationError.ErrorType.VALUE_OUT_OF_BOUNDS; -import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ParameterSpec.ATTENUATION_DURATION_THRESHOLD_MAX; -import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ParameterSpec.ATTENUATION_DURATION_THRESHOLD_MIN; -import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidatorTest.MINIMAL_RISK_SCORE_CLASSIFICATION; -import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidatorTest.buildExpectedResult; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatThrownBy; -import app.coronawarn.server.common.protocols.internal.ApplicationConfiguration; -import app.coronawarn.server.common.protocols.internal.AttenuationDurationThresholds; import app.coronawarn.server.services.distribution.assembly.appconfig.ApplicationConfigurationProvider; -import app.coronawarn.server.services.distribution.assembly.appconfig.ExposureConfigurationProvider; import app.coronawarn.server.services.distribution.assembly.appconfig.UnableToLoadFileException; import java.util.stream.Stream; import org.junit.jupiter.api.Test; import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.Arguments; import org.junit.jupiter.params.provider.MethodSource; -import org.junit.jupiter.params.provider.ValueSource; class ApplicationConfigurationValidatorTest { @@ -59,43 +49,6 @@ void negative(TestWithExpectedResult test) throws UnableToLoadFileException { assertThat(getResultForTest(test)).isEqualTo(test.result); } - @ParameterizedTest - @ValueSource(ints = {ATTENUATION_DURATION_THRESHOLD_MIN - 1, ATTENUATION_DURATION_THRESHOLD_MAX + 1}) - void negativeForAttenuationDurationThresholdOutOfBounds(int invalidThresholdValue) throws Exception { - ApplicationConfigurationValidator validator = getValidatorForAttenuationDurationThreshold( - invalidThresholdValue, invalidThresholdValue); - - ValidationResult expectedResult = buildExpectedResult( - new GeneralValidationError("attenuationDurationThreshold.upper", invalidThresholdValue, VALUE_OUT_OF_BOUNDS), - new GeneralValidationError("attenuationDurationThreshold.lower", invalidThresholdValue, VALUE_OUT_OF_BOUNDS)); - - assertThat(validator.validate()).isEqualTo(expectedResult); - } - - @Test - void negativeForUpperAttenuationDurationThresholdLesserThanLower() throws Exception { - ApplicationConfigurationValidator validator = getValidatorForAttenuationDurationThreshold( - ATTENUATION_DURATION_THRESHOLD_MAX, ATTENUATION_DURATION_THRESHOLD_MIN); - - ValidationResult expectedResult = buildExpectedResult( - new GeneralValidationError("attenuationDurationThreshold.lower, attenuationDurationThreshold.upper", - (ATTENUATION_DURATION_THRESHOLD_MAX + ", " + ATTENUATION_DURATION_THRESHOLD_MIN), MIN_GREATER_THAN_MAX)); - - assertThat(validator.validate()).isEqualTo(expectedResult); - } - - private ApplicationConfigurationValidator getValidatorForAttenuationDurationThreshold(int lower, int upper) - throws Exception { - ApplicationConfiguration appConfig = ApplicationConfiguration.newBuilder() - .setMinRiskScore(100) - .setRiskScoreClasses(MINIMAL_RISK_SCORE_CLASSIFICATION) - .setExposureConfig(ExposureConfigurationProvider.readFile("configtests/exposure-config_ok.yaml")) - .setAttenuationDurationThresholds(AttenuationDurationThresholds.newBuilder() - .setLower(lower) - .setUpper(upper)).build(); - return new ApplicationConfigurationValidator(appConfig); - } - @Test void circular() { assertThatThrownBy(() -> { diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/AttenuationDurationValidatorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/AttenuationDurationValidatorTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/AttenuationDurationValidatorTest.java @@ -0,0 +1,114 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.assembly.appconfig.validation; + +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.GeneralValidationError.ErrorType.MIN_GREATER_THAN_MAX; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.GeneralValidationError.ErrorType.VALUE_OUT_OF_BOUNDS; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ParameterSpec.ATTENUATION_DURATION_THRESHOLD_MAX; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ParameterSpec.ATTENUATION_DURATION_THRESHOLD_MIN; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ParameterSpec.ATTENUATION_DURATION_WEIGHT_MAX; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ParameterSpec.ATTENUATION_DURATION_WEIGHT_MIN; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidatorTest.buildError; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidatorTest.buildExpectedResult; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.WeightValidationError.ErrorType.OUT_OF_RANGE; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.WeightValidationError.ErrorType.TOO_MANY_DECIMAL_PLACES; +import static org.assertj.core.api.Assertions.assertThat; + +import app.coronawarn.server.common.protocols.internal.AttenuationDuration; +import app.coronawarn.server.common.protocols.internal.Thresholds; +import app.coronawarn.server.common.protocols.internal.Weights; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.ValueSource; + +public class AttenuationDurationValidatorTest { + private static final Thresholds VALID_THRESHOLDS = + buildThresholds(ATTENUATION_DURATION_THRESHOLD_MIN, ATTENUATION_DURATION_THRESHOLD_MAX); + private static final Weights VALID_WEIGHTS = + buildWeights(ATTENUATION_DURATION_WEIGHT_MAX, ATTENUATION_DURATION_WEIGHT_MAX, ATTENUATION_DURATION_WEIGHT_MAX); + + @ParameterizedTest + @ValueSource(ints = {ATTENUATION_DURATION_THRESHOLD_MIN - 1, ATTENUATION_DURATION_THRESHOLD_MAX + 1}) + void failsIfAttenuationDurationThresholdOutOfBounds(int invalidThresholdValue) { + AttenuationDurationValidator validator = buildValidator( + buildThresholds(invalidThresholdValue, invalidThresholdValue), VALID_WEIGHTS); + + ValidationResult expectedResult = buildExpectedResult( + buildError("attenuation-duration.thresholds.lower", invalidThresholdValue, VALUE_OUT_OF_BOUNDS), + buildError("attenuation-duration.thresholds.upper", invalidThresholdValue, VALUE_OUT_OF_BOUNDS)); + + assertThat(validator.validate()).isEqualTo(expectedResult); + } + + @Test + void failsIfUpperAttenuationDurationThresholdLesserThanLower() { + AttenuationDurationValidator validator = buildValidator( + buildThresholds(ATTENUATION_DURATION_THRESHOLD_MAX, ATTENUATION_DURATION_THRESHOLD_MIN), VALID_WEIGHTS); + + ValidationResult expectedResult = buildExpectedResult( + new GeneralValidationError("attenuation-duration.thresholds.lower, attenuation-duration.thresholds.upper", + (ATTENUATION_DURATION_THRESHOLD_MAX + ", " + ATTENUATION_DURATION_THRESHOLD_MIN), MIN_GREATER_THAN_MAX)); + + assertThat(validator.validate()).isEqualTo(expectedResult); + } + + @ParameterizedTest + @ValueSource(doubles = {ATTENUATION_DURATION_WEIGHT_MIN - .1, ATTENUATION_DURATION_WEIGHT_MAX + .1}) + void failsIfWeightsOutOfBounds(double invalidWeightValue) { + AttenuationDurationValidator validator = buildValidator(VALID_THRESHOLDS, + buildWeights(invalidWeightValue, invalidWeightValue, invalidWeightValue)); + + ValidationResult expectedResult = buildExpectedResult( + new WeightValidationError("attenuation-duration.weights.low", invalidWeightValue, OUT_OF_RANGE), + new WeightValidationError("attenuation-duration.weights.mid", invalidWeightValue, OUT_OF_RANGE), + new WeightValidationError("attenuation-duration.weights.high", invalidWeightValue, OUT_OF_RANGE)); + + assertThat(validator.validate()).isEqualTo(expectedResult); + } + + @Test + void failsIfWeightsHaveTooManyDecimalPlaces() { + double invalidWeightValue = ATTENUATION_DURATION_WEIGHT_MAX - 0.0000001; + AttenuationDurationValidator validator = buildValidator(VALID_THRESHOLDS, + buildWeights(invalidWeightValue, invalidWeightValue, invalidWeightValue)); + + ValidationResult expectedResult = buildExpectedResult( + new WeightValidationError("attenuation-duration.weights.low", invalidWeightValue, TOO_MANY_DECIMAL_PLACES), + new WeightValidationError("attenuation-duration.weights.mid", invalidWeightValue, TOO_MANY_DECIMAL_PLACES), + new WeightValidationError("attenuation-duration.weights.high", invalidWeightValue, TOO_MANY_DECIMAL_PLACES)); + + assertThat(validator.validate()).isEqualTo(expectedResult); + } + + private static AttenuationDurationValidator buildValidator(Thresholds thresholds, Weights weights) { + return new AttenuationDurationValidator(AttenuationDuration.newBuilder() + .setThresholds(thresholds) + .setWeights(weights).build()); + } + + private static Thresholds buildThresholds(int lower, int upper) { + return Thresholds.newBuilder().setLower(lower).setUpper(upper).build(); + } + + private static Weights buildWeights(double low, double mid, double high) { + return Weights.newBuilder().setLow(low).setMid(mid).setHigh(high).build(); + } +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidatorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidatorTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidatorTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidatorTest.java @@ -166,7 +166,7 @@ private static RiskScoreClass buildRiskClass(String label, int min, int max, Str return RiskScoreClass.newBuilder().setLabel(label).setMin(min).setMax(max).setUrl(url).build(); } - public static ValidationResult buildExpectedResult(GeneralValidationError... errors) { + public static ValidationResult buildExpectedResult(ValidationError... errors) { var validationResult = new ValidationResult(); Arrays.stream(errors).forEach(validationResult::add); return validationResult; diff --git a/services/distribution/src/test/resources/configtests/app-config_ok.yaml b/services/distribution/src/test/resources/configtests/app-config_ok.yaml --- a/services/distribution/src/test/resources/configtests/app-config_ok.yaml +++ b/services/distribution/src/test/resources/configtests/app-config_ok.yaml @@ -1,7 +1,5 @@ min-risk-score: 100 -attenuationDurationThresholds: - lower: 50 - upper: 70 +attenuation-duration: !include attenuation-duration.yaml risk-score-classes: !include risk-score-class_ok.yaml exposure-config: !include exposure-config_ok.yaml -app-version: !include app-version-config_ok.yaml \ No newline at end of file +app-version: !include app-version-config_ok.yaml diff --git a/services/distribution/src/test/resources/configtests/attenuation-duration.yaml b/services/distribution/src/test/resources/configtests/attenuation-duration.yaml new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/resources/configtests/attenuation-duration.yaml @@ -0,0 +1,7 @@ +thresholds: + lower: 50 + upper: 70 +weights: + low: 1.0 + mid: 0.5 + high: 0.0

Application Configuration: Attenuation Duration The RKI requested weighting parameters for the three buckets defined by the attenuation duration threshold. Add this to the attenuation duration configuration. @michael-burwig ```yaml attenuation-duration: thresholds: lower: 50 upper: 70 weights: low: 1 # attenuation < 50 dB mid: 0.5 # attenuation >50 dB && < 70 dB high: 0 # attenuation > 70dB is ignored ```

Are the weights in the range of [0, 1]? Is the threshold value range still [0, 100]? Thresholds remain unchanged. For weight, lets go with 0...1 for now. There will be another RKI call in the afternoon which might change that though.

corona-warn-app/cwa-server

corona-warn-app__cwa-server-436

ebb112166c8b6bf21ba18232db773be9a03b93e8

diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/DiagnosisKeysStructureProvider.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/DiagnosisKeysStructureProvider.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/DiagnosisKeysStructureProvider.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/DiagnosisKeysStructureProvider.java @@ -27,6 +27,8 @@ import app.coronawarn.server.services.distribution.assembly.structure.WritableOnDisk; import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import java.time.LocalDateTime; +import java.time.temporal.ChronoUnit; import java.util.Collection; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -65,7 +67,7 @@ public class DiagnosisKeysStructureProvider { public Directory<WritableOnDisk> getDiagnosisKeys() { logger.debug("Querying diagnosis keys from the database..."); Collection<DiagnosisKey> diagnosisKeys = diagnosisKeyService.getDiagnosisKeys(); - diagnosisKeyBundler.setDiagnosisKeys(diagnosisKeys); + diagnosisKeyBundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.now().truncatedTo(ChronoUnit.HOURS)); return new DiagnosisKeysDirectory(diagnosisKeyBundler, cryptoProvider, distributionServiceConfig); } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/DemoDiagnosisKeyBundler.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/DemoDiagnosisKeyBundler.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/DemoDiagnosisKeyBundler.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/DemoDiagnosisKeyBundler.java @@ -24,15 +24,13 @@ import app.coronawarn.server.common.persistence.domain.DiagnosisKey; import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; -import java.time.LocalDateTime; import java.util.Collection; -import java.util.List; import org.springframework.context.annotation.Profile; import org.springframework.stereotype.Component; /** - * An instance of this class contains a collection of {@link DiagnosisKey DiagnosisKeys}, that will be distributed - * in the same hour they have been submitted. + * An instance of this class contains a collection of {@link DiagnosisKey DiagnosisKeys}, that will be distributed in + * the same hour they have been submitted. */ @Profile("demo") @Component @@ -44,20 +42,11 @@ public DemoDiagnosisKeyBundler(DistributionServiceConfig distributionServiceConf /** * Initializes the internal {@code distributableDiagnosisKeys} map, grouping the diagnosis keys by the submission - * timestamp, thus ignoring the expiry policy. + * timestamp, thus ignoring the expiry and shifting policies. */ @Override protected void createDiagnosisKeyDistributionMap(Collection<DiagnosisKey> diagnosisKeys) { this.distributableDiagnosisKeys.clear(); this.distributableDiagnosisKeys.putAll(diagnosisKeys.stream().collect(groupingBy(this::getSubmissionDateTime))); } - - /** - * Returns all diagnosis keys that should be distributed in a specific hour, without respecting the shifting and - * expiry policies. - */ - @Override - public List<DiagnosisKey> getDiagnosisKeysDistributableAt(LocalDateTime hour) { - return this.getDiagnosisKeysForHour(hour); - } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/DiagnosisKeyBundler.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/DiagnosisKeyBundler.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/DiagnosisKeyBundler.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/DiagnosisKeyBundler.java @@ -20,18 +20,20 @@ package app.coronawarn.server.services.distribution.assembly.diagnosiskeys; -import static app.coronawarn.server.services.distribution.assembly.diagnosiskeys.util.DateTime.ONE_HOUR_INTERVAL_SECONDS; import static java.time.ZoneOffset.UTC; import static java.util.Collections.emptyList; import app.coronawarn.server.common.persistence.domain.DiagnosisKey; import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import java.time.LocalDate; import java.time.LocalDateTime; import java.util.Collection; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.Optional; +import java.util.Set; +import java.util.concurrent.TimeUnit; import java.util.stream.Collectors; /** @@ -39,9 +41,23 @@ */ public abstract class DiagnosisKeyBundler { + /** + * The submission timestamp is counted in 1 hour intervals since epoch. + */ + public static final long ONE_HOUR_INTERVAL_SECONDS = TimeUnit.HOURS.toSeconds(1); + + /** + * The rolling start interval number is counted in 10 minute intervals since epoch. + */ + public static final long TEN_MINUTES_INTERVAL_SECONDS = TimeUnit.MINUTES.toSeconds(10); + protected final int minNumberOfKeysPerBundle; protected final long expiryPolicyMinutes; + // The hour at which the distribution runs. This field is needed to prevent the run from distributing any keys that + // have already been submitted but may only be distributed in the future (e.g. because they are not expired yet). + protected LocalDateTime distributionTime; + // A map containing diagnosis keys, grouped by the LocalDateTime on which they may be distributed protected final Map<LocalDateTime, List<DiagnosisKey>> distributableDiagnosisKeys = new HashMap<>(); @@ -51,11 +67,22 @@ public DiagnosisKeyBundler(DistributionServiceConfig distributionServiceConfig) } /** - * Sets the {@link DiagnosisKey DiagnosisKeys} contained by this {@link DiagnosisKeyBundler} and calls {@link - * DiagnosisKeyBundler#createDiagnosisKeyDistributionMap}. + * Creates a {@link LocalDateTime} based on the specified epoch timestamp. + */ + public static LocalDateTime getLocalDateTimeFromHoursSinceEpoch(long timestamp) { + return LocalDateTime.ofEpochSecond(TimeUnit.HOURS.toSeconds(timestamp), 0, UTC); + } + + /** + * Sets the {@link DiagnosisKey DiagnosisKeys} contained by this {@link DiagnosisKeyBundler} and the time at which the + * distribution runs and calls {@link DiagnosisKeyBundler#createDiagnosisKeyDistributionMap}. + * + * @param diagnosisKeys The {@link DiagnosisKey DiagnosisKeys} contained by this {@link DiagnosisKeyBundler}. + * @param distributionTime The {@link LocalDateTime} at which the distribution runs. */ - public void setDiagnosisKeys(Collection<DiagnosisKey> diagnosisKeys) { - createDiagnosisKeyDistributionMap(diagnosisKeys); + public void setDiagnosisKeys(Collection<DiagnosisKey> diagnosisKeys, LocalDateTime distributionTime) { + this.distributionTime = distributionTime; + this.createDiagnosisKeyDistributionMap(diagnosisKeys); } /** @@ -74,9 +101,23 @@ public List<DiagnosisKey> getAllDiagnosisKeys() { protected abstract void createDiagnosisKeyDistributionMap(Collection<DiagnosisKey> diagnosisKeys); /** - * Returns all diagnosis keys that should be distributed in a specific hour. + * Returns a set of all {@link LocalDate dates} on which {@link DiagnosisKey diagnosis keys} shall be distributed. */ - public abstract List<DiagnosisKey> getDiagnosisKeysDistributableAt(LocalDateTime hour); + public Set<LocalDate> getDatesWithDistributableDiagnosisKeys() { + return this.distributableDiagnosisKeys.keySet().stream() + .map(LocalDateTime::toLocalDate) + .collect(Collectors.toSet()); + } + + /** + * Returns a set of all {@link LocalDateTime hours} of a specified {@link LocalDate date} during which {@link + * DiagnosisKey diagnosis keys} shall be distributed. + */ + public Set<LocalDateTime> getHoursWithDistributableDiagnosisKeys(LocalDate currentDate) { + return this.distributableDiagnosisKeys.keySet().stream() + .filter(dateTime -> dateTime.toLocalDate().equals(currentDate)) + .collect(Collectors.toSet()); + } /** * Returns the submission timestamp of a {@link DiagnosisKey} as a {@link LocalDateTime}. @@ -85,10 +126,21 @@ protected LocalDateTime getSubmissionDateTime(DiagnosisKey diagnosisKey) { return LocalDateTime.ofEpochSecond(diagnosisKey.getSubmissionTimestamp() * ONE_HOUR_INTERVAL_SECONDS, 0, UTC); } + /** + * Returns all diagnosis keys that should be distributed on a specific date. + */ + public List<DiagnosisKey> getDiagnosisKeysForDate(LocalDate date) { + return this.distributableDiagnosisKeys.keySet().stream() + .filter(dateTime -> dateTime.toLocalDate().equals(date)) + .map(this::getDiagnosisKeysForHour) + .flatMap(List::stream) + .collect(Collectors.toList()); + } + /** * Returns all diagnosis keys that should be distributed in a specific hour. */ - protected List<DiagnosisKey> getDiagnosisKeysForHour(LocalDateTime hour) { + public List<DiagnosisKey> getDiagnosisKeysForHour(LocalDateTime hour) { return Optional .ofNullable(this.distributableDiagnosisKeys.get(hour)) .orElse(emptyList()); diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundler.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundler.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundler.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundler.java @@ -20,7 +20,6 @@ package app.coronawarn.server.services.distribution.assembly.diagnosiskeys; -import static app.coronawarn.server.services.distribution.assembly.diagnosiskeys.util.DateTime.TEN_MINUTES_INTERVAL_SECONDS; import static java.time.ZoneOffset.UTC; import static java.util.Collections.emptyList; import static java.util.stream.Collectors.groupingBy; @@ -30,11 +29,13 @@ import java.time.Duration; import java.time.LocalDateTime; import java.time.temporal.ChronoUnit; +import java.util.ArrayList; import java.util.Collection; +import java.util.HashMap; import java.util.List; +import java.util.Map; import java.util.Optional; -import java.util.stream.Collectors; -import java.util.stream.Stream; +import java.util.stream.LongStream; import org.springframework.context.annotation.Profile; import org.springframework.stereotype.Component; @@ -57,55 +58,38 @@ public ProdDiagnosisKeyBundler(DistributionServiceConfig distributionServiceConf /** * Initializes the internal {@code distributableDiagnosisKeys} map, grouping the diagnosis keys by the date on which - * they may be distributed, while respecting the expiry policy. + * they may be distributed, while respecting the expiry and shifting policies. */ @Override protected void createDiagnosisKeyDistributionMap(Collection<DiagnosisKey> diagnosisKeys) { this.distributableDiagnosisKeys.clear(); - this.distributableDiagnosisKeys.putAll(diagnosisKeys.stream().collect(groupingBy(this::getDistributionDateTime))); - } - - /** - * Returns all diagnosis keys that should be distributed in a specific hour, while respecting the shifting and expiry - * policies. - */ - @Override - public List<DiagnosisKey> getDiagnosisKeysDistributableAt(LocalDateTime hour) { - List<DiagnosisKey> keysSinceLastDistribution = getKeysSinceLastDistribution(hour); - if (keysSinceLastDistribution.size() >= minNumberOfKeysPerBundle) { - return keysSinceLastDistribution; - } else { - return emptyList(); + if (diagnosisKeys.isEmpty()) { + return; } - } + Map<LocalDateTime, List<DiagnosisKey>> distributableDiagnosisKeysGroupedByExpiryPolicy = new HashMap<>( + diagnosisKeys.stream().collect(groupingBy(this::getDistributionDateTimeByExpiryPolicy))); + LocalDateTime earliestDistributableTimestamp = + getEarliestDistributableTimestamp(distributableDiagnosisKeysGroupedByExpiryPolicy).orElseThrow(); + LocalDateTime latestDistributableTimestamp = this.distributionTime; - /** - * Returns a all distributable keys between a specific hour and the last distribution (bundle that was above the - * shifting threshold) or the earliest distributable key. - */ - private List<DiagnosisKey> getKeysSinceLastDistribution(LocalDateTime hour) { - Optional<LocalDateTime> earliestDistributableTimestamp = getEarliestDistributableTimestamp(); - if (earliestDistributableTimestamp.isEmpty() || hour.isBefore(earliestDistributableTimestamp.get())) { - return emptyList(); - } - List<DiagnosisKey> distributableInCurrentHour = getDiagnosisKeysForHour(hour); - if (distributableInCurrentHour.size() >= minNumberOfKeysPerBundle) { - return distributableInCurrentHour; - } - LocalDateTime previousHour = hour.minusHours(1); - Collection<DiagnosisKey> distributableInPreviousHour = getDiagnosisKeysDistributableAt(previousHour); - if (distributableInPreviousHour.size() >= minNumberOfKeysPerBundle) { - // Last hour was distributed, so we can not combine the current hour with the last hour - return distributableInCurrentHour; - } else { - // Last hour was not distributed, so we can combine the current hour with the last hour - return Stream.concat(distributableInCurrentHour.stream(), getKeysSinceLastDistribution(previousHour).stream()) - .collect(Collectors.toList()); - } + List<DiagnosisKey> diagnosisKeyAccumulator = new ArrayList<>(); + LongStream.range(0, earliestDistributableTimestamp.until(latestDistributableTimestamp, ChronoUnit.HOURS)) + .forEach(hourCounter -> { + LocalDateTime currentHour = earliestDistributableTimestamp.plusHours(hourCounter); + Collection<DiagnosisKey> currentHourDiagnosisKeys = Optional + .ofNullable(distributableDiagnosisKeysGroupedByExpiryPolicy.get(currentHour)) + .orElse(emptyList()); + diagnosisKeyAccumulator.addAll(currentHourDiagnosisKeys); + if (diagnosisKeyAccumulator.size() >= minNumberOfKeysPerBundle) { + this.distributableDiagnosisKeys.put(currentHour, new ArrayList<>(diagnosisKeyAccumulator)); + diagnosisKeyAccumulator.clear(); + } + }); } - private Optional<LocalDateTime> getEarliestDistributableTimestamp() { - return this.distributableDiagnosisKeys.keySet().stream().min(LocalDateTime::compareTo); + private static Optional<LocalDateTime> getEarliestDistributableTimestamp( + Map<LocalDateTime, List<DiagnosisKey>> distributableDiagnosisKeys) { + return distributableDiagnosisKeys.keySet().stream().min(LocalDateTime::compareTo); } /** @@ -118,12 +102,13 @@ private LocalDateTime getExpiryDateTime(DiagnosisKey diagnosisKey) { } /** - * Calculates the earliest point in time at which the specified {@link DiagnosisKey} can be distributed. Before keys - * are allowed to be distributed, they must be expired for a configured amount of time. + * Calculates the earliest point in time at which the specified {@link DiagnosisKey} can be distributed, while + * respecting the expiry policy and the submission timestamp. Before keys are allowed to be distributed, they must be + * expired for a configured amount of time. * * @return {@link LocalDateTime} at which the specified {@link DiagnosisKey} can be distributed. */ - private LocalDateTime getDistributionDateTime(DiagnosisKey diagnosisKey) { + private LocalDateTime getDistributionDateTimeByExpiryPolicy(DiagnosisKey diagnosisKey) { LocalDateTime submissionDateTime = getSubmissionDateTime(diagnosisKey); LocalDateTime expiryDateTime = getExpiryDateTime(diagnosisKey); long minutesBetweenExpiryAndSubmission = Duration.between(expiryDateTime, submissionDateTime).toMinutes(); diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectory.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectory.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectory.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectory.java @@ -24,7 +24,6 @@ import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.DiagnosisKeyBundler; import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory.decorator.HourIndexingDecorator; -import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.util.DateTime; import app.coronawarn.server.services.distribution.assembly.structure.WritableOnDisk; import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; import app.coronawarn.server.services.distribution.assembly.structure.directory.IndexDirectoryOnDisk; @@ -46,12 +45,12 @@ public class DiagnosisKeysDateDirectory extends IndexDirectoryOnDisk<LocalDate> * collection. Payload signing is be performed according to the specified {@link CryptoProvider}. * * @param diagnosisKeyBundler A {@link DiagnosisKeyBundler} containing the {@link DiagnosisKey DiagnosisKeys}. - * @param cryptoProvider The {@link CryptoProvider} used for payload signing. + * @param cryptoProvider The {@link CryptoProvider} used for payload signing. */ public DiagnosisKeysDateDirectory(DiagnosisKeyBundler diagnosisKeyBundler, CryptoProvider cryptoProvider, DistributionServiceConfig distributionServiceConfig) { super(distributionServiceConfig.getApi().getDatePath(), - __ -> DateTime.getDates(diagnosisKeyBundler.getAllDiagnosisKeys()), ISO8601::format); + __ -> diagnosisKeyBundler.getDatesWithDistributableDiagnosisKeys(), ISO8601::format); this.cryptoProvider = cryptoProvider; this.diagnosisKeyBundler = diagnosisKeyBundler; this.distributionServiceConfig = distributionServiceConfig; diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDirectory.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDirectory.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDirectory.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDirectory.java @@ -23,7 +23,6 @@ import app.coronawarn.server.common.persistence.domain.DiagnosisKey; import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.DiagnosisKeyBundler; -import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory.decorator.CountryIndexingDecorator; import app.coronawarn.server.services.distribution.assembly.structure.WritableOnDisk; import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; import app.coronawarn.server.services.distribution.assembly.structure.directory.DirectoryOnDisk; @@ -70,8 +69,6 @@ public void prepare(ImmutableStack<Object> indices) { private IndexDirectory<String, WritableOnDisk> decorateCountryDirectory( IndexDirectoryOnDisk<String> countryDirectory) { - return new CountryIndexingDecorator<>( - new IndexingDecoratorOnDisk<>(countryDirectory, distributionServiceConfig.getOutputFileName()), - distributionServiceConfig); + return new IndexingDecoratorOnDisk<>(countryDirectory, distributionServiceConfig.getOutputFileName()); } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectory.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectory.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectory.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectory.java @@ -25,7 +25,6 @@ import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.DiagnosisKeyBundler; import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.archive.decorator.singing.DiagnosisKeySigningDecorator; import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.file.TemporaryExposureKeyExportFile; -import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.util.DateTime; import app.coronawarn.server.services.distribution.assembly.structure.WritableOnDisk; import app.coronawarn.server.services.distribution.assembly.structure.archive.Archive; import app.coronawarn.server.services.distribution.assembly.structure.archive.ArchiveOnDisk; @@ -53,8 +52,9 @@ public class DiagnosisKeysHourDirectory extends IndexDirectoryOnDisk<LocalDateTi */ public DiagnosisKeysHourDirectory(DiagnosisKeyBundler diagnosisKeyBundler, CryptoProvider cryptoProvider, DistributionServiceConfig distributionServiceConfig) { - super(distributionServiceConfig.getApi().getHourPath(), indices -> DateTime.getHours(((LocalDate) indices.peek()), - diagnosisKeyBundler.getAllDiagnosisKeys()), LocalDateTime::getHour); + super(distributionServiceConfig.getApi().getHourPath(), + indices -> diagnosisKeyBundler.getHoursWithDistributableDiagnosisKeys(((LocalDate) indices.peek())), + LocalDateTime::getHour); this.diagnosisKeyBundler = diagnosisKeyBundler; this.cryptoProvider = cryptoProvider; this.distributionServiceConfig = distributionServiceConfig; @@ -70,7 +70,7 @@ public void prepare(ImmutableStack<Object> indices) { String region = (String) currentIndices.pop().pop().peek(); List<DiagnosisKey> diagnosisKeysForCurrentHour = - this.diagnosisKeyBundler.getDiagnosisKeysDistributableAt(currentHour); + this.diagnosisKeyBundler.getDiagnosisKeysForHour(currentHour); long startTimestamp = currentHour.toEpochSecond(ZoneOffset.UTC); long endTimestamp = currentHour.plusHours(1).toEpochSecond(ZoneOffset.UTC); diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/CountryIndexingDecorator.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/CountryIndexingDecorator.java deleted file mode 100644 --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/CountryIndexingDecorator.java +++ /dev/null @@ -1,110 +0,0 @@ -/*- - * ---license-start - * Corona-Warn-App - * --- - * Copyright (C) 2020 SAP SE and all other contributors - * --- - * 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 - * - * http://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. - * ---license-end - */ - -package app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory.decorator; - -import app.coronawarn.server.services.distribution.assembly.structure.Writable; -import app.coronawarn.server.services.distribution.assembly.structure.WritableOnDisk; -import app.coronawarn.server.services.distribution.assembly.structure.archive.Archive; -import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; -import app.coronawarn.server.services.distribution.assembly.structure.directory.DirectoryOnDisk; -import app.coronawarn.server.services.distribution.assembly.structure.directory.IndexDirectory; -import app.coronawarn.server.services.distribution.assembly.structure.directory.decorator.IndexDirectoryDecorator; -import app.coronawarn.server.services.distribution.assembly.structure.file.FileOnDisk; -import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; -import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; -import java.nio.charset.StandardCharsets; -import java.util.Collection; -import java.util.Set; -import java.util.stream.Collectors; - -/** - * This decorator creates the central index file for a country, e.g. DE. - */ -public class CountryIndexingDecorator<T> extends IndexDirectoryDecorator<T, WritableOnDisk> { - - /** - * Separate each entry in the index file with new line. - */ - private static final String NEW_LINE_SEPARATOR = "\r\n"; - - /** - * the name of this index file. - */ - private final String fileName; - - /** - * Creates a new decorator instance for the given directory. - * - * @param directory The target country directory. - * @param distributionServiceConfig The config. - */ - public CountryIndexingDecorator(IndexDirectory<T, WritableOnDisk> directory, - DistributionServiceConfig distributionServiceConfig) { - super(directory); - this.fileName = distributionServiceConfig.getOutputFileName(); - } - - @Override - public void prepare(ImmutableStack<Object> indices) { - super.prepare(indices); - - Collection<DirectoryOnDisk> countryDirectories = this.getWritables().stream() - .filter(Writable::isDirectory) - .map(directory -> (DirectoryOnDisk) directory) - .collect(Collectors.toSet()); - - countryDirectories.forEach(this::writeIndexFileForCountry); - } - - private void writeIndexFileForCountry(Directory<WritableOnDisk> directory) { - var dateDirectory = (Directory<WritableOnDisk>) directory.getWritables() - .stream() - .filter(Writable::isDirectory) - .findFirst() - .orElseThrow(); - - String resourcePaths = CountryIndexingDecorator.getExposureKeyExportPaths(dateDirectory) - .stream() - .sorted() - .collect(Collectors.joining(NEW_LINE_SEPARATOR)); - - directory.addWritable(new FileOnDisk(fileName, resourcePaths.getBytes(StandardCharsets.UTF_8))); - } - - private static Set<String> getExposureKeyExportPaths(Directory<WritableOnDisk> rootDirectory) { - Collection<Directory<WritableOnDisk>> directories = rootDirectory.getWritables() - .stream() - .filter(Writable::isDirectory) - .filter(directory -> !(directory instanceof Archive)) - .map(directory -> (Directory<WritableOnDisk>) directory) - .collect(Collectors.toSet()); - - if (directories.isEmpty()) { - return Set.of(rootDirectory.getName()); - } else { - return directories.stream() - .map(CountryIndexingDecorator::getExposureKeyExportPaths) - .flatMap(Set::stream) - .map(childName -> rootDirectory.getName() + "/" + childName) - .collect(Collectors.toSet()); - } - } -} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/util/DateTime.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/util/DateTime.java deleted file mode 100644 --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/util/DateTime.java +++ /dev/null @@ -1,79 +0,0 @@ -/*- - * ---license-start - * Corona-Warn-App - * --- - * Copyright (C) 2020 SAP SE and all other contributors - * --- - * 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 - * - * http://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. - * ---license-end - */ - -package app.coronawarn.server.services.distribution.assembly.diagnosiskeys.util; - -import app.coronawarn.server.common.persistence.domain.DiagnosisKey; -import java.time.LocalDate; -import java.time.LocalDateTime; -import java.time.ZoneOffset; -import java.util.Collection; -import java.util.Set; -import java.util.concurrent.TimeUnit; -import java.util.stream.Collectors; - -/** - * Methods for conversions of time/date data. - */ -public class DateTime { - - /** - * The submission timestamp is counted in 1 hour intervals since epoch. - */ - public static final long ONE_HOUR_INTERVAL_SECONDS = TimeUnit.HOURS.toSeconds(1); - - /** - * The rolling start interval number is counted in 10 minute intervals since epoch. - */ - public static final long TEN_MINUTES_INTERVAL_SECONDS = TimeUnit.MINUTES.toSeconds(10); - - private DateTime() { - } - - /** - * Returns a set of all {@link LocalDate dates} that are associated with the submission timestamps of the specified - * {@link DiagnosisKey diagnosis keys}. - */ - public static Set<LocalDate> getDates(Collection<DiagnosisKey> diagnosisKeys) { - return diagnosisKeys.stream() - .map(DiagnosisKey::getSubmissionTimestamp) - .map(timestamp -> LocalDate.ofEpochDay(timestamp / 24)) - .collect(Collectors.toSet()); - } - - /** - * Returns a set of all {@link LocalDateTime hours} that are associated with the submission timestamps of the - * specified {@link DiagnosisKey diagnosis keys} and the specified {@link LocalDate date}. - */ - public static Set<LocalDateTime> getHours(LocalDate currentDate, Collection<DiagnosisKey> diagnosisKeys) { - return diagnosisKeys.stream() - .map(DiagnosisKey::getSubmissionTimestamp) - .map(DateTime::getLocalDateTimeFromHoursSinceEpoch) - .filter(currentDateTime -> currentDateTime.toLocalDate().equals(currentDate)) - .collect(Collectors.toSet()); - } - - /** - * Creates a {@link LocalDateTime} based on the specified epoch timestamp. - */ - public static LocalDateTime getLocalDateTimeFromHoursSinceEpoch(long timestamp) { - return LocalDateTime.ofEpochSecond(TimeUnit.HOURS.toSeconds(timestamp), 0, ZoneOffset.UTC); - } -} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/TestDataGeneration.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/TestDataGeneration.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/TestDataGeneration.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/TestDataGeneration.java @@ -20,8 +20,8 @@ package app.coronawarn.server.services.distribution.runner; -import static app.coronawarn.server.services.distribution.assembly.diagnosiskeys.util.DateTime.ONE_HOUR_INTERVAL_SECONDS; -import static app.coronawarn.server.services.distribution.assembly.diagnosiskeys.util.DateTime.TEN_MINUTES_INTERVAL_SECONDS; +import static app.coronawarn.server.services.distribution.assembly.diagnosiskeys.DiagnosisKeyBundler.ONE_HOUR_INTERVAL_SECONDS; +import static app.coronawarn.server.services.distribution.assembly.diagnosiskeys.DiagnosisKeyBundler.TEN_MINUTES_INTERVAL_SECONDS; import app.coronawarn.server.common.persistence.domain.DiagnosisKey; import app.coronawarn.server.common.persistence.service.DiagnosisKeyService;

diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundlerExpiryPolicyTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundlerExpiryPolicyTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundlerExpiryPolicyTest.java @@ -0,0 +1,88 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.assembly.diagnosiskeys; + +import static org.assertj.core.api.Assertions.assertThat; + +import app.coronawarn.server.common.persistence.domain.DiagnosisKey; +import app.coronawarn.server.services.distribution.common.Helpers; +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import java.time.LocalDateTime; +import java.util.List; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.ValueSource; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.boot.test.context.ConfigFileApplicationContextInitializer; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit.jupiter.SpringExtension; + +@EnableConfigurationProperties(value = DistributionServiceConfig.class) +@ExtendWith(SpringExtension.class) +@ContextConfiguration(classes = {DistributionServiceConfig.class, ProdDiagnosisKeyBundler.class}, + initializers = ConfigFileApplicationContextInitializer.class) +class ProdDiagnosisKeyBundlerExpiryPolicyTest { + + @Autowired + DistributionServiceConfig distributionServiceConfig; + + @Autowired + DiagnosisKeyBundler bundler; + + @ParameterizedTest + @ValueSource(longs = {0L, 24L, 24L + 2L}) + void testLastPeriodOfHourAndSubmissionLessThanDistributionDateTime(long submissionTimestamp) { + List<DiagnosisKey> diagnosisKeys = Helpers.buildDiagnosisKeys(5, submissionTimestamp, 10); + bundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 2, 3, 0, 0))).hasSize(10); + } + + @Test + void testLastPeriodOfHourAndSubmissionEqualsDistributionDateTime() { + List<DiagnosisKey> diagnosisKeys = Helpers.buildDiagnosisKeys(5, 24L + 3L, 10); + bundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 2, 3, 0, 0))).hasSize(10); + } + + @ParameterizedTest + @ValueSource(longs = {0L, 24L, 24L + 2L, 24L + 3L}) + void testFirstPeriodOfHourAndSubmissionLessThanDistributionDateTime(long submissionTimestamp) { + List<DiagnosisKey> diagnosisKeys = Helpers.buildDiagnosisKeys(6, submissionTimestamp, 10); + bundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 2, 4, 0, 0))).hasSize(10); + } + + @Test + void testFirstPeriodOfHourAndSubmissionEqualsDistributionDateTime() { + List<DiagnosisKey> diagnosisKeys = Helpers.buildDiagnosisKeys(6, 24L + 4L, 10); + bundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 2, 4, 0, 0))).hasSize(10); + } + + @Test + void testLastPeriodOfHourAndSubmissionGreaterDistributionDateTime() { + List<DiagnosisKey> diagnosisKeys = Helpers.buildDiagnosisKeys(5, 24L + 4L, 10); + bundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 2, 4, 0, 0))).hasSize(10); + } +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundlerKeyRetrievalTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundlerKeyRetrievalTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundlerKeyRetrievalTest.java @@ -0,0 +1,185 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.assembly.diagnosiskeys; + +import static app.coronawarn.server.services.distribution.common.Helpers.buildDiagnosisKeys; +import static java.util.Collections.emptySet; +import static org.assertj.core.api.Assertions.assertThat; + +import app.coronawarn.server.common.persistence.domain.DiagnosisKey; +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import java.time.LocalDate; +import java.time.LocalDateTime; +import java.util.Collection; +import java.util.List; +import java.util.Set; +import java.util.stream.Collectors; +import java.util.stream.Stream; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Nested; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.Arguments; +import org.junit.jupiter.params.provider.MethodSource; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.boot.test.context.ConfigFileApplicationContextInitializer; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit.jupiter.SpringExtension; + +@EnableConfigurationProperties(value = DistributionServiceConfig.class) +@ExtendWith(SpringExtension.class) +@ContextConfiguration(classes = {DistributionServiceConfig.class, ProdDiagnosisKeyBundler.class}, + initializers = ConfigFileApplicationContextInitializer.class) +class ProdDiagnosisKeyBundlerKeyRetrievalTest { + + @Autowired + DistributionServiceConfig distributionServiceConfig; + + @Autowired + DiagnosisKeyBundler bundler; + + @Test + void testGetsAllDiagnosisKeys() { + List<DiagnosisKey> diagnosisKeys = Stream + .of(buildDiagnosisKeys(6, 50L, 5), buildDiagnosisKeys(6, 51L, 5), buildDiagnosisKeys(6, 52L, 5)) + .flatMap(List::stream) + .collect(Collectors.toList()); + bundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); + assertThat(bundler.getAllDiagnosisKeys()).hasSize(15); + } + + @Test + void testGetDatesForEmptyList() { + bundler.setDiagnosisKeys(emptySet(), LocalDateTime.of(1970, 1, 5, 0, 0)); + assertThat(bundler.getDatesWithDistributableDiagnosisKeys()).isEmpty(); + } + + @Test + void testGetsDatesWithDistributableDiagnosisKeys() { + List<DiagnosisKey> diagnosisKeys = Stream + .of(buildDiagnosisKeys(6, 26L, 5), buildDiagnosisKeys(6, 50L, 1), buildDiagnosisKeys(6, 74L, 5)) + .flatMap(List::stream) + .collect(Collectors.toList()); + bundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); + assertThat(bundler.getDatesWithDistributableDiagnosisKeys()).containsAll(List.of( + LocalDate.of(1970, 1, 2), + LocalDate.of(1970, 1, 4) + )); + } + + @ParameterizedTest + @MethodSource("createDiagnosisKeysForEpochDay0") + void testGetDatesForEpochDay0(Collection<DiagnosisKey> diagnosisKeys) { + bundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); + var expDates = Set.of(LocalDate.ofEpochDay(2L)); + var actDates = bundler.getDatesWithDistributableDiagnosisKeys(); + assertThat(actDates).isEqualTo(expDates); + } + + private static Stream<Arguments> createDiagnosisKeysForEpochDay0() { + return Stream.of( + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 0, 0), 5), + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 1, 0), 5), + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 23, 59, 59), 5) + ).map(Arguments::of); + } + + @Test + void testGetDatesFor2Days() { + List<DiagnosisKey> diagnosisKeys = Stream + .of(buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 1, 0), 5), + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 4, 1, 0), 5)) + .flatMap(List::stream) + .collect(Collectors.toList()); + bundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); + var expDates = Set.of(LocalDate.ofEpochDay(2L), LocalDate.ofEpochDay(3L)); + assertThat(bundler.getDatesWithDistributableDiagnosisKeys()).isEqualTo(expDates); + } + + @Test + void testGetHoursForEmptyList() { + bundler.setDiagnosisKeys(emptySet(), LocalDateTime.of(1970, 1, 5, 0, 0)); + assertThat(bundler.getHoursWithDistributableDiagnosisKeys(LocalDate.of(1970, 1, 3))).isEmpty(); + } + + @Test + void testGetsHoursWithDistributableDiagnosisKeys() { + List<DiagnosisKey> diagnosisKeys = Stream + .of(buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 2, 4, 0), 5), + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 2, 5, 0), 1), + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 2, 6, 0), 5)) + .flatMap(List::stream) + .collect(Collectors.toList()); + bundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); + assertThat(bundler.getHoursWithDistributableDiagnosisKeys(LocalDate.of(1970, 1, 2))).containsAll(List.of( + LocalDateTime.of(1970, 1, 2, 4, 0, 0), + LocalDateTime.of(1970, 1, 2, 6, 0, 0) + )); + } + + @Test + void testGetsDiagnosisKeysForDate() { + List<DiagnosisKey> diagnosisKeys = Stream + .of(buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 2, 2, 0), 5), + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 2, 0), 1), + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 4, 2, 0), 5)) + .flatMap(List::stream) + .collect(Collectors.toList()); + bundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 20, 0)); + assertThat(bundler.getDiagnosisKeysForDate(LocalDate.of(1970, 1, 1))).hasSize(0); + assertThat(bundler.getDiagnosisKeysForDate(LocalDate.of(1970, 1, 2))).hasSize(5); + assertThat(bundler.getDiagnosisKeysForDate(LocalDate.of(1970, 1, 3))).hasSize(0); + assertThat(bundler.getDiagnosisKeysForDate(LocalDate.of(1970, 1, 4))).hasSize(6); + assertThat(bundler.getDiagnosisKeysForDate(LocalDate.of(1970, 1, 5))).hasSize(0); + } + + @Test + void testEmptyListWhenGettingDiagnosisKeysForDateBeforeEarliestDiagnosisKey() { + List<DiagnosisKey> diagnosisKeys = buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 2, 4, 0), 5); + bundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); + assertThat(bundler.getDiagnosisKeysForDate(LocalDate.of(1970, 1, 1))).hasSize(0); + } + + @Test + void testGetsDiagnosisKeysForHour() { + List<DiagnosisKey> diagnosisKeys = Stream + .of(buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 2, 4, 0), 5), + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 2, 5, 0), 1), + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 2, 6, 0), 5)) + .flatMap(List::stream) + .collect(Collectors.toList()); + bundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 2, 3, 0))).hasSize(0); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 2, 4, 0))).hasSize(5); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 2, 5, 0))).hasSize(0); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 2, 6, 0))).hasSize(6); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 2, 7, 0))).hasSize(0); + } + + @Test + void testEmptyListWhenGettingDiagnosisKeysForHourBeforeEarliestDiagnosisKey() { + List<DiagnosisKey> diagnosisKeys = buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 2, 4, 0), 5); + bundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 1, 0, 0, 0))).hasSize(0); + } +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundlerShiftingPolicyTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundlerShiftingPolicyTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundlerShiftingPolicyTest.java @@ -0,0 +1,121 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.assembly.diagnosiskeys; + +import static app.coronawarn.server.services.distribution.common.Helpers.buildDiagnosisKeys; +import static org.assertj.core.api.Assertions.assertThat; + +import app.coronawarn.server.common.persistence.domain.DiagnosisKey; +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import java.time.LocalDateTime; +import java.util.List; +import java.util.stream.Collectors; +import java.util.stream.IntStream; +import java.util.stream.Stream; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Nested; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.ValueSource; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.boot.test.context.ConfigFileApplicationContextInitializer; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit.jupiter.SpringExtension; + +@EnableConfigurationProperties(value = DistributionServiceConfig.class) +@ExtendWith(SpringExtension.class) +@ContextConfiguration(classes = {DistributionServiceConfig.class, ProdDiagnosisKeyBundler.class}, + initializers = ConfigFileApplicationContextInitializer.class) +class ProdDiagnosisKeyBundlerShiftingPolicyTest { + + @Autowired + DistributionServiceConfig distributionServiceConfig; + + @Autowired + DiagnosisKeyBundler bundler; + + @Test + void testDoesNotShiftIfPackageSizeGreaterThanThreshold() { + List<DiagnosisKey> diagnosisKeys = buildDiagnosisKeys(6, 50L, 6); + bundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 2, 0, 0))).hasSize(6); + } + + @Test + void testDoesNotShiftIfPackageSizeEqualsThreshold() { + List<DiagnosisKey> diagnosisKeys = buildDiagnosisKeys(6, 50L, 5); + bundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 2, 0, 0))).hasSize(5); + } + + @Test + void testShiftsIfPackageSizeLessThanThreshold() { + List<DiagnosisKey> diagnosisKeys = Stream + .concat(buildDiagnosisKeys(6, 50L, 4).stream(), buildDiagnosisKeys(6, 51L, 1).stream()) + .collect(Collectors.toList()); + bundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 2, 0, 0))).hasSize(0); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 3, 0, 0))).hasSize(5); + } + + @Test + void testShiftsSinceLastDistribution() { + List<DiagnosisKey> diagnosisKeys = Stream + .of(buildDiagnosisKeys(6, 50L, 5), buildDiagnosisKeys(6, 51L, 2), buildDiagnosisKeys(6, 52L, 4)) + .flatMap(List::stream) + .collect(Collectors.toList()); + bundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 2, 0, 0))).hasSize(5); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 3, 0, 0))).hasSize(0); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 4, 0, 0))).hasSize(6); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 5, 0, 0))).hasSize(0); + } + + @Test + void testShiftIncludesPreviouslyUndistributedKeys() { + List<DiagnosisKey> diagnosisKeys = Stream + .concat(buildDiagnosisKeys(6, 50L, 1).stream(), buildDiagnosisKeys(6, 51L, 5).stream()) + .collect(Collectors.toList()); + bundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 2, 0, 0))).hasSize(0); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 3, 0, 0))).hasSize(6); + } + + @Test + void testShiftsSparseDistributions() { + List<DiagnosisKey> diagnosisKeys = Stream + .of(buildDiagnosisKeys(6, 50L, 1), buildDiagnosisKeys(6, 51L, 1), buildDiagnosisKeys(6, 52L, 1), + buildDiagnosisKeys(6, 53L, 0), buildDiagnosisKeys(6, 54L, 0), buildDiagnosisKeys(6, 55L, 1), + buildDiagnosisKeys(6, 56L, 1)) + .flatMap(List::stream) + .collect(Collectors.toList()); + bundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 2, 0, 0))).hasSize(0); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 3, 0, 0))).hasSize(0); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 4, 0, 0))).hasSize(0); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 5, 0, 0))).hasSize(0); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 6, 0, 0))).hasSize(0); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 7, 0, 0))).hasSize(0); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 8, 0, 0))).hasSize(5); + } +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundlerTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundlerTest.java deleted file mode 100644 --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundlerTest.java +++ /dev/null @@ -1,190 +0,0 @@ -/*- - * ---license-start - * Corona-Warn-App - * --- - * Copyright (C) 2020 SAP SE and all other contributors - * --- - * 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 - * - * http://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. - * ---license-end - */ - -package app.coronawarn.server.services.distribution.assembly.diagnosiskeys; - -import static org.assertj.core.api.Assertions.assertThat; - -import app.coronawarn.server.common.persistence.domain.DiagnosisKey; -import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; -import java.time.LocalDateTime; -import java.util.List; -import java.util.stream.Collectors; -import java.util.stream.IntStream; -import java.util.stream.Stream; -import org.junit.jupiter.api.DisplayName; -import org.junit.jupiter.api.Nested; -import org.junit.jupiter.api.Test; -import org.junit.jupiter.api.extension.ExtendWith; -import org.junit.jupiter.params.ParameterizedTest; -import org.junit.jupiter.params.provider.ValueSource; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.boot.context.properties.EnableConfigurationProperties; -import org.springframework.boot.test.context.ConfigFileApplicationContextInitializer; -import org.springframework.test.context.ContextConfiguration; -import org.springframework.test.context.junit.jupiter.SpringExtension; - -@EnableConfigurationProperties(value = DistributionServiceConfig.class) -@ExtendWith(SpringExtension.class) -@ContextConfiguration(classes = {DistributionServiceConfig.class, ProdDiagnosisKeyBundler.class}, - initializers = ConfigFileApplicationContextInitializer.class) -class ProdDiagnosisKeyBundlerTest { - - @Autowired - DistributionServiceConfig distributionServiceConfig; - - @Autowired - DiagnosisKeyBundler bundler; - - @Test - void testEmptyListWhenNoDiagnosisKeys() { - bundler.setDiagnosisKeys(List.of()); - assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 1, 0, 0, 0))).hasSize(0); - } - - @Test - void testEmptyListWhenGettingDistributableKeysBeforeEarliestDiagnosisKey() { - List<DiagnosisKey> diagnosisKeys = buildDiagnosisKeys(6, 50L, 5); - bundler.setDiagnosisKeys(diagnosisKeys); - assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 1, 0, 0, 0))).hasSize(0); - } - - @Nested - @DisplayName("Expiry policy") - class ProdDiagnosisKeyBundlerExpiryPolicyTest { - - @ParameterizedTest - @ValueSource(longs = {0L, 24L, 24L + 2L}) - void testLastPeriodOfHourAndSubmissionLessThanDistributionDateTime(long submissionTimestamp) { - List<DiagnosisKey> diagnosisKeys = buildDiagnosisKeys(5, submissionTimestamp, 10); - bundler.setDiagnosisKeys(diagnosisKeys); - assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 2, 3, 0, 0))).hasSize(10); - } - - @Test - void testLastPeriodOfHourAndSubmissionEqualsDistributionDateTime() { - List<DiagnosisKey> diagnosisKeys = buildDiagnosisKeys(5, 24L + 3L, 10); - bundler.setDiagnosisKeys(diagnosisKeys); - assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 2, 3, 0, 0))).hasSize(10); - } - - @ParameterizedTest - @ValueSource(longs = {0L, 24L, 24L + 2L, 24L + 3L}) - void testFirstPeriodOfHourAndSubmissionLessThanDistributionDateTime(long submissionTimestamp) { - List<DiagnosisKey> diagnosisKeys = buildDiagnosisKeys(6, submissionTimestamp, 10); - bundler.setDiagnosisKeys(diagnosisKeys); - assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 2, 4, 0, 0))).hasSize(10); - } - - @Test - void testFirstPeriodOfHourAndSubmissionEqualsDistributionDateTime() { - List<DiagnosisKey> diagnosisKeys = buildDiagnosisKeys(6, 24L + 4L, 10); - bundler.setDiagnosisKeys(diagnosisKeys); - assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 2, 4, 0, 0))).hasSize(10); - } - - @Test - void testLastPeriodOfHourAndSubmissionGreaterDistributionDateTime() { - List<DiagnosisKey> diagnosisKeys = buildDiagnosisKeys(5, 24L + 4L, 10); - bundler.setDiagnosisKeys(diagnosisKeys); - assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 2, 4, 0, 0))).hasSize(10); - } - } - - @Nested - @DisplayName("Shifting policy") - class ProdDiagnosisKeyBundlerShiftingPolicyTest { - - @Test - void testDoesNotShiftIfPackageSizeGreaterThanThreshold() { - List<DiagnosisKey> diagnosisKeys = buildDiagnosisKeys(6, 50L, 6); - bundler.setDiagnosisKeys(diagnosisKeys); - assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 2, 0, 0))).hasSize(6); - } - - @Test - void testDoesNotShiftIfPackageSizeEqualsThreshold() { - List<DiagnosisKey> diagnosisKeys = buildDiagnosisKeys(6, 50L, 5); - bundler.setDiagnosisKeys(diagnosisKeys); - assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 2, 0, 0))).hasSize(5); - } - - @Test - void testShiftsIfPackageSizeLessThanThreshold() { - List<DiagnosisKey> diagnosisKeys = Stream - .concat(buildDiagnosisKeys(6, 50L, 4).stream(), buildDiagnosisKeys(6, 51L, 1).stream()) - .collect(Collectors.toList()); - bundler.setDiagnosisKeys(diagnosisKeys); - assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 2, 0, 0))).hasSize(0); - assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 3, 0, 0))).hasSize(5); - } - - @Test - void testShiftsSinceLastDistribution() { - List<DiagnosisKey> diagnosisKeys = Stream - .of(buildDiagnosisKeys(6, 50L, 5), buildDiagnosisKeys(6, 51L, 2), buildDiagnosisKeys(6, 52L, 4)) - .flatMap(List::stream) - .collect(Collectors.toList()); - bundler.setDiagnosisKeys(diagnosisKeys); - assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 2, 0, 0))).hasSize(5); - assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 3, 0, 0))).hasSize(0); - assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 4, 0, 0))).hasSize(6); - assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 5, 0, 0))).hasSize(0); - } - - @Test - void testShiftIncludesPreviouslyUndistributedKeys() { - List<DiagnosisKey> diagnosisKeys = Stream - .concat(buildDiagnosisKeys(6, 50L, 1).stream(), buildDiagnosisKeys(6, 51L, 5).stream()) - .collect(Collectors.toList()); - bundler.setDiagnosisKeys(diagnosisKeys); - assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 2, 0, 0))).hasSize(0); - assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 3, 0, 0))).hasSize(5); - } - - @Test - void testShiftsSparseDistributions() { - List<DiagnosisKey> diagnosisKeys = Stream - .of(buildDiagnosisKeys(6, 50L, 1), buildDiagnosisKeys(6, 51L, 1), buildDiagnosisKeys(6, 52L, 1), - buildDiagnosisKeys(6, 53L, 0), buildDiagnosisKeys(6, 54L, 0), buildDiagnosisKeys(6, 55L, 1), - buildDiagnosisKeys(6, 56L, 1)) - .flatMap(List::stream) - .collect(Collectors.toList()); - bundler.setDiagnosisKeys(diagnosisKeys); - assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 2, 0, 0))).hasSize(0); - assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 3, 0, 0))).hasSize(0); - assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 4, 0, 0))).hasSize(0); - assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 5, 0, 0))).hasSize(0); - assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 6, 0, 0))).hasSize(0); - assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 7, 0, 0))).hasSize(0); - assertThat(bundler.getDiagnosisKeysDistributableAt(LocalDateTime.of(1970, 1, 3, 8, 0, 0))).hasSize(5); - } - } - - public static List<DiagnosisKey> buildDiagnosisKeys(int startIntervalNumber, long submissionTimestamp, int number) { - return IntStream.range(0, number) - .mapToObj(__ -> DiagnosisKey.builder() - .withKeyData(new byte[16]) - .withRollingStartIntervalNumber(startIntervalNumber) - .withTransmissionRiskLevel(2) - .withSubmissionTimestamp(submissionTimestamp).build()) - .collect(Collectors.toList()); - } -} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDirectoryTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDirectoryTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDirectoryTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDirectoryTest.java @@ -21,6 +21,7 @@ package app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory; import static app.coronawarn.server.services.distribution.common.Helpers.buildDiagnosisKeyForSubmissionTimestamp; +import static app.coronawarn.server.services.distribution.common.Helpers.buildDiagnosisKeys; import static java.lang.String.join; import static org.assertj.core.api.Assertions.assertThat; @@ -28,6 +29,7 @@ import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.DemoDiagnosisKeyBundler; import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.DiagnosisKeyBundler; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.ProdDiagnosisKeyBundler; import app.coronawarn.server.services.distribution.assembly.structure.WritableOnDisk; import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; import app.coronawarn.server.services.distribution.assembly.structure.directory.DirectoryOnDisk; @@ -35,6 +37,7 @@ import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; import java.io.File; import java.io.IOException; +import java.time.LocalDateTime; import java.util.Arrays; import java.util.List; import java.util.Objects; @@ -81,17 +84,18 @@ void setupAll() throws IOException { // 01.01.1970 - 00:00 UTC long startTimestamp = 0; - // Generate diagnosis keys covering 30 hours of submission timestamps - // Until 02.01.1970 - 06:00 UTC -> 1 full day + 6 hours + // Generate diagnosis keys covering 29 hours of submission timestamps (one gap) + // Until 04.01.1970 - 06:00 UTC -> 1 full day + 5 hours diagnosisKeys = IntStream.range(0, 30) - .mapToObj( - currentHour -> buildDiagnosisKeyForSubmissionTimestamp(startTimestamp + currentHour)) + .filter(currentHour -> currentHour != 20) + .mapToObj(currentHour -> buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 0, 0).plusHours(currentHour), 5)) + .flatMap(List::stream) .collect(Collectors.toList()); } @Test void checkBuildsTheCorrectDirectoryStructureWhenNoKeys() { - DiagnosisKeyBundler bundler = new DemoDiagnosisKeyBundler(distributionServiceConfig); + DiagnosisKeyBundler bundler = new ProdDiagnosisKeyBundler(distributionServiceConfig); Directory<WritableOnDisk> directory = new DiagnosisKeysDirectory(bundler, cryptoProvider, distributionServiceConfig); parentDirectory.addWritable(directory); @@ -101,7 +105,6 @@ void checkBuildsTheCorrectDirectoryStructureWhenNoKeys() { String s = File.separator; Set<String> expectedFiles = Set.of( join(s, "diagnosis-keys", "country", "index"), - join(s, "diagnosis-keys", "country", "DE", "index"), join(s, "diagnosis-keys", "country", "DE", "date", "index") ); @@ -112,8 +115,8 @@ void checkBuildsTheCorrectDirectoryStructureWhenNoKeys() { @Test void checkBuildsTheCorrectDirectoryStructure() { - DiagnosisKeyBundler bundler = new DemoDiagnosisKeyBundler(distributionServiceConfig); - bundler.setDiagnosisKeys(diagnosisKeys); + DiagnosisKeyBundler bundler = new ProdDiagnosisKeyBundler(distributionServiceConfig); + bundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); Directory<WritableOnDisk> directory = new DiagnosisKeysDirectory(bundler, cryptoProvider, distributionServiceConfig); parentDirectory.addWritable(directory); @@ -123,42 +126,41 @@ void checkBuildsTheCorrectDirectoryStructure() { String s = File.separator; Set<String> expectedFiles = Set.of( join(s, "diagnosis-keys", "country", "index"), - join(s, "diagnosis-keys", "country", "DE", "index"), join(s, "diagnosis-keys", "country", "DE", "date", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-01", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-01", "hour", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-01", "hour", "0", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-01", "hour", "1", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-01", "hour", "2", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-01", "hour", "3", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-01", "hour", "4", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-01", "hour", "5", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-01", "hour", "6", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-01", "hour", "7", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-01", "hour", "8", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-01", "hour", "9", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-01", "hour", "10", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-01", "hour", "11", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-01", "hour", "12", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-01", "hour", "13", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-01", "hour", "14", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-01", "hour", "15", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-01", "hour", "16", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-01", "hour", "17", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-01", "hour", "18", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-01", "hour", "19", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-01", "hour", "20", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-01", "hour", "21", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-01", "hour", "22", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-01", "hour", "23", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-02", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-02", "hour", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-02", "hour", "0", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-02", "hour", "1", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-02", "hour", "2", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-02", "hour", "3", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-02", "hour", "4", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-02", "hour", "5", "index") + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "hour", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "hour", "0", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "hour", "1", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "hour", "2", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "hour", "3", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "hour", "4", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "hour", "5", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "hour", "6", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "hour", "7", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "hour", "8", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "hour", "9", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "hour", "10", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "hour", "11", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "hour", "12", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "hour", "13", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "hour", "14", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "hour", "15", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "hour", "16", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "hour", "17", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "hour", "18", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "hour", "19", "index"), + // One missing + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "hour", "21", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "hour", "22", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "hour", "23", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "hour", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "hour", "0", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "hour", "1", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "hour", "2", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "hour", "3", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "hour", "4", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "hour", "5", "index") ); Set<String> actualFiles = getActualFiles(outputFile); diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/DateIndexingDecoratorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/DateIndexingDecoratorTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/DateIndexingDecoratorTest.java @@ -0,0 +1,106 @@ +/* + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory.decorator; + +import static app.coronawarn.server.services.distribution.common.Helpers.buildDiagnosisKeys; +import static org.assertj.core.api.Assertions.assertThat; + +import app.coronawarn.server.common.persistence.domain.DiagnosisKey; +import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.DiagnosisKeyBundler; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.ProdDiagnosisKeyBundler; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory.DiagnosisKeysDateDirectory; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory.DiagnosisKeysHourDirectory; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import java.time.LocalDate; +import java.time.LocalDateTime; +import java.util.List; +import java.util.Set; +import java.util.stream.Collectors; +import java.util.stream.Stream; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.boot.test.context.ConfigFileApplicationContextInitializer; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit.jupiter.SpringExtension; + +@EnableConfigurationProperties(value = DistributionServiceConfig.class) +@ExtendWith(SpringExtension.class) +@ContextConfiguration(classes = {CryptoProvider.class, DistributionServiceConfig.class}, + initializers = ConfigFileApplicationContextInitializer.class) +class DateIndexingDecoratorTest { + + @Autowired + DistributionServiceConfig distributionServiceConfig; + + @Autowired + CryptoProvider cryptoProvider; + + private DiagnosisKeyBundler diagnosisKeyBundler; + + @BeforeEach + void setup() { + diagnosisKeyBundler = new ProdDiagnosisKeyBundler(distributionServiceConfig); + } + + @Test + void excludesEmptyDatesFromIndex() { + List<DiagnosisKey> diagnosisKeys = Stream + .of(buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 0, 0), 5), + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 4, 0, 0), 0), + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 5, 0, 0), 5)) + .flatMap(List::stream) + .collect(Collectors.toList()); + diagnosisKeyBundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 6, 0, 0)); + DateIndexingDecorator decorator = makeDecoratedDateDirectory(diagnosisKeyBundler); + decorator.prepare(new ImmutableStack<>().push("DE")); + + Set<LocalDate> index = decorator.getIndex(new ImmutableStack<>()); + + assertThat(index).contains(LocalDate.of(1970, 1, 3)); + assertThat(index).doesNotContain(LocalDate.of(1970, 1, 4)); + assertThat(index).contains(LocalDate.of(1970, 1, 5)); + } + + @Test + void excludesCurrentDateFromIndex() { + List<DiagnosisKey> diagnosisKeys = buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 4, 0, 0), 5); + diagnosisKeyBundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); + DateIndexingDecorator decorator = makeDecoratedDateDirectory(diagnosisKeyBundler); + decorator.prepare(new ImmutableStack<>().push("DE")); + + Set<LocalDate> index = decorator.getIndex(new ImmutableStack<>()); + + assertThat(index).contains(LocalDate.of(1970, 1, 4)); + assertThat(index).doesNotContain(LocalDate.of(1970, 1, 5)); + } + + private DateIndexingDecorator makeDecoratedDateDirectory(DiagnosisKeyBundler diagnosisKeyBundler) { + return new DateIndexingDecorator( + new DiagnosisKeysDateDirectory(diagnosisKeyBundler, cryptoProvider, distributionServiceConfig), + distributionServiceConfig + ); + } +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/HourIndexingDecoratorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/HourIndexingDecoratorTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/HourIndexingDecoratorTest.java @@ -0,0 +1,105 @@ +/* + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory.decorator; + +import static app.coronawarn.server.services.distribution.common.Helpers.buildDiagnosisKeys; +import static org.assertj.core.api.Assertions.assertThat; + +import app.coronawarn.server.common.persistence.domain.DiagnosisKey; +import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.DiagnosisKeyBundler; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.ProdDiagnosisKeyBundler; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory.DiagnosisKeysHourDirectory; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import java.time.LocalDate; +import java.time.LocalDateTime; +import java.util.List; +import java.util.Set; +import java.util.stream.Collectors; +import java.util.stream.Stream; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.boot.test.context.ConfigFileApplicationContextInitializer; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit.jupiter.SpringExtension; + +@EnableConfigurationProperties(value = DistributionServiceConfig.class) +@ExtendWith(SpringExtension.class) +@ContextConfiguration(classes = {CryptoProvider.class, DistributionServiceConfig.class}, + initializers = ConfigFileApplicationContextInitializer.class) +class HourIndexingDecoratorTest { + + @Autowired + DistributionServiceConfig distributionServiceConfig; + + @Autowired + CryptoProvider cryptoProvider; + + private DiagnosisKeyBundler diagnosisKeyBundler; + + @BeforeEach + void setup() { + diagnosisKeyBundler = new ProdDiagnosisKeyBundler(distributionServiceConfig); + } + + @Test + void excludesEmptyHoursFromIndex() { + List<DiagnosisKey> diagnosisKeys = Stream + .of(buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 4, 0), 5), + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 5, 0), 0), + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 6, 0), 5)) + .flatMap(List::stream) + .collect(Collectors.toList()); + diagnosisKeyBundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); + HourIndexingDecorator decorator = makeDecoratedHourDirectory(diagnosisKeyBundler); + decorator.prepare(new ImmutableStack<>().push("DE").push(LocalDate.of(1970, 1, 3))); + + Set<LocalDateTime> index = decorator.getIndex(new ImmutableStack<>().push(LocalDate.of(1970, 1, 3))); + + assertThat(index).contains(LocalDateTime.of(1970, 1, 3, 4, 0)); + assertThat(index).doesNotContain(LocalDateTime.of(1970, 1, 3, 5, 0)); + assertThat(index).contains(LocalDateTime.of(1970, 1, 3, 6, 0)); + } + + @Test + void excludesCurrentHourFromIndex() { + List<DiagnosisKey> diagnosisKeys = buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 5, 0, 0), 5); + diagnosisKeyBundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 1, 0)); + HourIndexingDecorator decorator = makeDecoratedHourDirectory(diagnosisKeyBundler); + decorator.prepare(new ImmutableStack<>().push("DE").push(LocalDate.of(1970, 1, 5))); + + Set<LocalDateTime> index = decorator.getIndex(new ImmutableStack<>().push(LocalDate.of(1970, 1, 5))); + + assertThat(index).contains(LocalDateTime.of(1970, 1, 5, 0, 0)); + assertThat(index).doesNotContain(LocalDateTime.of(1970, 1, 5, 1, 0)); + } + + private HourIndexingDecorator makeDecoratedHourDirectory(DiagnosisKeyBundler diagnosisKeyBundler) { + return new HourIndexingDecorator( + new DiagnosisKeysHourDirectory(diagnosisKeyBundler, cryptoProvider, distributionServiceConfig), + distributionServiceConfig + ); + } +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/util/DateTimeTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/util/DateTimeTest.java deleted file mode 100644 --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/util/DateTimeTest.java +++ /dev/null @@ -1,103 +0,0 @@ -/*- - * ---license-start - * Corona-Warn-App - * --- - * Copyright (C) 2020 SAP SE and all other contributors - * --- - * 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 - * - * http://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. - * ---license-end - */ - -package app.coronawarn.server.services.distribution.assembly.diagnosiskeys.util; - -import static app.coronawarn.server.services.distribution.common.Helpers.buildDiagnosisKeyForDateTime; -import static java.util.Collections.emptyList; -import static java.util.Collections.emptySet; -import static org.assertj.core.api.Assertions.assertThat; - -import app.coronawarn.server.common.persistence.domain.DiagnosisKey; -import app.coronawarn.server.services.distribution.common.Helpers; -import java.time.LocalDate; -import java.time.LocalDateTime; -import java.util.HashSet; -import java.util.Set; -import java.util.stream.Collectors; -import java.util.stream.Stream; -import org.junit.jupiter.api.Test; -import org.junit.jupiter.params.ParameterizedTest; -import org.junit.jupiter.params.provider.Arguments; -import org.junit.jupiter.params.provider.MethodSource; - -class DateTimeTest { - - @Test - void testGetDatesForEmptyList() { - assertThat(DateTime.getDates(emptyList())).isEmpty(); - } - - @ParameterizedTest - @MethodSource("createDiagnosisKeysForEpochDay0") - void testGetDatesForEpochDay0(DiagnosisKey diagnosisKey) { - var expDates = Set.of(LocalDate.ofEpochDay(0L)); - var actDates = DateTime.getDates(Set.of(diagnosisKey)); - - assertThat(actDates) - .withFailMessage( - "Failed for submission timestamp: " + diagnosisKey.getSubmissionTimestamp()) - .isEqualTo(expDates); - } - - private static Stream<Arguments> createDiagnosisKeysForEpochDay0() { - return Stream.of( - buildDiagnosisKeyForDateTime(LocalDateTime.of(1970, 1, 1, 0, 0)), - buildDiagnosisKeyForDateTime(LocalDateTime.of(1970, 1, 1, 1, 0)), - buildDiagnosisKeyForDateTime(LocalDateTime.of(1970, 1, 1, 23, 59, 59)) - ).map(Arguments::of); - } - - @Test - void testGetDatesFor2Days() { - var diagnosisKeys = Set.of( - buildDiagnosisKeyForDateTime(LocalDateTime.of(1970, 1, 1, 1, 0)), - buildDiagnosisKeyForDateTime(LocalDateTime.of(1970, 1, 2, 1, 0))); - var expDates = Set.of(LocalDate.ofEpochDay(0L), LocalDate.ofEpochDay(1L)); - - assertThat(DateTime.getDates(diagnosisKeys)).isEqualTo(expDates); - } - - @ParameterizedTest - @MethodSource("createDiagnosisKeysForEpochDay1And3") - void testGetHoursReturnsHoursOnlyForSpecifiedDate(Set<DiagnosisKey> diagnosisKeys) { - var expHours = Set.of( - LocalDateTime.of(1970, 1, 2, 0, 0), - LocalDateTime.of(1970, 1, 2, 5, 0)); - - var diagnosisKeysIncludingExpHours = new HashSet<>(diagnosisKeys); - diagnosisKeysIncludingExpHours.addAll(expHours.stream() - .map(Helpers::buildDiagnosisKeyForDateTime).collect(Collectors.toSet())); - - var actHours = DateTime.getHours(LocalDate.ofEpochDay(1L), diagnosisKeysIncludingExpHours); - - assertThat(actHours).isEqualTo(expHours); - } - - private static Stream<Arguments> createDiagnosisKeysForEpochDay1And3() { - return Stream.of( - emptySet(), - Set.of(buildDiagnosisKeyForDateTime(LocalDateTime.of(1970, 1, 1, 23, 59))), - Set.of( - buildDiagnosisKeyForDateTime(LocalDateTime.of(1970, 1, 1, 23, 59, 59)), - buildDiagnosisKeyForDateTime(LocalDateTime.of(1970, 1, 3, 0, 0))) - ).map(Arguments::of); - } -} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/common/Helpers.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/common/Helpers.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/common/Helpers.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/common/Helpers.java @@ -25,6 +25,9 @@ import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; import java.time.LocalDateTime; import java.time.ZoneOffset; +import java.util.List; +import java.util.stream.Collectors; +import java.util.stream.IntStream; public class Helpers { @@ -36,7 +39,7 @@ public static void prepareAndWrite(Directory directory) { public static DiagnosisKey buildDiagnosisKeyForSubmissionTimestamp(long submissionTimeStamp) { return DiagnosisKey.builder() .withKeyData(new byte[16]) - .withRollingStartIntervalNumber(600) + .withRollingStartIntervalNumber(1) .withTransmissionRiskLevel(2) .withSubmissionTimestamp(submissionTimeStamp).build(); } @@ -44,4 +47,19 @@ public static DiagnosisKey buildDiagnosisKeyForSubmissionTimestamp(long submissi public static DiagnosisKey buildDiagnosisKeyForDateTime(LocalDateTime dateTime) { return buildDiagnosisKeyForSubmissionTimestamp(dateTime.toEpochSecond(ZoneOffset.UTC) / 3600); } + + public static List<DiagnosisKey> buildDiagnosisKeys(int startIntervalNumber, LocalDateTime submissionTimestamp, int number) { + long timestamp = submissionTimestamp.toEpochSecond(ZoneOffset.UTC) / 3600; + return buildDiagnosisKeys(startIntervalNumber, timestamp, number); + } + + public static List<DiagnosisKey> buildDiagnosisKeys(int startIntervalNumber, long submissionTimestamp, int number) { + return IntStream.range(0, number) + .mapToObj(__ -> DiagnosisKey.builder() + .withKeyData(new byte[16]) + .withRollingStartIntervalNumber(startIntervalNumber) + .withTransmissionRiskLevel(2) + .withSubmissionTimestamp(submissionTimestamp).build()) + .collect(Collectors.toList()); + } }

Remove "empty" dates/hours from index files ## Current Implementation All dates/hours between the first submission and now (last full hour) are included in the index files, even if there were no submissions. ## Suggested Enhancement Only list dates/hours for which there were submissions in the index files. The "empty" date/hour files should, however, still be generated, even if they are not in the index. ## Expected Benefits Mobile clients need to do fewer requests (they can simply skip empty dates/hours).

Why should the empty files still be generated? Basically to attest that there were really no submissions in that time window (and that the distribution run didn't just fail). Since we are not (yet) signing index files, I guess the best we can do is to just create and sign the empty exports.

corona-warn-app/cwa-server

corona-warn-app__cwa-server-441

2165f162938409e6401c926d8643835a114ab887

diff --git a/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/attenuation_duration.proto b/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/attenuation_duration.proto --- a/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/attenuation_duration.proto +++ b/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/attenuation_duration.proto @@ -6,6 +6,8 @@ option java_multiple_files = true; message AttenuationDuration { Thresholds thresholds = 1; Weights weights = 2; + int32 defaultBucketOffset = 3; + int32 riskScoreNormalizationDivisor = 4; } message Thresholds { diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/AttenuationDurationValidator.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/AttenuationDurationValidator.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/AttenuationDurationValidator.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/AttenuationDurationValidator.java @@ -26,6 +26,10 @@ import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ParameterSpec.ATTENUATION_DURATION_THRESHOLD_MIN; import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ParameterSpec.ATTENUATION_DURATION_WEIGHT_MAX; import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ParameterSpec.ATTENUATION_DURATION_WEIGHT_MIN; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ParameterSpec.DEFAULT_BUCKET_OFFSET_MAX; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ParameterSpec.DEFAULT_BUCKET_OFFSET_MIN; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ParameterSpec.RISK_SCORE_NORMALIZATION_DIVISOR_MAX; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ParameterSpec.RISK_SCORE_NORMALIZATION_DIVISOR_MIN; import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.WeightValidationError.ErrorType.OUT_OF_RANGE; import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.WeightValidationError.ErrorType.TOO_MANY_DECIMAL_PLACES; @@ -49,6 +53,8 @@ public ValidationResult validate() { validateThresholds(); validateWeights(); + validateDefaultBucketOffset(); + validateRiskScoreNormalizationDivisor(); return errors; } @@ -57,8 +63,8 @@ private void validateThresholds() { int lower = attenuationDuration.getThresholds().getLower(); int upper = attenuationDuration.getThresholds().getUpper(); - checkThresholdBound("lower", lower); - checkThresholdBound("upper", upper); + checkValueRange("thresholds.lower", lower, ATTENUATION_DURATION_THRESHOLD_MIN, ATTENUATION_DURATION_THRESHOLD_MAX); + checkValueRange("thresholds.upper", upper, ATTENUATION_DURATION_THRESHOLD_MIN, ATTENUATION_DURATION_THRESHOLD_MAX); if (lower > upper) { String parameters = "attenuation-duration.thresholds.lower, attenuation-duration.thresholds.upper"; @@ -67,10 +73,10 @@ private void validateThresholds() { } } - private void checkThresholdBound(String thresholdLabel, int thresholdValue) { - if (thresholdValue < ATTENUATION_DURATION_THRESHOLD_MIN || thresholdValue > ATTENUATION_DURATION_THRESHOLD_MAX) { + private void checkValueRange(String parameterLabel, int value, int min, int max) { + if (value < min || value > max) { this.errors.add(new GeneralValidationError( - "attenuation-duration.thresholds." + thresholdLabel, thresholdValue, VALUE_OUT_OF_BOUNDS)); + "attenuation-duration." + parameterLabel, value, VALUE_OUT_OF_BOUNDS)); } } @@ -91,4 +97,15 @@ private void checkWeight(String weightLabel, double weightValue) { "attenuation-duration.weights." + weightLabel, weightValue, TOO_MANY_DECIMAL_PLACES)); } } + + private void validateDefaultBucketOffset() { + int bucketOffset = attenuationDuration.getDefaultBucketOffset(); + checkValueRange("default-bucket-offset", bucketOffset, DEFAULT_BUCKET_OFFSET_MIN, DEFAULT_BUCKET_OFFSET_MAX); + } + + private void validateRiskScoreNormalizationDivisor() { + int riskScoreNormalizationDivisor = attenuationDuration.getRiskScoreNormalizationDivisor(); + checkValueRange("risk-score-normalization-divisor", riskScoreNormalizationDivisor, + RISK_SCORE_NORMALIZATION_DIVISOR_MIN, RISK_SCORE_NORMALIZATION_DIVISOR_MAX); + } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ParameterSpec.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ParameterSpec.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ParameterSpec.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ParameterSpec.java @@ -78,4 +78,25 @@ private ParameterSpec() { * Maximum number of allowed decimals for an attenuation weight. */ public static final int ATTENUATION_DURATION_WEIGHT_MAX_DECIMALS = 3; + + + /** + * The allowed minimum value for a default bucket offset. + */ + public static final int DEFAULT_BUCKET_OFFSET_MIN = 0; + + /** + * The allowed maximum value for a default bucket offset. + */ + public static final int DEFAULT_BUCKET_OFFSET_MAX = 1; + + /** + * The allowed minimum value for a risk score normalization divisor. + */ + public static final int RISK_SCORE_NORMALIZATION_DIVISOR_MIN = 0; + + /** + * The allowed maximum value for a risk score normalization divisor. + */ + public static final int RISK_SCORE_NORMALIZATION_DIVISOR_MAX = 1000; } diff --git a/services/distribution/src/main/resources/master-config/attenuation-duration.yaml b/services/distribution/src/main/resources/master-config/attenuation-duration.yaml --- a/services/distribution/src/main/resources/master-config/attenuation-duration.yaml +++ b/services/distribution/src/main/resources/master-config/attenuation-duration.yaml @@ -4,6 +4,9 @@ # Each of the aforementioned partitions has a weight in the range of [0, 1] # assigned to it. The number of decimal places is restricted to 3. # +# default-bucket-offset value range: {0, 1} +# risk-score-normalization-divisor value range: [1, 1000] +# # Change this file with caution! thresholds: @@ -13,3 +16,5 @@ weights: low: 1.0 mid: 0.5 high: 0.0 +default-bucket-offset: 0 +risk-score-normalization-divisor: 25

diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/AttenuationDurationValidatorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/AttenuationDurationValidatorTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/AttenuationDurationValidatorTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/AttenuationDurationValidatorTest.java @@ -26,6 +26,10 @@ import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ParameterSpec.ATTENUATION_DURATION_THRESHOLD_MIN; import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ParameterSpec.ATTENUATION_DURATION_WEIGHT_MAX; import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ParameterSpec.ATTENUATION_DURATION_WEIGHT_MIN; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ParameterSpec.DEFAULT_BUCKET_OFFSET_MAX; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ParameterSpec.DEFAULT_BUCKET_OFFSET_MIN; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ParameterSpec.RISK_SCORE_NORMALIZATION_DIVISOR_MAX; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ParameterSpec.RISK_SCORE_NORMALIZATION_DIVISOR_MIN; import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidatorTest.buildError; import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidatorTest.buildExpectedResult; import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.WeightValidationError.ErrorType.OUT_OF_RANGE; @@ -44,12 +48,14 @@ public class AttenuationDurationValidatorTest { buildThresholds(ATTENUATION_DURATION_THRESHOLD_MIN, ATTENUATION_DURATION_THRESHOLD_MAX); private static final Weights VALID_WEIGHTS = buildWeights(ATTENUATION_DURATION_WEIGHT_MAX, ATTENUATION_DURATION_WEIGHT_MAX, ATTENUATION_DURATION_WEIGHT_MAX); + private static final int VALID_BUCKET_OFFSET = DEFAULT_BUCKET_OFFSET_MAX; + private static final int VALID_NORMALIZATION_DIVISOR = RISK_SCORE_NORMALIZATION_DIVISOR_MIN; @ParameterizedTest @ValueSource(ints = {ATTENUATION_DURATION_THRESHOLD_MIN - 1, ATTENUATION_DURATION_THRESHOLD_MAX + 1}) void failsIfAttenuationDurationThresholdOutOfBounds(int invalidThresholdValue) { AttenuationDurationValidator validator = buildValidator( - buildThresholds(invalidThresholdValue, invalidThresholdValue), VALID_WEIGHTS); + buildThresholds(invalidThresholdValue, invalidThresholdValue)); ValidationResult expectedResult = buildExpectedResult( buildError("attenuation-duration.thresholds.lower", invalidThresholdValue, VALUE_OUT_OF_BOUNDS), @@ -58,10 +64,35 @@ void failsIfAttenuationDurationThresholdOutOfBounds(int invalidThresholdValue) { assertThat(validator.validate()).isEqualTo(expectedResult); } + @ParameterizedTest + @ValueSource(ints = {DEFAULT_BUCKET_OFFSET_MIN - 1, DEFAULT_BUCKET_OFFSET_MAX + 1}) + void failsIfBucketOffsetOutOfBounds(int invalidDefaultBucketOffsetValue) { + AttenuationDurationValidator validator = buildValidator(VALID_THRESHOLDS, VALID_WEIGHTS, + invalidDefaultBucketOffsetValue, VALID_NORMALIZATION_DIVISOR); + + ValidationResult expectedResult = buildExpectedResult( + buildError("attenuation-duration.default-bucket-offset", invalidDefaultBucketOffsetValue, VALUE_OUT_OF_BOUNDS)); + + assertThat(validator.validate()).isEqualTo(expectedResult); + } + + @ParameterizedTest + @ValueSource(ints = {RISK_SCORE_NORMALIZATION_DIVISOR_MIN - 1, RISK_SCORE_NORMALIZATION_DIVISOR_MAX + 1}) + void failsIfRiskScoreNormalizationDivisorOutOfBounds(int invalidRiskScoreNormalizationDivisorValue) { + AttenuationDurationValidator validator = buildValidator(VALID_THRESHOLDS, VALID_WEIGHTS, VALID_BUCKET_OFFSET, + invalidRiskScoreNormalizationDivisorValue); + + ValidationResult expectedResult = buildExpectedResult( + buildError("attenuation-duration.risk-score-normalization-divisor", invalidRiskScoreNormalizationDivisorValue, + VALUE_OUT_OF_BOUNDS)); + + assertThat(validator.validate()).isEqualTo(expectedResult); + } + @Test void failsIfUpperAttenuationDurationThresholdLesserThanLower() { AttenuationDurationValidator validator = buildValidator( - buildThresholds(ATTENUATION_DURATION_THRESHOLD_MAX, ATTENUATION_DURATION_THRESHOLD_MIN), VALID_WEIGHTS); + buildThresholds(ATTENUATION_DURATION_THRESHOLD_MAX, ATTENUATION_DURATION_THRESHOLD_MIN)); ValidationResult expectedResult = buildExpectedResult( new GeneralValidationError("attenuation-duration.thresholds.lower, attenuation-duration.thresholds.upper", @@ -73,7 +104,7 @@ void failsIfUpperAttenuationDurationThresholdLesserThanLower() { @ParameterizedTest @ValueSource(doubles = {ATTENUATION_DURATION_WEIGHT_MIN - .1, ATTENUATION_DURATION_WEIGHT_MAX + .1}) void failsIfWeightsOutOfBounds(double invalidWeightValue) { - AttenuationDurationValidator validator = buildValidator(VALID_THRESHOLDS, + AttenuationDurationValidator validator = buildValidator( buildWeights(invalidWeightValue, invalidWeightValue, invalidWeightValue)); ValidationResult expectedResult = buildExpectedResult( @@ -87,7 +118,7 @@ void failsIfWeightsOutOfBounds(double invalidWeightValue) { @Test void failsIfWeightsHaveTooManyDecimalPlaces() { double invalidWeightValue = ATTENUATION_DURATION_WEIGHT_MAX - 0.0000001; - AttenuationDurationValidator validator = buildValidator(VALID_THRESHOLDS, + AttenuationDurationValidator validator = buildValidator( buildWeights(invalidWeightValue, invalidWeightValue, invalidWeightValue)); ValidationResult expectedResult = buildExpectedResult( @@ -98,10 +129,22 @@ void failsIfWeightsHaveTooManyDecimalPlaces() { assertThat(validator.validate()).isEqualTo(expectedResult); } - private static AttenuationDurationValidator buildValidator(Thresholds thresholds, Weights weights) { + private static AttenuationDurationValidator buildValidator(Thresholds thresholds) { + return buildValidator(thresholds, VALID_WEIGHTS, VALID_BUCKET_OFFSET, VALID_NORMALIZATION_DIVISOR); + } + + private static AttenuationDurationValidator buildValidator(Weights weights) { + return buildValidator(VALID_THRESHOLDS, weights, VALID_BUCKET_OFFSET, VALID_NORMALIZATION_DIVISOR); + } + + private static AttenuationDurationValidator buildValidator( + Thresholds thresholds, Weights weights, int defaultBucketOffset, int riskScoreNormalizationDivisor) { return new AttenuationDurationValidator(AttenuationDuration.newBuilder() .setThresholds(thresholds) - .setWeights(weights).build()); + .setWeights(weights) + .setDefaultBucketOffset(defaultBucketOffset) + .setRiskScoreNormalizationDivisor(riskScoreNormalizationDivisor) + .build()); } private static Thresholds buildThresholds(int lower, int upper) { diff --git a/services/distribution/src/test/resources/configtests/attenuation-duration.yaml b/services/distribution/src/test/resources/configtests/attenuation-duration.yaml --- a/services/distribution/src/test/resources/configtests/attenuation-duration.yaml +++ b/services/distribution/src/test/resources/configtests/attenuation-duration.yaml @@ -5,3 +5,5 @@ weights: low: 1.0 mid: 0.5 high: 0.0 +default-bucket-offset: 0 +risk-score-normalization-divisor: 25

Application Configuration: Attenuation Duration Enhancements We need two additional configuration variables for the attenuation duration, namely defaultBucketOffset and riskScoreNormalizationDivisor. The target config should look like this: ```yaml default-bucket-offset: 0 # discussed as W4 risk-score-normalization-divisor: 25 # discussed as W5 thresholds: lower: 50 upper: 70 weights: low: 1.0 mid: 0.5 high: 0.0 ``` Value range for bucket offset: 0 or 1 (int) risk score normalization divisor: 1...1000 (int)

@michael-burwig Proposed .proto file: ``` syntax = "proto3"; package app.coronawarn.server.common.protocols.internal; option java_package = "app.coronawarn.server.common.protocols.internal"; option java_multiple_files = true; message AttenuationDuration { Thresholds thresholds = 1; Weights weights = 2; int32 defaultBucketOffset = 3; int32 riskScoreNormalizationDivisor = 4; } message Thresholds { int32 lower = 1; int32 upper = 2; } message Weights { double low = 1; double mid = 2; double high = 3; } ```

corona-warn-app/cwa-server

corona-warn-app__cwa-server-463

eb68e1126a4f9bcb169afef6a2ca1dbbbcf8b3cd

diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/DiagnosisKeyBundler.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/DiagnosisKeyBundler.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/DiagnosisKeyBundler.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/DiagnosisKeyBundler.java @@ -27,6 +27,7 @@ import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; import java.time.LocalDate; import java.time.LocalDateTime; +import java.time.temporal.Temporal; import java.util.Collection; import java.util.HashMap; import java.util.List; @@ -35,12 +36,16 @@ import java.util.Set; import java.util.concurrent.TimeUnit; import java.util.stream.Collectors; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; /** * An instance of this class contains a collection of {@link DiagnosisKey DiagnosisKeys}. */ public abstract class DiagnosisKeyBundler { + private static final Logger logger = LoggerFactory.getLogger(DiagnosisKeyBundler.class); + /** * The submission timestamp is counted in 1 hour intervals since epoch. */ @@ -51,8 +56,9 @@ public abstract class DiagnosisKeyBundler { */ public static final long TEN_MINUTES_INTERVAL_SECONDS = TimeUnit.MINUTES.toSeconds(10); - protected final int minNumberOfKeysPerBundle; protected final long expiryPolicyMinutes; + protected final int minNumberOfKeysPerBundle; + private final int maxNumberOfKeysPerBundle; // The hour at which the distribution runs. This field is needed to prevent the run from distributing any keys that // have already been submitted but may only be distributed in the future (e.g. because they are not expired yet). @@ -61,9 +67,13 @@ public abstract class DiagnosisKeyBundler { // A map containing diagnosis keys, grouped by the LocalDateTime on which they may be distributed protected final Map<LocalDateTime, List<DiagnosisKey>> distributableDiagnosisKeys = new HashMap<>(); + /** + * Constructs a DiagnosisKeyBundler based on the specified service configuration. + */ public DiagnosisKeyBundler(DistributionServiceConfig distributionServiceConfig) { - this.minNumberOfKeysPerBundle = distributionServiceConfig.getShiftingPolicyThreshold(); this.expiryPolicyMinutes = distributionServiceConfig.getExpiryPolicyMinutes(); + this.minNumberOfKeysPerBundle = distributionServiceConfig.getShiftingPolicyThreshold(); + this.maxNumberOfKeysPerBundle = distributionServiceConfig.getMaximumNumberOfKeysPerBundle(); } /** @@ -106,9 +116,14 @@ public List<DiagnosisKey> getAllDiagnosisKeys() { public Set<LocalDate> getDatesWithDistributableDiagnosisKeys() { return this.distributableDiagnosisKeys.keySet().stream() .map(LocalDateTime::toLocalDate) + .filter(this::numberOfKeysForDateBelowMaximum) .collect(Collectors.toSet()); } + public boolean numberOfKeysForDateBelowMaximum(LocalDate date) { + return numberOfKeysBelowMaximum(getDiagnosisKeysForDate(date).size(), date); + } + /** * Returns a set of all {@link LocalDateTime hours} of a specified {@link LocalDate date} during which {@link * DiagnosisKey diagnosis keys} shall be distributed. @@ -116,9 +131,23 @@ public Set<LocalDate> getDatesWithDistributableDiagnosisKeys() { public Set<LocalDateTime> getHoursWithDistributableDiagnosisKeys(LocalDate currentDate) { return this.distributableDiagnosisKeys.keySet().stream() .filter(dateTime -> dateTime.toLocalDate().equals(currentDate)) + .filter(this::numberOfKeysForHourBelowMaximum) .collect(Collectors.toSet()); } + private boolean numberOfKeysForHourBelowMaximum(LocalDateTime hour) { + return numberOfKeysBelowMaximum(getDiagnosisKeysForHour(hour).size(), hour); + } + + private boolean numberOfKeysBelowMaximum(int numberOfKeys, Temporal time) { + if (numberOfKeys > maxNumberOfKeysPerBundle) { + logger.error("Number of diagnosis keys ({}) for {} exceeds the configured maximum.", numberOfKeys, time); + return false; + } else { + return true; + } + } + /** * Returns the submission timestamp of a {@link DiagnosisKey} as a {@link LocalDateTime}. */ diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysCountryDirectory.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysCountryDirectory.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysCountryDirectory.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysCountryDirectory.java @@ -67,6 +67,6 @@ public void prepare(ImmutableStack<Object> indices) { private IndexDirectory<LocalDate, WritableOnDisk> decorateDateDirectory(DiagnosisKeysDateDirectory dateDirectory) { return new DateAggregatingDecorator(new DateIndexingDecorator(dateDirectory, distributionServiceConfig), - cryptoProvider, distributionServiceConfig); + cryptoProvider, distributionServiceConfig, diagnosisKeyBundler); } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/DateAggregatingDecorator.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/DateAggregatingDecorator.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/DateAggregatingDecorator.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/DateAggregatingDecorator.java @@ -25,6 +25,7 @@ import app.coronawarn.server.common.protocols.external.exposurenotification.TemporaryExposureKey; import app.coronawarn.server.common.protocols.external.exposurenotification.TemporaryExposureKeyExport; import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.DiagnosisKeyBundler; import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.archive.decorator.singing.DiagnosisKeySigningDecorator; import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.file.TemporaryExposureKeyExportFile; import app.coronawarn.server.services.distribution.assembly.structure.Writable; @@ -54,15 +55,17 @@ public class DateAggregatingDecorator extends IndexDirectoryDecorator<LocalDate, private final CryptoProvider cryptoProvider; private final DistributionServiceConfig distributionServiceConfig; + private final DiagnosisKeyBundler diagnosisKeyBundler; /** * Creates a new DateAggregatingDecorator. */ public DateAggregatingDecorator(IndexDirectory<LocalDate, WritableOnDisk> directory, CryptoProvider cryptoProvider, - DistributionServiceConfig distributionServiceConfig) { + DistributionServiceConfig distributionServiceConfig, DiagnosisKeyBundler diagnosisKeyBundler) { super(directory); this.cryptoProvider = cryptoProvider; this.distributionServiceConfig = distributionServiceConfig; + this.diagnosisKeyBundler = diagnosisKeyBundler; } @Override @@ -77,6 +80,7 @@ public void prepare(ImmutableStack<Object> indices) { } Set<String> dates = this.getIndex(indices).stream() + .filter(diagnosisKeyBundler::numberOfKeysForDateBelowMaximum) .map(this.getIndexFormatter()) .map(Object::toString) .collect(Collectors.toSet()); diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/io/IO.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/io/IO.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/io/IO.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/io/IO.java @@ -30,6 +30,11 @@ */ public class IO { + /** + * The maximum acceptable file size in bytes. + */ + public static final int MAXIMUM_FILE_SIZE = 16000000; + private IO() { } @@ -51,12 +56,20 @@ public static void makeNewFile(File root, String name) { } /** - * Writes bytes into a file. + * Writes bytes into a file. If the resulting file would exceed the specified maximum file size, it is not written but + * removed instead. * * @param bytes The content to write * @param outputFile The file to write the content into. */ public static void writeBytesToFile(byte[] bytes, File outputFile) { + if (bytes.length > MAXIMUM_FILE_SIZE) { + String fileName = outputFile.getName(); + throw new UncheckedIOException( + new IOException( + "File size of " + bytes.length + " bytes exceeds the maximum file size. Deleting" + fileName)); + } + try (FileOutputStream outputFileStream = new FileOutputStream(outputFile)) { outputFileStream.write(bytes); } catch (IOException e) { diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/config/DistributionServiceConfig.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/config/DistributionServiceConfig.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/config/DistributionServiceConfig.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/config/DistributionServiceConfig.java @@ -33,6 +33,7 @@ public class DistributionServiceConfig { private Integer retentionDays; private Integer expiryPolicyMinutes; private Integer shiftingPolicyThreshold; + private Integer maximumNumberOfKeysPerBundle; private String outputFileName; private Boolean includeIncompleteDays; private Boolean includeIncompleteHours; @@ -81,6 +82,14 @@ public void setShiftingPolicyThreshold(Integer shiftingPolicyThreshold) { this.shiftingPolicyThreshold = shiftingPolicyThreshold; } + public Integer getMaximumNumberOfKeysPerBundle() { + return this.maximumNumberOfKeysPerBundle; + } + + public void setMaximumNumberOfKeysPerBundle(Integer maximumNumberOfKeysPerBundle) { + this.maximumNumberOfKeysPerBundle = maximumNumberOfKeysPerBundle; + } + public String getOutputFileName() { return outputFileName; } diff --git a/services/distribution/src/main/resources/application.yaml b/services/distribution/src/main/resources/application.yaml --- a/services/distribution/src/main/resources/application.yaml +++ b/services/distribution/src/main/resources/application.yaml @@ -13,6 +13,7 @@ services: retention-days: 14 expiry-policy-minutes: 120 shifting-policy-threshold: 140 + maximum-number-of-keys-per-bundle: 600000 include-incomplete-days: false include-incomplete-hours: false paths:

diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/DateIndexingDecoratorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/DateIndexingDecoratorTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/DateIndexingDecoratorTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/DateIndexingDecoratorTest.java @@ -22,6 +22,8 @@ import static app.coronawarn.server.services.distribution.common.Helpers.buildDiagnosisKeys; import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; import app.coronawarn.server.common.persistence.domain.DiagnosisKey; import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; @@ -96,6 +98,30 @@ void excludesCurrentDateFromIndex() { assertThat(index).doesNotContain(LocalDate.of(1970, 1, 5)); } + @Test + void excludesDatesThatExceedTheMaximumNumberOfKeys() { + List<DiagnosisKey> diagnosisKeys = Stream + .of(buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 6, 0), 1), + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 10, 0), 1)) + .flatMap(List::stream) + .collect(Collectors.toList()); + + DistributionServiceConfig svcConfig = mock(DistributionServiceConfig.class); + when(svcConfig.getExpiryPolicyMinutes()).thenReturn(120); + when(svcConfig.getShiftingPolicyThreshold()).thenReturn(1); + when(svcConfig.getMaximumNumberOfKeysPerBundle()).thenReturn(1); + + DiagnosisKeyBundler diagnosisKeyBundler = new ProdDiagnosisKeyBundler(svcConfig); + diagnosisKeyBundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); + + DateIndexingDecorator decorator = makeDecoratedDateDirectory(diagnosisKeyBundler); + + decorator.prepare(new ImmutableStack<>().push("DE")); + + Set<LocalDate> index = decorator.getIndex(new ImmutableStack<>()); + assertThat(index).isEmpty(); + } + private DateIndexingDecorator makeDecoratedDateDirectory(DiagnosisKeyBundler diagnosisKeyBundler) { return new DateIndexingDecorator( new DiagnosisKeysDateDirectory(diagnosisKeyBundler, cryptoProvider, distributionServiceConfig), diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/HourIndexingDecoratorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/HourIndexingDecoratorTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/HourIndexingDecoratorTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/HourIndexingDecoratorTest.java @@ -22,6 +22,8 @@ import static app.coronawarn.server.services.distribution.common.Helpers.buildDiagnosisKeys; import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; import app.coronawarn.server.common.persistence.domain.DiagnosisKey; import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; @@ -34,8 +36,6 @@ import java.time.LocalDateTime; import java.util.List; import java.util.Set; -import java.util.stream.Collectors; -import java.util.stream.Stream; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.ExtendWith; @@ -65,26 +65,27 @@ void setup() { } @Test - void excludesEmptyHoursFromIndex() { - List<DiagnosisKey> diagnosisKeys = Stream - .of(buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 4, 0), 5), - buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 5, 0), 0), - buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 6, 0), 5)) - .flatMap(List::stream) - .collect(Collectors.toList()); + void excludesHoursThatExceedTheMaximumNumberOfKeys() { + List<DiagnosisKey> diagnosisKeys = buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 4, 0), 2); + + DistributionServiceConfig svcConfig = mock(DistributionServiceConfig.class); + when(svcConfig.getExpiryPolicyMinutes()).thenReturn(120); + when(svcConfig.getShiftingPolicyThreshold()).thenReturn(1); + when(svcConfig.getMaximumNumberOfKeysPerBundle()).thenReturn(1); + + DiagnosisKeyBundler diagnosisKeyBundler = new ProdDiagnosisKeyBundler(svcConfig); diagnosisKeyBundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); + HourIndexingDecorator decorator = makeDecoratedHourDirectory(diagnosisKeyBundler); - decorator.prepare(new ImmutableStack<>().push("DE").push(LocalDate.of(1970, 1, 3))); + decorator.prepare(new ImmutableStack<>().push("DE").push(LocalDate.of(1970, 1, 3))); Set<LocalDateTime> index = decorator.getIndex(new ImmutableStack<>().push(LocalDate.of(1970, 1, 3))); - assertThat(index).contains(LocalDateTime.of(1970, 1, 3, 4, 0)); - assertThat(index).doesNotContain(LocalDateTime.of(1970, 1, 3, 5, 0)); - assertThat(index).contains(LocalDateTime.of(1970, 1, 3, 6, 0)); + assertThat(index).isEmpty(); } @Test - void excludesCurrentHourFromIndex() { + void excludesEmptyHoursFromIndex() { List<DiagnosisKey> diagnosisKeys = buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 5, 0, 0), 5); diagnosisKeyBundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 1, 0)); HourIndexingDecorator decorator = makeDecoratedHourDirectory(diagnosisKeyBundler); diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/io/IOTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/io/IOTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/io/IOTest.java @@ -0,0 +1,42 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.assembly.io; + + +import static org.assertj.core.api.Assertions.assertThatExceptionOfType; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.verify; + +import java.io.File; +import java.io.UncheckedIOException; +import org.junit.jupiter.api.Test; + +class IOTest { + + @Test + void doesNotWriteIfMaximumFileSize() { + File file = mock(File.class); + assertThatExceptionOfType(UncheckedIOException.class) + .isThrownBy(() -> IO.writeBytesToFile(new byte[IO.MAXIMUM_FILE_SIZE + 1], file)); + verify(file, never()).getPath(); + } +} diff --git a/services/distribution/src/test/resources/application.yaml b/services/distribution/src/test/resources/application.yaml --- a/services/distribution/src/test/resources/application.yaml +++ b/services/distribution/src/test/resources/application.yaml @@ -11,6 +11,7 @@ services: retention-days: 14 expiry-policy-minutes: 120 shifting-policy-threshold: 5 + maximum-number-of-keys-per-bundle: 600000 include-incomplete-days: false include-incomplete-hours: false paths:

Distribution: Add Safeguard to not generate any exposure key file > 16MB In order to prevent issues on the mobile device & potential abuse, add a safeguard, so that we do not publish any files, which are bigger than 16MB. In case this threshold is reached for any file, an error message must be logged. Make sure to keep consistency with the index files. In order to align with the current concept of always generating a file, we should generate an empty file in this case as well. @pithumke

> In order to align with the current concept of always generating a file, we should generate an empty file in this case as well. Will skip generating files larger than 600,000 keys in order to stay constistent with the current implementation.

corona-warn-app/cwa-server

corona-warn-app__cwa-server-466

b148f9eae02d75e509e9b0cc1ae0cdd3fbbad77e

diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/config/DistributionServiceConfig.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/config/DistributionServiceConfig.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/config/DistributionServiceConfig.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/config/DistributionServiceConfig.java @@ -404,6 +404,7 @@ public static class ObjectStore { private String bucket; private Boolean setPublicReadAclOnPutObject; private Integer maxNumberOfFailedOperations; + private Integer maxNumberOfS3Threads; public String getAccessKey() { return accessKey; @@ -460,5 +461,13 @@ public Integer getMaxNumberOfFailedOperations() { public void setMaxNumberOfFailedOperations(Integer maxNumberOfFailedOperations) { this.maxNumberOfFailedOperations = maxNumberOfFailedOperations; } + + public Integer getMaxNumberOfS3Threads() { + return maxNumberOfS3Threads; + } + + public void setMaxNumberOfS3Threads(Integer maxNumberOfS3Threads) { + this.maxNumberOfS3Threads = maxNumberOfS3Threads; + } } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3Publisher.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3Publisher.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3Publisher.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3Publisher.java @@ -28,9 +28,13 @@ import java.io.IOException; import java.nio.file.Path; import java.util.List; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.Future; import java.util.stream.Collectors; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor; +import org.springframework.stereotype.Component; /** * Publishes a folder on the disk to S3 while keeping the folder and file structure.<br> @@ -46,6 +50,7 @@ * <li>Currently not implemented: Supports multi threaded upload of files.</li> * </ul> */ +@Component public class S3Publisher { private static final Logger logger = LoggerFactory.getLogger(S3Publisher.class); @@ -55,32 +60,33 @@ public class S3Publisher { */ private static final String CWA_S3_ROOT = CwaApiStructureProvider.VERSION_DIRECTORY; - private final Path root; private final ObjectStoreAccess objectStoreAccess; private final FailedObjectStoreOperationsCounter failedOperationsCounter; + private final ThreadPoolTaskExecutor executor; /** * Creates an {@link S3Publisher} instance that attempts to publish the files at the specified location to an object * store. Object store operations are performed through the specified {@link ObjectStoreAccess} instance. * - * @param root The path of the directory that shall be published. * @param objectStoreAccess The {@link ObjectStoreAccess} used to communicate with the object store. * @param failedOperationsCounter The {@link FailedObjectStoreOperationsCounter} that is used to monitor the number of * failed operations. + * @param executor The executor that manages the upload task submission. */ - public S3Publisher(Path root, ObjectStoreAccess objectStoreAccess, - FailedObjectStoreOperationsCounter failedOperationsCounter) { - this.root = root; + public S3Publisher(ObjectStoreAccess objectStoreAccess, FailedObjectStoreOperationsCounter failedOperationsCounter, + ThreadPoolTaskExecutor executor) { this.objectStoreAccess = objectStoreAccess; this.failedOperationsCounter = failedOperationsCounter; + this.executor = executor; } /** * Synchronizes the files to S3. * + * @param root The path of the directory that shall be published. * @throws IOException in case there were problems reading files from the disk. */ - public void publish() throws IOException { + public void publish(Path root) throws IOException { PublishedFileSet published; List<LocalFile> toPublish = new PublishFileSet(root).getFiles(); List<LocalFile> diff; @@ -97,14 +103,25 @@ public void publish() throws IOException { diff = toPublish; } - logger.info("Beginning upload... "); - for (LocalFile file : diff) { - try { - this.objectStoreAccess.putObject(file); - } catch (ObjectStoreOperationFailedException e) { - failedOperationsCounter.incrementAndCheckThreshold(e); - } + logger.info("Beginning upload of {} files... ", diff.size()); + try { + diff.stream() + .map(file -> executor.submit(() -> objectStoreAccess.putObject(file))) + .forEach(this::awaitThread); + } finally { + executor.shutdown(); } logger.info("Upload completed."); } + + private void awaitThread(Future<?> result) { + try { + result.get(); + } catch (ExecutionException e) { + failedOperationsCounter.incrementAndCheckThreshold(new ObjectStoreOperationFailedException(e.getMessage(), e)); + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + throw new ObjectStoreOperationFailedException(e.getMessage(), e); + } + } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/ObjectStoreClientConfig.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/ObjectStorePublishingConfig.java similarity index 77% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/ObjectStoreClientConfig.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/ObjectStorePublishingConfig.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/ObjectStoreClientConfig.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/ObjectStorePublishingConfig.java @@ -26,6 +26,7 @@ import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.retry.annotation.EnableRetry; +import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor; import software.amazon.awssdk.auth.credentials.AwsBasicCredentials; import software.amazon.awssdk.auth.credentials.AwsCredentialsProvider; import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider; @@ -37,7 +38,7 @@ */ @Configuration @EnableRetry -public class ObjectStoreClientConfig { +public class ObjectStorePublishingConfig { private static final Region DEFAULT_REGION = Region.EU_CENTRAL_1; @@ -61,4 +62,17 @@ private ObjectStoreClient createClient(ObjectStore objectStore) { private String removeTrailingSlash(String string) { return string.endsWith("/") ? string.substring(0, string.length() - 1) : string; } + + /** + * Creates a {@link ThreadPoolTaskExecutor}, which is used to submit object store upload tasks. + */ + @Bean + public ThreadPoolTaskExecutor createExecutor(DistributionServiceConfig distributionServiceConfig) { + ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor(); + executor.setCorePoolSize(distributionServiceConfig.getObjectStore().getMaxNumberOfS3Threads()); + executor.setMaxPoolSize(distributionServiceConfig.getObjectStore().getMaxNumberOfS3Threads()); + executor.setThreadNamePrefix("object-store-operation-worker-"); + executor.initialize(); + return executor; + } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/S3Distribution.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/S3Distribution.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/S3Distribution.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/S3Distribution.java @@ -21,8 +21,6 @@ package app.coronawarn.server.services.distribution.runner; import app.coronawarn.server.services.distribution.assembly.component.OutputDirectoryProvider; -import app.coronawarn.server.services.distribution.objectstore.FailedObjectStoreOperationsCounter; -import app.coronawarn.server.services.distribution.objectstore.ObjectStoreAccess; import app.coronawarn.server.services.distribution.objectstore.S3Publisher; import app.coronawarn.server.services.distribution.objectstore.client.ObjectStoreOperationFailedException; import java.io.IOException; @@ -44,23 +42,19 @@ public class S3Distribution implements ApplicationRunner { private static final Logger logger = LoggerFactory.getLogger(S3Distribution.class); private final OutputDirectoryProvider outputDirectoryProvider; - private final ObjectStoreAccess objectStoreAccess; - private final FailedObjectStoreOperationsCounter failedOperationsCounter; + private final S3Publisher s3Publisher; - S3Distribution(OutputDirectoryProvider outputDirectoryProvider, ObjectStoreAccess objectStoreAccess, - FailedObjectStoreOperationsCounter failedOperationsCounter) { + S3Distribution(OutputDirectoryProvider outputDirectoryProvider, S3Publisher s3Publisher) { this.outputDirectoryProvider = outputDirectoryProvider; - this.objectStoreAccess = objectStoreAccess; - this.failedOperationsCounter = failedOperationsCounter; + this.s3Publisher = s3Publisher; } @Override public void run(ApplicationArguments args) { try { Path pathToDistribute = outputDirectoryProvider.getFileOnDisk().toPath().toAbsolutePath(); - S3Publisher s3Publisher = new S3Publisher(pathToDistribute, objectStoreAccess, failedOperationsCounter); - s3Publisher.publish(); + s3Publisher.publish(pathToDistribute); logger.info("Data pushed to Object Store successfully."); } catch (UnsupportedOperationException | ObjectStoreOperationFailedException | IOException e) { logger.error("Distribution failed.", e); diff --git a/services/distribution/src/main/resources/application.yaml b/services/distribution/src/main/resources/application.yaml --- a/services/distribution/src/main/resources/application.yaml +++ b/services/distribution/src/main/resources/application.yaml @@ -51,6 +51,7 @@ services: retry-attempts: 3 retry-backoff: 2000 max-number-of-failed-operations: 5 + max-number-of-s3-threads: 4 spring: main:

diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccessTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccessTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccessTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccessTest.java @@ -25,7 +25,7 @@ import static org.mockito.Mockito.when; import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; -import app.coronawarn.server.services.distribution.objectstore.client.ObjectStoreClientConfig; +import app.coronawarn.server.services.distribution.objectstore.client.ObjectStorePublishingConfig; import app.coronawarn.server.services.distribution.objectstore.publish.LocalFile; import app.coronawarn.server.services.distribution.objectstore.publish.LocalGenericFile; import java.io.IOException; @@ -43,7 +43,7 @@ import org.springframework.test.context.junit.jupiter.SpringExtension; @ExtendWith(SpringExtension.class) -@SpringBootTest(classes = {ObjectStoreAccess.class, ObjectStoreClientConfig.class}) +@SpringBootTest(classes = {ObjectStoreAccess.class, ObjectStorePublishingConfig.class}) @EnableConfigurationProperties(value = DistributionServiceConfig.class) @Tag("s3-integration") class ObjectStoreAccessTest { diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStorePublishingConfigTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStorePublishingConfigTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStorePublishingConfigTest.java @@ -0,0 +1,64 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.objectstore; + +import static org.assertj.core.api.Assertions.assertThat; + +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import app.coronawarn.server.services.distribution.objectstore.client.ObjectStoreClient; +import app.coronawarn.server.services.distribution.objectstore.client.ObjectStorePublishingConfig; +import app.coronawarn.server.services.distribution.objectstore.client.S3ClientWrapper; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.boot.test.mock.mockito.MockBean; +import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor; +import org.springframework.test.context.junit.jupiter.SpringExtension; + +@ExtendWith({SpringExtension.class}) +@SpringBootTest(classes = {ObjectStorePublishingConfig.class}) +@EnableConfigurationProperties(value = DistributionServiceConfig.class) +class ObjectStorePublishingConfigTest { + + @MockBean + private ObjectStoreClient objectStoreClient; + + @Autowired + private ThreadPoolTaskExecutor executor; + + @Autowired + private DistributionServiceConfig distributionServiceConfig; + + @Test + void testS3ClientWrapperInstantiation() { + ObjectStorePublishingConfig config = new ObjectStorePublishingConfig(); + assertThat(config.createObjectStoreClient(distributionServiceConfig)).isInstanceOf(S3ClientWrapper.class); + } + + @Test + void testThreadPoolExecutorPoolSize() { + int expNumberOfThreads = distributionServiceConfig.getObjectStore().getMaxNumberOfS3Threads(); + assertThat(executor.getCorePoolSize()).isEqualTo(expNumberOfThreads); + assertThat(executor.getMaxPoolSize()).isEqualTo(expNumberOfThreads); + } +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherIntegrationTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherIntegrationTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherIntegrationTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherIntegrationTest.java @@ -21,10 +21,9 @@ package app.coronawarn.server.services.distribution.objectstore; import static org.assertj.core.api.Assertions.assertThat; -import static org.mockito.Mockito.mock; import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; -import app.coronawarn.server.services.distribution.objectstore.client.ObjectStoreClientConfig; +import app.coronawarn.server.services.distribution.objectstore.client.ObjectStorePublishingConfig; import app.coronawarn.server.services.distribution.objectstore.client.S3Object; import java.io.IOException; import java.nio.file.Path; @@ -37,11 +36,12 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.boot.test.mock.mockito.MockBean; import org.springframework.core.io.ResourceLoader; import org.springframework.test.context.junit.jupiter.SpringExtension; @ExtendWith(SpringExtension.class) -@SpringBootTest(classes = {ObjectStoreAccess.class, ObjectStoreClientConfig.class}) +@SpringBootTest(classes = {ObjectStoreAccess.class, ObjectStorePublishingConfig.class, S3Publisher.class}) @EnableConfigurationProperties(value = DistributionServiceConfig.class) @Tag("s3-integration") class S3PublisherIntegrationTest { @@ -54,12 +54,15 @@ class S3PublisherIntegrationTest { @Autowired private ResourceLoader resourceLoader; + @MockBean + private FailedObjectStoreOperationsCounter failedObjectStoreOperationsCounter; + + @Autowired + private S3Publisher s3Publisher; + @Test void publishTestFolderOk() throws IOException { - S3Publisher publisher = new S3Publisher( - getFolderAsPath(rootTestFolder), objectStoreAccess, mock(FailedObjectStoreOperationsCounter.class)); - - publisher.publish(); + s3Publisher.publish(getFolderAsPath(rootTestFolder)); List<S3Object> s3Objects = objectStoreAccess.getObjectsWithPrefix("version"); assertThat(s3Objects).hasSize(5); diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherTest.java @@ -20,26 +20,37 @@ package app.coronawarn.server.services.distribution.objectstore; +import static org.assertj.core.util.Lists.emptyList; import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.doAnswer; +import static org.mockito.Mockito.doReturn; +import static org.mockito.Mockito.doThrow; import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.spy; import static org.mockito.Mockito.times; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; +import app.coronawarn.server.services.distribution.objectstore.client.ObjectStoreOperationFailedException; import app.coronawarn.server.services.distribution.objectstore.client.S3Object; import java.io.IOException; +import java.nio.file.Path; import java.util.List; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.Future; +import org.assertj.core.api.Assertions; +import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.ExtendWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.mock.mockito.MockBean; import org.springframework.core.io.ResourceLoader; +import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor; import org.springframework.test.context.junit.jupiter.SpringExtension; @ExtendWith(SpringExtension.class) class S3PublisherTest { - private static final String PUBLISHING_PATH = "testsetups/s3publishertest/topublish"; private static final S3Object FILE_1 = new S3Object("file1.txt", "cf7fb1ca5c32adc0941c35a6f7fc5eba"); private static final S3Object FILE_2 = new S3Object("file2.txt", "d882afb9fa9c26f7e9d0965b8faa79b8"); private static final S3Object FILE_3 = new S3Object("file3.txt", "0385524c9fdc83634467a11667c851ac"); @@ -47,14 +58,32 @@ class S3PublisherTest { @MockBean private ObjectStoreAccess objectStoreAccess; + @MockBean + private FailedObjectStoreOperationsCounter failedObjectStoreOperationsCounter; + @Autowired private ResourceLoader resourceLoader; + private ThreadPoolTaskExecutor executor; + private Path publishingPath; + private S3Publisher s3Publisher; + + @BeforeEach + void setup() throws IOException { + publishingPath = resourceLoader.getResource("testsetups/s3publishertest/topublish").getFile().toPath(); + executor = new ThreadPoolTaskExecutor(); + executor.setMaxPoolSize(1); + executor.setCorePoolSize(1); + executor.initialize(); + executor = spy(executor); + s3Publisher = new S3Publisher(objectStoreAccess, failedObjectStoreOperationsCounter, executor); + } + @Test void allNewNoExisting() throws IOException { - when(objectStoreAccess.getObjectsWithPrefix("version")).thenReturn(noneExisting()); + when(objectStoreAccess.getObjectsWithPrefix("version")).thenReturn(emptyList()); - createTestPublisher().publish(); + s3Publisher.publish(publishingPath); verify(objectStoreAccess, times(3)).putObject(any()); } @@ -63,7 +92,7 @@ void allNewNoExisting() throws IOException { void noUploadsDueToAlreadyExist() throws IOException { when(objectStoreAccess.getObjectsWithPrefix("version")).thenReturn(allExistAllSame()); - createTestPublisher().publish(); + s3Publisher.publish(publishingPath); verify(objectStoreAccess, times(0)).putObject(any()); } @@ -72,7 +101,7 @@ void noUploadsDueToAlreadyExist() throws IOException { void uploadAllOtherFilesDifferentNames() throws IOException { when(objectStoreAccess.getObjectsWithPrefix("version")).thenReturn(otherExisting()); - createTestPublisher().publish(); + s3Publisher.publish(publishingPath); verify(objectStoreAccess, times(3)).putObject(any()); } @@ -81,28 +110,75 @@ void uploadAllOtherFilesDifferentNames() throws IOException { void uploadOneDueToOneChanged() throws IOException { when(objectStoreAccess.getObjectsWithPrefix("version")).thenReturn(twoIdenticalOneOtherOneChange()); - createTestPublisher().publish(); + s3Publisher.publish(publishingPath); verify(objectStoreAccess, times(1)).putObject(any()); } - private List<S3Object> noneExisting() { - return List.of(); + @Test + void executorGetsShutDown() throws IOException { + when(objectStoreAccess.getObjectsWithPrefix("version")).thenReturn(emptyList()); + + s3Publisher.publish(publishingPath); + + verify(executor, times(1)).shutdown(); + } + + @Test + void taskExecutionHaltsWhenMaximumFailedOperationsReached() { + when(objectStoreAccess.getObjectsWithPrefix("version")).thenReturn(emptyList()); + setUpFailureThresholdExceededOnSecondUpload(); + + Assertions.assertThatExceptionOfType(ObjectStoreOperationFailedException.class) + .isThrownBy(() -> s3Publisher.publish(publishingPath)); + + // third invocation does not happen + verify(objectStoreAccess, times(2)).putObject(any()); + } + + @Test + void threadPoolShutDownWhenMaximumFailedOperationsReached() { + when(objectStoreAccess.getObjectsWithPrefix("version")).thenReturn(emptyList()); + setUpFailureThresholdExceededOnSecondUpload(); + + Assertions.assertThatExceptionOfType(ObjectStoreOperationFailedException.class) + .isThrownBy(() -> s3Publisher.publish(publishingPath)); + + verify(executor, times(1)).shutdown(); + } + + private void setUpFailureThresholdExceededOnSecondUpload() { + doThrow(ObjectStoreOperationFailedException.class).when(objectStoreAccess).putObject(any()); + doAnswer(__ -> null) + .doThrow(ObjectStoreOperationFailedException.class) + .when(failedObjectStoreOperationsCounter) + .incrementAndCheckThreshold(any(ObjectStoreOperationFailedException.class)); + } + + @Test + void interruptedExceptionHandling() throws ExecutionException, InterruptedException { + var result = mock(Future.class); + when(result.get()).thenThrow(new InterruptedException()); + doReturn(result).when(executor).submit(any(Runnable.class)); + when(objectStoreAccess.getObjectsWithPrefix("version")).thenReturn(emptyList()); + + Assertions.assertThatExceptionOfType(ObjectStoreOperationFailedException.class) + .isThrownBy(() -> s3Publisher.publish(publishingPath)); + + verify(executor, times(1)).shutdown(); } private List<S3Object> otherExisting() { return List.of( new S3Object("some_old_file.txt", "1fb772815c837b6294d9f163db89e962"), - new S3Object("other_old_file.txt", "2fb772815c837b6294d9f163db89e962") - ); + new S3Object("other_old_file.txt", "2fb772815c837b6294d9f163db89e962")); } private List<S3Object> allExistAllSame() { return List.of( FILE_1, FILE_2, - FILE_3 - ); + FILE_3); } private List<S3Object> twoIdenticalOneOtherOneChange() { @@ -110,12 +186,6 @@ private List<S3Object> twoIdenticalOneOtherOneChange() { new S3Object("newfile.txt", "1fb772815c837b6294d9f163db89e962"), // new FILE_1, FILE_2, - new S3Object("file3.txt", "111772815c837b6294d9f163db89e962") // changed - ); - } - - private S3Publisher createTestPublisher() throws IOException { - var publishPath = resourceLoader.getResource(PUBLISHING_PATH).getFile().toPath(); - return new S3Publisher(publishPath, objectStoreAccess, mock(FailedObjectStoreOperationsCounter.class)); + new S3Object("file3.txt", "111772815c837b6294d9f163db89e962")); // changed } } diff --git a/services/distribution/src/test/resources/application.yaml b/services/distribution/src/test/resources/application.yaml --- a/services/distribution/src/test/resources/application.yaml +++ b/services/distribution/src/test/resources/application.yaml @@ -50,6 +50,7 @@ services: retry-attempts: 3 retry-backoff: 1 max-number-of-failed-operations: 5 + max-number-of-s3-threads: 2 spring: main: banner-mode: off

S3Publisher: Increase performance The S3Publisher is currently running in only one thread, making it quite slow for uploads/requests for metadata. Enhance the S3Publisher/ObjectStoreAccess, so that multiple threads are being used for interacting with S3.

corona-warn-app/cwa-server

corona-warn-app__cwa-server-541

27ba812e04d6f842e15999adfbe388137b0c316b

diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -113,12 +113,14 @@ For the distribution module: ```bash POSTGRESQL_SERVICE_PORT=8001 VAULT_FILESIGNING_SECRET=</path/to/your/private_key> +SPRING_PROFILES_ACTIVE=signature-dev,disable-ssl-client-postgres ``` For the submission module: ```bash POSTGRESQL_SERVICE_PORT=8001 +SPRING_PROFILES_ACTIVE=disable-ssl-server,disable-ssl-client-postgres,disable-ssl-client-verification,disable-ssl-client-verification-verify-hostname ``` #### Configure @@ -159,8 +161,8 @@ To be able to set breakpoints (e.g. in IntelliJ), it may be necessary to use the The API that is being exposed by the backend services is documented in an [OpenAPI](https://www.openapis.org/) specification. The specification files are available at the following locations: -Service | OpenAPI Specification --------------|------------- +Service | OpenAPI Specification +--------------------------|------------- Submission Service | [services/submission/api_v1.json](https://github.com/corona-warn-app/cwa-server/raw/master/services/submission/api_v1.json) Distribution Service | [services/distribution/api_v1.json](https://github.com/corona-warn-app/cwa-server/raw/master/services/distribution/api_v1.json) @@ -168,25 +170,26 @@ Distribution Service | [services/distribution/api_v1.json](https://github.c ### Distribution -Profile | Effect -----------------------|------------- -`dev` | Turns the log level to `DEBUG`. -`cloud` | Removes default values for the `datasource` and `objectstore` configurations. -`demo` | Includes incomplete days and hours into the distribution run, thus creating aggregates for the current day and the current hour (and including both in the respective indices). When running multiple distributions in one hour with this profile, the date aggregate for today and the hours aggregate for the current hour will be updated and overwritten. This profile also turns off the expiry policy (Keys must be expired for at least 2 hours before distribution) and the shifting policy (there must be at least 140 keys in a distribution). -`testdata` | Causes test data to be inserted into the database before each distribution run. By default, around 1000 random diagnosis keys will be generated per hour. If there are no diagnosis keys in the database yet, random keys will be generated for every hour from the beginning of the retention period (14 days ago at 00:00 UTC) until one hour before the present hour. If there are already keys in the database, the random keys will be generated for every hour from the latest diagnosis key in the database (by submission timestamp) until one hour before the present hour (or none at all, if the latest diagnosis key in the database was submitted one hour ago or later). -`signature-dev` | Sets the app package ID in the export packages' signature info to `de.rki.coronawarnapp-dev` so that the non-productive/test public key will be used for client-side validation. -`signature-prod` | Sets the app package ID in the export packages' signature info to `de.rki.coronawarnapp` so that the productive public key will be used for client-side validation. -`ssl-client-postgres` | Enforces SSL with a pinned certificate for the connection to the postgres (see [here](https://github.com/corona-warn-app/cwa-server/blob/master/services/distribution/src/main/resources/application-ssl-client-postgres.yaml)). +Profile | Effect +------------------------------|------------- +`dev` | Turns the log level to `DEBUG`. +`cloud` | Removes default values for the `datasource` and `objectstore` configurations. +`demo` | Includes incomplete days and hours into the distribution run, thus creating aggregates for the current day and the current hour (and including both in the respective indices). When running multiple distributions in one hour with this profile, the date aggregate for today and the hours aggregate for the current hour will be updated and overwritten. This profile also turns off the expiry policy (Keys must be expired for at least 2 hours before distribution) and the shifting policy (there must be at least 140 keys in a distribution). +`testdata` | Causes test data to be inserted into the database before each distribution run. By default, around 1000 random diagnosis keys will be generated per hour. If there are no diagnosis keys in the database yet, random keys will be generated for every hour from the beginning of the retention period (14 days ago at 00:00 UTC) until one hour before the present hour. If there are already keys in the database, the random keys will be generated for every hour from the latest diagnosis key in the database (by submission timestamp) until one hour before the present hour (or none at all, if the latest diagnosis key in the database was submitted one hour ago or later). +`signature-dev` | Sets the app package ID in the export packages' signature info to `de.rki.coronawarnapp-dev` so that the non-productive/test public key will be used for client-side validation. +`signature-prod` | Sets the app package ID in the export packages' signature info to `de.rki.coronawarnapp` so that the productive public key will be used for client-side validation. +`disable-ssl-client-postgres` | Disables SSL for the connection to the postgres database. ### Submission -Profile | Effect ---------------------------|------------- -`dev` | Turns the log level to `DEBUG`. -`cloud` | Removes default values for the `datasource` configuration. -`ssl-server` | Enables SSL for the submission endpoint (see [here](https://github.com/corona-warn-app/cwa-server/blob/master/services/submission/src/main/resources/application-ssl-server.yaml)). -`ssl-client-postgres` | Enforces SSL with a pinned certificate for the connection to the postgres (see [here](https://github.com/corona-warn-app/cwa-server/blob/master/services/submission/src/main/resources/application-ssl-client-postgres.yaml)). -`ssl-client-verification` | Enforces SSL with a pinned certificate for the connection to the verification server (see [here](https://github.com/corona-warn-app/cwa-server/blob/master/services/submission/src/main/resources/application-ssl-client-verification.yaml)). +Profile | Effect +--------------------------------------------------|------------- +`dev` | Turns the log level to `DEBUG`. +`cloud` | Removes default values for the `datasource` configuration. +`disable-ssl-server` | Disables SSL for the submission endpoint. +`disable-ssl-client-postgres` | Disables SSL with a pinned certificate for the connection to the postgres database. +`disable-ssl-client-verification` | Disables SSL with a pinned certificate for the connection to the verification server. +`disable-ssl-client-verification-verify-hostname` | Disables the verification of the SSL hostname for the connection to the verification server. ## Documentation diff --git a/docker-compose.yml b/docker-compose.yml --- a/docker-compose.yml +++ b/docker-compose.yml @@ -11,7 +11,7 @@ services: - "8000:8080" - "8006:8081" environment: - SPRING_PROFILES_ACTIVE: dev + SPRING_PROFILES_ACTIVE: dev,disable-ssl-server,disable-ssl-client-postgres,disable-ssl-client-verification,disable-ssl-client-verification-verify-hostname POSTGRESQL_SERVICE_PORT: '5432' POSTGRESQL_SERVICE_HOST: postgres POSTGRESQL_DATABASE: ${POSTGRES_DB} @@ -29,7 +29,7 @@ services: - objectstore - create-bucket environment: - SPRING_PROFILES_ACTIVE: dev,signature-dev,testdata + SPRING_PROFILES_ACTIVE: dev,signature-dev,testdata,disable-ssl-client-postgres POSTGRESQL_SERVICE_PORT: '5432' POSTGRESQL_SERVICE_HOST: postgres POSTGRESQL_DATABASE: ${POSTGRES_DB} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/Application.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/Application.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/Application.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/Application.java @@ -21,6 +21,8 @@ package app.coronawarn.server.services.distribution; import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import java.util.Arrays; +import java.util.List; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.boot.SpringApplication; @@ -28,7 +30,9 @@ import org.springframework.boot.autoconfigure.domain.EntityScan; import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.context.ApplicationContext; +import org.springframework.context.EnvironmentAware; import org.springframework.context.annotation.ComponentScan; +import org.springframework.core.env.Environment; import org.springframework.data.jpa.repository.config.EnableJpaRepositories; /** @@ -42,7 +46,7 @@ @ComponentScan({"app.coronawarn.server.common.persistence", "app.coronawarn.server.services.distribution"}) @EnableConfigurationProperties({DistributionServiceConfig.class}) -public class Application { +public class Application implements EnvironmentAware { private static final Logger logger = LoggerFactory.getLogger(Application.class); @@ -58,4 +62,13 @@ public static void killApplication(ApplicationContext appContext) { logger.error("Application terminated abnormally."); System.exit(1); } + + @Override + public void setEnvironment(Environment environment) { + List<String> profiles = Arrays.asList(environment.getActiveProfiles()); + if (profiles.contains("disable-ssl-client-postgres")) { + logger.warn("The distribution runner is started with postgres connection TLS disabled. " + + "This should never be used in PRODUCTION!"); + } + } } diff --git a/services/distribution/src/main/resources/application-cloud.yaml b/services/distribution/src/main/resources/application-cloud.yaml --- a/services/distribution/src/main/resources/application-cloud.yaml +++ b/services/distribution/src/main/resources/application-cloud.yaml @@ -5,7 +5,6 @@ spring: user: ${POSTGRESQL_USER_FLYWAY} datasource: driver-class-name: org.postgresql.Driver - url: jdbc:postgresql://${POSTGRESQL_SERVICE_HOST}:${POSTGRESQL_SERVICE_PORT}/${POSTGRESQL_DATABASE} username: ${POSTGRESQL_USER_DISTRIBUTION} password: ${POSTGRESQL_PASSWORD_DISTRIBUTION} diff --git a/services/distribution/src/main/resources/application-disable-ssl-client-postgres.yaml b/services/distribution/src/main/resources/application-disable-ssl-client-postgres.yaml new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/resources/application-disable-ssl-client-postgres.yaml @@ -0,0 +1,4 @@ +--- +spring: + datasource: + url: jdbc:postgresql://${POSTGRESQL_SERVICE_HOST:localhost}:${POSTGRESQL_SERVICE_PORT:5432}/${POSTGRESQL_DATABASE:cwa} diff --git a/services/distribution/src/main/resources/application-ssl-client-postgres.yaml b/services/distribution/src/main/resources/application-ssl-client-postgres.yaml deleted file mode 100644 --- a/services/distribution/src/main/resources/application-ssl-client-postgres.yaml +++ /dev/null @@ -1,4 +0,0 @@ ---- -spring: - datasource: - url: jdbc:postgresql://${POSTGRESQL_SERVICE_HOST}:${POSTGRESQL_SERVICE_PORT}/${POSTGRESQL_DATABASE}?ssl=true&sslmode=verify-full&sslrootcert=${SSL_POSTGRES_CERTIFICATE_PATH}&sslcert=${SSL_SUBMISSION_CERTIFICATE_PATH}&sslkey=${SSL_SUBMISSION_PRIVATE_KEY_PATH} diff --git a/services/distribution/src/main/resources/application.yaml b/services/distribution/src/main/resources/application.yaml --- a/services/distribution/src/main/resources/application.yaml +++ b/services/distribution/src/main/resources/application.yaml @@ -68,6 +68,6 @@ spring: datasource: driver-class-name: org.postgresql.Driver - url: jdbc:postgresql://${POSTGRESQL_SERVICE_HOST:localhost}:${POSTGRESQL_SERVICE_PORT:5432}/${POSTGRESQL_DATABASE:cwa} + url: jdbc:postgresql://${POSTGRESQL_SERVICE_HOST}:${POSTGRESQL_SERVICE_PORT}/${POSTGRESQL_DATABASE}?ssl=true&sslmode=verify-full&sslrootcert=${SSL_POSTGRES_CERTIFICATE_PATH}&sslcert=${SSL_DISTRIBUTION_CERTIFICATE_PATH}&sslkey=${SSL_DISTRIBUTION_PRIVATE_KEY_PATH} username: ${POSTGRESQL_USER_DISTRIBUTION:local_setup_distribution} password: ${POSTGRESQL_PASSWORD_DISTRIBUTION:local_setup_distribution} diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/ServerApplication.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/ServerApplication.java --- a/services/submission/src/main/java/app/coronawarn/server/services/submission/ServerApplication.java +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/ServerApplication.java @@ -22,13 +22,19 @@ import io.micrometer.core.aop.TimedAspect; import io.micrometer.core.instrument.MeterRegistry; +import java.util.Arrays; +import java.util.List; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.autoconfigure.domain.EntityScan; import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.cloud.openfeign.EnableFeignClients; +import org.springframework.context.EnvironmentAware; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.ComponentScan; +import org.springframework.core.env.Environment; import org.springframework.data.jpa.repository.config.EnableJpaRepositories; import org.springframework.http.converter.protobuf.ProtobufHttpMessageConverter; @@ -39,7 +45,13 @@ "app.coronawarn.server.services.submission"}) @EnableConfigurationProperties @EnableFeignClients -public class ServerApplication { +public class ServerApplication implements EnvironmentAware { + + private static final Logger logger = LoggerFactory.getLogger(ServerApplication.class); + + public static void main(String[] args) { + SpringApplication.run(ServerApplication.class); + } @Bean TimedAspect timedAspect(MeterRegistry registry) { @@ -51,7 +63,27 @@ ProtobufHttpMessageConverter protobufHttpMessageConverter() { return new ProtobufHttpMessageConverter(); } - public static void main(String[] args) { - SpringApplication.run(ServerApplication.class); + @Override + public void setEnvironment(Environment environment) { + List<String> profiles = Arrays.asList(environment.getActiveProfiles()); + if (profiles.contains("disable-ssl-server")) { + logger.warn( + "The submission service is started with endpoint TLS disabled. This should never be used in PRODUCTION!"); + } + if (profiles.contains("disable-ssl-client-postgres")) { + logger.warn( + "The submission service is started with postgres connection TLS disabled. This should never be used in" + + "PRODUCTION!"); + } + if (profiles.contains("disable-ssl-client-verification")) { + logger.warn( + "The submission service is started with verification service connection TLS disabled. This should never be" + + "used in PRODUCTION!"); + } + if (profiles.contains("disable-ssl-client-verification-verify-hostname")) { + logger.warn( + "The submission service is started with verification service TLS hostname validation disabled. This should" + + "never be used in PRODUCTION!"); + } } } diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/config/SubmissionServiceConfig.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/config/SubmissionServiceConfig.java --- a/services/submission/src/main/java/app/coronawarn/server/services/submission/config/SubmissionServiceConfig.java +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/config/SubmissionServiceConfig.java @@ -20,6 +20,7 @@ package app.coronawarn.server.services.submission.config; +import java.io.File; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.stereotype.Component; @@ -35,6 +36,7 @@ public class SubmissionServiceConfig { private Payload payload; private Verification verification; private Monitoring monitoring; + private Client client; public Double getInitialFakeDelayMilliseconds() { return initialFakeDelayMilliseconds; @@ -142,4 +144,74 @@ public Long getMonitoringBatchSize() { public void setMonitoringBatchSize(Long batchSize) { this.monitoring.setBatchSize(batchSize); } + + public Client getClient() { + return client; + } + + public void setClient(Client client) { + this.client = client; + } + + public static class Client { + + private Ssl ssl; + + public Ssl getSsl() { + return ssl; + } + + public void setSsl(Ssl ssl) { + this.ssl = ssl; + } + + public static class Ssl { + + private File keyStore; + private String keyStorePassword; + private String keyPassword; + private File trustStore; + private String trustStorePassword; + + public File getKeyStore() { + return keyStore; + } + + public void setKeyStore(File keyStore) { + this.keyStore = keyStore; + } + + public String getKeyStorePassword() { + return keyStorePassword; + } + + public void setKeyStorePassword(String keyStorePassword) { + this.keyStorePassword = keyStorePassword; + } + + public String getKeyPassword() { + return keyPassword; + } + + public void setKeyPassword(String keyPassword) { + this.keyPassword = keyPassword; + } + + public File getTrustStore() { + return trustStore; + } + + public void setTrustStore(File trustStore) { + this.trustStore = trustStore; + } + + public String getTrustStorePassword() { + return trustStorePassword; + } + + public void setTrustStorePassword(String trustStorePassword) { + this.trustStorePassword = trustStorePassword; + } + } + } } diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/CloudFeignClientProvider.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/CloudFeignClientProvider.java --- a/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/CloudFeignClientProvider.java +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/CloudFeignClientProvider.java @@ -20,8 +20,11 @@ package app.coronawarn.server.services.submission.verification; +import app.coronawarn.server.services.submission.config.SubmissionServiceConfig; +import app.coronawarn.server.services.submission.config.SubmissionServiceConfig.Client.Ssl; import feign.Client; import feign.httpclient.ApacheHttpClient; +import java.io.File; import java.io.IOException; import java.security.GeneralSecurityException; import javax.net.ssl.SSLContext; @@ -33,19 +36,29 @@ import org.springframework.cloud.commons.httpclient.DefaultApacheHttpClientFactory; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Profile; -import org.springframework.core.env.Environment; import org.springframework.stereotype.Component; -import org.springframework.util.ResourceUtils; @Component -@Profile("ssl-client-verification") +@Profile("!disable-ssl-client-verification") public class CloudFeignClientProvider implements FeignClientProvider { - private final Environment environment; private final HostnameVerifierProvider hostnameVerifierProvider; + private final File keyStore; + private final String keyStorePassword; + private final String keyPassword; + private final File trustStore; + private final String trustStorePassword; - public CloudFeignClientProvider(Environment environment, HostnameVerifierProvider hostnameVerifierProvider) { - this.environment = environment; + /** + * Creates a {@link CloudFeignClientProvider} that provides feign clients with fixed key and trust material. + */ + public CloudFeignClientProvider(SubmissionServiceConfig config, HostnameVerifierProvider hostnameVerifierProvider) { + Ssl sslConfig = config.getClient().getSsl(); + this.keyStore = sslConfig.getKeyStore(); + this.keyStorePassword = sslConfig.getKeyStorePassword(); + this.keyPassword = sslConfig.getKeyPassword(); + this.trustStore = sslConfig.getTrustStore(); + this.trustStorePassword = sslConfig.getTrustStorePassword(); this.hostnameVerifierProvider = hostnameVerifierProvider; } @@ -56,18 +69,10 @@ public Client createFeignClient() { private SSLContext getSslContext() { try { - String keyStorePath = environment.getProperty("client.ssl.key-store"); - String keyStorePassword = environment.getProperty("client.ssl.key-store-password"); - String keyPassword = environment.getProperty("client.ssl.key-password"); - - String trustStorePath = environment.getProperty("client.ssl.verification.trust-store"); - String trustStorePassword = environment.getProperty("client.ssl.verification.trust-store-password"); - return SSLContextBuilder .create() - .loadKeyMaterial(ResourceUtils.getFile(keyStorePath), keyStorePassword.toCharArray(), - keyPassword.toCharArray()) - .loadTrustMaterial(ResourceUtils.getFile(trustStorePath), trustStorePassword.toCharArray()) + .loadKeyMaterial(this.keyStore, this.keyStorePassword.toCharArray(), this.keyPassword.toCharArray()) + .loadTrustMaterial(this.trustStore, this.trustStorePassword.toCharArray()) .build(); } catch (IOException | GeneralSecurityException e) { throw new RuntimeException(e); diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/DefaultHostnameVerifierProvider.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/DefaultHostnameVerifierProvider.java --- a/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/DefaultHostnameVerifierProvider.java +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/DefaultHostnameVerifierProvider.java @@ -26,7 +26,7 @@ import org.springframework.stereotype.Component; @Component -@Profile("ssl-client-verification-verify-hostname") +@Profile("!disable-ssl-client-verification-verify-hostname") public class DefaultHostnameVerifierProvider implements HostnameVerifierProvider { @Override diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/DevelopmentFeignClientProvider.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/DevelopmentFeignClientProvider.java --- a/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/DevelopmentFeignClientProvider.java +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/DevelopmentFeignClientProvider.java @@ -32,9 +32,15 @@ import org.springframework.stereotype.Component; @Component -@Profile("!ssl-client-verification") +@Profile("disable-ssl-client-verification") public class DevelopmentFeignClientProvider implements FeignClientProvider { + private final HostnameVerifierProvider hostnameVerifierProvider; + + public DevelopmentFeignClientProvider(HostnameVerifierProvider hostnameVerifierProvider) { + this.hostnameVerifierProvider = hostnameVerifierProvider; + } + @Override public Client createFeignClient() { return new ApacheHttpClient(createHttpClientFactory().createBuilder().build()); @@ -45,7 +51,8 @@ public Client createFeignClient() { */ @Bean public ApacheHttpClientFactory createHttpClientFactory() { - return new DefaultApacheHttpClientFactory(HttpClientBuilder.create()); + return new DefaultApacheHttpClientFactory(HttpClientBuilder.create() + .setSSLHostnameVerifier(this.hostnameVerifierProvider.createHostnameVerifier())); } @Bean diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/NoopHostnameVerifierProvider.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/NoopHostnameVerifierProvider.java --- a/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/NoopHostnameVerifierProvider.java +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/NoopHostnameVerifierProvider.java @@ -26,7 +26,7 @@ import org.springframework.stereotype.Component; @Component -@Profile("!ssl-client-verification-verify-hostname") +@Profile("disable-ssl-client-verification-verify-hostname") public class NoopHostnameVerifierProvider implements HostnameVerifierProvider { @Override diff --git a/services/submission/src/main/resources/application-cloud.yaml b/services/submission/src/main/resources/application-cloud.yaml --- a/services/submission/src/main/resources/application-cloud.yaml +++ b/services/submission/src/main/resources/application-cloud.yaml @@ -5,7 +5,6 @@ spring: user: ${POSTGRESQL_USER_FLYWAY} datasource: driver-class-name: org.postgresql.Driver - url: jdbc:postgresql://${POSTGRESQL_SERVICE_HOST}:${POSTGRESQL_SERVICE_PORT}/${POSTGRESQL_DATABASE} username: ${POSTGRESQL_USER_SUBMISSION} password: ${POSTGRESQL_PASSWORD_SUBMISSION} diff --git a/services/submission/src/main/resources/application-disable-ssl-client-postgres.yaml b/services/submission/src/main/resources/application-disable-ssl-client-postgres.yaml new file mode 100644 --- /dev/null +++ b/services/submission/src/main/resources/application-disable-ssl-client-postgres.yaml @@ -0,0 +1,4 @@ +--- +spring: + datasource: + url: jdbc:postgresql://${POSTGRESQL_SERVICE_HOST:localhost}:${POSTGRESQL_SERVICE_PORT:5432}/${POSTGRESQL_DATABASE:cwa} diff --git a/services/submission/src/main/resources/application-disable-ssl-server.yaml b/services/submission/src/main/resources/application-disable-ssl-server.yaml new file mode 100644 --- /dev/null +++ b/services/submission/src/main/resources/application-disable-ssl-server.yaml @@ -0,0 +1,4 @@ +--- +server: + ssl: + enabled: false diff --git a/services/submission/src/main/resources/application-ssl-client-postgres.yaml b/services/submission/src/main/resources/application-ssl-client-postgres.yaml deleted file mode 100644 --- a/services/submission/src/main/resources/application-ssl-client-postgres.yaml +++ /dev/null @@ -1,4 +0,0 @@ ---- -spring: - datasource: - url: jdbc:postgresql://${POSTGRESQL_SERVICE_HOST}:${POSTGRESQL_SERVICE_PORT}/${POSTGRESQL_DATABASE}?ssl=true&sslmode=verify-full&sslrootcert=${SSL_POSTGRES_CERTIFICATE_PATH}&sslcert=${SSL_SUBMISSION_CERTIFICATE_PATH}&sslkey=${SSL_SUBMISSION_PRIVATE_KEY_PATH} diff --git a/services/submission/src/main/resources/application-ssl-client-verification.yaml b/services/submission/src/main/resources/application-ssl-client-verification.yaml deleted file mode 100644 --- a/services/submission/src/main/resources/application-ssl-client-verification.yaml +++ /dev/null @@ -1,9 +0,0 @@ ---- -client: - ssl: - key-password: ${SSL_SUBMISSION_KEYSTORE_PASSWORD} - key-store: ${SSL_SUBMISSION_KEYSTORE_PATH} - key-store-password: ${SSL_SUBMISSION_KEYSTORE_PASSWORD} - verification: - trust-store: ${SSL_VERIFICATION_TRUSTSTORE_PATH} - trust-store-password: ${SSL_VERIFICATION_TRUSTSTORE_PASSWORD} diff --git a/services/submission/src/main/resources/application-ssl-server.yaml b/services/submission/src/main/resources/application-ssl-server.yaml deleted file mode 100644 --- a/services/submission/src/main/resources/application-ssl-server.yaml +++ /dev/null @@ -1,23 +0,0 @@ ---- -server: - ssl: - enabled: true - enabled-protocols: TLSv1.2,TLSv1.3 - protocol: TLS - ciphers: >- - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_DHE_DSS_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_256_GCM_SHA384 - TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_AES_128_GCM_SHA256 - TLS_AES_256_GCM_SHA384 - TLS_AES_128_CCM_SHA256 - key-password: ${SSL_SUBMISSION_KEYSTORE_PASSWORD} - key-store: ${SSL_SUBMISSION_KEYSTORE_PATH} - key-store-password: ${SSL_SUBMISSION_KEYSTORE_PASSWORD} - key-store-provider: SUN - key-store-type: JKS diff --git a/services/submission/src/main/resources/application.yaml b/services/submission/src/main/resources/application.yaml --- a/services/submission/src/main/resources/application.yaml +++ b/services/submission/src/main/resources/application.yaml @@ -32,7 +32,7 @@ spring: # Postgres configuration datasource: driver-class-name: org.postgresql.Driver - url: jdbc:postgresql://${POSTGRESQL_SERVICE_HOST:localhost}:${POSTGRESQL_SERVICE_PORT:5432}/${POSTGRESQL_DATABASE:cwa} + url: jdbc:postgresql://${POSTGRESQL_SERVICE_HOST}:${POSTGRESQL_SERVICE_PORT}/${POSTGRESQL_DATABASE}?ssl=true&sslmode=verify-full&sslrootcert=${SSL_POSTGRES_CERTIFICATE_PATH}&sslcert=${SSL_SUBMISSION_CERTIFICATE_PATH}&sslkey=${SSL_SUBMISSION_PRIVATE_KEY_PATH} username: ${POSTGRESQL_USER_SUBMISSION:local_setup_submission} password: ${POSTGRESQL_PASSWORD_SUBMISSION:local_setup_submission} @@ -64,4 +64,4 @@ management: feign: httpclient: maxConnections: 200 - maxConnectionsPerRoute: 200 + maxConnectionsPerRoute: 200 \ No newline at end of file

diff --git a/services/submission/src/test/java/app/coronawarn/server/services/submission/ServerApplicationTests.java b/services/submission/src/test/java/app/coronawarn/server/services/submission/ServerApplicationTests.java --- a/services/submission/src/test/java/app/coronawarn/server/services/submission/ServerApplicationTests.java +++ b/services/submission/src/test/java/app/coronawarn/server/services/submission/ServerApplicationTests.java @@ -28,8 +28,10 @@ import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.mock.mockito.MockBean; import org.springframework.boot.test.web.client.TestRestTemplate; +import org.springframework.test.context.ActiveProfiles; @SpringBootTest +@ActiveProfiles({ "disable-ssl-client-verification", "disable-ssl-client-verification-verify-hostname" }) class ServerApplicationTests { @Autowired diff --git a/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/PayloadValidationTest.java b/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/PayloadValidationTest.java --- a/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/PayloadValidationTest.java +++ b/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/PayloadValidationTest.java @@ -44,8 +44,10 @@ import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.mock.mockito.MockBean; import org.springframework.http.ResponseEntity; +import org.springframework.test.context.ActiveProfiles; @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) +@ActiveProfiles({"disable-ssl-client-verification", "disable-ssl-client-verification-verify-hostname"}) class PayloadValidationTest { @MockBean diff --git a/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/SubmissionControllerTest.java b/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/SubmissionControllerTest.java --- a/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/SubmissionControllerTest.java +++ b/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/SubmissionControllerTest.java @@ -73,8 +73,10 @@ import org.springframework.http.HttpMethod; import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; +import org.springframework.test.context.ActiveProfiles; @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) +@ActiveProfiles({ "disable-ssl-client-verification", "disable-ssl-client-verification-verify-hostname" }) class SubmissionControllerTest { private static final URI SUBMISSION_URL = URI.create("/version/v1/diagnosis-keys"); diff --git a/services/submission/src/test/java/app/coronawarn/server/services/submission/monitoring/VerificationServiceHealthIndicatorTest.java b/services/submission/src/test/java/app/coronawarn/server/services/submission/monitoring/VerificationServiceHealthIndicatorTest.java --- a/services/submission/src/test/java/app/coronawarn/server/services/submission/monitoring/VerificationServiceHealthIndicatorTest.java +++ b/services/submission/src/test/java/app/coronawarn/server/services/submission/monitoring/VerificationServiceHealthIndicatorTest.java @@ -32,14 +32,15 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.mock.mockito.MockBean; +import org.springframework.test.context.ActiveProfiles; import org.springframework.test.context.TestPropertySource; import org.springframework.test.web.servlet.MockMvc; import org.springframework.test.web.servlet.setup.MockMvcBuilders; import org.springframework.web.context.WebApplicationContext; - @TestPropertySource(properties = {"management.port="}) @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) +@ActiveProfiles({ "disable-ssl-client-verification", "disable-ssl-client-verification-verify-hostname" }) class VerificationServiceHealthIndicatorTest { @MockBean diff --git a/services/submission/src/test/java/app/coronawarn/server/services/submission/verification/TanVerifierTest.java b/services/submission/src/test/java/app/coronawarn/server/services/submission/verification/TanVerifierTest.java --- a/services/submission/src/test/java/app/coronawarn/server/services/submission/verification/TanVerifierTest.java +++ b/services/submission/src/test/java/app/coronawarn/server/services/submission/verification/TanVerifierTest.java @@ -20,7 +20,6 @@ package app.coronawarn.server.services.submission.verification; - import static com.github.tomakehurst.wiremock.client.WireMock.aResponse; import static com.github.tomakehurst.wiremock.client.WireMock.equalTo; import static com.github.tomakehurst.wiremock.client.WireMock.matchingJsonPath; @@ -49,11 +48,11 @@ import org.springframework.http.MediaType; import org.springframework.test.context.ActiveProfiles; -@SpringBootTest(classes = {TanVerifier.class, DevelopmentFeignClientProvider.class}) +@SpringBootTest(classes = {TanVerifier.class, DevelopmentFeignClientProvider.class, NoopHostnameVerifierProvider.class}) @ImportAutoConfiguration({FeignAutoConfiguration.class, FeignTestConfiguration.class}) @EnableConfigurationProperties(value = SubmissionServiceConfig.class) @EnableFeignClients -@ActiveProfiles("feign") +@ActiveProfiles({ "feign", "disable-ssl-client-verification", "disable-ssl-client-verification-verify-hostname" }) class TanVerifierTest { @Autowired

SSL: Set a profile to willingly decrease security Currently, we have the profiles `ssl-server`, `ssl-client-verification` and `ssl-client-postgres` which will enable `ssl` for certain situations. In context of secure-by-default, we should have it in the opposite way - you can set a profile to willingly decrease security.

corona-warn-app/cwa-server

corona-warn-app__cwa-server-551

39cf982dab39722accf5cbb2cc6f2c6ef15c8456

diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/config/SubmissionServiceConfig.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/config/SubmissionServiceConfig.java --- a/services/submission/src/main/java/app/coronawarn/server/services/submission/config/SubmissionServiceConfig.java +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/config/SubmissionServiceConfig.java @@ -116,13 +116,13 @@ public void setPath(String path) { } private static class Monitoring { - private Integer batchSize; + private Long batchSize; - public Integer getBatchSize() { + public Long getBatchSize() { return batchSize; } - public void setBatchSize(Integer batchSize) { + public void setBatchSize(Long batchSize) { this.batchSize = batchSize; } } @@ -135,11 +135,11 @@ public void setMonitoring(Monitoring monitoring) { this.monitoring = monitoring; } - public Integer getMonitoringBatchSize() { + public Long getMonitoringBatchSize() { return this.monitoring.getBatchSize(); } - public void setMonitoringBatchSize(Integer batchSize) { + public void setMonitoringBatchSize(Long batchSize) { this.monitoring.setBatchSize(batchSize); } } diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/monitoring/BatchCounter.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/monitoring/BatchCounter.java --- a/services/submission/src/main/java/app/coronawarn/server/services/submission/monitoring/BatchCounter.java +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/monitoring/BatchCounter.java @@ -22,6 +22,7 @@ import io.micrometer.core.instrument.Counter; import io.micrometer.core.instrument.MeterRegistry; +import java.util.concurrent.atomic.AtomicLong; /** * Batch counter for counting requests for monitoring. Counts up in batches, given batch size. This way, single requests @@ -33,11 +34,11 @@ public class BatchCounter { private static final String SUBMISSION_CONTROLLER_REQUESTS_COUNTER_DESCRIPTION = "Counts requests to the Submission Controller."; - private final int batchSize; + private final long batchSize; private final Counter counter; - private Double batch = 0.; + private final AtomicLong count = new AtomicLong(0L); - BatchCounter(MeterRegistry meterRegistry, int batchSize, String type) { + BatchCounter(MeterRegistry meterRegistry, long batchSize, String type) { this.batchSize = batchSize; counter = Counter.builder(SUBMISSION_CONTROLLER_REQUESTS_COUNTER_NAME) .tag("type", type) @@ -50,11 +51,8 @@ public class BatchCounter { * counter is incremented. */ public void increment() { - if (batch < batchSize) { - batch++; - } else { - counter.increment(batch); - batch = 1.; + if (0 == count.incrementAndGet() % batchSize) { + counter.increment(batchSize); } } } diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/monitoring/SubmissionControllerMonitor.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/monitoring/SubmissionControllerMonitor.java --- a/services/submission/src/main/java/app/coronawarn/server/services/submission/monitoring/SubmissionControllerMonitor.java +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/monitoring/SubmissionControllerMonitor.java @@ -38,7 +38,7 @@ public class SubmissionControllerMonitor { private final MeterRegistry meterRegistry; - private final Integer batchSize; + private final long batchSize; private BatchCounter requests; private BatchCounter realRequests; private BatchCounter fakeRequests;

diff --git a/services/submission/src/test/java/app/coronawarn/server/services/submission/monitoring/BatchCounterTest.java b/services/submission/src/test/java/app/coronawarn/server/services/submission/monitoring/BatchCounterTest.java new file mode 100644 --- /dev/null +++ b/services/submission/src/test/java/app/coronawarn/server/services/submission/monitoring/BatchCounterTest.java @@ -0,0 +1,64 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.submission.monitoring; + +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.spy; +import static org.mockito.Mockito.times; +import static org.mockito.Mockito.verify; + +import io.micrometer.core.instrument.Counter; +import io.micrometer.core.instrument.MeterRegistry; +import io.micrometer.core.instrument.MeterRegistryMock; +import java.util.stream.LongStream; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.ValueSource; + +class BatchCounterTest { + + private static final String COUNTER_TYPE = "FooCounter"; + private MeterRegistry meterRegistry; + private Counter meterCounter; + + @BeforeEach + void setUpCounter() { + meterCounter = mock(Counter.class); + meterRegistry = spy(new MeterRegistryMock(meterCounter)); + } + + @ParameterizedTest + @ValueSource(longs = {1L, 2L, 4L}) + void incrementSubmittedOnceIfBatchSizeReached(long batchSize) { + BatchCounter batchCounter = new BatchCounter(meterRegistry, batchSize, COUNTER_TYPE); + LongStream.range(0, batchSize).forEach(__ -> batchCounter.increment()); + verify(meterCounter, times(1)).increment(batchSize); + } + + @ParameterizedTest + @ValueSource(longs = {2L, 4L, 7L}) + void doesNotIncrementIfLesserThanBatchSize(long batchSize) { + BatchCounter batchCounter = new BatchCounter(meterRegistry, batchSize, COUNTER_TYPE); + LongStream.range(0, batchSize - 1).forEach(__ -> batchCounter.increment()); + verify(meterCounter, never()).increment(batchSize); + } +} diff --git a/services/submission/src/test/java/io/micrometer/core/instrument/MeterRegistryMock.java b/services/submission/src/test/java/io/micrometer/core/instrument/MeterRegistryMock.java new file mode 100644 --- /dev/null +++ b/services/submission/src/test/java/io/micrometer/core/instrument/MeterRegistryMock.java @@ -0,0 +1,40 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package io.micrometer.core.instrument; + +import io.micrometer.core.instrument.simple.SimpleMeterRegistry; + +/** + * Used to get access to the {@link Counter} instance in BatchCounterTest. + */ +public class MeterRegistryMock extends SimpleMeterRegistry { + + final Counter counter; + + public MeterRegistryMock(Counter counter) { + this.counter = counter; + } + + @Override + Counter counter(Meter.Id id) { + return counter; + } +}

BatchCounter uses Double for counting ## Describe the bug BatchCounter uses `double` for integer arithmetics, which is commonly discouraged. ## Expected behaviour BatchCounter uses `int` for counting up to `batchSize`, since `batchSize` is also of type `int`. It's faster. In theory it's more accurate. (In practice there is no difference in this case since the maximum value that is representable in a double is larger than `Integer.MAX_VALUE`. But for `long` instead of `int`, there would be a difference.) ## Possible Fix ~~~java private int batch; ~~~ While here, `batch` should be renamed to `batchCount` to better express its actual meaning. BatchCounter is not thread-safe ## Describe the bug When multiple threads call `BatchCounter.increment` at the same time, the resulting count is unspecified. ## Expected behaviour `synchronized void increment` ## Steps to reproduce the issue Call `BatchCounter` from several threads at the same time. ## Possible Fix Add `synchronized`.

corona-warn-app/cwa-server

corona-warn-app__cwa-server-572

97f16ca7b711a30eec695c1ae7a6f032df16533b

diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapper.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapper.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapper.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapper.java @@ -20,9 +20,11 @@ package app.coronawarn.server.services.distribution.objectstore.client; +import static java.lang.Boolean.TRUE; import static java.util.stream.Collectors.toList; import java.nio.file.Path; +import java.util.ArrayList; import java.util.Collection; import java.util.List; import java.util.Map; @@ -78,13 +80,20 @@ public boolean bucketExists(String bucketName) { backoff = @Backoff(delayExpression = "${services.distribution.objectstore.retry-backoff}")) public List<S3Object> getObjects(String bucket, String prefix) { logRetryStatus("object download"); - - ListObjectsV2Response response = - s3Client.listObjectsV2(ListObjectsV2Request.builder().prefix(prefix).bucket(bucket).build()); - - return response.contents().stream() - .map(s3Object -> buildS3Object(s3Object, bucket)) - .collect(toList()); + List<S3Object> allS3Objects = new ArrayList<>(); + String continuationToken = null; + + do { + ListObjectsV2Request request = + ListObjectsV2Request.builder().prefix(prefix).bucket(bucket).continuationToken(continuationToken).build(); + ListObjectsV2Response response = s3Client.listObjectsV2(request); + response.contents().stream() + .map(s3Object -> buildS3Object(s3Object, bucket)) + .forEach(allS3Objects::add); + continuationToken = TRUE.equals(response.isTruncated()) ? response.continuationToken() : null; + } while (continuationToken != null); + + return allS3Objects; } @Recover

diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapperTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapperTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapperTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapperTest.java @@ -150,6 +150,25 @@ void testGetObjects(List<S3Object> expResult) { assertThat(actResult).isEqualTo(expResult); } + @Test + void testContinuationToken() { + var continuationToken = "1ueGcxLPRx1Tr/XYExHnhbYLgveDs2J/wm36Hy4vbOwM=<"; + + when(s3Client.listObjectsV2(any(ListObjectsV2Request.class))) + .thenReturn(ListObjectsV2Response.builder().isTruncated(true).continuationToken(continuationToken).build(), + ListObjectsV2Response.builder().isTruncated(false).build()); + + s3ClientWrapper.getObjects(VALID_BUCKET_NAME, VALID_PREFIX); + + ListObjectsV2Request continuationRequest = ListObjectsV2Request.builder() + .prefix(VALID_PREFIX).bucket(VALID_BUCKET_NAME).continuationToken(continuationToken).build(); + ListObjectsV2Request noContinuationRequest = ListObjectsV2Request.builder() + .prefix(VALID_PREFIX).bucket(VALID_BUCKET_NAME).build(); + + verify(s3Client, times(1)).listObjectsV2(eq(continuationRequest)); + verify(s3Client, times(1)).listObjectsV2(eq(noContinuationRequest)); + } + private static Stream<Arguments> createGetObjectsResults() { return Stream.of( Lists.emptyList(),

S3ClientWrapper getObjects: Not all objects could be received <!-- Thanks for reporting a bug 🙌 ❤️ Before opening a new issue, please make sure that we do not have any duplicates already open. You can ensure this by searching the issue list for this repository. If there is a duplicate, please close your issue and add a comment to the existing issue instead. Also, be sure to check our documentation first: <URL> --> ## Describe the bug https://github.com/corona-warn-app/cwa-server/blob/a953c054f8b4dc97d6a40525c5c3d5aa4d867394/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapper.java#L83 It is possible that not all objects are received, because the **listObjectsV2(ListObjectsV2Request listObjectsV2Request)** method limits them up to 1000. Javadoc [listObjectsV2](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/s3/S3Client.html#listObjectsV2-software.amazon.awssdk.services.s3.model.ListObjectsV2Request-) > Returns some or all (up to 1,000) of the objects in a bucket. ## Possible Fix 1. Checking the response for more data with the **isTruncated** method. JavaDoc [isTruncated](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/s3/model/ListObjectsV2Response.html#isTruncated--) > Set to false if all of the results were returned. Set to true if more keys are available to return. If the number of results exceeds that specified by MaxKeys, all of the results might not be returned. 2. When the response is truncated, calling the **nextContinuationToken** method for the next token. JavaDoc [nextContinuationToken](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/s3/model/ListObjectsV2Response.html#nextContinuationToken--) > NextContinuationToken is sent when isTruncated is true, which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken. 3. Build a new ListObjectsV2Request with the **continuationToken** and call **listObjectsV2** again JavaDoc [continuationToken](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/s3/model/ListObjectsV2Request.Builder.html#continuationToken-java.lang.String-) > ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key. 4. Repeat everything until isTruncate is false. Here is a pretty good example from AWS. They use a different S3Client, but it is very similar to the one you use. ([source](https://docs.aws.amazon.com/AmazonS3/latest/dev/ListingObjectKeysUsingJava.html)) ```java import com.amazonaws.AmazonServiceException; import com.amazonaws.SdkClientException; import com.amazonaws.auth.profile.ProfileCredentialsProvider; import com.amazonaws.regions.Regions; import com.amazonaws.services.s3.AmazonS3; import com.amazonaws.services.s3.AmazonS3ClientBuilder; import com.amazonaws.services.s3.model.ListObjectsV2Request; import com.amazonaws.services.s3.model.ListObjectsV2Result; import com.amazonaws.services.s3.model.S3ObjectSummary; import java.io.IOException; public class ListKeys { public static void main(String[] args) throws IOException { Regions clientRegion = Regions.DEFAULT_REGION; String bucketName = "*** Bucket name ***"; try { AmazonS3 s3Client = AmazonS3ClientBuilder.standard() .withCredentials(new ProfileCredentialsProvider()) .withRegion(clientRegion) .build(); System.out.println("Listing objects"); // maxKeys is set to 2 to demonstrate the use of // ListObjectsV2Result.getNextContinuationToken() ListObjectsV2Request req = new ListObjectsV2Request().withBucketName(bucketName).withMaxKeys(2); ListObjectsV2Result result; do { result = s3Client.listObjectsV2(req); for (S3ObjectSummary objectSummary : result.getObjectSummaries()) { System.out.printf(" - %s (size: %d)\n", objectSummary.getKey(), objectSummary.getSize()); } // If there are more than maxKeys keys in the bucket, get a continuation token // and list the next objects. String token = result.getNextContinuationToken(); System.out.println("Next Continuation Token: " + token); req.setContinuationToken(token); } while (result.isTruncated()); } catch (AmazonServiceException e) { // The call was transmitted successfully, but Amazon S3 couldn't process // it, so it returned an error response. e.printStackTrace(); } catch (SdkClientException e) { // Amazon S3 couldn't be contacted for a response, or the client // couldn't parse the response from Amazon S3. e.printStackTrace(); } } } ``

corona-warn-app/cwa-server

corona-warn-app__cwa-server-573

670560bd755a94fe8cf7dfea5bba13c9b64858ed

diff --git a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKey.java b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKey.java --- a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKey.java +++ b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKey.java @@ -24,6 +24,7 @@ import app.coronawarn.server.common.persistence.domain.DiagnosisKeyBuilders.Builder; import app.coronawarn.server.common.persistence.domain.validation.ValidRollingStartIntervalNumber; +import app.coronawarn.server.common.persistence.domain.validation.ValidSubmissionTimestamp; import java.time.Instant; import java.time.LocalDateTime; import java.util.Arrays; @@ -70,6 +71,7 @@ public class DiagnosisKey { @Range(min = 0, max = 8, message = "Risk level must be between 0 and 8.") private int transmissionRiskLevel; + @ValidSubmissionTimestamp private long submissionTimestamp; protected DiagnosisKey() { diff --git a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyBuilder.java b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyBuilder.java --- a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyBuilder.java +++ b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyBuilder.java @@ -24,6 +24,7 @@ import static app.coronawarn.server.common.persistence.domain.DiagnosisKeyBuilders.FinalBuilder; import static app.coronawarn.server.common.persistence.domain.DiagnosisKeyBuilders.RollingStartIntervalNumberBuilder; import static app.coronawarn.server.common.persistence.domain.DiagnosisKeyBuilders.TransmissionRiskLevelBuilder; +import static app.coronawarn.server.common.persistence.domain.validation.ValidSubmissionTimestampValidator.SECONDS_PER_HOUR; import app.coronawarn.server.common.persistence.exception.InvalidDiagnosisKeyException; import app.coronawarn.server.common.protocols.external.exposurenotification.TemporaryExposureKey; @@ -47,7 +48,7 @@ public class DiagnosisKeyBuilder implements private int rollingStartIntervalNumber; private int rollingPeriod = DiagnosisKey.EXPECTED_ROLLING_PERIOD; private int transmissionRiskLevel; - private long submissionTimestamp = -1L; + private Long submissionTimestamp = null; DiagnosisKeyBuilder() { } @@ -93,9 +94,9 @@ public FinalBuilder withRollingPeriod(int rollingPeriod) { @Override public DiagnosisKey build() { - if (submissionTimestamp < 0) { + if (submissionTimestamp == null) { // hours since epoch - submissionTimestamp = Instant.now().getEpochSecond() / 3600L; + submissionTimestamp = Instant.now().getEpochSecond() / SECONDS_PER_HOUR; } var diagnosisKey = new DiagnosisKey( diff --git a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/validation/ValidSubmissionTimestamp.java b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/validation/ValidSubmissionTimestamp.java new file mode 100644 --- /dev/null +++ b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/validation/ValidSubmissionTimestamp.java @@ -0,0 +1,58 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.common.persistence.domain.validation; + +import java.lang.annotation.Documented; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; +import javax.validation.Constraint; +import javax.validation.Payload; + +@Constraint(validatedBy = ValidSubmissionTimestampValidator.class) +@Target({ElementType.FIELD}) +@Retention(RetentionPolicy.RUNTIME) +@Documented +public @interface ValidSubmissionTimestamp { + + /** + * Error message. + * + * @return the error message + */ + String message() default "Submission timestamp (hours since epoch)" + + " must be greater or equal 0 and cannot be in the future."; + + /** + * Groups. + * + * @return + */ + Class<?>[] groups() default {}; + + /** + * Payload. + * + * @return + */ + Class<? extends Payload>[] payload() default {}; +} diff --git a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/validation/ValidSubmissionTimestampValidator.java b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/validation/ValidSubmissionTimestampValidator.java new file mode 100644 --- /dev/null +++ b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/validation/ValidSubmissionTimestampValidator.java @@ -0,0 +1,38 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.common.persistence.domain.validation; + +import java.time.Instant; +import java.util.concurrent.TimeUnit; +import javax.validation.ConstraintValidator; +import javax.validation.ConstraintValidatorContext; + +public class ValidSubmissionTimestampValidator + implements ConstraintValidator<ValidSubmissionTimestamp, Long> { + + public static final long SECONDS_PER_HOUR = TimeUnit.HOURS.toSeconds(1); + + @Override + public boolean isValid(Long submissionTimestamp, ConstraintValidatorContext constraintValidatorContext) { + long currentHoursSinceEpoch = Instant.now().getEpochSecond() / SECONDS_PER_HOUR; + return submissionTimestamp >= 0L && submissionTimestamp <= currentHoursSinceEpoch; + } +} diff --git a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyService.java b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyService.java --- a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyService.java +++ b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyService.java @@ -20,6 +20,7 @@ package app.coronawarn.server.common.persistence.service; +import static app.coronawarn.server.common.persistence.domain.validation.ValidSubmissionTimestampValidator.SECONDS_PER_HOUR; import static java.time.ZoneOffset.UTC; import app.coronawarn.server.common.persistence.domain.DiagnosisKey; @@ -109,7 +110,7 @@ public void applyRetentionPolicy(int daysToRetain) { long threshold = LocalDateTime .ofInstant(Instant.now(), UTC) .minusDays(daysToRetain) - .toEpochSecond(UTC) / 3600L; + .toEpochSecond(UTC) / SECONDS_PER_HOUR; int numberOfDeletions = keyRepository.deleteBySubmissionTimestampIsLessThanEqual(threshold); logger.info("Deleted {} diagnosis key(s) with a submission timestamp older than {} day(s) ago.", numberOfDeletions, daysToRetain);

diff --git a/common/persistence/src/test/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyBuilderTest.java b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyBuilderTest.java --- a/common/persistence/src/test/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyBuilderTest.java +++ b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyBuilderTest.java @@ -20,6 +20,8 @@ package app.coronawarn.server.common.persistence.domain; +import static app.coronawarn.server.common.persistence.domain.validation.ValidSubmissionTimestampValidator.SECONDS_PER_HOUR; +import static app.coronawarn.server.common.persistence.service.DiagnosisKeyServiceTestHelper.buildDiagnosisKeyForSubmissionTimestamp; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatCode; import static org.assertj.core.api.Assertions.catchThrowable; @@ -28,6 +30,7 @@ import app.coronawarn.server.common.protocols.external.exposurenotification.TemporaryExposureKey; import com.google.protobuf.ByteString; import java.nio.charset.StandardCharsets; +import java.time.Duration; import java.time.Instant; import java.time.LocalDate; import java.time.ZoneOffset; @@ -189,6 +192,33 @@ void keyDataDoesNotThrowOnValid() { .doesNotThrowAnyException(); } + @ParameterizedTest + @ValueSource(longs = {-1L, Long.MAX_VALUE}) + void submissionTimestampMustBeValid(long submissionTimestamp) { + assertThat( + catchThrowable(() -> buildDiagnosisKeyForSubmissionTimestamp(submissionTimestamp))) + .isInstanceOf(InvalidDiagnosisKeyException.class); + } + + @Test + void submissionTimestampMustNotBeInTheFuture() { + assertThat(catchThrowable( + () -> buildDiagnosisKeyForSubmissionTimestamp(getCurrentHoursSinceEpoch() + 1))) + .isInstanceOf(InvalidDiagnosisKeyException.class); + assertThat(catchThrowable(() -> buildDiagnosisKeyForSubmissionTimestamp( + Instant.now().getEpochSecond() /* accidentally forgot to divide by SECONDS_PER_HOUR */))) + .isInstanceOf(InvalidDiagnosisKeyException.class); + } + + @Test + void submissionTimestampDoesNotThrowOnValid() { + assertThatCode(() -> buildDiagnosisKeyForSubmissionTimestamp(0L)).doesNotThrowAnyException(); + assertThatCode(() -> buildDiagnosisKeyForSubmissionTimestamp(getCurrentHoursSinceEpoch())).doesNotThrowAnyException(); + assertThatCode( + () -> buildDiagnosisKeyForSubmissionTimestamp(Instant.now().minus(Duration.ofHours(2)).getEpochSecond() / SECONDS_PER_HOUR)) + .doesNotThrowAnyException(); + } + private DiagnosisKey keyWithKeyData(byte[] expKeyData) { return DiagnosisKey.builder() .withKeyData(expKeyData) @@ -223,7 +253,7 @@ private void assertDiagnosisKeyEquals(DiagnosisKey actDiagnosisKey) { } private long getCurrentHoursSinceEpoch() { - return Instant.now().getEpochSecond() / 3600L; + return Instant.now().getEpochSecond() / SECONDS_PER_HOUR; } private void assertDiagnosisKeyEquals(DiagnosisKey actDiagnosisKey, long expSubmissionTimestamp) { diff --git a/common/persistence/src/test/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyServiceTest.java b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyServiceTest.java --- a/common/persistence/src/test/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyServiceTest.java +++ b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyServiceTest.java @@ -21,6 +21,8 @@ package app.coronawarn.server.common.persistence.service; import static app.coronawarn.server.common.persistence.service.DiagnosisKeyServiceTestHelper.assertDiagnosisKeysEqual; +import static app.coronawarn.server.common.persistence.service.DiagnosisKeyServiceTestHelper.buildDiagnosisKeyForDateTime; +import static app.coronawarn.server.common.persistence.service.DiagnosisKeyServiceTestHelper.buildDiagnosisKeyForSubmissionTimestamp; import static java.time.ZoneOffset.UTC; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatCode; @@ -33,7 +35,6 @@ import java.util.ArrayList; import java.util.Collections; import java.util.List; -import java.util.Random; import org.assertj.core.util.Lists; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.DisplayName; @@ -171,19 +172,4 @@ void shouldNotUpdateExistingKey() { assertThat(actKeys.size()).isEqualTo(1); assertThat(actKeys.iterator().next().getTransmissionRiskLevel()).isEqualTo(2); } - - public static DiagnosisKey buildDiagnosisKeyForSubmissionTimestamp(long submissionTimeStamp) { - byte[] randomBytes = new byte[16]; - Random random = new Random(submissionTimeStamp); - random.nextBytes(randomBytes); - return DiagnosisKey.builder() - .withKeyData(randomBytes) - .withRollingStartIntervalNumber(600) - .withTransmissionRiskLevel(2) - .withSubmissionTimestamp(submissionTimeStamp).build(); - } - - public static DiagnosisKey buildDiagnosisKeyForDateTime(OffsetDateTime dateTime) { - return buildDiagnosisKeyForSubmissionTimestamp(dateTime.toEpochSecond() / 3600); - } } diff --git a/common/persistence/src/test/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyServiceTestHelper.java b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyServiceTestHelper.java --- a/common/persistence/src/test/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyServiceTestHelper.java +++ b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyServiceTestHelper.java @@ -23,7 +23,9 @@ import static org.assertj.core.api.Assertions.assertThat; import app.coronawarn.server.common.persistence.domain.DiagnosisKey; +import java.time.OffsetDateTime; import java.util.List; +import java.util.Random; public class DiagnosisKeyServiceTestHelper { @@ -48,4 +50,19 @@ public static void assertDiagnosisKeysEqual(List<DiagnosisKey> expKeys, .isEqualTo(expKey.getSubmissionTimestamp()); } } + + public static DiagnosisKey buildDiagnosisKeyForSubmissionTimestamp(long submissionTimeStamp) { + byte[] randomBytes = new byte[16]; + Random random = new Random(submissionTimeStamp); + random.nextBytes(randomBytes); + return DiagnosisKey.builder() + .withKeyData(randomBytes) + .withRollingStartIntervalNumber(600) + .withTransmissionRiskLevel(2) + .withSubmissionTimestamp(submissionTimeStamp).build(); + } + + public static DiagnosisKey buildDiagnosisKeyForDateTime(OffsetDateTime dateTime) { + return buildDiagnosisKeyForSubmissionTimestamp(dateTime.toEpochSecond() / 3600); + } }

Add JPA range validator for submissionTimestamp of DiagnosisKey DiagnosisKey uses a submissionTimestamp field of type long https://github.com/corona-warn-app/cwa-server/blob/7059232b48d2507d142fe683fbebdda371a98652/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKey.java#L73 the value is actually the *hours* since epoch but there are no sanity checks on the value. Just from reading the code you could e.g. easily think it's seconds since epoch and use it the wrong way without noticing at runtime. Proposal: * Add a JPA ConstraintValidator similar to ValidRollingStartIntervalNumberValidator which checks the value range to be greater or equal zero and not in the future (current hour since epoch rounded up) * Add field javadoc to submissionTimestamp: "hours since epoch" Expected Benefits: * discard invalid data * less potential for programming errors

I could open a PR wit the proposal if you think it makes sense the getter and Builder already do have javadoc "hours since epoch" https://github.com/corona-warn-app/cwa-server/blob/master/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyBuilders.java#L80 so it's actually documented. Would still be nice to validate it though. @jsievers makes sense. Please go ahead with a proposal PR.

corona-warn-app/cwa-server

corona-warn-app__cwa-server-624

b690586ea60876791d7a71ee733dfd6faf8d87d5

diff --git a/services/distribution/src/main/resources/bootstrap-cloud.yaml b/services/distribution/src/main/resources/bootstrap-cloud.yaml new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/resources/bootstrap-cloud.yaml @@ -0,0 +1,27 @@ +--- +spring: + application: + name: cwa-server + cloud: + vault: + enabled: true + generic: + enabled: false + kv: + enabled: true + backend: ${VAULT_BACKEND} + profile-separator: '/' + application-name: 'distribution' + default-context: '' + profiles: cloud + fail-fast: true + authentication: KUBERNETES + kubernetes: + role: ${VAULT_ROLE} + kubernetes-path: kubernetes + service-account-token-file: /var/run/secrets/kubernetes.io/serviceaccount/token + uri: ${VAULT_URI} + connection-timeout: 5000 + read-timeout: 15000 + config: + order: -10 diff --git a/services/distribution/src/main/resources/bootstrap.yaml b/services/distribution/src/main/resources/bootstrap.yaml new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/resources/bootstrap.yaml @@ -0,0 +1,5 @@ +--- +spring: + cloud: + vault: + enabled: false diff --git a/services/submission/pom.xml b/services/submission/pom.xml --- a/services/submission/pom.xml +++ b/services/submission/pom.xml @@ -17,6 +17,11 @@ </properties> <dependencies> + <dependency> + <groupId>org.springframework.cloud</groupId> + <artifactId>spring-cloud-starter-vault-config</artifactId> + <version>2.2.3.RELEASE</version> + </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> diff --git a/services/submission/src/main/resources/bootstrap-cloud.yaml b/services/submission/src/main/resources/bootstrap-cloud.yaml new file mode 100644 --- /dev/null +++ b/services/submission/src/main/resources/bootstrap-cloud.yaml @@ -0,0 +1,27 @@ +--- +spring: + application: + name: cwa-server + cloud: + vault: + enabled: true + generic: + enabled: false + kv: + enabled: true + backend: ${VAULT_BACKEND} + profile-separator: '/' + application-name: 'submission' + default-context: '' + profiles: cloud + fail-fast: true + authentication: KUBERNETES + kubernetes: + role: ${VAULT_ROLE} + kubernetes-path: kubernetes + service-account-token-file: /var/run/secrets/kubernetes.io/serviceaccount/token + uri: ${VAULT_URI} + connection-timeout: 5000 + read-timeout: 15000 + config: + order: -10 diff --git a/services/submission/src/main/resources/bootstrap.yaml b/services/submission/src/main/resources/bootstrap.yaml new file mode 100644 --- /dev/null +++ b/services/submission/src/main/resources/bootstrap.yaml @@ -0,0 +1,5 @@ +--- +spring: + cloud: + vault: + enabled: false

diff --git a/services/distribution/src/test/resources/bootstrap.yaml b/services/distribution/src/test/resources/bootstrap.yaml new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/resources/bootstrap.yaml @@ -0,0 +1,5 @@ +--- +spring: + cloud: + vault: + enabled: false diff --git a/services/submission/src/test/resources/bootstrap.yaml b/services/submission/src/test/resources/bootstrap.yaml new file mode 100644 --- /dev/null +++ b/services/submission/src/test/resources/bootstrap.yaml @@ -0,0 +1,5 @@ +--- +spring: + cloud: + vault: + enabled: false

Integrate Spring Cloud Vault ## Suggested Enhancement Evaluate how the project can integrate the [Spring Cloud Vault](https://cloud.spring.io/spring-cloud-vault/reference/html/) to enhance the process of credential handling.

corona-warn-app/cwa-server

corona-warn-app__cwa-server-629

2e2655a94ae13a663cdbbcb17c5b1065edccf90b

diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/structure/directory/AppConfigurationDirectory.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/structure/directory/AppConfigurationDirectory.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/structure/directory/AppConfigurationDirectory.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/structure/directory/AppConfigurationDirectory.java @@ -32,6 +32,7 @@ import app.coronawarn.server.services.distribution.assembly.structure.directory.decorator.indexing.IndexingDecoratorOnDisk; import app.coronawarn.server.services.distribution.assembly.structure.file.FileOnDisk; import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import java.util.Optional; import java.util.Set; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -86,6 +87,7 @@ private void addConfigurationArchiveIfValid(String archiveName) { ArchiveOnDisk appConfigurationFile = new ArchiveOnDisk(archiveName); appConfigurationFile.addWritable(new FileOnDisk("export.bin", applicationConfiguration.toByteArray())); countryDirectory.addWritableToAll(ignoredValue -> - new AppConfigurationSigningDecorator(appConfigurationFile, cryptoProvider, distributionServiceConfig)); + Optional + .of(new AppConfigurationSigningDecorator(appConfigurationFile, cryptoProvider, distributionServiceConfig))); } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/CwaApiStructureProvider.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/CwaApiStructureProvider.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/CwaApiStructureProvider.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/CwaApiStructureProvider.java @@ -25,6 +25,7 @@ import app.coronawarn.server.services.distribution.assembly.structure.directory.IndexDirectoryOnDisk; import app.coronawarn.server.services.distribution.assembly.structure.directory.decorator.indexing.IndexingDecoratorOnDisk; import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import java.util.Optional; import java.util.Set; import org.springframework.stereotype.Component; @@ -59,8 +60,10 @@ public Directory<WritableOnDisk> getDirectory() { ignoredValue -> Set.of(distributionServiceConfig.getApi().getVersionV1()), Object::toString); - versionDirectory.addWritableToAll(ignoredValue -> appConfigurationStructureProvider.getAppConfiguration()); - versionDirectory.addWritableToAll(ignoredValue -> diagnosisKeysStructureProvider.getDiagnosisKeys()); + versionDirectory.addWritableToAll(ignoredValue -> + Optional.of(appConfigurationStructureProvider.getAppConfiguration())); + versionDirectory.addWritableToAll(ignoredValue -> + Optional.of(diagnosisKeysStructureProvider.getDiagnosisKeys())); return new IndexingDecoratorOnDisk<>(versionDirectory, distributionServiceConfig.getOutputFileName()); } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/DiagnosisKeyBundler.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/DiagnosisKeyBundler.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/DiagnosisKeyBundler.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/DiagnosisKeyBundler.java @@ -95,6 +95,13 @@ public void setDiagnosisKeys(Collection<DiagnosisKey> diagnosisKeys, LocalDateTi this.createDiagnosisKeyDistributionMap(diagnosisKeys); } + /** + * Returns the {@link LocalDateTime} at which the distribution runs. + */ + public LocalDateTime getDistributionTime() { + return this.distributionTime; + } + /** * Returns all {@link DiagnosisKey DiagnosisKeys} contained by this {@link DiagnosisKeyBundler}. */ diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysCountryDirectory.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysCountryDirectory.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysCountryDirectory.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysCountryDirectory.java @@ -23,7 +23,6 @@ import app.coronawarn.server.common.persistence.domain.DiagnosisKey; import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.DiagnosisKeyBundler; -import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory.decorator.DateAggregatingDecorator; import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory.decorator.DateIndexingDecorator; import app.coronawarn.server.services.distribution.assembly.structure.WritableOnDisk; import app.coronawarn.server.services.distribution.assembly.structure.directory.IndexDirectory; @@ -31,6 +30,7 @@ import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; import java.time.LocalDate; +import java.util.Optional; import java.util.Set; public class DiagnosisKeysCountryDirectory extends IndexDirectoryOnDisk<String> { @@ -57,14 +57,12 @@ public DiagnosisKeysCountryDirectory(DiagnosisKeyBundler diagnosisKeyBundler, @Override public void prepare(ImmutableStack<Object> indices) { - this.addWritableToAll(ignoredValue -> - decorateDateDirectory( - new DiagnosisKeysDateDirectory(diagnosisKeyBundler, cryptoProvider, distributionServiceConfig))); + this.addWritableToAll(ignoredValue -> Optional.of(decorateDateDirectory( + new DiagnosisKeysDateDirectory(diagnosisKeyBundler, cryptoProvider, distributionServiceConfig)))); super.prepare(indices); } private IndexDirectory<LocalDate, WritableOnDisk> decorateDateDirectory(DiagnosisKeysDateDirectory dateDirectory) { - return new DateAggregatingDecorator(new DateIndexingDecorator(dateDirectory, distributionServiceConfig), - cryptoProvider, distributionServiceConfig, diagnosisKeyBundler); + return new DateIndexingDecorator(dateDirectory, distributionServiceConfig); } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectory.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectory.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectory.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectory.java @@ -23,14 +23,23 @@ import app.coronawarn.server.common.persistence.domain.DiagnosisKey; import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.DiagnosisKeyBundler; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.archive.decorator.signing.DiagnosisKeySigningDecorator; import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory.decorator.HourIndexingDecorator; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.file.TemporaryExposureKeyExportFile; +import app.coronawarn.server.services.distribution.assembly.structure.Writable; import app.coronawarn.server.services.distribution.assembly.structure.WritableOnDisk; +import app.coronawarn.server.services.distribution.assembly.structure.archive.Archive; +import app.coronawarn.server.services.distribution.assembly.structure.archive.ArchiveOnDisk; import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; import app.coronawarn.server.services.distribution.assembly.structure.directory.IndexDirectoryOnDisk; +import app.coronawarn.server.services.distribution.assembly.structure.file.File; import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; import java.time.LocalDate; +import java.time.ZoneOffset; import java.time.format.DateTimeFormatter; +import java.util.List; +import java.util.Optional; public class DiagnosisKeysDateDirectory extends IndexDirectoryOnDisk<LocalDate> { @@ -61,12 +70,39 @@ public void prepare(ImmutableStack<Object> indices) { this.addWritableToAll(ignoredValue -> { DiagnosisKeysHourDirectory hourDirectory = new DiagnosisKeysHourDirectory(diagnosisKeyBundler, cryptoProvider, distributionServiceConfig); - return decorateHourDirectory(hourDirectory); + return Optional.of(decorateHourDirectory(hourDirectory)); }); + this.addWritableToAll(this::indicesToDateDirectoryArchive); super.prepare(indices); } + private Optional<Writable<WritableOnDisk>> indicesToDateDirectoryArchive(ImmutableStack<Object> currentIndices) { + LocalDate currentDate = (LocalDate) currentIndices.peek(); + if (currentDate.equals(diagnosisKeyBundler.getDistributionTime().toLocalDate())) { + return Optional.empty(); + } + String region = (String) currentIndices.pop().peek(); + + List<DiagnosisKey> diagnosisKeysForCurrentHour = + this.diagnosisKeyBundler.getDiagnosisKeysForDate(currentDate); + + long startTimestamp = currentDate.atStartOfDay().toEpochSecond(ZoneOffset.UTC); + long endTimestamp = currentDate.plusDays(1).atStartOfDay().toEpochSecond(ZoneOffset.UTC); + + File<WritableOnDisk> temporaryExposureKeyExportFile = TemporaryExposureKeyExportFile.fromDiagnosisKeys( + diagnosisKeysForCurrentHour, region, startTimestamp, endTimestamp, distributionServiceConfig); + + Archive<WritableOnDisk> dateArchive = new ArchiveOnDisk(distributionServiceConfig.getOutputFileName()); + dateArchive.addWritable(temporaryExposureKeyExportFile); + + return Optional.of(decorateDiagnosisKeyArchive(dateArchive)); + } + private Directory<WritableOnDisk> decorateHourDirectory(DiagnosisKeysHourDirectory hourDirectory) { return new HourIndexingDecorator(hourDirectory, distributionServiceConfig); } + + private Directory<WritableOnDisk> decorateDiagnosisKeyArchive(Archive<WritableOnDisk> archive) { + return new DiagnosisKeySigningDecorator(archive, cryptoProvider, distributionServiceConfig); + } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectory.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectory.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectory.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectory.java @@ -37,6 +37,7 @@ import java.time.LocalDateTime; import java.time.ZoneOffset; import java.util.List; +import java.util.Optional; public class DiagnosisKeysHourDirectory extends IndexDirectoryOnDisk<LocalDateTime> { @@ -80,7 +81,7 @@ public void prepare(ImmutableStack<Object> indices) { Archive<WritableOnDisk> hourArchive = new ArchiveOnDisk(distributionServiceConfig.getOutputFileName()); hourArchive.addWritable(temporaryExposureKeyExportFile); - return decorateDiagnosisKeyArchive(hourArchive); + return Optional.of(decorateDiagnosisKeyArchive(hourArchive)); }); super.prepare(indices); } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/DateAggregatingDecorator.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/DateAggregatingDecorator.java deleted file mode 100644 --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/DateAggregatingDecorator.java +++ /dev/null @@ -1,202 +0,0 @@ -/*- - * ---license-start - * Corona-Warn-App - * --- - * Copyright (C) 2020 SAP SE and all other contributors - * --- - * 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 - * - * http://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. - * ---license-end - */ - -package app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory.decorator; - -import static app.coronawarn.server.services.distribution.assembly.structure.util.functional.CheckedFunction.uncheckedFunction; - -import app.coronawarn.server.common.protocols.external.exposurenotification.TemporaryExposureKey; -import app.coronawarn.server.common.protocols.external.exposurenotification.TemporaryExposureKeyExport; -import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; -import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.DiagnosisKeyBundler; -import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.archive.decorator.signing.DiagnosisKeySigningDecorator; -import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.file.TemporaryExposureKeyExportFile; -import app.coronawarn.server.services.distribution.assembly.structure.Writable; -import app.coronawarn.server.services.distribution.assembly.structure.WritableOnDisk; -import app.coronawarn.server.services.distribution.assembly.structure.archive.Archive; -import app.coronawarn.server.services.distribution.assembly.structure.archive.ArchiveOnDisk; -import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; -import app.coronawarn.server.services.distribution.assembly.structure.directory.DirectoryOnDisk; -import app.coronawarn.server.services.distribution.assembly.structure.directory.IndexDirectory; -import app.coronawarn.server.services.distribution.assembly.structure.directory.decorator.DirectoryDecorator; -import app.coronawarn.server.services.distribution.assembly.structure.directory.decorator.IndexDirectoryDecorator; -import app.coronawarn.server.services.distribution.assembly.structure.file.File; -import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; -import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; -import java.time.LocalDate; -import java.util.List; -import java.util.NoSuchElementException; -import java.util.Optional; -import java.util.Set; -import java.util.stream.Collectors; -import java.util.stream.Stream; - -/** - * A {@link DirectoryDecorator} that will bundle hour aggregates into date aggregates and sign them. - */ -public class DateAggregatingDecorator extends IndexDirectoryDecorator<LocalDate, WritableOnDisk> { - - private final CryptoProvider cryptoProvider; - private final DistributionServiceConfig distributionServiceConfig; - private final DiagnosisKeyBundler diagnosisKeyBundler; - - /** - * Creates a new DateAggregatingDecorator. - */ - public DateAggregatingDecorator(IndexDirectory<LocalDate, WritableOnDisk> directory, CryptoProvider cryptoProvider, - DistributionServiceConfig distributionServiceConfig, DiagnosisKeyBundler diagnosisKeyBundler) { - super(directory); - this.cryptoProvider = cryptoProvider; - this.distributionServiceConfig = distributionServiceConfig; - this.diagnosisKeyBundler = diagnosisKeyBundler; - } - - @Override - public void prepare(ImmutableStack<Object> indices) { - super.prepare(indices); - Set<Directory<WritableOnDisk>> dayDirectories = this.getWritables().stream() - .filter(writable -> writable instanceof DirectoryOnDisk) - .map(directory -> (DirectoryOnDisk) directory) - .collect(Collectors.toSet()); - if (dayDirectories.isEmpty()) { - return; - } - - Set<String> dates = this.getIndex(indices).stream() - .filter(diagnosisKeyBundler::numberOfKeysForDateBelowMaximum) - .map(this.getIndexFormatter()) - .map(Object::toString) - .collect(Collectors.toSet()); - - dayDirectories.stream() - .filter(dayDirectory -> dates.contains(dayDirectory.getName())) - .forEach(currentDirectory -> Stream.of(currentDirectory) - .map(this::getSubSubDirectoryArchives) - .map(this::getTemporaryExposureKeyExportFilesFromArchives) - .map(this::parseTemporaryExposureKeyExportsFromFiles) - .map(this::reduceTemporaryExposureKeyExportsToNewFile) - .map(temporaryExposureKeyExportFile -> { - Archive<WritableOnDisk> aggregate = new ArchiveOnDisk(distributionServiceConfig.getOutputFileName()); - aggregate.addWritable(temporaryExposureKeyExportFile); - return aggregate; - }) - .map(file -> new DiagnosisKeySigningDecorator(file, cryptoProvider, distributionServiceConfig)) - .forEach(aggregate -> { - currentDirectory.addWritable(aggregate); - aggregate.prepare(indices); - }) - ); - } - - /** - * Returns all archives that are 3 levels down from the root directory. - */ - private Set<Archive<WritableOnDisk>> getSubSubDirectoryArchives(Directory<WritableOnDisk> rootDirectory) { - return getWritablesInDirectory(rootDirectory, 3).stream() - .filter(Writable::isArchive) - .map(archive -> (Archive<WritableOnDisk>) archive) - .collect(Collectors.toSet()); - } - - /** - * Traverses a directory {@code depth} levels deep and returns a flattened list of all writables at that depth. A - * {@code depth} of 0 or less returns a set only containing the root directory. A depth of 1 returns a set of - * writables in the root directory. A depth of 2 returns a set of all writables in all directories in the root - * directory, and so on. - * - * @param rootDirectory The directory in which to start traversal. - * @param depth The depth to traverse. - * @return All writables that are {@code depth} levels down. - */ - private Set<Writable<WritableOnDisk>> getWritablesInDirectory(Directory<WritableOnDisk> rootDirectory, int depth) { - if (depth <= 0) { - return Set.of(rootDirectory); - } else if (depth == 1) { - return rootDirectory.getWritables(); - } else { - return rootDirectory.getWritables().stream() - .filter(Writable::isDirectory) - .flatMap(directory -> getWritablesInDirectory((Directory<WritableOnDisk>) directory, depth - 1).stream()) - .collect(Collectors.toSet()); - } - } - - private Set<TemporaryExposureKeyExportFile> getTemporaryExposureKeyExportFilesFromArchives( - Set<Archive<WritableOnDisk>> hourArchives) { - return hourArchives.stream() - .map(Directory::getWritables) - .map(writables -> writables.stream() - .filter(writable -> writable.getName().equals("export.bin"))) - .map(Stream::findFirst) - .map(Optional::orElseThrow) - .filter(writable -> writable instanceof File) - .map(file -> (TemporaryExposureKeyExportFile) file) - .collect(Collectors.toSet()); - } - - private Set<TemporaryExposureKeyExport> parseTemporaryExposureKeyExportsFromFiles( - Set<TemporaryExposureKeyExportFile> temporaryExposureKeyExportFiles) { - return temporaryExposureKeyExportFiles.stream() - .map(TemporaryExposureKeyExportFile::getBytesWithoutHeader) - .map(uncheckedFunction(TemporaryExposureKeyExport::parseFrom)) - .collect(Collectors.toSet()); - } - - private TemporaryExposureKeyExportFile reduceTemporaryExposureKeyExportsToNewFile( - Set<TemporaryExposureKeyExport> temporaryExposureKeyExports) { - return TemporaryExposureKeyExportFile.fromTemporaryExposureKeys( - getTemporaryExposureKeys(temporaryExposureKeyExports), - getRegion(temporaryExposureKeyExports), - getStartTimestamp(temporaryExposureKeyExports), - getEndTimestamp(temporaryExposureKeyExports), - distributionServiceConfig - ); - } - - private static Set<TemporaryExposureKey> getTemporaryExposureKeys( - Set<TemporaryExposureKeyExport> temporaryExposureKeyExports) { - return temporaryExposureKeyExports.stream() - .map(TemporaryExposureKeyExport::getKeysList) - .flatMap(List::stream) - .collect(Collectors.toSet()); - } - - private static String getRegion(Set<TemporaryExposureKeyExport> temporaryExposureKeyExports) { - return temporaryExposureKeyExports.stream() - .map(TemporaryExposureKeyExport::getRegion) - .findAny() - .orElseThrow(NoSuchElementException::new); - } - - private static long getStartTimestamp( - Set<TemporaryExposureKeyExport> temporaryExposureKeyExports) { - return temporaryExposureKeyExports.stream() - .mapToLong(TemporaryExposureKeyExport::getStartTimestamp) - .min() - .orElseThrow(NoSuchElementException::new); - } - - private static long getEndTimestamp(Set<TemporaryExposureKeyExport> temporaryExposureKeyExports) { - return temporaryExposureKeyExports.stream() - .mapToLong(TemporaryExposureKeyExport::getEndTimestamp) - .max() - .orElseThrow(NoSuchElementException::new); - } -} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectoryOnDisk.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectoryOnDisk.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectoryOnDisk.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectoryOnDisk.java @@ -27,6 +27,7 @@ import app.coronawarn.server.services.distribution.assembly.structure.util.functional.IndexFunction; import app.coronawarn.server.services.distribution.assembly.structure.util.functional.WritableFunction; import java.util.HashSet; +import java.util.Optional; import java.util.Set; /** @@ -74,9 +75,9 @@ public void addWritableToAll(WritableFunction<WritableOnDisk> writableFunction) } /** - * Creates a new subdirectory for every element of the {@link IndexDirectory#getIndex index} and writes all its - * {@link IndexDirectory#addWritableToAll writables} to those. The respective element of the index will be pushed - * onto the Stack for subsequent {@link Writable#prepare} calls. + * Creates a new subdirectory for every element of the {@link IndexDirectory#getIndex index} and writes all its {@link + * IndexDirectory#addWritableToAll writables} to those. The respective element of the index will be pushed onto the + * Stack for subsequent {@link Writable#prepare} calls. * * @param indices A {@link ImmutableStack} of parameters from all {@link IndexDirectory IndexDirectories} further up * in the hierarchy. The Stack may contain different types, depending on the types {@code T} of {@link @@ -104,9 +105,11 @@ private DirectoryOnDisk makeSubDirectory(T index) { private void prepareMetaWritables(ImmutableStack<Object> indices, DirectoryOnDisk target) { this.metaWritables.forEach(metaWritableFunction -> { - Writable<WritableOnDisk> newWritable = metaWritableFunction.apply(indices); - target.addWritable(newWritable); - newWritable.prepare(indices); + Optional<Writable<WritableOnDisk>> maybeNewWritable = metaWritableFunction.apply(indices); + maybeNewWritable.ifPresent(newWritable -> { + target.addWritable(newWritable); + newWritable.prepare(indices); + }); }); } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/util/functional/WritableFunction.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/util/functional/WritableFunction.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/util/functional/WritableFunction.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/util/functional/WritableFunction.java @@ -22,6 +22,7 @@ import app.coronawarn.server.services.distribution.assembly.structure.Writable; import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; +import java.util.Optional; import java.util.function.Function; /** @@ -30,7 +31,8 @@ * @param <T> The specific type of {@link Writable} that this {@link WritableFunction} can create. */ @FunctionalInterface -public interface WritableFunction<T extends Writable<T>> extends Function<ImmutableStack<Object>, Writable<T>> { +public interface WritableFunction<T extends Writable<T>> extends + Function<ImmutableStack<Object>, Optional<Writable<T>>> { - Writable<T> apply(ImmutableStack<Object> t); + Optional<Writable<T>> apply(ImmutableStack<Object> t); }

diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundlerKeyRetrievalTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundlerKeyRetrievalTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundlerKeyRetrievalTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundlerKeyRetrievalTest.java @@ -180,4 +180,12 @@ void testEmptyListWhenGettingDiagnosisKeysForHourBeforeEarliestDiagnosisKey() { bundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 1, 0, 0, 0))).isEmpty(); } + + @Test + void testGetsCorrectDistributionDate(){ + LocalDateTime expected = LocalDateTime.of(1970, 1, 5, 0, 0); + List<DiagnosisKey> diagnosisKeys = buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 2, 4, 0), 5); + bundler.setDiagnosisKeys(diagnosisKeys, expected); + assertThat(bundler.getDistributionTime()).isEqualTo(expected); + } } diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectoryTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectoryTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectoryTest.java @@ -0,0 +1,185 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory; + +import static app.coronawarn.server.services.distribution.common.Helpers.buildDiagnosisKeys; +import static app.coronawarn.server.services.distribution.common.Helpers.getExpectedDateAndHourFiles; +import static org.assertj.core.api.Assertions.assertThat; + +import app.coronawarn.server.common.persistence.domain.DiagnosisKey; +import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.DiagnosisKeyBundler; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.ProdDiagnosisKeyBundler; +import app.coronawarn.server.services.distribution.assembly.structure.WritableOnDisk; +import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; +import app.coronawarn.server.services.distribution.assembly.structure.directory.DirectoryOnDisk; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; +import app.coronawarn.server.services.distribution.common.Helpers; +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import java.io.File; +import java.io.IOException; +import java.time.LocalDateTime; +import java.util.Collection; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.stream.Collectors; +import java.util.stream.IntStream; +import org.junit.Rule; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.junit.rules.TemporaryFolder; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.boot.test.context.ConfigFileApplicationContextInitializer; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit.jupiter.SpringExtension; + +@EnableConfigurationProperties(value = DistributionServiceConfig.class) +@ExtendWith(SpringExtension.class) +@ContextConfiguration(classes = {CryptoProvider.class, DistributionServiceConfig.class}, + initializers = ConfigFileApplicationContextInitializer.class) +class DiagnosisKeysDateDirectoryTest { + + @Rule + private final TemporaryFolder outputFolder = new TemporaryFolder(); + + @Autowired + CryptoProvider cryptoProvider; + + @Autowired + DistributionServiceConfig distributionServiceConfig; + + private File outputFile; + + @BeforeEach + void setupAll() throws IOException { + outputFolder.create(); + outputFile = outputFolder.newFolder(); + } + + private void runDateDistribution(Collection<DiagnosisKey> diagnosisKeys, LocalDateTime distributionTime) { + DiagnosisKeyBundler bundler = new ProdDiagnosisKeyBundler(distributionServiceConfig); + bundler + .setDiagnosisKeys(diagnosisKeys, distributionTime); + DiagnosisKeysDateDirectory dateDirectory = new DiagnosisKeysDateDirectory(bundler, cryptoProvider, + distributionServiceConfig); + Directory<WritableOnDisk> outputDirectory = new DirectoryOnDisk(outputFile); + outputDirectory.addWritable(dateDirectory); + dateDirectory.prepare(new ImmutableStack<>() + .push("version-directory") + .push("country-directory")); + outputDirectory.write(); + } + + @Test + void testCreatesCorrectDirectoryStructureForMultipleDates() { + Collection<DiagnosisKey> diagnosisKeys = IntStream.range(0, 3) + .mapToObj(currentDate -> IntStream.range(0, 5) + .mapToObj(currentHour -> + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3 + currentDate, 0, 0).plusHours(currentHour), 5)) + .flatMap(List::stream) + .collect(Collectors.toList())) + .flatMap(List::stream) + .collect(Collectors.toList()); + runDateDistribution(diagnosisKeys, LocalDateTime.of(1970, 1, 6, 0, 0)); + Set<String> actualFiles = Helpers.getFilePaths(outputFile, outputFile.getAbsolutePath()); + Set<String> expectedDateAndHourFiles = getExpectedDateAndHourFiles(Map.of( + "1970-01-03", List.of("0", "1", "2", "3", "4"), + "1970-01-04", List.of("0", "1", "2", "3", "4"), + "1970-01-05", List.of("0", "1", "2", "3", "4")), "1970-01-06"); + assertThat(actualFiles).isEqualTo(expectedDateAndHourFiles); + } + + @Test + void testDoesNotIncludeCurrentDateInDirectoryStructure() { + Collection<DiagnosisKey> diagnosisKeys = IntStream.range(0, 3) + .mapToObj(currentDate -> IntStream.range(0, 5) + .mapToObj(currentHour -> + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3 + currentDate, 0, 0).plusHours(currentHour), 5)) + .flatMap(List::stream) + .collect(Collectors.toList())) + .flatMap(List::stream) + .collect(Collectors.toList()); + runDateDistribution(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 12, 0)); + Set<String> actualFiles = Helpers.getFilePaths(outputFile, outputFile.getAbsolutePath()); + Set<String> expectedDateAndHourFiles = getExpectedDateAndHourFiles(Map.of( + "1970-01-03", List.of("0", "1", "2", "3", "4"), + "1970-01-04", List.of("0", "1", "2", "3", "4"), + "1970-01-05", List.of("0", "1", "2", "3", "4")), "1970-01-05"); + assertThat(actualFiles).isEqualTo(expectedDateAndHourFiles); + } + + @Test + void testDoesNotIncludeEmptyDatesInDirectoryStructure() { + Collection<DiagnosisKey> diagnosisKeys = IntStream.range(0, 3) + .filter(currentDate -> currentDate != 1) + .mapToObj(currentDate -> IntStream.range(0, 5) + .mapToObj(currentHour -> + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3 + currentDate, 0, 0).plusHours(currentHour), 5)) + .flatMap(List::stream) + .collect(Collectors.toList())) + .flatMap(List::stream) + .collect(Collectors.toList()); + + runDateDistribution(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 12, 0)); + Set<String> actualFiles = Helpers.getFilePaths(outputFile, outputFile.getAbsolutePath()); + Set<String> expectedDateAndHourFiles = getExpectedDateAndHourFiles(Map.of( + "1970-01-03", List.of("0", "1", "2", "3", "4"), + "1970-01-05", List.of("0", "1", "2", "3", "4")), "1970-01-05"); + assertThat(actualFiles).isEqualTo(expectedDateAndHourFiles); + } + + @Test + void testDoesNotIncludeDatesWithTooFewKeysInDirectoryStructure() { + Collection<DiagnosisKey> diagnosisKeys = List.of( + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 1, 0), 5), + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 4, 1, 0), 4), + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 5, 1, 0), 5)) + .stream() + .flatMap(List::stream) + .collect(Collectors.toList()); + runDateDistribution(diagnosisKeys, LocalDateTime.of(1970, 1, 6, 12, 0)); + Set<String> actualFiles = Helpers.getFilePaths(outputFile, outputFile.getAbsolutePath()); + Set<String> expectedDateAndHourFiles = getExpectedDateAndHourFiles(Map.of( + "1970-01-03", List.of("1"), + "1970-01-05", List.of("1")), "1970-01-06"); + assertThat(actualFiles).isEqualTo(expectedDateAndHourFiles); + } + + @Test + void testDoesNotIncludeDatesInTheFuture() { + Collection<DiagnosisKey> diagnosisKeys = List.of( + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 1, 0), 5), + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 4, 1, 0), 5), + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 5, 1, 0), 5)) + .stream() + .flatMap(List::stream) + .collect(Collectors.toList()); + runDateDistribution(diagnosisKeys, LocalDateTime.of(1970, 1, 4, 12, 0)); + Set<String> actualFiles = Helpers.getFilePaths(outputFile, outputFile.getAbsolutePath()); + Set<String> expectedDateAndHourFiles = getExpectedDateAndHourFiles(Map.of( + "1970-01-03", List.of("1"), + "1970-01-04", List.of("1")), "1970-01-04"); + assertThat(actualFiles).isEqualTo(expectedDateAndHourFiles); + } +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectoryTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectoryTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectoryTest.java @@ -0,0 +1,156 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory; + +import static app.coronawarn.server.services.distribution.common.Helpers.buildDiagnosisKeys; +import static app.coronawarn.server.services.distribution.common.Helpers.getExpectedHourFiles; +import static app.coronawarn.server.services.distribution.common.Helpers.getFilePaths; +import static org.assertj.core.api.Assertions.assertThat; + +import app.coronawarn.server.common.persistence.domain.DiagnosisKey; +import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.DiagnosisKeyBundler; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.ProdDiagnosisKeyBundler; +import app.coronawarn.server.services.distribution.assembly.structure.WritableOnDisk; +import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; +import app.coronawarn.server.services.distribution.assembly.structure.directory.DirectoryOnDisk; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import java.io.File; +import java.io.IOException; +import java.time.LocalDate; +import java.time.LocalDateTime; +import java.util.Collection; +import java.util.List; +import java.util.Set; +import java.util.stream.Collectors; +import java.util.stream.IntStream; +import org.junit.Rule; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.junit.rules.TemporaryFolder; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.boot.test.context.ConfigFileApplicationContextInitializer; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit.jupiter.SpringExtension; + +@EnableConfigurationProperties(value = DistributionServiceConfig.class) +@ExtendWith(SpringExtension.class) +@ContextConfiguration(classes = {CryptoProvider.class, DistributionServiceConfig.class}, + initializers = ConfigFileApplicationContextInitializer.class) +class DiagnosisKeysHourDirectoryTest { + + @Rule + private final TemporaryFolder outputFolder = new TemporaryFolder(); + + @Autowired + CryptoProvider cryptoProvider; + + @Autowired + DistributionServiceConfig distributionServiceConfig; + + private File outputFile; + + @BeforeEach + void setupAll() throws IOException { + outputFolder.create(); + outputFile = outputFolder.newFolder(); + } + + private void runHourDistribution(Collection<DiagnosisKey> diagnosisKeys, LocalDateTime distributionTime) { + DiagnosisKeyBundler bundler = new ProdDiagnosisKeyBundler(distributionServiceConfig); + bundler.setDiagnosisKeys(diagnosisKeys, distributionTime); + DiagnosisKeysHourDirectory hourDirectory = new DiagnosisKeysHourDirectory(bundler, cryptoProvider, + distributionServiceConfig); + Directory<WritableOnDisk> outputDirectory = new DirectoryOnDisk(outputFile); + outputDirectory.addWritable(hourDirectory); + hourDirectory.prepare(new ImmutableStack<>() + .push("version-directory") + .push("country-directory") + .push(LocalDate.of(1970, 1, 3)) // date-directory + ); + outputDirectory.write(); + } + + @Test + void testCreatesCorrectStructureForMultipleHours() { + Collection<DiagnosisKey> diagnosisKeys = IntStream.range(0, 5) + .mapToObj(currentHour -> buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 0, 0).plusHours(currentHour), 5)) + .flatMap(List::stream) + .collect(Collectors.toList()); + runHourDistribution(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); + Set<String> actualFiles = getFilePaths(outputFile, outputFile.getAbsolutePath()); + assertThat(actualFiles).isEqualTo(getExpectedHourFiles(Set.of("0", "1", "2", "3", "4"))); + } + + @Test + void testDoesNotIncludeEmptyHours() { + Collection<DiagnosisKey> diagnosisKeys = IntStream.range(0, 5) + .filter(currentHour -> currentHour != 3) + .mapToObj(currentHour -> buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 0, 0).plusHours(currentHour), 5)) + .flatMap(List::stream) + .collect(Collectors.toList()); + runHourDistribution(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); + Set<String> actualFiles = getFilePaths(outputFile, outputFile.getAbsolutePath()); + assertThat(actualFiles).isEqualTo(getExpectedHourFiles(Set.of("0", "1", "2", "4"))); + } + + @Test + void testDoesNotIncludeCurrentHour() { + Collection<DiagnosisKey> diagnosisKeys = IntStream.range(0, 5) + .mapToObj(currentHour -> buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 0, 0).plusHours(currentHour), 5)) + .flatMap(List::stream) + .collect(Collectors.toList()); + runHourDistribution(diagnosisKeys, LocalDateTime.of(1970, 1, 3, 4, 0)); + Set<String> actualFiles = getFilePaths(outputFile, outputFile.getAbsolutePath()); + assertThat(actualFiles).isEqualTo(getExpectedHourFiles(Set.of("0", "1", "2", "3"))); + } + + @Test + void testDoesNotIncludeHoursWithTooFewKeys() { + Collection<DiagnosisKey> diagnosisKeys = List.of( + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 0, 0), 5), + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 1, 0), 4), + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 2, 0), 5)) + .stream() + .flatMap(List::stream) + .collect(Collectors.toList()); + runHourDistribution(diagnosisKeys, LocalDateTime.of(1970, 1, 6, 12, 0)); + Set<String> actualFiles = getFilePaths(outputFile, outputFile.getAbsolutePath()); + assertThat(actualFiles).isEqualTo(getExpectedHourFiles(Set.of("0", "2"))); + } + + @Test + void testDoesNotIncludeHoursInTheFuture() { + Collection<DiagnosisKey> diagnosisKeys = List.of( + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 0, 0), 5), + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 1, 0), 5), + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 2, 0), 5)) + .stream() + .flatMap(List::stream) + .collect(Collectors.toList()); + runHourDistribution(diagnosisKeys, LocalDateTime.of(1970, 1, 3, 1, 0)); + Set<String> actualFiles = getFilePaths(outputFile, outputFile.getAbsolutePath()); + assertThat(actualFiles).isEqualTo(getExpectedHourFiles(Set.of("0"))); + } +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectoryTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectoryTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectoryTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectoryTest.java @@ -32,6 +32,7 @@ import java.util.Arrays; import java.util.List; import java.util.Objects; +import java.util.Optional; import java.util.Set; import java.util.stream.Collectors; import java.util.stream.Stream; @@ -79,7 +80,7 @@ void checkAddFileToAll() { indexDirectory.addWritableToAll(ignoredValue -> { FileOnDisk newFile = new FileOnDisk("index", new byte[0]); expectedFileList.add(newFile); - return newFile; + return Optional.of(newFile); }); prepareAndWrite(outputDirectory); @@ -104,7 +105,7 @@ void checkAddDirectoryToAll() { indexDirectory.addWritableToAll(ignoredValue -> { DirectoryOnDisk newDirectory = new DirectoryOnDisk("something"); expectedFileList.add(newDirectory); - return newDirectory; + return Optional.of(newDirectory); }); prepareAndWrite(outputDirectory); diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/common/Helpers.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/common/Helpers.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/common/Helpers.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/common/Helpers.java @@ -21,6 +21,7 @@ package app.coronawarn.server.services.distribution.common; import static app.coronawarn.server.services.distribution.assembly.appconfig.YamlLoader.loadYamlIntoProtobufBuilder; +import static java.io.File.separator; import app.coronawarn.server.common.persistence.domain.DiagnosisKey; import app.coronawarn.server.common.protocols.internal.ApplicationConfiguration; @@ -31,7 +32,10 @@ import java.time.LocalDateTime; import java.time.ZoneOffset; import java.util.Arrays; +import java.util.Collection; +import java.util.HashSet; import java.util.List; +import java.util.Map; import java.util.Objects; import java.util.Set; import java.util.stream.Collectors; @@ -95,4 +99,34 @@ public static Set<String> getFilePaths(java.io.File root, String basePath) { public static ApplicationConfiguration loadApplicationConfiguration(String path) throws UnableToLoadFileException { return loadYamlIntoProtobufBuilder(path, ApplicationConfiguration.Builder.class).build(); } + + public static Set<String> getExpectedHourFiles(Collection<String> hours) { + return hours.stream() + .map(hour -> Set.of( + String.join(separator, "hour", hour, "index"), + String.join(separator, "hour", hour, "index.checksum"))) + .flatMap(Set::stream) + .collect(Collectors.toSet()); + } + + public static Set<String> getExpectedDateAndHourFiles(Map<String, List<String>> datesAndHours, String currentDate) { + Set<String> expectedFiles = new HashSet<>(); + + datesAndHours.forEach((date, hours) -> { + if (!date.equals(currentDate)) { + expectedFiles.add(String.join(separator, "date", date, "index")); + expectedFiles.add(String.join(separator, "date", date, "index.checksum")); + } + + expectedFiles.add(String.join(separator, "date", date, "hour", "index")); + expectedFiles.add(String.join(separator, "date", date, "hour", "index.checksum")); + + hours.forEach(hour -> { + expectedFiles.add(String.join(separator, "date", date, "hour", hour, "index")); + expectedFiles.add(String.join(separator, "date", date, "hour", hour, "index.checksum")); + }); + }); + + return expectedFiles; + } }

Simplifying DateAggregatingDecorator The DateAggregatingDecorator should make more use of the `DiagnosisKeyBundler`. Please team up with @pithumke on this.

corona-warn-app/cwa-server

corona-warn-app__cwa-server-642

fa9adc6631233172684910191efdf00429799365

diff --git a/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/risk_score_parameters.proto b/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/risk_score_parameters.proto --- a/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/risk_score_parameters.proto +++ b/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/risk_score_parameters.proto @@ -59,6 +59,6 @@ message RiskScoreParameters { RiskLevel gt_27_le_33_dbm = 5; // 27 < A <= 33 dBm RiskLevel gt_15_le_27_dbm = 6; // 15 < A <= 27 dBm RiskLevel gt_10_le_15_dbm = 7; // 10 < A <= 15 dBm - RiskLevel lt_10_dbm = 8; // A <= 10 dBm, highest risk + RiskLevel le_10_dbm = 8; // A <= 10 dBm, highest risk } -} \ No newline at end of file +} diff --git a/services/distribution/src/main/resources/master-config/exposure-config.yaml b/services/distribution/src/main/resources/master-config/exposure-config.yaml --- a/services/distribution/src/main/resources/master-config/exposure-config.yaml +++ b/services/distribution/src/main/resources/master-config/exposure-config.yaml @@ -55,4 +55,4 @@ attenuation: gt_27_le_33_dbm: 1 gt_15_le_27_dbm: 1 gt_10_le_15_dbm: 1 - lt_10_dbm: 1 + le_10_dbm: 1

diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/YamlLoaderTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/YamlLoaderTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/YamlLoaderTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/YamlLoaderTest.java @@ -40,8 +40,9 @@ void okFile() throws UnableToLoadFileException { @ValueSource(strings = { "configtests/app-config_empty.yaml", "configtests/wrong_file.yaml", - "configtests/broken_syntax.yaml", - "file_does_not_exist_anywhere.yaml" + "configtests/app-config_broken_syntax.yaml", + "configtests/naming_mismatch.yaml", + "configtests/file_does_not_exist_anywhere.yaml" }) void throwsLoadFailure(String fileName) { assertThatExceptionOfType(UnableToLoadFileException.class).isThrownBy(() -> loadApplicationConfiguration(fileName)); diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ExposureConfigurationValidatorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ExposureConfigurationValidatorTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ExposureConfigurationValidatorTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ExposureConfigurationValidatorTest.java @@ -22,8 +22,7 @@ import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ExposureConfigurationValidator.CONFIG_PREFIX; import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidatorTest.buildError; -import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ValidationError.ErrorType.TOO_MANY_DECIMAL_PLACES; -import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ValidationError.ErrorType.VALUE_OUT_OF_BOUNDS; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ValidationError.ErrorType.*; import static org.assertj.core.api.Assertions.assertThat; import app.coronawarn.server.common.protocols.internal.RiskLevel; diff --git a/services/distribution/src/test/resources/configtests/exposure-config_ok.yaml b/services/distribution/src/test/resources/configtests/exposure-config_ok.yaml --- a/services/distribution/src/test/resources/configtests/exposure-config_ok.yaml +++ b/services/distribution/src/test/resources/configtests/exposure-config_ok.yaml @@ -55,4 +55,4 @@ attenuation: gt_27_le_33_dbm: 5 gt_15_le_27_dbm: 6 gt_10_le_15_dbm: 7 - lt_10_dbm: 8 \ No newline at end of file + le_10_dbm: 8 diff --git a/services/distribution/src/test/resources/configtests/naming_mismatch.yaml b/services/distribution/src/test/resources/configtests/naming_mismatch.yaml new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/resources/configtests/naming_mismatch.yaml @@ -0,0 +1,43 @@ +transmission_weight: 10.001 +duration_weight: 0.001 +attenuation_weight: 100 + +transmission: + foo: 2 # "foo" does not exist in proto + app_defined_2: 2 + app_defined_3: 3 + app_defined_4: 4 + app_defined_5: 5 + app_defined_6: 6 + app_defined_7: 7 + app_defined_8: 8 + +duration: + eq_0_min: 1 + gt_0_le_5_min: 2 + gt_5_le_10_min: 3 + gt_10_le_15_min: 4 + gt_15_le_20_min: 5 + gt_20_le_25_min: 6 + gt_25_le_30_min: 7 + gt_30_min: 8 + +days_since_last_exposure: + ge_14_days: 1 + ge_12_lt_14_days: 2 + ge_10_lt_12_days: 3 + ge_8_lt_10_days: 4 + ge_6_lt_8_days: 5 + ge_4_lt_6_days: 6 + ge_2_lt_4_days: 7 + ge_0_lt_2_days: 8 + +attenuation: + gt_73_dbm: 1 + gt_63_le_73_dbm: 2 + gt_51_le_63_dbm: 3 + gt_33_le_51_dbm: 4 + gt_27_le_33_dbm: 5 + gt_15_le_27_dbm: 6 + gt_10_le_15_dbm: 7 + le_10_dbm: 8 diff --git a/services/distribution/src/test/resources/objectstore/publisher/examplefile b/services/distribution/src/test/resources/objectstore/publisher/examplefile --- a/services/distribution/src/test/resources/objectstore/publisher/examplefile +++ b/services/distribution/src/test/resources/objectstore/publisher/examplefile @@ -43,4 +43,4 @@ attenuation: gt_27_le_33_dbm: 5 gt_15_le_27_dbm: 6 gt_10_le_15_dbm: 7 - lt_10_dbm: 8 \ No newline at end of file + le_10_dbm: 8 diff --git a/services/distribution/src/test/resources/parameters/all_ok.yaml b/services/distribution/src/test/resources/parameters/all_ok.yaml --- a/services/distribution/src/test/resources/parameters/all_ok.yaml +++ b/services/distribution/src/test/resources/parameters/all_ok.yaml @@ -43,4 +43,4 @@ attenuation: gt_27_le_33_dbm: 5 gt_15_le_27_dbm: 6 gt_10_le_15_dbm: 7 - lt_10_dbm: 8 \ No newline at end of file + le_10_dbm: 8 diff --git a/services/distribution/src/test/resources/parameters/broken_syntax.yaml b/services/distribution/src/test/resources/parameters/broken_syntax.yaml --- a/services/distribution/src/test/resources/parameters/broken_syntax.yaml +++ b/services/distribution/src/test/resources/parameters/broken_syntax.yaml @@ -40,4 +40,4 @@ attenuation: gt_27_le_33_dbm: 5 gt_15_le_27_dbm: 6 gt_10_le_15_dbm: 7 - lt_10_dbm: 8 \ No newline at end of file + le_10_dbm: 8 diff --git a/services/distribution/src/test/resources/parameters/partly_filled.yaml b/services/distribution/src/test/resources/parameters/partly_filled.yaml --- a/services/distribution/src/test/resources/parameters/partly_filled.yaml +++ b/services/distribution/src/test/resources/parameters/partly_filled.yaml @@ -43,4 +43,4 @@ attenuation: gt_27_le_33_dbm: 5 gt_15_le_27_dbm: 6 gt_10_le_15_dbm: 7 - lt_10_dbm: 8 \ No newline at end of file + le_10_dbm: 8 diff --git a/services/distribution/src/test/resources/parameters/score_too_high.yaml b/services/distribution/src/test/resources/parameters/score_too_high.yaml --- a/services/distribution/src/test/resources/parameters/score_too_high.yaml +++ b/services/distribution/src/test/resources/parameters/score_too_high.yaml @@ -40,4 +40,4 @@ attenuation: gt_27_le_33_dbm: 5 gt_15_le_27_dbm: 6 gt_10_le_15_dbm: 7 - lt_10_dbm: 8 \ No newline at end of file + le_10_dbm: 8 diff --git a/services/distribution/src/test/resources/parameters/weight_negative.yaml b/services/distribution/src/test/resources/parameters/weight_negative.yaml --- a/services/distribution/src/test/resources/parameters/weight_negative.yaml +++ b/services/distribution/src/test/resources/parameters/weight_negative.yaml @@ -41,4 +41,4 @@ attenuation: gt_27_le_33_dbm: 5 gt_15_le_27_dbm: 6 gt_10_le_15_dbm: 7 - lt_10_dbm: 8 \ No newline at end of file + le_10_dbm: 8 diff --git a/services/distribution/src/test/resources/parameters/weight_ok.yaml b/services/distribution/src/test/resources/parameters/weight_ok.yaml --- a/services/distribution/src/test/resources/parameters/weight_ok.yaml +++ b/services/distribution/src/test/resources/parameters/weight_ok.yaml @@ -40,4 +40,4 @@ attenuation: gt_27_le_33_dbm: 5 gt_15_le_27_dbm: 6 gt_10_le_15_dbm: 7 - lt_10_dbm: 8 \ No newline at end of file + le_10_dbm: 8 diff --git a/services/distribution/src/test/resources/parameters/weight_too_high.yaml b/services/distribution/src/test/resources/parameters/weight_too_high.yaml --- a/services/distribution/src/test/resources/parameters/weight_too_high.yaml +++ b/services/distribution/src/test/resources/parameters/weight_too_high.yaml @@ -40,4 +40,4 @@ attenuation: gt_27_le_33_dbm: 5 gt_15_le_27_dbm: 6 gt_10_le_15_dbm: 7 - lt_10_dbm: 8 \ No newline at end of file + le_10_dbm: 8

[MINOR] Incorrect value range in attenuation risk parameter ## Describe the bug The `AttenuationRiskParameters` proto message (see [here](https://github.com/corona-warn-app/cwa-server/blob/master/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/risk_score_parameters.proto)) is defined as follows: ```proto3 message AttenuationRiskParameters { RiskLevel gt_73_dbm = 1; // A > 73 dBm, lowest risk RiskLevel gt_63_le_73_dbm = 2; // 63 < A <= 73 dBm RiskLevel gt_51_le_63_dbm = 3; // 51 < A <= 63 dBm RiskLevel gt_33_le_51_dbm = 4; // 33 < A <= 51 dBm RiskLevel gt_27_le_33_dbm = 5; // 27 < A <= 33 dBm RiskLevel gt_15_le_27_dbm = 6; // 15 < A <= 27 dBm RiskLevel gt_10_le_15_dbm = 7; // 10 < A <= 15 dBm RiskLevel lt_10_dbm = 8; // A <= 10 dBm, highest risk } ``` There is no value range that includes an attenuation of **exactly** 10dBm. ## Expected behaviour According to the [Google/Apple spec](https://developer.apple.com/documentation/exposurenotification/enexposureconfiguration), the last value range should be "less than or equal to 10dBm" (`le_10_dbm`):  ## Possible Fix - Correct the last attenuation value range according to spec - Update dependent code/configuration respectively ([here](https://github.com/corona-warn-app/cwa-server/blob/b8afdce9a3bc8fd927fe4ec9be2e910ee8f1635d/services/distribution/src/test/resources/objectstore/publisher/examplefile), [here](https://github.com/corona-warn-app/cwa-server/tree/b8afdce9a3bc8fd927fe4ec9be2e910ee8f1635d/services/distribution/src/test/resources/parameters), [here](https://github.com/corona-warn-app/cwa-server/tree/d6c0ad58f6473bd55af9a0cbe2c0cc8db3914af6/services/distribution/src/main/resources/master-config) and possibly more). ## Additional context - This "bug" doesn't have any technical implications and should only be fixed for consistency - Downwards-compatibility of the proto messages should not be infringed by the proposed change

corona-warn-app/cwa-server

corona-warn-app__cwa-server-652

ac86a35d9c4a40d55315ce50052ea0e4a64f036e

diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ValidationError.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ValidationError.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ValidationError.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ValidationError.java @@ -79,7 +79,6 @@ public enum ErrorType { VALUE_OUT_OF_BOUNDS, INVALID_URL, INVALID_PARTITIONING, - TOO_MANY_DECIMAL_PLACES, - MISSING_ENTRY + TOO_MANY_DECIMAL_PLACES } }

diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ExposureConfigurationValidatorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ExposureConfigurationValidatorTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ExposureConfigurationValidatorTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ExposureConfigurationValidatorTest.java @@ -22,7 +22,6 @@ import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ExposureConfigurationValidator.CONFIG_PREFIX; import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidatorTest.buildError; -import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ValidationError.ErrorType.MISSING_ENTRY; import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ValidationError.ErrorType.TOO_MANY_DECIMAL_PLACES; import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ValidationError.ErrorType.VALUE_OUT_OF_BOUNDS; import static org.assertj.core.api.Assertions.assertThat; @@ -69,8 +68,6 @@ private static Stream<Arguments> createOkTests() { private static Stream<Arguments> createFailedTests() { return Stream.of( ScoreTooHigh(), - // TODO cwa-server/#320 Validate that no attributes are missing in .yaml - // ScoreNegative(), WeightNegative(), WeightTooHigh() ).map(Arguments::of); @@ -103,12 +100,6 @@ public static TestWithExpectedResult WeightTooHigh() { .with(buildError(CONFIG_PREFIX + "transmission", 101d, VALUE_OUT_OF_BOUNDS)); } - public static TestWithExpectedResult ScoreNegative() { - return new TestWithExpectedResult("score_negative.yaml") - .with(buildError(CONFIG_PREFIX + "transmission.appDefined1", RiskLevel.UNRECOGNIZED, VALUE_OUT_OF_BOUNDS)) - .with(buildError(CONFIG_PREFIX + "transmission.appDefined3", null, MISSING_ENTRY)); - } - public static TestWithExpectedResult ScoreTooHigh() { return new TestWithExpectedResult("score_too_high.yaml") .with(buildError(CONFIG_PREFIX + "transmission.appDefined1", RiskLevel.UNRECOGNIZED, VALUE_OUT_OF_BOUNDS)) diff --git a/services/distribution/src/test/resources/parameters/score_negative.yaml b/services/distribution/src/test/resources/parameters/score_negative.yaml deleted file mode 100644 --- a/services/distribution/src/test/resources/parameters/score_negative.yaml +++ /dev/null @@ -1,44 +0,0 @@ -transmission_weight: 100 -duration_weight: 50 -attenuation_weight: 80 - - -transmission: - app_defined_1: -2 # not ok, negative - app_defined_2: 0 - #app_defined_3: 3 # not ok (missing -> unspecified) - app_defined_4: 5 - app_defined_5: 5 - app_defined_6: 6 - app_defined_7: 7 - app_defined_8: 8 - -duration: - eq_0_min: 1 - gt_0_le_5_min: 2 - gt_5_le_10_min: 3 - gt_10_le_15_min: 4 - gt_15_le_20_min: 5 - gt_20_le_25_min: 6 - gt_25_le_30_min: 7 - gt_30_min: 8 - -days_since_last_exposure: - ge_14_days: 1 - ge_12_lt_14_days: 2 - ge_10_lt_12_days: 3 - ge_8_lt_10_days: 4 - ge_6_lt_8_days: 5 - ge_4_lt_6_days: 6 - ge_2_lt_4_days: 7 - ge_0_lt_2_days: 8 - -attenuation: - gt_73_dbm: 1 - gt_63_le_73_dbm: 2 - gt_51_le_63_dbm: 3 - gt_33_le_51_dbm: 4 - gt_27_le_33_dbm: 5 - gt_15_le_27_dbm: 6 - gt_10_le_15_dbm: 7 - lt_10_dbm: 8

Validate that no attributes are missing in .yaml validate that no attributes are missing in .yaml when accordingly re-enable the ``ScoreNegative`` test case in: https://github.com/corona-warn-app/cwa-server/blob/master/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ExposureConfigurationValidatorTest.java Note: the validation probably should be done on the loading the values from yaml into a proto object, since validating directly on the resulting proto object is too late as the default value for an unloaded attribute in proto is 0 which we consider as a valid value (or risk score in the allowed range of 0-8) See PR which disabled the test: https://github.com/corona-warn-app/cwa-server/pull/299

corona-warn-app/cwa-server

corona-warn-app__cwa-server-659

ee78bf15ece7f282836149b5f39422892f055096

diff --git a/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/submission_payload.proto b/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/submission_payload.proto --- a/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/submission_payload.proto +++ b/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/submission_payload.proto @@ -6,4 +6,5 @@ import "app/coronawarn/server/common/protocols/external/exposurenotification/tem message SubmissionPayload { repeated app.coronawarn.server.common.protocols.external.exposurenotification.TemporaryExposureKey keys = 1; -} \ No newline at end of file + bytes padding = 2; +} diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/ServerApplication.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/ServerApplication.java --- a/services/submission/src/main/java/app/coronawarn/server/services/submission/ServerApplication.java +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/ServerApplication.java @@ -20,6 +20,7 @@ package app.coronawarn.server.services.submission; +import app.coronawarn.server.services.submission.config.SubmissionServiceConfigValidator; import io.micrometer.core.aop.TimedAspect; import io.micrometer.core.instrument.MeterRegistry; import java.util.Arrays; @@ -40,6 +41,7 @@ import org.springframework.core.env.Environment; import org.springframework.data.jdbc.repository.config.EnableJdbcRepositories; import org.springframework.http.converter.protobuf.ProtobufHttpMessageConverter; +import org.springframework.validation.Validator; @SpringBootApplication(exclude = {UserDetailsServiceAutoConfiguration.class}) @EnableJdbcRepositories(basePackages = "app.coronawarn.server.common.persistence") @@ -74,6 +76,11 @@ ProtobufHttpMessageConverter protobufHttpMessageConverter() { return new ProtobufHttpMessageConverter(); } + @Bean + public static Validator configurationPropertiesValidator() { + return new SubmissionServiceConfigValidator(); + } + @Override public void setEnvironment(Environment environment) { List<String> profiles = Arrays.asList(environment.getActiveProfiles()); diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/config/SubmissionPayloadSizeFilter.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/config/SubmissionPayloadSizeFilter.java new file mode 100644 --- /dev/null +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/config/SubmissionPayloadSizeFilter.java @@ -0,0 +1,58 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.submission.config; + +import java.io.IOException; +import javax.servlet.FilterChain; +import javax.servlet.ServletException; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; +import org.springframework.http.HttpStatus; +import org.springframework.stereotype.Component; +import org.springframework.web.filter.OncePerRequestFilter; + +/** + * {@link SubmissionPayloadSizeFilter} instances filter requests exceeding a certain size limit. + */ +@Component +public class SubmissionPayloadSizeFilter extends OncePerRequestFilter { + + private final long maximumRequestSize; + + public SubmissionPayloadSizeFilter(SubmissionServiceConfig config) { + this.maximumRequestSize = config.getMaximumRequestSize().toBytes(); + } + + /** + * Filters each request that exceeds the maximum size. + */ + @Override + protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) + throws ServletException, IOException { + if (request.getContentLengthLong() > maximumRequestSize) { + response.setStatus(HttpStatus.BAD_REQUEST.value()); + response.getWriter().write("Request size exceeded limit of " + maximumRequestSize + " bytes"); + } else { + filterChain.doFilter(request, response); + } + } + +} diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/config/SubmissionServiceConfig.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/config/SubmissionServiceConfig.java --- a/services/submission/src/main/java/app/coronawarn/server/services/submission/config/SubmissionServiceConfig.java +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/config/SubmissionServiceConfig.java @@ -26,6 +26,7 @@ import javax.validation.constraints.Pattern; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.stereotype.Component; +import org.springframework.util.unit.DataSize; import org.springframework.validation.annotation.Validated; @Component @@ -53,6 +54,7 @@ public class SubmissionServiceConfig { @Min(1) @Max(10000) private Integer connectionPoolSize; + private DataSize maximumRequestSize; private Payload payload; private Verification verification; private Monitoring monitoring; @@ -98,6 +100,14 @@ public void setConnectionPoolSize(Integer connectionPoolSize) { this.connectionPoolSize = connectionPoolSize; } + public DataSize getMaximumRequestSize() { + return maximumRequestSize; + } + + public void setMaximumRequestSize(DataSize maximumRequestSize) { + this.maximumRequestSize = maximumRequestSize; + } + public Integer getMaxNumberOfKeys() { return payload.getMaxNumberOfKeys(); } diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/config/SubmissionServiceConfigValidator.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/config/SubmissionServiceConfigValidator.java new file mode 100644 --- /dev/null +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/config/SubmissionServiceConfigValidator.java @@ -0,0 +1,54 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.submission.config; + +import org.springframework.util.unit.DataSize; +import org.springframework.validation.Errors; +import org.springframework.validation.Validator; + +/** + * {@link SubmissionPayloadSizeFilter} instances validate the values of the SubmissionServiceConfig. + */ +public class SubmissionServiceConfigValidator implements Validator { + + public static final DataSize MIN_MAXIMUM_REQUEST_SIZE = DataSize.ofBytes(280); + public static final DataSize MAX_MAXIMUM_REQUEST_SIZE = DataSize.ofKilobytes(200); + + @Override + public boolean supports(Class<?> type) { + return type == SubmissionServiceConfig.class; + } + + /** + * Validate if the MaximumRequestSize of the {@link SubmissionServiceConfig} is in the defined range. + */ + @Override + public void validate(Object o, Errors errors) { + SubmissionServiceConfig properties = (SubmissionServiceConfig) o; + + if (properties.getMaximumRequestSize().compareTo(MIN_MAXIMUM_REQUEST_SIZE) < 0 + || properties.getMaximumRequestSize().compareTo(MAX_MAXIMUM_REQUEST_SIZE) > 0) { + errors.rejectValue("maximumRequestSize", + "Must be at least " + MIN_MAXIMUM_REQUEST_SIZE + " and not more than " + MAX_MAXIMUM_REQUEST_SIZE + "."); + } + } + +} diff --git a/services/submission/src/main/resources/application.yaml b/services/submission/src/main/resources/application.yaml --- a/services/submission/src/main/resources/application.yaml +++ b/services/submission/src/main/resources/application.yaml @@ -23,6 +23,8 @@ services: random-key-padding-multiplier: ${RANDOM_KEY_PADDING_MULTIPLIER:1} # The ApacheHttpClient's connection pool size. connection-pool-size: 200 + # The maximum request size accepted by the SubmissionController (e.g. 200B or 100KB). + maximum-request-size: ${MAXIMUM_REQUEST_SIZE:100KB} payload: # The maximum number of keys accepted for any submission. max-number-of-keys: 14

diff --git a/services/submission/src/test/java/app/coronawarn/server/services/submission/config/SubmissionServiceConfigValidatorTest.java b/services/submission/src/test/java/app/coronawarn/server/services/submission/config/SubmissionServiceConfigValidatorTest.java new file mode 100644 --- /dev/null +++ b/services/submission/src/test/java/app/coronawarn/server/services/submission/config/SubmissionServiceConfigValidatorTest.java @@ -0,0 +1,86 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.submission.config; + + +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.Arguments; +import org.junit.jupiter.params.provider.MethodSource; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.test.context.ActiveProfiles; +import org.springframework.util.unit.DataSize; +import org.springframework.validation.BeanPropertyBindingResult; +import org.springframework.validation.Errors; +import java.util.stream.Stream; + +import static org.assertj.core.api.Assertions.assertThat; + +@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) +@ActiveProfiles({"disable-ssl-client-verification", "disable-ssl-client-verification-verify-hostname"}) +class SubmissionServiceConfigValidatorTest { + + @Autowired + private SubmissionServiceConfigValidator submissionServiceConfigValidator; + + private SubmissionServiceConfig submissionServiceConfig; + + @BeforeEach + void setup() { + submissionServiceConfig = new SubmissionServiceConfig(); + } + + @ParameterizedTest + @MethodSource("validRequestDataSizes") + void ok(DataSize dataSize) { + Errors errors = validateConfig(dataSize); + assertThat(errors.hasErrors()).isFalse(); + } + + @ParameterizedTest + @MethodSource("invalidRequestDataSizes") + void fail(DataSize dataSize) { + Errors errors = validateConfig(dataSize); + assertThat(errors.hasErrors()).isTrue(); + } + + private Errors validateConfig(DataSize dataSize) { + Errors errors = new BeanPropertyBindingResult(submissionServiceConfig, "submissionServiceConfig"); + submissionServiceConfig.setMaximumRequestSize(dataSize); + submissionServiceConfigValidator.validate(submissionServiceConfig, errors); + return errors; + } + + private static Stream<Arguments> validRequestDataSizes() { + return Stream.of( + SubmissionServiceConfigValidator.MAX_MAXIMUM_REQUEST_SIZE, + SubmissionServiceConfigValidator.MIN_MAXIMUM_REQUEST_SIZE + ).map(Arguments::of); + } + + private static Stream<Arguments> invalidRequestDataSizes() { + return Stream.of( + DataSize.ofBytes(SubmissionServiceConfigValidator.MAX_MAXIMUM_REQUEST_SIZE.toBytes() + 1), + DataSize.ofBytes(SubmissionServiceConfigValidator.MIN_MAXIMUM_REQUEST_SIZE.toBytes() - 1) + ).map(Arguments::of); + } +} diff --git a/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/RequestExecutor.java b/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/RequestExecutor.java --- a/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/RequestExecutor.java +++ b/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/RequestExecutor.java @@ -62,6 +62,10 @@ public ResponseEntity<Void> execute(HttpMethod method, RequestEntity<SubmissionP public ResponseEntity<Void> executePost(Collection<TemporaryExposureKey> keys, HttpHeaders headers) { SubmissionPayload body = SubmissionPayload.newBuilder().addAllKeys(keys).build(); + return executePost(body, headers); + } + + public ResponseEntity<Void> executePost(SubmissionPayload body, HttpHeaders headers) { return execute(HttpMethod.POST, new RequestEntity<>(body, headers, HttpMethod.POST, SUBMISSION_URL)); } diff --git a/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/SubmissionControllerTest.java b/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/SubmissionControllerTest.java --- a/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/SubmissionControllerTest.java +++ b/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/SubmissionControllerTest.java @@ -45,9 +45,12 @@ import static org.springframework.http.HttpStatus.METHOD_NOT_ALLOWED; import static org.springframework.http.HttpStatus.OK; + import app.coronawarn.server.common.persistence.domain.DiagnosisKey; import app.coronawarn.server.common.persistence.service.DiagnosisKeyService; import app.coronawarn.server.common.protocols.external.exposurenotification.TemporaryExposureKey; +import app.coronawarn.server.common.protocols.internal.SubmissionPayload; +import app.coronawarn.server.services.submission.config.SubmissionPayloadSizeFilter; import app.coronawarn.server.services.submission.config.SubmissionServiceConfig; import app.coronawarn.server.services.submission.monitoring.SubmissionMonitor; import app.coronawarn.server.services.submission.verification.TanVerifier; @@ -104,7 +107,13 @@ public void setUpMocks() { @Test void checkResponseStatusForValidParameters() { - ResponseEntity<Void> actResponse = executor.executePost(buildPayloadWithMultipleKeys(), buildOkHeaders()); + ResponseEntity<Void> actResponse = executor.executePost(buildPayload(buildMultipleKeys()), buildOkHeaders()); + assertThat(actResponse.getStatusCode()).isEqualTo(OK); + } + + @Test + void checkResponseStatusForValidParametersWithPadding() { + ResponseEntity<Void> actResponse = executor.executePost(buildPayloadWithPadding(), buildOkHeaders()); assertThat(actResponse.getStatusCode()).isEqualTo(OK); } @@ -116,10 +125,9 @@ void check400ResponseStatusForInvalidParameters() { @Test void singleKeyWithOutdatedRollingStartIntervalNumberDoesNotGetSaved() { - Collection<TemporaryExposureKey> keys = buildPayloadWithSingleOutdatedKey(); ArgumentCaptor<Collection<DiagnosisKey>> argument = ArgumentCaptor.forClass(Collection.class); - executor.executePost(keys, buildOkHeaders()); + executor.executePost(buildPayload(createOutdatedKey()), buildOkHeaders()); verify(diagnosisKeyService, atLeastOnce()).saveDiagnosisKeys(argument.capture()); assertThat(argument.getValue()).isEmpty(); @@ -127,12 +135,12 @@ void singleKeyWithOutdatedRollingStartIntervalNumberDoesNotGetSaved() { @Test void keysWithOutdatedRollingStartIntervalNumberDoNotGetSaved() { - Collection<TemporaryExposureKey> submittedKeys = buildPayloadWithMultipleKeys(); + Collection<TemporaryExposureKey> submittedKeys = buildMultipleKeys(); TemporaryExposureKey outdatedKey = createOutdatedKey(); submittedKeys.add(outdatedKey); ArgumentCaptor<Collection<DiagnosisKey>> argument = ArgumentCaptor.forClass(Collection.class); - executor.executePost(submittedKeys, buildOkHeaders()); + executor.executePost(buildPayload(submittedKeys), buildOkHeaders()); verify(diagnosisKeyService, atLeastOnce()).saveDiagnosisKeys(argument.capture()); submittedKeys.remove(outdatedKey); @@ -141,10 +149,10 @@ void keysWithOutdatedRollingStartIntervalNumberDoNotGetSaved() { @Test void checkSaveOperationCallAndFakeDelayUpdateForValidParameters() { - Collection<TemporaryExposureKey> submittedKeys = buildPayloadWithMultipleKeys(); + Collection<TemporaryExposureKey> submittedKeys = buildMultipleKeys(); ArgumentCaptor<Collection<DiagnosisKey>> argument = ArgumentCaptor.forClass(Collection.class); - executor.executePost(submittedKeys, buildOkHeaders()); + executor.executePost(buildPayload(submittedKeys), buildOkHeaders()); verify(diagnosisKeyService, atLeastOnce()).saveDiagnosisKeys(argument.capture()); verify(fakeDelayManager, times(1)).updateFakeRequestDelay(anyLong()); @@ -200,6 +208,12 @@ void invalidTanHandling() { assertThat(actResponse.getStatusCode()).isEqualTo(FORBIDDEN); } + @Test + void invalidSubmissionPayload() { + ResponseEntity<Void> actResponse = executor.executePost(buildPayloadWithTooLargePadding(), buildOkHeaders()); + assertThat(actResponse.getStatusCode()).isEqualTo(BAD_REQUEST); + } + @Test void checkRealRequestHandlingIsMonitored() { executor.executePost(buildPayloadWithOneKey(), buildOkHeaders()); @@ -222,7 +236,35 @@ void checkInvalidTanHandlingIsMonitored() { verify(submissionMonitor, times(1)).incrementInvalidTanRequestCounter(); } - private Collection<TemporaryExposureKey> buildPayloadWithMultipleKeys() { + private SubmissionPayload buildPayload(TemporaryExposureKey key) { + Collection<TemporaryExposureKey> keys = Stream.of(key).collect(Collectors.toCollection(ArrayList::new)); + return buildPayload(keys); + } + + private SubmissionPayload buildPayload(Collection<TemporaryExposureKey> keys) { + return SubmissionPayload.newBuilder() + .addAllKeys(keys) + .build(); + } + + private SubmissionPayload buildPayloadWithPadding() { + return SubmissionPayload.newBuilder() + .addAllKeys(buildMultipleKeys()) + .setPadding(ByteString.copyFrom("PaddingString".getBytes())) + .build(); + } + + private SubmissionPayload buildPayloadWithTooLargePadding() { + int exceedingSize = (int) (2 * config.getMaximumRequestSize().toBytes()); + byte[] bytes = new byte[exceedingSize]; + + return SubmissionPayload.newBuilder() + .addAllKeys(buildMultipleKeys()) + .setPadding(ByteString.copyFrom(bytes)) + .build(); + } + + private Collection<TemporaryExposureKey> buildMultipleKeys() { int rollingStartIntervalNumber1 = createRollingStartIntervalNumber(config.getRetentionDays() - 1); int rollingStartIntervalNumber2 = rollingStartIntervalNumber1 + DiagnosisKey.EXPECTED_ROLLING_PERIOD; int rollingStartIntervalNumber3 = rollingStartIntervalNumber2 + DiagnosisKey.EXPECTED_ROLLING_PERIOD; @@ -233,11 +275,6 @@ private Collection<TemporaryExposureKey> buildPayloadWithMultipleKeys() { .collect(Collectors.toCollection(ArrayList::new)); } - private Collection<TemporaryExposureKey> buildPayloadWithSingleOutdatedKey() { - TemporaryExposureKey outdatedKey = createOutdatedKey(); - return Stream.of(outdatedKey).collect(Collectors.toCollection(ArrayList::new)); - } - private TemporaryExposureKey createOutdatedKey() { return TemporaryExposureKey.newBuilder() .setKeyData(ByteString.copyFromUtf8(VALID_KEY_DATA_2)) @@ -246,14 +283,13 @@ private TemporaryExposureKey createOutdatedKey() { .setTransmissionRiskLevel(5).build(); } - private static Collection<TemporaryExposureKey> buildPayloadWithInvalidKey() { - return Stream.of( - buildTemporaryExposureKey(VALID_KEY_DATA_1, createRollingStartIntervalNumber(2), 999)) - .collect(Collectors.toCollection(ArrayList::new)); + private SubmissionPayload buildPayloadWithInvalidKey() { + TemporaryExposureKey invalidKey = buildTemporaryExposureKey(VALID_KEY_DATA_1, createRollingStartIntervalNumber(2), 999); + return buildPayload(invalidKey); } private void assertElementsCorrespondToEachOther(Collection<TemporaryExposureKey> submittedTemporaryExposureKeys, - Collection<DiagnosisKey> savedDiagnosisKeys) { + Collection<DiagnosisKey> savedDiagnosisKeys) { Set<DiagnosisKey> submittedDiagnosisKeys = submittedTemporaryExposureKeys.stream() .map(submittedDiagnosisKey -> DiagnosisKey.builder().fromProtoBuf(submittedDiagnosisKey).build()) diff --git a/services/submission/src/test/resources/application.yaml b/services/submission/src/test/resources/application.yaml --- a/services/submission/src/test/resources/application.yaml +++ b/services/submission/src/test/resources/application.yaml @@ -23,6 +23,7 @@ services: retention-days: 14 random-key-padding-multiplier: 10 connection-pool-size: 200 + maximum-request-size: 100KB payload: max-number-of-keys: 14 verification:

Plausible Deniability: Add "Padding" property to submission payload Currently, mobile apps are collecting keys based on their install date. When a user uploads his keys (after being tested positive), the payload will contain 1-13 keys. Although the traffic between mobile & server is secured, an attacker may still sniff the packages in the network and predict, based on the request size, how many keys are probably part of the submission request. This may then lead to additional information for the attacker in an attempt to deanonymize a user. In order to mitigate this attack, add a new field to the submission payload, called `padding` of type string. The field shall be optional and must not break compatibility to the current/older mobile implementations (which should be given due to the use of protobuf). The server shall not process this field.

corona-warn-app/cwa-server

corona-warn-app__cwa-server-661

659008e984907e315e01f18095d02f70e1648fbb

diff --git a/.circleci/config.yml b/.circleci/config.yml --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -2,10 +2,17 @@ version: 2.1 jobs: build: working_directory: ~/cwa-server - docker: - - image: circleci/openjdk:11-jdk + machine: + image: ubuntu-1604:202004-01 + docker_layer_caching: true steps: - checkout + - run: + name: Update to OpenJDK 11 + command: | + sudo apt-get install openjdk-11-jre + sudo update-alternatives --set java /usr/lib/jvm/java-11-openjdk-amd64/bin/java + java -version - run: name: Generate cumulative pom.xml checksum command: | @@ -14,15 +21,22 @@ jobs: when: always - restore_cache: key: cwa-server-{{ checksum "~/pom-checksum" }} - - run: mvn --batch-mode dependency:go-offline + - run: ./mvnw --batch-mode dependency:go-offline - run: name: Analyze on SonarCloud - command: mvn --batch-mode verify sonar:sonar --fail-never + command: | + export JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64 + ./mvnw --batch-mode verify sonar:sonar --fail-never - save_cache: paths: - ~/.m2 key: cwa-server-{{ checksum "~/pom-checksum" }} - - run: mvn --batch-mode package + - run: + name: Run all tests on Docker + command: | + docker-compose -f docker-compose-it.yaml up -d objectstore + docker-compose -f docker-compose-it.yaml up -d create-bucket + docker-compose -f docker-compose-it.yaml run run-tests - run: name: Save test results command: | diff --git a/.env b/.env --- a/.env +++ b/.env @@ -6,6 +6,15 @@ POSTGRES_DB=cwa POSTGRES_USER=postgres POSTGRES_PASSWORD=postgres +POSTGRES_DISTRIBUTION_USER=local_setup_distribution +POSTGRES_DISTRIBUTION_PASSWORD=local_setup_distribution + +POSTGRES_SUBMISSION_USER=local_setup_submission +POSTGRES_SUBMISSION_PASSWORD=local_setup_submission + +POSTGRES_FLYWAY_USER=local_setup_flyway +POSTGRES_FLYWAY_PASSWORD=local_setup_flyway + # Docker Compose PgAdmin settings [email protected] PGADMIN_DEFAULT_PASSWORD=password diff --git a/.gitattributes b/.gitattributes --- a/.gitattributes +++ b/.gitattributes @@ -1 +1,3 @@ wait-for-it.sh text eol=lf +maven-wrapper.properties text eol=lf +mvnw text eol=lf diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -7,6 +7,7 @@ Before submitting, please take the time to check the points below and provide so * [ ] [Link your Pull Request to an issue](https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue) (if applicable) * [ ] Create Work In Progress [WIP] pull requests only if you need clarification or an explicit review before you can continue your work item. * [ ] Make sure that your PR is not introducing _unncessary_ reformatting (e.g., introduced by on-save hooks in your IDE) +* [ ] Make sure each new `.java` source file you add has a correct license header. --> diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -2,7 +2,7 @@ name: "Code scanning - action" on: push: - branches: + branches: - master jobs: @@ -22,14 +22,14 @@ jobs: uses: github/codeql-action/init@v1 with: languages: java - + - name: Java Setup uses: actions/setup-java@v1 with: java-version: 11 - name: Build - run: mvn --batch-mode clean compile + run: ./mvnw --batch-mode clean compile - name: Perform CodeQL Analysis uses: github/codeql-action/analyze@v1 diff --git a/CODEOWNERS b/CODEOWNERS --- a/CODEOWNERS +++ b/CODEOWNERS @@ -5,4 +5,4 @@ # For more details, read the following article on GitHub: https://help.github.com/articles/about-codeowners/. # These are the default owners for the whole content of this repository. The default owners are automatically added as reviewers when you open a pull request, unless different owners are specified in the file. -* @christian-kirschnick @johanneseschrig @michael-burwig @pithumke @ole-lilienthal @MKusber @stevesap @UnchartedBull +* @christian-kirschnick @johanneseschrig @michael-burwig @pithumke @ole-lilienthal @MKusber @stevesap @UnchartedBull @hilmarf @sorin-stefan-iovita-sap @KevponSAP @EvgeniiSkrebtcov @ioangut @kilbphilippSAP @emmetsap @EugenM-SAP @fredrb diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,6 +50,10 @@ The following rule governs documentation contributions: * Commits should be as small as possible while ensuring that each commit is correct independently (i.e., each commit should compile and pass tests). +* Make sure each new `.java` source file you add has a correct license header. This is enforced by a blocking Github Action on your pull request. To add the correct license header, either: + * Add it manually by copying it from another file. + * Run `mvn license:update-file-header` in the root directory to quickly generate missing headers everywhere. + * Test your changes as thoroughly as possible before you commit them. Preferably, automate your test by unit/integration tests. If tested manually, provide information about the test scope in the PR description (e.g. “Test passed: Upgrade version from 0.42 to 0.42.23.”). * Create _Work In Progress [WIP]_ pull requests only if you need clarification or an explicit review before you can continue your work item. diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -23,13 +23,13 @@ <a href="#licensing">Licensing</a> </p> -The goal of this project is to develop the official Corona-Warn-App for Germany based on the exposure notification API from [Apple](https://www.apple.com/covid19/contacttracing/) and [Google](https://www.google.com/covid19/exposurenotifications/). The apps (for both iOS and Android) use Bluetooth technology to exchange anonymous encrypted data with other mobile phones (on which the app is also installed) in the vicinity of an app user's phone. The data is stored locally on each user's device, preventing authorities or other parties from accessing or controlling the data. This repository contains the **implementation of the server for encryption keys** for the Corona-Warn-App. This implementation is still a **work in progress**, and the code it contains is currently alpha-quality code. +The goal of this project is to develop the official Corona-Warn-App for Germany based on the exposure notification API from [Apple](https://www.apple.com/covid19/contacttracing/) and [Google](https://www.google.com/covid19/exposurenotifications/). The apps (for both iOS and Android) use Bluetooth technology to exchange anonymous encrypted data with other mobile phones (on which the app is also installed) in the vicinity of an app user's phone. The data is stored locally on each user's device, preventing authorities or other parties from accessing or controlling the data. This repository contains the **implementation of the server for encryption keys** for the Corona-Warn-App. In this documentation, Corona-Warn-App services are also referred to as CWA services. ## Architecture Overview -You can find the architecture overview [here](/docs/architecture-overview.md), which will give you +You can find the architecture overview [here](/docs/ARCHITECTURE.md), which will give you a good starting point in how the backend services interact with other services, and what purpose they serve. @@ -49,7 +49,7 @@ If you want to use Docker-based deployment, you need to install Docker on your l #### Running the Full CWA Backend Using Docker Compose -For your convenience, a full setup including the generation of test data has been prepared using [Docker Compose](https://docs.docker.com/compose/reference/overview/). To build the backend services, run ```docker-compose build``` in the repository's root directory. A default configuration file can be found under ```.env```in the root folder of the repository. The default values for the local Postgres and Zenko Cloudserver should be changed in this file before docker-compose is run. +For your convenience, a full setup including the generation of test data has been prepared using [Docker Compose](https://docs.docker.com/compose/reference/overview/). To build the backend services, run ```docker-compose build``` in the repository's root directory. A default configuration file can be found under ```.env``` in the root folder of the repository. The default values for the local Postgres and Zenko Cloudserver should be changed in this file before docker-compose is run. Once the services are built, you can start the whole backend using ```docker-compose up```. The distribution service runs once and then finishes. If you want to trigger additional distribution runs, run ```docker-compose run distribution```. @@ -60,10 +60,10 @@ Service | Description | Endpoint and Default Credentials ------------------|-------------|----------- submission | The Corona-Warn-App submission service | `http://localhost:8000` <br> `http://localhost:8006` (for actuator endpoint) distribution | The Corona-Warn-App distribution service | NO ENDPOINT -postgres | A [postgres] database installation | `postgres:8001` <br> Username: postgres <br> Password: postgres +postgres | A [postgres] database installation | `localhost:8001` <br> `postgres:5432` (from containerized pgadmin) <br> Username: postgres <br> Password: postgres pgadmin | A [pgadmin](https://www.pgadmin.org/) installation for the postgres database | `http://localhost:8002` <br> Username: [email protected] <br> Password: password cloudserver | [Zenko CloudServer] is a S3-compliant object store | `http://localhost:8003/` <br> Access key: accessKey1 <br> Secret key: verySecretKey1 -verification-fake | A very simple fake implementation for the tan verification. | `http://localhost:8004/version/v1/tan/verify` <br> The only valid tan is "edc07f08-a1aa-11ea-bb37-0242ac130002" +verification-fake | A very simple fake implementation for the tan verification. | `http://localhost:8004/version/v1/tan/verify` <br> The only valid tan is `edc07f08-a1aa-11ea-bb37-0242ac130002`. ##### Known Limitation @@ -97,6 +97,32 @@ To prepare your machine to run the CWA project locally, we recommend that you fi * [Postgres] * [Zenko CloudServer] +If you are already running a local Postgres, you need to create a database `cwa` and run the following setup scripts: + +* Create the different CWA roles first by executing [create-roles.sql](setup/create-roles.sql). +* Create local database users for the specific roles by running [create-users.sql](./local-setup/create-users.sql). +* It is recommended to also run [enable-test-data-docker-compose.sql](./local-setup/enable-test-data-docker-compose.sql) +, which enables the test data generation profile. If you already had CWA running before and an existing `diagnosis-key` +table on your database, you need to run [enable-test-data.sql](./local-setup/enable-test-data.sql) instead. + +You can also use `docker-compose` to start Postgres and Zenko. If you do that, you have to +set the following environment-variables when running the Spring project: + +For the distribution module: + +```bash +POSTGRESQL_SERVICE_PORT=8001 +VAULT_FILESIGNING_SECRET=</path/to/your/private_key> +SPRING_PROFILES_ACTIVE=signature-dev,disable-ssl-client-postgres +``` + +For the submission module: + +```bash +POSTGRESQL_SERVICE_PORT=8001 +SPRING_PROFILES_ACTIVE=disable-ssl-server,disable-ssl-client-postgres,disable-ssl-client-verification,disable-ssl-client-verification-verify-hostname +``` + #### Configure After you made sure that the specified dependencies are running, configure them in the respective configuration files. @@ -126,7 +152,7 @@ If you want to start the submission service, for example, you start it as follow To enable the `DEBUG` log level, you can run the application using the Spring `dev` profile. ```bash -mvn spring-boot:run -Dspring-boot.run.profiles=dev +mvn spring-boot:run -Dspring.profiles.active=dev ``` To be able to set breakpoints (e.g. in IntelliJ), it may be necessary to use the ```-Dspring-boot.run.fork=false``` parameter. @@ -135,8 +161,8 @@ To be able to set breakpoints (e.g. in IntelliJ), it may be necessary to use the The API that is being exposed by the backend services is documented in an [OpenAPI](https://www.openapis.org/) specification. The specification files are available at the following locations: -Service | OpenAPI Specification --------------|------------- +Service | OpenAPI Specification +--------------------------|------------- Submission Service | [services/submission/api_v1.json](https://github.com/corona-warn-app/cwa-server/raw/master/services/submission/api_v1.json) Distribution Service | [services/distribution/api_v1.json](https://github.com/corona-warn-app/cwa-server/raw/master/services/distribution/api_v1.json) @@ -144,26 +170,20 @@ Distribution Service | [services/distribution/api_v1.json](https://github.c ### Distribution -Profile | Effect ------------------|------------- -`dev` | Turns the log level to `DEBUG`. -`cloud` | Removes default values for the `datasource` and `objectstore` configurations. -`demo` | Includes incomplete days and hours into the distribution run, thus creating aggregates for the current day and the current hour (and including both in the respective indices). When running multiple distributions in one hour with this profile, the date aggregate for today and the hours aggregate for the current hour will be updated and overwritten. This profile also turns off the expiry policy (Keys must be expired for at least 2 hours before distribution) and the shifting policy (there must be at least 140 keys in a distribution). -`testdata` | Causes test data to be inserted into the database before each distribution run. By default, around 1000 random diagnosis keys will be generated per hour. If there are no diagnosis keys in the database yet, random keys will be generated for every hour from the beginning of the retention period (14 days ago at 00:00 UTC) until one hour before the present hour. If there are already keys in the database, the random keys will be generated for every hour from the latest diagnosis key in the database (by submission timestamp) until one hour before the present hour (or none at all, if the latest diagnosis key in the database was submitted one hour ago or later). -`signature-dev` | Sets the app package ID in the export packages' signature info to `de.rki.coronawarnapp-dev` so that test certificates (instead of production certificates) will be used for client-side validation. -`signature-prod` | Provides production app package IDs for the signature info +See [Distribution Service - Spring Profiles](/docs/DISTRIBUTION.md#spring-profiles). ### Submission -Profile | Effect --------------|------------- -`dev` | Turns the log level to `DEBUG`. -`cloud` | Removes default values for the `datasource` configuration. +See [Submission Service - Spring Profiles](/docs/SUBMISSION.md#spring-profiles). ## Documentation The full documentation for the Corona-Warn-App can be found in the [cwa-documentation](https://github.com/corona-warn-app/cwa-documentation) repository. The documentation repository contains technical documents, architecture information, and whitepapers related to this implementation. +The documentation for cwa-server can be found under the [/docs](./docs) folder. + +The JavaDoc documentation for cwa-server is hosted by Github Pages at [https://corona-warn-app.github.io/cwa-server](https://corona-warn-app.github.io/cwa-server). + ## Support and Feedback The following channels are available for discussions, feedback, and support requests: diff --git a/common/persistence/pom.xml b/common/persistence/pom.xml --- a/common/persistence/pom.xml +++ b/common/persistence/pom.xml @@ -5,7 +5,7 @@ <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> - <version>2.3.0.RELEASE</version> + <version>2.3.1.RELEASE</version> <relativePath></relativePath> </parent> <modelVersion>4.0.0</modelVersion> @@ -35,7 +35,7 @@ </dependency> <dependency> <groupId>org.springframework.boot</groupId> - <artifactId>spring-boot-starter-data-jpa</artifactId> + <artifactId>spring-boot-starter-data-jdbc</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> @@ -73,10 +73,12 @@ <dependency> <groupId>org.flywaydb</groupId> <artifactId>flyway-core</artifactId> + <version>6.4.3</version> </dependency> <dependency> <groupId>org.postgresql</groupId> <artifactId>postgresql</artifactId> + <version>42.2.13</version> <scope>runtime</scope> </dependency> <dependency> @@ -111,8 +113,40 @@ </dependency> </dependencies> + <reporting> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-javadoc-plugin</artifactId> + <version>3.2.0</version> + <configuration> + <bottom> + <![CDATA[ + <script> + if (typeof useModuleDirectories !== 'undefined') { + useModuleDirectories = false; + } + </script> + ]]> + </bottom> + <additionalJOption>--allow-script-in-comments</additionalJOption> + </configuration> + </plugin> + </plugins> + </reporting> + <build> <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-site-plugin</artifactId> + <version>3.7.1</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-project-info-reports-plugin</artifactId> + <version>3.0.0</version> + </plugin> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>license-maven-plugin</artifactId> diff --git a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKey.java b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKey.java --- a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKey.java +++ b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKey.java @@ -24,26 +24,22 @@ import app.coronawarn.server.common.persistence.domain.DiagnosisKeyBuilders.Builder; import app.coronawarn.server.common.persistence.domain.validation.ValidRollingStartIntervalNumber; +import app.coronawarn.server.common.persistence.domain.validation.ValidSubmissionTimestamp; import java.time.Instant; import java.time.LocalDateTime; import java.util.Arrays; import java.util.Objects; import java.util.Set; -import javax.persistence.Column; -import javax.persistence.Entity; -import javax.persistence.Id; -import javax.persistence.Table; import javax.validation.ConstraintViolation; import javax.validation.Validation; import javax.validation.Validator; import javax.validation.constraints.Size; import org.hibernate.validator.constraints.Range; +import org.springframework.data.annotation.Id; /** * A key generated for advertising over a window of time. */ -@Entity -@Table(name = "diagnosis_key") public class DiagnosisKey { /** @@ -57,23 +53,20 @@ public class DiagnosisKey { @Id @Size(min = 16, max = 16, message = "Key data must be a byte array of length 16.") - @Column(unique = true) - private byte[] keyData; + private final byte[] keyData; @ValidRollingStartIntervalNumber - private int rollingStartIntervalNumber; + private final int rollingStartIntervalNumber; @Range(min = EXPECTED_ROLLING_PERIOD, max = EXPECTED_ROLLING_PERIOD, message = "Rolling period must be " + EXPECTED_ROLLING_PERIOD + ".") - private int rollingPeriod; + private final int rollingPeriod; @Range(min = 0, max = 8, message = "Risk level must be between 0 and 8.") - private int transmissionRiskLevel; + private final int transmissionRiskLevel; - private long submissionTimestamp; - - protected DiagnosisKey() { - } + @ValidSubmissionTimestamp + private final long submissionTimestamp; /** * Should be called by builders. diff --git a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyBuilder.java b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyBuilder.java --- a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyBuilder.java +++ b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyBuilder.java @@ -24,6 +24,7 @@ import static app.coronawarn.server.common.persistence.domain.DiagnosisKeyBuilders.FinalBuilder; import static app.coronawarn.server.common.persistence.domain.DiagnosisKeyBuilders.RollingStartIntervalNumberBuilder; import static app.coronawarn.server.common.persistence.domain.DiagnosisKeyBuilders.TransmissionRiskLevelBuilder; +import static app.coronawarn.server.common.persistence.domain.validation.ValidSubmissionTimestampValidator.SECONDS_PER_HOUR; import app.coronawarn.server.common.persistence.exception.InvalidDiagnosisKeyException; import app.coronawarn.server.common.protocols.external.exposurenotification.TemporaryExposureKey; @@ -47,7 +48,7 @@ public class DiagnosisKeyBuilder implements private int rollingStartIntervalNumber; private int rollingPeriod = DiagnosisKey.EXPECTED_ROLLING_PERIOD; private int transmissionRiskLevel; - private long submissionTimestamp = -1L; + private Long submissionTimestamp = null; DiagnosisKeyBuilder() { } @@ -93,9 +94,9 @@ public FinalBuilder withRollingPeriod(int rollingPeriod) { @Override public DiagnosisKey build() { - if (submissionTimestamp < 0) { + if (submissionTimestamp == null) { // hours since epoch - submissionTimestamp = Instant.now().getEpochSecond() / 3600L; + submissionTimestamp = Instant.now().getEpochSecond() / SECONDS_PER_HOUR; } var diagnosisKey = new DiagnosisKey( diff --git a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/validation/ValidSubmissionTimestamp.java b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/validation/ValidSubmissionTimestamp.java new file mode 100644 --- /dev/null +++ b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/validation/ValidSubmissionTimestamp.java @@ -0,0 +1,58 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.common.persistence.domain.validation; + +import java.lang.annotation.Documented; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; +import javax.validation.Constraint; +import javax.validation.Payload; + +@Constraint(validatedBy = ValidSubmissionTimestampValidator.class) +@Target({ElementType.FIELD}) +@Retention(RetentionPolicy.RUNTIME) +@Documented +public @interface ValidSubmissionTimestamp { + + /** + * Error message. + * + * @return the error message + */ + String message() default "Submission timestamp (hours since epoch)" + + " must be greater or equal 0 and cannot be in the future."; + + /** + * Groups. + * + * @return + */ + Class<?>[] groups() default {}; + + /** + * Payload. + * + * @return + */ + Class<? extends Payload>[] payload() default {}; +} diff --git a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/validation/ValidSubmissionTimestampValidator.java b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/validation/ValidSubmissionTimestampValidator.java new file mode 100644 --- /dev/null +++ b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/validation/ValidSubmissionTimestampValidator.java @@ -0,0 +1,38 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.common.persistence.domain.validation; + +import java.time.Instant; +import java.util.concurrent.TimeUnit; +import javax.validation.ConstraintValidator; +import javax.validation.ConstraintValidatorContext; + +public class ValidSubmissionTimestampValidator + implements ConstraintValidator<ValidSubmissionTimestamp, Long> { + + public static final long SECONDS_PER_HOUR = TimeUnit.HOURS.toSeconds(1); + + @Override + public boolean isValid(Long submissionTimestamp, ConstraintValidatorContext constraintValidatorContext) { + long currentHoursSinceEpoch = Instant.now().getEpochSecond() / SECONDS_PER_HOUR; + return submissionTimestamp >= 0L && submissionTimestamp <= currentHoursSinceEpoch; + } +} diff --git a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/repository/DiagnosisKeyRepository.java b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/repository/DiagnosisKeyRepository.java --- a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/repository/DiagnosisKeyRepository.java +++ b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/repository/DiagnosisKeyRepository.java @@ -21,21 +21,32 @@ package app.coronawarn.server.common.persistence.repository; import app.coronawarn.server.common.persistence.domain.DiagnosisKey; -import org.springframework.data.jpa.repository.JpaRepository; -import org.springframework.data.jpa.repository.Modifying; -import org.springframework.data.jpa.repository.Query; +import org.springframework.data.jdbc.repository.query.Modifying; +import org.springframework.data.jdbc.repository.query.Query; +import org.springframework.data.repository.PagingAndSortingRepository; +import org.springframework.data.repository.query.Param; import org.springframework.stereotype.Repository; @Repository -public interface DiagnosisKeyRepository extends JpaRepository<DiagnosisKey, Long> { +public interface DiagnosisKeyRepository extends PagingAndSortingRepository<DiagnosisKey, Long> { /** - * Deletes all entries that have a submission timestamp lesser or equal to the specified one. + * Counts all entries that have a submission timestamp less or equal than the specified one. + * + * @param submissionTimestamp The submission timestamp up to which entries will be expired. + * @return The number of expired keys. + */ + @Query("SELECT COUNT(*) FROM diagnosis_key WHERE submission_timestamp<=:threshold") + int countOlderThanOrEqual(@Param("threshold") long submissionTimestamp); + + /** + * Deletes all entries that have a submission timestamp less or equal than the specified one. * * @param submissionTimestamp The submission timestamp up to which entries will be deleted. - * @return The number of rows that were deleted. */ - int deleteBySubmissionTimestampIsLessThanEqual(long submissionTimestamp); + @Modifying + @Query("DELETE FROM diagnosis_key WHERE submission_timestamp<=:threshold") + void deleteOlderThanOrEqual(@Param("threshold") long submissionTimestamp); /** * Attempts to write the specified diagnosis key information into the database. If a row with the specified key data @@ -48,10 +59,14 @@ public interface DiagnosisKeyRepository extends JpaRepository<DiagnosisKey, Long * @param transmissionRisk The transmission risk level of the diagnosis key. */ @Modifying - @Query(nativeQuery = true, value = - "INSERT INTO diagnosis_key" - + "(key_data, rolling_start_interval_number, rolling_period, submission_timestamp, transmission_risk_level)" - + " VALUES(?, ?, ?, ?, ?) ON CONFLICT DO NOTHING;") - void saveDoNothingOnConflict(byte[] keyData, int rollingStartIntervalNumber, int rollingPeriod, - long submissionTimestamp, int transmissionRisk); + @Query("INSERT INTO diagnosis_key " + + "(key_data, rolling_start_interval_number, rolling_period, submission_timestamp, transmission_risk_level) " + + "VALUES (:keyData, :rollingStartIntervalNumber, :rollingPeriod, :submissionTimestamp, :transmissionRisk) " + + "ON CONFLICT DO NOTHING") + void saveDoNothingOnConflict( + @Param("keyData") byte[] keyData, + @Param("rollingStartIntervalNumber") int rollingStartIntervalNumber, + @Param("rollingPeriod") int rollingPeriod, + @Param("submissionTimestamp") long submissionTimestamp, + @Param("transmissionRisk") int transmissionRisk); } diff --git a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyService.java b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyService.java --- a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyService.java +++ b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyService.java @@ -20,7 +20,9 @@ package app.coronawarn.server.common.persistence.service; +import static app.coronawarn.server.common.persistence.domain.validation.ValidSubmissionTimestampValidator.SECONDS_PER_HOUR; import static java.time.ZoneOffset.UTC; +import static org.springframework.data.util.StreamUtils.createStreamFromIterator; import app.coronawarn.server.common.persistence.domain.DiagnosisKey; import app.coronawarn.server.common.persistence.repository.DiagnosisKeyRepository; @@ -69,7 +71,8 @@ public void saveDiagnosisKeys(Collection<DiagnosisKey> diagnosisKeys) { * Returns all valid persisted diagnosis keys, sorted by their submission timestamp. */ public List<DiagnosisKey> getDiagnosisKeys() { - List<DiagnosisKey> diagnosisKeys = keyRepository.findAll(Sort.by(Direction.ASC, "submissionTimestamp")); + List<DiagnosisKey> diagnosisKeys = createStreamFromIterator( + keyRepository.findAll(Sort.by(Direction.ASC, "submissionTimestamp")).iterator()).collect(Collectors.toList()); List<DiagnosisKey> validDiagnosisKeys = diagnosisKeys.stream().filter(DiagnosisKeyService::isDiagnosisKeyValid).collect(Collectors.toList()); @@ -109,9 +112,10 @@ public void applyRetentionPolicy(int daysToRetain) { long threshold = LocalDateTime .ofInstant(Instant.now(), UTC) .minusDays(daysToRetain) - .toEpochSecond(UTC) / 3600L; - int numberOfDeletions = keyRepository.deleteBySubmissionTimestampIsLessThanEqual(threshold); - logger.info("Deleted {} diagnosis key(s) with a submission timestamp older than {} day(s) ago.", + .toEpochSecond(UTC) / SECONDS_PER_HOUR; + int numberOfDeletions = keyRepository.countOlderThanOrEqual(threshold); + logger.info("Deleting {} diagnosis key(s) with a submission timestamp older than {} day(s) ago.", numberOfDeletions, daysToRetain); + keyRepository.deleteOlderThanOrEqual(threshold); } } diff --git a/common/persistence/src/main/resources/db/migration/postgres/V1__createTables.sql b/common/persistence/src/main/resources/db/migration/V1__createTables.sql similarity index 100% rename from common/persistence/src/main/resources/db/migration/postgres/V1__createTables.sql rename to common/persistence/src/main/resources/db/migration/V1__createTables.sql diff --git a/common/persistence/src/main/resources/db/migration/h2/V1__createTables.sql b/common/persistence/src/main/resources/db/migration/h2/V1__createTables.sql deleted file mode 100644 --- a/common/persistence/src/main/resources/db/migration/h2/V1__createTables.sql +++ /dev/null @@ -1,7 +0,0 @@ -CREATE TABLE diagnosis_key ( - key_data bytea PRIMARY KEY, - rolling_period integer NOT NULL, - rolling_start_interval_number integer NOT NULL, - submission_timestamp bigint NOT NULL, - transmission_risk_level integer NOT NULL -); diff --git a/common/persistence/src/main/resources/db/specific/h2/V2__createPermissions.sql b/common/persistence/src/main/resources/db/specific/h2/V2__createPermissions.sql new file mode 100644 --- /dev/null +++ b/common/persistence/src/main/resources/db/specific/h2/V2__createPermissions.sql @@ -0,0 +1 @@ +-- no permissions on H2 necessary diff --git a/common/persistence/src/main/resources/db/specific/postgresql/V2__createPermissions.sql b/common/persistence/src/main/resources/db/specific/postgresql/V2__createPermissions.sql new file mode 100644 --- /dev/null +++ b/common/persistence/src/main/resources/db/specific/postgresql/V2__createPermissions.sql @@ -0,0 +1,2 @@ +GRANT SELECT, DELETE ON TABLE diagnosis_key TO "cwa_distribution"; +GRANT INSERT ON TABLE diagnosis_key TO "cwa_submission"; diff --git a/common/protocols/pom.xml b/common/protocols/pom.xml --- a/common/protocols/pom.xml +++ b/common/protocols/pom.xml @@ -20,7 +20,7 @@ <dependency> <groupId>com.google.protobuf</groupId> <artifactId>protobuf-java</artifactId> - <version>3.11.4</version> + <version>3.12.2</version> </dependency> </dependencies> @@ -46,7 +46,7 @@ </execution> </executions> <configuration> - <protocArtifact>com.google.protobuf:protoc:3.11.4:exe:${os.detected.classifier}</protocArtifact> + <protocArtifact>com.google.protobuf:protoc:3.12.2:exe:${os.detected.classifier}</protocArtifact> </configuration> </plugin> </plugins> diff --git a/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/risk_score_parameters.proto b/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/risk_score_parameters.proto --- a/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/risk_score_parameters.proto +++ b/common/protocols/src/main/proto/app/coronawarn/server/common/protocols/internal/risk_score_parameters.proto @@ -59,6 +59,6 @@ message RiskScoreParameters { RiskLevel gt_27_le_33_dbm = 5; // 27 < A <= 33 dBm RiskLevel gt_15_le_27_dbm = 6; // 15 < A <= 27 dBm RiskLevel gt_10_le_15_dbm = 7; // 10 < A <= 15 dBm - RiskLevel lt_10_dbm = 8; // A <= 10 dBm, highest risk + RiskLevel le_10_dbm = 8; // A <= 10 dBm, highest risk } -} \ No newline at end of file +} diff --git a/docker-compose-it.yaml b/docker-compose-it.yaml new file mode 100644 --- /dev/null +++ b/docker-compose-it.yaml @@ -0,0 +1,41 @@ +version: '3' +services: + objectstore: + image: "zenko/cloudserver" + volumes: + - objectstore_volume:/data + ports: + - "8003:8000" + environment: + ENDPOINT: objectstore + REMOTE_MANAGEMENT_DISABLE: 1 + SCALITY_ACCESS_KEY_ID: ${OBJECTSTORE_ACCESSKEY} + SCALITY_SECRET_ACCESS_KEY: ${OBJECTSTORE_SECRETKEY} + create-bucket: + image: amazon/aws-cli + environment: + - AWS_ACCESS_KEY_ID=${OBJECTSTORE_ACCESSKEY} + - AWS_SECRET_ACCESS_KEY=${OBJECTSTORE_SECRETKEY} + entrypoint: ["/root/scripts/wait-for-it/wait-for-it.sh", "objectstore:8000", "-t", "30", "--"] + volumes: + - ./scripts/wait-for-it:/root/scripts/wait-for-it + command: aws s3api create-bucket --bucket cwa --endpoint-url http://objectstore:8000 --acl public-read + depends_on: + - objectstore + run-tests: + stop_signal: SIGKILL + working_dir: $PWD + environment: + - CWA_OBJECTSTORE_ENDPOINT=http://objectstore + - CWA_OBJECTSTORE_PORT=8000 + depends_on: + - objectstore + - create-bucket + image: openjdk:11 + command: ./mvnw failsafe:integration-test --batch-mode package + volumes: + - $PWD:$PWD + - /var/run/docker.sock:/var/run/docker.sock + - ~/.m2:/root/.m2 +volumes: + objectstore_volume: diff --git a/docker-compose.yml b/docker-compose.yml --- a/docker-compose.yml +++ b/docker-compose.yml @@ -11,14 +11,14 @@ services: - "8000:8080" - "8006:8081" environment: - SPRING_PROFILES_ACTIVE: dev + SPRING_PROFILES_ACTIVE: dev,disable-ssl-server,disable-ssl-client-postgres,disable-ssl-client-verification,disable-ssl-client-verification-verify-hostname POSTGRESQL_SERVICE_PORT: '5432' POSTGRESQL_SERVICE_HOST: postgres POSTGRESQL_DATABASE: ${POSTGRES_DB} - POSTGRESQL_PASSWORD_SUBMISION: ${POSTGRES_PASSWORD} - POSTGRESQL_USER_SUBMISION: ${POSTGRES_USER} - POSTGRESQL_PASSWORD_FLYWAY: ${POSTGRES_PASSWORD} - POSTGRESQL_USER_FLYWAY: ${POSTGRES_USER} + POSTGRESQL_PASSWORD_SUBMISION: ${POSTGRES_SUBMISSION_PASSWORD} + POSTGRESQL_USER_SUBMISION: ${POSTGRES_SUBMISSION_USER} + POSTGRESQL_PASSWORD_FLYWAY: ${POSTGRES_FLYWAY_PASSWORD} + POSTGRESQL_USER_FLYWAY: ${POSTGRES_FLYWAY_USER} VERIFICATION_BASE_URL: http://verification-fake:8004 distribution: build: @@ -29,14 +29,14 @@ services: - objectstore - create-bucket environment: - SPRING_PROFILES_ACTIVE: dev,signature-dev,testdata + SPRING_PROFILES_ACTIVE: dev,signature-dev,testdata,disable-ssl-client-postgres POSTGRESQL_SERVICE_PORT: '5432' POSTGRESQL_SERVICE_HOST: postgres POSTGRESQL_DATABASE: ${POSTGRES_DB} - POSTGRESQL_PASSWORD_DISTRIBUTION: ${POSTGRES_PASSWORD} - POSTGRESQL_USER_DISTRIBUTION: ${POSTGRES_USER} - POSTGRESQL_PASSWORD_FLYWAY: ${POSTGRES_PASSWORD} - POSTGRESQL_USER_FLYWAY: ${POSTGRES_USER} + POSTGRESQL_PASSWORD_DISTRIBUTION: ${POSTGRES_DISTRIBUTION_PASSWORD} + POSTGRESQL_USER_DISTRIBUTION: ${POSTGRES_DISTRIBUTION_USER} + POSTGRESQL_PASSWORD_FLYWAY: ${POSTGRES_FLYWAY_PASSWORD} + POSTGRESQL_USER_FLYWAY: ${POSTGRES_FLYWAY_USER} # Settings for the S3 compatible objectstore CWA_OBJECTSTORE_ACCESSKEY: ${OBJECTSTORE_ACCESSKEY} CWA_OBJECTSTORE_SECRETKEY: ${OBJECTSTORE_SECRETKEY} @@ -60,6 +60,9 @@ services: POSTGRES_PASSWORD: ${POSTGRES_PASSWORD} volumes: - postgres_volume:/data/postgres + - ./setup/setup-roles.sql:/docker-entrypoint-initdb.d/1-roles.sql + - ./local-setup/create-users.sql:/docker-entrypoint-initdb.d/2-users.sql + - ./local-setup/enable-test-data-docker-compose.sql:/docker-entrypoint-initdb.d/3-enable-testdata.sql pgadmin: container_name: pgadmin_container image: dpage/pgadmin4 diff --git a/docs/architecture-overview.md b/docs/ARCHITECTURE.md similarity index 88% rename from docs/architecture-overview.md rename to docs/ARCHITECTURE.md --- a/docs/architecture-overview.md +++ b/docs/ARCHITECTURE.md @@ -1,17 +1,22 @@ -# Architecture CWA Server +# CWA-Server Architecture This document outlines the CWA server architecture on high level. This document does not necessarily reflect the current implementation status in this repository, as development is still ongoing. Also, details of the exposure notification API by Google/Apple might change in the future. -Please note: This overview document only focuses on the architecture of this component. -If you are interested in the full architectural overview, check out the [solution architecture](https://github.com/corona-warn-app/cwa-documentation/blob/master/solution_architecture.md) -in the [cwa-documentation](https://github.com/corona-warn-app/cwa-documentation) repository. +The high level overview of CWA can be found in the [cwa-documentation](https://github.com/corona-warn-app/cwa-documentation) +repository. The [solution architecture](https://github.com/corona-warn-app/cwa-documentation/blob/master/solution_architecture.md) +is outlined in detail. + + +The above illustration shows all components of the CWA project. This repository reflects the `Corona-Warn-App Server` +component, which can be found in the left bottom corner. This document explains in more detail how this component +functions and interacts with other components. ## Overview -The Corona Warn App ("CWA") server runs in a Kubernetes cluster on the Open Shift (“OSP”) platform. +The Corona Warn App ("CWA") server runs in a Kubernetes cluster on the OpenShift (“OCP”) platform. Its main objective is to enable users to take part in the exposure notification framework based on Apple/Google specifications. Although CWA aims at compliance to the spec on a protocol level, it does not mean automatically that all features will be implemented. Main driver for these assessments is data privacy and protection (DPP) concerns. @@ -123,17 +128,19 @@ CWA-Fake: <0 or 1> There is currently no official specification for publishing diagnosis keys to the server. Google currently uses the following in their reference implementation. -[exposure_model.go](https://github.com/google/exposure-notifications-server/blob/master/internal/database/exposure_model.go) +[exposure_types.go](https://github.com/google/exposure-notifications-server/blob/master/pkg/api/v1alpha1/exposure_types.go) ```golang type Publish struct { - Keys []ExposureKey `json:"temporaryExposureKeys"` - Regions []string `json:"regions"` - AppPackageName string `json:"appPackageName"` - Platform string `json:"platform"` - DeviceVerificationPayload string `json:"deviceVerificationPayload"` - VerificationPayload string `json:"verificationPayload"` - Padding string `json:"padding"` + Keys []ExposureKey `json:"temporaryExposureKeys"` + Regions []string `json:"regions"` + AppPackageName string `json:"appPackageName"` + VerificationPayload string `json:"verificationPayload"` + HMACKey string `json:"hmackey"` + Padding string `json:"padding"` + + Platform string `json:"platform"` // DEPRECATED + DeviceVerificationPayload string `json:"deviceVerificationPayload"` // DEPRECATED } ``` diff --git a/docs/DISTRIBUTION.md b/docs/DISTRIBUTION.md new file mode 100644 --- /dev/null +++ b/docs/DISTRIBUTION.md @@ -0,0 +1,127 @@ +# CWA-Server Distribution Service + +## Spring Profiles + +Spring profiles are used to apply distribution service configuration based on the running environment, determined by the active profile. + +You will find `.yaml` and `.xml` based profile-specific configuration files at [`/services/distribution/src/main/resources`](/services/distribution/src/main/resources). + +### Available Profiles + +Profile | Effect +------------------------------|------------- +`dev` | Sets the log level to `DEBUG` and changes the `CONSOLE_LOG_PATTERN` used by Log4j 2. +`cloud` | Removes default values for the `spring.flyway`, `spring.datasource` and `services.distribution.objectstore` configurations. <br>Changes the distribution output path and turns off `set-public-read-acl-on-put-object`. +`demo` | Includes incomplete days and hours into the distribution run, thus creating aggregates for the current day and the current hour (and including both in the respective indices). When running multiple distributions in one hour with this profile, the date aggregate for today and the hours aggregate for the current hour will be updated and overwritten. This profile also turns off the expiry policy (Keys must be expired for at least 2 hours before distribution) and the shifting policy (there must be at least 140 keys in a distribution). +`testdata` | Causes test data to be inserted into the database before each distribution run. By default, around 1000 random diagnosis keys will be generated per hour. If there are no diagnosis keys in the database yet, random keys will be generated for every hour from the beginning of the retention period (14 days ago at 00:00 UTC) until one hour before the present hour. If there are already keys in the database, the random keys will be generated for every hour from the latest diagnosis key in the database (by submission timestamp) until one hour before the present hour (or none at all, if the latest diagnosis key in the database was submitted one hour ago or later). +`signature-dev` | Sets the app package ID in the export packages' signature info to `de.rki.coronawarnapp-dev` so that the non-productive/test public key will be used for client-side validation. +`signature-prod` | Sets the app package ID in the export packages' signature info to `de.rki.coronawarnapp` so that the productive public key will be used for client-side validation. +`disable-ssl-client-postgres` | Disables SSL for the connection to the postgres database. + +Please refer to the section [Configuration Properties](#configuration-properties) and the inline comments in the base `application.yaml` configuration file for further details on the configuration properties impacted by the above profiles. + +## Configuration Properties + +All of the configurable parameters, that are used throughout this service can be found in the +[`application.yaml`](/services/distribution/src/main/resources/application.yaml) file. This configuration file is +divided into different sub-categories: + +- Some general configuration, which isn't divided into sub-categories +- `paths` - Local paths, that are used during the export creation +- `tek-export` - Configuration for the exported archive, that is saved on the S3-compatible storage +- `api` - API configuration, configures the API, which is used by the mobile app to query diagnosis keys +- `signature` - Signature configuration, used for signing the exports +- `objectstore` - Configuration for the S3 compatible object storage + +## Object Store + +The communication with the S3 compatible object storage, that is hosted by Deutsche Telekom is achieved through AWS SDK +v2. The files, that will be uploaded to the S3 compatible storage are created on local storage first (output path +defined in application configuration) and are then uploaded to the storage provider. + +### Headers + +Up to three headers are set during upload, depending on the configuration properties. + +#### `Cache-Control` + +Defines the maximum amount of time a published resource is considered fresh, when held in cache. Will be set for each +upload. The default value is 300 seconds. + +#### `x-amz-acl` + +Defines the canned ACL for the uploaded file. Is only set if [`set-public-read-acl-on-put-object`] is set to true in the +configuration properties. Will be `public-read` in that case, which grants full control to the owners and read-access to +AllUsers. This setting should only be used when running with the application with the local Zenko Cloudserver. + +#### `cwa-hash` + +Custom header, which adds the MD5 hash of the archive contents (export.bin). If the file isn't an archive, the contents +of the file will be used to build the hash (index files). This header is used to determine, whether a file should be +uploaded or not. If the hash for the file is the same as the hash available on the S3 compatible storage it will not be +uploaded, since the contents of that specific file did not change, so there is no need to re-upload the file. If the +hash differs, or the file is not available on the S3 compatible storage the file will be uploaded. + +This header is needed, since it is not possible to create byte-identical archives when using ECDSA due to its +non-deterministic nature. + +### Threading + +The upload operations are being run in multiple threads in order to increase performance. The number of threads is +defined in the application configuration. Each upload operation is passed to Spring Boot's `ThreadPoolTaskExecutor`, +which then distributes them across the available threads. Once all tasks are submitted, the logic checks, whether all +threads have terminated before shutting down the thread pool. If errors are thrown, they are handled as explained in the +following section. + +### Error Handling + +In order to increase resilience of the distribution service two error handling measures were introduced. + +The first one being Spring Boot's Retry logic, which is applied to all S3 operations with the number of retries being +specified in the application configuration. This results in Spring Boot retrying the operation up to three times, with a +two second pause in between. + +The second part will catch operations, that have failed even after retrying them through SpringBoot's Retry logic. If +more than five uploads fail (can be configured in the application configuration) the program will terminate with an +error, if less than five operations have failed so far the error will just be logged to console, but the upload will +continue. + +The error handling is designed to handle intermediate errors, like short connection problems. If too many operations +fail it is safe to assume, that a bigger problem is occurring and that subsequent operations will also fail. In this +case the program is terminated to prevent unnecessary load. + +### Retention + +The same 14 days retention period (like the database) is also enforced on the S3 compatible storage. Each distribution +run will execute the retention policy. + +When data deletion is executed on the object store, the object store is instructed to delete all files with the following +prefix: + +`version/v1/diagnosis-keys/country/DE/<date>` + +In which `<date>` stands for the ISO formatted date (e.g. `2012-06-05`), and is before the retention cutoff date +(today - 14 days). + +## Assembly Process + +The exported diagnosis-keys are being organized in hourly and daily archives. The folder structure is as follows: +`/version/<version>/diagnosis-keys/country/<ISO-3166-country>/date/<YYYY-MM-DD>/hour/<hh>/index`. The version, country, +date and hour directory also contain an index file each, listing all the subdirectories. All generated files are named +`index`, which acts as a workaround to also support files & folders with the same name - e.g. +`version/v1/diagnosis-keys/country` is both a file and the folder `version/v1/diagnosis-keys/country/`. S3 supports this +concept, but writing this structure to the local disk is not supported. Therefore, this country file will be assembled as +`version/v1/diagnosis-keys/country/index`. The `/index` part will then be removed upon S3 upload. + +For each assembly run the diagnosis keys for the last 14 days are queried. Based on the result, hour and their parent +directories are created and the keys are added to their respective archives. To which archive the key should be added is +determined by the distribution timestamp. + +The diagnosis keys need to be expired for at least two hours, before they can be distributed. This means that if the key +has been submitted within two hours after the expiry date, it cannot be published immediately. Therefore a distribution +timestamp is calculated, which is either the submission timestamp, or, if the submission timestamp is within two hours +after the expiry date, the expiry date plus two hours. This ensures compliance with the specification from Google and +Apple. + +Each run creates all hourly and daily archives for the last 14 days. To prevent unnecessary uploads the +[`cwa-hash`](#cwa-hash) header has been introduced. diff --git a/docs/INFRASTRUCTURE.md b/docs/INFRASTRUCTURE.md new file mode 100644 --- /dev/null +++ b/docs/INFRASTRUCTURE.md @@ -0,0 +1 @@ +# CWA-Server Infrastructure diff --git a/docs/PERSISTENCE.md b/docs/PERSISTENCE.md new file mode 100644 --- /dev/null +++ b/docs/PERSISTENCE.md @@ -0,0 +1 @@ +# CWA-Server Persistence diff --git a/docs/QUALITY_ASSURANCE.md b/docs/QUALITY_ASSURANCE.md new file mode 100644 --- /dev/null +++ b/docs/QUALITY_ASSURANCE.md @@ -0,0 +1 @@ +# CWA-Server Quality Assurance diff --git a/docs/README.md b/docs/README.md new file mode 100644 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,11 @@ +# CWA-Server Documentation + +| Documentation | Description | +| --- | --- | +| [Architecture](./ARCHITECTURE.md) | Architectural overview | +| [Submission Service](./SUBMISSION.md) | Documentation of the submission service | +| [Distribution Service](./DISTRIBUTION.md) | Documentation of the distribution service | +| [Persistence](./PERSISTENCE.md) | Documentation of the persistence module | +| [Infrastructure](./INFRASTRUCTURE.md) | Documentation of infrastructure related topics | +| [Quality Assurance](./QUALITY_ASSURANCE.md) | Documentation of testing and quality assurance | +| [Security](./SECURITY.md) | Documentation of security related topics | diff --git a/docs/SECURITY.md b/docs/SECURITY.md new file mode 100644 --- /dev/null +++ b/docs/SECURITY.md @@ -0,0 +1,21 @@ +# CWA-Server Security + +## TLS Configuration + +The cwa-server uses encrypted connections for external and internal communication. The main configuration for the external communication channel can be found [here](../services/submission/src/main/resources/application.yaml) (see section `server`). The current settings will only allow TLS version 1.2 and 1.3. The offered ciphers are chosen in accordance to the recommendations in [BSI-TR-02102-2](https://www.bsi.bund.de/SharedDocs/Downloads/DE/BSI/Publikationen/TechnischeRichtlinien/TR02102/BSI-TR-02102-2.pdf). +Internal communication is configured for instance [in the feign client](../services/submission/src/main/java/app/coronawarn/server/services/submission/verification/CloudFeignClientProvider.java). +Database connections are established via TLS and are enabled for mutual authentication, see [here](../services/submission/src/main/resources/application.yaml#L38). + +## Security-Related Spring Profiles + +The TLS configuration previously described can be changed to enable certain test scenarios. It is important to realize that this degradation of security is only possible by setting a Spring profile, while the default behavior will always use the most secure configuration. To prevent misconfiguration in production, multiple controls are implemented. This includes among others configuration-as-code deployments, explicit log messages for unsafe configurations and monitoring of deployed configurations. +The relevant profiles are: + +|Profile|Description| +|-------|-----------| +|`disable-ssl-server`|Disables SSL for the submission endpoint.| +|`disable-ssl-client-postgres`|Disables SSL with a trusted certificate for the connection to the postgres database.| +|`disable-ssl-client-verification`|Disables SSL with a trusted certificate for the connection to the verification server.| +|`disable-ssl-client-verification-verify-hostname`|Disables the verification of the SSL hostname for the connection to the verification server.| + +Apart from those configuration options, the `dev` profile will never be used in production to prevent leakage of data for security and privacy concerns reasons. diff --git a/docs/SUBMISSION.md b/docs/SUBMISSION.md new file mode 100644 --- /dev/null +++ b/docs/SUBMISSION.md @@ -0,0 +1,20 @@ +# CWA-Server Submission Service + +## Spring Profiles + +Spring profiles are used to apply submission service configuration based on the running environment, determined by the active profile. + +You will find `.yaml` and `.xml` based profile-specific configuration files at [`/services/submission/src/main/resources`](/services/submission/src/main/resources). + +### Available Profiles + +Profile | Effect +--------------------------------------------------|------------- +`dev` | Sets the log level to `DEBUG` and changes the `CONSOLE_LOG_PATTERN` used by Log4j 2. +`cloud` | Removes default values for the `spring.flyway`, `spring.datasource` and `services.submission.verification.base-url` configurations. +`disable-ssl-server` | Disables SSL for the submission endpoint. +`disable-ssl-client-postgres` | Disables SSL with a pinned certificate for the connection to the postgres. +`disable-ssl-client-verification` | Disables SSL with a pinned certificate for the connection to the verification server. +`disable-ssl-client-verification-verify-hostname` | Disables the verification of the SSL hostname for the connection to the verification server. + +Please refer to the inline comments in the base `application.yaml` configuration file for further details on the configuration properties impacted by the above profiles. diff --git a/local-setup/create-users.sql b/local-setup/create-users.sql new file mode 100644 --- /dev/null +++ b/local-setup/create-users.sql @@ -0,0 +1,5 @@ +/* Creates default users for local development */ + +CREATE USER "local_setup_flyway" WITH INHERIT IN ROLE cwa_flyway ENCRYPTED PASSWORD 'local_setup_flyway'; +CREATE USER "local_setup_submission" WITH INHERIT IN ROLE cwa_submission ENCRYPTED PASSWORD 'local_setup_submission'; +CREATE USER "local_setup_distribution" WITH INHERIT IN ROLE cwa_distribution ENCRYPTED PASSWORD 'local_setup_distribution'; diff --git a/local-setup/enable-test-data-docker-compose.sql b/local-setup/enable-test-data-docker-compose.sql new file mode 100644 --- /dev/null +++ b/local-setup/enable-test-data-docker-compose.sql @@ -0,0 +1,3 @@ +/* Testdata creation requires INSERT permission - this is only active on local deployments */ +/* Since the Diagnosis Key Table does not yet exist, this is a workaround to still allow inserts */ +ALTER DEFAULT PRIVILEGES FOR USER local_setup_flyway IN SCHEMA public GRANT INSERT ON TABLES TO cwa_distribution; diff --git a/local-setup/enable-test-data.sql b/local-setup/enable-test-data.sql new file mode 100644 --- /dev/null +++ b/local-setup/enable-test-data.sql @@ -0,0 +1,2 @@ +/* Test Data profile requires insert permissions on diagnois key table */ +GRANT INSERT ON diagnosis_key TO cwa_distribution; diff --git a/pom.xml b/pom.xml --- a/pom.xml +++ b/pom.xml @@ -40,8 +40,40 @@ <sonar.host.url>https://sonarcloud.io</sonar.host.url> </properties> + <reporting> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-javadoc-plugin</artifactId> + <version>3.2.0</version> + <configuration> + <bottom> + <![CDATA[ + <script> + if (typeof useModuleDirectories !== 'undefined') { + useModuleDirectories = false; + } + </script> + ]]> + </bottom> + <additionalJOption>--allow-script-in-comments</additionalJOption> + </configuration> + </plugin> + </plugins> + </reporting> + <build> <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-site-plugin</artifactId> + <version>3.7.1</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-project-info-reports-plugin</artifactId> + <version>3.0.0</version> + </plugin> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>license-maven-plugin</artifactId> diff --git a/scripts/wait-for-it/wait-for-it.sh b/scripts/wait-for-it/wait-for-it.sh --- a/scripts/wait-for-it/wait-for-it.sh +++ b/scripts/wait-for-it/wait-for-it.sh @@ -150,7 +150,7 @@ if [[ $WAITFORIT_TIMEOUT_PATH =~ "busybox" ]]; then WAITFORIT_ISBUSY=1 # Check if busybox timeout uses -t flag # (recent Alpine versions don't support -t anymore) - if timeout &>/dev/stdout | grep -q -e '-t '; then + if timeout &>/dev/stdout | grep -q -e -- '-t '; then WAITFORIT_BUSYTIMEFLAG="-t" fi else diff --git a/services/distribution/Dockerfile b/services/distribution/Dockerfile --- a/services/distribution/Dockerfile +++ b/services/distribution/Dockerfile @@ -1,12 +1,29 @@ -FROM maven:3.6.3-jdk-11 as build +FROM openjdk:11 as build ARG WORK_DIR=/build +# copy the pom and config files first (which do not change very often) +COPY ./.mvn ${WORK_DIR}/.mvn +COPY ./mvnw ${WORK_DIR}/mvnw +COPY ./pom.xml ${WORK_DIR}/pom.xml +COPY ./common/pom.xml ${WORK_DIR}/common/pom.xml +COPY ./common/protocols/pom.xml ${WORK_DIR}/common/protocols/pom.xml +COPY ./common/persistence/pom.xml ${WORK_DIR}/common/persistence/pom.xml +COPY ./services/pom.xml ${WORK_DIR}/services/pom.xml +COPY ./services/distribution/pom.xml ${WORK_DIR}/services/distribution/pom.xml +COPY ./services/submission/pom.xml ${WORK_DIR}/services/submission/pom.xml + +WORKDIR ${WORK_DIR} + +# build all dependencies for offline use +RUN ${WORK_DIR}/mvnw dependency:go-offline --file ${WORK_DIR}/pom.xml -B + +# copy rest of files COPY . ${WORK_DIR}/ -RUN mkdir -p /root/.m2 /usr/sap/distribution-service +RUN mkdir -p /usr/sap/distribution-service # hadolint ignore=SC2086 -RUN mvn --batch-mode -DskipTests=true --file ${WORK_DIR}/pom.xml ${MAVEN_ARGS} clean install +RUN ${WORK_DIR}/mvnw --batch-mode -DskipTests=true --file ${WORK_DIR}/pom.xml ${MAVEN_ARGS} clean install RUN cp ${WORK_DIR}/services/distribution/target/distribution-*.jar /usr/sap/distribution-service/distribution.jar RUN cp ${WORK_DIR}/scripts/DpkgHelper.java /DpkgHelper.java @@ -14,4 +31,6 @@ FROM gcr.io/distroless/java:11 COPY --from=build /DpkgHelper.java . COPY --from=build /usr/sap/distribution-service/distribution.jar . RUN ["java", "DpkgHelper.java"] +USER 65534:65534 +ENTRYPOINT ["/usr/bin/java", "-Djdk.tls.namedGroups=\"secp256r1,secp384r1,brainpoolP256r1,brainpoolP384r1,brainpoolP512r1,ffdhe2048,ffdhe3072,ffdhe4096\"", "-jar"] CMD ["distribution.jar"] diff --git a/services/distribution/api_v1.json b/services/distribution/api_v1.json --- a/services/distribution/api_v1.json +++ b/services/distribution/api_v1.json @@ -348,13 +348,10 @@ }, "/version/{version}/configuration/country/{country}/app_config": { "get": { - "summary": "Get Application configuration for a country.", + "summary": "Get application configuration for a country.", + "description": "Gives application configuration for a specific country, which includes:\n- Minimum risk score\n- Risk score classification\n- Risk score parameters\n- Attenuation duration\n- Application version configuration", "tags": [ - "Minimum risk score", - "Risk score classification", - "Risk score parameters", - "Attenuation duration", - "Application version configuration" + "Application configuration" ], "parameters": [ { diff --git a/services/distribution/pom.xml b/services/distribution/pom.xml --- a/services/distribution/pom.xml +++ b/services/distribution/pom.xml @@ -17,6 +17,18 @@ <build> <pluginManagement> <plugins> + <plugin> + <artifactId>maven-failsafe-plugin</artifactId> + <version>3.0.0-M4</version> + <executions> + <execution> + <goals> + <goal>integration-test</goal> + <goal>verify</goal> + </goals> + </execution> + </executions> + </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-surefire-plugin</artifactId> @@ -56,7 +68,7 @@ <dependency> <groupId>software.amazon.awssdk</groupId> <artifactId>s3</artifactId> - <version>2.13.25</version> + <version>2.13.26</version> </dependency> <dependency> <artifactId>bcpkix-jdk15on</artifactId> @@ -76,13 +88,17 @@ <dependency> <artifactId>commons-math3</artifactId> <groupId>org.apache.commons</groupId> - <version>3.2</version> + <version>3.6.1</version> </dependency> <dependency> <artifactId>spring-retry</artifactId> <groupId>org.springframework.retry</groupId> <version>1.3.0</version> </dependency> + <dependency> + <groupId>org.springframework.boot</groupId> + <artifactId>spring-boot-starter-aop</artifactId> + </dependency> </dependencies> -</project> \ No newline at end of file +</project> diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/Application.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/Application.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/Application.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/Application.java @@ -21,15 +21,21 @@ package app.coronawarn.server.services.distribution; import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import java.util.Arrays; +import java.util.List; +import org.apache.logging.log4j.LogManager; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.DisposableBean; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.autoconfigure.domain.EntityScan; import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.context.ApplicationContext; +import org.springframework.context.EnvironmentAware; import org.springframework.context.annotation.ComponentScan; -import org.springframework.data.jpa.repository.config.EnableJpaRepositories; +import org.springframework.core.env.Environment; +import org.springframework.data.jdbc.repository.config.EnableJdbcRepositories; /** * The retrieval, assembly and distribution of configuration and diagnosis key data is handled by a chain of {@link @@ -37,12 +43,11 @@ * the chain execution. */ @SpringBootApplication -@EnableJpaRepositories(basePackages = "app.coronawarn.server.common.persistence") +@EnableJdbcRepositories(basePackages = "app.coronawarn.server.common.persistence") @EntityScan(basePackages = "app.coronawarn.server.common.persistence") -@ComponentScan({"app.coronawarn.server.common.persistence", - "app.coronawarn.server.services.distribution"}) +@ComponentScan({"app.coronawarn.server.common.persistence", "app.coronawarn.server.services.distribution"}) @EnableConfigurationProperties({DistributionServiceConfig.class}) -public class Application { +public class Application implements EnvironmentAware, DisposableBean { private static final Logger logger = LoggerFactory.getLogger(Application.class); @@ -50,6 +55,15 @@ public static void main(String[] args) { SpringApplication.run(Application.class); } + /** + * Manual shutdown hook needed to avoid Log4j shutdown issues (see cwa-server/#589). + */ + @Override + public void destroy() { + logger.info("Shutting down log4j2."); + LogManager.shutdown(); + } + /** * Terminates this application with exit code 1 (general error). */ @@ -58,4 +72,13 @@ public static void killApplication(ApplicationContext appContext) { logger.error("Application terminated abnormally."); System.exit(1); } + + @Override + public void setEnvironment(Environment environment) { + List<String> profiles = Arrays.asList(environment.getActiveProfiles()); + if (profiles.contains("disable-ssl-client-postgres")) { + logger.warn("The distribution runner is started with postgres connection TLS disabled. " + + "This should never be used in PRODUCTION!"); + } + } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/ApplicationConfigurationProvider.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/ApplicationConfigurationPublicationConfig.java similarity index 65% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/ApplicationConfigurationProvider.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/ApplicationConfigurationPublicationConfig.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/ApplicationConfigurationProvider.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/ApplicationConfigurationPublicationConfig.java @@ -21,10 +21,11 @@ package app.coronawarn.server.services.distribution.assembly.appconfig; import app.coronawarn.server.common.protocols.internal.ApplicationConfiguration; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; /** - * Provides the application configuration needed for the mobile client. Contains all necessary - * sub-configs, including: + * Provides the application configuration needed for the mobile client. Contains all necessary sub-configs, including: * <ul> * <li>Exposure Configuration</li> * <li>Risk Score Classification</li> @@ -33,35 +34,22 @@ * * <p>The application config is fetched from the master-config folder.</p> */ -public class ApplicationConfigurationProvider { +@Configuration +public class ApplicationConfigurationPublicationConfig { /** * The location of the exposure configuration master file. */ public static final String MASTER_FILE = "master-config/app-config.yaml"; - private ApplicationConfigurationProvider() { - - } - /** * Fetches the master configuration as a ApplicationConfiguration instance. * * @return the exposure configuration as ApplicationConfiguration * @throws UnableToLoadFileException when the file/transformation did not succeed */ - public static ApplicationConfiguration readMasterFile() throws UnableToLoadFileException { - return readFile(MASTER_FILE); - } - - /** - * Fetches an exposure configuration file based on the given path. The path must be available in the classloader. - * - * @param path the path, e.g. folder/my-exposure-configuration.yaml - * @return the ApplicationConfiguration - * @throws UnableToLoadFileException when the file/transformation did not succeed - */ - public static ApplicationConfiguration readFile(String path) throws UnableToLoadFileException { - return YamlLoader.loadYamlIntoProtobufBuilder(path, ApplicationConfiguration.Builder.class).build(); + @Bean + public ApplicationConfiguration createMasterConfiguration() throws UnableToLoadFileException { + return YamlLoader.loadYamlIntoProtobufBuilder(MASTER_FILE, ApplicationConfiguration.Builder.class).build(); } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/structure/directory/AppConfigurationDirectory.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/structure/directory/AppConfigurationDirectory.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/structure/directory/AppConfigurationDirectory.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/structure/directory/AppConfigurationDirectory.java @@ -21,12 +21,6 @@ package app.coronawarn.server.services.distribution.assembly.appconfig.structure.directory; import app.coronawarn.server.common.protocols.internal.ApplicationConfiguration; -import app.coronawarn.server.common.protocols.internal.ApplicationVersionConfiguration; -import app.coronawarn.server.common.protocols.internal.AttenuationDuration; -import app.coronawarn.server.common.protocols.internal.RiskScoreClassification; -import app.coronawarn.server.common.protocols.internal.RiskScoreParameters; -import app.coronawarn.server.services.distribution.assembly.appconfig.ApplicationConfigurationProvider; -import app.coronawarn.server.services.distribution.assembly.appconfig.UnableToLoadFileException; import app.coronawarn.server.services.distribution.assembly.appconfig.structure.archive.decorator.signing.AppConfigurationSigningDecorator; import app.coronawarn.server.services.distribution.assembly.appconfig.validation.ApplicationConfigurationValidator; import app.coronawarn.server.services.distribution.assembly.appconfig.validation.ConfigurationValidator; @@ -38,26 +32,21 @@ import app.coronawarn.server.services.distribution.assembly.structure.directory.decorator.indexing.IndexingDecoratorOnDisk; import app.coronawarn.server.services.distribution.assembly.structure.file.FileOnDisk; import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; -import com.google.protobuf.Message; +import java.util.Optional; import java.util.Set; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Creates the directory structure {@code /configuration/country/:country} and writes the following five files, - * wrapped in a signed zip archive: - * 1. File containing minimum risk score - * 2. File containing {@link RiskScoreParameters} - * 3. File containing {@link RiskScoreClassification} - * 4. File containing {@link AttenuationDuration} - * 5. File containing {@link ApplicationVersionConfiguration} + * Creates the directory structure {@code /configuration/country/:country} and writes the app configuration parameters + * into a zip file. */ public class AppConfigurationDirectory extends DirectoryOnDisk { private static final Logger logger = LoggerFactory.getLogger(AppConfigurationDirectory.class); private final IndexDirectoryOnDisk<String> countryDirectory; - + private final ApplicationConfiguration applicationConfiguration; private final CryptoProvider cryptoProvider; private final DistributionServiceConfig distributionServiceConfig; @@ -66,45 +55,39 @@ public class AppConfigurationDirectory extends DirectoryOnDisk { * * @param cryptoProvider The {@link CryptoProvider} whose artifacts to use for creating the signature. */ - public AppConfigurationDirectory(CryptoProvider cryptoProvider, DistributionServiceConfig distributionServiceConfig) { + public AppConfigurationDirectory(ApplicationConfiguration applicationConfiguration, CryptoProvider cryptoProvider, + DistributionServiceConfig distributionServiceConfig) { super(distributionServiceConfig.getApi().getParametersPath()); + this.applicationConfiguration = applicationConfiguration; this.cryptoProvider = cryptoProvider; this.distributionServiceConfig = distributionServiceConfig; countryDirectory = new IndexDirectoryOnDisk<>(distributionServiceConfig.getApi().getCountryPath(), - __ -> Set.of(distributionServiceConfig.getApi().getCountryGermany()), Object::toString); + ignoredValue -> Set.of(distributionServiceConfig.getApi().getCountryGermany()), Object::toString); - addApplicationConfigurationIfValid(); + addConfigurationArchiveIfValid(distributionServiceConfig.getApi().getAppConfigFileName()); this.addWritable(new IndexingDecoratorOnDisk<>(countryDirectory, distributionServiceConfig.getOutputFileName())); } - private void addApplicationConfigurationIfValid() { - try { - ApplicationConfiguration appConfig = ApplicationConfigurationProvider.readMasterFile(); - ConfigurationValidator validator = new ApplicationConfigurationValidator(appConfig); - addArchiveIfMessageValid(distributionServiceConfig.getApi().getAppConfigFileName(), - appConfig, validator); - } catch (UnableToLoadFileException e) { - logger.error("Exposure configuration will not be published! Unable to read configuration file from disk.", e); - } - } - /** - * If validation of the {@link Message} succeeds, it is written into a file, put into an archive with the specified - * name and added to the specified parent directory. + * If validation of the {@link ApplicationConfiguration} succeeds, it is written into a file, put into an archive with + * the specified name and added to the specified parent directory. */ - private void addArchiveIfMessageValid(String archiveName, Message message, ConfigurationValidator validator) { + private void addConfigurationArchiveIfValid(String archiveName) { + ConfigurationValidator validator = new ApplicationConfigurationValidator(applicationConfiguration); ValidationResult validationResult = validator.validate(); if (validationResult.hasErrors()) { - logger.error("App configuration file creation failed. Validation failed for {}./n{}", + logger.error("App configuration file creation failed. Validation failed for {}, {}", archiveName, validationResult); + return; } ArchiveOnDisk appConfigurationFile = new ArchiveOnDisk(archiveName); - appConfigurationFile.addWritable(new FileOnDisk("export.bin", message.toByteArray())); - countryDirectory.addWritableToAll(__ -> new AppConfigurationSigningDecorator(appConfigurationFile, cryptoProvider, - distributionServiceConfig)); + appConfigurationFile.addWritable(new FileOnDisk("export.bin", applicationConfiguration.toByteArray())); + countryDirectory.addWritableToAll(ignoredValue -> + Optional + .of(new AppConfigurationSigningDecorator(appConfigurationFile, cryptoProvider, distributionServiceConfig))); } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ApplicationConfigurationValidator.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ApplicationConfigurationValidator.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ApplicationConfigurationValidator.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ApplicationConfigurationValidator.java @@ -60,7 +60,7 @@ public ValidationResult validate() { private void validateMinRisk() { int minLevel = this.config.getMinRiskScore(); - if (!RiskScoreValidator.isInBounds(minLevel)) { + if (!RiskScoreValidator.isWithinBounds(minLevel)) { this.errors.add(new ValidationError("min-risk-score", minLevel, VALUE_OUT_OF_BOUNDS)); } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidator.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidator.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidator.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreClassificationValidator.java @@ -85,7 +85,7 @@ private void validateLabel(String label) { } private void validateRiskScoreValueBounds(int value) { - if (!RiskScoreValidator.isInBounds(value)) { + if (!RiskScoreValidator.isWithinBounds(value)) { errors.add( new ValidationError(CONFIG_PREFIX + "risk-classes.[minRiskLevel|maxRiskLevel]", value, VALUE_OUT_OF_BOUNDS)); } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreValidator.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreValidator.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreValidator.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/RiskScoreValidator.java @@ -33,9 +33,9 @@ private RiskScoreValidator() { * Validates the bounds of a risk score value. * * @param value the risk score value - * @return true if is in bounds, false otherwise + * @return true if value is within bounds, false otherwise */ - public static boolean isInBounds(int value) { + public static boolean isWithinBounds(int value) { return ParameterSpec.RISK_SCORE_MIN <= value && value <= ParameterSpec.RISK_SCORE_MAX; } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ValidationError.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ValidationError.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ValidationError.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ValidationError.java @@ -79,7 +79,6 @@ public enum ErrorType { VALUE_OUT_OF_BOUNDS, INVALID_URL, INVALID_PARTITIONING, - TOO_MANY_DECIMAL_PLACES, - MISSING_ENTRY + TOO_MANY_DECIMAL_PLACES } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/AppConfigurationStructureProvider.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/AppConfigurationStructureProvider.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/AppConfigurationStructureProvider.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/AppConfigurationStructureProvider.java @@ -20,6 +20,7 @@ package app.coronawarn.server.services.distribution.assembly.component; +import app.coronawarn.server.common.protocols.internal.ApplicationConfiguration; import app.coronawarn.server.services.distribution.assembly.appconfig.structure.directory.AppConfigurationDirectory; import app.coronawarn.server.services.distribution.assembly.structure.WritableOnDisk; import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; @@ -35,14 +36,16 @@ public class AppConfigurationStructureProvider { private final CryptoProvider cryptoProvider; private final DistributionServiceConfig distributionServiceConfig; + private final ApplicationConfiguration applicationConfiguration; - AppConfigurationStructureProvider(CryptoProvider cryptoProvider, - DistributionServiceConfig distributionServiceConfig) { + AppConfigurationStructureProvider(CryptoProvider cryptoProvider, DistributionServiceConfig distributionServiceConfig, + ApplicationConfiguration applicationConfiguration) { this.cryptoProvider = cryptoProvider; this.distributionServiceConfig = distributionServiceConfig; + this.applicationConfiguration = applicationConfiguration; } public Directory<WritableOnDisk> getAppConfiguration() { - return new AppConfigurationDirectory(cryptoProvider, distributionServiceConfig); + return new AppConfigurationDirectory(applicationConfiguration, cryptoProvider, distributionServiceConfig); } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/CwaApiStructureProvider.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/CwaApiStructureProvider.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/CwaApiStructureProvider.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/component/CwaApiStructureProvider.java @@ -25,6 +25,7 @@ import app.coronawarn.server.services.distribution.assembly.structure.directory.IndexDirectoryOnDisk; import app.coronawarn.server.services.distribution.assembly.structure.directory.decorator.indexing.IndexingDecoratorOnDisk; import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import java.util.Optional; import java.util.Set; import org.springframework.stereotype.Component; @@ -34,13 +35,8 @@ @Component public class CwaApiStructureProvider { - public static final String VERSION_DIRECTORY = "version"; - public static final String VERSION_V1 = "v1"; - private final AppConfigurationStructureProvider appConfigurationStructureProvider; - private final DiagnosisKeysStructureProvider diagnosisKeysStructureProvider; - private final DistributionServiceConfig distributionServiceConfig; /** @@ -59,12 +55,15 @@ public class CwaApiStructureProvider { * Returns the base directory. */ public Directory<WritableOnDisk> getDirectory() { - IndexDirectoryOnDisk<String> versionDirectory = - new IndexDirectoryOnDisk<>(VERSION_DIRECTORY, __ -> Set.of(VERSION_V1), Object::toString); + IndexDirectoryOnDisk<String> versionDirectory = new IndexDirectoryOnDisk<>( + distributionServiceConfig.getApi().getVersionPath(), + ignoredValue -> Set.of(distributionServiceConfig.getApi().getVersionV1()), + Object::toString); - versionDirectory - .addWritableToAll(__ -> appConfigurationStructureProvider.getAppConfiguration()); - versionDirectory.addWritableToAll(__ -> diagnosisKeysStructureProvider.getDiagnosisKeys()); + versionDirectory.addWritableToAll(ignoredValue -> + Optional.of(appConfigurationStructureProvider.getAppConfiguration())); + versionDirectory.addWritableToAll(ignoredValue -> + Optional.of(diagnosisKeysStructureProvider.getDiagnosisKeys())); return new IndexingDecoratorOnDisk<>(versionDirectory, distributionServiceConfig.getOutputFileName()); } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/DiagnosisKeyBundler.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/DiagnosisKeyBundler.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/DiagnosisKeyBundler.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/DiagnosisKeyBundler.java @@ -95,6 +95,13 @@ public void setDiagnosisKeys(Collection<DiagnosisKey> diagnosisKeys, LocalDateTi this.createDiagnosisKeyDistributionMap(diagnosisKeys); } + /** + * Returns the {@link LocalDateTime} at which the distribution runs. + */ + public LocalDateTime getDistributionTime() { + return this.distributionTime; + } + /** * Returns all {@link DiagnosisKey DiagnosisKeys} contained by this {@link DiagnosisKeyBundler}. */ diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/archive/decorator/singing/DiagnosisKeySigningDecorator.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/archive/decorator/signing/DiagnosisKeySigningDecorator.java similarity index 97% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/archive/decorator/singing/DiagnosisKeySigningDecorator.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/archive/decorator/signing/DiagnosisKeySigningDecorator.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/archive/decorator/singing/DiagnosisKeySigningDecorator.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/archive/decorator/signing/DiagnosisKeySigningDecorator.java @@ -18,7 +18,7 @@ * ---license-end */ -package app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.archive.decorator.singing; +package app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.archive.decorator.signing; import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; import app.coronawarn.server.services.distribution.assembly.structure.Writable; diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysCountryDirectory.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysCountryDirectory.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysCountryDirectory.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysCountryDirectory.java @@ -23,7 +23,6 @@ import app.coronawarn.server.common.persistence.domain.DiagnosisKey; import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.DiagnosisKeyBundler; -import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory.decorator.DateAggregatingDecorator; import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory.decorator.DateIndexingDecorator; import app.coronawarn.server.services.distribution.assembly.structure.WritableOnDisk; import app.coronawarn.server.services.distribution.assembly.structure.directory.IndexDirectory; @@ -31,6 +30,7 @@ import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; import java.time.LocalDate; +import java.util.Optional; import java.util.Set; public class DiagnosisKeysCountryDirectory extends IndexDirectoryOnDisk<String> { @@ -48,7 +48,7 @@ public class DiagnosisKeysCountryDirectory extends IndexDirectoryOnDisk<String> */ public DiagnosisKeysCountryDirectory(DiagnosisKeyBundler diagnosisKeyBundler, CryptoProvider cryptoProvider, DistributionServiceConfig distributionServiceConfig) { - super(distributionServiceConfig.getApi().getCountryPath(), __ -> + super(distributionServiceConfig.getApi().getCountryPath(), ignoredValue -> Set.of(distributionServiceConfig.getApi().getCountryGermany()), Object::toString); this.diagnosisKeyBundler = diagnosisKeyBundler; this.cryptoProvider = cryptoProvider; @@ -57,16 +57,12 @@ public DiagnosisKeysCountryDirectory(DiagnosisKeyBundler diagnosisKeyBundler, @Override public void prepare(ImmutableStack<Object> indices) { - this.addWritableToAll(__ -> { - DiagnosisKeysDateDirectory dateDirectory = new DiagnosisKeysDateDirectory(diagnosisKeyBundler, cryptoProvider, - distributionServiceConfig); - return decorateDateDirectory(dateDirectory); - }); + this.addWritableToAll(ignoredValue -> Optional.of(decorateDateDirectory( + new DiagnosisKeysDateDirectory(diagnosisKeyBundler, cryptoProvider, distributionServiceConfig)))); super.prepare(indices); } private IndexDirectory<LocalDate, WritableOnDisk> decorateDateDirectory(DiagnosisKeysDateDirectory dateDirectory) { - return new DateAggregatingDecorator(new DateIndexingDecorator(dateDirectory, distributionServiceConfig), - cryptoProvider, distributionServiceConfig, diagnosisKeyBundler); + return new DateIndexingDecorator(dateDirectory, distributionServiceConfig); } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectory.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectory.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectory.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectory.java @@ -20,17 +20,28 @@ package app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory; +import static java.lang.Boolean.FALSE; + import app.coronawarn.server.common.persistence.domain.DiagnosisKey; import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.DiagnosisKeyBundler; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.archive.decorator.signing.DiagnosisKeySigningDecorator; import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory.decorator.HourIndexingDecorator; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.file.TemporaryExposureKeyExportFile; +import app.coronawarn.server.services.distribution.assembly.structure.Writable; import app.coronawarn.server.services.distribution.assembly.structure.WritableOnDisk; +import app.coronawarn.server.services.distribution.assembly.structure.archive.Archive; +import app.coronawarn.server.services.distribution.assembly.structure.archive.ArchiveOnDisk; import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; import app.coronawarn.server.services.distribution.assembly.structure.directory.IndexDirectoryOnDisk; +import app.coronawarn.server.services.distribution.assembly.structure.file.File; import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; import java.time.LocalDate; +import java.time.ZoneOffset; import java.time.format.DateTimeFormatter; +import java.util.List; +import java.util.Optional; public class DiagnosisKeysDateDirectory extends IndexDirectoryOnDisk<LocalDate> { @@ -50,7 +61,7 @@ public class DiagnosisKeysDateDirectory extends IndexDirectoryOnDisk<LocalDate> public DiagnosisKeysDateDirectory(DiagnosisKeyBundler diagnosisKeyBundler, CryptoProvider cryptoProvider, DistributionServiceConfig distributionServiceConfig) { super(distributionServiceConfig.getApi().getDatePath(), - __ -> diagnosisKeyBundler.getDatesWithDistributableDiagnosisKeys(), ISO8601::format); + ignoredValue -> diagnosisKeyBundler.getDatesWithDistributableDiagnosisKeys(), ISO8601::format); this.cryptoProvider = cryptoProvider; this.diagnosisKeyBundler = diagnosisKeyBundler; this.distributionServiceConfig = distributionServiceConfig; @@ -58,15 +69,47 @@ public DiagnosisKeysDateDirectory(DiagnosisKeyBundler diagnosisKeyBundler, @Override public void prepare(ImmutableStack<Object> indices) { - this.addWritableToAll(__ -> { + this.addWritableToAll(ignoredValue -> { DiagnosisKeysHourDirectory hourDirectory = new DiagnosisKeysHourDirectory(diagnosisKeyBundler, cryptoProvider, distributionServiceConfig); - return decorateHourDirectory(hourDirectory); + return Optional.of(decorateHourDirectory(hourDirectory)); }); + this.addWritableToAll(this::indicesToDateDirectoryArchive); super.prepare(indices); } + private Optional<Writable<WritableOnDisk>> indicesToDateDirectoryArchive(ImmutableStack<Object> currentIndices) { + LocalDate currentDate = (LocalDate) currentIndices.peek(); + if (shouldNotInclude(currentDate)) { + return Optional.empty(); + } + String region = (String) currentIndices.pop().peek(); + + List<DiagnosisKey> diagnosisKeysForCurrentHour = + this.diagnosisKeyBundler.getDiagnosisKeysForDate(currentDate); + + long startTimestamp = currentDate.atStartOfDay().toEpochSecond(ZoneOffset.UTC); + long endTimestamp = currentDate.plusDays(1).atStartOfDay().toEpochSecond(ZoneOffset.UTC); + + File<WritableOnDisk> temporaryExposureKeyExportFile = TemporaryExposureKeyExportFile.fromDiagnosisKeys( + diagnosisKeysForCurrentHour, region, startTimestamp, endTimestamp, distributionServiceConfig); + + Archive<WritableOnDisk> dateArchive = new ArchiveOnDisk(distributionServiceConfig.getOutputFileName()); + dateArchive.addWritable(temporaryExposureKeyExportFile); + + return Optional.of(decorateDiagnosisKeyArchive(dateArchive)); + } + + private boolean shouldNotInclude(LocalDate currentDate) { + return FALSE.equals(distributionServiceConfig.getIncludeIncompleteDays()) + && currentDate.equals(diagnosisKeyBundler.getDistributionTime().toLocalDate()); + } + private Directory<WritableOnDisk> decorateHourDirectory(DiagnosisKeysHourDirectory hourDirectory) { return new HourIndexingDecorator(hourDirectory, distributionServiceConfig); } + + private Directory<WritableOnDisk> decorateDiagnosisKeyArchive(Archive<WritableOnDisk> archive) { + return new DiagnosisKeySigningDecorator(archive, cryptoProvider, distributionServiceConfig); + } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectory.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectory.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectory.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectory.java @@ -23,7 +23,7 @@ import app.coronawarn.server.common.persistence.domain.DiagnosisKey; import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.DiagnosisKeyBundler; -import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.archive.decorator.singing.DiagnosisKeySigningDecorator; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.archive.decorator.signing.DiagnosisKeySigningDecorator; import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.file.TemporaryExposureKeyExportFile; import app.coronawarn.server.services.distribution.assembly.structure.WritableOnDisk; import app.coronawarn.server.services.distribution.assembly.structure.archive.Archive; @@ -37,6 +37,7 @@ import java.time.LocalDateTime; import java.time.ZoneOffset; import java.util.List; +import java.util.Optional; public class DiagnosisKeysHourDirectory extends IndexDirectoryOnDisk<LocalDateTime> { @@ -80,7 +81,7 @@ public void prepare(ImmutableStack<Object> indices) { Archive<WritableOnDisk> hourArchive = new ArchiveOnDisk(distributionServiceConfig.getOutputFileName()); hourArchive.addWritable(temporaryExposureKeyExportFile); - return decorateDiagnosisKeyArchive(hourArchive); + return Optional.of(decorateDiagnosisKeyArchive(hourArchive)); }); super.prepare(indices); } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/DateAggregatingDecorator.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/DateAggregatingDecorator.java deleted file mode 100644 --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/DateAggregatingDecorator.java +++ /dev/null @@ -1,202 +0,0 @@ -/*- - * ---license-start - * Corona-Warn-App - * --- - * Copyright (C) 2020 SAP SE and all other contributors - * --- - * 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 - * - * http://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. - * ---license-end - */ - -package app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory.decorator; - -import static app.coronawarn.server.services.distribution.assembly.structure.util.functional.CheckedFunction.uncheckedFunction; - -import app.coronawarn.server.common.protocols.external.exposurenotification.TemporaryExposureKey; -import app.coronawarn.server.common.protocols.external.exposurenotification.TemporaryExposureKeyExport; -import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; -import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.DiagnosisKeyBundler; -import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.archive.decorator.singing.DiagnosisKeySigningDecorator; -import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.file.TemporaryExposureKeyExportFile; -import app.coronawarn.server.services.distribution.assembly.structure.Writable; -import app.coronawarn.server.services.distribution.assembly.structure.WritableOnDisk; -import app.coronawarn.server.services.distribution.assembly.structure.archive.Archive; -import app.coronawarn.server.services.distribution.assembly.structure.archive.ArchiveOnDisk; -import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; -import app.coronawarn.server.services.distribution.assembly.structure.directory.DirectoryOnDisk; -import app.coronawarn.server.services.distribution.assembly.structure.directory.IndexDirectory; -import app.coronawarn.server.services.distribution.assembly.structure.directory.decorator.DirectoryDecorator; -import app.coronawarn.server.services.distribution.assembly.structure.directory.decorator.IndexDirectoryDecorator; -import app.coronawarn.server.services.distribution.assembly.structure.file.File; -import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; -import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; -import java.time.LocalDate; -import java.util.List; -import java.util.NoSuchElementException; -import java.util.Optional; -import java.util.Set; -import java.util.stream.Collectors; -import java.util.stream.Stream; - -/** - * A {@link DirectoryDecorator} that will bundle hour aggregates into date aggregates and sign them. - */ -public class DateAggregatingDecorator extends IndexDirectoryDecorator<LocalDate, WritableOnDisk> { - - private final CryptoProvider cryptoProvider; - private final DistributionServiceConfig distributionServiceConfig; - private final DiagnosisKeyBundler diagnosisKeyBundler; - - /** - * Creates a new DateAggregatingDecorator. - */ - public DateAggregatingDecorator(IndexDirectory<LocalDate, WritableOnDisk> directory, CryptoProvider cryptoProvider, - DistributionServiceConfig distributionServiceConfig, DiagnosisKeyBundler diagnosisKeyBundler) { - super(directory); - this.cryptoProvider = cryptoProvider; - this.distributionServiceConfig = distributionServiceConfig; - this.diagnosisKeyBundler = diagnosisKeyBundler; - } - - @Override - public void prepare(ImmutableStack<Object> indices) { - super.prepare(indices); - Set<Directory<WritableOnDisk>> dayDirectories = this.getWritables().stream() - .filter(writable -> writable instanceof DirectoryOnDisk) - .map(directory -> (DirectoryOnDisk) directory) - .collect(Collectors.toSet()); - if (dayDirectories.isEmpty()) { - return; - } - - Set<String> dates = this.getIndex(indices).stream() - .filter(diagnosisKeyBundler::numberOfKeysForDateBelowMaximum) - .map(this.getIndexFormatter()) - .map(Object::toString) - .collect(Collectors.toSet()); - - dayDirectories.stream() - .filter(dayDirectory -> dates.contains(dayDirectory.getName())) - .forEach(currentDirectory -> Stream.of(currentDirectory) - .map(this::getSubSubDirectoryArchives) - .map(this::getTemporaryExposureKeyExportFilesFromArchives) - .map(this::parseTemporaryExposureKeyExportsFromFiles) - .map(this::reduceTemporaryExposureKeyExportsToNewFile) - .map(temporaryExposureKeyExportFile -> { - Archive<WritableOnDisk> aggregate = new ArchiveOnDisk(distributionServiceConfig.getOutputFileName()); - aggregate.addWritable(temporaryExposureKeyExportFile); - return aggregate; - }) - .map(file -> new DiagnosisKeySigningDecorator(file, cryptoProvider, distributionServiceConfig)) - .forEach(aggregate -> { - currentDirectory.addWritable(aggregate); - aggregate.prepare(indices); - }) - ); - } - - /** - * Returns all archives that are 3 levels down from the root directory. - */ - private Set<Archive<WritableOnDisk>> getSubSubDirectoryArchives(Directory<WritableOnDisk> rootDirectory) { - return getWritablesInDirectory(rootDirectory, 3).stream() - .filter(Writable::isArchive) - .map(archive -> (Archive<WritableOnDisk>) archive) - .collect(Collectors.toSet()); - } - - /** - * Traverses a directory {@code depth} levels deep and returns a flattened list of all writables at that depth. A - * {@code depth} of 0 or less returns a set only containing the root directory. A depth of 1 returns a set of - * writables in the root directory. A depth of 2 returns a set of all writables in all directories in the root - * directory, and so on. - * - * @param rootDirectory The directory in which to start traversal. - * @param depth The depth to traverse. - * @return All writables that are {@code depth} levels down. - */ - private Set<Writable<WritableOnDisk>> getWritablesInDirectory(Directory<WritableOnDisk> rootDirectory, int depth) { - if (depth <= 0) { - return Set.of(rootDirectory); - } else if (depth == 1) { - return rootDirectory.getWritables(); - } else { - return rootDirectory.getWritables().stream() - .filter(Writable::isDirectory) - .flatMap(directory -> getWritablesInDirectory((Directory<WritableOnDisk>) directory, depth - 1).stream()) - .collect(Collectors.toSet()); - } - } - - private Set<TemporaryExposureKeyExportFile> getTemporaryExposureKeyExportFilesFromArchives( - Set<Archive<WritableOnDisk>> hourArchives) { - return hourArchives.stream() - .map(Directory::getWritables) - .map(writables -> writables.stream() - .filter(writable -> writable.getName().equals("export.bin"))) - .map(Stream::findFirst) - .map(Optional::orElseThrow) - .filter(writable -> writable instanceof File) - .map(file -> (TemporaryExposureKeyExportFile) file) - .collect(Collectors.toSet()); - } - - private Set<TemporaryExposureKeyExport> parseTemporaryExposureKeyExportsFromFiles( - Set<TemporaryExposureKeyExportFile> temporaryExposureKeyExportFiles) { - return temporaryExposureKeyExportFiles.stream() - .map(TemporaryExposureKeyExportFile::getBytesWithoutHeader) - .map(uncheckedFunction(TemporaryExposureKeyExport::parseFrom)) - .collect(Collectors.toSet()); - } - - private TemporaryExposureKeyExportFile reduceTemporaryExposureKeyExportsToNewFile( - Set<TemporaryExposureKeyExport> temporaryExposureKeyExports) { - return TemporaryExposureKeyExportFile.fromTemporaryExposureKeys( - getTemporaryExposureKeys(temporaryExposureKeyExports), - getRegion(temporaryExposureKeyExports), - getStartTimestamp(temporaryExposureKeyExports), - getEndTimestamp(temporaryExposureKeyExports), - distributionServiceConfig - ); - } - - private static Set<TemporaryExposureKey> getTemporaryExposureKeys( - Set<TemporaryExposureKeyExport> temporaryExposureKeyExports) { - return temporaryExposureKeyExports.stream() - .map(TemporaryExposureKeyExport::getKeysList) - .flatMap(List::stream) - .collect(Collectors.toSet()); - } - - private static String getRegion(Set<TemporaryExposureKeyExport> temporaryExposureKeyExports) { - return temporaryExposureKeyExports.stream() - .map(TemporaryExposureKeyExport::getRegion) - .findAny() - .orElseThrow(NoSuchElementException::new); - } - - private static long getStartTimestamp( - Set<TemporaryExposureKeyExport> temporaryExposureKeyExports) { - return temporaryExposureKeyExports.stream() - .mapToLong(TemporaryExposureKeyExport::getStartTimestamp) - .min() - .orElseThrow(NoSuchElementException::new); - } - - private static long getEndTimestamp(Set<TemporaryExposureKeyExport> temporaryExposureKeyExports) { - return temporaryExposureKeyExports.stream() - .mapToLong(TemporaryExposureKeyExport::getEndTimestamp) - .max() - .orElseThrow(NoSuchElementException::new); - } -} diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectory.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectory.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectory.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectory.java @@ -49,8 +49,8 @@ public interface IndexDirectory<T, W extends Writable<W>> extends Directory<W> { * Calls the {@link app.coronawarn.server.services.distribution.assembly.structure.util.functional.IndexFunction} with * the {@code indices} to calculate and return the elements of the index of this {@link IndexDirectory}. * - * @param indices A {@link Stack} of parameters from all {@link IndexDirectory IndexDirectories} further up in the - * hierarchy. The Stack may contain different types, depending on the types {@code T} of {@link + * @param indices A {@link ImmutableStack} of parameters from all {@link IndexDirectory IndexDirectories} further up + * in the hierarchy. The Stack may contain different types, depending on the types {@code T} of {@link * IndexDirectory IndexDirectories} further up in the hierarchy. */ Set<T> getIndex(ImmutableStack<Object> indices); diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectoryOnDisk.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectoryOnDisk.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectoryOnDisk.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectoryOnDisk.java @@ -27,6 +27,7 @@ import app.coronawarn.server.services.distribution.assembly.structure.util.functional.IndexFunction; import app.coronawarn.server.services.distribution.assembly.structure.util.functional.WritableFunction; import java.util.HashSet; +import java.util.Optional; import java.util.Set; /** @@ -74,9 +75,9 @@ public void addWritableToAll(WritableFunction<WritableOnDisk> writableFunction) } /** - * Creates a new subdirectory for every element of the {@link IndexDirectory#getIndex index} and writes all its - * {@link IndexDirectory#addWritableToAll writables} to those. The respective element of the index will be pushed - * onto the Stack for subsequent {@link Writable#prepare} calls. + * Creates a new subdirectory for every element of the {@link IndexDirectory#getIndex index} and writes all its {@link + * IndexDirectory#addWritableToAll writables} to those. The respective element of the index will be pushed onto the + * Stack for subsequent {@link Writable#prepare} calls. * * @param indices A {@link ImmutableStack} of parameters from all {@link IndexDirectory IndexDirectories} further up * in the hierarchy. The Stack may contain different types, depending on the types {@code T} of {@link @@ -104,9 +105,11 @@ private DirectoryOnDisk makeSubDirectory(T index) { private void prepareMetaWritables(ImmutableStack<Object> indices, DirectoryOnDisk target) { this.metaWritables.forEach(metaWritableFunction -> { - Writable<WritableOnDisk> newWritable = metaWritableFunction.apply(indices); - target.addWritable(newWritable); - newWritable.prepare(indices); + Optional<Writable<WritableOnDisk>> maybeNewWritable = metaWritableFunction.apply(indices); + maybeNewWritable.ifPresent(newWritable -> { + target.addWritable(newWritable); + newWritable.prepare(indices); + }); }); } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/decorator/indexing/IndexingDecoratorOnDisk.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/decorator/indexing/IndexingDecoratorOnDisk.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/decorator/indexing/IndexingDecoratorOnDisk.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/directory/decorator/indexing/IndexingDecoratorOnDisk.java @@ -25,6 +25,7 @@ import app.coronawarn.server.services.distribution.assembly.structure.file.FileOnDisk; import app.coronawarn.server.services.distribution.assembly.structure.file.FileOnDiskWithChecksum; import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; +import java.nio.charset.StandardCharsets; import java.util.List; import java.util.Set; import java.util.stream.Collectors; @@ -46,6 +47,6 @@ public FileOnDisk getIndexFile(String indexFileName, ImmutableStack<Object> indi .sorted() .collect(Collectors.toList()); array.addAll(elements); - return new FileOnDiskWithChecksum(indexFileName, array.toJSONString().getBytes()); + return new FileOnDiskWithChecksum(indexFileName, array.toJSONString().getBytes(StandardCharsets.UTF_8)); } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/util/functional/WritableFunction.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/util/functional/WritableFunction.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/util/functional/WritableFunction.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/structure/util/functional/WritableFunction.java @@ -22,6 +22,7 @@ import app.coronawarn.server.services.distribution.assembly.structure.Writable; import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; +import java.util.Optional; import java.util.function.Function; /** @@ -30,7 +31,8 @@ * @param <T> The specific type of {@link Writable} that this {@link WritableFunction} can create. */ @FunctionalInterface -public interface WritableFunction<T extends Writable<T>> extends Function<ImmutableStack<Object>, Writable<T>> { +public interface WritableFunction<T extends Writable<T>> extends + Function<ImmutableStack<Object>, Optional<Writable<T>>> { - Writable<T> apply(ImmutableStack<Object> t); + Optional<Writable<T>> apply(ImmutableStack<Object> t); } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/config/DistributionServiceConfig.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/config/DistributionServiceConfig.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/config/DistributionServiceConfig.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/config/DistributionServiceConfig.java @@ -404,6 +404,7 @@ public static class ObjectStore { private String bucket; private Boolean setPublicReadAclOnPutObject; private Integer maxNumberOfFailedOperations; + private Integer maxNumberOfS3Threads; public String getAccessKey() { return accessKey; @@ -460,5 +461,13 @@ public Integer getMaxNumberOfFailedOperations() { public void setMaxNumberOfFailedOperations(Integer maxNumberOfFailedOperations) { this.maxNumberOfFailedOperations = maxNumberOfFailedOperations; } + + public Integer getMaxNumberOfS3Threads() { + return maxNumberOfS3Threads; + } + + public void setMaxNumberOfS3Threads(Integer maxNumberOfS3Threads) { + this.maxNumberOfS3Threads = maxNumberOfS3Threads; + } } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccess.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccess.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccess.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccess.java @@ -140,6 +140,8 @@ private Map<HeaderKey, String> createHeaders(int maxAge, LocalFile file) { headers.put(HeaderKey.CWA_HASH, file.getChecksum()); } + headers.put(HeaderKey.CONTENT_TYPE, file.getContentType()); + return headers; } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3Publisher.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3Publisher.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3Publisher.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3Publisher.java @@ -20,7 +20,7 @@ package app.coronawarn.server.services.distribution.objectstore; -import app.coronawarn.server.services.distribution.assembly.component.CwaApiStructureProvider; +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; import app.coronawarn.server.services.distribution.objectstore.client.ObjectStoreOperationFailedException; import app.coronawarn.server.services.distribution.objectstore.publish.LocalFile; import app.coronawarn.server.services.distribution.objectstore.publish.PublishFileSet; @@ -28,13 +28,16 @@ import java.io.IOException; import java.nio.file.Path; import java.util.List; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.Future; import java.util.stream.Collectors; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor; +import org.springframework.stereotype.Component; /** - * Publishes a folder on the disk to S3 while keeping the folder and file structure.<br> - * Moreover, does the following: + * Publishes a folder on the disk to S3 while keeping the folder and file structure.<br> Moreover, does the following: * <br> * <ul> * <li>Publishes index files on a different route, removing the trailing "/index" part.</li> @@ -46,47 +49,49 @@ * <li>Currently not implemented: Supports multi threaded upload of files.</li> * </ul> */ +@Component public class S3Publisher { private static final Logger logger = LoggerFactory.getLogger(S3Publisher.class); - /** - * The default CWA root folder, which contains all CWA related files. - */ - private static final String CWA_S3_ROOT = CwaApiStructureProvider.VERSION_DIRECTORY; - - private final Path root; private final ObjectStoreAccess objectStoreAccess; private final FailedObjectStoreOperationsCounter failedOperationsCounter; + private final ThreadPoolTaskExecutor executor; + private final DistributionServiceConfig distributionServiceConfig; /** * Creates an {@link S3Publisher} instance that attempts to publish the files at the specified location to an object * store. Object store operations are performed through the specified {@link ObjectStoreAccess} instance. * - * @param root The path of the directory that shall be published. - * @param objectStoreAccess The {@link ObjectStoreAccess} used to communicate with the object store. - * @param failedOperationsCounter The {@link FailedObjectStoreOperationsCounter} that is used to monitor the number of - * failed operations. + * @param objectStoreAccess The {@link ObjectStoreAccess} used to communicate with the object store. + * @param failedOperationsCounter The {@link FailedObjectStoreOperationsCounter} that is used to monitor the number + * of failed operations. + * @param executor The executor that manages the upload task submission. + * @param distributionServiceConfig The {@link DistributionServiceConfig} used for distribution service + * configuration. */ - public S3Publisher(Path root, ObjectStoreAccess objectStoreAccess, - FailedObjectStoreOperationsCounter failedOperationsCounter) { - this.root = root; + public S3Publisher(ObjectStoreAccess objectStoreAccess, FailedObjectStoreOperationsCounter failedOperationsCounter, + ThreadPoolTaskExecutor executor, DistributionServiceConfig distributionServiceConfig) { this.objectStoreAccess = objectStoreAccess; this.failedOperationsCounter = failedOperationsCounter; + this.executor = executor; + this.distributionServiceConfig = distributionServiceConfig; } /** * Synchronizes the files to S3. * + * @param root The path of the directory that shall be published. * @throws IOException in case there were problems reading files from the disk. */ - public void publish() throws IOException { + public void publish(Path root) throws IOException { PublishedFileSet published; List<LocalFile> toPublish = new PublishFileSet(root).getFiles(); List<LocalFile> diff; try { - published = new PublishedFileSet(objectStoreAccess.getObjectsWithPrefix(CWA_S3_ROOT)); + published = new PublishedFileSet( + objectStoreAccess.getObjectsWithPrefix(distributionServiceConfig.getApi().getVersionPath())); diff = toPublish .stream() .filter(published::isNotYetPublished) @@ -97,14 +102,25 @@ public void publish() throws IOException { diff = toPublish; } - logger.info("Beginning upload... "); - for (LocalFile file : diff) { - try { - this.objectStoreAccess.putObject(file); - } catch (ObjectStoreOperationFailedException e) { - failedOperationsCounter.incrementAndCheckThreshold(e); - } + logger.info("Beginning upload of {} files... ", diff.size()); + try { + diff.stream() + .map(file -> executor.submit(() -> objectStoreAccess.putObject(file))) + .forEach(this::awaitThread); + } finally { + executor.shutdown(); } logger.info("Upload completed."); } + + private void awaitThread(Future<?> result) { + try { + result.get(); + } catch (ExecutionException e) { + failedOperationsCounter.incrementAndCheckThreshold(new ObjectStoreOperationFailedException(e.getMessage(), e)); + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + throw new ObjectStoreOperationFailedException(e.getMessage(), e); + } + } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3RetentionPolicy.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3RetentionPolicy.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3RetentionPolicy.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3RetentionPolicy.java @@ -58,7 +58,8 @@ public S3RetentionPolicy(ObjectStoreAccess objectStoreAccess, DistributionServic * @param retentionDays the number of days, that files should be retained on S3. */ public void applyRetentionPolicy(int retentionDays) { - List<S3Object> diagnosisKeysObjects = objectStoreAccess.getObjectsWithPrefix("version/v1/" + List<S3Object> diagnosisKeysObjects = objectStoreAccess.getObjectsWithPrefix(api.getVersionPath() + "/" + + api.getVersionV1() + "/" + api.getDiagnosisKeysPath() + "/" + api.getCountryPath() + "/" + api.getCountryGermany() + "/" diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/ObjectStoreClient.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/ObjectStoreClient.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/ObjectStoreClient.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/ObjectStoreClient.java @@ -74,7 +74,11 @@ public interface ObjectStoreClient { enum HeaderKey { CACHE_CONTROL("Cache-Control"), AMZ_ACL("x-amz-acl"), - CWA_HASH("cwa-hash"); + CWA_HASH("cwa-hash"), + /** + * To control which content type is sent, when objects are retrieved from the object store. + */ + CONTENT_TYPE("Content-Type"); public final String keyValue; diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/ObjectStoreClientConfig.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/ObjectStorePublishingConfig.java similarity index 77% rename from services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/ObjectStoreClientConfig.java rename to services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/ObjectStorePublishingConfig.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/ObjectStoreClientConfig.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/ObjectStorePublishingConfig.java @@ -26,6 +26,7 @@ import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.retry.annotation.EnableRetry; +import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor; import software.amazon.awssdk.auth.credentials.AwsBasicCredentials; import software.amazon.awssdk.auth.credentials.AwsCredentialsProvider; import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider; @@ -37,7 +38,7 @@ */ @Configuration @EnableRetry -public class ObjectStoreClientConfig { +public class ObjectStorePublishingConfig { private static final Region DEFAULT_REGION = Region.EU_CENTRAL_1; @@ -61,4 +62,17 @@ private ObjectStoreClient createClient(ObjectStore objectStore) { private String removeTrailingSlash(String string) { return string.endsWith("/") ? string.substring(0, string.length() - 1) : string; } + + /** + * Creates a {@link ThreadPoolTaskExecutor}, which is used to submit object store upload tasks. + */ + @Bean + public ThreadPoolTaskExecutor createExecutor(DistributionServiceConfig distributionServiceConfig) { + ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor(); + executor.setCorePoolSize(distributionServiceConfig.getObjectStore().getMaxNumberOfS3Threads()); + executor.setMaxPoolSize(distributionServiceConfig.getObjectStore().getMaxNumberOfS3Threads()); + executor.setThreadNamePrefix("object-store-operation-worker-"); + executor.initialize(); + return executor; + } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapper.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapper.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapper.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapper.java @@ -20,9 +20,11 @@ package app.coronawarn.server.services.distribution.objectstore.client; +import static java.lang.Boolean.TRUE; import static java.util.stream.Collectors.toList; import java.nio.file.Path; +import java.util.ArrayList; import java.util.Collection; import java.util.List; import java.util.Map; @@ -78,13 +80,20 @@ public boolean bucketExists(String bucketName) { backoff = @Backoff(delayExpression = "${services.distribution.objectstore.retry-backoff}")) public List<S3Object> getObjects(String bucket, String prefix) { logRetryStatus("object download"); - - ListObjectsV2Response response = - s3Client.listObjectsV2(ListObjectsV2Request.builder().prefix(prefix).bucket(bucket).build()); - - return response.contents().stream() - .map(s3Object -> buildS3Object(s3Object, bucket)) - .collect(toList()); + List<S3Object> allS3Objects = new ArrayList<>(); + String continuationToken = null; + + do { + ListObjectsV2Request request = + ListObjectsV2Request.builder().prefix(prefix).bucket(bucket).continuationToken(continuationToken).build(); + ListObjectsV2Response response = s3Client.listObjectsV2(request); + response.contents().stream() + .map(s3Object -> buildS3Object(s3Object, bucket)) + .forEach(allS3Objects::add); + continuationToken = TRUE.equals(response.isTruncated()) ? response.continuationToken() : null; + } while (continuationToken != null); + + return allS3Objects; } @Recover @@ -109,6 +118,9 @@ public void putObject(String bucket, String objectName, Path filePath, Map<Heade if (headers.containsKey(HeaderKey.CWA_HASH)) { requestBuilder.metadata(Map.of(HeaderKey.CWA_HASH.withMetaPrefix(), headers.get(HeaderKey.CWA_HASH))); } + if (headers.containsKey(HeaderKey.CONTENT_TYPE)) { + requestBuilder.contentType(headers.get(HeaderKey.CONTENT_TYPE)); + } RequestBody bodyFile = RequestBody.fromFile(filePath); s3Client.putObject(requestBuilder.build(), bodyFile); diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/LocalFile.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/LocalFile.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/LocalFile.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/LocalFile.java @@ -86,4 +86,22 @@ protected String createS3Key(Path file, Path rootFolder) { Path relativePath = rootFolder.relativize(file); return relativePath.toString().replaceAll("\\\\", "/"); } + + /** + * Value for the <code>content-type</code> header. + * + * @return Either <a href="https://www.iana.org/assignments/media-types/application/zip">zip</a> or + * <a href="https://www.iana.org/assignments/media-types/application/json">json</a>. + */ + public String getContentType() { + if (s3Key.endsWith("app_config")) { + return "application/zip"; + } + if (s3Key.matches(".*\\d")) { + // date and hourly diagnosis key files + return "application/zip"; + } + // list of versions, dates, hours + return "application/json"; + } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/LocalIndexFile.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/LocalIndexFile.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/LocalIndexFile.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/LocalIndexFile.java @@ -29,7 +29,7 @@ * those files easier for the consumers. Index files are assembled with the name "index", but should * be published on S3 w/o the index part, to make e.g.: * <br> - * /diagnosis-keys/date/2020-12-12/index -> /diagnosis-keys/date/2020-12-12 + * /diagnosis-keys/date/2020-12-12/index is published to /diagnosis-keys/date/2020-12-12 */ public class LocalIndexFile extends LocalFile { diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/PublishedFileSet.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/PublishedFileSet.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/PublishedFileSet.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/PublishedFileSet.java @@ -54,7 +54,7 @@ public PublishedFileSet(List<S3Object> s3Objects) { * </ul> * * @param file the to-be-published file which should be checked - * @return true, if it exists & is identical + * @return true, if it exists and is identical */ public boolean isNotYetPublished(LocalFile file) { S3Object published = s3Objects.get(file.getS3Key()); diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/S3Distribution.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/S3Distribution.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/S3Distribution.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/S3Distribution.java @@ -21,8 +21,6 @@ package app.coronawarn.server.services.distribution.runner; import app.coronawarn.server.services.distribution.assembly.component.OutputDirectoryProvider; -import app.coronawarn.server.services.distribution.objectstore.FailedObjectStoreOperationsCounter; -import app.coronawarn.server.services.distribution.objectstore.ObjectStoreAccess; import app.coronawarn.server.services.distribution.objectstore.S3Publisher; import app.coronawarn.server.services.distribution.objectstore.client.ObjectStoreOperationFailedException; import java.io.IOException; @@ -44,23 +42,19 @@ public class S3Distribution implements ApplicationRunner { private static final Logger logger = LoggerFactory.getLogger(S3Distribution.class); private final OutputDirectoryProvider outputDirectoryProvider; - private final ObjectStoreAccess objectStoreAccess; - private final FailedObjectStoreOperationsCounter failedOperationsCounter; + private final S3Publisher s3Publisher; - S3Distribution(OutputDirectoryProvider outputDirectoryProvider, ObjectStoreAccess objectStoreAccess, - FailedObjectStoreOperationsCounter failedOperationsCounter) { + S3Distribution(OutputDirectoryProvider outputDirectoryProvider, S3Publisher s3Publisher) { this.outputDirectoryProvider = outputDirectoryProvider; - this.objectStoreAccess = objectStoreAccess; - this.failedOperationsCounter = failedOperationsCounter; + this.s3Publisher = s3Publisher; } @Override public void run(ApplicationArguments args) { try { Path pathToDistribute = outputDirectoryProvider.getFileOnDisk().toPath().toAbsolutePath(); - S3Publisher s3Publisher = new S3Publisher(pathToDistribute, objectStoreAccess, failedOperationsCounter); - s3Publisher.publish(); + s3Publisher.publish(pathToDistribute); logger.info("Data pushed to Object Store successfully."); } catch (UnsupportedOperationException | ObjectStoreOperationFailedException | IOException e) { logger.error("Distribution failed.", e); diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/TestDataGeneration.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/TestDataGeneration.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/TestDataGeneration.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/TestDataGeneration.java @@ -114,7 +114,7 @@ private void writeTestData() { logger.debug("Generating diagnosis keys between {} and {}...", startTimestamp, endTimestamp); List<DiagnosisKey> newDiagnosisKeys = LongStream.range(startTimestamp, endTimestamp) .mapToObj(submissionTimestamp -> IntStream.range(0, poisson.sample()) - .mapToObj(__ -> generateDiagnosisKey(submissionTimestamp)) + .mapToObj(ignoredValue -> generateDiagnosisKey(submissionTimestamp)) .collect(Collectors.toList())) .flatMap(List::stream) .collect(Collectors.toList()); diff --git a/services/distribution/src/main/resources/application-cloud.yaml b/services/distribution/src/main/resources/application-cloud.yaml --- a/services/distribution/src/main/resources/application-cloud.yaml +++ b/services/distribution/src/main/resources/application-cloud.yaml @@ -1,13 +1,10 @@ --- spring: flyway: - enabled: true - locations: classpath:db/migration/postgres password: ${POSTGRESQL_PASSWORD_FLYWAY} user: ${POSTGRESQL_USER_FLYWAY} datasource: driver-class-name: org.postgresql.Driver - url: jdbc:postgresql://${POSTGRESQL_SERVICE_HOST}:${POSTGRESQL_SERVICE_PORT}/${POSTGRESQL_DATABASE} username: ${POSTGRESQL_USER_DISTRIBUTION} password: ${POSTGRESQL_PASSWORD_DISTRIBUTION} diff --git a/services/distribution/src/main/resources/application-disable-ssl-client-postgres.yaml b/services/distribution/src/main/resources/application-disable-ssl-client-postgres.yaml new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/resources/application-disable-ssl-client-postgres.yaml @@ -0,0 +1,4 @@ +--- +spring: + datasource: + url: jdbc:postgresql://${POSTGRESQL_SERVICE_HOST:localhost}:${POSTGRESQL_SERVICE_PORT:5432}/${POSTGRESQL_DATABASE:cwa} diff --git a/services/distribution/src/main/resources/application-ssl-client-postgres.yaml b/services/distribution/src/main/resources/application-ssl-client-postgres.yaml deleted file mode 100644 --- a/services/distribution/src/main/resources/application-ssl-client-postgres.yaml +++ /dev/null @@ -1,4 +0,0 @@ ---- -spring: - datasource: - url: jdbc:postgresql://${POSTGRESQL_SERVICE_HOST}:${POSTGRESQL_SERVICE_PORT}/${POSTGRESQL_DATABASE}?ssl=true&sslmode=verify-full&sslrootcert=${SSL_POSTGRES_CERTIFICATE_PATH}&sslcert=${SSL_SUBMISSION_CERTIFICATE_PATH}&sslkey=${SSL_SUBMISSION_PRIVATE_KEY_PATH} diff --git a/services/distribution/src/main/resources/application.yaml b/services/distribution/src/main/resources/application.yaml --- a/services/distribution/src/main/resources/application.yaml +++ b/services/distribution/src/main/resources/application.yaml @@ -9,20 +9,35 @@ logging: services: distribution: + # The name of the distribution output file. output-file-name: index + # The number of days to retain diagnosis keys for both database persistency layer and files stored on the object store. retention-days: 14 + # The number of minutes that diagnosis keys must have been expired for (since the end of the rolling interval window) before they can be distributed. expiry-policy-minutes: 120 + # The minimum number of diagnosis keys per bundle. shifting-policy-threshold: 140 + # The maximum number of keys per bundle. maximum-number-of-keys-per-bundle: 600000 + # Indicates whether the current incomplete day will be included in the distribution (used for testing purposes). include-incomplete-days: false + # Indicates whether the current incomplete hour will be included in the distribution (used for testing purposes). include-incomplete-hours: false + # Local paths, that are used during the export creation. paths: + # The output path. output: out + # The location of the private key. privatekey: ${VAULT_FILESIGNING_SECRET} + # Configuration for the exported archive, that is saved on the S3-compatible storage. tek-export: + # The TEK file name included in the zip archive, containing the list of diagnosis keys. file-name: export.bin + # The TEK file header. file-header: EK Export v1 + # The fixed (ensured by right whitespace padding) TEK file header width. file-header-width: 16 + # Configuration for the API which is used by the mobile app to query diagnosis keys. api: version-path: version version-v1: v1 @@ -33,40 +48,50 @@ services: diagnosis-keys-path: diagnosis-keys parameters-path: configuration app-config-file-name: app_config + # Signature configuration, used for signing the exports. signature: + # The alias with which to identify public key to be used for verification. verification-key-id: 262 + # The key version for rollovers. verification-key-version: v1 + # The ASN.1 OID for algorithm identifier. algorithm-oid: 1.2.840.10045.4.3.2 + # The algorithm name. algorithm-name: SHA256withECDSA + # The signature file name included in the zip archive. file-name: export.sig + # The security provider. security-provider: BC - # Configuration for the S3 compatible object storage hosted by Telekom in Germany + # Configuration for the S3 compatible object storage hosted by Telekom in Germany. objectstore: access-key: ${CWA_OBJECTSTORE_ACCESSKEY:accessKey1} secret-key: ${CWA_OBJECTSTORE_SECRETKEY:verySecretKey1} endpoint: ${CWA_OBJECTSTORE_ENDPOINT:http://localhost} bucket: ${CWA_OBJECTSTORE_BUCKET:cwa} port: ${CWA_OBJECTSTORE_PORT:8003} + # Indicates whether the S3 Access Control List (ACL) header should be set to 'public-read' on put object. set-public-read-acl-on-put-object: true + # The number of maximum retry attempts used for configuring Spring @Retryable annotation. retry-attempts: 3 + # The backoff period in milliseconds used for configuring Spring @Retryable annotation. retry-backoff: 2000 + # The maximum number of failed operations before giving up. max-number-of-failed-operations: 5 + # The ThreadPoolTaskExecutor's maximum thread pool size. + max-number-of-s3-threads: 4 spring: main: web-application-type: NONE -# Postgres configuration - jpa: - hibernate: - ddl-auto: validate + # Postgres configuration flyway: enabled: true - locations: classpath:db/migration/postgres - password: ${POSTGRESQL_PASSWORD_FLYWAY:postgres} - user: ${POSTGRESQL_USER_FLYWAY:postgres} + locations: classpath:/db/migration, classpath:/db/specific/{vendor} + password: ${POSTGRESQL_PASSWORD_FLYWAY:local_setup_flyway} + user: ${POSTGRESQL_USER_FLYWAY:local_setup_flyway} datasource: driver-class-name: org.postgresql.Driver - url: jdbc:postgresql://${POSTGRESQL_SERVICE_HOST:localhost}:${POSTGRESQL_SERVICE_PORT:5432}/${POSTGRESQL_DATABASE:cwa} - username: ${POSTGRESQL_USER_DISTRIBUTION:postgres} - password: ${POSTGRESQL_PASSWORD_DISTRIBUTION:postgres} + url: jdbc:postgresql://${POSTGRESQL_SERVICE_HOST}:${POSTGRESQL_SERVICE_PORT}/${POSTGRESQL_DATABASE}?ssl=true&sslmode=verify-full&sslrootcert=${SSL_POSTGRES_CERTIFICATE_PATH}&sslcert=${SSL_DISTRIBUTION_CERTIFICATE_PATH}&sslkey=${SSL_DISTRIBUTION_PRIVATE_KEY_PATH} + username: ${POSTGRESQL_USER_DISTRIBUTION:local_setup_distribution} + password: ${POSTGRESQL_PASSWORD_DISTRIBUTION:local_setup_distribution} diff --git a/services/distribution/src/main/resources/bootstrap-cloud.yaml b/services/distribution/src/main/resources/bootstrap-cloud.yaml new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/resources/bootstrap-cloud.yaml @@ -0,0 +1,27 @@ +--- +spring: + application: + name: cwa-server + cloud: + vault: + enabled: true + generic: + enabled: false + kv: + enabled: true + backend: ${VAULT_BACKEND} + profile-separator: '/' + application-name: 'distribution' + default-context: '' + profiles: cloud + fail-fast: true + authentication: KUBERNETES + kubernetes: + role: ${VAULT_ROLE} + kubernetes-path: kubernetes + service-account-token-file: /var/run/secrets/kubernetes.io/serviceaccount/token + uri: ${VAULT_URI} + connection-timeout: 5000 + read-timeout: 15000 + config: + order: -10 diff --git a/services/distribution/src/main/resources/bootstrap.yaml b/services/distribution/src/main/resources/bootstrap.yaml new file mode 100644 --- /dev/null +++ b/services/distribution/src/main/resources/bootstrap.yaml @@ -0,0 +1,5 @@ +--- +spring: + cloud: + vault: + enabled: false diff --git a/services/distribution/src/main/resources/log4j2-dev.xml b/services/distribution/src/main/resources/log4j2-dev.xml --- a/services/distribution/src/main/resources/log4j2-dev.xml +++ b/services/distribution/src/main/resources/log4j2-dev.xml @@ -1,8 +1,8 @@ <?xml version="1.0" encoding="UTF-8"?> -<Configuration status="WARN"> +<Configuration status="WARN" shutdownHook="disable"> <Properties> <Property name="LOG_EXCEPTION_CONVERSION_WORD">%xwEx</Property> - <Property name="LOG_DATEFORMAT_PATTERN">yyyy-MM-dd'T'HH:mm:ssXXX</Property> + <Property name="LOG_DATEFORMAT_PATTERN">yyyy-MM-dd'T'HH:mm:ssZ</Property> <Property name="CONSOLE_LOG_PATTERN">%d{${LOG_DATEFORMAT_PATTERN}} %-5level %t %c{1.}[%pid]: %m%n${sys:LOG_EXCEPTION_CONVERSION_WORD}</Property> </Properties> <Appenders> diff --git a/services/distribution/src/main/resources/log4j2.xml b/services/distribution/src/main/resources/log4j2.xml --- a/services/distribution/src/main/resources/log4j2.xml +++ b/services/distribution/src/main/resources/log4j2.xml @@ -1,8 +1,8 @@ <?xml version="1.0" encoding="UTF-8"?> -<Configuration status="WARN"> +<Configuration status="WARN" shutdownHook="disable"> <Properties> - <Property name="LOG_DATEFORMAT_PATTERN">yyyy-MM-dd'T'HH:mm:ssXXX</Property> - <Property name="CONSOLE_LOG_PATTERN">%d{${LOG_DATEFORMAT_PATTERN}} %-5level %t %c{1.}[%pid]: %m %replace{%rException}{\n}{\u2028}%n</Property> + <Property name="LOG_DATEFORMAT_PATTERN">yyyy-MM-dd'T'HH:mm:ssZ</Property> + <Property name="CONSOLE_LOG_PATTERN">%d{${LOG_DATEFORMAT_PATTERN}} %-5level %t %c{1.}[%pid]: %m %replace{%rException}{[\r\n]+}{\u2028}%n</Property> </Properties> <Appenders> <Console name="Console" target="SYSTEM_OUT" follow="true"> diff --git a/services/distribution/src/main/resources/master-config/app-config.yaml b/services/distribution/src/main/resources/master-config/app-config.yaml --- a/services/distribution/src/main/resources/master-config/app-config.yaml +++ b/services/distribution/src/main/resources/master-config/app-config.yaml @@ -4,7 +4,9 @@ # # This configuration file will be fetched by the mobile app in order to function. # -# It currently provides settings for minimum risk score, score classes and exposure configuration. +# min-risk-score: exposure incidents with scores lower than the value of this property will be excluded by the ExposureNotification framework. +# +# For details regarding other properties - please see their respective configuration files. # # Change this file with caution! diff --git a/services/distribution/src/main/resources/master-config/app-version-config.yaml b/services/distribution/src/main/resources/master-config/app-version-config.yaml --- a/services/distribution/src/main/resources/master-config/app-version-config.yaml +++ b/services/distribution/src/main/resources/master-config/app-version-config.yaml @@ -12,14 +12,14 @@ ios: patch: 2 min: major: 0 - minor: 8 + minor: 5 patch: 0 android: latest: - major: 0 - minor: 8 - patch: 3 + major: 1 + minor: 0 + patch: 4 min: - major: 0 - minor: 8 - patch: 0 + major: 1 + minor: 0 + patch: 4 diff --git a/services/distribution/src/main/resources/master-config/attenuation-duration.yaml b/services/distribution/src/main/resources/master-config/attenuation-duration.yaml --- a/services/distribution/src/main/resources/master-config/attenuation-duration.yaml +++ b/services/distribution/src/main/resources/master-config/attenuation-duration.yaml @@ -10,8 +10,8 @@ # Change this file with caution! thresholds: - lower: 44 - upper: 48 + lower: 55 + upper: 63 weights: low: 1.0 mid: 0.5 diff --git a/services/distribution/src/main/resources/master-config/exposure-config.yaml b/services/distribution/src/main/resources/master-config/exposure-config.yaml --- a/services/distribution/src/main/resources/master-config/exposure-config.yaml +++ b/services/distribution/src/main/resources/master-config/exposure-config.yaml @@ -41,18 +41,18 @@ days_since_last_exposure: ge_14_days: 5 ge_12_lt_14_days: 5 ge_10_lt_12_days: 5 - ge_8_lt_10_days: 4 - ge_6_lt_8_days: 4 - ge_4_lt_6_days: 4 - ge_2_lt_4_days: 4 - ge_0_lt_2_days: 4 + ge_8_lt_10_days: 5 + ge_6_lt_8_days: 5 + ge_4_lt_6_days: 5 + ge_2_lt_4_days: 5 + ge_0_lt_2_days: 5 attenuation: gt_73_dbm: 0 - gt_63_le_73_dbm: 0 - gt_51_le_63_dbm: 0 + gt_63_le_73_dbm: 1 + gt_51_le_63_dbm: 1 gt_33_le_51_dbm: 1 gt_27_le_33_dbm: 1 gt_15_le_27_dbm: 1 gt_10_le_15_dbm: 1 - lt_10_dbm: 1 + le_10_dbm: 1 diff --git a/services/distribution/src/main/resources/master-config/risk-score-classification.yaml b/services/distribution/src/main/resources/master-config/risk-score-classification.yaml --- a/services/distribution/src/main/resources/master-config/risk-score-classification.yaml +++ b/services/distribution/src/main/resources/master-config/risk-score-classification.yaml @@ -1,10 +1,10 @@ # This is the Risk Score Classification master file which partitions the risk -# score value range (0-255) into distinct risk classes that will be used to by +# score value range (0-72) into distinct risk classes that will be used to by # the app in order to present the correct risk classification in a user # friendly manner, based on the underlying total risk score, to the user. # # The risk classes must not overlap and -# cover the full risk score value range (0-255). +# cover the full risk score value range (0-72). # # Change this file with caution! diff --git a/services/pom.xml b/services/pom.xml --- a/services/pom.xml +++ b/services/pom.xml @@ -8,7 +8,7 @@ <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> - <version>2.3.0.RELEASE</version> + <version>2.3.1.RELEASE</version> <relativePath></relativePath> </parent> @@ -36,6 +36,11 @@ </properties> <dependencies> + <dependency> + <groupId>org.springframework.cloud</groupId> + <artifactId>spring-cloud-starter-vault-config</artifactId> + <version>2.2.3.RELEASE</version> + </dependency> <dependency> <groupId>org.opencwa</groupId> <artifactId>persistence</artifactId> @@ -89,10 +94,49 @@ <artifactId>snakeyaml</artifactId> <version>1.26</version> </dependency> + <dependency> + <!-- https://nvd.nist.gov/vuln/detail/CVE-2020-13692 --> + <groupId>org.postgresql</groupId> + <artifactId>postgresql</artifactId> + <version>42.2.13</version> + <scope>runtime</scope> + </dependency> </dependencies> + <reporting> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-javadoc-plugin</artifactId> + <version>3.2.0</version> + <configuration> + <bottom> + <![CDATA[ + <script> + if (typeof useModuleDirectories !== 'undefined') { + useModuleDirectories = false; + } + </script> + ]]> + </bottom> + <additionalJOption>--allow-script-in-comments</additionalJOption> + </configuration> + </plugin> + </plugins> + </reporting> + <build> <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-site-plugin</artifactId> + <version>3.7.1</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-project-info-reports-plugin</artifactId> + <version>3.0.0</version> + </plugin> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>license-maven-plugin</artifactId> diff --git a/services/submission/Dockerfile b/services/submission/Dockerfile --- a/services/submission/Dockerfile +++ b/services/submission/Dockerfile @@ -1,12 +1,28 @@ -FROM maven:3.6.3-jdk-11 as build - +FROM openjdk:11 as build ARG WORK_DIR=/build +# copy the pom and config files first (which do not change very often) +COPY ./.mvn ${WORK_DIR}/.mvn +COPY ./mvnw ${WORK_DIR}/mvnw +COPY ./pom.xml ${WORK_DIR}/pom.xml +COPY ./common/pom.xml ${WORK_DIR}/common/pom.xml +COPY ./common/protocols/pom.xml ${WORK_DIR}/common/protocols/pom.xml +COPY ./common/persistence/pom.xml ${WORK_DIR}/common/persistence/pom.xml +COPY ./services/pom.xml ${WORK_DIR}/services/pom.xml +COPY ./services/distribution/pom.xml ${WORK_DIR}/services/distribution/pom.xml +COPY ./services/submission/pom.xml ${WORK_DIR}/services/submission/pom.xml + +WORKDIR ${WORK_DIR} + +# build all dependencies for offline use +RUN ${WORK_DIR}/mvnw dependency:go-offline --file ${WORK_DIR}/pom.xml -B + +# copy rest of files COPY . ${WORK_DIR}/ -RUN mkdir -p /root/.m2 /usr/sap/submission-service +RUN mkdir -p /usr/sap/submission-service # hadolint ignore=SC2086 -RUN mvn --batch-mode -DskipTests=true --file ${WORK_DIR}/pom.xml ${MAVEN_ARGS} clean install +RUN ${WORK_DIR}/mvnw --batch-mode -DskipTests=true --file ${WORK_DIR}/pom.xml ${MAVEN_ARGS} clean install RUN cp ${WORK_DIR}/services/submission/target/submission-*.jar /usr/sap/submission-service/submission.jar RUN cp ${WORK_DIR}/scripts/DpkgHelper.java /DpkgHelper.java @@ -14,4 +30,6 @@ FROM gcr.io/distroless/java:11 COPY --from=build /DpkgHelper.java . COPY --from=build /usr/sap/submission-service/submission.jar . RUN ["java", "DpkgHelper.java"] +USER 65534:65534 +ENTRYPOINT ["/usr/bin/java", "-Djdk.tls.namedGroups=\"secp256r1,secp384r1,brainpoolP256r1,brainpoolP384r1,brainpoolP512r1,ffdhe2048,ffdhe3072,ffdhe4096\"", "-jar"] CMD ["submission.jar"] diff --git a/services/submission/pom.xml b/services/submission/pom.xml --- a/services/submission/pom.xml +++ b/services/submission/pom.xml @@ -38,7 +38,7 @@ <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-math3</artifactId> - <version>3.2</version> + <version>3.6.1</version> <scope>compile</scope> </dependency> <dependency> @@ -68,7 +68,6 @@ <version>2.26.3</version> <scope>test</scope> </dependency> - </dependencies> <build> diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/ServerApplication.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/ServerApplication.java --- a/services/submission/src/main/java/app/coronawarn/server/services/submission/ServerApplication.java +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/ServerApplication.java @@ -22,36 +22,81 @@ import io.micrometer.core.aop.TimedAspect; import io.micrometer.core.instrument.MeterRegistry; +import java.util.Arrays; +import java.util.List; +import org.apache.logging.log4j.LogManager; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.DisposableBean; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.autoconfigure.domain.EntityScan; +import org.springframework.boot.autoconfigure.security.servlet.UserDetailsServiceAutoConfiguration; import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.cloud.openfeign.EnableFeignClients; +import org.springframework.context.EnvironmentAware; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.ComponentScan; -import org.springframework.data.jpa.repository.config.EnableJpaRepositories; +import org.springframework.core.env.Environment; +import org.springframework.data.jdbc.repository.config.EnableJdbcRepositories; import org.springframework.http.converter.protobuf.ProtobufHttpMessageConverter; -@SpringBootApplication -@EnableJpaRepositories(basePackages = "app.coronawarn.server.common.persistence") +@SpringBootApplication(exclude = {UserDetailsServiceAutoConfiguration.class}) +@EnableJdbcRepositories(basePackages = "app.coronawarn.server.common.persistence") @EntityScan(basePackages = "app.coronawarn.server.common.persistence") @ComponentScan({"app.coronawarn.server.common.persistence", "app.coronawarn.server.services.submission"}) @EnableConfigurationProperties @EnableFeignClients -public class ServerApplication { +public class ServerApplication implements EnvironmentAware, DisposableBean { + + private static final Logger logger = LoggerFactory.getLogger(ServerApplication.class); + + public static void main(String[] args) { + SpringApplication.run(ServerApplication.class); + } @Bean TimedAspect timedAspect(MeterRegistry registry) { return new TimedAspect(registry); } + /** + * Manual shutdown hook needed to avoid Log4j shutdown issues (see cwa-server/#589). + */ + @Override + public void destroy() { + LogManager.shutdown(); + } + @Bean ProtobufHttpMessageConverter protobufHttpMessageConverter() { return new ProtobufHttpMessageConverter(); } - public static void main(String[] args) { - SpringApplication.run(ServerApplication.class); + @Override + public void setEnvironment(Environment environment) { + List<String> profiles = Arrays.asList(environment.getActiveProfiles()); + + logger.info("Enabled named groups: {}", System.getProperty("jdk.tls.namedGroups")); + if (profiles.contains("disable-ssl-server")) { + logger.warn( + "The submission service is started with endpoint TLS disabled. This should never be used in PRODUCTION!"); + } + if (profiles.contains("disable-ssl-client-postgres")) { + logger.warn( + "The submission service is started with postgres connection TLS disabled. " + + "This should never be used in PRODUCTION!"); + } + if (profiles.contains("disable-ssl-client-verification")) { + logger.warn( + "The submission service is started with verification service connection TLS disabled. " + + "This should never be used in PRODUCTION!"); + } + if (profiles.contains("disable-ssl-client-verification-verify-hostname")) { + logger.warn( + "The submission service is started with verification service TLS hostname validation disabled. " + + "This should never be used in PRODUCTION!"); + } } } diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/config/SecurityConfig.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/config/SecurityConfig.java --- a/services/submission/src/main/java/app/coronawarn/server/services/submission/config/SecurityConfig.java +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/config/SecurityConfig.java @@ -35,7 +35,11 @@ @EnableWebSecurity public class SecurityConfig extends WebSecurityConfigurerAdapter { - private static final String ACTUATOR_ROUTE = "/actuator/**"; + private static final String ACTUATOR_ROUTE = "/actuator/"; + private static final String HEALTH_ROUTE = ACTUATOR_ROUTE + "health"; + private static final String PROMETHEUS_ROUTE = ACTUATOR_ROUTE + "prometheus"; + private static final String READINESS_ROUTE = ACTUATOR_ROUTE + "readiness"; + private static final String LIVENESS_ROUTE = ACTUATOR_ROUTE + "liveness"; private static final String SUBMISSION_ROUTE = "/version/v1" + SubmissionController.SUBMISSION_ROUTE; @@ -51,10 +55,11 @@ protected HttpFirewall strictFirewall() { @Override protected void configure(HttpSecurity http) throws Exception { http.authorizeRequests() - .mvcMatchers(HttpMethod.GET, ACTUATOR_ROUTE).permitAll() + .mvcMatchers(HttpMethod.GET, HEALTH_ROUTE, PROMETHEUS_ROUTE, READINESS_ROUTE, LIVENESS_ROUTE).permitAll() .mvcMatchers(HttpMethod.POST, SUBMISSION_ROUTE).permitAll() .anyRequest().denyAll() .and().csrf().disable(); + http.headers().contentSecurityPolicy("default-src 'self'"); } } diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/config/SubmissionServiceConfig.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/config/SubmissionServiceConfig.java --- a/services/submission/src/main/java/app/coronawarn/server/services/submission/config/SubmissionServiceConfig.java +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/config/SubmissionServiceConfig.java @@ -20,35 +20,45 @@ package app.coronawarn.server.services.submission.config; +import java.io.File; +import javax.validation.constraints.Max; +import javax.validation.constraints.Min; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.stereotype.Component; +import org.springframework.validation.annotation.Validated; @Component @ConfigurationProperties(prefix = "services.submission") +@Validated public class SubmissionServiceConfig { // Exponential moving average of the last N real request durations (in ms), where // N = fakeDelayMovingAverageSamples. - private Double initialFakeDelayMilliseconds; - private Double fakeDelayMovingAverageSamples; + private Long initialFakeDelayMilliseconds; + private Long fakeDelayMovingAverageSamples; private Integer retentionDays; + @Min(1) + @Max(25) + private Integer randomKeyPaddingMultiplier; + private Integer connectionPoolSize; private Payload payload; private Verification verification; private Monitoring monitoring; + private Client client; - public Double getInitialFakeDelayMilliseconds() { + public Long getInitialFakeDelayMilliseconds() { return initialFakeDelayMilliseconds; } - public void setInitialFakeDelayMilliseconds(Double initialFakeDelayMilliseconds) { + public void setInitialFakeDelayMilliseconds(Long initialFakeDelayMilliseconds) { this.initialFakeDelayMilliseconds = initialFakeDelayMilliseconds; } - public Double getFakeDelayMovingAverageSamples() { + public Long getFakeDelayMovingAverageSamples() { return fakeDelayMovingAverageSamples; } - public void setFakeDelayMovingAverageSamples(Double fakeDelayMovingAverageSamples) { + public void setFakeDelayMovingAverageSamples(Long fakeDelayMovingAverageSamples) { this.fakeDelayMovingAverageSamples = fakeDelayMovingAverageSamples; } @@ -60,6 +70,22 @@ public void setRetentionDays(Integer retentionDays) { this.retentionDays = retentionDays; } + public Integer getRandomKeyPaddingMultiplier() { + return randomKeyPaddingMultiplier; + } + + public void setRandomKeyPaddingMultiplier(Integer randomKeyPaddingMultiplier) { + this.randomKeyPaddingMultiplier = randomKeyPaddingMultiplier; + } + + public Integer getConnectionPoolSize() { + return connectionPoolSize; + } + + public void setConnectionPoolSize(Integer connectionPoolSize) { + this.connectionPoolSize = connectionPoolSize; + } + public Integer getMaxNumberOfKeys() { return payload.getMaxNumberOfKeys(); } @@ -116,13 +142,13 @@ public void setPath(String path) { } private static class Monitoring { - private Integer batchSize; + private Long batchSize; - public Integer getBatchSize() { + public Long getBatchSize() { return batchSize; } - public void setBatchSize(Integer batchSize) { + public void setBatchSize(Long batchSize) { this.batchSize = batchSize; } } @@ -135,11 +161,81 @@ public void setMonitoring(Monitoring monitoring) { this.monitoring = monitoring; } - public Integer getMonitoringBatchSize() { + public Long getMonitoringBatchSize() { return this.monitoring.getBatchSize(); } - public void setMonitoringBatchSize(Integer batchSize) { + public void setMonitoringBatchSize(Long batchSize) { this.monitoring.setBatchSize(batchSize); } + + public Client getClient() { + return client; + } + + public void setClient(Client client) { + this.client = client; + } + + public static class Client { + + private Ssl ssl; + + public Ssl getSsl() { + return ssl; + } + + public void setSsl(Ssl ssl) { + this.ssl = ssl; + } + + public static class Ssl { + + private File keyStore; + private String keyStorePassword; + private String keyPassword; + private File trustStore; + private String trustStorePassword; + + public File getKeyStore() { + return keyStore; + } + + public void setKeyStore(File keyStore) { + this.keyStore = keyStore; + } + + public String getKeyStorePassword() { + return keyStorePassword; + } + + public void setKeyStorePassword(String keyStorePassword) { + this.keyStorePassword = keyStorePassword; + } + + public String getKeyPassword() { + return keyPassword; + } + + public void setKeyPassword(String keyPassword) { + this.keyPassword = keyPassword; + } + + public File getTrustStore() { + return trustStore; + } + + public void setTrustStore(File trustStore) { + this.trustStore = trustStore; + } + + public String getTrustStorePassword() { + return trustStorePassword; + } + + public void setTrustStorePassword(String trustStorePassword) { + this.trustStorePassword = trustStorePassword; + } + } + } } diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/FakeDelayManager.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/FakeDelayManager.java new file mode 100644 --- /dev/null +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/FakeDelayManager.java @@ -0,0 +1,62 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.submission.controller; + +import app.coronawarn.server.services.submission.config.SubmissionServiceConfig; +import org.apache.commons.math3.distribution.PoissonDistribution; +import org.springframework.stereotype.Component; + +/** + * {@link FakeDelayManager} instances manage the response delay in the processing of fake (or "dummy") requests. + */ +@Component +public class FakeDelayManager { + + private final long movingAverageSampleSize; + private long fakeDelay; + + public FakeDelayManager(SubmissionServiceConfig submissionServiceConfig) { + this.fakeDelay = submissionServiceConfig.getInitialFakeDelayMilliseconds(); + this.movingAverageSampleSize = submissionServiceConfig.getFakeDelayMovingAverageSamples(); + } + + /** + * Returns the current fake delay after applying random jitter. + */ + public long getJitteredFakeDelay() { + return new PoissonDistribution(fakeDelay).sample(); + } + + /** + * Updates the moving average for the request duration with the specified value. + */ + public void updateFakeRequestDelay(long realRequestDuration) { + final long currentDelay = fakeDelay; + fakeDelay = currentDelay + (realRequestDuration - currentDelay) / movingAverageSampleSize; + } + + /** + * Returns the current fake delay in seconds. Used for monitoring. + */ + public Double getFakeDelayInSeconds() { + return fakeDelay / 1000.; + } +} diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/FakeRequestController.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/FakeRequestController.java new file mode 100644 --- /dev/null +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/FakeRequestController.java @@ -0,0 +1,69 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.submission.controller; + +import static app.coronawarn.server.services.submission.controller.SubmissionController.SUBMISSION_ROUTE; +import static java.util.concurrent.TimeUnit.MILLISECONDS; + +import app.coronawarn.server.services.submission.monitoring.SubmissionMonitor; +import io.micrometer.core.annotation.Timed; +import java.util.concurrent.Executors; +import java.util.concurrent.ScheduledExecutorService; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.PostMapping; +import org.springframework.web.bind.annotation.RequestHeader; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RestController; +import org.springframework.web.context.request.async.DeferredResult; + +@RestController +@RequestMapping("/version/v1") +public class FakeRequestController { + + private final ScheduledExecutorService scheduledExecutor = Executors.newScheduledThreadPool(4); + private final SubmissionMonitor submissionMonitor; + private final FakeDelayManager fakeDelayManager; + + FakeRequestController(SubmissionMonitor submissionMonitor, FakeDelayManager fakeDelayManager) { + this.submissionMonitor = submissionMonitor; + this.fakeDelayManager = fakeDelayManager; + } + + /** + * Handles "fake" requests. The concept of fake (or "dummy") requests is a privacy preserving measure which is + * characterized by having corona warn app send "dummy" requests in randomized intervals. These requests are not + * triggering any diagnosis key processing/storage on the server but simply result in an HTTP response with status + * code 200 (OK) after a dynamically calculated delay. + * + * @param fake The header flag, marking fake requests. + * @return An empty response body and HTTP status code 200 (OK). + */ + @PostMapping(value = SUBMISSION_ROUTE, headers = {"cwa-fake!=0"}) + @Timed(description = "Time spent handling fake submission.") + public DeferredResult<ResponseEntity<Void>> fakeRequest(@RequestHeader("cwa-fake") Integer fake) { + submissionMonitor.incrementRequestCounter(); + submissionMonitor.incrementFakeRequestCounter(); + long delay = fakeDelayManager.getJitteredFakeDelay(); + DeferredResult<ResponseEntity<Void>> deferredResult = new DeferredResult<>(); + scheduledExecutor.schedule(() -> deferredResult.setResult(ResponseEntity.ok().build()), delay, MILLISECONDS); + return deferredResult; + } +} diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/SubmissionController.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/SubmissionController.java --- a/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/SubmissionController.java +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/SubmissionController.java @@ -25,17 +25,14 @@ import app.coronawarn.server.common.protocols.external.exposurenotification.TemporaryExposureKey; import app.coronawarn.server.common.protocols.internal.SubmissionPayload; import app.coronawarn.server.services.submission.config.SubmissionServiceConfig; -import app.coronawarn.server.services.submission.monitoring.SubmissionControllerMonitor; +import app.coronawarn.server.services.submission.monitoring.SubmissionMonitor; import app.coronawarn.server.services.submission.validation.ValidSubmissionPayload; import app.coronawarn.server.services.submission.verification.TanVerifier; import io.micrometer.core.annotation.Timed; +import java.security.SecureRandom; import java.util.ArrayList; import java.util.List; -import java.util.concurrent.Executors; -import java.util.concurrent.ForkJoinPool; -import java.util.concurrent.ScheduledExecutorService; -import java.util.concurrent.TimeUnit; -import org.apache.commons.math3.distribution.PoissonDistribution; +import java.util.stream.IntStream; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.http.HttpStatus; @@ -60,96 +57,64 @@ public class SubmissionController { */ public static final String SUBMISSION_ROUTE = "/diagnosis-keys"; - private final SubmissionControllerMonitor submissionControllerMonitor; - private final ScheduledExecutorService scheduledExecutor = Executors.newSingleThreadScheduledExecutor(); - private final ForkJoinPool forkJoinPool = ForkJoinPool.commonPool(); + private final SubmissionMonitor submissionMonitor; private final DiagnosisKeyService diagnosisKeyService; private final TanVerifier tanVerifier; - private final Double fakeDelayMovingAverageSamples; private final Integer retentionDays; - private Double fakeDelay; + private final Integer randomKeyPaddingMultiplier; + private final FakeDelayManager fakeDelayManager; - SubmissionController(DiagnosisKeyService diagnosisKeyService, TanVerifier tanVerifier, - SubmissionServiceConfig submissionServiceConfig, SubmissionControllerMonitor submissionControllerMonitor) { + SubmissionController( + DiagnosisKeyService diagnosisKeyService, TanVerifier tanVerifier, FakeDelayManager fakeDelayManager, + SubmissionServiceConfig submissionServiceConfig, SubmissionMonitor submissionMonitor) { this.diagnosisKeyService = diagnosisKeyService; this.tanVerifier = tanVerifier; - this.submissionControllerMonitor = submissionControllerMonitor; - fakeDelay = submissionServiceConfig.getInitialFakeDelayMilliseconds(); - fakeDelayMovingAverageSamples = submissionServiceConfig.getFakeDelayMovingAverageSamples(); + this.submissionMonitor = submissionMonitor; + this.fakeDelayManager = fakeDelayManager; retentionDays = submissionServiceConfig.getRetentionDays(); - submissionControllerMonitor.initializeGauges(this); + randomKeyPaddingMultiplier = submissionServiceConfig.getRandomKeyPaddingMultiplier(); } /** * Handles diagnosis key submission requests. * * @param exposureKeys The unmarshalled protocol buffers submission payload. - * @param fake A header flag, marking fake requests. * @param tan A tan for diagnosis verification. * @return An empty response body. */ - @PostMapping(SUBMISSION_ROUTE) + @PostMapping(value = SUBMISSION_ROUTE, headers = {"cwa-fake=0"}) @Timed(description = "Time spent handling submission.") public DeferredResult<ResponseEntity<Void>> submitDiagnosisKey( @ValidSubmissionPayload @RequestBody SubmissionPayload exposureKeys, - @RequestHeader("cwa-fake") Integer fake, @RequestHeader("cwa-authorization") String tan) { - submissionControllerMonitor.incrementRequestCounter(); - if (fake != 0) { - submissionControllerMonitor.incrementFakeRequestCounter(); - return buildFakeDeferredResult(); - } else { - submissionControllerMonitor.incrementRealRequestCounter(); - return buildRealDeferredResult(exposureKeys, tan); - } - } - - private DeferredResult<ResponseEntity<Void>> buildFakeDeferredResult() { - DeferredResult<ResponseEntity<Void>> deferredResult = new DeferredResult<>(); - long delay = new PoissonDistribution(fakeDelay).sample(); - scheduledExecutor.schedule(() -> deferredResult.setResult(buildSuccessResponseEntity()), - delay, TimeUnit.MILLISECONDS); - return deferredResult; + submissionMonitor.incrementRequestCounter(); + submissionMonitor.incrementRealRequestCounter(); + return buildRealDeferredResult(exposureKeys, tan); } private DeferredResult<ResponseEntity<Void>> buildRealDeferredResult(SubmissionPayload exposureKeys, String tan) { DeferredResult<ResponseEntity<Void>> deferredResult = new DeferredResult<>(); - forkJoinPool.submit(() -> { - try { - StopWatch stopWatch = new StopWatch(); - stopWatch.start(); - if (!this.tanVerifier.verifyTan(tan)) { - submissionControllerMonitor.incrementInvalidTanRequestCounter(); - deferredResult.setResult(buildTanInvalidResponseEntity()); - } else { - persistDiagnosisKeysPayload(exposureKeys); - deferredResult.setResult(buildSuccessResponseEntity()); - stopWatch.stop(); - updateFakeDelay(stopWatch.getTotalTimeMillis()); - } - } catch (Exception e) { - deferredResult.setErrorResult(e); + StopWatch stopWatch = new StopWatch(); + stopWatch.start(); + try { + if (!this.tanVerifier.verifyTan(tan)) { + submissionMonitor.incrementInvalidTanRequestCounter(); + deferredResult.setResult(ResponseEntity.status(HttpStatus.FORBIDDEN).build()); + } else { + persistDiagnosisKeysPayload(exposureKeys); + deferredResult.setResult(ResponseEntity.ok().build()); } - }); + } catch (Exception e) { + deferredResult.setErrorResult(e); + } finally { + stopWatch.stop(); + fakeDelayManager.updateFakeRequestDelay(stopWatch.getTotalTimeMillis()); + } return deferredResult; } - /** - * Returns a response that indicates successful request processing. - */ - private ResponseEntity<Void> buildSuccessResponseEntity() { - return ResponseEntity.ok().build(); - } - - /** - * Returns a response that indicates that an invalid TAN was specified in the request. - */ - private ResponseEntity<Void> buildTanInvalidResponseEntity() { - return ResponseEntity.status(HttpStatus.FORBIDDEN).build(); - } - /** * Persists the diagnosis keys contained in the specified request payload. * @@ -169,19 +134,28 @@ public void persistDiagnosisKeysPayload(SubmissionPayload protoBufDiagnosisKeys) } } - diagnosisKeyService.saveDiagnosisKeys(diagnosisKeys); + diagnosisKeyService.saveDiagnosisKeys(padDiagnosisKeys(diagnosisKeys)); } - private void updateFakeDelay(long realRequestDuration) { - final Double currentDelay = fakeDelay; - fakeDelay = currentDelay + (1 / fakeDelayMovingAverageSamples) * (realRequestDuration - currentDelay); + private List<DiagnosisKey> padDiagnosisKeys(List<DiagnosisKey> diagnosisKeys) { + List<DiagnosisKey> paddedDiagnosisKeys = new ArrayList<>(); + diagnosisKeys.forEach(diagnosisKey -> { + paddedDiagnosisKeys.add(diagnosisKey); + IntStream.range(1, randomKeyPaddingMultiplier) + .mapToObj(index -> DiagnosisKey.builder() + .withKeyData(generateRandomKeyData()) + .withRollingStartIntervalNumber(diagnosisKey.getRollingStartIntervalNumber()) + .withTransmissionRiskLevel(diagnosisKey.getTransmissionRiskLevel()) + .withRollingPeriod(diagnosisKey.getRollingPeriod()) + .build()) + .forEach(paddedDiagnosisKeys::add); + }); + return paddedDiagnosisKeys; } - /** - * Gets the current fake delay. Used for monitoring. - * @return the current fake delay - */ - public Double getFakeDelay() { - return fakeDelay; + private static byte[] generateRandomKeyData() { + byte[] randomKeyData = new byte[16]; + new SecureRandom().nextBytes(randomKeyData); + return randomKeyData; } } diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/monitoring/BatchCounter.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/monitoring/BatchCounter.java --- a/services/submission/src/main/java/app/coronawarn/server/services/submission/monitoring/BatchCounter.java +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/monitoring/BatchCounter.java @@ -22,6 +22,7 @@ import io.micrometer.core.instrument.Counter; import io.micrometer.core.instrument.MeterRegistry; +import java.util.concurrent.atomic.AtomicLong; /** * Batch counter for counting requests for monitoring. Counts up in batches, given batch size. This way, single requests @@ -29,15 +30,15 @@ */ public class BatchCounter { - private static final String SUBMISSION_CONTROLLER_REQUESTS_COUNTER_NAME = "submissionController.requests"; + private static final String SUBMISSION_CONTROLLER_REQUESTS_COUNTER_NAME = "submission_controller.requests"; private static final String SUBMISSION_CONTROLLER_REQUESTS_COUNTER_DESCRIPTION = "Counts requests to the Submission Controller."; - private final int batchSize; + private final long batchSize; private final Counter counter; - private Double batch = 0.; + private final AtomicLong count = new AtomicLong(0L); - BatchCounter(MeterRegistry meterRegistry, int batchSize, String type) { + BatchCounter(MeterRegistry meterRegistry, long batchSize, String type) { this.batchSize = batchSize; counter = Counter.builder(SUBMISSION_CONTROLLER_REQUESTS_COUNTER_NAME) .tag("type", type) @@ -50,11 +51,8 @@ public class BatchCounter { * counter is incremented. */ public void increment() { - if (batch < batchSize) { - batch++; - } else { - counter.increment(batch); - batch = 1.; + if (0 == count.incrementAndGet() % batchSize) { + counter.increment(batchSize); } } } diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/monitoring/SubmissionControllerMonitor.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/monitoring/SubmissionMonitor.java similarity index 70% rename from services/submission/src/main/java/app/coronawarn/server/services/submission/monitoring/SubmissionControllerMonitor.java rename to services/submission/src/main/java/app/coronawarn/server/services/submission/monitoring/SubmissionMonitor.java --- a/services/submission/src/main/java/app/coronawarn/server/services/submission/monitoring/SubmissionControllerMonitor.java +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/monitoring/SubmissionMonitor.java @@ -21,44 +21,46 @@ package app.coronawarn.server.services.submission.monitoring; import app.coronawarn.server.services.submission.config.SubmissionServiceConfig; -import app.coronawarn.server.services.submission.controller.SubmissionController; +import app.coronawarn.server.services.submission.controller.FakeDelayManager; import io.micrometer.core.instrument.Gauge; import io.micrometer.core.instrument.MeterRegistry; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.stereotype.Component; /** - * Provides functionality for monitoring the application logic of the - * {@link app.coronawarn.server.services.submission.controller.SubmissionController}. + * Provides functionality for monitoring the diagnosis key submission handling logic. */ @Component @ConfigurationProperties(prefix = "services.submission.monitoring") -public class SubmissionControllerMonitor { - private static final String SUBMISSION_CONTROLLER_CURRENT_FAKE_DELAY = "submissionController.fakeDelay"; +public class SubmissionMonitor { - private final MeterRegistry meterRegistry; + private static final String SUBMISSION_CONTROLLER_CURRENT_FAKE_DELAY = "submission_controller.fake_delay_seconds"; - private final Integer batchSize; + private final MeterRegistry meterRegistry; + private final long batchSize; private BatchCounter requests; private BatchCounter realRequests; private BatchCounter fakeRequests; private BatchCounter invalidTanRequests; /** - * Constructor for {@link SubmissionControllerMonitor}. Initializes all counters to 0 upon being called. + * Constructor for {@link SubmissionMonitor}. Initializes all counters to 0 upon being called. * * @param meterRegistry the meterRegistry + * @param fakeDelayManager the fake delay manager whose fake delay will be monitored */ - protected SubmissionControllerMonitor(MeterRegistry meterRegistry, SubmissionServiceConfig submissionServiceConfig) { + protected SubmissionMonitor( + MeterRegistry meterRegistry, SubmissionServiceConfig submissionServiceConfig, FakeDelayManager fakeDelayManager) { this.meterRegistry = meterRegistry; this.batchSize = submissionServiceConfig.getMonitoringBatchSize(); initializeCounters(); + initializeGauges(fakeDelayManager); } /** * We count the following values. * <ul> - * <li> All requests that come in to the {@link SubmissionController}. + * <li> All requests that reach the controllers. * <li> As part of all, the number of requests that are not fake. * <li> As part of all, the number of requests that are fake. * <li> As part of all, the number of requests for that the TAN-validation failed. @@ -72,14 +74,14 @@ private void initializeCounters() { } /** - * Initializes the gauges for the {@link SubmissionController} that is being monitored. Currently, only the delay time - * of fake requests is measured. + * Initializes the gauges for the {@link FakeDelayManager} that is being monitored. Currently, only the delay time of + * fake requests is measured. * - * @param submissionController the submission controller for which the gauges shall be initialized + * @param fakeDelayManager the fake request handler for which the gauges shall be initialized */ - public void initializeGauges(SubmissionController submissionController) { - Gauge.builder(SUBMISSION_CONTROLLER_CURRENT_FAKE_DELAY, submissionController, - __ -> submissionController.getFakeDelay()) + private void initializeGauges(FakeDelayManager fakeDelayManager) { + Gauge.builder(SUBMISSION_CONTROLLER_CURRENT_FAKE_DELAY, fakeDelayManager, + ignoredValue -> fakeDelayManager.getFakeDelayInSeconds()) .description("The time that fake requests are delayed to make them indistinguishable from real requests.") .register(meterRegistry); } diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/validation/ValidSubmissionPayload.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/validation/ValidSubmissionPayload.java --- a/services/submission/src/main/java/app/coronawarn/server/services/submission/validation/ValidSubmissionPayload.java +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/validation/ValidSubmissionPayload.java @@ -32,7 +32,6 @@ import java.lang.annotation.Target; import java.util.Arrays; import java.util.List; -import java.util.Objects; import javax.validation.Constraint; import javax.validation.ConstraintValidator; import javax.validation.ConstraintValidatorContext; @@ -88,11 +87,6 @@ public boolean isValid(SubmissionPayload submissionPayload, ConstraintValidatorC List<TemporaryExposureKey> exposureKeys = submissionPayload.getKeysList(); validatorContext.disableDefaultConstraintViolation(); - if (Objects.isNull(exposureKeys)) { - addViolation(validatorContext, "Field 'keys' points to Null."); - return false; - } - boolean isValid = checkKeyCollectionSize(exposureKeys, validatorContext); isValid &= checkUniqueStartIntervalNumbers(exposureKeys, validatorContext); isValid &= checkNoOverlapsInTimeWindow(exposureKeys, validatorContext); diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/CloudFeignClientProvider.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/CloudFeignClientProvider.java --- a/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/CloudFeignClientProvider.java +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/CloudFeignClientProvider.java @@ -20,51 +20,81 @@ package app.coronawarn.server.services.submission.verification; +import app.coronawarn.server.services.submission.config.SubmissionServiceConfig; +import app.coronawarn.server.services.submission.config.SubmissionServiceConfig.Client.Ssl; import feign.Client; +import feign.httpclient.ApacheHttpClient; +import java.io.File; import java.io.IOException; import java.security.GeneralSecurityException; import javax.net.ssl.SSLContext; -import javax.net.ssl.SSLSocketFactory; -import org.apache.http.conn.ssl.NoopHostnameVerifier; +import org.apache.http.impl.client.HttpClientBuilder; import org.apache.http.ssl.SSLContextBuilder; +import org.springframework.cloud.commons.httpclient.ApacheHttpClientConnectionManagerFactory; +import org.springframework.cloud.commons.httpclient.ApacheHttpClientFactory; +import org.springframework.cloud.commons.httpclient.DefaultApacheHttpClientConnectionManagerFactory; +import org.springframework.cloud.commons.httpclient.DefaultApacheHttpClientFactory; +import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Profile; -import org.springframework.core.env.Environment; import org.springframework.stereotype.Component; -import org.springframework.util.ResourceUtils; @Component -@Profile("ssl-client-verification") +@Profile("!disable-ssl-client-verification") public class CloudFeignClientProvider implements FeignClientProvider { - Environment environment; + private final HostnameVerifierProvider hostnameVerifierProvider; + private final Integer connectionPoolSize; + private final File keyStore; + private final String keyStorePassword; + private final String keyPassword; + private final File trustStore; + private final String trustStorePassword; - public CloudFeignClientProvider(Environment environment) { - this.environment = environment; + /** + * Creates a {@link CloudFeignClientProvider} that provides feign clients with fixed key and trust material. + */ + public CloudFeignClientProvider(SubmissionServiceConfig config, HostnameVerifierProvider hostnameVerifierProvider) { + Ssl sslConfig = config.getClient().getSsl(); + this.keyStore = sslConfig.getKeyStore(); + this.keyStorePassword = sslConfig.getKeyStorePassword(); + this.keyPassword = sslConfig.getKeyPassword(); + this.trustStore = sslConfig.getTrustStore(); + this.trustStorePassword = sslConfig.getTrustStorePassword(); + this.connectionPoolSize = config.getConnectionPoolSize(); + this.hostnameVerifierProvider = hostnameVerifierProvider; } @Override public Client createFeignClient() { - return new Client.Default(getSslSocketFactory(), new NoopHostnameVerifier()); + return new ApacheHttpClient(createHttpClientFactory().createBuilder().build()); } - private SSLSocketFactory getSslSocketFactory() { + private SSLContext getSslContext() { try { - String keyStorePath = environment.getProperty("client.ssl.key-store"); - String keyStorePassword = environment.getProperty("client.ssl.key-store-password"); - String keyPassword = environment.getProperty("client.ssl.key-password"); - - String trustStorePath = environment.getProperty("client.ssl.verification.trust-store"); - String trustStorePassword = environment.getProperty("client.ssl.verification.trust-store-password"); - - SSLContext sslContext = SSLContextBuilder + return SSLContextBuilder .create() - .loadKeyMaterial(ResourceUtils.getFile(keyStorePath), keyStorePassword.toCharArray(), - keyPassword.toCharArray()) - .loadTrustMaterial(ResourceUtils.getFile(trustStorePath), trustStorePassword.toCharArray()) + .loadKeyMaterial(this.keyStore, this.keyStorePassword.toCharArray(), this.keyPassword.toCharArray()) + .loadTrustMaterial(this.trustStore, this.trustStorePassword.toCharArray()) .build(); - return sslContext.getSocketFactory(); } catch (IOException | GeneralSecurityException e) { throw new RuntimeException(e); } } + + /** + * Creates an {@link ApacheHttpClientFactory} that validates SSL certificates and host names. + */ + @Bean + public ApacheHttpClientFactory createHttpClientFactory() { + return new DefaultApacheHttpClientFactory(HttpClientBuilder.create() + .setMaxConnPerRoute(this.connectionPoolSize) + .setMaxConnTotal(this.connectionPoolSize) + .setSSLContext(getSslContext()) + .setSSLHostnameVerifier(this.hostnameVerifierProvider.createHostnameVerifier())); + } + + @Bean + public ApacheHttpClientConnectionManagerFactory createConnectionManager() { + return new DefaultApacheHttpClientConnectionManagerFactory(); + } } diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/DefaultHostnameVerifierProvider.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/DefaultHostnameVerifierProvider.java new file mode 100644 --- /dev/null +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/DefaultHostnameVerifierProvider.java @@ -0,0 +1,36 @@ +/* + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.submission.verification; + +import javax.net.ssl.HostnameVerifier; +import org.apache.http.conn.ssl.DefaultHostnameVerifier; +import org.springframework.context.annotation.Profile; +import org.springframework.stereotype.Component; + +@Component +@Profile("!disable-ssl-client-verification-verify-hostname") +public class DefaultHostnameVerifierProvider implements HostnameVerifierProvider { + + @Override + public HostnameVerifier createHostnameVerifier() { + return new DefaultHostnameVerifier(); + } +} diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/DevelopmentFeignClientProvider.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/DevelopmentFeignClientProvider.java --- a/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/DevelopmentFeignClientProvider.java +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/DevelopmentFeignClientProvider.java @@ -20,6 +20,7 @@ package app.coronawarn.server.services.submission.verification; +import app.coronawarn.server.services.submission.config.SubmissionServiceConfig; import feign.Client; import feign.httpclient.ApacheHttpClient; import org.apache.http.impl.client.HttpClientBuilder; @@ -32,17 +33,32 @@ import org.springframework.stereotype.Component; @Component -@Profile("!ssl-client-verification") +@Profile("disable-ssl-client-verification") public class DevelopmentFeignClientProvider implements FeignClientProvider { + private final HostnameVerifierProvider hostnameVerifierProvider; + private final Integer connectionPoolSize; + + public DevelopmentFeignClientProvider(SubmissionServiceConfig config, + HostnameVerifierProvider hostnameVerifierProvider) { + this.connectionPoolSize = config.getConnectionPoolSize(); + this.hostnameVerifierProvider = hostnameVerifierProvider; + } + @Override public Client createFeignClient() { - return new ApacheHttpClient(); + return new ApacheHttpClient(createHttpClientFactory().createBuilder().build()); } + /** + * Creates an {@link ApacheHttpClientFactory} that neither validates SSL certificates nor host names. + */ @Bean public ApacheHttpClientFactory createHttpClientFactory() { - return new DefaultApacheHttpClientFactory(HttpClientBuilder.create()); + return new DefaultApacheHttpClientFactory(HttpClientBuilder.create() + .setMaxConnPerRoute(this.connectionPoolSize) + .setMaxConnTotal(this.connectionPoolSize) + .setSSLHostnameVerifier(this.hostnameVerifierProvider.createHostnameVerifier())); } @Bean diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/HostnameVerifierProvider.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/HostnameVerifierProvider.java new file mode 100644 --- /dev/null +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/HostnameVerifierProvider.java @@ -0,0 +1,28 @@ +/* + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.submission.verification; + +import javax.net.ssl.HostnameVerifier; + +public interface HostnameVerifierProvider { + + HostnameVerifier createHostnameVerifier(); +} diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/NoopHostnameVerifierProvider.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/NoopHostnameVerifierProvider.java new file mode 100644 --- /dev/null +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/NoopHostnameVerifierProvider.java @@ -0,0 +1,36 @@ +/* + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.submission.verification; + +import javax.net.ssl.HostnameVerifier; +import org.apache.http.conn.ssl.NoopHostnameVerifier; +import org.springframework.context.annotation.Profile; +import org.springframework.stereotype.Component; + +@Component +@Profile("disable-ssl-client-verification-verify-hostname") +public class NoopHostnameVerifierProvider implements HostnameVerifierProvider { + + @Override + public HostnameVerifier createHostnameVerifier() { + return new NoopHostnameVerifier(); + } +} diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/TanVerifier.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/TanVerifier.java --- a/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/TanVerifier.java +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/verification/TanVerifier.java @@ -57,7 +57,8 @@ public boolean verifyTan(String tanString) { return verifyWithVerificationService(tan); } catch (IllegalArgumentException e) { - logger.debug("TAN Syntax check failed for TAN: {}", tanString.trim()); + logger.error("TAN Syntax check failed for TAN: {}, length: {}", + tanString.substring(0, Math.min(36, tanString.length())), tanString.length()); return false; } } diff --git a/services/submission/src/main/resources/application-cloud.yaml b/services/submission/src/main/resources/application-cloud.yaml --- a/services/submission/src/main/resources/application-cloud.yaml +++ b/services/submission/src/main/resources/application-cloud.yaml @@ -1,13 +1,10 @@ --- spring: flyway: - enabled: true - locations: classpath:db/migration/postgres password: ${POSTGRESQL_PASSWORD_FLYWAY} user: ${POSTGRESQL_USER_FLYWAY} datasource: driver-class-name: org.postgresql.Driver - url: jdbc:postgresql://${POSTGRESQL_SERVICE_HOST}:${POSTGRESQL_SERVICE_PORT}/${POSTGRESQL_DATABASE} username: ${POSTGRESQL_USER_SUBMISSION} password: ${POSTGRESQL_PASSWORD_SUBMISSION} diff --git a/services/submission/src/main/resources/application-dev.yaml b/services/submission/src/main/resources/application-dev.yaml --- a/services/submission/src/main/resources/application-dev.yaml +++ b/services/submission/src/main/resources/application-dev.yaml @@ -4,3 +4,5 @@ logging: org: springframework: web: DEBUG + app: + coronawarn: DEBUG diff --git a/services/submission/src/main/resources/application-disable-ssl-client-postgres.yaml b/services/submission/src/main/resources/application-disable-ssl-client-postgres.yaml new file mode 100644 --- /dev/null +++ b/services/submission/src/main/resources/application-disable-ssl-client-postgres.yaml @@ -0,0 +1,4 @@ +--- +spring: + datasource: + url: jdbc:postgresql://${POSTGRESQL_SERVICE_HOST:localhost}:${POSTGRESQL_SERVICE_PORT:5432}/${POSTGRESQL_DATABASE:cwa} diff --git a/services/submission/src/main/resources/application-disable-ssl-server.yaml b/services/submission/src/main/resources/application-disable-ssl-server.yaml new file mode 100644 --- /dev/null +++ b/services/submission/src/main/resources/application-disable-ssl-server.yaml @@ -0,0 +1,4 @@ +--- +server: + ssl: + enabled: false diff --git a/services/submission/src/main/resources/application-ssl-client-postgres.yaml b/services/submission/src/main/resources/application-ssl-client-postgres.yaml deleted file mode 100644 --- a/services/submission/src/main/resources/application-ssl-client-postgres.yaml +++ /dev/null @@ -1,4 +0,0 @@ ---- -spring: - datasource: - url: jdbc:postgresql://${POSTGRESQL_SERVICE_HOST}:${POSTGRESQL_SERVICE_PORT}/${POSTGRESQL_DATABASE}?ssl=true&sslmode=verify-full&sslrootcert=${SSL_POSTGRES_CERTIFICATE_PATH}&sslcert=${SSL_SUBMISSION_CERTIFICATE_PATH}&sslkey=${SSL_SUBMISSION_PRIVATE_KEY_PATH} diff --git a/services/submission/src/main/resources/application-ssl-client-verification.yaml b/services/submission/src/main/resources/application-ssl-client-verification.yaml deleted file mode 100644 --- a/services/submission/src/main/resources/application-ssl-client-verification.yaml +++ /dev/null @@ -1,9 +0,0 @@ ---- -client: - ssl: - key-password: ${SSL_SUBMISSION_KEYSTORE_PASSWORD} - key-store: ${SSL_SUBMISSION_KEYSTORE_PATH} - key-store-password: ${SSL_SUBMISSION_KEYSTORE_PASSWORD} - verification: - trust-store: ${SSL_VERIFICATION_TRUSTSTORE_PATH} - trust-store-password: ${SSL_VERIFICATION_TRUSTSTORE_PASSWORD} diff --git a/services/submission/src/main/resources/application-ssl-server.yaml b/services/submission/src/main/resources/application-ssl-server.yaml deleted file mode 100644 --- a/services/submission/src/main/resources/application-ssl-server.yaml +++ /dev/null @@ -1,9 +0,0 @@ ---- -server: - ssl: - enabled: true - key-password: ${SSL_SUBMISSION_KEYSTORE_PASSWORD} - key-store: ${SSL_SUBMISSION_KEYSTORE_PATH} - key-store-password: ${SSL_SUBMISSION_KEYSTORE_PASSWORD} - key-store-provider: SUN - key-store-type: JKS diff --git a/services/submission/src/main/resources/application.yaml b/services/submission/src/main/resources/application.yaml --- a/services/submission/src/main/resources/application.yaml +++ b/services/submission/src/main/resources/application.yaml @@ -4,6 +4,8 @@ logging: org: springframework: web: INFO + app: + coronawarn: INFO services: submission: @@ -11,31 +13,53 @@ services: initial-fake-delay-milliseconds: 10 # The number of samples for the calculation of the moving average for fake request delays. fake-delay-moving-average-samples: 10 + # The retention threshold for acceptable diagnosis keys during submission. retention-days: 14 + # The number of keys to save to the DB for every real submitted key. + # Example: If the 'random-key-padding-multiplier' is set to 10, and 5 keys are being submitted, + # then the 5 real submitted keys will be saved to the DB, plus an additional 45 keys with + # random 'key_data'. All properties, besides the 'key_data', of the additional keys will be + # identical to the real key. + random-key-padding-multiplier: ${RANDOM_KEY_PADDING_MULTIPLIER:1} + # The ApacheHttpClient's connection pool size. + connection-pool-size: 200 payload: + # The maximum number of keys accepted for any submission. max-number-of-keys: 14 verification: base-url: ${VERIFICATION_BASE_URL:http://localhost:8004} path: /version/v1/tan/verify monitoring: + # The batch size (number of requests) to use for monitoring request count. batch-size: 5 + client: + ssl: + key-password: ${SSL_SUBMISSION_KEYSTORE_PASSWORD} + key-store: ${SSL_SUBMISSION_KEYSTORE_PATH} + key-store-password: ${SSL_SUBMISSION_KEYSTORE_PASSWORD} + trust-store: ${SSL_VERIFICATION_TRUSTSTORE_PATH} + trust-store-password: ${SSL_VERIFICATION_TRUSTSTORE_PASSWORD} spring: - jpa: - hibernate: - ddl-auto: validate + lifecycle: + # keep in sync or lower than the kubernetes setting 'terminationGracePeriodSeconds' + # 5s +5s Feign client + 20s DB timeout + timeout-per-shutdown-phase: 30s + transaction: + default-timeout: 20 flyway: enabled: true - locations: classpath:db/migration/postgres - password: ${POSTGRESQL_PASSWORD_FLYWAY:postgres} - user: ${POSTGRESQL_USER_FLYWAY:postgres} -# Postgres configuration + locations: classpath:/db/migration, classpath:/db/specific/{vendor} + password: ${POSTGRESQL_PASSWORD_FLYWAY:local_setup_flyway} + user: ${POSTGRESQL_USER_FLYWAY:local_setup_flyway} + # Postgres configuration datasource: driver-class-name: org.postgresql.Driver - url: jdbc:postgresql://${POSTGRESQL_SERVICE_HOST:localhost}:${POSTGRESQL_SERVICE_PORT:5432}/${POSTGRESQL_DATABASE:cwa} - username: ${POSTGRESQL_USER_SUBMISSION:postgres} - password: ${POSTGRESQL_PASSWORD_SUBMISSION:postgres} + url: jdbc:postgresql://${POSTGRESQL_SERVICE_HOST}:${POSTGRESQL_SERVICE_PORT}/${POSTGRESQL_DATABASE}?ssl=true&sslmode=verify-full&sslrootcert=${SSL_POSTGRES_CERTIFICATE_PATH}&sslcert=${SSL_SUBMISSION_CERTIFICATE_PATH}&sslkey=${SSL_SUBMISSION_PRIVATE_KEY_PATH} + username: ${POSTGRESQL_USER_SUBMISSION:local_setup_submission} + password: ${POSTGRESQL_PASSWORD_SUBMISSION:local_setup_submission} +# Actuator configuration management: server: port: 8081 @@ -60,3 +84,34 @@ management: health: probes: enabled: true + +server: + shutdown: graceful + ssl: + enabled: true + enabled-protocols: TLSv1.2,TLSv1.3 + protocol: TLS + ciphers: >- + TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 + TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 + TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 + TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 + TLS_DHE_DSS_WITH_AES_128_GCM_SHA256 + TLS_DHE_DSS_WITH_AES_256_GCM_SHA384 + TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 + TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 + TLS_AES_128_GCM_SHA256 + TLS_AES_256_GCM_SHA384 + TLS_AES_128_CCM_SHA256 + key-password: ${SSL_SUBMISSION_KEYSTORE_PASSWORD} + key-store: ${SSL_SUBMISSION_KEYSTORE_PATH} + key-store-password: ${SSL_SUBMISSION_KEYSTORE_PASSWORD} + key-store-provider: SUN + key-store-type: JKS + +feign: + client: + config: + default: + connect-timeout: 5000 + read-timeout: 5000 \ No newline at end of file diff --git a/services/submission/src/main/resources/bootstrap-cloud.yaml b/services/submission/src/main/resources/bootstrap-cloud.yaml new file mode 100644 --- /dev/null +++ b/services/submission/src/main/resources/bootstrap-cloud.yaml @@ -0,0 +1,27 @@ +--- +spring: + application: + name: cwa-server + cloud: + vault: + enabled: true + generic: + enabled: false + kv: + enabled: true + backend: ${VAULT_BACKEND} + profile-separator: '/' + application-name: 'submission' + default-context: '' + profiles: cloud + fail-fast: true + authentication: KUBERNETES + kubernetes: + role: ${VAULT_ROLE} + kubernetes-path: kubernetes + service-account-token-file: /var/run/secrets/kubernetes.io/serviceaccount/token + uri: ${VAULT_URI} + connection-timeout: 5000 + read-timeout: 15000 + config: + order: -10 diff --git a/services/submission/src/main/resources/bootstrap.yaml b/services/submission/src/main/resources/bootstrap.yaml new file mode 100644 --- /dev/null +++ b/services/submission/src/main/resources/bootstrap.yaml @@ -0,0 +1,5 @@ +--- +spring: + cloud: + vault: + enabled: false diff --git a/services/submission/src/main/resources/log4j2-dev.xml b/services/submission/src/main/resources/log4j2-dev.xml --- a/services/submission/src/main/resources/log4j2-dev.xml +++ b/services/submission/src/main/resources/log4j2-dev.xml @@ -2,7 +2,7 @@ <Configuration status="WARN"> <Properties> <Property name="LOG_EXCEPTION_CONVERSION_WORD">%xwEx</Property> - <Property name="LOG_DATEFORMAT_PATTERN">yyyy-MM-dd'T'HH:mm:ssXXX</Property> + <Property name="LOG_DATEFORMAT_PATTERN">yyyy-MM-dd'T'HH:mm:ssZ</Property> <Property name="CONSOLE_LOG_PATTERN">%d{${LOG_DATEFORMAT_PATTERN}} %-5level %t %c{1.}[%pid]: %m%n${sys:LOG_EXCEPTION_CONVERSION_WORD}</Property> </Properties> <Appenders> diff --git a/services/submission/src/main/resources/log4j2.xml b/services/submission/src/main/resources/log4j2.xml --- a/services/submission/src/main/resources/log4j2.xml +++ b/services/submission/src/main/resources/log4j2.xml @@ -1,8 +1,8 @@ <?xml version="1.0" encoding="UTF-8"?> <Configuration status="WARN"> <Properties> - <Property name="LOG_DATEFORMAT_PATTERN">yyyy-MM-dd'T'HH:mm:ssXXX</Property> - <Property name="CONSOLE_LOG_PATTERN">%d{${LOG_DATEFORMAT_PATTERN}} %-5level %t %c{1.}[%pid]: %m %replace{%rException}{\n}{\u2028}%n</Property> + <Property name="LOG_DATEFORMAT_PATTERN">yyyy-MM-dd'T'HH:mm:ssZ</Property> + <Property name="CONSOLE_LOG_PATTERN">%d{${LOG_DATEFORMAT_PATTERN}} %-5level %t %c{1.}[%pid]: %m %replace{%rException}{[\r\n]+}{\u2028}%n</Property> </Properties> <Appenders> <Console name="Console" target="SYSTEM_OUT" follow="true"> diff --git a/setup/create-users.sql b/setup/create-users.sql new file mode 100644 --- /dev/null +++ b/setup/create-users.sql @@ -0,0 +1,5 @@ +/* Creates CWA users */ + +CREATE USER "<change me>" WITH INHERIT IN ROLE cwa_flyway ENCRYPTED PASSWORD '<change me>'; +CREATE USER "<change me>" WITH INHERIT IN ROLE cwa_submission ENCRYPTED PASSWORD '<change me>'; +CREATE USER "<change me>" WITH INHERIT IN ROLE cwa_distribution ENCRYPTED PASSWORD '<change me>'; diff --git a/setup/setup-roles.sql b/setup/setup-roles.sql new file mode 100644 --- /dev/null +++ b/setup/setup-roles.sql @@ -0,0 +1,50 @@ +/* + * This SQL file needs to be executed when a new CWA database is set up. + * It will create the necessary roles & restrict permissions to the CWA scope. + */ + +/* Revoke all default access to the database */ +REVOKE ALL ON DATABASE cwa FROM PUBLIC; +REVOKE USAGE ON SCHEMA public FROM PUBLIC; + +/* Create roles */ +CREATE ROLE cwa_user + NOLOGIN + NOSUPERUSER + NOINHERIT + NOCREATEDB + NOCREATEROLE + NOREPLICATION; + +GRANT CONNECT ON DATABASE cwa TO cwa_user; +GRANT USAGE ON SCHEMA public TO cwa_user; + +CREATE ROLE cwa_flyway + NOLOGIN + NOSUPERUSER + INHERIT + NOCREATEDB + NOCREATEROLE + NOREPLICATION + IN ROLE cwa_user; + +/* Flyway user needs to have full access to schema */ +GRANT CREATE ON SCHEMA public TO cwa_flyway; + +CREATE ROLE cwa_submission + NOLOGIN + NOSUPERUSER + INHERIT + NOCREATEDB + NOCREATEROLE + NOREPLICATION + IN ROLE cwa_user; + +CREATE ROLE cwa_distribution + NOLOGIN + NOSUPERUSER + INHERIT + NOCREATEDB + NOCREATEROLE + NOREPLICATION + IN ROLE cwa_user;

diff --git a/common/persistence/src/test/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyBuilderTest.java b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyBuilderTest.java --- a/common/persistence/src/test/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyBuilderTest.java +++ b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyBuilderTest.java @@ -20,6 +20,8 @@ package app.coronawarn.server.common.persistence.domain; +import static app.coronawarn.server.common.persistence.domain.validation.ValidSubmissionTimestampValidator.SECONDS_PER_HOUR; +import static app.coronawarn.server.common.persistence.service.DiagnosisKeyServiceTestHelper.buildDiagnosisKeyForSubmissionTimestamp; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatCode; import static org.assertj.core.api.Assertions.catchThrowable; @@ -27,7 +29,8 @@ import app.coronawarn.server.common.persistence.exception.InvalidDiagnosisKeyException; import app.coronawarn.server.common.protocols.external.exposurenotification.TemporaryExposureKey; import com.google.protobuf.ByteString; -import java.nio.charset.Charset; +import java.nio.charset.StandardCharsets; +import java.time.Duration; import java.time.Instant; import java.time.LocalDate; import java.time.ZoneOffset; @@ -37,7 +40,7 @@ class DiagnosisKeyBuilderTest { - private final byte[] expKeyData = "16-bytelongarray".getBytes(Charset.defaultCharset()); + private final byte[] expKeyData = "16-bytelongarray".getBytes(StandardCharsets.US_ASCII); private final int expRollingStartIntervalNumber = 73800; private final int expTransmissionRiskLevel = 1; private final long expSubmissionTimestamp = 2L; @@ -179,16 +182,43 @@ void rollingPeriodDoesNotThrowForValid() { @ValueSource(strings = {"17--bytelongarray", "", "1"}) void keyDataMustHaveValidLength(String invalidKeyString) { assertThat( - catchThrowable(() -> keyWithKeyData(invalidKeyString.getBytes(Charset.defaultCharset())))) + catchThrowable(() -> keyWithKeyData(invalidKeyString.getBytes(StandardCharsets.US_ASCII)))) .isInstanceOf(InvalidDiagnosisKeyException.class); } @Test void keyDataDoesNotThrowOnValid() { - assertThatCode(() -> keyWithKeyData("16-bytelongarray".getBytes(Charset.defaultCharset()))) + assertThatCode(() -> keyWithKeyData("16-bytelongarray".getBytes(StandardCharsets.US_ASCII))) .doesNotThrowAnyException(); } + @ParameterizedTest + @ValueSource(longs = {-1L, Long.MAX_VALUE}) + void submissionTimestampMustBeValid(long submissionTimestamp) { + assertThat( + catchThrowable(() -> buildDiagnosisKeyForSubmissionTimestamp(submissionTimestamp))) + .isInstanceOf(InvalidDiagnosisKeyException.class); + } + + @Test + void submissionTimestampMustNotBeInTheFuture() { + assertThat(catchThrowable( + () -> buildDiagnosisKeyForSubmissionTimestamp(getCurrentHoursSinceEpoch() + 1))) + .isInstanceOf(InvalidDiagnosisKeyException.class); + assertThat(catchThrowable(() -> buildDiagnosisKeyForSubmissionTimestamp( + Instant.now().getEpochSecond() /* accidentally forgot to divide by SECONDS_PER_HOUR */))) + .isInstanceOf(InvalidDiagnosisKeyException.class); + } + + @Test + void submissionTimestampDoesNotThrowOnValid() { + assertThatCode(() -> buildDiagnosisKeyForSubmissionTimestamp(0L)).doesNotThrowAnyException(); + assertThatCode(() -> buildDiagnosisKeyForSubmissionTimestamp(getCurrentHoursSinceEpoch())).doesNotThrowAnyException(); + assertThatCode( + () -> buildDiagnosisKeyForSubmissionTimestamp(Instant.now().minus(Duration.ofHours(2)).getEpochSecond() / SECONDS_PER_HOUR)) + .doesNotThrowAnyException(); + } + private DiagnosisKey keyWithKeyData(byte[] expKeyData) { return DiagnosisKey.builder() .withKeyData(expKeyData) @@ -223,7 +253,7 @@ private void assertDiagnosisKeyEquals(DiagnosisKey actDiagnosisKey) { } private long getCurrentHoursSinceEpoch() { - return Instant.now().getEpochSecond() / 3600L; + return Instant.now().getEpochSecond() / SECONDS_PER_HOUR; } private void assertDiagnosisKeyEquals(DiagnosisKey actDiagnosisKey, long expSubmissionTimestamp) { diff --git a/common/persistence/src/test/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyServiceMockedRepositoryTest.java b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyServiceMockedRepositoryTest.java --- a/common/persistence/src/test/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyServiceMockedRepositoryTest.java +++ b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyServiceMockedRepositoryTest.java @@ -26,20 +26,20 @@ import app.coronawarn.server.common.persistence.repository.DiagnosisKeyRepository; import app.coronawarn.server.common.persistence.service.DiagnosisKeyService; -import java.nio.charset.Charset; +import java.nio.charset.StandardCharsets; import java.util.ArrayList; import java.util.List; import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest; +import org.springframework.boot.test.autoconfigure.data.jdbc.DataJdbcTest; import org.springframework.boot.test.mock.mockito.MockBean; import org.springframework.data.domain.Sort; import org.springframework.data.domain.Sort.Direction; -@DataJpaTest +@DataJdbcTest class DiagnosisKeyServiceMockedRepositoryTest { - static final byte[] expKeyData = "16-bytelongarray".getBytes(Charset.defaultCharset()); + static final byte[] expKeyData = "16-bytelongarray".getBytes(StandardCharsets.US_ASCII); static final int expRollingStartIntervalNumber = 73800; static final int expTransmissionRiskLevel = 1; @@ -89,7 +89,7 @@ private DiagnosisKey validKey(long expSubmissionTimestamp) { } private DiagnosisKey invalidKey(long expSubmissionTimestamp) { - byte[] expKeyData = "17--bytelongarray".getBytes(Charset.defaultCharset()); + byte[] expKeyData = "17--bytelongarray".getBytes(StandardCharsets.US_ASCII); return new DiagnosisKey(expKeyData, expRollingStartIntervalNumber, DiagnosisKey.EXPECTED_ROLLING_PERIOD, expTransmissionRiskLevel, expSubmissionTimestamp); } diff --git a/common/persistence/src/test/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyTest.java b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyTest.java --- a/common/persistence/src/test/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyTest.java +++ b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/domain/DiagnosisKeyTest.java @@ -25,7 +25,7 @@ import static org.assertj.core.api.Assertions.assertThatCode; import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException; -import java.nio.charset.Charset; +import java.nio.charset.StandardCharsets; import java.time.Instant; import java.time.LocalDateTime; import org.junit.jupiter.api.DisplayName; @@ -35,7 +35,7 @@ class DiagnosisKeyTest { - final static byte[] expKeyData = "testKey111111111".getBytes(Charset.defaultCharset()); + final static byte[] expKeyData = "testKey111111111".getBytes(StandardCharsets.US_ASCII); final static int expRollingStartIntervalNumber = 1; final static int expRollingPeriod = 2; final static int expTransmissionRiskLevel = 3; diff --git a/common/persistence/src/test/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyServiceTest.java b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyServiceTest.java --- a/common/persistence/src/test/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyServiceTest.java +++ b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyServiceTest.java @@ -21,6 +21,8 @@ package app.coronawarn.server.common.persistence.service; import static app.coronawarn.server.common.persistence.service.DiagnosisKeyServiceTestHelper.assertDiagnosisKeysEqual; +import static app.coronawarn.server.common.persistence.service.DiagnosisKeyServiceTestHelper.buildDiagnosisKeyForDateTime; +import static app.coronawarn.server.common.persistence.service.DiagnosisKeyServiceTestHelper.buildDiagnosisKeyForSubmissionTimestamp; import static java.time.ZoneOffset.UTC; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatCode; @@ -33,7 +35,6 @@ import java.util.ArrayList; import java.util.Collections; import java.util.List; -import java.util.Random; import org.assertj.core.util.Lists; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.DisplayName; @@ -41,9 +42,9 @@ import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.ValueSource; import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest; +import org.springframework.boot.test.autoconfigure.data.jdbc.DataJdbcTest; -@DataJpaTest +@DataJdbcTest class DiagnosisKeyServiceTest { @Autowired @@ -171,19 +172,4 @@ void shouldNotUpdateExistingKey() { assertThat(actKeys.size()).isEqualTo(1); assertThat(actKeys.iterator().next().getTransmissionRiskLevel()).isEqualTo(2); } - - public static DiagnosisKey buildDiagnosisKeyForSubmissionTimestamp(long submissionTimeStamp) { - byte[] randomBytes = new byte[16]; - Random random = new Random(submissionTimeStamp); - random.nextBytes(randomBytes); - return DiagnosisKey.builder() - .withKeyData(randomBytes) - .withRollingStartIntervalNumber(600) - .withTransmissionRiskLevel(2) - .withSubmissionTimestamp(submissionTimeStamp).build(); - } - - public static DiagnosisKey buildDiagnosisKeyForDateTime(OffsetDateTime dateTime) { - return buildDiagnosisKeyForSubmissionTimestamp(dateTime.toEpochSecond() / 3600); - } } diff --git a/common/persistence/src/test/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyServiceTestHelper.java b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyServiceTestHelper.java --- a/common/persistence/src/test/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyServiceTestHelper.java +++ b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyServiceTestHelper.java @@ -23,13 +23,15 @@ import static org.assertj.core.api.Assertions.assertThat; import app.coronawarn.server.common.persistence.domain.DiagnosisKey; +import java.time.OffsetDateTime; import java.util.List; +import java.util.Random; public class DiagnosisKeyServiceTestHelper { public static void assertDiagnosisKeysEqual(List<DiagnosisKey> expKeys, List<DiagnosisKey> actKeys) { - assertThat(actKeys).withFailMessage("Cardinality mismatch").isNotNull().hasSize(expKeys.size()); + assertThat(actKeys).withFailMessage("Cardinality mismatch").hasSameSizeAs(expKeys); for (int i = 0; i < expKeys.size(); i++) { var expKey = expKeys.get(i); @@ -48,4 +50,19 @@ public static void assertDiagnosisKeysEqual(List<DiagnosisKey> expKeys, .isEqualTo(expKey.getSubmissionTimestamp()); } } + + public static DiagnosisKey buildDiagnosisKeyForSubmissionTimestamp(long submissionTimeStamp) { + byte[] randomBytes = new byte[16]; + Random random = new Random(submissionTimeStamp); + random.nextBytes(randomBytes); + return DiagnosisKey.builder() + .withKeyData(randomBytes) + .withRollingStartIntervalNumber(600) + .withTransmissionRiskLevel(2) + .withSubmissionTimestamp(submissionTimeStamp).build(); + } + + public static DiagnosisKey buildDiagnosisKeyForDateTime(OffsetDateTime dateTime) { + return buildDiagnosisKeyForSubmissionTimestamp(dateTime.toEpochSecond() / 3600); + } } diff --git a/common/persistence/src/test/resources/application.yaml b/common/persistence/src/test/resources/application.yaml --- a/common/persistence/src/test/resources/application.yaml +++ b/common/persistence/src/test/resources/application.yaml @@ -1,20 +1,16 @@ --- spring: - test: - database: - replace: none flyway: - enabled: false - jpa: - hibernate: - ddl-auto: create - properties: - hibernate: - show_sql: false + enabled: true + locations: classpath:/db/migration, classpath:/db/specific/{vendor} datasource: url: jdbc:h2:mem:test;MODE=PostgreSQL driverClassName: org.h2.Driver platform: h2 + test: + database: + # Use datasource as defined above. + replace: none main: banner-mode: off logging: diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/ApplicationConfigurationMasterFileTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/ApplicationConfigurationMasterFileTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/ApplicationConfigurationMasterFileTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/ApplicationConfigurationMasterFileTest.java @@ -22,19 +22,27 @@ import static org.assertj.core.api.Assertions.assertThat; +import app.coronawarn.server.common.protocols.internal.ApplicationConfiguration; import app.coronawarn.server.services.distribution.assembly.appconfig.validation.ApplicationConfigurationValidator; import app.coronawarn.server.services.distribution.assembly.appconfig.validation.ValidationResult; import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit.jupiter.SpringExtension; +@ExtendWith(SpringExtension.class) +@ContextConfiguration(classes = ApplicationConfigurationPublicationConfig.class) class ApplicationConfigurationMasterFileTest { private static final ValidationResult SUCCESS = new ValidationResult(); - @Test - void testMasterFile() throws UnableToLoadFileException { - var config = ApplicationConfigurationProvider.readMasterFile(); + @Autowired + private ApplicationConfiguration applicationConfiguration; - var validator = new ApplicationConfigurationValidator(config); + @Test + void testMasterFile() { + var validator = new ApplicationConfigurationValidator(applicationConfiguration); ValidationResult result = validator.validate(); assertThat(result).isEqualTo(SUCCESS); diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/ApplicationConfigurationProviderTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/YamlLoaderTest.java similarity index 74% rename from services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/ApplicationConfigurationProviderTest.java rename to services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/YamlLoaderTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/ApplicationConfigurationProviderTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/YamlLoaderTest.java @@ -20,6 +20,7 @@ package app.coronawarn.server.services.distribution.assembly.appconfig; +import static app.coronawarn.server.services.distribution.common.Helpers.loadApplicationConfiguration; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatExceptionOfType; @@ -27,11 +28,11 @@ import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.ValueSource; -class ApplicationConfigurationProviderTest { +class YamlLoaderTest { @Test void okFile() throws UnableToLoadFileException { - var result = ApplicationConfigurationProvider.readFile("configtests/app-config_ok.yaml"); + var result = loadApplicationConfiguration("configtests/app-config_ok.yaml"); assertThat(result).withFailMessage("File is null, indicating loading failed").isNotNull(); } @@ -39,11 +40,11 @@ void okFile() throws UnableToLoadFileException { @ValueSource(strings = { "configtests/app-config_empty.yaml", "configtests/wrong_file.yaml", - "configtests/broken_syntax.yaml", - "file_does_not_exist_anywhere.yaml" + "configtests/app-config_broken_syntax.yaml", + "configtests/naming_mismatch.yaml", + "configtests/file_does_not_exist_anywhere.yaml" }) void throwsLoadFailure(String fileName) { - assertThatExceptionOfType(UnableToLoadFileException.class) - .isThrownBy(() -> ApplicationConfigurationProvider.readFile(fileName)); + assertThatExceptionOfType(UnableToLoadFileException.class).isThrownBy(() -> loadApplicationConfiguration(fileName)); } } diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/parsing/NoMessageBuilderOnClassExceptionTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/parsing/NoMessageBuilderOnClassExceptionTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/parsing/NoMessageBuilderOnClassExceptionTest.java @@ -0,0 +1,40 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.assembly.appconfig.parsing; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; + +import org.junit.jupiter.api.Test; +import org.yaml.snakeyaml.nodes.Node; + +class NoMessageBuilderOnClassExceptionTest { + + @Test + void testCorrectMessage() { + Node node = mock(Node.class); + Class expType = String.class; + when(node.getType()).thenReturn(expType); + NoMessageBuilderOnClassException actException = new NoMessageBuilderOnClassException(node); + assertThat(actException.getMessage()).isEqualTo("No Message.Builder on class: " + expType.getSimpleName()); + } +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/structure/AppConfigurationDirectoryTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/structure/AppConfigurationDirectoryTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/structure/AppConfigurationDirectoryTest.java @@ -0,0 +1,105 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.assembly.appconfig.structure; + +import static app.coronawarn.server.services.distribution.common.Helpers.loadApplicationConfiguration; +import static java.io.File.separator; +import static java.lang.String.join; +import static org.assertj.core.api.Assertions.assertThat; + +import app.coronawarn.server.common.protocols.internal.ApplicationConfiguration; +import app.coronawarn.server.services.distribution.assembly.appconfig.ApplicationConfigurationPublicationConfig; +import app.coronawarn.server.services.distribution.assembly.appconfig.UnableToLoadFileException; +import app.coronawarn.server.services.distribution.assembly.appconfig.structure.directory.AppConfigurationDirectory; +import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; +import app.coronawarn.server.services.distribution.assembly.structure.WritableOnDisk; +import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; +import app.coronawarn.server.services.distribution.assembly.structure.directory.DirectoryOnDisk; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; +import app.coronawarn.server.services.distribution.common.Helpers; +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import java.io.File; +import java.io.IOException; +import java.util.Set; +import org.junit.Rule; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.junit.rules.TemporaryFolder; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.boot.test.context.ConfigFileApplicationContextInitializer; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit.jupiter.SpringExtension; + +@EnableConfigurationProperties(value = DistributionServiceConfig.class) +@ExtendWith(SpringExtension.class) +@ContextConfiguration(classes = {CryptoProvider.class, ApplicationConfigurationPublicationConfig.class}, + initializers = ConfigFileApplicationContextInitializer.class) +class AppConfigurationDirectoryTest { + + @Rule + private TemporaryFolder outputFolder = new TemporaryFolder(); + + @Autowired + private CryptoProvider cryptoProvider; + + @Autowired + private DistributionServiceConfig distributionServiceConfigSpy; + + @Autowired + private ApplicationConfiguration applicationConfiguration; + + @Test + void createsCorrectFiles() throws IOException { + Set<String> expFiles = Set.of( + join(separator, "configuration", "country", "index"), + join(separator, "configuration", "country", "index.checksum"), + join(separator, "configuration", "country", "DE", "app_config"), + join(separator, "configuration", "country", "DE", "app_config.checksum")); + + assertThat(writeDirectoryAndGetFiles(applicationConfiguration)).isEqualTo(expFiles); + } + + @Test + void doesNotWriteAppConfigIfValidationFails() throws IOException, UnableToLoadFileException { + ApplicationConfiguration invalidConfiguration = + loadApplicationConfiguration("configtests/app-config_mrs_negative.yaml"); + + Set<String> expFiles = Set.of( + join(separator, "configuration", "country", "index"), + join(separator, "configuration", "country", "index.checksum")); + + assertThat(writeDirectoryAndGetFiles(invalidConfiguration)).isEqualTo(expFiles); + } + + private Set<String> writeDirectoryAndGetFiles(ApplicationConfiguration applicationConfiguration) throws IOException { + outputFolder.create(); + File outputFile = outputFolder.newFolder(); + Directory<WritableOnDisk> parentDirectory = new DirectoryOnDisk(outputFile); + AppConfigurationDirectory configurationDirectory = + new AppConfigurationDirectory(applicationConfiguration, cryptoProvider, distributionServiceConfigSpy); + parentDirectory.addWritable(configurationDirectory); + + configurationDirectory.prepare(new ImmutableStack<>()); + configurationDirectory.write(); + return Helpers.getFilePaths(outputFile, outputFile.getAbsolutePath()); + } +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ApplicationConfigurationValidatorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ApplicationConfigurationValidatorTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ApplicationConfigurationValidatorTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ApplicationConfigurationValidatorTest.java @@ -24,10 +24,10 @@ import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ParameterSpec.RISK_SCORE_MIN; import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidatorTest.buildError; import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ValidationError.ErrorType.VALUE_OUT_OF_BOUNDS; +import static app.coronawarn.server.services.distribution.common.Helpers.loadApplicationConfiguration; import static org.assertj.core.api.Assertions.assertThat; -import static org.assertj.core.api.Assertions.assertThatThrownBy; +import static org.assertj.core.api.Assertions.assertThatExceptionOfType; -import app.coronawarn.server.services.distribution.assembly.appconfig.ApplicationConfigurationProvider; import app.coronawarn.server.services.distribution.assembly.appconfig.UnableToLoadFileException; import java.util.stream.Stream; import org.junit.jupiter.api.Test; @@ -38,8 +38,7 @@ class ApplicationConfigurationValidatorTest { private static final ValidationResult SUCCESS = new ValidationResult(); - - private static final TestWithExpectedResult.Builder testBuilder = new TestWithExpectedResult.Builder("configtests/"); + private static final TestWithExpectedResult.Builder TEST_BUILDER = new TestWithExpectedResult.Builder("configtests/"); @ParameterizedTest @MethodSource("createOkTests") @@ -55,22 +54,18 @@ void negative(TestWithExpectedResult test) throws UnableToLoadFileException { @Test void circular() { - assertThatThrownBy(() -> { - ApplicationConfigurationProvider.readFile("configtests/app-config_circular.yaml"); - }).isInstanceOf(UnableToLoadFileException.class); + assertThatExceptionOfType(UnableToLoadFileException.class) + .isThrownBy(() -> loadApplicationConfiguration("configtests/app-config_circular.yaml")); } - private ValidationResult getResultForTest(TestWithExpectedResult test) - throws UnableToLoadFileException { - var config = ApplicationConfigurationProvider.readFile(test.path()); + private ValidationResult getResultForTest(TestWithExpectedResult test) throws UnableToLoadFileException { + var config = loadApplicationConfiguration(test.path()); var validator = new ApplicationConfigurationValidator(config); return validator.validate(); } private static Stream<Arguments> createOkTests() { - return Stream.of( - AllOk() - ).map(Arguments::of); + return Stream.of(AllOk()).map(Arguments::of); } private static Stream<Arguments> createNegativeTests() { @@ -81,16 +76,16 @@ private static Stream<Arguments> createNegativeTests() { } public static TestWithExpectedResult AllOk() { - return testBuilder.build("app-config_ok.yaml"); + return TEST_BUILDER.build("app-config_ok.yaml"); } public static TestWithExpectedResult MinRiskThresholdOutOfBoundsNegative() { - return testBuilder.build("app-config_mrs_negative.yaml") + return TEST_BUILDER.build("app-config_mrs_negative.yaml") .with(buildError("min-risk-score", RISK_SCORE_MIN - 1, VALUE_OUT_OF_BOUNDS)); } public static TestWithExpectedResult MinRiskThresholdOutOfBoundsPositive() { - return testBuilder.build("app-config_mrs_oob.yaml") + return TEST_BUILDER.build("app-config_mrs_oob.yaml") .with(buildError("min-risk-score", RISK_SCORE_MAX + 1, VALUE_OUT_OF_BOUNDS)); } } diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ExposureConfigurationValidatorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ExposureConfigurationValidatorTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ExposureConfigurationValidatorTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ExposureConfigurationValidatorTest.java @@ -22,9 +22,7 @@ import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ExposureConfigurationValidator.CONFIG_PREFIX; import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.RiskScoreClassificationValidatorTest.buildError; -import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ValidationError.ErrorType.MISSING_ENTRY; -import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ValidationError.ErrorType.TOO_MANY_DECIMAL_PLACES; -import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ValidationError.ErrorType.VALUE_OUT_OF_BOUNDS; +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ValidationError.ErrorType.*; import static org.assertj.core.api.Assertions.assertThat; import app.coronawarn.server.common.protocols.internal.RiskLevel; @@ -69,8 +67,6 @@ private static Stream<Arguments> createOkTests() { private static Stream<Arguments> createFailedTests() { return Stream.of( ScoreTooHigh(), - // TODO cwa-server/#320 Validate that no attributes are missing in .yaml - // ScoreNegative(), WeightNegative(), WeightTooHigh() ).map(Arguments::of); @@ -103,12 +99,6 @@ public static TestWithExpectedResult WeightTooHigh() { .with(buildError(CONFIG_PREFIX + "transmission", 101d, VALUE_OUT_OF_BOUNDS)); } - public static TestWithExpectedResult ScoreNegative() { - return new TestWithExpectedResult("score_negative.yaml") - .with(buildError(CONFIG_PREFIX + "transmission.appDefined1", RiskLevel.UNRECOGNIZED, VALUE_OUT_OF_BOUNDS)) - .with(buildError(CONFIG_PREFIX + "transmission.appDefined3", null, MISSING_ENTRY)); - } - public static TestWithExpectedResult ScoreTooHigh() { return new TestWithExpectedResult("score_too_high.yaml") .with(buildError(CONFIG_PREFIX + "transmission.appDefined1", RiskLevel.UNRECOGNIZED, VALUE_OUT_OF_BOUNDS)) diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ValidationResultTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ValidationResultTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/appconfig/validation/ValidationResultTest.java @@ -0,0 +1,60 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.assembly.appconfig.validation; + +import static app.coronawarn.server.services.distribution.assembly.appconfig.validation.ValidationError.ErrorType.INVALID_URL; +import static org.assertj.core.api.Assertions.assertThat; + +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +class ValidationResultTest { + + private static final ValidationError EXP_VALIDATION_ERROR = new ValidationError("expSrc", "expValue", INVALID_URL); + private ValidationResult emptyValidationResult; + + @BeforeEach + void setUpEmptyResult() { + emptyValidationResult = new ValidationResult(); + } + + @Test + void hasErrorsReturnsFalseIfNoErrors() { + assertThat(emptyValidationResult.hasErrors()).isFalse(); + } + + @Test + void hasErrorsReturnsTrueIfErrors() { + emptyValidationResult.add(EXP_VALIDATION_ERROR); + assertThat(emptyValidationResult.hasErrors()).isTrue(); + } + + @Test + void toStringReturnsCorrectErrorInformation() { + emptyValidationResult.add(EXP_VALIDATION_ERROR); + assertThat(emptyValidationResult).hasToString("[" + EXP_VALIDATION_ERROR.toString() + "]"); + } + + @Test + void toStringReturnsCorrectErrorInformationIfEmpty() { + assertThat(emptyValidationResult).hasToString("[]"); + } +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundlerKeyRetrievalTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundlerKeyRetrievalTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundlerKeyRetrievalTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundlerKeyRetrievalTest.java @@ -144,18 +144,18 @@ void testGetsDiagnosisKeysForDate() { .flatMap(List::stream) .collect(Collectors.toList()); bundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 20, 0)); - assertThat(bundler.getDiagnosisKeysForDate(LocalDate.of(1970, 1, 1))).hasSize(0); + assertThat(bundler.getDiagnosisKeysForDate(LocalDate.of(1970, 1, 1))).isEmpty(); assertThat(bundler.getDiagnosisKeysForDate(LocalDate.of(1970, 1, 2))).hasSize(5); - assertThat(bundler.getDiagnosisKeysForDate(LocalDate.of(1970, 1, 3))).hasSize(0); + assertThat(bundler.getDiagnosisKeysForDate(LocalDate.of(1970, 1, 3))).isEmpty(); assertThat(bundler.getDiagnosisKeysForDate(LocalDate.of(1970, 1, 4))).hasSize(6); - assertThat(bundler.getDiagnosisKeysForDate(LocalDate.of(1970, 1, 5))).hasSize(0); + assertThat(bundler.getDiagnosisKeysForDate(LocalDate.of(1970, 1, 5))).isEmpty(); } @Test void testEmptyListWhenGettingDiagnosisKeysForDateBeforeEarliestDiagnosisKey() { List<DiagnosisKey> diagnosisKeys = buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 2, 4, 0), 5); bundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); - assertThat(bundler.getDiagnosisKeysForDate(LocalDate.of(1970, 1, 1))).hasSize(0); + assertThat(bundler.getDiagnosisKeysForDate(LocalDate.of(1970, 1, 1))).isEmpty(); } @Test @@ -167,17 +167,25 @@ void testGetsDiagnosisKeysForHour() { .flatMap(List::stream) .collect(Collectors.toList()); bundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); - assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 2, 3, 0))).hasSize(0); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 2, 3, 0))).isEmpty(); assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 2, 4, 0))).hasSize(5); - assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 2, 5, 0))).hasSize(0); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 2, 5, 0))).isEmpty(); assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 2, 6, 0))).hasSize(6); - assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 2, 7, 0))).hasSize(0); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 2, 7, 0))).isEmpty(); } @Test void testEmptyListWhenGettingDiagnosisKeysForHourBeforeEarliestDiagnosisKey() { List<DiagnosisKey> diagnosisKeys = buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 2, 4, 0), 5); bundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); - assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 1, 0, 0, 0))).hasSize(0); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 1, 0, 0, 0))).isEmpty(); + } + + @Test + void testGetsCorrectDistributionDate(){ + LocalDateTime expected = LocalDateTime.of(1970, 1, 5, 0, 0); + List<DiagnosisKey> diagnosisKeys = buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 2, 4, 0), 5); + bundler.setDiagnosisKeys(diagnosisKeys, expected); + assertThat(bundler.getDistributionTime()).isEqualTo(expected); } } diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundlerShiftingPolicyTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundlerShiftingPolicyTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundlerShiftingPolicyTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundlerShiftingPolicyTest.java @@ -69,7 +69,7 @@ void testShiftsIfPackageSizeLessThanThreshold() { .concat(buildDiagnosisKeys(6, 50L, 4).stream(), buildDiagnosisKeys(6, 51L, 1).stream()) .collect(Collectors.toList()); bundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); - assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 2, 0, 0))).hasSize(0); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 2, 0, 0))).isEmpty(); assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 3, 0, 0))).hasSize(5); } @@ -81,9 +81,9 @@ void testShiftsSinceLastDistribution() { .collect(Collectors.toList()); bundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 2, 0, 0))).hasSize(5); - assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 3, 0, 0))).hasSize(0); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 3, 0, 0))).isEmpty(); assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 4, 0, 0))).hasSize(6); - assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 5, 0, 0))).hasSize(0); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 5, 0, 0))).isEmpty(); } @Test @@ -92,7 +92,7 @@ void testShiftIncludesPreviouslyUndistributedKeys() { .concat(buildDiagnosisKeys(6, 50L, 1).stream(), buildDiagnosisKeys(6, 51L, 5).stream()) .collect(Collectors.toList()); bundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); - assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 2, 0, 0))).hasSize(0); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 2, 0, 0))).isEmpty(); assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 3, 0, 0))).hasSize(6); } @@ -105,12 +105,12 @@ void testShiftsSparseDistributions() { .flatMap(List::stream) .collect(Collectors.toList()); bundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); - assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 2, 0, 0))).hasSize(0); - assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 3, 0, 0))).hasSize(0); - assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 4, 0, 0))).hasSize(0); - assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 5, 0, 0))).hasSize(0); - assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 6, 0, 0))).hasSize(0); - assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 7, 0, 0))).hasSize(0); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 2, 0, 0))).isEmpty(); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 3, 0, 0))).isEmpty(); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 4, 0, 0))).isEmpty(); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 5, 0, 0))).isEmpty(); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 6, 0, 0))).isEmpty(); + assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 7, 0, 0))).isEmpty(); assertThat(bundler.getDiagnosisKeysForHour(LocalDateTime.of(1970, 1, 3, 8, 0, 0))).hasSize(5); } } diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectoryTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectoryTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectoryTest.java @@ -0,0 +1,209 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory; + +import static app.coronawarn.server.services.distribution.common.Helpers.buildDiagnosisKeys; +import static app.coronawarn.server.services.distribution.common.Helpers.getExpectedDateAndHourFiles; +import static java.io.File.separator; +import static org.assertj.core.api.Assertions.assertThat; + +import app.coronawarn.server.common.persistence.domain.DiagnosisKey; +import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.DiagnosisKeyBundler; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.ProdDiagnosisKeyBundler; +import app.coronawarn.server.services.distribution.assembly.structure.WritableOnDisk; +import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; +import app.coronawarn.server.services.distribution.assembly.structure.directory.DirectoryOnDisk; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; +import app.coronawarn.server.services.distribution.common.Helpers; +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import java.io.File; +import java.io.IOException; +import java.time.LocalDateTime; +import java.util.Collection; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.stream.Collectors; +import java.util.stream.IntStream; +import org.junit.Rule; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.junit.rules.TemporaryFolder; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.boot.test.context.ConfigFileApplicationContextInitializer; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit.jupiter.SpringExtension; + +@EnableConfigurationProperties(value = DistributionServiceConfig.class) +@ExtendWith(SpringExtension.class) +@ContextConfiguration(classes = {CryptoProvider.class, DistributionServiceConfig.class}, + initializers = ConfigFileApplicationContextInitializer.class) +class DiagnosisKeysDateDirectoryTest { + + @Rule + private final TemporaryFolder outputFolder = new TemporaryFolder(); + + @Autowired + CryptoProvider cryptoProvider; + + @Autowired + DistributionServiceConfig distributionServiceConfig; + + private File outputFile; + + @BeforeEach + void setupAll() throws IOException { + outputFolder.create(); + outputFile = outputFolder.newFolder(); + } + + private void runDateDistribution(Collection<DiagnosisKey> diagnosisKeys, LocalDateTime distributionTime) { + DiagnosisKeyBundler bundler = new ProdDiagnosisKeyBundler(distributionServiceConfig); + bundler + .setDiagnosisKeys(diagnosisKeys, distributionTime); + DiagnosisKeysDateDirectory dateDirectory = new DiagnosisKeysDateDirectory(bundler, cryptoProvider, + distributionServiceConfig); + Directory<WritableOnDisk> outputDirectory = new DirectoryOnDisk(outputFile); + outputDirectory.addWritable(dateDirectory); + dateDirectory.prepare(new ImmutableStack<>() + .push("version-directory") + .push("country-directory")); + outputDirectory.write(); + } + + @Test + void testCreatesCorrectDirectoryStructureForMultipleDates() { + Collection<DiagnosisKey> diagnosisKeys = IntStream.range(0, 3) + .mapToObj(currentDate -> IntStream.range(0, 5) + .mapToObj(currentHour -> + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3 + currentDate, 0, 0).plusHours(currentHour), 5)) + .flatMap(List::stream) + .collect(Collectors.toList())) + .flatMap(List::stream) + .collect(Collectors.toList()); + runDateDistribution(diagnosisKeys, LocalDateTime.of(1970, 1, 6, 0, 0)); + Set<String> actualFiles = Helpers.getFilePaths(outputFile, outputFile.getAbsolutePath()); + Set<String> expectedDateAndHourFiles = getExpectedDateAndHourFiles(Map.of( + "1970-01-03", List.of("0", "1", "2", "3", "4"), + "1970-01-04", List.of("0", "1", "2", "3", "4"), + "1970-01-05", List.of("0", "1", "2", "3", "4")), "1970-01-06"); + assertThat(actualFiles).isEqualTo(expectedDateAndHourFiles); + } + + @Test + void testDoesNotIncludeCurrentDateInDirectoryStructure() { + Collection<DiagnosisKey> diagnosisKeys = IntStream.range(0, 3) + .mapToObj(currentDate -> IntStream.range(0, 5) + .mapToObj(currentHour -> + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3 + currentDate, 0, 0).plusHours(currentHour), 5)) + .flatMap(List::stream) + .collect(Collectors.toList())) + .flatMap(List::stream) + .collect(Collectors.toList()); + runDateDistribution(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 12, 0)); + Set<String> actualFiles = Helpers.getFilePaths(outputFile, outputFile.getAbsolutePath()); + Set<String> expectedDateAndHourFiles = getExpectedDateAndHourFiles(Map.of( + "1970-01-03", List.of("0", "1", "2", "3", "4"), + "1970-01-04", List.of("0", "1", "2", "3", "4"), + "1970-01-05", List.of("0", "1", "2", "3", "4")), "1970-01-05"); + assertThat(actualFiles).isEqualTo(expectedDateAndHourFiles); + } + + @Test + void testDoesNotIncludeEmptyDatesInDirectoryStructure() { + Collection<DiagnosisKey> diagnosisKeys = IntStream.range(0, 3) + .filter(currentDate -> currentDate != 1) + .mapToObj(currentDate -> IntStream.range(0, 5) + .mapToObj(currentHour -> + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3 + currentDate, 0, 0).plusHours(currentHour), 5)) + .flatMap(List::stream) + .collect(Collectors.toList())) + .flatMap(List::stream) + .collect(Collectors.toList()); + + runDateDistribution(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 12, 0)); + Set<String> actualFiles = Helpers.getFilePaths(outputFile, outputFile.getAbsolutePath()); + Set<String> expectedDateAndHourFiles = getExpectedDateAndHourFiles(Map.of( + "1970-01-03", List.of("0", "1", "2", "3", "4"), + "1970-01-05", List.of("0", "1", "2", "3", "4")), "1970-01-05"); + assertThat(actualFiles).isEqualTo(expectedDateAndHourFiles); + } + + @Test + void testDoesNotIncludeDatesWithTooFewKeysInDirectoryStructure() { + Collection<DiagnosisKey> diagnosisKeys = List.of( + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 1, 0), 5), + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 4, 1, 0), 4), + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 5, 1, 0), 5)) + .stream() + .flatMap(List::stream) + .collect(Collectors.toList()); + runDateDistribution(diagnosisKeys, LocalDateTime.of(1970, 1, 6, 12, 0)); + Set<String> actualFiles = Helpers.getFilePaths(outputFile, outputFile.getAbsolutePath()); + Set<String> expectedDateAndHourFiles = getExpectedDateAndHourFiles(Map.of( + "1970-01-03", List.of("1"), + "1970-01-05", List.of("1")), "1970-01-06"); + assertThat(actualFiles).isEqualTo(expectedDateAndHourFiles); + } + + @Test + void testDoesNotIncludeDatesInTheFuture() { + Collection<DiagnosisKey> diagnosisKeys = List.of( + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 1, 0), 5), + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 4, 1, 0), 5), + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 5, 1, 0), 5)) + .stream() + .flatMap(List::stream) + .collect(Collectors.toList()); + runDateDistribution(diagnosisKeys, LocalDateTime.of(1970, 1, 4, 12, 0)); + Set<String> actualFiles = Helpers.getFilePaths(outputFile, outputFile.getAbsolutePath()); + Set<String> expectedDateAndHourFiles = getExpectedDateAndHourFiles(Map.of( + "1970-01-03", List.of("1"), + "1970-01-04", List.of("1")), "1970-01-04"); + assertThat(actualFiles).isEqualTo(expectedDateAndHourFiles); + } + + @Test + void testWhenDemoProfileIsActiveItDoesIncludeCurrentDateInDirectoryStructure() { + distributionServiceConfig.setIncludeIncompleteDays(true); + Collection<DiagnosisKey> diagnosisKeys = IntStream.range(0, 3) + .mapToObj(currentDate -> IntStream.range(0, 5) + .mapToObj(currentHour -> + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3 + currentDate, 0, 0).plusHours(currentHour), 5)) + .flatMap(List::stream) + .collect(Collectors.toList())) + .flatMap(List::stream) + .collect(Collectors.toList()); + runDateDistribution(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 12, 0)); + Set<String> actualFiles = Helpers.getFilePaths(outputFile, outputFile.getAbsolutePath()); + Set<String> expectedDateAndHourFiles = getExpectedDateAndHourFiles(Map.of( + "1970-01-03", List.of("0", "1", "2", "3", "4"), + "1970-01-04", List.of("0", "1", "2", "3", "4"), + "1970-01-05", List.of("0", "1", "2", "3", "4")), "1970-01-05"); + expectedDateAndHourFiles.addAll(Set.of( + String.join(separator, "date", "1970-01-05", "index"), + String.join(separator, "date", "1970-01-05", "index.checksum"))); + assertThat(actualFiles).isEqualTo(expectedDateAndHourFiles); + } +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDirectoryTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDirectoryTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDirectoryTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDirectoryTest.java @@ -21,6 +21,7 @@ package app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory; import static app.coronawarn.server.services.distribution.common.Helpers.buildDiagnosisKeys; +import static app.coronawarn.server.services.distribution.common.Helpers.getFilePaths; import static java.lang.String.join; import static org.assertj.core.api.Assertions.assertThat; @@ -37,10 +38,8 @@ import java.io.File; import java.io.IOException; import java.time.LocalDateTime; -import java.util.Arrays; import java.util.HashSet; import java.util.List; -import java.util.Objects; import java.util.Set; import java.util.stream.Collectors; import java.util.stream.IntStream; @@ -108,7 +107,7 @@ void checkBuildsTheCorrectDirectoryStructureWhenNoKeys() { join(s, "diagnosis-keys", "country", "DE", "date", "index") ); - Set<String> actualFiles = getActualFiles(outputFile); + Set<String> actualFiles = getFilePaths(outputFile, outputFile.getAbsolutePath()); assertThat(actualFiles).isEqualTo(amendWithChecksumFiles(expectedFiles)); } @@ -163,7 +162,7 @@ void checkBuildsTheCorrectDirectoryStructure() { join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "hour", "5", "index") ); - Set<String> actualFiles = getActualFiles(outputFile); + Set<String> actualFiles = getFilePaths(outputFile, outputFile.getAbsolutePath()); assertThat(actualFiles).isEqualTo(amendWithChecksumFiles(expectedFiles)); } @@ -178,24 +177,4 @@ private Set<String> amendWithChecksumFiles(Set<String> expectedFiles) { return allExpectedFiles; } - - private Set<String> getActualFiles(java.io.File root) { - Set<String> files = Arrays.stream(Objects.requireNonNull(root.listFiles())) - .filter(File::isFile) - .map(File::getAbsolutePath) - .map(path -> path.substring(outputFile.getAbsolutePath().length() + 1)) - .collect(Collectors.toSet()); - - Set<java.io.File> directories = Arrays.stream(Objects.requireNonNull(root.listFiles())) - .filter(File::isDirectory) - .collect(Collectors.toSet()); - - Set<String> subFiles = directories.stream() - .map(this::getActualFiles) - .flatMap(Set::stream) - .collect(Collectors.toSet()); - - files.addAll(subFiles); - return files; - } } diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectoryTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectoryTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectoryTest.java @@ -0,0 +1,156 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.directory; + +import static app.coronawarn.server.services.distribution.common.Helpers.buildDiagnosisKeys; +import static app.coronawarn.server.services.distribution.common.Helpers.getExpectedHourFiles; +import static app.coronawarn.server.services.distribution.common.Helpers.getFilePaths; +import static org.assertj.core.api.Assertions.assertThat; + +import app.coronawarn.server.common.persistence.domain.DiagnosisKey; +import app.coronawarn.server.services.distribution.assembly.component.CryptoProvider; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.DiagnosisKeyBundler; +import app.coronawarn.server.services.distribution.assembly.diagnosiskeys.ProdDiagnosisKeyBundler; +import app.coronawarn.server.services.distribution.assembly.structure.WritableOnDisk; +import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; +import app.coronawarn.server.services.distribution.assembly.structure.directory.DirectoryOnDisk; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import java.io.File; +import java.io.IOException; +import java.time.LocalDate; +import java.time.LocalDateTime; +import java.util.Collection; +import java.util.List; +import java.util.Set; +import java.util.stream.Collectors; +import java.util.stream.IntStream; +import org.junit.Rule; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.junit.rules.TemporaryFolder; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.boot.test.context.ConfigFileApplicationContextInitializer; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit.jupiter.SpringExtension; + +@EnableConfigurationProperties(value = DistributionServiceConfig.class) +@ExtendWith(SpringExtension.class) +@ContextConfiguration(classes = {CryptoProvider.class, DistributionServiceConfig.class}, + initializers = ConfigFileApplicationContextInitializer.class) +class DiagnosisKeysHourDirectoryTest { + + @Rule + private final TemporaryFolder outputFolder = new TemporaryFolder(); + + @Autowired + CryptoProvider cryptoProvider; + + @Autowired + DistributionServiceConfig distributionServiceConfig; + + private File outputFile; + + @BeforeEach + void setupAll() throws IOException { + outputFolder.create(); + outputFile = outputFolder.newFolder(); + } + + private void runHourDistribution(Collection<DiagnosisKey> diagnosisKeys, LocalDateTime distributionTime) { + DiagnosisKeyBundler bundler = new ProdDiagnosisKeyBundler(distributionServiceConfig); + bundler.setDiagnosisKeys(diagnosisKeys, distributionTime); + DiagnosisKeysHourDirectory hourDirectory = new DiagnosisKeysHourDirectory(bundler, cryptoProvider, + distributionServiceConfig); + Directory<WritableOnDisk> outputDirectory = new DirectoryOnDisk(outputFile); + outputDirectory.addWritable(hourDirectory); + hourDirectory.prepare(new ImmutableStack<>() + .push("version-directory") + .push("country-directory") + .push(LocalDate.of(1970, 1, 3)) // date-directory + ); + outputDirectory.write(); + } + + @Test + void testCreatesCorrectStructureForMultipleHours() { + Collection<DiagnosisKey> diagnosisKeys = IntStream.range(0, 5) + .mapToObj(currentHour -> buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 0, 0).plusHours(currentHour), 5)) + .flatMap(List::stream) + .collect(Collectors.toList()); + runHourDistribution(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); + Set<String> actualFiles = getFilePaths(outputFile, outputFile.getAbsolutePath()); + assertThat(actualFiles).isEqualTo(getExpectedHourFiles(Set.of("0", "1", "2", "3", "4"))); + } + + @Test + void testDoesNotIncludeEmptyHours() { + Collection<DiagnosisKey> diagnosisKeys = IntStream.range(0, 5) + .filter(currentHour -> currentHour != 3) + .mapToObj(currentHour -> buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 0, 0).plusHours(currentHour), 5)) + .flatMap(List::stream) + .collect(Collectors.toList()); + runHourDistribution(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); + Set<String> actualFiles = getFilePaths(outputFile, outputFile.getAbsolutePath()); + assertThat(actualFiles).isEqualTo(getExpectedHourFiles(Set.of("0", "1", "2", "4"))); + } + + @Test + void testDoesNotIncludeCurrentHour() { + Collection<DiagnosisKey> diagnosisKeys = IntStream.range(0, 5) + .mapToObj(currentHour -> buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 0, 0).plusHours(currentHour), 5)) + .flatMap(List::stream) + .collect(Collectors.toList()); + runHourDistribution(diagnosisKeys, LocalDateTime.of(1970, 1, 3, 4, 0)); + Set<String> actualFiles = getFilePaths(outputFile, outputFile.getAbsolutePath()); + assertThat(actualFiles).isEqualTo(getExpectedHourFiles(Set.of("0", "1", "2", "3"))); + } + + @Test + void testDoesNotIncludeHoursWithTooFewKeys() { + Collection<DiagnosisKey> diagnosisKeys = List.of( + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 0, 0), 5), + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 1, 0), 4), + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 2, 0), 5)) + .stream() + .flatMap(List::stream) + .collect(Collectors.toList()); + runHourDistribution(diagnosisKeys, LocalDateTime.of(1970, 1, 6, 12, 0)); + Set<String> actualFiles = getFilePaths(outputFile, outputFile.getAbsolutePath()); + assertThat(actualFiles).isEqualTo(getExpectedHourFiles(Set.of("0", "2"))); + } + + @Test + void testDoesNotIncludeHoursInTheFuture() { + Collection<DiagnosisKey> diagnosisKeys = List.of( + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 0, 0), 5), + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 1, 0), 5), + buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 2, 0), 5)) + .stream() + .flatMap(List::stream) + .collect(Collectors.toList()); + runHourDistribution(diagnosisKeys, LocalDateTime.of(1970, 1, 3, 1, 0)); + Set<String> actualFiles = getFilePaths(outputFile, outputFile.getAbsolutePath()); + assertThat(actualFiles).isEqualTo(getExpectedHourFiles(Set.of("0"))); + } +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/DateIndexingDecoratorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/DateIndexingDecoratorTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/DateIndexingDecoratorTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/DateIndexingDecoratorTest.java @@ -80,9 +80,9 @@ void excludesEmptyDatesFromIndex() { Set<LocalDate> index = decorator.getIndex(new ImmutableStack<>()); - assertThat(index).contains(LocalDate.of(1970, 1, 3)); - assertThat(index).doesNotContain(LocalDate.of(1970, 1, 4)); - assertThat(index).contains(LocalDate.of(1970, 1, 5)); + assertThat(index).contains(LocalDate.of(1970, 1, 3)) + .doesNotContain(LocalDate.of(1970, 1, 4)) + .contains(LocalDate.of(1970, 1, 5)); } @Test @@ -94,8 +94,8 @@ void excludesCurrentDateFromIndex() { Set<LocalDate> index = decorator.getIndex(new ImmutableStack<>()); - assertThat(index).contains(LocalDate.of(1970, 1, 4)); - assertThat(index).doesNotContain(LocalDate.of(1970, 1, 5)); + assertThat(index).contains(LocalDate.of(1970, 1, 4)) + .doesNotContain(LocalDate.of(1970, 1, 5)); } @Test @@ -125,7 +125,6 @@ void excludesDatesThatExceedTheMaximumNumberOfKeys() { private DateIndexingDecorator makeDecoratedDateDirectory(DiagnosisKeyBundler diagnosisKeyBundler) { return new DateIndexingDecorator( new DiagnosisKeysDateDirectory(diagnosisKeyBundler, cryptoProvider, distributionServiceConfig), - distributionServiceConfig - ); + distributionServiceConfig); } } diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/HourIndexingDecoratorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/HourIndexingDecoratorTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/HourIndexingDecoratorTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/HourIndexingDecoratorTest.java @@ -93,14 +93,13 @@ void excludesEmptyHoursFromIndex() { Set<LocalDateTime> index = decorator.getIndex(new ImmutableStack<>().push(LocalDate.of(1970, 1, 5))); - assertThat(index).contains(LocalDateTime.of(1970, 1, 5, 0, 0)); - assertThat(index).doesNotContain(LocalDateTime.of(1970, 1, 5, 1, 0)); + assertThat(index).contains(LocalDateTime.of(1970, 1, 5, 0, 0)) + .doesNotContain(LocalDateTime.of(1970, 1, 5, 1, 0)); } private HourIndexingDecorator makeDecoratedHourDirectory(DiagnosisKeyBundler diagnosisKeyBundler) { return new HourIndexingDecorator( new DiagnosisKeysHourDirectory(diagnosisKeyBundler, cryptoProvider, distributionServiceConfig), - distributionServiceConfig - ); + distributionServiceConfig); } } diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/file/TemporaryExposureKeyExportFileTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/file/TemporaryExposureKeyExportFileTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/file/TemporaryExposureKeyExportFileTest.java @@ -0,0 +1,122 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.assembly.diagnosiskeys.structure.file; + +import static app.coronawarn.server.services.distribution.common.Helpers.buildDiagnosisKeyForSubmissionTimestamp; +import static org.assertj.core.api.Assertions.assertThat; + +import app.coronawarn.server.services.distribution.assembly.structure.WritableOnDisk; +import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; +import app.coronawarn.server.services.distribution.assembly.structure.directory.DirectoryOnDisk; +import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig.Signature; +import java.io.File; +import java.io.IOException; +import java.nio.file.Files; +import java.util.Set; +import org.junit.Rule; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.junit.rules.TemporaryFolder; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.boot.test.context.ConfigFileApplicationContextInitializer; +import org.springframework.test.annotation.DirtiesContext; +import org.springframework.test.annotation.DirtiesContext.ClassMode; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit.jupiter.SpringExtension; + + +@EnableConfigurationProperties(value = DistributionServiceConfig.class) +@ExtendWith(SpringExtension.class) +@ContextConfiguration(classes = {DistributionServiceConfig.class}, + initializers = ConfigFileApplicationContextInitializer.class) +@DirtiesContext(classMode = ClassMode.AFTER_EACH_TEST_METHOD) +class TemporaryExposureKeyExportFileTest { + + public static final String TEK_EXPORT_CHECKSUM_FILE_NAME = "export.bin.checksum"; + + @Rule + TemporaryFolder outputFolder = new TemporaryFolder(); + + @Autowired + DistributionServiceConfig distributionServiceConfig; + + @BeforeEach + void setup() throws IOException { + outputFolder.create(); + } + + @Test + void testChecksumIsDeterministic() throws IOException { + File outputFile1 = createFile(); + byte[] checksum1 = readChecksumFile(outputFile1); + + File outputFile2 = createFile(); + byte[] checksum2 = readChecksumFile(outputFile2); + + assertThat(checksum1).isEqualTo(checksum2); + } + + @Test + void testChecksumChangesWhenPrivateKeyIsModified() throws IOException { + File outputFile1 = createFile(); + byte[] checksum1 = readChecksumFile(outputFile1); + + modifySignaturePrivateKeyVersion(); + + File outputFile2 = createFile(); + byte[] checksum2 = readChecksumFile(outputFile2); + + assertThat(checksum1).isNotEqualTo(checksum2); + } + + private TemporaryExposureKeyExportFile createTemporaryExposureKeyExportFile() { + return TemporaryExposureKeyExportFile.fromDiagnosisKeys( + Set.of( + buildDiagnosisKeyForSubmissionTimestamp(1) + ), + "DE", 0, 10, distributionServiceConfig + ); + } + + private File createFile() throws IOException { + TemporaryExposureKeyExportFile tekExportFile = createTemporaryExposureKeyExportFile(); + File outputFile = outputFolder.newFolder(); + Directory<WritableOnDisk> directory = new DirectoryOnDisk(outputFile); + directory.addWritable(tekExportFile); + directory.prepare(new ImmutableStack<>()); + directory.write(); + return outputFile; + } + + private byte[] readChecksumFile(File outputFile1) throws IOException { + return Files.readAllBytes(outputFile1.toPath().resolve(TEK_EXPORT_CHECKSUM_FILE_NAME)); + } + + private void modifySignaturePrivateKeyVersion() { + Signature signature = distributionServiceConfig.getSignature(); + String verificationKeyVersion = signature.getVerificationKeyVersion(); + signature.setVerificationKeyVersion(verificationKeyVersion + "x"); + } +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectoryTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectoryTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectoryTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/IndexDirectoryTest.java @@ -32,6 +32,7 @@ import java.util.Arrays; import java.util.List; import java.util.Objects; +import java.util.Optional; import java.util.Set; import java.util.stream.Collectors; import java.util.stream.Stream; @@ -44,7 +45,7 @@ class IndexDirectoryTest { private static final String name = "Numbers"; private static final Set<Integer> index = Set.of(0, 1, 2); - private static final IndexFunction<Integer> indexFunction = __ -> index; + private static final IndexFunction<Integer> indexFunction = ignoredValue -> index; private static final Formatter<Integer> indexFormatter = Integer::valueOf; private IndexDirectory<Integer, WritableOnDisk> indexDirectory; private Directory<WritableOnDisk> outputDirectory; @@ -76,10 +77,10 @@ void checkGetIndexFormatter() { @Test void checkAddFileToAll() { List<FileOnDisk> expectedFileList = new ArrayList<>(); - indexDirectory.addWritableToAll(__ -> { + indexDirectory.addWritableToAll(ignoredValue -> { FileOnDisk newFile = new FileOnDisk("index", new byte[0]); expectedFileList.add(newFile); - return newFile; + return Optional.of(newFile); }); prepareAndWrite(outputDirectory); @@ -101,10 +102,10 @@ void checkAddFileToAll() { @Test void checkAddDirectoryToAll() { List<DirectoryOnDisk> expectedFileList = new ArrayList<>(); - indexDirectory.addWritableToAll(__ -> { + indexDirectory.addWritableToAll(ignoredValue -> { DirectoryOnDisk newDirectory = new DirectoryOnDisk("something"); expectedFileList.add(newDirectory); - return newDirectory; + return Optional.of(newDirectory); }); prepareAndWrite(outputDirectory); diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/decorators/DirectoryDecoratorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/decorator/DirectoryDecoratorTest.java similarity index 94% rename from services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/decorators/DirectoryDecoratorTest.java rename to services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/decorator/DirectoryDecoratorTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/decorators/DirectoryDecoratorTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/decorator/DirectoryDecoratorTest.java @@ -18,7 +18,7 @@ * ---license-end */ -package app.coronawarn.server.services.distribution.assembly.structure.directory.decorators; +package app.coronawarn.server.services.distribution.assembly.structure.directory.decorator; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.verify; @@ -26,7 +26,6 @@ import app.coronawarn.server.services.distribution.assembly.structure.WritableOnDisk; import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; import app.coronawarn.server.services.distribution.assembly.structure.directory.DirectoryOnDisk; -import app.coronawarn.server.services.distribution.assembly.structure.directory.decorator.DirectoryDecorator; import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; import org.junit.jupiter.api.Test; diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/decorators/indexing/IndexingDecoratorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/decorator/indexing/IndexingDecoratorTest.java similarity index 90% rename from services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/decorators/indexing/IndexingDecoratorTest.java rename to services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/decorator/indexing/IndexingDecoratorTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/decorators/indexing/IndexingDecoratorTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/directory/decorator/indexing/IndexingDecoratorTest.java @@ -18,7 +18,7 @@ * ---license-end */ -package app.coronawarn.server.services.distribution.assembly.structure.directory.decorators.indexing; +package app.coronawarn.server.services.distribution.assembly.structure.directory.decorator.indexing; import static app.coronawarn.server.services.distribution.common.Helpers.prepareAndWrite; import static org.assertj.core.api.Assertions.assertThat; @@ -28,7 +28,6 @@ import app.coronawarn.server.services.distribution.assembly.structure.directory.DirectoryOnDisk; import app.coronawarn.server.services.distribution.assembly.structure.directory.IndexDirectory; import app.coronawarn.server.services.distribution.assembly.structure.directory.IndexDirectoryOnDisk; -import app.coronawarn.server.services.distribution.assembly.structure.directory.decorator.indexing.IndexingDecoratorOnDisk; import app.coronawarn.server.services.distribution.assembly.structure.file.FileOnDiskWithChecksum; import java.io.File; import java.io.FileReader; @@ -50,7 +49,7 @@ class IndexingDecoratorTest { @Rule private TemporaryFolder outputFolder = new TemporaryFolder(); - private static final Set<Integer> index = Set.of(1, 2, 3); + private static final Set<Integer> INDEX = Set.of(1, 2, 3); private java.io.File outputFile; private Directory<WritableOnDisk> parent; private IndexDirectory<Integer, WritableOnDisk> decoratee; @@ -61,7 +60,7 @@ public void setup() throws IOException { outputFolder.create(); outputFile = outputFolder.newFolder(); parent = new DirectoryOnDisk(outputFile); - decoratee = new IndexDirectoryOnDisk<>("foo", __ -> index, __ -> __); + decoratee = new IndexDirectoryOnDisk<>("foo", ignoredValue -> INDEX, value -> value); decorator = new IndexingDecoratorOnDisk<>(decoratee, "foo"); parent.addWritable(decorator); @@ -73,6 +72,7 @@ public void setup() throws IOException { void checkWritesIndexFile() throws IOException, ParseException { java.io.File actualIndexDirectoryFile = Objects.requireNonNull(outputFile.listFiles())[0]; java.io.File actualPhysicalFile = Stream.of(actualIndexDirectoryFile) + .filter(File::isDirectory) .map(File::listFiles) .flatMap(Arrays::stream) .filter(File::isFile) @@ -85,10 +85,9 @@ void checkWritesIndexFile() throws IOException, ParseException { Object obj = jsonParser.parse(reader); JSONArray indexJson = (JSONArray) obj; - index.forEach(expected -> + INDEX.forEach(expected -> assertThat(indexJson.contains(expected.longValue())) .withFailMessage(expected.toString()) - .isTrue() - ); + .isTrue()); } } diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/util/ImmutableStackTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/util/ImmutableStackTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/util/ImmutableStackTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/structure/util/ImmutableStackTest.java @@ -61,7 +61,7 @@ void checksEmptyStackHasNoting() { @Test void throwsExceptionWhenPopsFromEmptyStack() { - assertThatExceptionOfType(NoSuchElementException.class) - .isThrownBy(() -> new ImmutableStack<>().pop()); + ImmutableStack<Object> stack = new ImmutableStack<>(); + assertThatExceptionOfType(NoSuchElementException.class).isThrownBy(() -> stack.pop()); } } diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/common/Helpers.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/common/Helpers.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/common/Helpers.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/common/Helpers.java @@ -20,12 +20,24 @@ package app.coronawarn.server.services.distribution.common; +import static app.coronawarn.server.services.distribution.assembly.appconfig.YamlLoader.loadYamlIntoProtobufBuilder; +import static java.io.File.separator; + import app.coronawarn.server.common.persistence.domain.DiagnosisKey; +import app.coronawarn.server.common.protocols.internal.ApplicationConfiguration; +import app.coronawarn.server.services.distribution.assembly.appconfig.UnableToLoadFileException; import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; import app.coronawarn.server.services.distribution.assembly.structure.util.ImmutableStack; +import java.io.File; import java.time.LocalDateTime; import java.time.ZoneOffset; +import java.util.Arrays; +import java.util.Collection; +import java.util.HashSet; import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Set; import java.util.stream.Collectors; import java.util.stream.IntStream; @@ -48,18 +60,73 @@ public static DiagnosisKey buildDiagnosisKeyForDateTime(LocalDateTime dateTime) return buildDiagnosisKeyForSubmissionTimestamp(dateTime.toEpochSecond(ZoneOffset.UTC) / 3600); } - public static List<DiagnosisKey> buildDiagnosisKeys(int startIntervalNumber, LocalDateTime submissionTimestamp, int number) { + public static List<DiagnosisKey> buildDiagnosisKeys( + int startIntervalNumber, LocalDateTime submissionTimestamp, int number) { long timestamp = submissionTimestamp.toEpochSecond(ZoneOffset.UTC) / 3600; return buildDiagnosisKeys(startIntervalNumber, timestamp, number); } public static List<DiagnosisKey> buildDiagnosisKeys(int startIntervalNumber, long submissionTimestamp, int number) { return IntStream.range(0, number) - .mapToObj(__ -> DiagnosisKey.builder() + .mapToObj(ignoredValue -> DiagnosisKey.builder() .withKeyData(new byte[16]) .withRollingStartIntervalNumber(startIntervalNumber) .withTransmissionRiskLevel(2) .withSubmissionTimestamp(submissionTimestamp).build()) .collect(Collectors.toList()); } + + public static Set<String> getFilePaths(java.io.File root, String basePath) { + Set<String> files = Arrays.stream(Objects.requireNonNull(root.listFiles())) + .filter(File::isFile) + .map(File::getAbsolutePath) + .map(path -> path.substring(basePath.length() + 1)) + .collect(Collectors.toSet()); + + Set<java.io.File> directories = Arrays.stream(Objects.requireNonNull(root.listFiles())) + .filter(File::isDirectory) + .collect(Collectors.toSet()); + + Set<String> subFiles = directories.stream() + .map(subDirectory -> getFilePaths(subDirectory, basePath)) + .flatMap(Set::stream) + .collect(Collectors.toSet()); + + files.addAll(subFiles); + return files; + } + + public static ApplicationConfiguration loadApplicationConfiguration(String path) throws UnableToLoadFileException { + return loadYamlIntoProtobufBuilder(path, ApplicationConfiguration.Builder.class).build(); + } + + public static Set<String> getExpectedHourFiles(Collection<String> hours) { + return hours.stream() + .map(hour -> Set.of( + String.join(separator, "hour", hour, "index"), + String.join(separator, "hour", hour, "index.checksum"))) + .flatMap(Set::stream) + .collect(Collectors.toSet()); + } + + public static Set<String> getExpectedDateAndHourFiles(Map<String, List<String>> datesAndHours, String currentDate) { + Set<String> expectedFiles = new HashSet<>(); + + datesAndHours.forEach((date, hours) -> { + if (!date.equals(currentDate)) { + expectedFiles.add(String.join(separator, "date", date, "index")); + expectedFiles.add(String.join(separator, "date", date, "index.checksum")); + } + + expectedFiles.add(String.join(separator, "date", date, "hour", "index")); + expectedFiles.add(String.join(separator, "date", date, "hour", "index.checksum")); + + hours.forEach(hour -> { + expectedFiles.add(String.join(separator, "date", date, "hour", hour, "index")); + expectedFiles.add(String.join(separator, "date", date, "hour", hour, "index.checksum")); + }); + }); + + return expectedFiles; + } } diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccessTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccessIT.java similarity index 88% rename from services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccessTest.java rename to services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccessIT.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccessTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccessIT.java @@ -25,11 +25,13 @@ import static org.mockito.Mockito.when; import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; -import app.coronawarn.server.services.distribution.objectstore.client.ObjectStoreClientConfig; +import app.coronawarn.server.services.distribution.objectstore.client.ObjectStorePublishingConfig; +import app.coronawarn.server.services.distribution.objectstore.client.S3Object; import app.coronawarn.server.services.distribution.objectstore.publish.LocalFile; import app.coronawarn.server.services.distribution.objectstore.publish.LocalGenericFile; import java.io.IOException; import java.nio.file.Path; +import java.util.List; import java.util.UUID; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.BeforeEach; @@ -43,15 +45,13 @@ import org.springframework.test.context.junit.jupiter.SpringExtension; @ExtendWith(SpringExtension.class) -@SpringBootTest(classes = {ObjectStoreAccess.class, ObjectStoreClientConfig.class}) +@SpringBootTest(classes = {ObjectStoreAccess.class, ObjectStorePublishingConfig.class}) @EnableConfigurationProperties(value = DistributionServiceConfig.class) @Tag("s3-integration") -class ObjectStoreAccessTest { +class ObjectStoreAccessIT { private static final String testRunId = "testing/cwa/" + UUID.randomUUID().toString() + "/"; - private static final String rootTestFolder = "objectstore/"; - private static final String textFile = rootTestFolder + "store-test-file"; @Autowired @@ -93,15 +93,15 @@ void pushTestFileAndDelete() throws IOException { when(localFileSpy.getS3Key()).thenReturn(testRunId + localFile.getS3Key()); objectStoreAccess.putObject(localFileSpy); - var files = objectStoreAccess.getObjectsWithPrefix(testRunId); - assertThat(files.size()).isEqualTo(1); + List<S3Object> files = objectStoreAccess.getObjectsWithPrefix(testRunId); + assertThat(files).hasSize(1); assertThat(files.get(0).getObjectName()).isEqualTo(testFileTargetKey); objectStoreAccess.deleteObjectsWithPrefix(testRunId); - var filesAfterDeletion = objectStoreAccess.getObjectsWithPrefix(testRunId); - assertThat(filesAfterDeletion.size()).isEqualTo(0); + List<S3Object> filesAfterDeletion = objectStoreAccess.getObjectsWithPrefix(testRunId); + assertThat(filesAfterDeletion).isEmpty(); } private Path getExampleFile() throws IOException { @@ -111,5 +111,4 @@ private Path getExampleFile() throws IOException { private Path getRootTestFolder() throws IOException { return resourceLoader.getResource(rootTestFolder).getFile().toPath(); } - } diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccessUnitTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccessUnitTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccessUnitTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccessUnitTest.java @@ -21,21 +21,25 @@ package app.coronawarn.server.services.distribution.objectstore; import static java.util.Map.entry; +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatExceptionOfType; import static org.mockito.ArgumentMatchers.eq; import static org.mockito.Mockito.any; import static org.mockito.Mockito.atLeastOnce; import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.times; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; import app.coronawarn.server.services.distribution.objectstore.client.ObjectStoreClient; import app.coronawarn.server.services.distribution.objectstore.client.ObjectStoreClient.HeaderKey; +import app.coronawarn.server.services.distribution.objectstore.client.S3Object; import app.coronawarn.server.services.distribution.objectstore.publish.LocalFile; import java.io.File; import java.nio.file.Path; +import java.util.List; import java.util.Map; -import org.assertj.core.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.ExtendWith; @@ -87,6 +91,14 @@ private LocalFile setUpLocalFileMock() { return testLocalFile; } + @Test + void illegalArgumentExceptionIfBucketDoesNotExist() { + when(objectStoreClient.bucketExists(any())).thenReturn(false); + + assertThatExceptionOfType(IllegalArgumentException.class) + .isThrownBy(() -> new ObjectStoreAccess(distributionServiceConfig, objectStoreClient)); + } + @Test void testPutObjectSetsDefaultCacheControlHeader() { ArgumentCaptor<Map<HeaderKey, String>> headers = ArgumentCaptor.forClass(Map.class); @@ -96,7 +108,7 @@ void testPutObjectSetsDefaultCacheControlHeader() { verify(objectStoreClient, atLeastOnce()) .putObject(eq(expBucketName), eq(EXP_S3_KEY), eq(expPath), headers.capture()); - Assertions.assertThat(headers.getValue()).contains(expHeader); + assertThat(headers.getValue()).contains(expHeader); } @Test @@ -109,6 +121,38 @@ void testPutObjectSetsSpecifiedCacheControlHeader() { verify(objectStoreClient, atLeastOnce()) .putObject(eq(expBucketName), eq(EXP_S3_KEY), eq(expPath), headers.capture()); - Assertions.assertThat(headers.getValue()).contains(expHeader); + assertThat(headers.getValue()).contains(expHeader); + } + + @Test + void putObjectSetsSpecifiedFileChecksum() { + when(testLocalFile.getChecksum()).thenReturn("test-hash"); + + ArgumentCaptor<Map<HeaderKey, String>> headers = ArgumentCaptor.forClass(Map.class); + var expHash = "test-hash"; + var expHeader = entry(HeaderKey.CWA_HASH, expHash); + + objectStoreAccess.putObject(testLocalFile); + + verify(objectStoreClient, atLeastOnce()) + .putObject(eq(expBucketName), eq(EXP_S3_KEY), eq(expPath), headers.capture()); + assertThat(headers.getValue()).contains(expHeader); + } + + @Test + void shouldDeleteMatchingFiles() { + var fileToDelete1 = new S3Object("test-file-1"); + var fileToDelete2 = new S3Object("test-file-2"); + var fileToDelete3 = new S3Object("test-file-3"); + + var filesToDelete = List.of(fileToDelete1, fileToDelete2, fileToDelete3); + var filesToDeleteObjectName = List + .of(fileToDelete1.getObjectName(), fileToDelete2.getObjectName(), fileToDelete3.getObjectName()); + + when(objectStoreClient.getObjects(any(), any())).thenReturn(filesToDelete); + + objectStoreAccess.deleteObjectsWithPrefix(""); + + verify(objectStoreClient, times(1)).removeObjects(eq(expBucketName), eq(filesToDeleteObjectName)); } } diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStorePublishingConfigTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStorePublishingConfigTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStorePublishingConfigTest.java @@ -0,0 +1,64 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.objectstore; + +import static org.assertj.core.api.Assertions.assertThat; + +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import app.coronawarn.server.services.distribution.objectstore.client.ObjectStoreClient; +import app.coronawarn.server.services.distribution.objectstore.client.ObjectStorePublishingConfig; +import app.coronawarn.server.services.distribution.objectstore.client.S3ClientWrapper; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.boot.test.mock.mockito.MockBean; +import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor; +import org.springframework.test.context.junit.jupiter.SpringExtension; + +@ExtendWith({SpringExtension.class}) +@SpringBootTest(classes = {ObjectStorePublishingConfig.class}) +@EnableConfigurationProperties(value = DistributionServiceConfig.class) +class ObjectStorePublishingConfigTest { + + @MockBean + private ObjectStoreClient objectStoreClient; + + @Autowired + private ThreadPoolTaskExecutor executor; + + @Autowired + private DistributionServiceConfig distributionServiceConfig; + + @Test + void testS3ClientWrapperInstantiation() { + ObjectStorePublishingConfig config = new ObjectStorePublishingConfig(); + assertThat(config.createObjectStoreClient(distributionServiceConfig)).isInstanceOf(S3ClientWrapper.class); + } + + @Test + void testThreadPoolExecutorPoolSize() { + int expNumberOfThreads = distributionServiceConfig.getObjectStore().getMaxNumberOfS3Threads(); + assertThat(executor.getCorePoolSize()).isEqualTo(expNumberOfThreads); + assertThat(executor.getMaxPoolSize()).isEqualTo(expNumberOfThreads); + } +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherIntegrationTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherIT.java similarity index 85% rename from services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherIntegrationTest.java rename to services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherIT.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherIntegrationTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherIT.java @@ -21,10 +21,9 @@ package app.coronawarn.server.services.distribution.objectstore; import static org.assertj.core.api.Assertions.assertThat; -import static org.mockito.Mockito.mock; import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; -import app.coronawarn.server.services.distribution.objectstore.client.ObjectStoreClientConfig; +import app.coronawarn.server.services.distribution.objectstore.client.ObjectStorePublishingConfig; import app.coronawarn.server.services.distribution.objectstore.client.S3Object; import java.io.IOException; import java.nio.file.Path; @@ -37,14 +36,15 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.boot.test.mock.mockito.MockBean; import org.springframework.core.io.ResourceLoader; import org.springframework.test.context.junit.jupiter.SpringExtension; @ExtendWith(SpringExtension.class) -@SpringBootTest(classes = {ObjectStoreAccess.class, ObjectStoreClientConfig.class}) +@SpringBootTest(classes = {ObjectStoreAccess.class, ObjectStorePublishingConfig.class, S3Publisher.class}) @EnableConfigurationProperties(value = DistributionServiceConfig.class) @Tag("s3-integration") -class S3PublisherIntegrationTest { +class S3PublisherIT { private final String rootTestFolder = "objectstore/publisher/"; @@ -54,12 +54,15 @@ class S3PublisherIntegrationTest { @Autowired private ResourceLoader resourceLoader; + @MockBean + private FailedObjectStoreOperationsCounter failedObjectStoreOperationsCounter; + + @Autowired + private S3Publisher s3Publisher; + @Test void publishTestFolderOk() throws IOException { - S3Publisher publisher = new S3Publisher( - getFolderAsPath(rootTestFolder), objectStoreAccess, mock(FailedObjectStoreOperationsCounter.class)); - - publisher.publish(); + s3Publisher.publish(getFolderAsPath(rootTestFolder)); List<S3Object> s3Objects = objectStoreAccess.getObjectsWithPrefix("version"); assertThat(s3Objects).hasSize(5); diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherTest.java @@ -20,26 +20,44 @@ package app.coronawarn.server.services.distribution.objectstore; +import static org.assertj.core.util.Lists.emptyList; import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.doAnswer; +import static org.mockito.Mockito.doReturn; +import static org.mockito.Mockito.doThrow; import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.spy; import static org.mockito.Mockito.times; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig.Api; +import app.coronawarn.server.services.distribution.objectstore.client.ObjectStoreOperationFailedException; import app.coronawarn.server.services.distribution.objectstore.client.S3Object; import java.io.IOException; +import java.nio.file.Path; import java.util.List; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.Future; +import org.assertj.core.api.Assertions; +import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.ExtendWith; import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.boot.test.context.ConfigFileApplicationContextInitializer; import org.springframework.boot.test.mock.mockito.MockBean; import org.springframework.core.io.ResourceLoader; +import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor; +import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.junit.jupiter.SpringExtension; +@EnableConfigurationProperties(value = DistributionServiceConfig.class) @ExtendWith(SpringExtension.class) +@ContextConfiguration(classes = {Api.class}, initializers = ConfigFileApplicationContextInitializer.class) class S3PublisherTest { - private static final String PUBLISHING_PATH = "testsetups/s3publishertest/topublish"; private static final S3Object FILE_1 = new S3Object("file1.txt", "cf7fb1ca5c32adc0941c35a6f7fc5eba"); private static final S3Object FILE_2 = new S3Object("file2.txt", "d882afb9fa9c26f7e9d0965b8faa79b8"); private static final S3Object FILE_3 = new S3Object("file3.txt", "0385524c9fdc83634467a11667c851ac"); @@ -47,14 +65,36 @@ class S3PublisherTest { @MockBean private ObjectStoreAccess objectStoreAccess; + @MockBean + private FailedObjectStoreOperationsCounter failedObjectStoreOperationsCounter; + @Autowired private ResourceLoader resourceLoader; + @Autowired + private DistributionServiceConfig distributionServiceConfig; + + private ThreadPoolTaskExecutor executor; + private Path publishingPath; + private S3Publisher s3Publisher; + + @BeforeEach + void setup() throws IOException { + publishingPath = resourceLoader.getResource("testsetups/s3publishertest/topublish").getFile().toPath(); + executor = new ThreadPoolTaskExecutor(); + executor.setMaxPoolSize(1); + executor.setCorePoolSize(1); + executor.initialize(); + executor = spy(executor); + s3Publisher = new S3Publisher(objectStoreAccess, failedObjectStoreOperationsCounter, executor, + distributionServiceConfig); + } + @Test void allNewNoExisting() throws IOException { - when(objectStoreAccess.getObjectsWithPrefix("version")).thenReturn(noneExisting()); + when(objectStoreAccess.getObjectsWithPrefix("version")).thenReturn(emptyList()); - createTestPublisher().publish(); + s3Publisher.publish(publishingPath); verify(objectStoreAccess, times(3)).putObject(any()); } @@ -63,7 +103,7 @@ void allNewNoExisting() throws IOException { void noUploadsDueToAlreadyExist() throws IOException { when(objectStoreAccess.getObjectsWithPrefix("version")).thenReturn(allExistAllSame()); - createTestPublisher().publish(); + s3Publisher.publish(publishingPath); verify(objectStoreAccess, times(0)).putObject(any()); } @@ -72,7 +112,7 @@ void noUploadsDueToAlreadyExist() throws IOException { void uploadAllOtherFilesDifferentNames() throws IOException { when(objectStoreAccess.getObjectsWithPrefix("version")).thenReturn(otherExisting()); - createTestPublisher().publish(); + s3Publisher.publish(publishingPath); verify(objectStoreAccess, times(3)).putObject(any()); } @@ -81,28 +121,84 @@ void uploadAllOtherFilesDifferentNames() throws IOException { void uploadOneDueToOneChanged() throws IOException { when(objectStoreAccess.getObjectsWithPrefix("version")).thenReturn(twoIdenticalOneOtherOneChange()); - createTestPublisher().publish(); + s3Publisher.publish(publishingPath); verify(objectStoreAccess, times(1)).putObject(any()); } - private List<S3Object> noneExisting() { - return List.of(); + @Test + void uploadAllDueToError() throws IOException { + when(objectStoreAccess.getObjectsWithPrefix("version")).thenThrow(new ObjectStoreOperationFailedException("")); + + s3Publisher.publish(publishingPath); + + verify(objectStoreAccess, times(3)).putObject(any()); + } + + @Test + void executorGetsShutDown() throws IOException { + when(objectStoreAccess.getObjectsWithPrefix("version")).thenReturn(emptyList()); + + s3Publisher.publish(publishingPath); + + verify(executor, times(1)).shutdown(); + } + + @Test + void taskExecutionHaltsWhenMaximumFailedOperationsReached() { + when(objectStoreAccess.getObjectsWithPrefix("version")).thenReturn(emptyList()); + setUpFailureThresholdExceededOnSecondUpload(); + + Assertions.assertThatExceptionOfType(ObjectStoreOperationFailedException.class) + .isThrownBy(() -> s3Publisher.publish(publishingPath)); + + // third invocation does not happen + verify(objectStoreAccess, times(2)).putObject(any()); + } + + @Test + void threadPoolShutDownWhenMaximumFailedOperationsReached() { + when(objectStoreAccess.getObjectsWithPrefix("version")).thenReturn(emptyList()); + setUpFailureThresholdExceededOnSecondUpload(); + + Assertions.assertThatExceptionOfType(ObjectStoreOperationFailedException.class) + .isThrownBy(() -> s3Publisher.publish(publishingPath)); + + verify(executor, times(1)).shutdown(); + } + + private void setUpFailureThresholdExceededOnSecondUpload() { + doThrow(ObjectStoreOperationFailedException.class).when(objectStoreAccess).putObject(any()); + doAnswer(ignoredValue -> null) + .doThrow(ObjectStoreOperationFailedException.class) + .when(failedObjectStoreOperationsCounter) + .incrementAndCheckThreshold(any(ObjectStoreOperationFailedException.class)); + } + + @Test + void interruptedExceptionHandling() throws ExecutionException, InterruptedException { + var result = mock(Future.class); + when(result.get()).thenThrow(new InterruptedException()); + doReturn(result).when(executor).submit(any(Runnable.class)); + when(objectStoreAccess.getObjectsWithPrefix("version")).thenReturn(emptyList()); + + Assertions.assertThatExceptionOfType(ObjectStoreOperationFailedException.class) + .isThrownBy(() -> s3Publisher.publish(publishingPath)); + + verify(executor, times(1)).shutdown(); } private List<S3Object> otherExisting() { return List.of( new S3Object("some_old_file.txt", "1fb772815c837b6294d9f163db89e962"), - new S3Object("other_old_file.txt", "2fb772815c837b6294d9f163db89e962") - ); + new S3Object("other_old_file.txt", "2fb772815c837b6294d9f163db89e962")); } private List<S3Object> allExistAllSame() { return List.of( FILE_1, FILE_2, - FILE_3 - ); + FILE_3); } private List<S3Object> twoIdenticalOneOtherOneChange() { @@ -110,12 +206,6 @@ private List<S3Object> twoIdenticalOneOtherOneChange() { new S3Object("newfile.txt", "1fb772815c837b6294d9f163db89e962"), // new FILE_1, FILE_2, - new S3Object("file3.txt", "111772815c837b6294d9f163db89e962") // changed - ); - } - - private S3Publisher createTestPublisher() throws IOException { - var publishPath = resourceLoader.getResource(PUBLISHING_PATH).getFile().toPath(); - return new S3Publisher(publishPath, objectStoreAccess, mock(FailedObjectStoreOperationsCounter.class)); + new S3Object("file3.txt", "111772815c837b6294d9f163db89e962")); // changed } } diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3RetentionPolicyTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3RetentionPolicyTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3RetentionPolicyTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3RetentionPolicyTest.java @@ -103,7 +103,8 @@ void deleteDiagnosisKeysUpdatesFailedOperationCounter() { private String generateFileName(LocalDate date) { var api = distributionServiceConfig.getApi(); - return "version/v1/" + api.getDiagnosisKeysPath() + "/" + api.getCountryPath() + "/" - + api.getCountryGermany() + "/" + api.getDatePath() + "/" + date.toString() + "/hour/0"; + return api.getVersionPath() + "/" + api.getVersionV1() + "/" + api.getDiagnosisKeysPath() + "/" + + api.getCountryPath() + "/" + api.getCountryGermany() + "/" + api.getDatePath() + "/" + date.toString() + "/" + + api.getHourPath() + "/0"; } } diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapperTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapperTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapperTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapperTest.java @@ -20,7 +20,7 @@ package app.coronawarn.server.services.distribution.objectstore.client; -import static java.util.Collections.emptyMap; +import static java.util.Collections.EMPTY_MAP; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatExceptionOfType; import static org.assertj.core.util.Maps.newHashMap; @@ -82,6 +82,7 @@ class S3ClientWrapperTest { private static final String VALID_BUCKET_NAME = "myBucket"; private static final String VALID_PREFIX = "prefix"; private static final String VALID_NAME = "object key"; + private static final Path VALID_PATH = Path.of(""); @Value("${services.distribution.objectstore.retry-attempts}") private int configuredNumberOfRetries; @@ -150,6 +151,25 @@ void testGetObjects(List<S3Object> expResult) { assertThat(actResult).isEqualTo(expResult); } + @Test + void testContinuationToken() { + var continuationToken = "1ueGcxLPRx1Tr/XYExHnhbYLgveDs2J/wm36Hy4vbOwM=<"; + + when(s3Client.listObjectsV2(any(ListObjectsV2Request.class))) + .thenReturn(ListObjectsV2Response.builder().isTruncated(true).continuationToken(continuationToken).build(), + ListObjectsV2Response.builder().isTruncated(false).build()); + + s3ClientWrapper.getObjects(VALID_BUCKET_NAME, VALID_PREFIX); + + ListObjectsV2Request continuationRequest = ListObjectsV2Request.builder() + .prefix(VALID_PREFIX).bucket(VALID_BUCKET_NAME).continuationToken(continuationToken).build(); + ListObjectsV2Request noContinuationRequest = ListObjectsV2Request.builder() + .prefix(VALID_PREFIX).bucket(VALID_BUCKET_NAME).build(); + + verify(s3Client, times(1)).listObjectsV2(eq(continuationRequest)); + verify(s3Client, times(1)).listObjectsV2(eq(noContinuationRequest)); + } + private static Stream<Arguments> createGetObjectsResults() { return Stream.of( Lists.emptyList(), @@ -186,17 +206,28 @@ void shouldRetryGettingObjectsAndThenThrow(Class<Exception> cause) { @Test void testPutObjectForNoHeaders() { - s3ClientWrapper.putObject(VALID_BUCKET_NAME, VALID_NAME, Path.of(""), emptyMap()); + s3ClientWrapper.putObject(VALID_BUCKET_NAME, VALID_NAME, VALID_PATH, EMPTY_MAP); PutObjectRequest expRequest = PutObjectRequest.builder().bucket(VALID_BUCKET_NAME).key(VALID_NAME).build(); verify(s3Client, atLeastOnce()).putObject(eq(expRequest), any(RequestBody.class)); } + @Test + void testPutObjectForContentTypeHeader() { + String contentType = "foo-content-type"; + s3ClientWrapper.putObject(VALID_BUCKET_NAME, VALID_NAME, Path.of(""), + newHashMap(HeaderKey.CONTENT_TYPE, contentType)); + + PutObjectRequest expRequest = + PutObjectRequest.builder().bucket(VALID_BUCKET_NAME).key(VALID_NAME).contentType(contentType).build(); + verify(s3Client, atLeastOnce()).putObject(eq(expRequest), any(RequestBody.class)); + } + @Test void testPutObjectForCacheControlHeader() { var expCacheControl = "foo-cache-control"; s3ClientWrapper - .putObject(VALID_BUCKET_NAME, VALID_NAME, Path.of(""), newHashMap(HeaderKey.CACHE_CONTROL, expCacheControl)); + .putObject(VALID_BUCKET_NAME, VALID_NAME, VALID_PATH, newHashMap(HeaderKey.CACHE_CONTROL, expCacheControl)); PutObjectRequest expRequest = PutObjectRequest.builder().bucket(VALID_BUCKET_NAME).key(VALID_NAME).cacheControl(expCacheControl).build(); @@ -206,7 +237,7 @@ void testPutObjectForCacheControlHeader() { @Test void testPutObjectForAmzAclHeader() { String expAcl = "foo-acl"; - s3ClientWrapper.putObject(VALID_BUCKET_NAME, VALID_NAME, Path.of(""), newHashMap(HeaderKey.AMZ_ACL, expAcl)); + s3ClientWrapper.putObject(VALID_BUCKET_NAME, VALID_NAME, VALID_PATH, newHashMap(HeaderKey.AMZ_ACL, expAcl)); PutObjectRequest expRequest = PutObjectRequest.builder().bucket(VALID_BUCKET_NAME).key(VALID_NAME).acl(expAcl).build(); @@ -218,7 +249,7 @@ void testPutObjectForAmzAclHeader() { void putObjectsThrowsObjectStoreOperationFailedExceptionIfClientThrows(Class<Exception> cause) { when(s3Client.putObject(any(PutObjectRequest.class), any(RequestBody.class))).thenThrow(cause); assertThatExceptionOfType(ObjectStoreOperationFailedException.class) - .isThrownBy(() -> s3ClientWrapper.putObject(VALID_BUCKET_NAME, VALID_PREFIX, Path.of(""), emptyMap())); + .isThrownBy(() -> s3ClientWrapper.putObject(VALID_BUCKET_NAME, VALID_PREFIX, VALID_PATH, EMPTY_MAP)); } @ParameterizedTest @@ -226,7 +257,7 @@ void putObjectsThrowsObjectStoreOperationFailedExceptionIfClientThrows(Class<Exc void shouldRetryUploadingObjectAndThenThrow(Class<Exception> cause) { when(s3Client.putObject(any(PutObjectRequest.class), any(RequestBody.class))).thenThrow(cause); assertThatExceptionOfType(ObjectStoreOperationFailedException.class) - .isThrownBy(() -> s3ClientWrapper.putObject(VALID_BUCKET_NAME, VALID_PREFIX, Path.of(""), emptyMap())); + .isThrownBy(() -> s3ClientWrapper.putObject(VALID_BUCKET_NAME, VALID_PREFIX, VALID_PATH, EMPTY_MAP)); verify(s3Client, times(configuredNumberOfRetries)).putObject(any(PutObjectRequest.class), any(RequestBody.class)); } @@ -251,27 +282,31 @@ private Delete buildDeleteObject(List<String> objectNames) { @Test void removeObjectsThrowsOnDeletionErrors() { DeleteObjectsResponse actResponse = DeleteObjectsResponse.builder().errors(S3Error.builder().build()).build(); - when(s3Client.deleteObjects(any(DeleteObjectsRequest.class))).thenReturn(actResponse); + List<String> targetObjects = List.of(VALID_NAME); assertThatExceptionOfType(ObjectStoreOperationFailedException.class) - .isThrownBy(() -> s3ClientWrapper.removeObjects(VALID_BUCKET_NAME, List.of(VALID_NAME))); + .isThrownBy(() -> s3ClientWrapper.removeObjects(VALID_BUCKET_NAME, targetObjects)); } @ParameterizedTest @ValueSource(classes = {NoSuchBucketException.class, S3Exception.class, SdkClientException.class, SdkException.class}) void removeObjectsThrowsObjectStoreOperationFailedExceptionIfClientThrows(Class<Exception> cause) { when(s3Client.deleteObjects(any(DeleteObjectsRequest.class))).thenThrow(cause); + List<String> targetObjects = List.of(VALID_NAME); + assertThatExceptionOfType(ObjectStoreOperationFailedException.class) - .isThrownBy(() -> s3ClientWrapper.removeObjects(VALID_BUCKET_NAME, List.of(VALID_NAME))); + .isThrownBy(() -> s3ClientWrapper.removeObjects(VALID_BUCKET_NAME, targetObjects)); } @ParameterizedTest @ValueSource(classes = {NoSuchBucketException.class, S3Exception.class, SdkClientException.class, SdkException.class}) void shouldRetryRemovingObjectAndThenThrow(Class<Exception> cause) { when(s3Client.deleteObjects(any(DeleteObjectsRequest.class))).thenThrow(cause); + List<String> targetObjects = List.of(VALID_NAME); + assertThatExceptionOfType(ObjectStoreOperationFailedException.class) - .isThrownBy(() -> s3ClientWrapper.removeObjects(VALID_BUCKET_NAME, List.of(VALID_NAME))); + .isThrownBy(() -> s3ClientWrapper.removeObjects(VALID_BUCKET_NAME, targetObjects)); verify(s3Client, times(configuredNumberOfRetries)).deleteObjects(any(DeleteObjectsRequest.class)); } diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/publish/LocalFileTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/publish/LocalFileTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/publish/LocalFileTest.java @@ -0,0 +1,51 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.objectstore.publish; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +import java.nio.file.Path; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.ValueSource; + +class LocalFileTest { + @ParameterizedTest + @ValueSource(strings = { + "version", + "version/v1/configuration/country", + "version/v1/diagnosis-keys/country", + "version/v1/diagnosis-keys/country/DE/date", + "version/v1/diagnosis-keys/country/DE/date/2020-06-11/hour" }) + void testGetContentTypeJson(String path) { + LocalFile test = new LocalIndexFile(Path.of("/root", path, "/index"), Path.of("/root")); + assertEquals("application/json", test.getContentType()); + } + + @ParameterizedTest + @ValueSource(strings = { + "version/v1/configuration/country/DE/app_config", + "version/v1/diagnosis-keys/country/DE/date/2020-06-11", + "version/v1/diagnosis-keys/country/DE/date/2020-06-11/hour/13" }) + void testGetContentTypeZip(String path) { + LocalFile test = new LocalIndexFile(Path.of("/root", path, "/index"), Path.of("/root")); + assertEquals("application/zip", test.getContentType()); + } +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/runner/AssemblyRunnerTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/runner/AssemblyRunnerTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/runner/AssemblyRunnerTest.java @@ -0,0 +1,92 @@ +/* + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.runner; + +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.spy; +import static org.mockito.Mockito.times; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +import app.coronawarn.server.services.distribution.assembly.component.CwaApiStructureProvider; +import app.coronawarn.server.services.distribution.assembly.component.OutputDirectoryProvider; +import app.coronawarn.server.services.distribution.assembly.structure.WritableOnDisk; +import app.coronawarn.server.services.distribution.assembly.structure.directory.Directory; +import app.coronawarn.server.services.distribution.assembly.structure.directory.DirectoryOnDisk; +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import java.io.IOException; +import org.junit.Rule; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.junit.rules.TemporaryFolder; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.boot.test.context.ConfigFileApplicationContextInitializer; +import org.springframework.boot.test.mock.mockito.MockBean; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit.jupiter.SpringExtension; + +@EnableConfigurationProperties(value = DistributionServiceConfig.class) +@ExtendWith(SpringExtension.class) +@ContextConfiguration(classes = {Assembly.class}, initializers = ConfigFileApplicationContextInitializer.class) +class AssemblyRunnerTest { + + @MockBean + OutputDirectoryProvider outputDirectoryProvider; + + @MockBean + CwaApiStructureProvider cwaApiStructureProvider; + + @Autowired + Assembly assembly; + + private Directory<WritableOnDisk> parentDirectory; + private Directory<WritableOnDisk> childDirectory; + + @Rule + private TemporaryFolder outputFolder = new TemporaryFolder(); + + @BeforeEach + void setup() throws IOException { + outputFolder.create(); + var outputDirectory = outputFolder.newFolder("parent"); + var outputSubDirectory = outputFolder.newFolder("parent/child"); + parentDirectory = new DirectoryOnDisk(outputDirectory); + childDirectory = new DirectoryOnDisk(outputSubDirectory); + } + + @Test + void shouldCorrectlyCreatePrepareAndWriteDirectories() throws IOException { + Directory<WritableOnDisk> spyParentDirectory = spy(parentDirectory); + + when(outputDirectoryProvider.getDirectory()).thenReturn(spyParentDirectory); + when(cwaApiStructureProvider.getDirectory()).thenReturn(childDirectory); + + assembly.run(null); + + verify(outputDirectoryProvider, times(1)).getDirectory(); + verify(outputDirectoryProvider, times(1)).clear(); + verify(cwaApiStructureProvider, times(1)).getDirectory(); + verify(spyParentDirectory, times(1)).prepare(any()); + verify(spyParentDirectory, times(1)).write(); + } +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/runner/RetentionPolicyRunnerTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/runner/RetentionPolicyRunnerTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/runner/RetentionPolicyRunnerTest.java @@ -0,0 +1,62 @@ +/* + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.runner; + +import static org.mockito.Mockito.times; +import static org.mockito.Mockito.verify; + +import app.coronawarn.server.common.persistence.service.DiagnosisKeyService; +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import app.coronawarn.server.services.distribution.objectstore.S3RetentionPolicy; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.boot.test.context.ConfigFileApplicationContextInitializer; +import org.springframework.boot.test.mock.mockito.MockBean; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit.jupiter.SpringExtension; + +@EnableConfigurationProperties(value = DistributionServiceConfig.class) +@ExtendWith(SpringExtension.class) +@ContextConfiguration(classes = {RetentionPolicy.class}, initializers = ConfigFileApplicationContextInitializer.class) +class RetentionPolicyRunnerTest { + + @MockBean + DiagnosisKeyService diagnosisKeyService; + + @MockBean + S3RetentionPolicy s3RetentionPolicy; + + @Autowired + DistributionServiceConfig distributionServiceConfig; + + @Autowired + RetentionPolicy retentionPolicy; + + @Test + void shouldCallDatabaseAndS3RetentionRunner() { + retentionPolicy.run(null); + + verify(diagnosisKeyService, times(1)).applyRetentionPolicy(distributionServiceConfig.getRetentionDays()); + verify(s3RetentionPolicy, times(1)).applyRetentionPolicy(distributionServiceConfig.getRetentionDays()); + } +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/runner/S3DistributionRunnerTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/runner/S3DistributionRunnerTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/runner/S3DistributionRunnerTest.java @@ -0,0 +1,66 @@ +/* + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.runner; + +import static org.mockito.Mockito.times; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +import app.coronawarn.server.services.distribution.assembly.component.OutputDirectoryProvider; +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import app.coronawarn.server.services.distribution.objectstore.S3Publisher; +import java.io.IOException; +import java.nio.file.Paths; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.boot.test.context.ConfigFileApplicationContextInitializer; +import org.springframework.boot.test.mock.mockito.MockBean; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit.jupiter.SpringExtension; + +@EnableConfigurationProperties(value = DistributionServiceConfig.class) +@ExtendWith(SpringExtension.class) +@ContextConfiguration(classes = {S3Distribution.class}, initializers = ConfigFileApplicationContextInitializer.class) +class S3DistributionRunnerTest { + + @MockBean + OutputDirectoryProvider outputDirectoryProvider; + + @MockBean + S3Publisher s3Publisher; + + @Autowired + S3Distribution s3Distribution; + + @Test + void shouldPublishCorrectFolder() throws IOException { + var outputPath = Paths.get("test", "mock", "folder"); + var outputFile = new java.io.File(String.valueOf(outputPath)); + + when(outputDirectoryProvider.getFileOnDisk()).thenReturn(outputFile); + + s3Distribution.run(null); + + verify(s3Publisher, times(1)).publish(outputPath.toAbsolutePath()); + } +} diff --git a/services/distribution/src/test/resources/application.yaml b/services/distribution/src/test/resources/application.yaml --- a/services/distribution/src/test/resources/application.yaml +++ b/services/distribution/src/test/resources/application.yaml @@ -3,7 +3,7 @@ logging: level: org: springframework: off - root: info + root: off services: distribution: @@ -50,13 +50,15 @@ services: retry-attempts: 3 retry-backoff: 1 max-number-of-failed-operations: 5 + max-number-of-s3-threads: 2 spring: main: banner-mode: off - flyway: - enabled: true -# default case is H2 - value will be overwritten by profile cloud or postgres - locations: classpath:db/migration/h2 - jpa: - hibernate: - ddl-auto: validate + datasource: + url: jdbc:h2:mem:test;MODE=PostgreSQL + driverClassName: org.h2.Driver + platform: h2 + test: + database: + # Use datasource as defined above. + replace: none diff --git a/services/distribution/src/test/resources/bootstrap.yaml b/services/distribution/src/test/resources/bootstrap.yaml new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/resources/bootstrap.yaml @@ -0,0 +1,5 @@ +--- +spring: + cloud: + vault: + enabled: false diff --git a/services/distribution/src/test/resources/configtests/exposure-config_ok.yaml b/services/distribution/src/test/resources/configtests/exposure-config_ok.yaml --- a/services/distribution/src/test/resources/configtests/exposure-config_ok.yaml +++ b/services/distribution/src/test/resources/configtests/exposure-config_ok.yaml @@ -55,4 +55,4 @@ attenuation: gt_27_le_33_dbm: 5 gt_15_le_27_dbm: 6 gt_10_le_15_dbm: 7 - lt_10_dbm: 8 \ No newline at end of file + le_10_dbm: 8 diff --git a/services/distribution/src/test/resources/parameters/score_negative.yaml b/services/distribution/src/test/resources/configtests/naming_mismatch.yaml similarity index 73% rename from services/distribution/src/test/resources/parameters/score_negative.yaml rename to services/distribution/src/test/resources/configtests/naming_mismatch.yaml --- a/services/distribution/src/test/resources/parameters/score_negative.yaml +++ b/services/distribution/src/test/resources/configtests/naming_mismatch.yaml @@ -1,13 +1,12 @@ -transmission_weight: 100 -duration_weight: 50 -attenuation_weight: 80 - +transmission_weight: 10.001 +duration_weight: 0.001 +attenuation_weight: 100 transmission: - app_defined_1: -2 # not ok, negative - app_defined_2: 0 - #app_defined_3: 3 # not ok (missing -> unspecified) - app_defined_4: 5 + foo: 2 # "foo" does not exist in proto + app_defined_2: 2 + app_defined_3: 3 + app_defined_4: 4 app_defined_5: 5 app_defined_6: 6 app_defined_7: 7 @@ -41,4 +40,4 @@ attenuation: gt_27_le_33_dbm: 5 gt_15_le_27_dbm: 6 gt_10_le_15_dbm: 7 - lt_10_dbm: 8 + le_10_dbm: 8 diff --git a/services/distribution/src/test/resources/objectstore/publisher/examplefile b/services/distribution/src/test/resources/objectstore/publisher/examplefile --- a/services/distribution/src/test/resources/objectstore/publisher/examplefile +++ b/services/distribution/src/test/resources/objectstore/publisher/examplefile @@ -43,4 +43,4 @@ attenuation: gt_27_le_33_dbm: 5 gt_15_le_27_dbm: 6 gt_10_le_15_dbm: 7 - lt_10_dbm: 8 \ No newline at end of file + le_10_dbm: 8 diff --git a/services/distribution/src/test/resources/parameters/all_ok.yaml b/services/distribution/src/test/resources/parameters/all_ok.yaml --- a/services/distribution/src/test/resources/parameters/all_ok.yaml +++ b/services/distribution/src/test/resources/parameters/all_ok.yaml @@ -43,4 +43,4 @@ attenuation: gt_27_le_33_dbm: 5 gt_15_le_27_dbm: 6 gt_10_le_15_dbm: 7 - lt_10_dbm: 8 \ No newline at end of file + le_10_dbm: 8 diff --git a/services/distribution/src/test/resources/parameters/broken_syntax.yaml b/services/distribution/src/test/resources/parameters/broken_syntax.yaml --- a/services/distribution/src/test/resources/parameters/broken_syntax.yaml +++ b/services/distribution/src/test/resources/parameters/broken_syntax.yaml @@ -40,4 +40,4 @@ attenuation: gt_27_le_33_dbm: 5 gt_15_le_27_dbm: 6 gt_10_le_15_dbm: 7 - lt_10_dbm: 8 \ No newline at end of file + le_10_dbm: 8 diff --git a/services/distribution/src/test/resources/parameters/partly_filled.yaml b/services/distribution/src/test/resources/parameters/partly_filled.yaml --- a/services/distribution/src/test/resources/parameters/partly_filled.yaml +++ b/services/distribution/src/test/resources/parameters/partly_filled.yaml @@ -43,4 +43,4 @@ attenuation: gt_27_le_33_dbm: 5 gt_15_le_27_dbm: 6 gt_10_le_15_dbm: 7 - lt_10_dbm: 8 \ No newline at end of file + le_10_dbm: 8 diff --git a/services/distribution/src/test/resources/parameters/score_too_high.yaml b/services/distribution/src/test/resources/parameters/score_too_high.yaml --- a/services/distribution/src/test/resources/parameters/score_too_high.yaml +++ b/services/distribution/src/test/resources/parameters/score_too_high.yaml @@ -40,4 +40,4 @@ attenuation: gt_27_le_33_dbm: 5 gt_15_le_27_dbm: 6 gt_10_le_15_dbm: 7 - lt_10_dbm: 8 \ No newline at end of file + le_10_dbm: 8 diff --git a/services/distribution/src/test/resources/parameters/weight_negative.yaml b/services/distribution/src/test/resources/parameters/weight_negative.yaml --- a/services/distribution/src/test/resources/parameters/weight_negative.yaml +++ b/services/distribution/src/test/resources/parameters/weight_negative.yaml @@ -41,4 +41,4 @@ attenuation: gt_27_le_33_dbm: 5 gt_15_le_27_dbm: 6 gt_10_le_15_dbm: 7 - lt_10_dbm: 8 \ No newline at end of file + le_10_dbm: 8 diff --git a/services/distribution/src/test/resources/parameters/weight_ok.yaml b/services/distribution/src/test/resources/parameters/weight_ok.yaml --- a/services/distribution/src/test/resources/parameters/weight_ok.yaml +++ b/services/distribution/src/test/resources/parameters/weight_ok.yaml @@ -40,4 +40,4 @@ attenuation: gt_27_le_33_dbm: 5 gt_15_le_27_dbm: 6 gt_10_le_15_dbm: 7 - lt_10_dbm: 8 \ No newline at end of file + le_10_dbm: 8 diff --git a/services/distribution/src/test/resources/parameters/weight_too_high.yaml b/services/distribution/src/test/resources/parameters/weight_too_high.yaml --- a/services/distribution/src/test/resources/parameters/weight_too_high.yaml +++ b/services/distribution/src/test/resources/parameters/weight_too_high.yaml @@ -40,4 +40,4 @@ attenuation: gt_27_le_33_dbm: 5 gt_15_le_27_dbm: 6 gt_10_le_15_dbm: 7 - lt_10_dbm: 8 \ No newline at end of file + le_10_dbm: 8 diff --git a/services/submission/src/test/java/app/coronawarn/server/services/submission/ServerApplicationTests.java b/services/submission/src/test/java/app/coronawarn/server/services/submission/ServerApplicationTests.java --- a/services/submission/src/test/java/app/coronawarn/server/services/submission/ServerApplicationTests.java +++ b/services/submission/src/test/java/app/coronawarn/server/services/submission/ServerApplicationTests.java @@ -28,8 +28,10 @@ import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.mock.mockito.MockBean; import org.springframework.boot.test.web.client.TestRestTemplate; +import org.springframework.test.context.ActiveProfiles; @SpringBootTest +@ActiveProfiles({ "disable-ssl-client-verification", "disable-ssl-client-verification-verify-hostname" }) class ServerApplicationTests { @Autowired diff --git a/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/FakeDelayManagerTest.java b/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/FakeDelayManagerTest.java new file mode 100644 --- /dev/null +++ b/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/FakeDelayManagerTest.java @@ -0,0 +1,83 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.submission.controller; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.reset; +import static org.mockito.Mockito.when; + +import app.coronawarn.server.services.submission.config.SubmissionServiceConfig; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +class FakeDelayManagerTest { + + private static final long VALID_DELAY = 1000L; + private static final long VALID_SAMPLE_SIZE = 1L; + private final SubmissionServiceConfig config = mock(SubmissionServiceConfig.class); + + @BeforeEach + void setup() { + reset(config); + } + + @Test + void jitteredFakeDelayGreaterThanOrEqualZero() { + FakeDelayManager fakeDelayManager = buildFakeDelayManager(1L, 1L); + long actFakeDelay = fakeDelayManager.getJitteredFakeDelay(); + assertThat(actFakeDelay).isGreaterThanOrEqualTo(0L); + } + + @Test + void testUpdateFakeDelayForSampleSizeOne() { + FakeDelayManager fakeDelayManager = buildFakeDelayManager(1000L, 1L); + fakeDelayManager.updateFakeRequestDelay(2000L); + assertThat(fakeDelayManager.getFakeDelayInSeconds()).isEqualTo(2d); + } + + @Test + void testUpdateFakeDelayForSampleSizeTwo() { + FakeDelayManager fakeDelayManager = buildFakeDelayManager(1000L, 2L); + fakeDelayManager.updateFakeRequestDelay(3000L); + assertThat(fakeDelayManager.getFakeDelayInSeconds()).isEqualTo(2d); + } + + @Test + void testUpdateFakeDelayForConstantRequestTime() { + FakeDelayManager fakeDelayManager = buildFakeDelayManager(1000L, 3L); + fakeDelayManager.updateFakeRequestDelay(1000L); + fakeDelayManager.updateFakeRequestDelay(1000L); + assertThat(fakeDelayManager.getFakeDelayInSeconds()).isEqualTo(1d); + } + + @Test + void testGetFakeDelayInSecondsForInitialDelay() { + FakeDelayManager fakeDelayManager = buildFakeDelayManager(VALID_DELAY, VALID_SAMPLE_SIZE); + assertThat(fakeDelayManager.getFakeDelayInSeconds()).isEqualTo(VALID_DELAY / 1000d); + } + + private FakeDelayManager buildFakeDelayManager(long initialDelay, long movingAverageSampleSize) { + when(config.getInitialFakeDelayMilliseconds()).thenReturn(initialDelay); + when(config.getFakeDelayMovingAverageSamples()).thenReturn(movingAverageSampleSize); + return new FakeDelayManager(config); + } +} diff --git a/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/FakeRequestControllerTest.java b/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/FakeRequestControllerTest.java new file mode 100644 --- /dev/null +++ b/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/FakeRequestControllerTest.java @@ -0,0 +1,86 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.submission.controller; + +import static app.coronawarn.server.services.submission.controller.RequestExecutor.buildOkHeaders; +import static app.coronawarn.server.services.submission.controller.RequestExecutor.buildPayloadWithOneKey; +import static app.coronawarn.server.services.submission.controller.RequestExecutor.setCwaFakeHeader; +import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.ArgumentMatchers.anyLong; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.times; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; +import static org.springframework.http.HttpStatus.OK; + +import app.coronawarn.server.services.submission.monitoring.SubmissionMonitor; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.boot.test.mock.mockito.MockBean; +import org.springframework.http.HttpHeaders; +import org.springframework.http.ResponseEntity; +import org.springframework.test.context.ActiveProfiles; + +@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) +@ActiveProfiles({"disable-ssl-client-verification", "disable-ssl-client-verification-verify-hostname"}) +class FakeRequestControllerTest { + + @Autowired + private RequestExecutor executor; + + @MockBean + private FakeDelayManager fakeDelayManager; + + @MockBean + private SubmissionMonitor submissionMonitor; + + @BeforeEach + public void setUpMocks() { + when(fakeDelayManager.getJitteredFakeDelay()).thenReturn(1000L); + } + + @Test + void fakeRequestHandling() { + HttpHeaders headers = buildOkHeaders(); + setCwaFakeHeader(headers, "1"); + + ResponseEntity<Void> actResponse = executor.executePost(buildPayloadWithOneKey(), headers); + + verify(fakeDelayManager, times(1)).getJitteredFakeDelay(); + verify(fakeDelayManager, never()).updateFakeRequestDelay(anyLong()); + assertThat(actResponse.getStatusCode()).isEqualTo(OK); + } + + @Test + void checkFakeRequestHandlingIsMonitored() { + HttpHeaders headers = buildOkHeaders(); + setCwaFakeHeader(headers, "1"); + + executor.executePost(buildPayloadWithOneKey(), headers); + + verify(submissionMonitor, times(1)).incrementRequestCounter(); + verify(submissionMonitor, never()).incrementRealRequestCounter(); + verify(submissionMonitor, times(1)).incrementFakeRequestCounter(); + verify(submissionMonitor, never()).incrementInvalidTanRequestCounter(); + } +} diff --git a/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/PayloadValidationTest.java b/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/PayloadValidationTest.java --- a/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/PayloadValidationTest.java +++ b/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/PayloadValidationTest.java @@ -44,8 +44,10 @@ import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.mock.mockito.MockBean; import org.springframework.http.ResponseEntity; +import org.springframework.test.context.ActiveProfiles; @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) +@ActiveProfiles({"disable-ssl-client-verification", "disable-ssl-client-verification-verify-hostname"}) class PayloadValidationTest { @MockBean @@ -61,13 +63,13 @@ public void setUpMocks() { @Test void check400ResponseStatusForMissingKeys() { - ResponseEntity<Void> actResponse = executor.executeRequest(Lists.emptyList(), buildOkHeaders()); + ResponseEntity<Void> actResponse = executor.executePost(Lists.emptyList(), buildOkHeaders()); assertThat(actResponse.getStatusCode()).isEqualTo(BAD_REQUEST); } @Test void check400ResponseStatusForTooManyKeys() { - ResponseEntity<Void> actResponse = executor.executeRequest(buildPayloadWithTooManyKeys(), buildOkHeaders()); + ResponseEntity<Void> actResponse = executor.executePost(buildPayloadWithTooManyKeys(), buildOkHeaders()); assertThat(actResponse.getStatusCode()).isEqualTo(BAD_REQUEST); } @@ -87,7 +89,7 @@ void check400ResponseStatusForDuplicateStartIntervalNumber() { buildTemporaryExposureKey(VALID_KEY_DATA_1, rollingStartIntervalNumber, 1), buildTemporaryExposureKey(VALID_KEY_DATA_2, rollingStartIntervalNumber, 2)); - ResponseEntity<Void> actResponse = executor.executeRequest(keysWithDuplicateStartIntervalNumber, buildOkHeaders()); + ResponseEntity<Void> actResponse = executor.executePost(keysWithDuplicateStartIntervalNumber, buildOkHeaders()); assertThat(actResponse.getStatusCode()).isEqualTo(BAD_REQUEST); } @@ -102,7 +104,7 @@ void check200ResponseStatusForGapsInTimeIntervals() { buildTemporaryExposureKey(VALID_KEY_DATA_3, rollingStartIntervalNumber3, 3), buildTemporaryExposureKey(VALID_KEY_DATA_2, rollingStartIntervalNumber2, 2)); - ResponseEntity<Void> actResponse = executor.executeRequest(keysWithDuplicateStartIntervalNumber, buildOkHeaders()); + ResponseEntity<Void> actResponse = executor.executePost(keysWithDuplicateStartIntervalNumber, buildOkHeaders()); assertThat(actResponse.getStatusCode()).isEqualTo(OK); } @@ -115,7 +117,7 @@ void check400ResponseStatusForOverlappingTimeIntervals() { buildTemporaryExposureKey(VALID_KEY_DATA_1, rollingStartIntervalNumber1, 1), buildTemporaryExposureKey(VALID_KEY_DATA_2, rollingStartIntervalNumber2, 2)); - ResponseEntity<Void> actResponse = executor.executeRequest(keysWithDuplicateStartIntervalNumber, buildOkHeaders()); + ResponseEntity<Void> actResponse = executor.executePost(keysWithDuplicateStartIntervalNumber, buildOkHeaders()); assertThat(actResponse.getStatusCode()).isEqualTo(BAD_REQUEST); } @@ -130,7 +132,7 @@ void check200ResponseStatusForValidSubmissionPayload() { buildTemporaryExposureKey(VALID_KEY_DATA_3, rollingStartIntervalNumber3, 3), buildTemporaryExposureKey(VALID_KEY_DATA_2, rollingStartIntervalNumber2, 2)); - ResponseEntity<Void> actResponse = executor.executeRequest(keysWithDuplicateStartIntervalNumber, buildOkHeaders()); + ResponseEntity<Void> actResponse = executor.executePost(keysWithDuplicateStartIntervalNumber, buildOkHeaders()); assertThat(actResponse.getStatusCode()).isEqualTo(OK); } diff --git a/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/RequestExecutor.java b/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/RequestExecutor.java --- a/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/RequestExecutor.java +++ b/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/RequestExecutor.java @@ -29,6 +29,7 @@ import java.time.Instant; import java.time.LocalDate; import java.util.Collection; +import java.util.Collections; import org.springframework.boot.test.web.client.TestRestTemplate; import org.springframework.http.HttpHeaders; import org.springframework.http.HttpMethod; @@ -43,21 +44,25 @@ */ @Component public class RequestExecutor { + public static final String VALID_KEY_DATA_1 = "testKey111111111"; public static final String VALID_KEY_DATA_2 = "testKey222222222"; public static final String VALID_KEY_DATA_3 = "testKey333333333"; private static final URI SUBMISSION_URL = URI.create("/version/v1/diagnosis-keys"); + private final TestRestTemplate testRestTemplate; public RequestExecutor(TestRestTemplate testRestTemplate) { this.testRestTemplate = testRestTemplate; } - public ResponseEntity<Void> executeRequest(Collection<TemporaryExposureKey> keys, HttpHeaders headers) { + public ResponseEntity<Void> execute(HttpMethod method, RequestEntity<SubmissionPayload> requestEntity) { + return testRestTemplate.exchange(SUBMISSION_URL, method, requestEntity, Void.class); + } + + public ResponseEntity<Void> executePost(Collection<TemporaryExposureKey> keys, HttpHeaders headers) { SubmissionPayload body = SubmissionPayload.newBuilder().addAllKeys(keys).build(); - RequestEntity<SubmissionPayload> request = - new RequestEntity<>(body, headers, HttpMethod.POST, SUBMISSION_URL); - return testRestTemplate.postForEntity(SUBMISSION_URL, request, Void.class); + return execute(HttpMethod.POST, new RequestEntity<>(body, headers, HttpMethod.POST, SUBMISSION_URL)); } public static HttpHeaders buildOkHeaders() { @@ -95,4 +100,8 @@ public static int createRollingStartIntervalNumber(Integer daysAgo) { .minusDays(daysAgo).atStartOfDay() .toEpochSecond(UTC) / (60 * 10)); } + + public static Collection<TemporaryExposureKey> buildPayloadWithOneKey() { + return Collections.singleton(buildTemporaryExposureKey(VALID_KEY_DATA_1, 1, 3)); + } } diff --git a/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/SubmissionControllerTest.java b/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/SubmissionControllerTest.java --- a/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/SubmissionControllerTest.java +++ b/services/submission/src/test/java/app/coronawarn/server/services/submission/controller/SubmissionControllerTest.java @@ -24,16 +24,19 @@ import static app.coronawarn.server.services.submission.controller.RequestExecutor.VALID_KEY_DATA_2; import static app.coronawarn.server.services.submission.controller.RequestExecutor.VALID_KEY_DATA_3; import static app.coronawarn.server.services.submission.controller.RequestExecutor.buildOkHeaders; +import static app.coronawarn.server.services.submission.controller.RequestExecutor.buildPayloadWithOneKey; import static app.coronawarn.server.services.submission.controller.RequestExecutor.buildTemporaryExposureKey; import static app.coronawarn.server.services.submission.controller.RequestExecutor.createRollingStartIntervalNumber; import static app.coronawarn.server.services.submission.controller.RequestExecutor.setContentTypeProtoBufHeader; import static app.coronawarn.server.services.submission.controller.RequestExecutor.setCwaAuthHeader; import static app.coronawarn.server.services.submission.controller.RequestExecutor.setCwaFakeHeader; import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.ArgumentMatchers.anyLong; import static org.mockito.Mockito.any; import static org.mockito.Mockito.anyString; import static org.mockito.Mockito.atLeastOnce; import static org.mockito.Mockito.never; +import static org.mockito.Mockito.times; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; import static org.springframework.http.HttpStatus.BAD_REQUEST; @@ -46,13 +49,12 @@ import app.coronawarn.server.common.persistence.service.DiagnosisKeyService; import app.coronawarn.server.common.protocols.external.exposurenotification.TemporaryExposureKey; import app.coronawarn.server.services.submission.config.SubmissionServiceConfig; +import app.coronawarn.server.services.submission.monitoring.SubmissionMonitor; import app.coronawarn.server.services.submission.verification.TanVerifier; import com.google.protobuf.ByteString; -import java.net.URI; import java.util.ArrayList; import java.util.Arrays; import java.util.Collection; -import java.util.Collections; import java.util.List; import java.util.Set; import java.util.stream.Collectors; @@ -66,25 +68,27 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.mock.mockito.MockBean; -import org.springframework.boot.test.web.client.TestRestTemplate; import org.springframework.http.HttpHeaders; import org.springframework.http.HttpMethod; import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; +import org.springframework.test.context.ActiveProfiles; @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) +@ActiveProfiles({"disable-ssl-client-verification", "disable-ssl-client-verification-verify-hostname"}) class SubmissionControllerTest { - private static final URI SUBMISSION_URL = URI.create("/version/v1/diagnosis-keys"); - @MockBean private DiagnosisKeyService diagnosisKeyService; @MockBean private TanVerifier tanVerifier; - @Autowired - private TestRestTemplate testRestTemplate; + @MockBean + private SubmissionMonitor submissionMonitor; + + @MockBean + private FakeDelayManager fakeDelayManager; @Autowired private RequestExecutor executor; @@ -95,17 +99,18 @@ class SubmissionControllerTest { @BeforeEach public void setUpMocks() { when(tanVerifier.verifyTan(anyString())).thenReturn(true); + when(fakeDelayManager.getJitteredFakeDelay()).thenReturn(1000L); } @Test void checkResponseStatusForValidParameters() { - ResponseEntity<Void> actResponse = executor.executeRequest(buildPayloadWithMultipleKeys(), buildOkHeaders()); + ResponseEntity<Void> actResponse = executor.executePost(buildPayloadWithMultipleKeys(), buildOkHeaders()); assertThat(actResponse.getStatusCode()).isEqualTo(OK); } @Test void check400ResponseStatusForInvalidParameters() { - ResponseEntity<Void> actResponse = executor.executeRequest(buildPayloadWithInvalidKey(), buildOkHeaders()); + ResponseEntity<Void> actResponse = executor.executePost(buildPayloadWithInvalidKey(), buildOkHeaders()); assertThat(actResponse.getStatusCode()).isEqualTo(BAD_REQUEST); } @@ -114,7 +119,7 @@ void singleKeyWithOutdatedRollingStartIntervalNumberDoesNotGetSaved() { Collection<TemporaryExposureKey> keys = buildPayloadWithSingleOutdatedKey(); ArgumentCaptor<Collection<DiagnosisKey>> argument = ArgumentCaptor.forClass(Collection.class); - executor.executeRequest(keys, buildOkHeaders()); + executor.executePost(keys, buildOkHeaders()); verify(diagnosisKeyService, atLeastOnce()).saveDiagnosisKeys(argument.capture()); assertThat(argument.getValue()).isEmpty(); @@ -122,33 +127,34 @@ void singleKeyWithOutdatedRollingStartIntervalNumberDoesNotGetSaved() { @Test void keysWithOutdatedRollingStartIntervalNumberDoNotGetSaved() { - Collection<TemporaryExposureKey> keys = buildPayloadWithMultipleKeys(); + Collection<TemporaryExposureKey> submittedKeys = buildPayloadWithMultipleKeys(); TemporaryExposureKey outdatedKey = createOutdatedKey(); - keys.add(outdatedKey); + submittedKeys.add(outdatedKey); ArgumentCaptor<Collection<DiagnosisKey>> argument = ArgumentCaptor.forClass(Collection.class); - executor.executeRequest(keys, buildOkHeaders()); + executor.executePost(submittedKeys, buildOkHeaders()); verify(diagnosisKeyService, atLeastOnce()).saveDiagnosisKeys(argument.capture()); - keys.remove(outdatedKey); - assertElementsCorrespondToEachOther(keys, argument.getValue()); + submittedKeys.remove(outdatedKey); + assertElementsCorrespondToEachOther(submittedKeys, argument.getValue()); } @Test - void checkSaveOperationCallForValidParameters() { - Collection<TemporaryExposureKey> keys = buildPayloadWithMultipleKeys(); + void checkSaveOperationCallAndFakeDelayUpdateForValidParameters() { + Collection<TemporaryExposureKey> submittedKeys = buildPayloadWithMultipleKeys(); ArgumentCaptor<Collection<DiagnosisKey>> argument = ArgumentCaptor.forClass(Collection.class); - executor.executeRequest(keys, buildOkHeaders()); + executor.executePost(submittedKeys, buildOkHeaders()); verify(diagnosisKeyService, atLeastOnce()).saveDiagnosisKeys(argument.capture()); - assertElementsCorrespondToEachOther(keys, argument.getValue()); + verify(fakeDelayManager, times(1)).updateFakeRequestDelay(anyLong()); + assertElementsCorrespondToEachOther(submittedKeys, argument.getValue()); } @ParameterizedTest @MethodSource("createIncompleteHeaders") void badRequestIfCwaHeadersMissing(HttpHeaders headers) { - ResponseEntity<Void> actResponse = executor.executeRequest(buildPayloadWithOneKey(), headers); + ResponseEntity<Void> actResponse = executor.executePost(buildPayloadWithOneKey(), headers); verify(diagnosisKeyService, never()).saveDiagnosisKeys(any()); assertThat(actResponse.getStatusCode()).isEqualTo(BAD_REQUEST); @@ -169,8 +175,7 @@ void checkOnlyPostAllowed(HttpMethod deniedHttpMethod) { // METHOD_NOT_ALLOWED is the result of TRACE calls (disabled by default in tomcat) List<HttpStatus> allowedErrors = Arrays.asList(INTERNAL_SERVER_ERROR, FORBIDDEN, METHOD_NOT_ALLOWED); - HttpStatus actStatus = testRestTemplate - .exchange(SUBMISSION_URL, deniedHttpMethod, null, Void.class).getStatusCode(); + HttpStatus actStatus = executor.execute(deniedHttpMethod, null).getStatusCode(); assertThat(allowedErrors) .withFailMessage(deniedHttpMethod + " resulted in unexpected status: " + actStatus) @@ -181,32 +186,40 @@ private static Stream<Arguments> createDeniedHttpMethods() { return Arrays.stream(HttpMethod.values()) .filter(method -> method != HttpMethod.POST) .filter(method -> method != HttpMethod.PATCH) /* not supported by Rest Template */ - .map(elem -> Arguments.of(elem)); + .map(Arguments::of); } @Test void invalidTanHandling() { when(tanVerifier.verifyTan(anyString())).thenReturn(false); - ResponseEntity<Void> actResponse = executor.executeRequest(buildPayloadWithOneKey(), buildOkHeaders()); + ResponseEntity<Void> actResponse = executor.executePost(buildPayloadWithOneKey(), buildOkHeaders()); verify(diagnosisKeyService, never()).saveDiagnosisKeys(any()); + verify(fakeDelayManager, times(1)).updateFakeRequestDelay(anyLong()); assertThat(actResponse.getStatusCode()).isEqualTo(FORBIDDEN); } @Test - void fakeRequestHandling() { - HttpHeaders headers = buildOkHeaders(); - setCwaFakeHeader(headers, "1"); - - ResponseEntity<Void> actResponse = executor.executeRequest(buildPayloadWithOneKey(), headers); + void checkRealRequestHandlingIsMonitored() { + executor.executePost(buildPayloadWithOneKey(), buildOkHeaders()); - verify(diagnosisKeyService, never()).saveDiagnosisKeys(any()); - assertThat(actResponse.getStatusCode()).isEqualTo(OK); + verify(submissionMonitor, times(1)).incrementRequestCounter(); + verify(submissionMonitor, times(1)).incrementRealRequestCounter(); + verify(submissionMonitor, never()).incrementFakeRequestCounter(); + verify(submissionMonitor, never()).incrementInvalidTanRequestCounter(); } - private static Collection<TemporaryExposureKey> buildPayloadWithOneKey() { - return Collections.singleton(buildTemporaryExposureKey(VALID_KEY_DATA_1, 1, 3)); + @Test + void checkInvalidTanHandlingIsMonitored() { + when(tanVerifier.verifyTan(anyString())).thenReturn(false); + + executor.executePost(buildPayloadWithOneKey(), buildOkHeaders()); + + verify(submissionMonitor, times(1)).incrementRequestCounter(); + verify(submissionMonitor, times(1)).incrementRealRequestCounter(); + verify(submissionMonitor, never()).incrementFakeRequestCounter(); + verify(submissionMonitor, times(1)).incrementInvalidTanRequestCounter(); } private Collection<TemporaryExposureKey> buildPayloadWithMultipleKeys() { @@ -232,23 +245,43 @@ private TemporaryExposureKey createOutdatedKey() { .setRollingPeriod(DiagnosisKey.EXPECTED_ROLLING_PERIOD) .setTransmissionRiskLevel(5).build(); } + private static Collection<TemporaryExposureKey> buildPayloadWithInvalidKey() { return Stream.of( buildTemporaryExposureKey(VALID_KEY_DATA_1, createRollingStartIntervalNumber(2), 999)) .collect(Collectors.toCollection(ArrayList::new)); } - private void assertElementsCorrespondToEachOther - (Collection<TemporaryExposureKey> submittedKeys, Collection<DiagnosisKey> keyEntities) { - Set<DiagnosisKey> expKeys = submittedKeys.stream() - .map(aSubmittedKey -> DiagnosisKey.builder().fromProtoBuf(aSubmittedKey).build()) + + private void assertElementsCorrespondToEachOther(Collection<TemporaryExposureKey> submittedTemporaryExposureKeys, + Collection<DiagnosisKey> savedDiagnosisKeys) { + + Set<DiagnosisKey> submittedDiagnosisKeys = submittedTemporaryExposureKeys.stream() + .map(submittedDiagnosisKey -> DiagnosisKey.builder().fromProtoBuf(submittedDiagnosisKey).build()) .collect(Collectors.toSet()); - assertThat(keyEntities.size()) - .withFailMessage("Number of submitted keys and generated key entities don't match.") - .isEqualTo(expKeys.size()); - keyEntities.forEach(anActKey -> assertThat(expKeys) - .withFailMessage("Key entity does not correspond to a submitted key.") - .contains(anActKey) - ); + assertThat(savedDiagnosisKeys).hasSize(submittedDiagnosisKeys.size() * config.getRandomKeyPaddingMultiplier()); + assertThat(savedDiagnosisKeys).containsAll(submittedDiagnosisKeys); + + submittedDiagnosisKeys.forEach(submittedDiagnosisKey -> { + List<DiagnosisKey> savedKeysForSingleSubmittedKey = savedDiagnosisKeys.stream() + .filter(savedDiagnosisKey -> savedDiagnosisKey.getRollingPeriod() == + submittedDiagnosisKey.getRollingPeriod()) + .filter(savedDiagnosisKey -> savedDiagnosisKey.getTransmissionRiskLevel() == + submittedDiagnosisKey.getTransmissionRiskLevel()) + .filter(savedDiagnosisKey -> savedDiagnosisKey.getRollingStartIntervalNumber() == + submittedDiagnosisKey.getRollingStartIntervalNumber()) + .collect(Collectors.toList()); + + assertThat(savedKeysForSingleSubmittedKey).hasSize(config.getRandomKeyPaddingMultiplier()); + assertThat(savedKeysForSingleSubmittedKey.stream().filter(savedKey -> + Arrays.equals(savedKey.getKeyData(), submittedDiagnosisKey.getKeyData()))).hasSize(1); + assertThat(savedKeysForSingleSubmittedKey).allMatch( + savedKey -> savedKey.getRollingPeriod() == submittedDiagnosisKey.getRollingPeriod()); + assertThat(savedKeysForSingleSubmittedKey).allMatch( + savedKey -> savedKey.getRollingStartIntervalNumber() == submittedDiagnosisKey + .getRollingStartIntervalNumber()); + assertThat(savedKeysForSingleSubmittedKey).allMatch( + savedKey -> savedKey.getTransmissionRiskLevel() == submittedDiagnosisKey.getTransmissionRiskLevel()); + }); } } diff --git a/services/submission/src/test/java/app/coronawarn/server/services/submission/monitoring/BatchCounterTest.java b/services/submission/src/test/java/app/coronawarn/server/services/submission/monitoring/BatchCounterTest.java new file mode 100644 --- /dev/null +++ b/services/submission/src/test/java/app/coronawarn/server/services/submission/monitoring/BatchCounterTest.java @@ -0,0 +1,64 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.submission.monitoring; + +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.spy; +import static org.mockito.Mockito.times; +import static org.mockito.Mockito.verify; + +import io.micrometer.core.instrument.Counter; +import io.micrometer.core.instrument.MeterRegistry; +import io.micrometer.core.instrument.MeterRegistryMock; +import java.util.stream.LongStream; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.ValueSource; + +class BatchCounterTest { + + private static final String COUNTER_TYPE = "FooCounter"; + private MeterRegistry meterRegistry; + private Counter meterCounter; + + @BeforeEach + void setUpCounter() { + meterCounter = mock(Counter.class); + meterRegistry = spy(new MeterRegistryMock(meterCounter)); + } + + @ParameterizedTest + @ValueSource(longs = {1L, 2L, 4L}) + void incrementSubmittedOnceIfBatchSizeReached(long batchSize) { + BatchCounter batchCounter = new BatchCounter(meterRegistry, batchSize, COUNTER_TYPE); + LongStream.range(0, batchSize).forEach(ignoredValue -> batchCounter.increment()); + verify(meterCounter, times(1)).increment(batchSize); + } + + @ParameterizedTest + @ValueSource(longs = {2L, 4L, 7L}) + void doesNotIncrementIfLesserThanBatchSize(long batchSize) { + BatchCounter batchCounter = new BatchCounter(meterRegistry, batchSize, COUNTER_TYPE); + LongStream.range(0, batchSize - 1).forEach(ignoredValue -> batchCounter.increment()); + verify(meterCounter, never()).increment(batchSize); + } +} diff --git a/services/submission/src/test/java/app/coronawarn/server/services/submission/monitoring/SubmissionMonitorTest.java b/services/submission/src/test/java/app/coronawarn/server/services/submission/monitoring/SubmissionMonitorTest.java new file mode 100644 --- /dev/null +++ b/services/submission/src/test/java/app/coronawarn/server/services/submission/monitoring/SubmissionMonitorTest.java @@ -0,0 +1,78 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.submission.monitoring; + +import static org.mockito.ArgumentMatchers.anyDouble; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.reset; +import static org.mockito.Mockito.spy; +import static org.mockito.Mockito.times; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +import app.coronawarn.server.services.submission.config.SubmissionServiceConfig; +import app.coronawarn.server.services.submission.controller.FakeDelayManager; +import io.micrometer.core.instrument.Counter; +import io.micrometer.core.instrument.MeterRegistry; +import io.micrometer.core.instrument.MeterRegistryMock; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +class SubmissionMonitorTest { + + private final Counter meterCounter = mock(Counter.class); + private final SubmissionServiceConfig submissionServiceConfig = mock(SubmissionServiceConfig.class); + private MeterRegistry meterRegistry; + private SubmissionMonitor submissionMonitor; + + @BeforeEach + void setup() { + reset(meterCounter); + reset(submissionServiceConfig); + meterRegistry = spy(new MeterRegistryMock(meterCounter)); + when(submissionServiceConfig.getMonitoringBatchSize()).thenReturn(1L); + submissionMonitor = new SubmissionMonitor(meterRegistry, submissionServiceConfig, mock(FakeDelayManager.class)); + } + + @Test + void incrementFakeRequestCounterIncrementsEnclosedCounter() { + submissionMonitor.incrementFakeRequestCounter(); + verify(meterCounter, times(1)).increment(anyDouble()); + } + + @Test + void incrementInvalidTanRequestCounterIncrementsEnclosedCounter() { + submissionMonitor.incrementInvalidTanRequestCounter(); + verify(meterCounter, times(1)).increment(anyDouble()); + } + + @Test + void incrementRealRequestCounterIncrementsEnclosedCounter() { + submissionMonitor.incrementRealRequestCounter(); + verify(meterCounter, times(1)).increment(anyDouble()); + } + + @Test + void incrementRequestCounterIncrementsEnclosedCounter() { + submissionMonitor.incrementRequestCounter(); + verify(meterCounter, times(1)).increment(anyDouble()); + } +} diff --git a/services/submission/src/test/java/app/coronawarn/server/services/submission/monitoring/VerificationServiceHealthIndicatorTest.java b/services/submission/src/test/java/app/coronawarn/server/services/submission/monitoring/VerificationServiceHealthIndicatorTest.java --- a/services/submission/src/test/java/app/coronawarn/server/services/submission/monitoring/VerificationServiceHealthIndicatorTest.java +++ b/services/submission/src/test/java/app/coronawarn/server/services/submission/monitoring/VerificationServiceHealthIndicatorTest.java @@ -32,14 +32,15 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.mock.mockito.MockBean; +import org.springframework.test.context.ActiveProfiles; import org.springframework.test.context.TestPropertySource; import org.springframework.test.web.servlet.MockMvc; import org.springframework.test.web.servlet.setup.MockMvcBuilders; import org.springframework.web.context.WebApplicationContext; - @TestPropertySource(properties = {"management.port="}) @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) +@ActiveProfiles({ "disable-ssl-client-verification", "disable-ssl-client-verification-verify-hostname" }) class VerificationServiceHealthIndicatorTest { @MockBean @@ -56,12 +57,19 @@ public void setup() { } @Test - void checkIsHealthyIfVerificationServerIsRunning() throws Exception { + void checkIsHealthyIfVerificationServerIsRunningAndExceptionIsThrown() throws Exception { when(verificationServerClient.verifyTan(any())).thenThrow(FeignException.NotFound.class); mvc.perform(get("/actuator/health")) .andExpect(status().is2xxSuccessful()).andReturn(); } + @Test + void checkIsHealthyIfVerificationServerIsRunning() throws Exception { + when(verificationServerClient.verifyTan(any())).thenReturn("ok"); + mvc.perform(get("/actuator/health")) + .andExpect(status().is2xxSuccessful()).andReturn(); + } + @Test void checkIsUnhealthyIfVerificationServerIsDown() throws Exception { when(verificationServerClient.verifyTan(any())).thenThrow(FeignException.InternalServerError.class); diff --git a/services/submission/src/test/java/app/coronawarn/server/services/submission/verification/TanTest.java b/services/submission/src/test/java/app/coronawarn/server/services/submission/verification/TanTest.java --- a/services/submission/src/test/java/app/coronawarn/server/services/submission/verification/TanTest.java +++ b/services/submission/src/test/java/app/coronawarn/server/services/submission/verification/TanTest.java @@ -29,10 +29,11 @@ import org.junit.jupiter.params.provider.ValueSource; class TanTest { + @ParameterizedTest @ValueSource(strings = { - "ANY SYNTAX", "123456", "ABCD23X", "ZZZZZZZ", "Bearer 3123fe", "", "&%$§&%&$%/%&", - "LOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOONG" + "ANY SYNTAX", "123456", "ABCD23X", "ZZZZZZZ", "Bearer 3123fe", "", "&%$§&%&$%/%&", + "LOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOONG" }) void invalidTanShouldThrowException(String invalidSyntaxTan) { assertThatThrownBy(() -> Tan.of(invalidSyntaxTan)).isInstanceOf(IllegalArgumentException.class); @@ -43,7 +44,6 @@ void validTanShouldReturnTanInstance() { String tanString = UUID.randomUUID().toString(); Tan tan = Tan.of(tanString); - assertThat(tan).isNotNull(); - assertThat(tan.toString()).isEqualTo(tanString); + assertThat(tan).isNotNull().hasToString(tanString); } } diff --git a/services/submission/src/test/java/app/coronawarn/server/services/submission/verification/TanVerifierTest.java b/services/submission/src/test/java/app/coronawarn/server/services/submission/verification/TanVerifierTest.java --- a/services/submission/src/test/java/app/coronawarn/server/services/submission/verification/TanVerifierTest.java +++ b/services/submission/src/test/java/app/coronawarn/server/services/submission/verification/TanVerifierTest.java @@ -20,7 +20,6 @@ package app.coronawarn.server.services.submission.verification; - import static com.github.tomakehurst.wiremock.client.WireMock.aResponse; import static com.github.tomakehurst.wiremock.client.WireMock.equalTo; import static com.github.tomakehurst.wiremock.client.WireMock.matchingJsonPath; @@ -49,11 +48,11 @@ import org.springframework.http.MediaType; import org.springframework.test.context.ActiveProfiles; -@SpringBootTest(classes = {TanVerifier.class, DevelopmentFeignClientProvider.class}) +@SpringBootTest(classes = {TanVerifier.class, DevelopmentFeignClientProvider.class, NoopHostnameVerifierProvider.class}) @ImportAutoConfiguration({FeignAutoConfiguration.class, FeignTestConfiguration.class}) @EnableConfigurationProperties(value = SubmissionServiceConfig.class) @EnableFeignClients -@ActiveProfiles("feign") +@ActiveProfiles({ "feign", "disable-ssl-client-verification", "disable-ssl-client-verification-verify-hostname" }) class TanVerifierTest { @Autowired @@ -109,6 +108,18 @@ void checkInvalidTan() { assertThat(tanVerificationResponse).isFalse(); } + @Test + void checkTooLongTan() { + server.stubFor( + post(urlEqualTo(verificationPath)) + .withHeader(CONTENT_TYPE, equalTo(MediaType.APPLICATION_JSON.toString())) + .willReturn(aResponse().withStatus(HttpStatus.NOT_FOUND.value()))); + + boolean tanVerificationResponse = tanVerifier.verifyTan(randomUUID + randomUUID); + + assertThat(tanVerificationResponse).isFalse(); + } + @Test void checkInternalServerError() { server.stubFor( @@ -119,4 +130,14 @@ void checkInternalServerError() { assertThatExceptionOfType(FeignException.class).isThrownBy(() -> tanVerifier.verifyTan(randomUUID)); } + @Test + void checkTimeout() { + server.stubFor( + post(urlEqualTo(verificationPath)) + .withRequestBody(matchingJsonPath("tan", equalTo(randomUUID))) + .withHeader(CONTENT_TYPE, equalTo(MediaType.APPLICATION_JSON.toString())) + .willReturn(aResponse().withStatus(HttpStatus.OK.value()).withFixedDelay(1000))); + + assertThatExceptionOfType(FeignException.class).isThrownBy(() -> tanVerifier.verifyTan(randomUUID)); + } } diff --git a/services/submission/src/test/java/io/micrometer/core/instrument/MeterRegistryMock.java b/services/submission/src/test/java/io/micrometer/core/instrument/MeterRegistryMock.java new file mode 100644 --- /dev/null +++ b/services/submission/src/test/java/io/micrometer/core/instrument/MeterRegistryMock.java @@ -0,0 +1,40 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package io.micrometer.core.instrument; + +import io.micrometer.core.instrument.simple.SimpleMeterRegistry; + +/** + * Used to get access to the {@link Counter} instance in BatchCounterTest. + */ +public class MeterRegistryMock extends SimpleMeterRegistry { + + final Counter counter; + + public MeterRegistryMock(Counter counter) { + this.counter = counter; + } + + @Override + Counter counter(Meter.Id id) { + return counter; + } +} diff --git a/services/submission/src/test/resources/application.yaml b/services/submission/src/test/resources/application.yaml --- a/services/submission/src/test/resources/application.yaml +++ b/services/submission/src/test/resources/application.yaml @@ -7,26 +7,22 @@ logging: spring: main: banner-mode: off - flyway: - enabled: true - # default case is H2 - value will be overwritten by profile cloud or postgres - locations: classpath:db/migration/h2 datasource: url: jdbc:h2:mem:test;MODE=PostgreSQL driverClassName: org.h2.Driver platform: h2 test: database: + # Use datasource as defined above. replace: none - jpa: - hibernate: - ddl-auto: validate services: submission: initial-fake-delay-milliseconds: 1 fake-delay-moving-average-samples: 1 retention-days: 14 + random-key-padding-multiplier: 10 + connection-pool-size: 200 payload: max-number-of-keys: 14 verification: @@ -48,3 +44,10 @@ management: health: probes: enabled: true + +feign: + client: + config: + default: + connect-timeout: 500 + read-timeout: 500 \ No newline at end of file diff --git a/services/submission/src/test/resources/bootstrap.yaml b/services/submission/src/test/resources/bootstrap.yaml new file mode 100644 --- /dev/null +++ b/services/submission/src/test/resources/bootstrap.yaml @@ -0,0 +1,5 @@ +--- +spring: + cloud: + vault: + enabled: false

Failing requests in down-scaling scenario ## Describe the bug Reducing the number of submission service service pods leads to immediate termination of request processing on the service instance that is shutting down while. This results in clients observing a failing requests. In the worst case scenario, submission processing is interrupted after a TAN was verified successfully but the corresponding diagnosis keys have not been persisted yet. ## Expected behaviour On a service instance that is shutting down, no new requests shall be accepted. Requests that are already being processed at the time shall be given a grace period in which they are allowed to finish processing. ## Possible Fix - ``ThreadPoolExecutor.awaitTermination`` and similar concepts ## Additional context From a previous performance testing run: <!-- Add any other context about the problem here. -->  Log4j improper shutdown ## Current Behaviour On Distribution service shutdown, the following log entry appears, indicating Log4j did not shutdown properly. Also, it is logged using the fallback `SimpleLogger` which uses a different timestamp date format and is not consistent with other log entries and therefore may not be picked up by monitoring tools. `2020-06-12 09:05:23,582 SpringContextShutdownHook WARN Unable to register Log4j shutdown hook because JVM is shutting down. Using SimpleLogger` This is due to an [unresolved bug](https://issues.apache.org/jira/browse/LOG4J2-658) with Log4j. ## Possible Fix As described in https://stackoverflow.com/questions/30120330/log4j2-unable-to-register-shutdown-hook-because-jvm-is-shutting-down/33134173, a workaround is: - Disable Log4j's automatic shutdown hook - Register a manual shutdown hook instead

corona-warn-app/cwa-server

corona-warn-app__cwa-server-676

7e519598cbf2823ab655a057f8a0f77297bf6ed1

diff --git a/docker-compose.yml b/docker-compose.yml --- a/docker-compose.yml +++ b/docker-compose.yml @@ -46,6 +46,7 @@ services: services.distribution.paths.output: /tmp/distribution # Settings for cryptographic artifacts VAULT_FILESIGNING_SECRET: ${SECRET_PRIVATE} + FORCE_UPDATE_KEYFILES: 'false' volumes: - ./docker-compose-test-secrets:/secrets postgres: diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundler.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundler.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundler.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundler.java @@ -31,6 +31,7 @@ import java.time.temporal.ChronoUnit; import java.util.ArrayList; import java.util.Collection; +import java.util.Collections; import java.util.HashMap; import java.util.List; import java.util.Map; @@ -83,6 +84,9 @@ protected void createDiagnosisKeyDistributionMap(Collection<DiagnosisKey> diagno if (diagnosisKeyAccumulator.size() >= minNumberOfKeysPerBundle) { this.distributableDiagnosisKeys.put(currentHour, new ArrayList<>(diagnosisKeyAccumulator)); diagnosisKeyAccumulator.clear(); + } else { + // placeholder list is needed to be able to generate empty file - see issue #650 + this.distributableDiagnosisKeys.put(currentHour, Collections.emptyList()); } }); } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/config/DistributionServiceConfig.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/config/DistributionServiceConfig.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/config/DistributionServiceConfig.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/config/DistributionServiceConfig.java @@ -464,6 +464,7 @@ public static class ObjectStore { @Min(1) @Max(64) private Integer maxNumberOfS3Threads; + private Boolean forceUpdateKeyfiles; public String getAccessKey() { return accessKey; @@ -528,5 +529,13 @@ public Integer getMaxNumberOfS3Threads() { public void setMaxNumberOfS3Threads(Integer maxNumberOfS3Threads) { this.maxNumberOfS3Threads = maxNumberOfS3Threads; } + + public Boolean getForceUpdateKeyfiles() { + return forceUpdateKeyfiles; + } + + public void setForceUpdateKeyfiles(Boolean forceUpdateKeyfiles) { + this.forceUpdateKeyfiles = forceUpdateKeyfiles; + } } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3Publisher.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3Publisher.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3Publisher.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/S3Publisher.java @@ -79,28 +79,25 @@ public S3Publisher(ObjectStoreAccess objectStoreAccess, FailedObjectStoreOperati } /** - * Synchronizes the files to S3. + * Synchronizes the files to S3. Current strategy is to never update diagnosis key archive files already + * published on S3, even if the retention and shifting policies cause a diff between subsequent distribution runs. + * Thus, by default distribution will only add new key files, but still modify indexes. This behaviour can however + * be controlled through the configuration parameter <code>DistributionServiceConfig.forceUpdateKeyFiles</code> * * @param root The path of the directory that shall be published. + * @see Github issue #650 * @throws IOException in case there were problems reading files from the disk. */ public void publish(Path root) throws IOException { - PublishedFileSet published; List<LocalFile> toPublish = new PublishFileSet(root).getFiles(); - List<LocalFile> diff; - try { - published = new PublishedFileSet( - objectStoreAccess.getObjectsWithPrefix(distributionServiceConfig.getApi().getVersionPath())); - diff = toPublish - .stream() - .filter(published::isNotYetPublished) - .collect(Collectors.toList()); - } catch (ObjectStoreOperationFailedException e) { - failedOperationsCounter.incrementAndCheckThreshold(e); - // failed to retrieve existing files; publish everything - diff = toPublish; - } + PublishedFileSet published = new PublishedFileSet( + objectStoreAccess.getObjectsWithPrefix(distributionServiceConfig.getApi().getVersionPath()), + distributionServiceConfig.getObjectStore().getForceUpdateKeyfiles()); + List<LocalFile> diff = toPublish + .stream() + .filter(published::shouldPublish) + .collect(Collectors.toList()); logger.info("Beginning upload of {} files... ", diff.size()); try { diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/S3Object.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/S3Object.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/S3Object.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/client/S3Object.java @@ -63,6 +63,15 @@ public String getCwaHash() { return cwaHash; } + /** + * Indicates if the S3 object is a file with diagnosis key content. + * The evaluation is based on the distribution logic which implies that such files are generated + * with a Date / Hour S3 key format (days: 1-31 / hours: 0-23) ending in 2 digits. + */ + public boolean isDiagnosisKeyFile() { + return Objects.nonNull(objectName) && objectName.matches(".*\\d\\d"); + } + @Override public boolean equals(Object o) { if (this == o) { diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/LocalFile.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/LocalFile.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/LocalFile.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/LocalFile.java @@ -97,11 +97,21 @@ public String getContentType() { if (s3Key.endsWith("app_config")) { return "application/zip"; } - if (s3Key.matches(".*\\d")) { + if (isKeyFile()) { // date and hourly diagnosis key files return "application/zip"; } // list of versions, dates, hours return "application/json"; } + + /** + * Indicates if a local file is a Key-file or not. Only the Key files are stored in the Date / Hour tree structure. + * One file per sub-folder (days: 1-31 / hours: 0-23). The index files are not stored in folders ending with a digit. + * + * @return <code>true</code> if and only if the {@link #s3Key} ends with a digit, false otherwise. + */ + public boolean isKeyFile() { + return s3Key.matches(".*\\d"); + } } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/PublishedFileSet.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/PublishedFileSet.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/PublishedFileSet.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/objectstore/publish/PublishedFileSet.java @@ -32,37 +32,52 @@ public class PublishedFileSet { /** ta map of S3 objects with the S3 object name as the key component of the map. */ private Map<String, S3Object> s3Objects; + private boolean isKeyFilePublishingAllowed; + /** - * Creates a new PublishedFileSet for the given S3 objects with the help of the metadata provider. - * The metadata provider helps to determine whether files have been changed, and are requiring - * re-upload. + * Creates a new PublishedFileSet for the given S3 objects with the help of the + * metadata provider. The metadata provider helps to determine whether files + * have been changed, and are requiring re-upload. * - * @param s3Objects the list of s3 objects. + * @param s3Objects the list of s3 objects. + * @param isKeyFilePublishingAllowed whether the system is currently configured + * to allow diagnosis key file updates on S3 */ - public PublishedFileSet(List<S3Object> s3Objects) { + public PublishedFileSet(List<S3Object> s3Objects, boolean isKeyFilePublishingAllowed) { this.s3Objects = s3Objects.stream() .collect(Collectors.toMap(S3Object::getObjectName, s3object -> s3object)); + this.isKeyFilePublishingAllowed = isKeyFilePublishingAllowed; } /** - * Checks whether the given file, which is subject for publishing, is already available on the S3. - * Will return true, when: + * Checks whether the given file, which is subject for publishing, is already available on the S3. Will return true, + * when: * <ul> - * <li>The S3 object key exists on S3</li> - * <li>The checksum of the existing S3 object matches the hash of the given file</li> + * <li>The S3 object key does NOT exist on S3.</li> + * <li>The environment variable FORCE_UPDATE_KEYFILES is set to true.</li> + * <li>The checksum of the existing S3 object differs to the hash of the given file.</li> * </ul> * * @param file the to-be-published file which should be checked - * @return true, if it exists and is identical + * @return {@code true}, if it doesn't exist or differs - {@code false}, if the file has been published already */ - public boolean isNotYetPublished(LocalFile file) { + public boolean shouldPublish(LocalFile file) { S3Object published = s3Objects.get(file.getS3Key()); if (published == null) { return true; } + if (file.isKeyFile()) { + // #650 - once published key files should not be changed anymore unless explicitly forced + return isKeyFilePublishingAllowed && contentChanged(file, published); + } + + return contentChanged(file, published); + } + + private boolean contentChanged(LocalFile file, S3Object published) { return !file.getChecksum().equals(published.getCwaHash()); } diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/RetentionPolicy.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/RetentionPolicy.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/RetentionPolicy.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/RetentionPolicy.java @@ -53,7 +53,7 @@ public class RetentionPolicy implements ApplicationRunner { /** * Creates a new RetentionPolicy. */ - RetentionPolicy(DiagnosisKeyService diagnosisKeyService, + public RetentionPolicy(DiagnosisKeyService diagnosisKeyService, ApplicationContext applicationContext, DistributionServiceConfig distributionServiceConfig, S3RetentionPolicy s3RetentionPolicy) { diff --git a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/S3Distribution.java b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/S3Distribution.java --- a/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/S3Distribution.java +++ b/services/distribution/src/main/java/app/coronawarn/server/services/distribution/runner/S3Distribution.java @@ -20,6 +20,7 @@ package app.coronawarn.server.services.distribution.runner; +import app.coronawarn.server.services.distribution.Application; import app.coronawarn.server.services.distribution.assembly.component.OutputDirectoryProvider; import app.coronawarn.server.services.distribution.objectstore.S3Publisher; import app.coronawarn.server.services.distribution.objectstore.client.ObjectStoreOperationFailedException; @@ -29,6 +30,7 @@ import org.slf4j.LoggerFactory; import org.springframework.boot.ApplicationArguments; import org.springframework.boot.ApplicationRunner; +import org.springframework.context.ApplicationContext; import org.springframework.core.annotation.Order; import org.springframework.stereotype.Component; @@ -43,10 +45,13 @@ public class S3Distribution implements ApplicationRunner { private final OutputDirectoryProvider outputDirectoryProvider; private final S3Publisher s3Publisher; + private final ApplicationContext applicationContext; - S3Distribution(OutputDirectoryProvider outputDirectoryProvider, S3Publisher s3Publisher) { + S3Distribution(OutputDirectoryProvider outputDirectoryProvider, S3Publisher s3Publisher, + ApplicationContext applicationContext) { this.outputDirectoryProvider = outputDirectoryProvider; this.s3Publisher = s3Publisher; + this.applicationContext = applicationContext; } @Override @@ -58,6 +63,7 @@ public void run(ApplicationArguments args) { logger.info("Data pushed to Object Store successfully."); } catch (UnsupportedOperationException | ObjectStoreOperationFailedException | IOException e) { logger.error("Distribution failed.", e); + Application.killApplication(applicationContext); } } } diff --git a/services/distribution/src/main/resources/application.yaml b/services/distribution/src/main/resources/application.yaml --- a/services/distribution/src/main/resources/application.yaml +++ b/services/distribution/src/main/resources/application.yaml @@ -79,6 +79,8 @@ services: max-number-of-failed-operations: 5 # The ThreadPoolTaskExecutor's maximum thread pool size. max-number-of-s3-threads: 4 + # Allows distribution to overwrite files which are published on the object store + force-update-keyfiles: ${FORCE_UPDATE_KEYFILES:false} spring: main:

diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundlerKeyRetrievalTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundlerKeyRetrievalTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundlerKeyRetrievalTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/ProdDiagnosisKeyBundlerKeyRetrievalTest.java @@ -89,7 +89,7 @@ void testGetsDatesWithDistributableDiagnosisKeys() { @MethodSource("createDiagnosisKeysForEpochDay0") void testGetDatesForEpochDay0(Collection<DiagnosisKey> diagnosisKeys) { bundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); - var expDates = Set.of(LocalDate.ofEpochDay(2L)); + var expDates = Set.of(LocalDate.ofEpochDay(2L), LocalDate.ofEpochDay(3L)); var actDates = bundler.getDatesWithDistributableDiagnosisKeys(); assertThat(actDates).isEqualTo(expDates); } diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectoryTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectoryTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectoryTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDateDirectoryTest.java @@ -46,6 +46,7 @@ import java.util.stream.IntStream; import org.junit.Rule; import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.ExtendWith; import org.junit.rules.TemporaryFolder; @@ -105,9 +106,10 @@ void testCreatesCorrectDirectoryStructureForMultipleDates() { runDateDistribution(diagnosisKeys, LocalDateTime.of(1970, 1, 6, 0, 0)); Set<String> actualFiles = Helpers.getFilePaths(outputFile, outputFile.getAbsolutePath()); Set<String> expectedDateAndHourFiles = getExpectedDateAndHourFiles(Map.of( - "1970-01-03", List.of("0", "1", "2", "3", "4"), - "1970-01-04", List.of("0", "1", "2", "3", "4"), - "1970-01-05", List.of("0", "1", "2", "3", "4")), "1970-01-06"); + "1970-01-03", listOfHoursAsStrings(0, 23), + "1970-01-04", listOfHoursAsStrings(0, 23), + "1970-01-05", listOfHoursAsStrings(0, 23)), + "1970-01-06"); assertThat(actualFiles).isEqualTo(expectedDateAndHourFiles); } @@ -124,14 +126,17 @@ void testDoesNotIncludeCurrentDateInDirectoryStructure() { runDateDistribution(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 12, 0)); Set<String> actualFiles = Helpers.getFilePaths(outputFile, outputFile.getAbsolutePath()); Set<String> expectedDateAndHourFiles = getExpectedDateAndHourFiles(Map.of( - "1970-01-03", List.of("0", "1", "2", "3", "4"), - "1970-01-04", List.of("0", "1", "2", "3", "4"), - "1970-01-05", List.of("0", "1", "2", "3", "4")), "1970-01-05"); + "1970-01-03", listOfHoursAsStrings(0, 23), + "1970-01-04", listOfHoursAsStrings(0, 23), + "1970-01-05", listOfHoursAsStrings(0, 11)), "1970-01-05"); assertThat(actualFiles).isEqualTo(expectedDateAndHourFiles); } @Test - void testDoesNotIncludeEmptyDatesInDirectoryStructure() { + @Disabled("Temporarily disabling this test as part of the fix for issue #650." + + "There seems to be a timing issue with this test because running it individually works, but running it" + + " in a suite will cause it to produce a different output then expected. Further investigation is required here ") + void testIncludesEmptyDatesInDirectoryStructure() { Collection<DiagnosisKey> diagnosisKeys = IntStream.range(0, 3) .filter(currentDate -> currentDate != 1) .mapToObj(currentDate -> IntStream.range(0, 5) @@ -145,13 +150,14 @@ void testDoesNotIncludeEmptyDatesInDirectoryStructure() { runDateDistribution(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 12, 0)); Set<String> actualFiles = Helpers.getFilePaths(outputFile, outputFile.getAbsolutePath()); Set<String> expectedDateAndHourFiles = getExpectedDateAndHourFiles(Map.of( - "1970-01-03", List.of("0", "1", "2", "3", "4"), - "1970-01-05", List.of("0", "1", "2", "3", "4")), "1970-01-05"); + "1970-01-03", listOfHoursAsStrings(0, 23), + "1970-01-04", listOfHoursAsStrings(0, 23), + "1970-01-05", listOfHoursAsStrings(0, 11)), "1970-01-05"); assertThat(actualFiles).isEqualTo(expectedDateAndHourFiles); } @Test - void testDoesNotIncludeDatesWithTooFewKeysInDirectoryStructure() { + void testIncludesDatesWithFewerKeysThanThresholdInDirectoryStructure() { Collection<DiagnosisKey> diagnosisKeys = List.of( buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 1, 0), 5), buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 4, 1, 0), 4), @@ -162,8 +168,10 @@ void testDoesNotIncludeDatesWithTooFewKeysInDirectoryStructure() { runDateDistribution(diagnosisKeys, LocalDateTime.of(1970, 1, 6, 12, 0)); Set<String> actualFiles = Helpers.getFilePaths(outputFile, outputFile.getAbsolutePath()); Set<String> expectedDateAndHourFiles = getExpectedDateAndHourFiles(Map.of( - "1970-01-03", List.of("1"), - "1970-01-05", List.of("1")), "1970-01-06"); + "1970-01-03", listOfHoursAsStrings(1, 23), + "1970-01-04", listOfHoursAsStrings(0, 23), + "1970-01-05", listOfHoursAsStrings(0, 23), + "1970-01-06", listOfHoursAsStrings(0, 11)), "1970-01-06"); assertThat(actualFiles).isEqualTo(expectedDateAndHourFiles); } @@ -179,13 +187,16 @@ void testDoesNotIncludeDatesInTheFuture() { runDateDistribution(diagnosisKeys, LocalDateTime.of(1970, 1, 4, 12, 0)); Set<String> actualFiles = Helpers.getFilePaths(outputFile, outputFile.getAbsolutePath()); Set<String> expectedDateAndHourFiles = getExpectedDateAndHourFiles(Map.of( - "1970-01-03", List.of("1"), - "1970-01-04", List.of("1")), "1970-01-04"); + "1970-01-03", listOfHoursAsStrings(1, 23), + "1970-01-04", listOfHoursAsStrings(0, 11)), "1970-01-04"); assertThat(actualFiles).isEqualTo(expectedDateAndHourFiles); } @Test void testWhenDemoProfileIsActiveItDoesIncludeCurrentDateInDirectoryStructure() { + // set the incomplete days configuration for this particular test but revert before test ends + // such that other tests are + Boolean currentIncompleteDaysConfig = distributionServiceConfig.getIncludeIncompleteDays(); distributionServiceConfig.setIncludeIncompleteDays(true); Collection<DiagnosisKey> diagnosisKeys = IntStream.range(0, 3) .mapToObj(currentDate -> IntStream.range(0, 5) @@ -198,12 +209,19 @@ void testWhenDemoProfileIsActiveItDoesIncludeCurrentDateInDirectoryStructure() { runDateDistribution(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 12, 0)); Set<String> actualFiles = Helpers.getFilePaths(outputFile, outputFile.getAbsolutePath()); Set<String> expectedDateAndHourFiles = getExpectedDateAndHourFiles(Map.of( - "1970-01-03", List.of("0", "1", "2", "3", "4"), - "1970-01-04", List.of("0", "1", "2", "3", "4"), - "1970-01-05", List.of("0", "1", "2", "3", "4")), "1970-01-05"); + "1970-01-03", listOfHoursAsStrings(0, 23), + "1970-01-04", listOfHoursAsStrings(0, 23), + "1970-01-05", listOfHoursAsStrings(0, 11)), "1970-01-05"); expectedDateAndHourFiles.addAll(Set.of( String.join(separator, "date", "1970-01-05", "index"), String.join(separator, "date", "1970-01-05", "index.checksum"))); + + distributionServiceConfig.setIncludeIncompleteDays(currentIncompleteDaysConfig); assertThat(actualFiles).isEqualTo(expectedDateAndHourFiles); } + + private static List<String> listOfHoursAsStrings(int from, int until) { + return IntStream.range(from, until + 1).mapToObj(String::valueOf).collect(Collectors.toList()); + } + } diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDirectoryTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDirectoryTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDirectoryTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysDirectoryTest.java @@ -148,7 +148,8 @@ void checkBuildsTheCorrectDirectoryStructure() { join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "hour", "17", "index"), join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "hour", "18", "index"), join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "hour", "19", "index"), - // One missing + // One missing from data, but still we should a structure created because of the empty file (issue #650) + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "hour", "20", "index"), join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "hour", "21", "index"), join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "hour", "22", "index"), join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-03", "hour", "23", "index"), @@ -159,7 +160,25 @@ void checkBuildsTheCorrectDirectoryStructure() { join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "hour", "2", "index"), join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "hour", "3", "index"), join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "hour", "4", "index"), - join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "hour", "5", "index") + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "hour", "5", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "hour", "6", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "hour", "7", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "hour", "8", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "hour", "9", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "hour", "10", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "hour", "11", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "hour", "12", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "hour", "13", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "hour", "14", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "hour", "15", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "hour", "16", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "hour", "17", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "hour", "18", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "hour", "19", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "hour", "20", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "hour", "21", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "hour", "22", "index"), + join(s, "diagnosis-keys", "country", "DE", "date", "1970-01-04", "hour", "23", "index") ); Set<String> actualFiles = getFilePaths(outputFile, outputFile.getAbsolutePath()); diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectoryTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectoryTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectoryTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/DiagnosisKeysHourDirectoryTest.java @@ -44,6 +44,7 @@ import java.util.Set; import java.util.stream.Collectors; import java.util.stream.IntStream; + import org.junit.Rule; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @@ -100,23 +101,11 @@ void testCreatesCorrectStructureForMultipleHours() { .mapToObj(currentHour -> buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 0, 0).plusHours(currentHour), 5)) .flatMap(List::stream) .collect(Collectors.toList()); - runHourDistribution(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0), + runHourDistribution(diagnosisKeys, LocalDateTime.of(1970, 1, 4, 0, 0), LocalDate.of(1970, 1, 3)); Set<String> actualFiles = getFilePaths(outputFile, outputFile.getAbsolutePath()); - assertThat(actualFiles).isEqualTo(getExpectedHourFiles(Set.of("0", "1", "2", "3", "4"))); - } - - @Test - void testDoesNotIncludeEmptyHours() { - Collection<DiagnosisKey> diagnosisKeys = IntStream.range(0, 5) - .filter(currentHour -> currentHour != 3) - .mapToObj(currentHour -> buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 0, 0).plusHours(currentHour), 5)) - .flatMap(List::stream) - .collect(Collectors.toList()); - runHourDistribution(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0), - LocalDate.of(1970, 1, 3)); - Set<String> actualFiles = getFilePaths(outputFile, outputFile.getAbsolutePath()); - assertThat(actualFiles).isEqualTo(getExpectedHourFiles(Set.of("0", "1", "2", "4"))); + assertThat(actualFiles).isEqualTo(getExpectedHourFiles( + IntStream.range(0, 24).mapToObj(String::valueOf).collect(Collectors.toSet()))); } @Test @@ -131,21 +120,6 @@ void testDoesNotIncludeCurrentHour() { assertThat(actualFiles).isEqualTo(getExpectedHourFiles(Set.of("0", "1", "2", "3"))); } - @Test - void testDoesNotIncludeHoursWithTooFewKeys() { - Collection<DiagnosisKey> diagnosisKeys = List.of( - buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 0, 0), 5), - buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 1, 0), 4), - buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 2, 0), 5)) - .stream() - .flatMap(List::stream) - .collect(Collectors.toList()); - runHourDistribution(diagnosisKeys, LocalDateTime.of(1970, 1, 6, 12, 0), - LocalDate.of(1970, 1, 3)); - Set<String> actualFiles = getFilePaths(outputFile, outputFile.getAbsolutePath()); - assertThat(actualFiles).isEqualTo(getExpectedHourFiles(Set.of("0", "2"))); - } - @Test void testDoesNotIncludeHoursInTheFuture() { Collection<DiagnosisKey> diagnosisKeys = List.of( diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/DateIndexingDecoratorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/DateIndexingDecoratorTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/DateIndexingDecoratorTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/DateIndexingDecoratorTest.java @@ -66,24 +66,6 @@ void setup() { diagnosisKeyBundler = new ProdDiagnosisKeyBundler(distributionServiceConfig); } - @Test - void excludesEmptyDatesFromIndex() { - List<DiagnosisKey> diagnosisKeys = Stream - .of(buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 0, 0), 5), - buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 4, 0, 0), 0), - buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 5, 0, 0), 5)) - .flatMap(List::stream) - .collect(Collectors.toList()); - diagnosisKeyBundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 6, 0, 0)); - DateIndexingDecorator decorator = makeDecoratedDateDirectory(diagnosisKeyBundler); - decorator.prepare(new ImmutableStack<>().push("DE")); - - Set<LocalDate> index = decorator.getIndex(new ImmutableStack<>()); - - assertThat(index).contains(LocalDate.of(1970, 1, 3)) - .doesNotContain(LocalDate.of(1970, 1, 4)) - .contains(LocalDate.of(1970, 1, 5)); - } @Test void excludesCurrentDateFromIndex() { @@ -112,7 +94,7 @@ void excludesDatesThatExceedTheMaximumNumberOfKeys() { when(svcConfig.getMaximumNumberOfKeysPerBundle()).thenReturn(1); DiagnosisKeyBundler diagnosisKeyBundler = new ProdDiagnosisKeyBundler(svcConfig); - diagnosisKeyBundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); + diagnosisKeyBundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 4, 0, 0)); DateIndexingDecorator decorator = makeDecoratedDateDirectory(diagnosisKeyBundler); diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/HourIndexingDecoratorTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/HourIndexingDecoratorTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/HourIndexingDecoratorTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/assembly/diagnosiskeys/structure/directory/decorator/HourIndexingDecoratorTest.java @@ -73,7 +73,7 @@ void tearDown() { } @Test - void excludesHoursThatExceedTheMaximumNumberOfKeys() { + void excludesHoursThatExceedTheMaximumNumberOfKeysPerBundle() { List<DiagnosisKey> diagnosisKeys = buildDiagnosisKeys(6, LocalDateTime.of(1970, 1, 3, 4, 0), 2); TimeUtils.setNow(LocalDateTime.of(1970, 1, 3, 0, 0).toInstant(ZoneOffset.UTC)); @@ -84,7 +84,7 @@ void excludesHoursThatExceedTheMaximumNumberOfKeys() { when(svcConfig.getMaximumNumberOfKeysPerBundle()).thenReturn(1); DiagnosisKeyBundler diagnosisKeyBundler = new ProdDiagnosisKeyBundler(svcConfig); - diagnosisKeyBundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 5, 0, 0)); + diagnosisKeyBundler.setDiagnosisKeys(diagnosisKeys, LocalDateTime.of(1970, 1, 3, 5, 0)); HourIndexingDecorator decorator = makeDecoratedHourDirectory(diagnosisKeyBundler); diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/common/DiagnosisTestData.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/common/DiagnosisTestData.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/common/DiagnosisTestData.java @@ -0,0 +1,87 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.common; + +import app.coronawarn.server.common.persistence.domain.DiagnosisKey; +import java.time.LocalDate; +import java.time.LocalDateTime; +import java.time.ZoneOffset; +import java.time.temporal.ChronoUnit; +import java.util.List; +import java.util.Random; +import java.util.stream.Collectors; +import java.util.stream.IntStream; + +/** + * A simple container class able to create diagnosis keys test data, given a set of days or day intervals expresed in + * <code>java.time.*</code> structures. + */ +public final class DiagnosisTestData { + + private List<DiagnosisKey> diagnosisKeys; + + private DiagnosisTestData() { + } + + public List<DiagnosisKey> getDiagnosisKeys() { + return diagnosisKeys; + } + + /** + * @return An instance that contains diagnosis keys computed for the given interval of days. Each day will have a + * number of keys equal to the given <code>casesPerDay</code> parameter, recorded, for simplicity, in the last hour of + * the day. + */ + public static DiagnosisTestData of(LocalDate fromDay, LocalDate untilDay, int casesPerDay) { + + int numberOfDays = (int) ChronoUnit.DAYS.between(fromDay, untilDay) + 1; + DiagnosisTestData testData = new DiagnosisTestData(); + + testData.diagnosisKeys = computeDiagnosisKeys(testData, fromDay, numberOfDays, casesPerDay); + return testData; + } + + private static List<DiagnosisKey> computeDiagnosisKeys(DiagnosisTestData testData, LocalDate fromDay, + int numberOFDays, int casesPerDay) { + return IntStream.range(0, numberOFDays) + .mapToObj(day -> + randomDiagnosisKeys(fromDay.atStartOfDay().plusDays(day).plusHours(23), casesPerDay) + ).flatMap(List::stream).collect(Collectors.toList()); + } + + private static List<DiagnosisKey> randomDiagnosisKeys(LocalDateTime submissionTime, int casesPerDay) { + long timestamp = submissionTime.toEpochSecond(ZoneOffset.UTC) / 3600; + return IntStream.range(0, casesPerDay) + .mapToObj(dayCounter -> + DiagnosisKey.builder().withKeyData(randomKeyData()) + .withRollingStartIntervalNumber(600) + .withTransmissionRiskLevel(5).withSubmissionTimestamp(timestamp) + .build()) + .collect(Collectors.toList()); + } + + private static byte[] randomKeyData() { + byte[] exposureKeys = new byte[16]; + Random random = new Random(); + random.nextBytes(exposureKeys); + return exposureKeys; + } +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherTest.java @@ -126,15 +126,6 @@ void uploadOneDueToOneChanged() throws IOException { verify(objectStoreAccess, times(1)).putObject(any()); } - @Test - void uploadAllDueToError() throws IOException { - when(objectStoreAccess.getObjectsWithPrefix("version")).thenThrow(new ObjectStoreOperationFailedException("")); - - s3Publisher.publish(publishingPath); - - verify(objectStoreAccess, times(3)).putObject(any()); - } - @Test void executorGetsShutDown() throws IOException { when(objectStoreAccess.getObjectsWithPrefix("version")).thenReturn(emptyList()); diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapperTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapperTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapperTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/client/S3ClientWrapperTest.java @@ -48,6 +48,7 @@ import org.junit.jupiter.params.provider.ValueSource; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Value; +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.boot.test.context.ConfigFileApplicationContextInitializer; import org.springframework.boot.test.mock.mockito.MockBean; @@ -98,7 +99,8 @@ class S3ClientWrapperTest { public static class RetryS3ClientConfig { @Bean - public ObjectStoreClient createS3ClientWrapper(S3Client s3Client) { + @ConditionalOnMissingBean + public ObjectStoreClient createObjectStoreClient(S3Client s3Client) { return new S3ClientWrapper(s3Client); } } @@ -215,7 +217,7 @@ void testPutObjectForNoHeaders() { @Test void testPutObjectForContentTypeHeader() { String contentType = "foo-content-type"; - s3ClientWrapper.putObject(VALID_BUCKET_NAME, VALID_NAME, Path.of(""), + s3ClientWrapper.putObject(VALID_BUCKET_NAME, VALID_NAME, Path.of(""), newHashMap(HeaderKey.CONTENT_TYPE, contentType)); PutObjectRequest expRequest = diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccessIT.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/integration/ObjectStoreAccessIT.java similarity index 96% rename from services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccessIT.java rename to services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/integration/ObjectStoreAccessIT.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/ObjectStoreAccessIT.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/integration/ObjectStoreAccessIT.java @@ -18,13 +18,14 @@ * ---license-end */ -package app.coronawarn.server.services.distribution.objectstore; +package app.coronawarn.server.services.distribution.objectstore.integration; import static org.assertj.core.api.Assertions.assertThat; import static org.mockito.Mockito.spy; import static org.mockito.Mockito.when; import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import app.coronawarn.server.services.distribution.objectstore.ObjectStoreAccess; import app.coronawarn.server.services.distribution.objectstore.client.ObjectStorePublishingConfig; import app.coronawarn.server.services.distribution.objectstore.client.S3Object; import app.coronawarn.server.services.distribution.objectstore.publish.LocalFile; diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/integration/ObjectStoreFilePreservationIT.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/integration/ObjectStoreFilePreservationIT.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/integration/ObjectStoreFilePreservationIT.java @@ -0,0 +1,214 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.objectstore.integration; + +import java.io.File; +import java.io.IOException; +import java.time.LocalDate; +import java.time.Month; +import java.time.temporal.ChronoUnit; +import java.util.List; +import java.util.Map; +import java.util.stream.Collectors; + +import org.junit.Rule; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Tag; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.junit.rules.TemporaryFolder; +import org.mockito.Mockito; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.ConfigFileApplicationContextInitializer; +import org.springframework.boot.test.mock.mockito.MockBean; +import org.springframework.context.ApplicationContext; +import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor; +import org.springframework.test.annotation.DirtiesContext; +import org.springframework.test.context.ActiveProfiles; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit.jupiter.SpringExtension; + +import app.coronawarn.server.common.persistence.service.DiagnosisKeyService; +import app.coronawarn.server.services.distribution.Application; +import app.coronawarn.server.services.distribution.assembly.component.OutputDirectoryProvider; +import app.coronawarn.server.services.distribution.assembly.structure.directory.DirectoryOnDisk; +import app.coronawarn.server.services.distribution.common.DiagnosisTestData; +import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import app.coronawarn.server.services.distribution.objectstore.FailedObjectStoreOperationsCounter; +import app.coronawarn.server.services.distribution.objectstore.ObjectStoreAccess; +import app.coronawarn.server.services.distribution.objectstore.S3Publisher; +import app.coronawarn.server.services.distribution.objectstore.S3RetentionPolicy; +import app.coronawarn.server.services.distribution.objectstore.client.S3Object; +import app.coronawarn.server.services.distribution.runner.Assembly; +import app.coronawarn.server.services.distribution.runner.RetentionPolicy; + +@ExtendWith(SpringExtension.class) +@ContextConfiguration(classes = Application.class, initializers = ConfigFileApplicationContextInitializer.class) +@DirtiesContext +@ActiveProfiles("integration-test") +@Tag("s3-integration") +class ObjectStoreFilePreservationIT { + + @Autowired + private DiagnosisKeyService diagnosisKeyService; + @Autowired + private Assembly fileAssembler; + @Autowired + private ApplicationContext applicationContext; + @Autowired + private S3RetentionPolicy s3RetentionPolicy; + @Autowired + private ObjectStoreAccess objectStoreAccess; + @Autowired + private DistributionServiceConfig distributionServiceConfig; + + @MockBean + private OutputDirectoryProvider distributionDirectoryProvider; + + @Rule + private TemporaryFolder testOutputFolder = new TemporaryFolder(); + + + @BeforeEach + public void setup() throws IOException { + testOutputFolder.create(); + objectStoreAccess.deleteObjectsWithPrefix(distributionServiceConfig.getApi().getVersionPath()); + } + + /** + * The test covers a behaviour that manifests itself when data retention and shifting policies cause the file + * distribution logic to generate, in subsequent runs, different content for the same timeframes. Below the + * distribution problem is described with a concerete daily scenario. + * <p> + * The test presumes there are 4 consecutive days with 80 keys submitted daily. Running a distribution in Day 4 would + * result in: + * <p> + * Day 1 -> submission of 80 keys -> 1 empty file distributed<br> + * Day 2 -> submission of 80 keys -> 1 distributed containing 160 keys<br> + * Day 3 -> submission of 80 keys -> 1 empty file distributed<br> + * Day 4 -> submission of 80 keys -> 1 distributed containing 160 keys<br> + * <p> + * All day & hour files already generated should not be changed/removed from S3 even after retention policies have + * been applied and a second distribution is triggered. + * <p> + * If for example, data in Day 1 gets removed completely, then a second distribution run causes a shifting of keys in + * different files compared to the previous run, the result being: + * <p> + * Day 2 -> submission of 80 keys -> 1 empty file generated (different than what is currently on S3)<br> + * Day 3 -> submission of 80 keys -> 1 distributed containing 160 keys (different than 1 empty file on S3)<br> + * Day 4 -> submission of 80 keys -> 1 empty file (different than 1 empty file on S3)<br> + */ + @Test + void files_once_published_to_objectstore_should_not_be_overriden_because_of_retention_or_shifting_policies() + throws IOException { + + // keep data in the past for this test + LocalDate testStartDate = LocalDate.now().minusDays(10); + LocalDate testEndDate = LocalDate.now().minusDays(6); + + // setup the 80 keys per day scenario + createDiagnosisKeyTestData(testStartDate, testEndDate, 80); + + assembleAndDistribute(testOutputFolder.newFolder("output-before-retention")); + List<S3Object> filesBeforeRetention = getPublishedFiles(); + + triggerRetentionPolicy(testStartDate); + + // Trigger second distrubution after data retention policies were applied + assembleAndDistribute(testOutputFolder.newFolder("output-after-retention")); + List<S3Object> filesAfterRetention = getPublishedFiles(); + + assertPreviouslyPublishedKeyFilesAreTheSame(filesBeforeRetention, filesAfterRetention); + } + + private List<S3Object> getPublishedFiles() { + return objectStoreAccess.getObjectsWithPrefix(distributionServiceConfig.getApi().getVersionPath()); + } + + private void assertPreviouslyPublishedKeyFilesAreTheSame(List<S3Object> filesBeforeRetention, + List<S3Object> filesAfterRetention) { + + Map<String, S3Object> beforeRetentionFileMap = filesBeforeRetention + .stream() + .filter(S3Object::isDiagnosisKeyFile) + .collect(Collectors.toMap(S3Object::getObjectName, s3object -> s3object)); + + filesAfterRetention + .stream() + .filter(S3Object::isDiagnosisKeyFile) + .forEach(secondVersion -> { + S3Object previouslyPublished = beforeRetentionFileMap.get(secondVersion.getObjectName()); + + if (filesAreDifferent(previouslyPublished, secondVersion)) { + throw new AssertionError("Files have been changed on object store " + + "due to retention policy. Before: " + previouslyPublished.getObjectName() + + "-" + previouslyPublished.getCwaHash() + + "| After:" + secondVersion.getObjectName() + + "-" + secondVersion.getCwaHash()); + } + }); + } + + private boolean filesAreDifferent(S3Object previouslyPublished, S3Object newVerion) { + return previouslyPublished == null || + !newVerion.getCwaHash().equals(previouslyPublished.getCwaHash()); + } + + /** + * Remove test data inserted for the given date + */ + private void triggerRetentionPolicy(LocalDate fromDate) { + DistributionServiceConfig mockDistributionConfig = new DistributionServiceConfig(); + mockDistributionConfig.setRetentionDays(numberOfDaysSince(fromDate)); + new RetentionPolicy(diagnosisKeyService, applicationContext, mockDistributionConfig, + s3RetentionPolicy).run(null); + } + + private Integer numberOfDaysSince(LocalDate testStartDate) { + return (int) ChronoUnit.DAYS.between(testStartDate, LocalDate.now()) - 1; + } + + private void createDiagnosisKeyTestData(LocalDate fromDay, LocalDate untilDay, int casesPerDay) { + DiagnosisTestData testData = DiagnosisTestData.of(fromDay, untilDay, casesPerDay); + diagnosisKeyService.saveDiagnosisKeys(testData.getDiagnosisKeys()); + } + + private void assembleAndDistribute(File output) throws IOException { + Mockito.when(distributionDirectoryProvider.getDirectory()).thenReturn(new DirectoryOnDisk(output)); + Mockito.when(distributionDirectoryProvider.getFileOnDisk()).thenReturn(output); + + fileAssembler.run(null); + + S3Publisher s3Publisher = new S3Publisher(objectStoreAccess, + new FailedObjectStoreOperationsCounter(distributionServiceConfig), + newAsyncExecutor(), distributionServiceConfig); + s3Publisher.publish(distributionDirectoryProvider.getFileOnDisk().toPath().toAbsolutePath()); + } + + private ThreadPoolTaskExecutor newAsyncExecutor() { + ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor(); + executor.setCorePoolSize(8); + executor.setMaxPoolSize(8); + executor.setQueueCapacity(11); + executor.initialize(); + return executor; + } +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherIT.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/integration/S3PublisherIT.java similarity index 89% rename from services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherIT.java rename to services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/integration/S3PublisherIT.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/S3PublisherIT.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/integration/S3PublisherIT.java @@ -18,11 +18,14 @@ * ---license-end */ -package app.coronawarn.server.services.distribution.objectstore; +package app.coronawarn.server.services.distribution.objectstore.integration; import static org.assertj.core.api.Assertions.assertThat; import app.coronawarn.server.services.distribution.config.DistributionServiceConfig; +import app.coronawarn.server.services.distribution.objectstore.FailedObjectStoreOperationsCounter; +import app.coronawarn.server.services.distribution.objectstore.ObjectStoreAccess; +import app.coronawarn.server.services.distribution.objectstore.S3Publisher; import app.coronawarn.server.services.distribution.objectstore.client.ObjectStorePublishingConfig; import app.coronawarn.server.services.distribution.objectstore.client.S3Object; import java.io.IOException; diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/publish/LocalFileTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/publish/LocalFileTest.java --- a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/publish/LocalFileTest.java +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/publish/LocalFileTest.java @@ -20,6 +20,8 @@ package app.coronawarn.server.services.distribution.objectstore.publish; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; import static org.junit.jupiter.api.Assertions.assertEquals; import java.nio.file.Path; @@ -48,4 +50,26 @@ void testGetContentTypeZip(String path) { LocalFile test = new LocalIndexFile(Path.of("/root", path, "/index"), Path.of("/root")); assertEquals("application/zip", test.getContentType()); } + + @ParameterizedTest + @ValueSource(strings = { + "version/v1/diagnosis-keys/country/DE/date/2020-06-11", + "version/v1/diagnosis-keys/country/DE/date/2020-06-11/hour/13" }) + void testIsKeyFile(String path) { + LocalFile test = new LocalIndexFile(Path.of("/root", path, "/index"), Path.of("/root")); + assertTrue(test.isKeyFile()); + } + + @ParameterizedTest + @ValueSource(strings = { + "version", + "version/v1/configuration/country", + "version/v1/configuration/country/DE/app_config", + "version/v1/diagnosis-keys/country", + "version/v1/diagnosis-keys/country/DE/date", + "version/v1/diagnosis-keys/country/DE/date/2020-06-11/hour" }) + void testIsNotKeyFile(String path) { + LocalFile test = new LocalIndexFile(Path.of("/root", path, "/index"), Path.of("/root")); + assertFalse(test.isKeyFile()); + } } diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/publish/PublishedFileSetTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/publish/PublishedFileSetTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/publish/PublishedFileSetTest.java @@ -0,0 +1,72 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.objectstore.publish; + +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; + +import java.nio.file.Path; +import java.util.Collections; +import java.util.List; + +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.ValueSource; + +import app.coronawarn.server.services.distribution.objectstore.client.S3Object; + +class PublishedFileSetTest { + + @ParameterizedTest + @ValueSource(strings = { + "version/v1/diagnosis-keys/country/DE/date/2020-01-01", + "version/v1/diagnosis-keys/country/DE/date/2020-06-11/hour/0", + "version/v1/diagnosis-keys/country/DE/date/2020-06-11/hour/23"}) + void testShouldNotPublishWithoutForceUpdateConfiguration(String key) { + List<S3Object> s3Objects = List.of(new S3Object(key, "1234")); + PublishedFileSet publishedSet = new PublishedFileSet(s3Objects, false); + LocalFile testFile = new LocalIndexFile(Path.of("/root", key, "/index"), Path.of("/root")); + assertFalse(publishedSet.shouldPublish(testFile)); + } + + @ParameterizedTest + @ValueSource(strings = { + "version/v1/diagnosis-keys/country/DE/date/2020-01-01", + "version/v1/diagnosis-keys/country/DE/date/2020-06-11/hour/0", + "version/v1/diagnosis-keys/country/DE/date/2020-06-11/hour/23"}) + void testShouldPublishWithForceUpdateConfiguration(String key) { + List<S3Object> s3Objects = List.of(new S3Object(key, "1234")); + PublishedFileSet publishedSet = new PublishedFileSet(s3Objects, true); + LocalFile testFile = new LocalIndexFile(Path.of("/root", key, "/index"), Path.of("/root")); + assertTrue(publishedSet.shouldPublish(testFile)); + } + + @ParameterizedTest + @ValueSource(strings = { + "version/v1/diagnosis-keys/country/DE/date/2020-01-01", + "version/v1/diagnosis-keys/country/DE/date/2020-06-11/hour/0", + "version/v1/diagnosis-keys/country/DE/date/2020-06-11/hour/23"}) + void testShouldPublishWhenObjectStoreEmpty(String key) { + PublishedFileSet publishedSet = new PublishedFileSet(Collections.emptyList(), false); + LocalFile testFile = new LocalIndexFile(Path.of("/root", key, "/index"), Path.of("/root")); + assertTrue(publishedSet.shouldPublish(testFile)); + } + +} diff --git a/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/publish/S3ObjectTest.java b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/publish/S3ObjectTest.java new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/java/app/coronawarn/server/services/distribution/objectstore/publish/S3ObjectTest.java @@ -0,0 +1,52 @@ +/*- + * ---license-start + * Corona-Warn-App + * --- + * Copyright (C) 2020 SAP SE and all other contributors + * --- + * 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 + * + * http://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. + * ---license-end + */ + +package app.coronawarn.server.services.distribution.objectstore.publish; + +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; + +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.ValueSource; + +import app.coronawarn.server.services.distribution.objectstore.client.S3Object; + +class S3ObjectTest { + + @ParameterizedTest + @ValueSource(strings = { + "version/v1/diagnosis-keys/country/DE/date/2020-06-11", + "version/v1/diagnosis-keys/country/DE/date/2020-06-11/hour/13" }) + void testIsKeyFile(String key) { + S3Object test = new S3Object(key); + assertTrue(test.isDiagnosisKeyFile()); + } + + @ParameterizedTest + @ValueSource(strings = { + "version/v1/configuration/country/DE/app_config", + "version/v1/configuration/country", + "version/v1/diagnosis-keys/country/DE/date", + "version/v1/diagnosis-keys/country/DE/date/2020-06-11/hour" }) + void testIsNotKeyFile(String key) { + S3Object test = new S3Object(key); + assertFalse(test.isDiagnosisKeyFile()); + } +} diff --git a/services/distribution/src/test/resources/application-integration-test.yaml b/services/distribution/src/test/resources/application-integration-test.yaml new file mode 100644 --- /dev/null +++ b/services/distribution/src/test/resources/application-integration-test.yaml @@ -0,0 +1,4 @@ +--- +services: + distribution: + shifting-policy-threshold: 140 diff --git a/services/distribution/src/test/resources/application.yaml b/services/distribution/src/test/resources/application.yaml --- a/services/distribution/src/test/resources/application.yaml +++ b/services/distribution/src/test/resources/application.yaml @@ -51,6 +51,7 @@ services: retry-backoff: 1 max-number-of-failed-operations: 5 max-number-of-s3-threads: 2 + force-update-keyfiles: ${FORCE_UPDATE_KEYFILES:false} spring: main: banner-mode: off

Wrong hash value for 2020-06-23 and 2020-06-24 <!-- Thanks for proposing an enhancement 🙌 ❤️ Before opening a new issue, please make sure that we do not have any duplicates already open. You can ensure this by searching the issue list for this repository. If there is a duplicate, please close your issue and add a comment to the existing issue instead. --> ## Current Implementation <!-- Describe or point to the current implementation that you would like to see improved --> Old keys are deleted and the remaining keys are repacked by day or by hour. 60 keys moved from 24.06.2020 to 23.06.2020. 44 keys are deleted from 23.06.2020 The hour files 2020-06-23-hour-08.zip, 2020-06-23-hour-13.zip, 2020-06-23-hour-17.zip are repacked to 2020-06-23-hour-10.zip, 2020-06-23-hour-15.zip, 2020-06-23-hour-18.zip (Even the old hour files are superseded they are still on the server.) ## Suggested Enhancement <!-- Outline the idea of your enhancement, by e.g., describing the algorithm you propose. You can also create a Pull Request to outline your idea --> Leave the files as they are, do not remove old keys. ## Expected Benefits <!-- Summarize how your enhancement could aid the implementation (performance, readability, memory consumption, battery consumption, etc.). Please also back up with measurements or give detailed explanations for reduced runtimes, memory consumption, etc. --> The files downloaded by the app have the same hash value as the file on the server.

Initial suspicion: Retention Policy kicked in and deleted older keys, which were not immediately distributed due to shifting policy. This in turn did lead to even less keys for the first days of CWA so the other packages were now also shifted. <del>I believe this only affects hourly packages as retention enforcement & daily package creation are part of the same job. </del> <del> There are some options on how this can be fixed:</del> 1. <del>(Temporary) Disable hourly files. As they are currently not being used by the mobile app, there would be no impact.</del> 2. <del>Run retention only once per day and not on every job. Can be problematic in case this one job did not trigger or failed, so the next retention run would only occur after 24 hours. Not a big issue though.</del> 3. Store some pointer/information on the database which indicates which keys were already distributed. There are some edge cases which make this approach more complicated though (e.g. shifting keys due to 2 hours key validity expiration). Edit: Daily files are just as affected as hourly files. Guess this leaves only one option. @pithumke what do you think? Today 2020-06-24.zip on the server has the same values and hash as it was first publish (so the 60 moved keys moved back). 2020-06-23.zip does not contain 173 keys of the original file. But this time, on IOS, the file has been downloaded again, why?? The hash and the # of keys are the same in IOS and on the server (330 keys now). All keys publish in 2020-06-23-hour-08.zip are missing in the daily file 2020-06-23.zip, now. Is this expected?

corona-warn-app/cwa-server

corona-warn-app__cwa-server-783

3b67b75657b26418691e024e049af7f3494c787b

diff --git a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKey.java b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKey.java --- a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKey.java +++ b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/domain/DiagnosisKey.java @@ -77,7 +77,7 @@ public class DiagnosisKey { private final boolean consentToFederation; - @Size(max = 2) + @Size(max = 2, message = "Origin country code must have length of 2.") private final String originCountry; @ValidCountries diff --git a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/repository/DiagnosisKeyRepository.java b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/repository/DiagnosisKeyRepository.java --- a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/repository/DiagnosisKeyRepository.java +++ b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/repository/DiagnosisKeyRepository.java @@ -62,6 +62,7 @@ public interface DiagnosisKeyRepository extends PagingAndSortingRepository<Diagn * @param originCountry The origin country from the app. * @param visitedCountries The list of countries this transmissions is relevant for. * @param reportType The report type of the diagnosis key. + * @return {@literal true} if the diagnosis key was inserted successfully, {@literal false} otherwise. */ @Modifying @Query("INSERT INTO diagnosis_key " @@ -70,7 +71,7 @@ public interface DiagnosisKeyRepository extends PagingAndSortingRepository<Diagn + "VALUES (:keyData, :rollingStartIntervalNumber, :rollingPeriod, :submissionTimestamp, :transmissionRisk, " + ":origin_country, :visited_countries, :report_type, :days_since_onset_of_symptoms, :consent_to_federation) " + "ON CONFLICT DO NOTHING") - void saveDoNothingOnConflict( + boolean saveDoNothingOnConflict( @Param("keyData") byte[] keyData, @Param("rollingStartIntervalNumber") int rollingStartIntervalNumber, @Param("rollingPeriod") int rollingPeriod, diff --git a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyService.java b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyService.java --- a/common/persistence/src/main/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyService.java +++ b/common/persistence/src/main/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyService.java @@ -53,23 +53,39 @@ public DiagnosisKeyService(DiagnosisKeyRepository keyRepository, ValidDiagnosisK } /** - * Persists the specified collection of {@link DiagnosisKey} instances. If the key data of a particular diagnosis key - * already exists in the database, this diagnosis key is not persisted. + * Persists the specified collection of {@link DiagnosisKey} instances and returns the number of inserted diagnosis + * keys. If the key data of a particular diagnosis key already exists in the database, this diagnosis key is not + * persisted. * * @param diagnosisKeys must not contain {@literal null}. + * @return Number of successfully inserted diagnosis keys. * @throws IllegalArgumentException in case the given collection contains {@literal null}. */ @Timed @Transactional - public void saveDiagnosisKeys(Collection<DiagnosisKey> diagnosisKeys) { + public int saveDiagnosisKeys(Collection<DiagnosisKey> diagnosisKeys) { + int numberOfInsertedKeys = 0; + for (DiagnosisKey diagnosisKey : diagnosisKeys) { - keyRepository.saveDoNothingOnConflict( + boolean keyInsertedSuccessfully = keyRepository.saveDoNothingOnConflict( diagnosisKey.getKeyData(), diagnosisKey.getRollingStartIntervalNumber(), diagnosisKey.getRollingPeriod(), diagnosisKey.getSubmissionTimestamp(), diagnosisKey.getTransmissionRiskLevel(), diagnosisKey.getOriginCountry(), diagnosisKey.getVisitedCountries().toArray(new String[0]), diagnosisKey.getReportType().name(), diagnosisKey.getDaysSinceOnsetOfSymptoms(), diagnosisKey.isConsentToFederation()); + + if (keyInsertedSuccessfully) { + numberOfInsertedKeys++; + } } + + int conflictingKeys = diagnosisKeys.size() - numberOfInsertedKeys; + if (conflictingKeys > 0) { + logger.warn("{} out of {} diagnosis keys conflicted with existing database entries and were ignored.", + conflictingKeys, diagnosisKeys.size()); + } + + return numberOfInsertedKeys; } /** diff --git a/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/SubmissionController.java b/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/SubmissionController.java --- a/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/SubmissionController.java +++ b/services/submission/src/main/java/app/coronawarn/server/services/submission/controller/SubmissionController.java @@ -138,7 +138,7 @@ private List<DiagnosisKey> extractValidDiagnosisKeysFromPayload(SubmissionPayloa if (diagnosisKey.isYoungerThanRetentionThreshold(retentionDays)) { diagnosisKeys.add(diagnosisKey); } else { - logger.info("Not persisting a diagnosis key, as it is outdated beyond retention threshold."); + logger.warn("Not persisting a diagnosis key, as it is outdated beyond retention threshold."); } }

diff --git a/common/persistence/src/test/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyServiceTest.java b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyServiceTest.java --- a/common/persistence/src/test/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyServiceTest.java +++ b/common/persistence/src/test/java/app/coronawarn/server/common/persistence/service/DiagnosisKeyServiceTest.java @@ -155,10 +155,22 @@ void shouldNotUpdateExistingKey() { .withReportType(ReportType.CONFIRMED_CLINICAL_DIAGNOSIS) .build()); - diagnosisKeyService.saveDiagnosisKeys(keys); + int actNumberOfInsertedRows = diagnosisKeyService.saveDiagnosisKeys(keys); var actKeys = diagnosisKeyService.getDiagnosisKeys(); + assertThat(actNumberOfInsertedRows).isEqualTo(1); assertThat(actKeys).hasSize(1); assertThat(actKeys.iterator().next().getTransmissionRiskLevel()).isEqualTo(2); } + + @Test + void testReturnedNumberOfInsertedKeysForNoConflict() { + var keys = list( + buildDiagnosisKeyForSubmissionTimestamp(1L), + buildDiagnosisKeyForSubmissionTimestamp(0L)); + + int actNumberOfInsertedRows = diagnosisKeyService.saveDiagnosisKeys(keys); + + assertThat(actNumberOfInsertedRows).isEqualTo(2); + } }

Improve logging of the submission validation process <!-- Thanks for proposing an enhancement 🙌 ❤️ Before opening a new issue, please make sure that we do not have any duplicates already open. You can ensure this by searching the issue list for this repository. If there is a duplicate, please close your issue and add a comment to the existing issue instead. --> The enhancement suggested by @Tho-Mat, and based on the discussion in https://github.com/corona-warn-app/cwa-server/issues/723 ## Current Implementation Issue https://github.com/corona-warn-app/cwa-server/issues/723, demonstrated that currently implemented logging is not sufficient for effective troubleshooting of the submission validation process. ## Suggested Enhancement If the kay can not be saved in a DB (e.g. because it is already in database / Date to high / Date to low / unknown), we log this fact, date of the issue and the reason in the application logs. ## Expected Benefits This would have the great advantage of better analyzing certain constellations that can lead to errors.

corona-warn-app/cwa-server

corona-warn-app__cwa-server-972

e3f867a8005bd7f79c9eabe269d168fc01330484

diff --git a/services/download/src/main/java/app/coronawarn/server/services/download/FederationBatchProcessor.java b/services/download/src/main/java/app/coronawarn/server/services/download/FederationBatchProcessor.java --- a/services/download/src/main/java/app/coronawarn/server/services/download/FederationBatchProcessor.java +++ b/services/download/src/main/java/app/coronawarn/server/services/download/FederationBatchProcessor.java @@ -22,9 +22,11 @@ import java.time.Period; import java.time.ZoneOffset; import java.util.Deque; +import java.util.HashSet; import java.util.LinkedList; import java.util.List; import java.util.Optional; +import java.util.Set; import java.util.concurrent.atomic.AtomicBoolean; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -42,6 +44,12 @@ public class FederationBatchProcessor { private final FederationGatewayDownloadService federationGatewayDownloadService; private final DownloadServiceConfig config; private final ValidFederationKeyFilter validFederationKeyFilter; + + // This is a potential memory-leak if there are very many batches + // This is an intentional decision: + // We'd rather run into a memory-leak if there are too many batches + // than run into an endless loop if a batch-tag repeats + private final Set<String> seenBatches; /** * Constructor. @@ -63,6 +71,7 @@ public FederationBatchProcessor(FederationBatchInfoService batchInfoService, this.federationGatewayDownloadService = federationGatewayDownloadService; this.config = config; this.validFederationKeyFilter = federationKeyValidator; + this.seenBatches = new HashSet<>(); } /** @@ -129,16 +138,21 @@ public void processUnprocessedFederationBatches() throws FatalFederationGatewayE logger.info("{} unprocessed federation batches found.", unprocessedBatches.size()); while (!unprocessedBatches.isEmpty()) { - FederationBatchInfo currentBatch = unprocessedBatches.remove(); - processBatchAndReturnNextBatchId(currentBatch, ERROR) + FederationBatchInfo currentBatchInfo = unprocessedBatches.remove(); + seenBatches.add(currentBatchInfo.getBatchTag()); + processBatchAndReturnNextBatchId(currentBatchInfo, ERROR) .ifPresent(nextBatchTag -> { - if (config.getEfgsEnforceDateBasedDownload()) { - unprocessedBatches.add(new FederationBatchInfo(nextBatchTag, currentBatch.getDate())); + if (isEfgsEnforceDateBasedDownloadAndNotSeen(nextBatchTag)) { + unprocessedBatches.add(new FederationBatchInfo(nextBatchTag, currentBatchInfo.getDate())); } }); } } + private boolean isEfgsEnforceDateBasedDownloadAndNotSeen(String batchTag) { + return config.getEfgsEnforceDateBasedDownload() && !seenBatches.contains(batchTag); + } + private Optional<String> processBatchAndReturnNextBatchId( FederationBatchInfo batchInfo, FederationBatchStatus errorStatus) throws FatalFederationGatewayException { LocalDate date = batchInfo.getDate();

diff --git a/services/download/src/test/java/app/coronawarn/server/services/download/FederationBatchProcessorTest.java b/services/download/src/test/java/app/coronawarn/server/services/download/FederationBatchProcessorTest.java --- a/services/download/src/test/java/app/coronawarn/server/services/download/FederationBatchProcessorTest.java +++ b/services/download/src/test/java/app/coronawarn/server/services/download/FederationBatchProcessorTest.java @@ -32,12 +32,14 @@ import app.coronawarn.server.services.download.validation.ValidFederationKeyFilter; import com.google.protobuf.ByteString; import feign.FeignException; +import java.time.Duration; import java.time.LocalDate; import java.time.Period; import java.time.ZoneOffset; import java.util.List; import java.util.Optional; import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.DisplayName; import org.junit.jupiter.api.Nested; @@ -226,6 +228,23 @@ void testOneUnprocessedBatchFails() throws Exception { Mockito.verify(batchInfoService, times(1)).updateStatus(any(FederationBatchInfo.class), eq(ERROR)); Mockito.verify(diagnosisKeyService, never()).saveDiagnosisKeys(any()); } + + @Test + void testNoInfiniteLoopSameBatchTag() throws FatalFederationGatewayException { + config.setEfgsEnforceDateBasedDownload(true); + FederationBatchInfo batchInfo = new FederationBatchInfo(batchTag1, date, UNPROCESSED); + BatchDownloadResponse serverResponse = FederationBatchTestHelper + .createBatchDownloadResponse(batchTag1, Optional.of(batchTag1)); + + when(batchInfoService.findByStatus(UNPROCESSED)).thenReturn(list(batchInfo)); + when(federationGatewayDownloadService.downloadBatch(batchTag1, date)).thenReturn(serverResponse); + + Assertions + .assertTimeoutPreemptively(Duration.ofSeconds(1), () -> batchProcessor.processUnprocessedFederationBatches()); + Mockito.verify(batchInfoService, times(1)).findByStatus(UNPROCESSED); + Mockito.verify(federationGatewayDownloadService, times(1)).downloadBatch(batchTag1, date); + Mockito.verify(batchInfoService, times(1)).updateStatus(batchInfo, PROCESSED); + } } @Nested

[BSI][20201107] Denial-of-Service in Download Service Rating: Informational Description: The download service component of the cwa-server backend can be forced into an endless loop by a malicious or faulty federation gateway server. When downloading new batches from the federation gateway server, the download service checks the nextBatchTag header of the federation gateway server’s response. If this header is set, the download service will continue requesting a batch with this tag. It will not stop as long as the server includes this header. This can trap the download service in an endless loop. This highly depends on the behavior and implementation of the federation gateway server. However, even a non-malicious, faulty implementation might trigger this issue. Additionally, the issue was sometimes hard to reproduce as the server first has to be forced to request new batches (which in some cases required setting the EFGS_ENABLE_DATE_BASED_DOWNLOAD configuration to true). Affected System: cwa-server (commit 4f3f460f580ea5d548dff0e3ceb739908c83d1a7) Proof of Concept: The following screenshots show the offending lines in the FederationBatchProcessor.java: <img width="846" alt="Download Service DoS Offending Code" src="https://user-images.githubusercontent.com/65443025/98435998-dcd5f900-20d7-11eb-9f5e-3fb7f449ca58.png"> The following snippets show a minimalistic federation gateway server mock that returns invalid data but sets the nextBatchTag header on each response. The first request needs to fail (in this case implemented by sending an invalid HTTP request body) so that the batch tag is added to the list of unprocessed batches. <img width="775" alt="snippet-1" src="https://user-images.githubusercontent.com/65443025/98436046-5c63c800-20d8-11eb-843e-47e98b9c2ed7.png"> <img width="779" alt="snippet-2" src="https://user-images.githubusercontent.com/65443025/98436048-61c11280-20d8-11eb-9d77-43ebd770a556.png"> The following screenshot shows the failing first request on the first run of the download service: <img width="824" alt="Download Service DoS First Invalid Request" src="https://user-images.githubusercontent.com/65443025/98436059-87e6b280-20d8-11eb-9ad0-7ceaaa557add.png"> The next screenshot shows the log output of the download service when it is run again. It can be seen that the server will endlessly try to request a next batch. <img width="845" alt="Download Service DoS Endless Loop Log" src="https://user-images.githubusercontent.com/65443025/98436074-ab116200-20d8-11eb-8c3c-ac545d9c1b07.png"> Recommended Controls: The while loop should be adapted so that it is not possible for it to continue forever. The received nextBatchTag header should be checked. If it is already contained in the list of unprocessed batches, it should not be added again. This does not protect against a malicious server that sends different batch tags on each request. Therefore, alternatively, a timeout value or a maximum number of retries could be introduced.

corona-warn-app/cwa-server

corona-warn-app__cwa-server-1965

f20af0764008b8ef07ba67c3b26693115035c43f

diff --git a/services/distribution/src/main/resources/application.yaml b/services/distribution/src/main/resources/application.yaml --- a/services/distribution/src/main/resources/application.yaml +++ b/services/distribution/src/main/resources/application.yaml @@ -140,11 +140,11 @@ services: app-versions: latest-ios: ${IOS_LATEST_VERSION:1.5.3} min-ios: ${IOS_MIN_VERSION:1.5.3} - latest-android: ${ANDROID_LATEST_VERSION:1.5.1} - min-android: ${ANDROID_MIN_VERSION:1.5.1} + latest-android: ${ANDROID_LATEST_VERSION:1.0.4} + min-android: ${ANDROID_MIN_VERSION:1.0.4} # With ENF v2 Android apps are versioned by Version Code and not by Semantic Versioning - min-android-version-code: ${ANDROID_MIN_VERSION_CODE:48} - latest-android-version-code: ${ANDROID_LATEST_VERSION_CODE:48} + min-android-version-code: ${ANDROID_MIN_VERSION_CODE:31} + latest-android-version-code: ${ANDROID_LATEST_VERSION_CODE:31} app-config-parameters: dgcParameters: testCertificateParameters:

diff --git a/services/distribution/src/test/resources/application-allow-list-invalid.yaml b/services/distribution/src/test/resources/application-allow-list-invalid.yaml --- a/services/distribution/src/test/resources/application-allow-list-invalid.yaml +++ b/services/distribution/src/test/resources/application-allow-list-invalid.yaml @@ -83,10 +83,10 @@ services: app-versions: latest-ios: ${IOS_LATEST_VERSION:1.5.3} min-ios: ${IOS_MIN_VERSION:1.5.3} - latest-android: ${ANDROID_LATEST_VERSION:1.5.1} - min-android: ${ANDROID_MIN_VERSION:1.5.1} - min-android-version-code: ${ANDROID_MIN_VERSION_CODE:48} - latest-android-version-code: ${ANDROID_LATEST_VERSION_CODE:48} + latest-android: ${ANDROID_LATEST_VERSION:1.0.4} + min-android: ${ANDROID_MIN_VERSION:1.0.4} + min-android-version-code: ${ANDROID_MIN_VERSION_CODE:31} + latest-android-version-code: ${ANDROID_LATEST_VERSION_CODE:31} app-config-parameters: dgcParameters: testCertificateParameters: diff --git a/services/distribution/src/test/resources/application.yaml b/services/distribution/src/test/resources/application.yaml --- a/services/distribution/src/test/resources/application.yaml +++ b/services/distribution/src/test/resources/application.yaml @@ -98,10 +98,10 @@ services: app-versions: latest-ios: ${IOS_LATEST_VERSION:1.5.3} min-ios: ${IOS_MIN_VERSION:1.5.3} - latest-android: ${ANDROID_LATEST_VERSION:1.5.1} - min-android: ${ANDROID_MIN_VERSION:1.5.1} - min-android-version-code: ${ANDROID_MIN_VERSION_CODE:48} - latest-android-version-code: ${ANDROID_LATEST_VERSION_CODE:48} + latest-android: ${ANDROID_LATEST_VERSION:1.0.4} + min-android: ${ANDROID_MIN_VERSION:1.0.4} + min-android-version-code: ${ANDROID_MIN_VERSION_CODE:31} + latest-android-version-code: ${ANDROID_LATEST_VERSION_CODE:31} app-config-parameters: dgcParameters: testCertificateParameters:

min-android 1.5.1 differs from production 1.0.4 value ## Describe the bug The `min-android` value served on https://svc90.main.px.t-online.de/version/v1/configuration/country/DE/app_config is `1.0.4` which differs from the value `1.5.1` stored in https://github.com/corona-warn-app/cwa-server/blob/main/services/distribution/src/main/resources/application.yaml#L144 If CWA Android 1.4.0 is started, there is no prompt shown to the user that the app should be updated. ## Expected behaviour The `min-android` value served on https://svc90.main.px.t-online.de/version/v1/configuration/country/DE/app_config should be the same as the value stored in https://github.com/corona-warn-app/cwa-server/blob/main/services/distribution/src/main/resources/application.yaml#L144 which is currently `1.5.1`. If `min-android` with the value of `1.5.1` were in production then starting CWA Android 1.4.0 should produce a prompt to update the app. ## Steps to reproduce the issue 1. In Android Studio check out CWA Android app release/1.4.x 2. Run CWA on Pixel 3a API 33 Android device emulator in Debug mode 3. Open Logcat in Android Studio and enter search term "UpdateChecker" The log shows the following: ``` UpdateChecker de.rki.coronawarnapp.dev E minVersionStringFromServer:1.0.4 UpdateChecker de.rki.coronawarnapp.dev E Current app version:1.4.0 UpdateChecker de.rki.coronawarnapp.dev E needs update:false ``` Alternatively install old released versions from https://www.apkmirror.com/apk/robert-koch-institut/corona-warn-app/. As soon as a version < 1.0.4 is started, e.g. 1.0.0 or 1.0.2, a message "Update available" is output.  If version 1.0.4 is installed and started, no update message is output. This is consistent with min-Android being set to `1.0.4` in production. ## Technical details - Android Studio Dolphin | 2021.3.1 Patch 1 - Pixel 3a API 33 Android device emulator - CWA Android 1.4.0 (note that this version was not released. Version 1.5 followed version 1.3) ## Possible Fix Clarify what the minimum enforced version of CWA Android in production is supposed to be and ensure alignment of https://github.com/corona-warn-app/cwa-server/blob/main/services/distribution/src/main/resources/application.yaml with the values used in production.

- FYI: I opened https://github.com/corona-warn-app/cwa-server/issues/1963 asking the team to check for other differences between this repositories `main` branch & the production environment. Also I would expect `min-android-version-code` / `minVersionCode=48` and not `31` to be served.