From 3b0806201b4dba6a9827a8e0e2268cb3c7d86953 Mon Sep 17 00:00:00 2001 From: Tony Germano Date: Sun, 15 Nov 2026 21:24:44 -0500 Subject: [PATCH] Honor the password in the query-parameter message export The variant of the server-side message export that takes query parameters copied the password and encryption type into the writer options but never enabled the password. MessageWriterFactory only protects an archive when the password is enabled, so a request for a password-protected ZIP wrote an unprotected one without any error. The variant that takes the options in the request body, which the administrator uses, was not affected. Enable the password when one is given. Tests: the options the controller receives for a password, no password and an empty one; the first fails without the change. Issue: https://github.com/OpenIntegrationEngine/engine/issues/582 Assisted-by: Claude:claude-sonnet-5-5 Signed-off-by: Tony Germano --- .../server/api/servlets/MessageServlet.java | 11 ++-- .../api/servlets/MessageServletTest.java | 50 ++++++++++++++++--- 2 files changed, 45 insertions(+), 16 deletions(-) diff --git a/server/src/main/java/com/mirth/connect/server/api/servlets/MessageServlet.java b/server/src/main/java/com/mirth/connect/server/api/servlets/MessageServlet.java index 0e3e778c67..984097095f 100644 --- a/server/src/main/java/com/mirth/connect/server/api/servlets/MessageServlet.java +++ b/server/src/main/java/com/mirth/connect/server/api/servlets/MessageServlet.java @@ -1,11 +1,5 @@ -/* - * Copyright (c) Mirth Corporation. All rights reserved. - * - * http://www.mirthcorp.com - * - * The software in this package is published under the terms of the MPL license a copy of which has - * been included with this distribution in the LICENSE.txt file. - */ +// SPDX-License-Identifier: MPL-2.0 +// SPDX-FileCopyrightText: Mirth Corporation package com.mirth.connect.server.api.servlets; @@ -525,6 +519,7 @@ private MessageWriterOptions getMessageWriterOptions(ContentType contentType, bo writerOptions.setArchiveFileName(archiveFileName); writerOptions.setArchiveFormat(archiveFormat); writerOptions.setCompressFormat(compressFormat); + writerOptions.setPasswordEnabled(StringUtils.isNotEmpty(password)); writerOptions.setPassword(password); writerOptions.setEncryptionType(encryptionType); diff --git a/server/src/test/java/com/mirth/connect/server/api/servlets/MessageServletTest.java b/server/src/test/java/com/mirth/connect/server/api/servlets/MessageServletTest.java index 5dce80294a..0add38a908 100644 --- a/server/src/test/java/com/mirth/connect/server/api/servlets/MessageServletTest.java +++ b/server/src/test/java/com/mirth/connect/server/api/servlets/MessageServletTest.java @@ -1,16 +1,13 @@ -/* - * Copyright (c) Mirth Corporation. All rights reserved. - * - * http://www.mirthcorp.com - * - * The software in this package is published under the terms of the MPL license a copy of which has - * been included with this distribution in the LICENSE.txt file. - */ +// SPDX-License-Identifier: MPL-2.0 +// SPDX-FileCopyrightText: Mirth Corporation +// SPDX-FileCopyrightText: 2026 Tony Germano package com.mirth.connect.server.api.servlets; import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertTrue; import static org.mockito.ArgumentMatchers.any; import static org.mockito.ArgumentMatchers.anyBoolean; import static org.mockito.ArgumentMatchers.anyInt; @@ -25,6 +22,7 @@ import java.io.InputStream; import java.net.URI; import java.util.Collection; +import java.util.Collections; import java.util.Date; import java.util.HashMap; import java.util.HashSet; @@ -47,20 +45,25 @@ import org.junit.After; import org.junit.Before; import org.junit.Test; +import org.mockito.ArgumentCaptor; import org.mockito.invocation.InvocationOnMock; import com.mirth.connect.client.core.Operation; import com.mirth.connect.client.core.api.MirthApiException; +import com.mirth.connect.donkey.model.message.ContentType; import com.mirth.connect.donkey.server.channel.ChannelException; import com.mirth.connect.donkey.server.channel.DispatchResult; import com.mirth.connect.donkey.server.message.batch.BatchMessageException; import com.mirth.connect.model.LoginStatus; import com.mirth.connect.model.LoginStatus.Status; import com.mirth.connect.model.User; +import com.mirth.connect.util.messagewriter.EncryptionType; +import com.mirth.connect.util.messagewriter.MessageWriterOptions; import com.mirth.connect.server.api.providers.ResponseCodeFilter; import com.mirth.connect.server.controllers.AuthorizationController; import com.mirth.connect.server.controllers.ControllerFactory; import com.mirth.connect.server.controllers.EngineController; +import com.mirth.connect.server.controllers.MessageController; import com.mirth.connect.server.controllers.UserController; public class MessageServletTest { @@ -69,6 +72,7 @@ public class MessageServletTest { static ControllerFactory controllerFactory; static EngineController engineController; + static MessageController messageController; static HttpSession session; static HttpServletRequest request; static ContainerRequestContext context; @@ -88,6 +92,9 @@ public void setup() throws Exception { when(engineController.dispatchRawMessage(eq("batchMessageException"), any(), anyBoolean(), anyBoolean())).thenThrow(new BatchMessageException()); when(controllerFactory.createEngineController()).thenReturn(engineController); + messageController = mock(MessageController.class); + when(controllerFactory.createMessageController()).thenReturn(messageController); + UserController userController = mock(UserController.class); when(userController.authorizeUser(anyString(), anyString(), anyString())).thenReturn(new LoginStatus(Status.SUCCESS, "")); when(userController.getUser(anyInt(), anyString())).thenAnswer((InvocationOnMock invocation) -> { @@ -124,6 +131,33 @@ public void teardown() { reset(engineController); } + @Test + public void testExportMessagesServerEnablesPasswordWhenGiven() throws Exception { + MessageWriterOptions options = exportWithQueryParameters("secret"); + + assertTrue(options.isPasswordEnabled()); + assertEquals("secret", options.getPassword()); + assertEquals(EncryptionType.AES256, options.getEncryptionType()); + } + + @Test + public void testExportMessagesServerLeavesPasswordDisabledWhenNotGiven() throws Exception { + assertFalse(exportWithQueryParameters(null).isPasswordEnabled()); + assertFalse(exportWithQueryParameters("").isPasswordEnabled()); + } + + /** Exports through the variant that takes query parameters and returns the options the controller received. */ + private MessageWriterOptions exportWithQueryParameters(String password) throws Exception { + MessageServlet servlet = new MessageServlet(request, context, sc, controllerFactory); + reset(messageController); + + servlet.exportMessagesServer("channel1", null, null, null, null, null, null, null, null, null, null, Collections.emptySet(), Collections.emptySet(), Collections.emptySet(), null, Collections.emptySet(), Collections.emptySet(), Collections.emptySet(), Collections.emptySet(), Collections.emptySet(), Collections.emptySet(), Collections.emptySet(), Collections.emptySet(), Collections.emptySet(), Collections.emptySet(), Collections.emptySet(), Collections.emptySet(), Collections.emptySet(), Collections.emptySet(), Collections.emptySet(), Collections.emptySet(), Collections.emptySet(), Collections.emptySet(), null, null, null, null, 2, ContentType.RAW, false, false, false, null, "root", "pattern", "archive", "zip", null, password, EncryptionType.AES256); + + ArgumentCaptor options = ArgumentCaptor.forClass(MessageWriterOptions.class); + verify(messageController).exportMessages(eq("channel1"), any(), eq(2), options.capture()); + return options.getValue(); + } + @Test public void testProcessMessageReturnsMessageId() { MessageServlet servlet = new MessageServlet(request, context, sc, controllerFactory);