Skip to content

Commit

Permalink
Introduce encrypted client-server protocol
Browse files Browse the repository at this point in the history
  • Loading branch information
@bwRavencl
bwRavencl committed Jan 16, 2025
1 parent 2595694 commit c2b3784
Show file tree
Hide file tree
Showing 7 changed files with 294 additions and 58 deletions.
3 changes: 2 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ it automates all the steps below and much more!
- Customizable position and colors
- Two modes of operation:
- Local
- Server to client (experimental! use only in trusted networks!)
- Client-Server (experimental! use only in trusted networks!)
- Supported gamepads:
- Xbox 360 Controller
- Xbox One Controller
Expand Down Expand Up @@ -204,6 +204,7 @@ Server-Client mode:
| ‑gamecontrollerdb | file source | adds the SDL controller mappings from the specified [file](https://github.com/gabomdq/SDL_GameControllerDB) | yes |
| ‑help | | prints the help and exits | no |
| -host | hostname / IP address | sets the host address for outgoing network connections | yes |
| -password | password | sets the password for all network connections | yes |
| -port | port number | sets the server port for all network connections | yes |
| ‑profile | file source | loads the specified profile after launch | yes |
| ‑quit | | quits the application | yes |
Expand Down
186 changes: 148 additions & 38 deletions src/main/java/de/bwravencl/controllerbuddy/gui/Main.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@
import java.nio.file.Files;
import java.nio.file.InvalidPathException;
import java.nio.file.NoSuchFileException;
import java.security.NoSuchAlgorithmException;
import java.security.SecureRandom;
import java.text.MessageFormat;
import java.util.ArrayList;
Expand All @@ -128,6 +129,7 @@
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.Random;
import java.util.ResourceBundle;
import java.util.Scanner;
import java.util.Set;
Expand Down Expand Up @@ -166,6 +168,7 @@
import javax.swing.JMenuItem;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.JPasswordField;
import javax.swing.JProgressBar;
import javax.swing.JRadioButtonMenuItem;
import javax.swing.JRootPane;
Expand All @@ -188,7 +191,10 @@
import javax.swing.event.HyperlinkEvent;
import javax.swing.filechooser.FileFilter;
import javax.swing.filechooser.FileNameExtensionFilter;
import javax.swing.text.AttributeSet;
import javax.swing.text.BadLocationException;
import javax.swing.text.DefaultFormatter;
import javax.swing.text.PlainDocument;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.OutputKeys;
Expand Down Expand Up @@ -226,6 +232,8 @@ public final class Main {
public static final boolean isWindows = Platform.getOSType() == Platform.WINDOWS;
public static final boolean isLinux = Platform.getOSType() == Platform.LINUX;
public static final boolean isMac = Platform.getOSType() == Platform.MAC;
public static final int PASSWORD_MIN_LENGTH = 6;
public static final int PASSWORD_MAX_LENGTH = 24;
public static final ResourceBundle strings = ResourceBundle.getBundle("strings");
public static final int DEFAULT_HGAP = 10;
public static final int DEFAULT_VGAP = 10;
Expand Down Expand Up @@ -287,6 +295,7 @@ public final class Main {
private static final String OPTION_HOST = "host";
private static final String OPTION_PORT = "port";
private static final String OPTION_TIMEOUT = "timeout";
private static final String OPTION_PASSWORD = "password";
private static final String OPTION_GAME_CONTROLLER_DB = "gamecontrollerdb";
private static final String OPTION_TRAY = "tray";
private static final String OPTION_SAVE = "save";
Expand Down Expand Up @@ -315,6 +324,7 @@ public final class Main {
private static final String PREFERENCES_HOST = "host";
private static final String PREFERENCES_PORT = "port";
private static final String PREFERENCES_TIMEOUT = "timeout";
private static final String PREFERENCES_PASSWORD = "password";
private static final String PREFERENCES_OVERLAY_SCALING = "overlay_scaling";
private static final String PREFERENCES_DARK_THEME = "dark_theme";
private static final String PREFERENCES_PREVENT_POWER_SAVE_MODE = "prevent_power_save_mode";
Expand Down Expand Up @@ -351,6 +361,7 @@ public final class Main {
options.addOption(OPTION_HOST, true, strings.getString("HOST_OPTION_DESCRIPTION"));
options.addOption(OPTION_PORT, true, strings.getString("PORT_OPTION_DESCRIPTION"));
options.addOption(OPTION_TIMEOUT, true, strings.getString("TIMEOUT_OPTION_DESCRIPTION"));
options.addOption(OPTION_PASSWORD, true, strings.getString("PASSWORD_OPTION_DESCRIPTION"));
options.addOption(OPTION_GAME_CONTROLLER_DB, true, strings.getString("GAME_CONTROLLER_DB_OPTION_DESCRIPTION"));
options.addOption(OPTION_TRAY, false, strings.getString("TRAY_OPTION_DESCRIPTION"));
options.addOption(OPTION_SAVE, true, strings.getString("SAVE_OPTION_DESCRIPTION"));
Expand All @@ -374,6 +385,7 @@ public final class Main {
}
}

private final Random random;
private final TaskRunner taskRunner;
private final Preferences preferences;
private final Map<VirtualAxis, JProgressBar> virtualAxisToProgressBarMap = new HashMap<>();
Expand Down Expand Up @@ -449,11 +461,17 @@ private Main(final TaskRunner taskRunner, final String cmdProfilePath, final Str

this.taskRunner = taskRunner;

try {
random = SecureRandom.getInstanceStrong();
} catch (final NoSuchAlgorithmException e) {
throw new RuntimeException(e);
}

Thread.startVirtualThread(() -> {
try (final var singleInstanceServerSocket = new ServerSocket(0, 0, InetAddress.getLoopbackAddress())) {
SINGLE_INSTANCE_LOCK_FILE.deleteOnExit();

final var randomNumber = new SecureRandom().nextInt();
final var randomNumber = random.nextInt();

try {
Files.writeString(SINGLE_INSTANCE_LOCK_FILE.toPath(),
Expand Down Expand Up @@ -1236,6 +1254,15 @@ private static boolean isValidHost(final String host) {
return host != null && !host.isBlank();
}

private static boolean isValidPassword(final String password) {
if (password == null) {
return false;
}

final var length = password.length();
return !password.isBlank() && length >= 6 && length <= 24;
}

public static void main(final String[] args) {
log.log(Level.INFO, "Launching " + Constants.APPLICATION_NAME + " " + Constants.VERSION);
log.log(Level.INFO, "Operating System: " + System.getProperty("os.name") + " "
Expand Down Expand Up @@ -1733,6 +1760,10 @@ float getOverlayScaling() {
return preferences.getFloat(PREFERENCES_OVERLAY_SCALING, DEFAULT_OVERLAY_SCALING);
}

public String getPassword() {
return preferences.get(PREFERENCES_PASSWORD, "");
}

public int getPollInterval() {
return preferences.getInt(PREFERENCES_POLL_INTERVAL, RunMode.DEFAULT_POLL_INTERVAL);
}
Expand All @@ -1746,6 +1777,10 @@ public Preferences getPreferences() {
return preferences;
}

public Random getRandom() {
return random;
}

public int getSelectedHotSwappingButtonId() {
return Math.min(Math.max(preferences.getInt(PREFERENCES_HOT_SWAPPING_BUTTON, HotSwappingButton.None.id),
HotSwappingButton.None.id), GLFW.GLFW_GAMEPAD_BUTTON_LAST);
Expand Down Expand Up @@ -1818,6 +1853,19 @@ private boolean handleNetworkCommandLineOptions(final CommandLine commandLine) {
}
}

final var password = commandLine.getOptionValue(OPTION_PASSWORD);
if (password != null) {
if (!isValidPassword(password)) {
valid = false;
GuiUtils.showMessageDialog(this, frame,
MessageFormat.format(
strings.getString("INVALID_VALUE_FOR_COMMAND_LINE_OPTION_PASSWORD_DIALOG_TEXT"),
OPTION_PASSWORD, PASSWORD_MIN_LENGTH, PASSWORD_MAX_LENGTH),
strings.getString("ERROR_DIALOG_TITLE"), JOptionPane.ERROR_MESSAGE);
}
preferences.put(PREFERENCES_PASSWORD, password);
}

return valid;
}

Expand Down Expand Up @@ -3744,6 +3792,29 @@ private static JsonContext create() {
}
}

private static final class LimitedLengthPlainDocument extends PlainDocument {

@Serial
private static final long serialVersionUID = 6672096787814740118L;

private final int limit;

private LimitedLengthPlainDocument(final int limit) {
this.limit = limit;
}

@Override
public void insertString(final int offs, final String str, final AttributeSet a) throws BadLocationException {
if (str == null) {
return;
}

if ((getLength() + str.length()) <= limit) {
super.insertString(offs, str, a);
}
}
}

private static final class ProfileFileChooser extends AbstractProfileFileChooser {

@Serial
Expand Down Expand Up @@ -3970,13 +4041,55 @@ && handleUnsavedChanges()) {
}
}

private abstract class ConnectAction extends AbstractAction {

@Serial
private static final long serialVersionUID = 3506732842101613495L;

private final boolean withHost;

private ConnectAction(final boolean withHost) {
this.withHost = withHost;
}

@Override
public void actionPerformed(final ActionEvent e) {
showConnectDialog();
}

abstract void proceed();

private void showConnectDialog() {
final var connectionSettingsPanel = new ConnectionSettingsPanel(withHost);

executeWhileVisible(() -> {
if (JOptionPane.showConfirmDialog(frame, connectionSettingsPanel,
strings.getString("CONNECT_DIALOG_TITLE"), JOptionPane.OK_CANCEL_OPTION,
JOptionPane.PLAIN_MESSAGE) == JOptionPane.OK_OPTION) {
final var errorMessage = connectionSettingsPanel.saveSettings();

if (errorMessage == null) {
proceed();
} else {
GuiUtils.showMessageDialog(main, frame, errorMessage, strings.getString("ERROR_DIALOG_TITLE"),
JOptionPane.ERROR_MESSAGE);
showConnectDialog();
}
}
});
}
}

private class ConnectionSettingsPanel extends JPanel {

@Serial
private static final long serialVersionUID = 2959405425250777631L;

private static final int TEXT_FIELD_COLUMNS = 15;

private final JSpinner portSpinner;
private final JSpinner timeoutSpinner;
private final JPasswordField passwordPasswordField;
private JTextField hostTextField;

private ConnectionSettingsPanel(final boolean withHost) {
Expand All @@ -3991,7 +4104,7 @@ private ConnectionSettingsPanel(final boolean withHost) {
hostPanel.add(hostLabel);

final var host = getHost();
hostTextField = new JTextField(host, 15);
hostTextField = new JTextField(new LimitedLengthPlainDocument(64), host, TEXT_FIELD_COLUMNS);
hostTextField.setCaretPosition(0);
hostPanel.add(hostTextField);

Expand Down Expand Up @@ -4026,21 +4139,41 @@ private ConnectionSettingsPanel(final boolean withHost) {
((DefaultFormatter) timeoutSpinnerEditor.getTextField().getFormatter()).setCommitsOnValidEdit(true);
timeoutSpinner.setEditor(timeoutSpinnerEditor);
timeoutPanel.add(timeoutSpinner);

final var passwordPanel = new JPanel(DEFAULT_FLOW_LAYOUT);
add(passwordPanel);

final var passwordLabel = new JLabel(strings.getString("PASSWORD_LABEL"));
passwordLabel.setPreferredSize(CONNECTION_SETTINGS_LABEL_DIMENSION);
passwordPanel.add(passwordLabel);

final var password = getPassword();
passwordPasswordField = new JPasswordField(new LimitedLengthPlainDocument(PASSWORD_MAX_LENGTH), password,
TEXT_FIELD_COLUMNS);
passwordPasswordField.setCaretPosition(0);
passwordPanel.add(passwordPasswordField);
}

private boolean saveSettings() {
private String saveSettings() {
if (hostTextField != null) {
final var host = hostTextField.getText().strip();
if (!isValidHost(host)) {
return false;
return strings.getString("NO_HOST_ADDRESS_ERROR_DIALOG_TEXT");
}
preferences.put(PREFERENCES_HOST, host);
}

preferences.putInt(PREFERENCES_PORT, (int) portSpinner.getValue());
preferences.putInt(PREFERENCES_TIMEOUT, (int) timeoutSpinner.getValue());

return true;
final var password = new String(passwordPasswordField.getPassword());
if (!isValidPassword(password)) {
return MessageFormat.format(strings.getString("INVALID_PASSWORD_ERROR_DIALOG_TEXT"),
PASSWORD_MIN_LENGTH, PASSWORD_MAX_LENGTH);
}
preferences.put(PREFERENCES_PASSWORD, password);

return null;
}
}

Expand Down Expand Up @@ -4492,37 +4625,21 @@ public void actionPerformed(final ActionEvent actionEvent) {
}
}

private final class StartClientAction extends AbstractAction {
private final class StartClientAction extends ConnectAction {

@Serial
private static final long serialVersionUID = 3975574941559749481L;

private StartClientAction() {
super(true);

putValue(NAME, strings.getString("START_CLIENT_ACTION_NAME"));
putValue(SHORT_DESCRIPTION, strings.getString("START_CLIENT_ACTION_DESCRIPTION"));
}

@Override
public void actionPerformed(final ActionEvent e) {
showConnectDialog();
}

private void showConnectDialog() {
final var connectionSettingsPanel = new ConnectionSettingsPanel(true);

executeWhileVisible(() -> {
if (JOptionPane.showConfirmDialog(frame, connectionSettingsPanel,
strings.getString("CONNECT_DIALOG_TITLE"), JOptionPane.OK_CANCEL_OPTION,
JOptionPane.PLAIN_MESSAGE) == JOptionPane.OK_OPTION) {
if (connectionSettingsPanel.saveSettings()) {
startClient();
} else {
GuiUtils.showMessageDialog(main, frame, strings.getString("NO_HOST_ADDRESS_ERROR_DIALOG_TEXT"),
strings.getString("ERROR_DIALOG_TITLE"), JOptionPane.ERROR_MESSAGE);
showConnectDialog();
}
}
});
void proceed() {
startClient();
}
}

Expand All @@ -4542,28 +4659,21 @@ public void actionPerformed(final ActionEvent e) {
}
}

private final class StartServerAction extends AbstractAction {
private final class StartServerAction extends ConnectAction {

@Serial
private static final long serialVersionUID = 1758447420975631146L;

private StartServerAction() {
super(false);

putValue(NAME, strings.getString("START_SERVER_ACTION_NAME"));
putValue(SHORT_DESCRIPTION, strings.getString("START_SERVER_ACTION_DESCRIPTION"));
}

@Override
public void actionPerformed(final ActionEvent e) {
final var connectionSettingsPanel = new ConnectionSettingsPanel(false);

executeWhileVisible(() -> {
if (JOptionPane.showConfirmDialog(frame, connectionSettingsPanel,
strings.getString("CONNECT_DIALOG_TITLE"), JOptionPane.OK_CANCEL_OPTION,
JOptionPane.PLAIN_MESSAGE) == JOptionPane.OK_OPTION) {
connectionSettingsPanel.saveSettings();
startServer();
}
});
void proceed() {
startServer();
}
}

Expand Down
Loading

0 comments on commit c2b3784

Please sign in to comment.