Introduce VaultMetadataProvider.

Author: ylangisc

core/src/main/java/ch/cyberduck/core/features/Vault.java

@@ -23,8 +23,8 @@
 import ch.cyberduck.core.exception.NotfoundException;
 import ch.cyberduck.core.exception.UnsupportedException;
 import ch.cyberduck.core.vault.DisabledVault;
-import ch.cyberduck.core.vault.VaultCredentials;
 import ch.cyberduck.core.vault.VaultMetadata;
+import ch.cyberduck.core.vault.VaultMetadataProvider;
 
 public interface Vault {
 
@@ -36,7 +36,8 @@ public interface Vault {
      * @throws BackgroundException    Failure reading master key from server
      * @throws NotfoundException      No master key file in home
      */
-    Vault create(Session<?> session, String region, VaultCredentials credentials) throws BackgroundException;
+
+    Vault create(Session<?> session, String region, VaultMetadataProvider metadata) throws BackgroundException;
 
     /**
      * Open existing vault

core/src/main/java/ch/cyberduck/core/vault/DisabledVault.java

@@ -18,6 +18,7 @@
 import ch.cyberduck.core.PasswordCallback;
 import ch.cyberduck.core.Path;
 import ch.cyberduck.core.Session;
+import ch.cyberduck.core.exception.BackgroundException;
 import ch.cyberduck.core.features.Vault;
 
 import java.util.EnumSet;
@@ -36,7 +37,7 @@ public DisabledVault(final Path home) {
     }
 
     @Override
-    public Vault create(final Session<?> session, final String region, final VaultCredentials credentials) {
+    public Vault create(final Session<?> session, final String region, final VaultMetadataProvider metadata) throws BackgroundException {
         return null;
     }
 

core/src/main/java/ch/cyberduck/core/vault/VaultMetadataProvider.java

@@ -0,0 +1,23 @@
+package ch.cyberduck.core.vault;
+
+/*
+ * Copyright (c) 2002-2025 iterate GmbH. All rights reserved.
+ * https://cyberduck.io/
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ */
+
+public interface VaultMetadataProvider {
+
+    //Map<Path, byte[]> metadataFiles() throws BackgroundException;
+
+    //String dirPath();
+}

cryptomator/src/main/java/ch/cyberduck/core/cryptomator/CryptoVaultProvider.java

@@ -18,6 +18,8 @@
 import ch.cyberduck.core.ListProgressListener;
 import ch.cyberduck.core.Path;
 import ch.cyberduck.core.Session;
+import ch.cyberduck.core.cryptomator.impl.uvf.DefaultVaultMetadataUVFProvider;
+import ch.cyberduck.core.cryptomator.impl.v8.DefaultVaultMetadataV8Provider;
 import ch.cyberduck.core.exception.BackgroundException;
 import ch.cyberduck.core.features.Find;
 import ch.cyberduck.core.preferences.HostPreferencesFactory;
@@ -94,9 +96,10 @@ public synchronized AbstractVault provide(final Session<?> session, final VaultM
     public AbstractVault create(final Session<?> session, final String region, final VaultCredentials credentials, final VaultMetadata metadata) throws BackgroundException {
         switch(metadata.type) {
             case V8:
-                return new ch.cyberduck.core.cryptomator.impl.v8.CryptoVault(metadata.root).create(session, region, credentials);
+                return new ch.cyberduck.core.cryptomator.impl.v8.CryptoVault(metadata.root).create(session, region, new DefaultVaultMetadataV8Provider(credentials));
             case UVF:
-                return new ch.cyberduck.core.cryptomator.impl.uvf.CryptoVault(metadata.root).create(session, region, credentials);
+                //TODO plain UVF
+                return new ch.cyberduck.core.cryptomator.impl.uvf.CryptoVault(metadata.root).create(session, region, new DefaultVaultMetadataUVFProvider());
             default:
                 log.error("Unknown vault type {}", metadata.type);
                 // TODO schmeissen, DISABLED zurück geben geht nicht weil kein AbstractVault

cryptomator/src/main/java/ch/cyberduck/core/cryptomator/impl/uvf/CryptoVault.java

@@ -23,6 +23,7 @@
 import ch.cyberduck.core.Session;
 import ch.cyberduck.core.SimplePathPredicate;
 import ch.cyberduck.core.cryptomator.AbstractVault;
+import ch.cyberduck.core.cryptomator.ContentWriter;
 import ch.cyberduck.core.cryptomator.CryptoDirectory;
 import ch.cyberduck.core.cryptomator.CryptoFilename;
 import ch.cyberduck.core.cryptomator.features.CryptoDirectoryUVFFeature;
@@ -32,9 +33,13 @@
 import ch.cyberduck.core.exception.BackgroundException;
 import ch.cyberduck.core.exception.UnsupportedException;
 import ch.cyberduck.core.features.Directory;
+import ch.cyberduck.core.features.Encryption;
 import ch.cyberduck.core.features.Vault;
-import ch.cyberduck.core.vault.VaultCredentials;
+import ch.cyberduck.core.features.Write;
+import ch.cyberduck.core.preferences.PreferencesFactory;
+import ch.cyberduck.core.transfer.TransferStatus;
 import ch.cyberduck.core.vault.VaultMetadata;
+import ch.cyberduck.core.vault.VaultMetadataProvider;
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
@@ -83,8 +88,37 @@ public CryptoVault(final Path home) {
     }
 
     @Override
-    public AbstractVault create(final Session<?> session, final String region, final VaultCredentials credentials) throws BackgroundException {
-        throw new UnsupportedOperationException();
+    public AbstractVault create(final Session<?> session, final String region, final VaultMetadataProvider metadata) throws BackgroundException {
+        final VaultMetadataUVFProvider provider = VaultMetadataUVFProvider.cast(metadata);
+
+        final Path home = this.getHome();
+        log.debug("Create vault root directory at {}", home);
+
+        // Obtain non encrypted directory writer
+        final Directory<?> directory = session._getFeature(Directory.class);
+        final TransferStatus status = new TransferStatus().setRegion(region);
+        final Encryption encryption = session._getFeature(Encryption.class);
+        if(encryption != null) {
+            status.setEncryption(encryption.getDefault(home));
+        }
+        final Path vault = directory.mkdir(session._getFeature(Write.class), home, status);
+
+        final Path dataDir = new Path(vault, "d", EnumSet.of(Path.Type.directory));
+        final Path firstLevel = new Path(dataDir, provider.getDirPath().substring(0, 2), EnumSet.of(Path.Type.directory));
+        final Path secondLevel = new Path(firstLevel, provider.getDirPath().substring(2), EnumSet.of(Path.Type.directory));
+
+        directory.mkdir(session._getFeature(Write.class), dataDir, status);
+        directory.mkdir(session._getFeature(Write.class), firstLevel, status);
+        directory.mkdir(session._getFeature(Write.class), secondLevel, status);
+
+        // vault.uvf
+        new ContentWriter(session).write(new Path(home, PreferencesFactory.get().getProperty("cryptomator.vault.config.filename"),
+                EnumSet.of(Path.Type.file, Path.Type.vault)), provider.getMetadata());
+        // dir.uvf
+        new ContentWriter(session).write(new Path(secondLevel, "dir.uvf", EnumSet.of(Path.Type.file)),
+                provider.getRootDirectoryMetadata());
+
+        return this;
     }
 
     // load -> unlock -> open

cryptomator/src/main/java/ch/cyberduck/core/cryptomator/impl/uvf/DefaultVaultMetadataUVFProvider.java

@@ -0,0 +1,34 @@
+package ch.cyberduck.core.cryptomator.impl.uvf;
+
+/*
+ * Copyright (c) 2002-2025 iterate GmbH. All rights reserved.
+ * https://cyberduck.io/
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ */
+
+public class DefaultVaultMetadataUVFProvider implements VaultMetadataUVFProvider {
+
+    @Override
+    public byte[] getMetadata() {
+        return new byte[0];
+    }
+
+    @Override
+    public byte[] getRootDirectoryMetadata() {
+        return new byte[0];
+    }
+
+    @Override
+    public String getDirPath() {
+        return "";
+    }
+}

cryptomator/src/main/java/ch/cyberduck/core/cryptomator/impl/uvf/VaultMetadataUVFProvider.java

@@ -0,0 +1,36 @@
+package ch.cyberduck.core.cryptomator.impl.uvf;
+
+/*
+ * Copyright (c) 2002-2025 iterate GmbH. All rights reserved.
+ * https://cyberduck.io/
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ */
+
+import ch.cyberduck.core.vault.VaultMetadataProvider;
+
+public interface VaultMetadataUVFProvider extends VaultMetadataProvider {
+
+    byte[] getMetadata();
+
+    byte[] getRootDirectoryMetadata();
+
+    String getDirPath();
+
+    static VaultMetadataUVFProvider cast(VaultMetadataProvider provider) {
+        if(provider instanceof VaultMetadataUVFProvider) {
+            return (VaultMetadataUVFProvider) provider;
+        }
+        else {
+            throw new IllegalArgumentException("Unsupported metadata type " + provider.getClass());
+        }
+    }
+}

cryptomator/src/main/java/ch/cyberduck/core/cryptomator/impl/v8/CryptoVault.java

@@ -42,7 +42,6 @@
 import ch.cyberduck.core.exception.NotfoundException;
 import ch.cyberduck.core.features.Directory;
 import ch.cyberduck.core.features.Encryption;
-import ch.cyberduck.core.features.Write;
 import ch.cyberduck.core.features.Vault;
 import ch.cyberduck.core.features.Write;
 import ch.cyberduck.core.preferences.Preferences;
@@ -52,6 +51,7 @@
 import ch.cyberduck.core.vault.VaultCredentials;
 import ch.cyberduck.core.vault.VaultException;
 import ch.cyberduck.core.vault.VaultMetadata;
+import ch.cyberduck.core.vault.VaultMetadataProvider;
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
@@ -212,8 +212,14 @@ public Pattern getFilenamePattern() {
         return FILENAME_PATTERN;
     }
 
+    public AbstractVault create(final Session<?> session, final String region, final VaultCredentials credentials) throws BackgroundException {
+        return this.create(session, region, new DefaultVaultMetadataV8Provider(credentials));
+    }
+
     @Override
-    public synchronized AbstractVault create(final Session<?> session, final String region, final VaultCredentials credentials) throws BackgroundException {
+    public AbstractVault create(final Session<?> session, final String region, final VaultMetadataProvider metadata) throws BackgroundException {
+        final VaultMetadataV8Provider provider = VaultMetadataV8Provider.cast(metadata);
+        final VaultCredentials credentials = provider.getCredentials();
         final Host bookmark = session.getHost();
         if(credentials.isSaved()) {
             try {

cryptomator/src/main/java/ch/cyberduck/core/cryptomator/impl/v8/DefaultVaultMetadataV8Provider.java

@@ -0,0 +1,32 @@
+package ch.cyberduck.core.cryptomator.impl.v8;
+
+/*
+ * Copyright (c) 2002-2025 iterate GmbH. All rights reserved.
+ * https://cyberduck.io/
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ */
+
+import ch.cyberduck.core.vault.VaultCredentials;
+
+public class DefaultVaultMetadataV8Provider implements VaultMetadataV8Provider {
+
+    private VaultCredentials credentials;
+
+    public DefaultVaultMetadataV8Provider(final VaultCredentials credentials) {
+        this.credentials = credentials;
+    }
+
+    @Override
+    public VaultCredentials getCredentials() {
+        return credentials;
+    }
+}

cryptomator/src/main/java/ch/cyberduck/core/cryptomator/impl/v8/VaultMetadataV8Provider.java

@@ -0,0 +1,33 @@
+package ch.cyberduck.core.cryptomator.impl.v8;
+
+/*
+ * Copyright (c) 2002-2025 iterate GmbH. All rights reserved.
+ * https://cyberduck.io/
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ */
+
+import ch.cyberduck.core.vault.VaultCredentials;
+import ch.cyberduck.core.vault.VaultMetadataProvider;
+
+public interface VaultMetadataV8Provider extends VaultMetadataProvider {
+
+    VaultCredentials getCredentials();
+
+    static VaultMetadataV8Provider cast(VaultMetadataProvider provider) {
+        if(provider instanceof VaultMetadataV8Provider) {
+            return (VaultMetadataV8Provider) provider;
+        }
+        else {
+            throw new IllegalArgumentException("Unsupported metadata type " + provider.getClass());
+        }
+    }
+}