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

[ELY-2805] Revert "[ELY-2547] Add Elytron Tool option to overwrite CLI script" #2191

Merged
merged 1 commit into from
Sep 17, 2024
Merged

[ELY-2805] Revert "[ELY-2547] Add Elytron Tool option to overwrite CLI script" #2191

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
1 change: 0 additions & 1 deletion tool/src/main/java/org/wildfly/security/tool/Command.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -498,7 +498,6 @@ class Params {
static final String SILENT_PARAM = "silent";
static final String STORE_LOCATION_PARAM = "location";
static final String SUMMARY_PARAM = "summary";
static final String OVERWRITE_SCRIPT_FILE = "overwrite-script-file";

// Other constants
static final Pattern BOOLEAN_ARG_REGEX = Pattern.compile("(true|false)", Pattern.CASE_INSENSITIVE | Pattern.UNICODE_CASE);
Expand Down
3 changes: 0 additions & 3 deletions tool/src/main/java/org/wildfly/security/tool/ElytronToolMessages.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -589,9 +589,6 @@ public interface ElytronToolMessages extends BasicLogger {
@Message(id = NONE, value = "Provides a detailed summary of all operations performed, once the command finishes.")
String cmdFileSystemRealmSummaryDesc();

@Message(id = NONE, value = "Whether the cli script file will be overwritten, if attempting to write to an existing file.")
String cmdFileSystemRealmOverwriteCliScriptFileDesc();

@Message(id = NONE, value = "No users file specified. Please use either --bulk-convert <file> or specify a users file using --users-file <file>")
MissingOptionException missingUsersFile();

Expand Down
45 changes: 10 additions & 35 deletions tool/src/main/java/org/wildfly/security/tool/FileSystemEncryptRealmCommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
*/
package org.wildfly.security.tool;

import static org.wildfly.security.tool.Params.BOOLEAN_PARAM;
import static org.wildfly.security.tool.Params.BULK_CONVERT_PARAM;
import static org.wildfly.security.tool.Params.CREATE_CREDENTIAL_STORE_PARAM;
import static org.wildfly.security.tool.Params.CREDENTIAL_STORE_LOCATION_PARAM;
Expand All @@ -39,7 +38,6 @@
import static org.wildfly.security.tool.Params.LINE_SEPARATOR;
import static org.wildfly.security.tool.Params.NAME_PARAM;
import static org.wildfly.security.tool.Params.OUTPUT_LOCATION_PARAM;
import static org.wildfly.security.tool.Params.OVERWRITE_SCRIPT_FILE;
import static org.wildfly.security.tool.Params.PASSWORD_ENV_PARAM;
import static org.wildfly.security.tool.Params.PASSWORD_PARAM;
import static org.wildfly.security.tool.Params.REALM_NAME_PARAM;
Expand Down Expand Up @@ -178,10 +176,6 @@ class FileSystemEncryptRealmCommand extends Command {
option.setArgName(FILE_PARAM);
options.addOption(option);

option = new Option("w", OVERWRITE_SCRIPT_FILE, true, ElytronToolMessages.msg.cmdFileSystemRealmOverwriteCliScriptFileDesc());
option.setArgName(BOOLEAN_PARAM);
options.addOption(option);

option = Option.builder().longOpt(HELP_PARAM).desc(ElytronToolMessages.msg.cmdLineHelp()).build();
options.addOption(option);

Expand Down Expand Up @@ -214,7 +208,6 @@ private static final class Descriptor {
private Boolean encoded;
private Boolean createCredentialStore;
private Boolean populate;
private Boolean overwriteScriptFile;
Descriptor() {
}

Expand All @@ -237,7 +230,6 @@ private static final class Descriptor {
this.createCredentialStore = descriptor.createCredentialStore;
this.secretKeyAlias = descriptor.secretKeyAlias;
this.populate = descriptor.populate;
this.overwriteScriptFile = descriptor.overwriteScriptFile;
}

public Encoding getHashEncoding() {
Expand Down Expand Up @@ -370,14 +362,6 @@ void setKeyPairAlias(String keyPairAlias) {
this.keyPairAlias = keyPairAlias;
}

public Boolean getOverwriteScriptFile() {
return overwriteScriptFile;
}

public void setOverwriteScriptFile(Boolean overwriteScriptFile) {
this.overwriteScriptFile = overwriteScriptFile;
}

void reset() {
this.inputRealmLocation = null;
this.outputRealmLocation = null;
Expand All @@ -395,7 +379,6 @@ void reset() {
this.encoded = null;
this.levels = null;
this.populate = null;
this.overwriteScriptFile = null;
}
}

Expand Down Expand Up @@ -441,7 +424,6 @@ public void execute(String[] args) throws Exception {
String encodedOption = cmdLine.getOptionValue("f");
String bulkConvert = cmdLine.getOptionValue("b");
String populateOption = cmdLine.getOptionValue("p");
String overwriteScriptFileOption = cmdLine.getOptionValue("w");

if (bulkConvert == null) {
if (realmNameOption == null) {
Expand Down Expand Up @@ -491,9 +473,6 @@ public void execute(String[] args) throws Exception {
} else {
descriptor.setPopulate(Boolean.valueOf(populateOption));
}
if (overwriteScriptFileOption != null) {
descriptor.setOverwriteScriptFile(Boolean.valueOf(overwriteScriptFileOption));
}

if (levelsOption == null) {
descriptor.setLevels(DEFAULT_LEVELS);
Expand Down Expand Up @@ -949,7 +928,6 @@ private void createWildFlyScript() throws Exception {
String keyStoreType = descriptor.getKeyStoreType();
char[] password = descriptor.getPassword();
String keyPairAlias = descriptor.getKeyPairAlias();
Boolean overwriteScript = descriptor.getOverwriteScriptFile();

if (hashCharset == null) {
hashCharset = StandardCharsets.UTF_8;
Expand All @@ -964,20 +942,17 @@ private void createWildFlyScript() throws Exception {

Path scriptPath = Paths.get(String.format("%s/%s.cli", outputRealmLocation, fileSystemRealmName));

if (overwriteScript == null) {
if (scriptPath.toFile().exists()) {
createScriptCheck = prompt(
true,
ElytronToolMessages.msg.shouldFileBeOverwritten(scriptPath.toString()),
false,
null
);
if (createScriptCheck.trim().isEmpty()) createScriptCheck = "n";
}

overwriteScript = createScriptCheck.isEmpty() || createScriptCheck.toLowerCase().startsWith("y");
if (scriptPath.toFile().exists()) {
createScriptCheck = prompt(
true,
ElytronToolMessages.msg.shouldFileBeOverwritten(scriptPath.toString()),
false,
null
);
if (createScriptCheck.trim().isEmpty()) createScriptCheck = "n";
}

boolean overwriteScript = createScriptCheck.isEmpty() || createScriptCheck.toLowerCase().startsWith("y");
if (!overwriteScript) { // Generate a random file for the CLI script
do {
scriptPath = Paths.get(String.format("%s/%s.cli",
Expand Down Expand Up @@ -1031,7 +1006,7 @@ private void createWildFlyScript() throws Exception {
if (overwriteScript) { // Create a new script file, or overwrite the existing one
Files.write(scriptPath, scriptLines, StandardOpenOption.CREATE, StandardOpenOption.TRUNCATE_EXISTING);
} else {
Files.write(scriptPath, scriptLines, StandardOpenOption.CREATE);
Files.write(scriptPath, scriptLines, StandardOpenOption.APPEND);
}
counter++;
}
Expand Down
42 changes: 10 additions & 32 deletions tool/src/main/java/org/wildfly/security/tool/FileSystemRealmIntegrityCommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@
import static org.wildfly.security.tool.Params.NAME_PARAM;
import static org.wildfly.security.tool.Params.NUMBER_PARAM;
import static org.wildfly.security.tool.Params.OUTPUT_LOCATION_PARAM;
import static org.wildfly.security.tool.Params.OVERWRITE_SCRIPT_FILE;
import static org.wildfly.security.tool.Params.PASSWORD_ENV_PARAM;
import static org.wildfly.security.tool.Params.PASSWORD_PARAM;
import static org.wildfly.security.tool.Params.REALM_NAME_PARAM;
Expand Down Expand Up @@ -161,9 +160,6 @@ public class FileSystemRealmIntegrityCommand extends Command {
options.addOption(Option.builder("b").longOpt(BULK_CONVERT_PARAM).desc(ElytronToolMessages.msg.cmdFileSystemRealmIntegrityBulkConvertDesc())
.hasArg().argName(FILE_PARAM)
.build());
options.addOption(Option.builder("w").longOpt(OVERWRITE_SCRIPT_FILE).desc(ElytronToolMessages.msg.cmdFileSystemRealmOverwriteCliScriptFileDesc())
.hasArg().argName(BOOLEAN_PARAM)
.build());

// General options
options.addOption(Option.builder("h").longOpt(HELP_PARAM).desc(ElytronToolMessages.msg.cmdLineHelp())
Expand Down Expand Up @@ -192,7 +188,6 @@ private static final class Descriptor {
private Encoding hashEncoding;
private Charset hashCharset;
private Boolean encoded;
private Boolean overwriteScriptFile;

private Boolean upgradeInPlace;
private Boolean missingRequiredValue;
Expand Down Expand Up @@ -220,7 +215,6 @@ private static final class Descriptor {
this.hashEncoding = descriptor.hashEncoding;
this.hashCharset = descriptor.hashCharset;
this.encoded = descriptor.encoded;
this.overwriteScriptFile = descriptor.overwriteScriptFile;

this.upgradeInPlace = descriptor.upgradeInPlace;
this.missingRequiredValue = descriptor.missingRequiredValue;
Expand Down Expand Up @@ -331,9 +325,6 @@ public Boolean getMissingRequiredValue() {
public Boolean getRealmUpgraded() {
return realmUpgraded;
}
public Boolean getOverwriteScriptFile() {
return overwriteScriptFile;
}

public void setInputRealmPath(String inputRealmPath) {
setInputRealmPath(Paths.get(inputRealmPath).normalize().toAbsolutePath());
Expand Down Expand Up @@ -422,9 +413,6 @@ public void setMissingRequiredValue() {
public void setRealmUpgraded() {
this.realmUpgraded = true;
}
public void setOverwriteScriptFile(Boolean overwriteScriptFile) {
this.overwriteScriptFile = overwriteScriptFile;
}

void reset(boolean resetMissingValues) {
// Required values are set to null if contents are null, or equal "MISSING"
Expand All @@ -443,7 +431,6 @@ void reset(boolean resetMissingValues) {
hashEncoding = null;
hashCharset = null;
encoded = null;
overwriteScriptFile = null;

upgradeInPlace = false;
realmUpgraded = false;
Expand Down Expand Up @@ -492,7 +479,6 @@ public void execute(String[] args) throws Exception {
String hashCharsetOption = cmdLine.getOptionValue("u");
String encodedOption = cmdLine.getOptionValue("f");
String bulkConvertOption = cmdLine.getOptionValue("b");
String overwriteScriptFileOption = cmdLine.getOptionValue("w");

if (bulkConvertOption == null) {
if (summaryMode) {
Expand Down Expand Up @@ -591,10 +577,6 @@ public void execute(String[] args) throws Exception {
descriptor.setEncoded(Boolean.parseBoolean(encodedOption));
}

if (overwriteScriptFileOption != null) {
descriptor.setOverwriteScriptFile(Boolean.valueOf(overwriteScriptFileOption));
}

descriptors.add(descriptor);
findMissingRequiredValuesAndSetValues(0, descriptor);
} else if (nonBulkConvertOptionSet(inputRealmPathOption, outputRealmPathOption, realmNameOption, keyStorePathOption,
Expand Down Expand Up @@ -973,26 +955,22 @@ private void createWildFlyScript() throws Exception {
String fileSystemRealmName = descriptor.getFileSystemRealmName();
Path outputRealmPath = descriptor.getOutputRealmPath();
boolean upgradeInPlace = descriptor.getUpgradeInPlace();
Boolean overwriteScript = descriptor.getOverwriteScriptFile();

String createScriptCheck = "";
Path scriptPath = Paths.get(String.format("%s/%s.cli", outputRealmPath, fileSystemRealmName));

if (overwriteScript == null) {
// Ask to overwrite CLI script, if already exists
if(scriptPath.toFile().exists()) {
createScriptCheck = prompt(
true,
ElytronToolMessages.msg.shouldFileBeOverwritten(scriptPath.toString()),
false,
null
);
if (createScriptCheck.trim().isEmpty()) createScriptCheck = "n";
}

overwriteScript = createScriptCheck.isEmpty() || createScriptCheck.toLowerCase().startsWith("y");
// Ask to overwrite CLI script, if already exists
if(scriptPath.toFile().exists()) {
createScriptCheck = prompt(
true,
ElytronToolMessages.msg.shouldFileBeOverwritten(scriptPath.toString()),
false,
null
);
if (createScriptCheck.trim().isEmpty()) createScriptCheck = "n";
}

boolean overwriteScript = createScriptCheck.isEmpty() || createScriptCheck.toLowerCase().startsWith("y");
if (!overwriteScript) {
do {
scriptPath = Paths.get(String.format("%s/%s.cli",
Expand Down
50 changes: 0 additions & 50 deletions tool/src/test/java/org/wildfly/security/tool/FileSystemEncryptRealmCommandTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@
*/
package org.wildfly.security.tool;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotEquals;
import static org.junit.Assert.assertThrows;
import static org.junit.Assert.assertTrue;
import static org.wildfly.security.tool.Command.ELYTRON_KS_PASS_PROVIDERS;
Expand Down Expand Up @@ -68,12 +66,6 @@ private void runCommand(String inputLocation, String outputLocation, String file
executeCommandAndCheckStatus(requiredArgs, expectedStatus);
}

private void runCommand(String inputLocation, String outputLocation, String fileSystemRealmName, String encoded, boolean create, int expectedStatus, boolean overwriteScriptFile) {
String[] requiredArgs;
requiredArgs = new String[]{"--input-location", inputLocation, "--output-location", outputLocation, "--realm-name", fileSystemRealmName, "--encoded", encoded, "--create", String.valueOf(create), "--credential-store", CREDENTIAL_STORE_PATH, "--overwrite-script-file", String.valueOf(overwriteScriptFile)};
executeCommandAndCheckStatus(requiredArgs, expectedStatus);
}

private void runCommand(String inputLocation, String outputLocation, String fileSystemRealmName, int levels, String encoded, boolean create, int expectedStatus) {
String[] requiredArgs;
requiredArgs = new String[]{"--input-location", inputLocation, "--output-location", outputLocation, "--realm-name", fileSystemRealmName, "--levels", String.valueOf(levels), "--encoded", encoded, "--create", String.valueOf(create), "--credential-store", CREDENTIAL_STORE_PATH};
Expand Down Expand Up @@ -167,48 +159,6 @@ public void testSingleUser() throws Exception {
}
}

@Test
public void testOverwritingScriptFileTrue() throws Exception {
String outputLocation = RELATIVE_BASE_DIR + "fs-encrypted-realms";
String fileSystemRealmName = "overwrite-script-true";
String file = "target/test-classes/filesystem-encrypt/fs-encrypted-realms/overwrite-script-true.cli";

String inputLocation = RELATIVE_BASE_DIR + "fs-unencrypted-realms/single-user-with-role/";
runCommand(inputLocation, outputLocation, fileSystemRealmName, 3, "false", true, 0);

assertTrue(fileExists(file));
File scriptFile = new File(file);
Long modifiedBefore = scriptFile.lastModified();

inputLocation = RELATIVE_BASE_DIR + "fs-unencrypted-realms/single-user/";
runCommand(inputLocation, outputLocation, fileSystemRealmName, "false", true, 0, true);

Long modifiedAfter = scriptFile.lastModified();

assertNotEquals(modifiedBefore, modifiedAfter);
}

@Test
public void testOverwritingScriptFileFalse() throws Exception {
String outputLocation = RELATIVE_BASE_DIR + "fs-encrypted-realms";
String fileSystemRealmName = "overwrite-script-false";
String file = "target/test-classes/filesystem-encrypt/fs-encrypted-realms/overwrite-script-false.cli";

String inputLocation = RELATIVE_BASE_DIR + "fs-unencrypted-realms/single-user-with-role/";
runCommand(inputLocation, outputLocation, fileSystemRealmName, 3, "false", true, 0);

assertTrue(fileExists(file));
File scriptFile = new File(file);
Long modifiedBefore = scriptFile.lastModified();

inputLocation = RELATIVE_BASE_DIR + "fs-unencrypted-realms/single-user/";
runCommand(inputLocation, outputLocation, fileSystemRealmName, "false", true, 0, false);

Long modifiedAfter = scriptFile.lastModified();

assertEquals(modifiedBefore, modifiedAfter);
}

@Test
public void testSingleUserMissingParam() throws Exception {
String outputLocation = RELATIVE_BASE_DIR + "fs-encrypted-realms";
Expand Down
Loading
Loading