Merge branch 'release/2.5.0'

Author: infeo

.github/workflows/build.yml

@@ -7,16 +7,16 @@ jobs:
     runs-on: ubuntu-latest
     if: "!contains(github.event.head_commit.message, '[ci skip]') && !contains(github.event.head_commit.message, '[skip ci]')"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
            fetch-depth: 0
-      - uses: actions/setup-java@v2
+      - uses: actions/setup-java@v3
         with:
           java-version: 17
           distribution: 'temurin'
           cache: 'maven'
       - name: Cache SonarCloud packages
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: ~/.sonar/cache
           key: ${{ runner.os }}-sonar
@@ -36,12 +36,12 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed to get PR information, if any
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
-      - uses: actions/upload-artifact@v2
+      - uses: actions/upload-artifact@v3
         with:
           name: artifacts
           path: target/*.jar
       - name: Create Release
-        uses: actions/create-release@v1
+        uses: actions/create-release@v1 #NOTE: action is archived and unmaintained
         if: startsWith(github.ref, 'refs/tags/')
         env:
           GITHUB_TOKEN: ${{ secrets.CRYPTOBOT_RELEASE_TOKEN }} # release as "cryptobot"

.github/workflows/codeql-analysis.yml

@@ -15,19 +15,19 @@ jobs:
     runs-on: ubuntu-latest
     if: "!contains(github.event.head_commit.message, '[ci skip]') && !contains(github.event.head_commit.message, '[skip ci]')"
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         fetch-depth: 2
-    - uses: actions/setup-java@v2
+    - uses: actions/setup-java@v3
       with:
         java-version: 17
         distribution: 'temurin'
         cache: 'maven'
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
+      uses: github/codeql-action/init@v2
       with:
         languages: java
     - name: Build and Test
       run: mvn -B install -DskipTests
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      uses: github/codeql-action/analyze@v2

.github/workflows/publish-central.yml

@@ -10,10 +10,10 @@ jobs:
   publish:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           ref: "refs/tags/${{ github.event.inputs.tag }}"
-      - uses: actions/setup-java@v2
+      - uses: actions/setup-java@v3
         with:
           java-version: 17
           distribution: 'temurin'

.github/workflows/publish-github.yml

@@ -7,8 +7,8 @@ jobs:
     runs-on: ubuntu-latest
     if: startsWith(github.ref, 'refs/tags/') # only allow publishing tagged versions
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-java@v2
+      - uses: actions/checkout@v3
+      - uses: actions/setup-java@v3
         with:
           java-version: 17
           distribution: 'temurin'

pom.xml

@@ -2,7 +2,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>org.cryptomator</groupId>
 	<artifactId>cryptofs</artifactId>
-	<version>2.4.5</version>
+	<version>2.5.0</version>
 	<name>Cryptomator Crypto Filesystem</name>
 	<description>This library provides the Java filesystem provider used by Cryptomator.</description>
 	<url>https://github.com/cryptomator/cryptofs</url>

src/main/java/org/cryptomator/cryptofs/CryptoFileSystemImpl.java

@@ -230,10 +230,12 @@ void setAttribute(CryptoPath cleartextPath, String attribute, Object value, Link
 	}
 
 	Map<String, Object> readAttributes(CryptoPath cleartextPath, String attributes, LinkOption... options) throws IOException {
+		stats.incrementAccesses();
 		return fileAttributeByNameProvider.readAttributes(cleartextPath, attributes, options);
 	}
 
 	<A extends BasicFileAttributes> A readAttributes(CryptoPath cleartextPath, Class<A> type, LinkOption... options) throws IOException {
+		stats.incrementAccesses();
 		return fileAttributeProvider.readAttributes(cleartextPath, type, options);
 	}
 
@@ -387,6 +389,7 @@ private FileChannel newFileChannelFromFile(CryptoPath cleartextFilePath, Effecti
 			if (options.readable()) {
 				stats.incrementAccessesRead();
 			}
+			stats.incrementAccesses();
 			return ch;
 		} catch (Exception e) {
 			ch.close();
@@ -669,4 +672,4 @@ public String toString() {
 		return format("%sCryptoFileSystem(%s)", open ? "" : "closed ", pathToVault);
 	}
 
-}
+}

src/main/java/org/cryptomator/cryptofs/CryptoFileSystemProvider.java

@@ -143,7 +143,7 @@ public static void initialize(Path pathToVault, CryptoFileSystemProperties prope
 		}
 		byte[] rawKey = new byte[0];
 		var config = VaultConfig.createNew().cipherCombo(properties.cipherCombo()).shorteningThreshold(properties.shorteningThreshold()).build();
-		try (Masterkey key = properties.keyLoader().loadKey(keyId);
+		try (Masterkey key = properties.keyLoader().loadKey(keyId); //
 			 Cryptor cryptor = CryptorProvider.forScheme(config.getCipherCombo()).provide(key, strongSecureRandom())) {
 			rawKey = key.getEncoded();
 			// save vault config:
@@ -154,6 +154,8 @@ public static void initialize(Path pathToVault, CryptoFileSystemProperties prope
 			String dirHash = cryptor.fileNameCryptor().hashDirectoryId(Constants.ROOT_DIR_ID);
 			Path vaultCipherRootPath = pathToVault.resolve(Constants.DATA_DIR_NAME).resolve(dirHash.substring(0, 2)).resolve(dirHash.substring(2));
 			Files.createDirectories(vaultCipherRootPath);
+			// create dirId backup:
+			DirectoryIdBackup.backupManually(cryptor, new CryptoPathMapper.CiphertextDirectory(Constants.ROOT_DIR_ID, vaultCipherRootPath));
 		} finally {
 			Arrays.fill(rawKey, (byte) 0x00);
 		}

src/main/java/org/cryptomator/cryptofs/CryptoFileSystemStats.java

@@ -27,6 +27,8 @@ public class CryptoFileSystemStats {
 	private final LongAdder chunkCacheHits = new LongAdder();
 	private final LongAdder amountOfAccessesRead = new LongAdder();
 	private final LongAdder amountOfAccessesWritten = new LongAdder();
+	private final LongAdder amountOfAccesses = new LongAdder();
+	private final LongAdder totalAmountOfAccessed = new LongAdder();
 
 	@Inject
 	CryptoFileSystemStats() {
@@ -122,4 +124,17 @@ public void incrementAccessesWritten() {
 		amountOfAccessesWritten.increment();
 	}
 
+	public long pollAmountOfAccesses() {
+		return amountOfAccesses.sumThenReset();
+	}
+
+	public long pollTotalAmountOfAccesses() {
+		return totalAmountOfAccessed.sum();
+	}
+
+	public void incrementAccesses() {
+		totalAmountOfAccessed.increment();
+		amountOfAccesses.increment();
+	}
+
 }

src/main/java/org/cryptomator/cryptofs/CryptoPathMapper.java

@@ -161,8 +161,8 @@ public CiphertextDirectory getCiphertextDir(CryptoPath cleartextPath) throws IOE
 		} else {
 			try {
 				return ciphertextDirectories.get(cleartextPath, () -> {
-					Path dirIdFile = getCiphertextFilePath(cleartextPath).getDirFilePath();
-					return resolveDirectory(dirIdFile);
+					Path dirFile = getCiphertextFilePath(cleartextPath).getDirFilePath();
+					return resolveDirectory(dirFile);
 				});
 			} catch (ExecutionException e) {
 				Throwables.throwIfInstanceOf(e.getCause(), IOException.class);

src/main/java/org/cryptomator/cryptofs/DirectoryIdBackup.java

@@ -13,7 +13,7 @@
 import java.nio.file.StandardOpenOption;
 
 /**
- * Single purpose class to backup the directory id of an encrypted directory when it is created.
+ * Single purpose class to back up the directory id of an encrypted directory when it is created.
  */
 @CryptoFileSystemScoped
 public class DirectoryIdBackup {
@@ -28,20 +28,20 @@ public DirectoryIdBackup(Cryptor cryptor) {
 	/**
 	 * Performs the backup operation for the given {@link CryptoPathMapper.CiphertextDirectory} object.
 	 * <p>
-	 * The directory id is written via an encrypting channel to the file {@link CryptoPathMapper.CiphertextDirectory#path}/{@value Constants#DIR_ID_FILE}.
+	 * The directory id is written via an encrypting channel to the file {@link CryptoPathMapper.CiphertextDirectory#path}/{@value Constants#DIR_BACKUP_FILE_NAME}.
 	 *
 	 * @param ciphertextDirectory The cipher dir object containing the dir id and the encrypted content root
 	 * @throws IOException if an IOException is raised during the write operation
 	 */
 	public void execute(CryptoPathMapper.CiphertextDirectory ciphertextDirectory) throws IOException {
-		try (var channel = Files.newByteChannel(ciphertextDirectory.path.resolve(Constants.DIR_ID_FILE), StandardOpenOption.CREATE_NEW, StandardOpenOption.WRITE); //
+		try (var channel = Files.newByteChannel(ciphertextDirectory.path.resolve(Constants.DIR_BACKUP_FILE_NAME), StandardOpenOption.CREATE_NEW, StandardOpenOption.WRITE); //
 			 var encryptingChannel = wrapEncryptionAround(channel, cryptor)) {
 			encryptingChannel.write(ByteBuffer.wrap(ciphertextDirectory.dirId.getBytes(StandardCharsets.US_ASCII)));
 		}
 	}
 
 	/**
-	 * Static method to explicitly backup the directory id for a specified ciphertext directory.
+	 * Static method to explicitly back up the directory id for a specified ciphertext directory.
 	 *
 	 * @param cryptor The cryptor to be used
 	 * @param ciphertextDirectory A {@link org.cryptomator.cryptofs.CryptoPathMapper.CiphertextDirectory} for which the dirId should be back up'd.