8000 Validate .conf extension for --config-file option by griffonbyte · Pull Request #47696 · keycloak/keycloak · GitHub
[go: up one dir, main page]
Skip to content

Validate .conf extension for --config-file option #47696

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
shawkins merged 2 commits into from
Apr 7, 2026
Merged

Validate .conf extension for --config-file option #47696

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
5e11c44
Validate .conf extension for --config-file option
griffonbyte Apr 1, 2026
68252be
fix: validate config file extension before checking existence
griffonbyte Apr 2, 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
4 changes: 4 additions & 0 deletions quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/cli/command/Main.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,10 @@ public void setProfile(String profile) {
description = "Set the path to a configuration file. By default, configuration properties are read from the \"keycloak.conf\" file in the \"conf\" directory.",
paramLabel = "file")
public void setConfigFile(String path) {
if (!path.endsWith(".conf")) {
throw new CommandLine.ParameterException(spec.commandLine(),
String.format("Configuration file specified via '%s' or '%s' must have the '.conf' extension.", CONFIG_FILE_LONG_NAME, CONFIG_FILE_SHORT_NAME));
}
if (Files.notExists(Path.of(path))) {
throw new CommandLine.ParameterException(spec.commandLine(),
String.format("File specified via '%s' or '%s' option does not exist.", CONFIG_FILE_LONG_NAME, CONFIG_FILE_SHORT_NAME));
Expand Down
5 changes: 5 additions & 0 deletions .../main/java/org/keycloak/quarkus/runtime/configuration/KeycloakPropertiesConfigSource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,11 @@ public Path getConfigurationFile() {
return null;
}

if (!filePath.endsWith(".conf")) {
throw new RuntimeException(
String.format("Configuration file '%s' must have the '.conf' extension.", filePath));
}

return Paths.get(filePath);
}
}
Expand Down
7 changes: 7 additions & 0 deletions quarkus/tests/integration/src/test/java/org/keycloak/it/cli/dist/StartCommandDistTest.java
View file
Open in desktop 8000
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,13 @@ void testInvalidConfigFileOption(CLIResult cliResult) {
cliResult.assertError(String.format("Try '%s --help' for more information on the available options.", KeycloakDistribution.SCRIPT_CMD));
}

@DryRun
@Test
@Launch({CONFIG_FILE_LONG_NAME + "=src/test/resources/keycloak.properties", "start", "--db=dev-file"})
void testConfigFileWithWrongExtension(CLIResult cliResult) {
cliResult.assertError("Configuration file specified via '--config-file' or '-cf' must have the '.conf' extension.");
}

@RawDistOnly(reason = "Containers are immutable")
@Test
void testRuntimeValuesAreNotCaptured(KeycloakDistribution dist) {
Expand Down
1 change: 1 addition & 0 deletions quarkus/tests/integration/src/test/resources/keycloak.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# test config with wrong extension
Loading
0