Changeset 8085 for branches/3.19-stable

Timestamp:

Oct 27, 2022, 7:25:30 AM (7 months ago)

Author:

Nicklas Nordborg

Message:

References #2284: Add support for encryption to the Packed file exporter plug-in

The ZIP exporter now supports encryption.

Location:

branches/3.19-stable/src

Files:

• core/net/sf/basedb/util/zip/FilePacker.java (modified) (2 diffs)
• core/net/sf/basedb/util/zip/ZipFilePacker.java (modified) (5 diffs)
• plugins/core/net/sf/basedb/plugins/PackedFileExporter.java (modified) (3 diffs)

branches/3.19-stable/src/core/net/sf/basedb/util/zip/FilePacker.java

@@ -27 +27 @@
 import java.io.InputStream;
 import java.io.OutputStream;
+
+import net.sf.basedb.core.PluginParameter;
+import net.sf.basedb.core.StringParameterType;
 
 /**
@@ -65 +68 @@
   
   /**
+    Does the packer support encryption or not?
+    The default implementation return false.
+    @since 3.19.5
+  */
+  public default boolean supportsEncryption()
+  {
+    return false;
+  }
+  
+  /**
+    The default implementation return a parameter asking for a password.
+    The implementing class may create another parameter as long as it is
+    named "password". This method is only called if the implementation
+    supports encryption.
+    @since 3.19.5
+  */
+  public default PluginParameter<String> getPasswordParameter()
+  {
+    PluginParameter<String> passwordParameter = new PluginParameter<String>
+    (
+      "password", "Password", "Enter a password to encrypt the archive." , new StringParameterType()
+    );
+    return passwordParameter;
+  }
+  
+  /**
+    Set the password to use for encrypting the archive. This method
+    is only called if the implementation supports encryption and the
+    user has entered a password.
+    @since 3.19.5
+  */
+  public default void setPassword(String password)
+  {}
+  
+  /**
     The output stream that the compressed files should be written to.
     @param out The output stream to write to

branches/3.19-stable/src/core/net/sf/basedb/util/zip/ZipFilePacker.java

@@ -23 +23 @@
 package net.sf.basedb.util.zip;
 
+import net.lingala.zip4j.io.outputstream.ZipOutputStream;
+import net.lingala.zip4j.model.ZipParameters;
+import net.lingala.zip4j.model.enums.AesKeyStrength;
+import net.lingala.zip4j.model.enums.CompressionLevel;
+import net.lingala.zip4j.model.enums.CompressionMethod;
+import net.lingala.zip4j.model.enums.EncryptionMethod;
+import net.sf.basedb.core.BaseException;
+import net.sf.basedb.core.PluginParameter;
+import net.sf.basedb.core.StringParameterType;
 import net.sf.basedb.util.FileUtil;
 
@@ -28 +37 @@
 import java.io.InputStream;
 import java.io.OutputStream;
-import java.util.zip.ZipEntry;
-import java.util.zip.ZipOutputStream;
 
 /**
@@ -42 +49 @@
 {
   private ZipOutputStream zip;
+  private String password;
   
   /**
@@ -78 +86 @@
   }
   /**
-   * Wrap the output stream in a {@link ZipOutputStream}.
-   */
+    Wrap the output stream in a {@link ZipOutputStream}.
+  */
   @Override
   public void setOutputStream(OutputStream out)
   {
-    this.zip = new ZipOutputStream(out);
-    zip.setMethod(ZipOutputStream.DEFLATED);
+    try
+    {
+      this.zip = password == null ? new ZipOutputStream(out) : new ZipOutputStream(out, password.toCharArray());
+    }
+    catch (IOException ex)
+    {
+      throw new BaseException(ex);
+    }
   }
+  
   /**
-    Create a new {@link ZipEntry} and write the compressed
-    data to it.
+    Encryption is supported.
+    @since 3.19.5
+  */
+  @Override
+  public boolean supportsEncryption() 
+  {
+    return true;
+  }
+
+  /**
+    Get the encyption password parameter.
+    @since 3.19.5
+  */
+  @Override
+  public PluginParameter<String> getPasswordParameter()
+  {
+    PluginParameter<String> passwordParameter = new PluginParameter<String>
+    (
+      "password", "Password", "Enter a password to encrypt the archive with strong AES256 encryption. "
+        + "If empty, the ZIP archive will not be encrypted." , new StringParameterType()
+    );
+    return passwordParameter;
+  }
+
+  /**
+    @since 3.19.5
+  */
+  @Override
+  public void setPassword(String password) 
+  {
+    this.password = password;
+  }
+
+  /**
+    Create a new entry and write the compressed data to it.
   */
   @Override
@@ -96 +144 @@
     boolean isDirectory = in == null;
     if (isDirectory && !entryName.endsWith("/")) entryName += "/";
-    ZipEntry entry = new ZipEntry(entryName);
-    if (lastModified > 0) entry.setTime(lastModified);
-    if (isDirectory) 
+    
+    ZipParameters zipParameters = new ZipParameters();
+    zipParameters.setFileNameInZip(entryName);
+    if (lastModified > 0)
     {
-      entry.setMethod(ZipOutputStream.STORED);
-      entry.setSize(0);
-      entry.setCrc(0);
+      zipParameters.setLastModifiedFileTime(lastModified);
+    }
+    if (isDirectory)
+    {
+      zipParameters.setCompressionMethod(CompressionMethod.STORE);
+      zipParameters.setEntrySize(0);
+      zipParameters.setEntryCRC(0);
     }
     else
     {
-      entry.setSize(size);
+      zipParameters.setCompressionMethod(CompressionMethod.DEFLATE);
+      zipParameters.setCompressionLevel(CompressionLevel.NORMAL);
+      zipParameters.setEntrySize(size);
+      if (password != null)
+      {
+        zipParameters.setEncryptFiles(true);
+        zipParameters.setEncryptionMethod(EncryptionMethod.AES);
+        zipParameters.setAesKeyStrength(AesKeyStrength.KEY_STRENGTH_256);
+      }
     }
-    zip.putNextEntry(entry);
+    zip.putNextEntry(zipParameters);
     if (!isDirectory) FileUtil.copy(in, zip);
     zip.flush();

branches/3.19-stable/src/plugins/core/net/sf/basedb/plugins/PackedFileExporter.java

@@ -308 +308 @@
         
         // Other options
+        if (packer.supportsEncryption())
+        {
+          storeValue(job, request, ri.getParameter("password"));
+        }
         storeValue(job, request, ri.getParameter("removeItems"));
         if (saveAs != null)
@@ -358 +362 @@
     List<Integer> directories = job.getValues("directories");
     boolean removeItems = Boolean.TRUE.equals(job.getValue("removeItems"));
+    String password = job.getValue("password");
     FilePacker packer = getPacker();
+    if (packer.supportsEncryption() && password != null)
+    {
+      packer.setPassword(password);
+    }
 
     ChainedProgressReporter chained = null;
@@ -528 +537 @@
         parameters.add(getSaveAsParameter(null, null, defaultPath, requireFile));
         parameters.add(getOverwriteParameter(null, null));
+        // Encryption
+        if (packer.supportsEncryption())
+        {
+          parameters.add(packer.getPasswordParameter());
+        }
 
         // Remove parameter