Skip to content
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

Jump to bottom

Fix env var password hashing for PBKDF2 #4773

Merged
merged 2 commits into from
Oct 4, 2024
Merged

Fix env var password hashing for PBKDF2 #4773

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a859cb2
Fix env password hashing for PBKDF2
terryquigleysas Oct 3, 2024
c5349de
Fix pre-existing typos
terryquigleysas Oct 3, 2024
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
20 changes: 10 additions & 10 deletions src/main/java/org/opensearch/security/support/SecurityUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,16 +96,16 @@
return in;
}

return replaceEnvVarsBC(replaceEnvVarsNonBC(replaceEnvVarsBase64(in)));
return replaceEnvVarsBC(replaceEnvVarsNonBC(replaceEnvVarsBase64(in, settings), settings), settings);
}

private static String replaceEnvVarsNonBC(String in) {
private static String replaceEnvVarsNonBC(String in, Settings settings) {
cwperks marked this conversation as resolved.
Show resolved Hide resolved
// ${env.MY_ENV_VAR}
// ${env.MY_ENV_VAR:-default}
Matcher matcher = ENV_PATTERN.matcher(in);
StringBuffer sb = new StringBuffer();
while (matcher.find()) {
final String replacement = resolveEnvVar(matcher.group(1), matcher.group(2), false);
final String replacement = resolveEnvVar(matcher.group(1), matcher.group(2), false, settings);
if (replacement != null) {
matcher.appendReplacement(sb, Matcher.quoteReplacement(replacement));
}
Expand All @@ -114,13 +114,13 @@
return sb.toString();
}

private static String replaceEnvVarsBC(String in) {
private static String replaceEnvVarsBC(String in, Settings settings) {
// ${envbc.MY_ENV_VAR}
// ${envbc.MY_ENV_VAR:-default}
Matcher matcher = ENVBC_PATTERN.matcher(in);
StringBuffer sb = new StringBuffer();
while (matcher.find()) {
final String replacement = resolveEnvVar(matcher.group(1), matcher.group(2), true);
final String replacement = resolveEnvVar(matcher.group(1), matcher.group(2), true, settings);
if (replacement != null) {
matcher.appendReplacement(sb, Matcher.quoteReplacement(replacement));
}
Expand All @@ -129,13 +129,13 @@
return sb.toString();
}

private static String replaceEnvVarsBase64(String in) {
private static String replaceEnvVarsBase64(String in, Settings settings) {
// ${envbc.MY_ENV_VAR}
// ${envbc.MY_ENV_VAR:-default}
Matcher matcher = ENVBASE64_PATTERN.matcher(in);
StringBuffer sb = new StringBuffer();
while (matcher.find()) {
final String replacement = resolveEnvVar(matcher.group(1), matcher.group(2), false);
final String replacement = resolveEnvVar(matcher.group(1), matcher.group(2), false, settings);

Check warning on line 138 in src/main/java/org/opensearch/security/support/SecurityUtils.java

View check run for this annotation

Codecov / codecov/patch

src/main/java/org/opensearch/security/support/SecurityUtils.java#L138 

Added line #L138 was not covered by tests
if (replacement != null) {
matcher.appendReplacement(
sb,
Expand All @@ -149,16 +149,16 @@

// ${env.MY_ENV_VAR}
// ${env.MY_ENV_VAR:-default}
private static String resolveEnvVar(String envVarName, String mode, boolean bc) {
private static String resolveEnvVar(String envVarName, String mode, boolean bc, Settings settings) {
final String envVarValue = System.getenv(envVarName);
if (envVarValue == null || envVarValue.isEmpty()) {
if (mode != null && mode.startsWith(":-") && mode.length() > 2) {
return bc ? Hasher.hash(mode.substring(2).toCharArray()) : mode.substring(2);
return bc ? Hasher.hash(mode.substring(2).toCharArray(), settings) : mode.substring(2);
} else {
return null;
}
} else {
return bc ? Hasher.hash(envVarValue.toCharArray()) : envVarValue;
return bc ? Hasher.hash(envVarValue.toCharArray(), settings) : envVarValue;
}
}
}
4 changes: 2 additions & 2 deletions src/main/java/org/opensearch/security/tools/SecurityAdmin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,15 +204,15 @@ public static int execute(final String[] args) throws Exception {
.longOpt("truststore-type")
.hasArg()
.argName("type")
.desc("JKS or PKCS12, if not given we use the file extension to dectect the type")
.desc("JKS or PKCS12, if not given we use the file extension to detect the type")
.build()
);
options.addOption(
Option.builder("kst")
.longOpt("keystore-type")
.hasArg()
.argName("type")
.desc("JKS or PKCS12, if not given we use the file extension to dectect the type")
.desc("JKS or PKCS12, if not given we use the file extension to detect the type")
.build()
);
// CS-ENFORCE-SINGLE
Expand Down
38 changes: 38 additions & 0 deletions src/test/java/org/opensearch/security/UtilTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,44 @@ public void testEnvReplace() {
assertTrue(checked);
}

@Test
public void testEnvReplacePBKDF2() {
Settings settings = Settings.builder().put(ConfigConstants.SECURITY_PASSWORD_HASHING_ALGORITHM, ConfigConstants.PBKDF2).build();
final PasswordHasher passwordHasherPBKDF2 = PasswordHasherFactory.createPasswordHasher(settings);
assertThat(SecurityUtils.replaceEnvVars("abv${env.MYENV}xyz", settings), is("abv${env.MYENV}xyz"));
assertThat(SecurityUtils.replaceEnvVars("abv${envbc.MYENV}xyz", settings), is("abv${envbc.MYENV}xyz"));
assertThat(SecurityUtils.replaceEnvVars("abv${env.MYENV:-tTt}xyz", settings), is("abvtTtxyz"));
assertTrue(passwordHasherPBKDF2.check("tTt".toCharArray(), SecurityUtils.replaceEnvVars("${envbc.MYENV:-tTt}", settings)));
terryquigleysas marked this conversation as resolved.
Show resolved Hide resolved
assertThat(SecurityUtils.replaceEnvVars("abv${env.MYENV:-tTt}xyz${env.MYENV:-xxx}", settings), is("abvtTtxyzxxx"));
assertTrue(SecurityUtils.replaceEnvVars("abv${env.MYENV:-tTt}xyz${envbc.MYENV:-xxx}", settings).startsWith("abvtTtxyz$3$"));
assertThat(SecurityUtils.replaceEnvVars("abv${env.MYENV:tTt}xyz", settings), is("abv${env.MYENV:tTt}xyz"));
assertThat(SecurityUtils.replaceEnvVars("abv${env.MYENV-tTt}xyz", settings), is("abv${env.MYENV-tTt}xyz"));

Map<String, String> env = System.getenv();
assertTrue(env.size() > 0);

boolean checked = false;

for (String k : env.keySet()) {
String val = System.getenv().get(k);
if (val == null || val.isEmpty()) {
continue;
}
assertThat(SecurityUtils.replaceEnvVars("abv${env." + k + "}xyz", settings), is("abv" + val + "xyz"));
assertThat(SecurityUtils.replaceEnvVars("abv${" + k + "}xyz", settings), is("abv${" + k + "}xyz"));
assertThat(SecurityUtils.replaceEnvVars("abv${env." + k + ":-k182765ggh}xyz", settings), is("abv" + val + "xyz"));
assertThat(
SecurityUtils.replaceEnvVars("abv${env." + k + "}xyzabv${env." + k + "}xyz", settings),
is("abv" + val + "xyzabv" + val + "xyz")
);
assertThat(SecurityUtils.replaceEnvVars("abv${env." + k + ":-k182765ggh}xyz", settings), is("abv" + val + "xyz"));
assertTrue(passwordHasherPBKDF2.check(val.toCharArray(), SecurityUtils.replaceEnvVars("${envbc." + k + "}", settings)));
checked = true;
}

assertTrue(checked);
}

@Test
public void testNoEnvReplace() {
Settings settings = Settings.builder().put(ConfigConstants.SECURITY_DISABLE_ENVVAR_REPLACEMENT, true).build();
Expand Down
Loading