Skip to content

Conversation

@dominicwenig-hmq
Copy link
Contributor

@dominicwenig-hmq dominicwenig-hmq commented Apr 25, 2025

New feature to redact logged passwords.

@cla-bot cla-bot bot added the cla-signed label Apr 25, 2025
@Donnerbart Donnerbart force-pushed the feature/nopasswordinverbose branch from ff3f2cd to 1a338f6 Compare October 28, 2025 09:52
@Donnerbart Donnerbart requested a review from Copilot October 28, 2025 09:53
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request adds a new configuration option to redact passwords in verbose logging mode.

  • Adds a redact-password boolean configuration property with a default value of false
  • Updates password logging logic to display <redacted> when the option is enabled
  • Adds comprehensive test coverage for the new redaction functionality

Reviewed Changes

Copilot reviewed 27 out of 30 changed files in this pull request and generated no comments.

Show a summary per file
File Description
src/main/java/com/hivemq/extensions/log/mqtt/message/config/ExtensionConfig.java Adds isRedactPassword() method to interface
src/main/java/com/hivemq/extensions/log/mqtt/message/config/ExtensionConfigProperties.java Implements redact-password property constant and getter
src/main/java/com/hivemq/extensions/log/mqtt/message/config/ExtensionConfigXml.java Adds XML binding for redact-password field
src/main/java/com/hivemq/extensions/log/mqtt/message/config/ExtensionConfigReader.java Sets default value for redact-password property
src/main/java/com/hivemq/extensions/log/mqtt/message/util/MessageLogUtil.java Implements password redaction logic in logConnect method
src/main/java/com/hivemq/extensions/log/mqtt/message/interceptor/ConnectInboundInterceptorImpl.java Passes redactPassword parameter to logging utility
src/main/java/com/hivemq/extensions/log/mqtt/message/interceptor/ConnectDisconnectEventListener.java Passes redactPassword parameter to logging utility
src/main/java/com/hivemq/extensions/log/mqtt/message/initializer/ClientInitializerImpl.java Passes redactPassword config to interceptor
src/main/java/com/hivemq/extensions/log/mqtt/message/initializer/ClientInitializerImpl4_2.java Passes redactPassword config to event listener and interceptor
src/main/resources/config.xsd Adds redact-password element to XSD schema
src/test/java/com/hivemq/extensions/log/mqtt/message/util/MessageLogUtilTest.java Adds test coverage for password redaction scenarios
src/test/java/com/hivemq/extensions/log/mqtt/message/config/ExtensionConfigReaderTest.java Updates tests to verify redact-password default value
src/integrationTest/java/com/hivemq/extensions/log/FullConfigRedactPasswordIT.java Adds integration tests for redact-password functionality
src/integrationTest/java/com/hivemq/extensions/log/FullConfigXmlRedactPasswordIT.java Adds XML-based integration tests for redact-password functionality
src/integrationTest/resources/fullConfigRedactPassword.xml Adds test configuration file with redact-password enabled
src/integrationTest/resources/fullConfigRedactPassword.properties Adds test properties file with redact-password enabled
src/integrationTest/resources/fullConfig*.xml Updates existing config files with redact-password default
src/integrationTest/resources/fullConfig*.properties Updates existing property files with redact-password default
src/hivemq-extension/conf/examples/config.xml Updates example configuration with redact-password option
README.adoc Documents the new redact-password configuration option

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@Donnerbart Donnerbart force-pushed the feature/nopasswordinverbose branch from 1a338f6 to 0adec2c Compare October 28, 2025 09:59
@Donnerbart Donnerbart changed the title Feature/nopasswordinverbose Add feature to redact logged passwords Oct 28, 2025
@Donnerbart Donnerbart force-pushed the feature/nopasswordinverbose branch 2 times, most recently from d7804c1 to 0adec2c Compare October 28, 2025 10:24
@Donnerbart
Copy link
Contributor

Implemented via #139

@Donnerbart Donnerbart closed this Oct 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants