Skip to content

ENHACEMENTS: ManageSieve capabilities #2916

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
chibenwa wants to merge 5 commits into
base: master
Choose a base branch
from
Open

ENHACEMENTS: ManageSieve capabilities #2916

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
342a7ba
[ENHANCEMENT] ManageSieve: do not advertize STARTTLS over unencrypted…
chibenwa Jan 16, 2026
5007c8c
[ENHANCEMENT] ManageSieve: Send capabilities after STARTTLS negociati…
chibenwa Jan 16, 2026
f6a9194
[ENHANCEMENT] Use Apache James and real version in Capability IMPLEME…
chibenwa Jan 26, 2026
be0540a
fixup! [ENHANCEMENT] Use Apache James and real version in Capability …
chibenwa Jan 27, 2026
35a7cec
fixup! [ENHANCEMENT] ManageSieve: Send capabilities after STARTTLS ne…
chibenwa Jan 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .../managesieve/core/src/main/resources/org/apache/james/managesieve/scripts/capability.test
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ SUB {
S: "SASL" "PLAIN"
S: "SIEVE" ".*"
S: "STARTTLS"
S: "IMPLEMENTATION" "Apache ManageSieve v1.0"
S: "IMPLEMENTATION" "Apache James ManageSieve 3.9.0"
S: "VERSION" "1.0"
}
S: OK
Expand All @@ -32,7 +32,7 @@ SUB {
S: "SASL" "PLAIN"
S: "SIEVE" ".*"
S: "STARTTLS"
S: "IMPLEMENTATION" "Apache ManageSieve v1.0"
S: "IMPLEMENTATION" "Apache James ManageSieve 3.9.0"
S: "VERSION" "1.0"
}
S: OK
Expand All @@ -48,7 +48,7 @@ S: "OWNER" "user"
S: "SASL" "PLAIN"
S: "SIEVE" ".*"
S: "STARTTLS"
S: "IMPLEMENTATION" "Apache ManageSieve v1.0"
S: "IMPLEMENTATION" "Apache James ManageSieve 3.9.0"
S: "VERSION" "1.0"
}
S: OK
6 changes: 4 additions & 2 deletions protocols/managesieve/src/main/java/org/apache/james/managesieve/core/CoreProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ interface CommandWrapper {
String execute() throws ManageSieveException, SieveRepositoryException, IOException;
}

public static final String IMPLEMENTATION_DESCRIPTION = "Apache ManageSieve v1.0";
public static final String IMPLEMENTATION_DESCRIPTION = "Apache James ManageSieve 3.9.0";
Copy link
Contributor

@felixauringer felixauringer Jan 29, 2026

Choose a reason for hiding this comment

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

I definitely see why you put the version here but maybe it would be nice to have it as a constant somewhere? Changing it here (and probably in other places) and in many tests for every version seems cumbersome to me.

public static final String MANAGE_SIEVE_VERSION = "1.0";

