Merge pull request #251 from iExecBlockchainComputing/release/8.5.0

Release/8.5.0

Author: mcornaton

CHANGELOG.md

@@ -2,6 +2,42 @@
 
 All notable changes to this project will be documented in this file.
 
+## [[8.5.0]](https://github.com/iExecBlockchainComputing/iexec-sms/releases/tag/v8.5.0) 2024-02-29
+
+### New Features
+
+- Export metrics on TEE challenges and Ethereum Credentials counts. (#230)
+- Add a cache mechanism for secret existence. (#231)
+- Expose cache metrics and refactor cache implementation. (#238)
+- Set permissions to read-only on AES Key File. (#242)
+- Backup AES Key File with database backup. (#243)
+- Copy AES Key File on database copy. (#244)
+- Delete AES Key File on database delete. (#245)
+- Restore AES Key File on database restoration. (#246)
+- Create TEE session with worker IPFS storage token and fallback on requester token. (#248)
+
+### Bug Fixes
+
+- Validate authorization first when working on compute secrets. (#229)
+- Remove outdated empty log assertions in session tests. (#233)
+- Do not use `@Data` lombok annotations on entities. (#235)
+- Forbid access to sensitive APIs when no API key has been configured. (#249 #252)
+
+### Quality
+
+- Optimize chain calls in `AuthorizationService`. (#228)
+- Fix licence headers in some source files. (#232)
+- Move `EthereumCredentials` class to `com.iexec.sms.tee.challenge` package. (#234)
+- Use `@DataJpaTest` to run secrets and TEE challenges tests on H2 database. (#236 #237)
+- Insert secrets in a single SQL statement. (#238)
+- Remove unused method in `AuthorizationService`, update `AuthorizationServiceTests`. (#240)
+- Move `ApiKeyRequestFilter` class to `com.iexec.sms.admin` package. (#241)
+- Clean App compute secret endpoints on `AppComputeSecretController`. (#247)
+
+### Dependency Upgrades
+
+- Upgrade to `iexec-common` 8.4.0. (#250)
+
 ## [[8.4.0]](https://github.com/iExecBlockchainComputing/iexec-sms/releases/tag/v8.4.0) 2024-01-10
 
 ### New Features

build.gradle

@@ -88,6 +88,9 @@ dependencies {
     implementation "io.github.openfeign:feign-jackson:$openFeignVersion"
     implementation "io.github.openfeign:feign-slf4j:$openFeignVersion"
 
+    // expiring map
+    implementation "net.jodah:expiringmap:0.5.11"
+
     // test
     testImplementation 'org.springframework.boot:spring-boot-starter-test'
     testRuntimeOnly("org.junit.platform:junit-platform-launcher")

gradle.properties

@@ -1,5 +1,5 @@
-version=8.4.0
-iexecCommonVersion=8.3.1
+version=8.5.0
+iexecCommonVersion=8.4.0
 iexecCommonsPocoVersion=3.2.0
 
 nexusUser

iexec-sms-library/src/main/java/com/iexec/sms/api/SmsClient.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022-2023 IEXEC BLOCKCHAIN TECH
+ * Copyright 2022-2024 IEXEC BLOCKCHAIN TECH
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -36,8 +36,11 @@
  */
 public interface SmsClient {
 
+    // Define Application Developer secret index
+    static final String APP_DEVELOPER_SECRET_INDEX = "1";
+
     // region Secrets
-    @RequestLine("POST /apps/{appAddress}/secrets/1")
+    @RequestLine("POST /apps/{appAddress}/secrets")
     @Headers("Authorization: {authorization}")
     ApiResponseBody<String, List<String>> addAppDeveloperAppComputeSecret(
             @Param("authorization") String authorization,
@@ -46,12 +49,21 @@ ApiResponseBody<String, List<String>> addAppDeveloperAppComputeSecret(
             String secretValue
     );
 
+    /**
+     * @deprecated Call {@code isAppDeveloperAppComputeSecretPresent(appAddress)}
+     */
+    @Deprecated(forRemoval = true)
     @RequestLine("HEAD /apps/{appAddress}/secrets/{secretIndex}")
     ApiResponseBody<String, List<String>> isAppDeveloperAppComputeSecretPresent(
             @Param("appAddress") String appAddress,
             @Param("secretIndex") String secretIndex
     );
 
+    @RequestLine("HEAD /apps/{appAddress}/secrets")
+    ApiResponseBody<String, List<String>> isAppDeveloperAppComputeSecretPresent(
+            @Param("appAddress") String appAddress
+    );
+
     @RequestLine("POST /requesters/{requesterAddress}/secrets/{secretKey}")
     @Headers("Authorization: {authorization}")
     ApiResponseBody<String, List<String>> addRequesterAppComputeSecret(

iexec-sms-library/src/main/java/com/iexec/sms/metric/SecretsMetrics.java

@@ -16,7 +16,10 @@
 
 package com.iexec.sms.metric;
 
-import lombok.*;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
 
 @Builder
 @NoArgsConstructor
@@ -27,4 +30,5 @@ public class SecretsMetrics {
     private long initialCount;
     private long storedCount;
     private long addedSinceStartCount;
+    private long cachedSecretsCount;
 }

src/itest/java/com/iexec/sms/secret/compute/TeeTaskComputeSecretIntegrationTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2021-2023 IEXEC BLOCKCHAIN TECH
+ * Copyright 2021-2024 IEXEC BLOCKCHAIN TECH
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -101,19 +101,18 @@ public void setUp() {
 
     @Test
     void shouldAddNewComputeSecrets() {
-        final String appDeveloperSecretIndex = "1";
         final String requesterSecretKey = "secret-key";
         final String requesterAddress = REQUESTER_ADDRESS;
         final String appAddress = APP_ADDRESS;
         final String secretValue = SECRET_VALUE;
         final String ownerAddress = OWNER_ADDRESS;
 
-        addNewAppDeveloperSecret(appAddress, appDeveloperSecretIndex, secretValue, ownerAddress);
+        addNewAppDeveloperSecret(appAddress, SmsClient.APP_DEVELOPER_SECRET_INDEX, secretValue, ownerAddress);
         addNewRequesterSecret(requesterAddress, requesterSecretKey, secretValue);
 
         // Check the new secrets exists for the API
         try {
-            apiClient.isAppDeveloperAppComputeSecretPresent(appAddress, appDeveloperSecretIndex);
+            apiClient.isAppDeveloperAppComputeSecretPresent(appAddress);
         } catch (FeignException e) {
             Assertions.assertThat(e.status()).isEqualTo(HttpStatus.NO_CONTENT.value());
         }
@@ -133,7 +132,7 @@ void shouldAddNewComputeSecrets() {
                                 .onChainObjectType(OnChainObjectType.APPLICATION)
                                 .onChainObjectAddress(appAddress)
                                 .secretOwnerRole(SecretOwnerRole.APPLICATION_DEVELOPER)
-                                .key(appDeveloperSecretIndex)
+                                .key(SmsClient.APP_DEVELOPER_SECRET_INDEX)
                                 .build(),
                         exampleMatcher
                 )
@@ -145,7 +144,7 @@ void shouldAddNewComputeSecrets() {
             return;
         }
         Assertions.assertThat(appDeveloperSecret.get().getHeader().getOnChainObjectAddress()).isEqualToIgnoringCase(appAddress);
-        Assertions.assertThat(appDeveloperSecret.get().getHeader().getKey()).isEqualTo(appDeveloperSecretIndex);
+        Assertions.assertThat(appDeveloperSecret.get().getHeader().getKey()).isEqualTo(SmsClient.APP_DEVELOPER_SECRET_INDEX);
         Assertions.assertThat(appDeveloperSecret.get().getValue()).isNotEqualTo(secretValue);
         Assertions.assertThat(appDeveloperSecret.get().getValue()).isEqualTo(encryptionService.encrypt(secretValue));
 
@@ -173,7 +172,7 @@ void shouldAddNewComputeSecrets() {
 
         // We shouldn't be able to add a new secrets to the database with the same IDs
         try {
-            final String authorization = getAuthorizationForAppDeveloper(appAddress, appDeveloperSecretIndex, secretValue);
+            final String authorization = getAuthorizationForAppDeveloper(appAddress, SmsClient.APP_DEVELOPER_SECRET_INDEX, secretValue);
             apiClient.addAppDeveloperAppComputeSecret(authorization, appAddress, secretValue);
             Assertions.fail("A second app developer secret with the same app address and index should be rejected.");
         } catch (FeignException.Conflict ignored) {
@@ -192,7 +191,7 @@ void shouldAddNewComputeSecrets() {
         try {
             when(iexecHubService.getOwner(UPPER_CASE_APP_ADDRESS)).thenReturn(ownerAddress);
 
-            final String authorization = getAuthorizationForAppDeveloper(UPPER_CASE_APP_ADDRESS, appDeveloperSecretIndex, secretValue);
+            final String authorization = getAuthorizationForAppDeveloper(UPPER_CASE_APP_ADDRESS, SmsClient.APP_DEVELOPER_SECRET_INDEX, secretValue);
             apiClient.addAppDeveloperAppComputeSecret(authorization, UPPER_CASE_APP_ADDRESS, secretValue);
             Assertions.fail("A second app developer secret with the same index " +
                     "and an app address whose only difference is the case should be rejected.");
@@ -242,7 +241,7 @@ private void addNewAppDeveloperSecret(String appAddress, String secretIndex, Str
 
         // At first, no secret should be in the database
         try {
-            apiClient.isAppDeveloperAppComputeSecretPresent(appAddress, secretIndex);
+            apiClient.isAppDeveloperAppComputeSecretPresent(appAddress);
             Assertions.fail("No application developer secret was expected but one has been retrieved.");
         } catch (FeignException.NotFound ignored) {
             // Having a Not Found exception is what we expect there.

src/main/java/com/iexec/sms/admin/AdminController.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 IEXEC BLOCKCHAIN TECH
+ * Copyright 2023-2024 IEXEC BLOCKCHAIN TECH
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -50,7 +50,7 @@ private enum BackupAction {
     /**
      * The name of the database backup file.
      */
-    private static final String BACKUP_FILENAME = "backup.sql";
+    private static final String BACKUP_DATABASE_FILENAME = "backup.sql";
 
     /**
      * We want to perform one operation at a time. This ReentrantLock is used to set up the lock mechanism.
@@ -200,7 +200,7 @@ private ResponseEntity<Void> performOperation(String sourceStorageID, String sou
 
             switch (operationType) {
                 case BACKUP:
-                    operationSuccessful = adminService.createDatabaseBackupFile(adminStorageLocation + BACKUP_STORAGE_LOCATION, BACKUP_FILENAME);
+                    operationSuccessful = adminService.createBackupFile(adminStorageLocation + BACKUP_STORAGE_LOCATION, BACKUP_DATABASE_FILENAME);
                     break;
                 case RESTORE:
                     operationSuccessful = adminService.restoreDatabaseFromBackupFile(sourceStoragePath, sourceFileName);
@@ -211,7 +211,7 @@ private ResponseEntity<Void> performOperation(String sourceStorageID, String sou
                 case REPLICATE:
                     destinationStoragePath = getStoragePathFromID(destinationStorageID);
                     operationSuccessful = adminService.copyBackupFile(
-                            adminStorageLocation + BACKUP_STORAGE_LOCATION, BACKUP_FILENAME, destinationStoragePath, destinationFileName);
+                            adminStorageLocation + BACKUP_STORAGE_LOCATION, BACKUP_DATABASE_FILENAME, destinationStoragePath, destinationFileName);
                     break;
                 case COPY:
                     destinationStoragePath = getStoragePathFromID(destinationStorageID);

src/main/java/com/iexec/sms/admin/AdminOperationError.java

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2024-2024 IEXEC BLOCKCHAIN TECH
+ *
+ * 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 com.iexec.sms.admin;
+
+/**
+ * Enum to manage error on administration operations
+ */
+public enum AdminOperationError {
+
+    BACKUP_FILE_OUTSIDE_STORAGE("Backup file is outside of storage file system"),
+    DATABASE_BACKUP_FILE_NOT_EXIST("Database backup file does not exist"),
+    AES_KEY_BACKUP_FILE_NOT_EXIST("AES KEY backup file does not exist"),
+    REPLICATE_OR_COPY_FILE_OUTSIDE_STORAGE("Replicated or Copied backup file destination is outside of storage file system"),
+    DATABASE_FILE_ALREADY_EXIST("A file already exists at the destination of database file"),
+    AES_KEY_FILE_ALREADY_EXIST("A file already exists at the destination of AES Key file"),
+    AES_KEY_FILE_WRITE_PERMISSIONS("Can't add write permissions to AES Key file permissions");
+
+    private final String description;
+
+    AdminOperationError(String description) {
+        this.description = description;
+    }
+
+    @Override
+    public String toString() {
+        return description;
+    }
+}