Skip to content

fix: use the jcifs 3.x property names for NTLM parameters and SMB1 logging #205

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

Merged
marevol merged 1 commit into from
Sep 10, 2026
Merged

fix: use the jcifs 3.x property names for NTLM parameters and SMB1 logging #205

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 7 additions & 4 deletions ...r/src/main/java/org/codelibs/fess/crawler/client/http/config/WebAuthenticationConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,11 +238,14 @@ public void setFormParameters(final Map<String, String> formParameters) {
*
* <p>Supported parameters include:</p>
* <ul>
* <li>jcifs.smb.client.SO_SNDBUF - TCP send buffer size</li>
* <li>jcifs.smb.client.SO_RCVBUF - TCP receive buffer size</li>
* <li>jcifs.smb.client.domain - Default domain</li>
* <li>And other jcifs.* properties</li>
* <li>jcifs.client.domain - Default domain</li>
* <li>jcifs.client.snd_buf_size - TCP send buffer size</li>
* <li>jcifs.client.rcv_buf_size - TCP receive buffer size</li>
* <li>And other jcifs.* properties read by PropertyConfiguration</li>
* </ul>
*
* <p>jcifs 3.0.0 dropped the .smb segment from every key, so the 2.x
* spelling jcifs.smb.client.* is ignored without error.</p>
*/
private Map<String, String> ntlmParameters;

Expand Down
2 changes: 1 addition & 1 deletion fess-crawler/src/main/java/org/codelibs/fess/crawler/client/smb1/SmbClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ public class SmbClient extends AbstractCrawlerClient {
public static final String SMB_OWNER_ATTRIBUTES = "smb1OwnerAttributes";

static {
if (Config.getInt("jcifs.smb1.util.loglevel", -1) == -1) {
if (Config.getInt("jcifs.util.loglevel", -1) == -1) {
if (logger.isTraceEnabled()) {
LogStream.setLevel(4);
} else if (logger.isDebugEnabled()) {
Expand Down
6 changes: 3 additions & 3 deletions ...wler/src/test/java/org/codelibs/fess/crawler/client/http/Hc4HttpClientAuthConfigTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ public void test_convertFromConfig_ntlm_withParameters() {
config.setCredentials(credentials);

Map<String, String> ntlmParams = new HashMap<>();
ntlmParams.put("jcifs.smb.client.domain", "TESTDOMAIN");
ntlmParams.put("jcifs.smb.client.SO_SNDBUF", "65535");
ntlmParams.put("jcifs.client.domain", "TESTDOMAIN");
ntlmParams.put("jcifs.client.snd_buf_size", "65535");
config.setNtlmParameters(ntlmParams);

WebAuthenticationConfig[] configs = new WebAuthenticationConfig[] { config };
Expand Down Expand Up @@ -180,7 +180,7 @@ public void test_convertFromConfig_multipleConfigs_withNtlm() {
ntlmConfig.setCredentials(ntlmCredentials);

Map<String, String> ntlmParams = new HashMap<>();
ntlmParams.put("jcifs.smb.client.domain", "NTLMDOMAIN");
ntlmParams.put("jcifs.client.domain", "NTLMDOMAIN");
ntlmConfig.setNtlmParameters(ntlmParams);

WebAuthenticationConfig[] configs = new WebAuthenticationConfig[] { basicConfig, ntlmConfig };
Expand Down
32 changes: 16 additions & 16 deletions ...wler/src/test/java/org/codelibs/fess/crawler/client/http/Hc5HttpClientAuthConfigTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ public void test_convertFromConfig_ntlm_withParameters() {
config.setCredentials(credentials);

Map<String, String> ntlmParams = new HashMap<>();
ntlmParams.put("jcifs.smb.client.domain", "TESTDOMAIN");
ntlmParams.put("jcifs.smb.client.SO_SNDBUF", "65535");
ntlmParams.put("jcifs.client.domain", "TESTDOMAIN");
ntlmParams.put("jcifs.client.snd_buf_size", "65535");
config.setNtlmParameters(ntlmParams);

WebAuthenticationConfig[] configs = new WebAuthenticationConfig[] { config };
Expand Down Expand Up @@ -184,7 +184,7 @@ public void test_convertFromConfig_multipleConfigs_withNtlm() {
ntlmConfig.setCredentials(ntlmCredentials);

Map<String, String> ntlmParams = new HashMap<>();
ntlmParams.put("jcifs.smb.client.domain", "NTLMDOMAIN");
ntlmParams.put("jcifs.client.domain", "NTLMDOMAIN");
ntlmConfig.setNtlmParameters(ntlmParams);

WebAuthenticationConfig[] configs = new WebAuthenticationConfig[] { basicConfig, ntlmConfig };
Expand Down Expand Up @@ -328,8 +328,8 @@ public void test_collectNtlmParameters_withWebAuthenticationConfig_ntlmWithParam
config.setCredentials(credentials);

Map<String, String> ntlmParams = new HashMap<>();
ntlmParams.put("jcifs.smb.client.domain", "TESTDOMAIN");
ntlmParams.put("jcifs.smb.client.SO_SNDBUF", "65535");
ntlmParams.put("jcifs.client.domain", "TESTDOMAIN");
ntlmParams.put("jcifs.client.snd_buf_size", "65535");
config.setNtlmParameters(ntlmParams);

Map<String, Object> params = new HashMap<>();
Expand All @@ -339,8 +339,8 @@ public void test_collectNtlmParameters_withWebAuthenticationConfig_ntlmWithParam
Properties result = httpClient.collectNtlmParameters();

assertNotNull(result);
assertEquals("TESTDOMAIN", result.getProperty("jcifs.smb.client.domain"));
assertEquals("65535", result.getProperty("jcifs.smb.client.SO_SNDBUF"));
assertEquals("TESTDOMAIN", result.getProperty("jcifs.client.domain"));
assertEquals("65535", result.getProperty("jcifs.client.snd_buf_size"));
}

@Test
Expand Down Expand Up @@ -441,8 +441,8 @@ public void test_collectNtlmParameters_multipleNtlmConfigs_mergesParams() {
config1.setCredentials(credentials1);

Map<String, String> ntlmParams1 = new HashMap<>();
ntlmParams1.put("jcifs.smb.client.domain", "DOMAIN1");
ntlmParams1.put("jcifs.smb.client.SO_SNDBUF", "65535");
ntlmParams1.put("jcifs.client.domain", "DOMAIN1");
ntlmParams1.put("jcifs.client.snd_buf_size", "65535");
config1.setNtlmParameters(ntlmParams1);

// Second NTLM config with different params
Expand All @@ -459,8 +459,8 @@ public void test_collectNtlmParameters_multipleNtlmConfigs_mergesParams() {
config2.setCredentials(credentials2);

Map<String, String> ntlmParams2 = new HashMap<>();
ntlmParams2.put("jcifs.smb.client.domain", "DOMAIN2"); // Overrides DOMAIN1
ntlmParams2.put("jcifs.smb.client.SO_RCVBUF", "32768");
ntlmParams2.put("jcifs.client.domain", "DOMAIN2"); // Overrides DOMAIN1
ntlmParams2.put("jcifs.client.rcv_buf_size", "32768");
config2.setNtlmParameters(ntlmParams2);

Map<String, Object> params = new HashMap<>();
Expand All @@ -471,9 +471,9 @@ public void test_collectNtlmParameters_multipleNtlmConfigs_mergesParams() {

assertNotNull(result);
// Later config overrides earlier
assertEquals("DOMAIN2", result.getProperty("jcifs.smb.client.domain"));
assertEquals("65535", result.getProperty("jcifs.smb.client.SO_SNDBUF"));
assertEquals("32768", result.getProperty("jcifs.smb.client.SO_RCVBUF"));
assertEquals("DOMAIN2", result.getProperty("jcifs.client.domain"));
assertEquals("65535", result.getProperty("jcifs.client.snd_buf_size"));
assertEquals("32768", result.getProperty("jcifs.client.rcv_buf_size"));
}

@Test
Expand Down Expand Up @@ -504,7 +504,7 @@ public void test_collectNtlmParameters_mixedConfigs() {
ntlmConfig.setCredentials(ntlmCredentials);

Map<String, String> ntlmParams = new HashMap<>();
ntlmParams.put("jcifs.smb.client.domain", "NTLMDOMAIN");
ntlmParams.put("jcifs.client.domain", "NTLMDOMAIN");
ntlmConfig.setNtlmParameters(ntlmParams);

Map<String, Object> params = new HashMap<>();
Expand All @@ -514,7 +514,7 @@ public void test_collectNtlmParameters_mixedConfigs() {
Properties result = httpClient.collectNtlmParameters();

assertNotNull(result);
assertEquals("NTLMDOMAIN", result.getProperty("jcifs.smb.client.domain"));
assertEquals("NTLMDOMAIN", result.getProperty("jcifs.client.domain"));
assertEquals(1, result.size());
}
}
14 changes: 7 additions & 7 deletions fess-crawler/src/test/java/org/codelibs/fess/crawler/client/http/Hc5HttpClientTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ public void test_init_withNtlmAuthenticationConfig() {
config.setCredentials(credentials);

Map<String, String> ntlmParams = new HashMap<>();
ntlmParams.put("jcifs.smb.client.domain", "TESTDOMAIN");
ntlmParams.put("jcifs.client.domain", "TESTDOMAIN");
config.setNtlmParameters(ntlmParams);

Map<String, Object> params = new HashMap<>();
Expand Down Expand Up @@ -345,7 +345,7 @@ public void test_init_withMultipleNtlmConfigs() {
config1.setCredentials(credentials1);

Map<String, String> ntlmParams1 = new HashMap<>();
ntlmParams1.put("jcifs.smb.client.domain", "DOMAIN1");
ntlmParams1.put("jcifs.client.domain", "DOMAIN1");
config1.setNtlmParameters(ntlmParams1);

WebAuthenticationConfig config2 = new WebAuthenticationConfig();
Expand All @@ -361,7 +361,7 @@ public void test_init_withMultipleNtlmConfigs() {
config2.setCredentials(credentials2);

Map<String, String> ntlmParams2 = new HashMap<>();
ntlmParams2.put("jcifs.smb.client.domain", "DOMAIN2");
ntlmParams2.put("jcifs.client.domain", "DOMAIN2");
config2.setNtlmParameters(ntlmParams2);

Map<String, Object> params = new HashMap<>();
Expand Down Expand Up @@ -405,7 +405,7 @@ public void test_init_withMixedAuthConfigs() {
ntlmConfig.setCredentials(ntlmCredentials);

Map<String, String> ntlmParams = new HashMap<>();
ntlmParams.put("jcifs.smb.client.domain", "NTLMDOMAIN");
ntlmParams.put("jcifs.client.domain", "NTLMDOMAIN");
ntlmConfig.setNtlmParameters(ntlmParams);

Map<String, Object> params = new HashMap<>();
Expand Down Expand Up @@ -441,7 +441,7 @@ public void test_init_withNtlmConfig_setsCustomAuthenticationStrategy() {
config.setCredentials(credentials);

Map<String, String> ntlmParams = new HashMap<>();
ntlmParams.put("jcifs.smb.client.domain", "TESTDOMAIN");
ntlmParams.put("jcifs.client.domain", "TESTDOMAIN");
config.setNtlmParameters(ntlmParams);

Map<String, Object> params = new HashMap<>();
Expand Down Expand Up @@ -545,7 +545,7 @@ public void test_init_withNtlmConfig_multipleHosts() {
config1.setCredentials(credentials1);

Map<String, String> ntlmParams1 = new HashMap<>();
ntlmParams1.put("jcifs.smb.client.domain", "DOMAIN1");
ntlmParams1.put("jcifs.client.domain", "DOMAIN1");
config1.setNtlmParameters(ntlmParams1);

WebAuthenticationConfig config2 = new WebAuthenticationConfig();
Expand All @@ -562,7 +562,7 @@ public void test_init_withNtlmConfig_multipleHosts() {
config2.setCredentials(credentials2);

Map<String, String> ntlmParams2 = new HashMap<>();
ntlmParams2.put("jcifs.smb.client.domain", "DOMAIN2");
ntlmParams2.put("jcifs.client.domain", "DOMAIN2");
config2.setNtlmParameters(ntlmParams2);

Map<String, Object> params = new HashMap<>();
Expand Down
8 changes: 4 additions & 4 deletions ...rc/test/java/org/codelibs/fess/crawler/client/http/Hc5NtlmAuthenticationStrategyTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ public void test_init_withNtlmConfig_setsCustomAuthenticationStrategy() throws E
config.setCredentials(credentials);

Map<String, String> ntlmParams = new HashMap<>();
ntlmParams.put("jcifs.smb.client.domain", "TESTDOMAIN");
ntlmParams.put("jcifs.client.domain", "TESTDOMAIN");
config.setNtlmParameters(ntlmParams);

Map<String, Object> params = new HashMap<>();
Expand Down Expand Up @@ -284,7 +284,7 @@ public void test_init_withMultipleAuthConfigsIncludingNtlm() throws Exception {
ntlmConfig.setCredentials(ntlmCredentials);

Map<String, String> ntlmParams = new HashMap<>();
ntlmParams.put("jcifs.smb.client.domain", "NTLMDOMAIN");
ntlmParams.put("jcifs.client.domain", "NTLMDOMAIN");
ntlmConfig.setNtlmParameters(ntlmParams);

Map<String, Object> params = new HashMap<>();
Expand Down Expand Up @@ -346,7 +346,7 @@ public void test_init_withNtlmConfig_setsProxyAuthenticationStrategy() throws Ex
config.setCredentials(credentials);

Map<String, String> ntlmParams = new HashMap<>();
ntlmParams.put("jcifs.smb.client.domain", "TESTDOMAIN");
ntlmParams.put("jcifs.client.domain", "TESTDOMAIN");
config.setNtlmParameters(ntlmParams);

Map<String, Object> params = new HashMap<>();
Expand Down Expand Up @@ -386,7 +386,7 @@ public void test_init_withNtlmAndProxyConfig() throws Exception {
ntlmConfig.setCredentials(ntlmCredentials);

Map<String, String> ntlmParams = new HashMap<>();
ntlmParams.put("jcifs.smb.client.domain", "NTLMDOMAIN");
ntlmParams.put("jcifs.client.domain", "NTLMDOMAIN");
ntlmConfig.setNtlmParameters(ntlmParams);

Map<String, Object> params = new HashMap<>();
Expand Down
10 changes: 5 additions & 5 deletions ...c/test/java/org/codelibs/fess/crawler/client/http/config/WebAuthenticationConfigTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,12 +220,12 @@ public void test_ntlmParameters() {
assertNull(config.getNtlmParameters());

Map<String, String> params = new HashMap<>();
params.put("jcifs.smb.client.domain", "MYDOMAIN");
params.put("jcifs.smb.client.SO_SNDBUF", "65536");
params.put("jcifs.client.domain", "MYDOMAIN");
params.put("jcifs.client.snd_buf_size", "65536");

config.setNtlmParameters(params);
assertEquals(params, config.getNtlmParameters());
assertEquals("MYDOMAIN", config.getNtlmParameters().get("jcifs.smb.client.domain"));
assertEquals("MYDOMAIN", config.getNtlmParameters().get("jcifs.client.domain"));

config.setNtlmParameters(null);
assertNull(config.getNtlmParameters());
Expand Down Expand Up @@ -304,13 +304,13 @@ public void test_ntlmAuthConfiguration() {
config.setCredentials(credentials);

Map<String, String> ntlmParams = new HashMap<>();
ntlmParams.put("jcifs.smb.client.domain", "CORP");
ntlmParams.put("jcifs.client.domain", "CORP");
config.setNtlmParameters(ntlmParams);

assertEquals(AuthSchemeType.NTLM, config.getAuthSchemeType());
assertEquals(CredentialsType.NTLM, config.getCredentials().getType());
assertEquals("CORP", config.getCredentials().getDomain());
assertEquals("CORP", config.getNtlmParameters().get("jcifs.smb.client.domain"));
assertEquals("CORP", config.getNtlmParameters().get("jcifs.client.domain"));
}

/**
Expand Down
Loading