private final SieveRepository sieveRepository;
Expand Down Expand Up @@ -96,6 +96,9 @@ private String convertCapabilityMapToString(Map<Capabilities, String> capabiliti

private Map<Capabilities, String> computeCapabilityMap(Session session) {
Map<Capabilities, String> capabilities = Maps.newHashMap(capabilitiesBase);
if (!session.isSslEnabled()) {
capabilities.put(Capabilities.STARTTLS, null);
}
if (session.isAuthenticated()) {
capabilities.put(Capabilities.OWNER, session.getUser().asString());
}
Expand Down Expand Up @@ -345,7 +348,6 @@ private Map<Capabilities, String> precomputedCapabilitiesBase(SieveParser parser
Map<Capabilities, String> capabilitiesBase = new HashMap<>();
capabilitiesBase.put(Capabilities.IMPLEMENTATION, IMPLEMENTATION_DESCRIPTION);
capabilitiesBase.put(Capabilities.VERSION, MANAGE_SIEVE_VERSION);
capabilitiesBase.put(Capabilities.STARTTLS, null);
if (!extensions.isEmpty()) {
capabilitiesBase.put(Capabilities.SIEVE, extensions);
}
Expand Down
4 changes: 2 additions & 2 deletions ...c/test/java/org/apache/james/transport/mailets/managesieve/ManageSieveMailetTestCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ void testCapabilityUnauthorised() throws Exception {
initializeMailet();
mailet.service(mail);
ensureResponseContains("Re: CAPABILITY", "\"SIEVE\" \"a b c\"",
"\"IMPLEMENTATION\" \"Apache ManageSieve v1.0\"",
"\"IMPLEMENTATION\" \"Apache James ManageSieve 3.9.0\"",
"\"VERSION\" \"1.0\"",
"\"STARTTLS\"",
"\"SASL\" \"PLAIN\"",
Expand All @@ -109,7 +109,7 @@ void testCapability() throws Exception {
mail.setAttribute(new Attribute(Mail.SMTP_AUTH_USER, AttributeValue.of("test")));
mailet.service(mail);
ensureResponseContains("Re: CAPABILITY", "\"SIEVE\" \"a b c\"",
"\"IMPLEMENTATION\" \"Apache ManageSieve v1.0\"",
"\"IMPLEMENTATION\" \"Apache James ManageSieve 3.9.0\"",
"\"OWNER\" \"test@localhost\"",
"\"VERSION\" \"1.0\"",
"\"STARTTLS\"",
Expand Down
11 changes: 11 additions & 0 deletions ...main/java/org/apache/james/managesieveserver/netty/ManageSieveChannelUpstreamHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception
}

Session manageSieveSession = ctx.channel().attr(NettyConstants.SESSION_ATTRIBUTE_KEY).get();
Session.State statePriorExecution = manageSieveSession.getState();
String responseString = manageSieveProcessor.handleRequest(manageSieveSession, request);
attachment.resetCumulation();
attachment.write(responseString);
Expand All @@ -92,6 +93,16 @@ public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception
manageSieveSession.setSslEnabled(true);
manageSieveSession.setState(Session.State.UNAUTHENTICATED);
attachment.stopDetectingCommandInjection();

// RFC-5804 section 1.7 returning capabilities is mandated after STARTTLS
String capabilities = manageSieveProcessor.handleRequest(manageSieveSession, "CAPABILITY");
attachment.write(capabilities);
}
if (manageSieveSession.getState() == Session.State.AUTHENTICATED &&
statePriorExecution != Session.State.AUTHENTICATED) {
// RFC-5804 section 1.7 returning capabilities is mandated after AUTH
String capabilities = manageSieveProcessor.handleRequest(manageSieveSession, "CAPABILITY");
attachment.write(capabilities);
}
} catch (NotEnoughDataException ex) {
// Do nothing will keep the cumulation
Expand Down
4 changes: 3 additions & 1 deletion ...tocols-managesieve/src/test/java/org/apache/james/managesieveserver/AuthenticateTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;

public class AuthenticateTest {
class AuthenticateTest {
private ManageSieveClient client;
private final ManageSieveServerTestSystem testSystem;

Expand Down Expand Up @@ -159,6 +159,7 @@ void doubleAuthenticationShouldFail() throws IOException {
this.client.sendCommand(command);
ManageSieveClient.ServerResponse firstAuthenticationResponse = this.client.readResponse();
Assertions.assertThat(firstAuthenticationResponse.responseType()).isEqualTo(ManageSieveClient.ResponseType.OK);
this.client.readResponse(); // Read capabilities

this.client.sendCommand(command);
ManageSieveClient.ServerResponse secondAuthenticationResponse = this.client.readResponse();
Expand Down Expand Up @@ -234,5 +235,6 @@ void authenticatePlain() throws IOException {
this.client.sendCommand("AUTHENTICATE \"PLAIN\" \"" + Base64.getEncoder().encodeToString(initialClientResponse.getBytes(StandardCharsets.UTF_8)) + "\"");
ManageSieveClient.ServerResponse authenticationResponse = this.client.readResponse();
Assertions.assertThat(authenticationResponse.responseType()).isEqualTo(ManageSieveClient.ResponseType.OK);
this.client.readResponse(); // Read capabilities
}
}