Skip to content

Feat: crypted password property #3924

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

Open
achoqt wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Feat: crypted password property #3924

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
866aecb
feat: new property to manage crypted passwords
achoqt Sep 15, 2026
83cc9a1
add a tooltip to the crypted_password property
achoqt Sep 16, 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
6 changes: 6 additions & 0 deletions app/display/model/src/main/java/org/csstudio/display/builder/model/Messages.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,15 @@ public class Messages
DisplayMode,
EmbeddedDisplayWidget_GroupName,
EnableGradient,
Encryption_NONE,
FontStyle_Bold,
FontStyle_BoldItalic,
FontStyle_Italic,
FontStyle_Regular,
GroupWidget_Description,
GroupWidget_Name,
HighlightActiveRegion,
InformativeTooltipCryptedPassword,
InformativeTooltipActions,
InformativeTooltipAlarmBorder,
InformativeTooltipHeight,
Expand Down Expand Up @@ -87,6 +89,7 @@ public class Messages
LoLoAndHiHiWarningColor,
LowAndHighWarningColor,
NeedleWidth,
Md5_Encryption,
Middle,
MinAndMaxFromPV,
NoLimitsFromPV,
Expand Down Expand Up @@ -133,6 +136,8 @@ public class Messages
Rotation_90,
ScrollBar_ShowValueTip,
ScrollBar_BarLength,
Sha256_Encryption,
Sha512_Encryption,
SlideButton_Label,
Spinner_ButtonsOnLeft,
Stripchart_Description,
Expand Down Expand Up @@ -204,6 +209,7 @@ public class Messages
WidgetProperties_CursorInfoPV,
WidgetProperties_CursorXPV,
WidgetProperties_CursorYPV,
WidgetProperties_CryptedPassword,
WidgetProperties_DataHeight,
WidgetProperties_DataWidth,
WidgetProperties_DateColor,
Expand Down
12 changes: 12 additions & 0 deletions ...l/src/main/java/org/csstudio/display/builder/model/properties/CommonWidgetProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -771,6 +771,18 @@
public static final WidgetPropertyDescriptor<String> propPassword =
newStringPropertyDescriptor(WidgetPropertyCategory.BEHAVIOR, "password", Messages.WidgetProperties_Password);

/**
* 'crypted password' property: Select the hash algorithm of the provided crypted password
*/
public static final WidgetPropertyDescriptor<CryptedPassword> propCryptedPassword =
new WidgetPropertyDescriptor<>(
WidgetPropertyCategory.BEHAVIOR, "crypted_password", Messages.WidgetProperties_CryptedPassword) {
@Override
public EnumWidgetProperty<CryptedPassword> createProperty(final Widget widget,
final CryptedPassword default_value) {

Check warning on line 782 in app/display/model/src/main/java/org/csstudio/display/builder/model/properties/CommonWidgetProperties.java

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Rename this local variable to match the regular expression '^[a-z][a-zA-Z0-9]*$'. 


See more on https://sonarcloud.io/project/issues?id=ControlSystemStudio_phoebus&issues=AaCqbOrGuC9m43L7o7sa&open=AaCqbOrGuC9m43L7o7sa&pullRequest=3924
return new EnumWidgetProperty<>(this, widget, default_value);
}
};
/**
* Runtime 'pv_value' property: Typically read from primary PV
*/
Expand Down
27 changes: 27 additions & 0 deletions ...ay/model/src/main/java/org/csstudio/display/builder/model/properties/CryptedPassword.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
package org.csstudio.display.builder.model.properties;

import org.csstudio.display.builder.model.Messages;

public enum CryptedPassword {

/** Password not crypted */
NONE(Messages.Encryption_NONE),
/** MD5 Crypted password */
MD5(Messages.Md5_Encryption),
/** SH256 Crypted password */
SHA256(Messages.Sha256_Encryption),
/** SHA512 Crypted password */
SHA512(Messages.Sha512_Encryption);
private final String label;

private CryptedPassword(final String label)
{
this.label = label;
}

@Override
public String toString()
{
return label;
}
}
12 changes: 12 additions & 0 deletions ...ay/model/src/main/java/org/csstudio/display/builder/model/widgets/ActionButtonWidget.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propBackgroundColor;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propConfirmDialog;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propConfirmMessage;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propCryptedPassword;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propEnabled;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propFont;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propForegroundColor;
Expand All @@ -24,6 +25,7 @@
import java.util.Arrays;
import java.util.List;

import org.csstudio.display.builder.model.Messages;
import org.csstudio.display.builder.model.MacroizedWidgetProperty;
import org.csstudio.display.builder.model.Version;
import org.csstudio.display.builder.model.Widget;
Expand All @@ -36,6 +38,7 @@
import org.csstudio.display.builder.model.persist.WidgetFontService;
import org.csstudio.display.builder.model.persist.XMLTags;
import org.csstudio.display.builder.model.properties.CommonWidgetProperties;
import org.csstudio.display.builder.model.properties.CryptedPassword;
import org.csstudio.display.builder.model.properties.HorizontalAlignment;
import org.csstudio.display.builder.model.properties.RotationStep;
import org.csstudio.display.builder.model.properties.VerticalAlignment;
Expand Down Expand Up @@ -237,6 +240,7 @@
private volatile WidgetProperty<Boolean> confirm_dialog;
private volatile WidgetProperty<String> confirm_message;
private volatile WidgetProperty<String> password;
private volatile WidgetProperty<CryptedPassword> cryptedPassword;

/** Constructor */
public ActionButtonWidget()
Expand Down Expand Up @@ -271,6 +275,8 @@
properties.add(confirm_dialog = propConfirmDialog.createProperty(this, false));
properties.add(confirm_message = propConfirmMessage.createProperty(this, "Are your sure you want to do this?"));
properties.add(password = propPassword.createProperty(this, ""));
properties.add(cryptedPassword = propCryptedPassword.createProperty(this, CryptedPassword.NONE));

Check warning on line 278 in app/display/model/src/main/java/org/csstudio/display/builder/model/widgets/ActionButtonWidget.java

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Extract the assignment out of this expression. 


See more on https://sonarcloud.io/project/issues?id=ControlSystemStudio_phoebus&issues=AaCqbOxXuC9m43L7o7se&open=AaCqbOxXuC9m43L7o7se&pullRequest=3924
cryptedPassword.setInformativeTooltip(Messages.InformativeTooltipCryptedPassword);
}

@Override
Expand Down Expand Up @@ -358,4 +364,10 @@
{
return password;
}

/** @return 'crypted_password' property */
public WidgetProperty<CryptedPassword> propCryptedPassword()
{
return cryptedPassword;
}
}
12 changes: 12 additions & 0 deletions ...play/model/src/main/java/org/csstudio/display/builder/model/widgets/BoolButtonWidget.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propBit;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propConfirmDialogOptions;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propConfirmMessage;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propCryptedPassword;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propEnabled;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propFont;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propForegroundColor;
Expand Down Expand Up @@ -41,6 +42,7 @@
import org.csstudio.display.builder.model.persist.NamedWidgetFonts;
import org.csstudio.display.builder.model.persist.WidgetFontService;
import org.csstudio.display.builder.model.properties.ConfirmDialog;
import org.csstudio.display.builder.model.properties.CryptedPassword;
import org.csstudio.display.builder.model.properties.EnumWidgetProperty;
import org.csstudio.display.builder.model.properties.HorizontalAlignment;
import org.csstudio.display.builder.model.properties.VerticalAlignment;
Expand Down Expand Up @@ -182,6 +184,7 @@
private volatile WidgetProperty<ConfirmDialog> confirm_dialog;
private volatile WidgetProperty<String> confirm_message;
private volatile WidgetProperty<String> password;
private volatile WidgetProperty<CryptedPassword> cryptedPassword;

/** Constructor */
public BoolButtonWidget()
Expand All @@ -200,6 +203,7 @@
protected void defineProperties(final List<WidgetProperty<?>> properties)
{
super.defineProperties(properties);

properties.add(bit = propBit.createProperty(this, 0));
properties.add(off_label = propOffLabel.createProperty(this, "Off"));
properties.add(off_color = propOffColor.createProperty(this, new WidgetColor(60, 100, 60)));
Expand All @@ -219,6 +223,8 @@
properties.add(confirm_dialog = propConfirmDialogOptions.createProperty(this, ConfirmDialog.NONE));
properties.add(confirm_message = propConfirmMessage.createProperty(this, "Are your sure you want to do this?"));
properties.add(password = propPassword.createProperty(this, ""));
properties.add(cryptedPassword = propCryptedPassword.createProperty(this, CryptedPassword.NONE));

Check warning on line 226 in app/display/model/src/main/java/org/csstudio/display/builder/model/widgets/BoolButtonWidget.java

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Extract the assignment out of this expression. 


See more on https://sonarcloud.io/project/issues?id=ControlSystemStudio_phoebus&issues=AaCqbOvnuC9m43L7o7sb&open=AaCqbOvnuC9m43L7o7sb&pullRequest=3924
cryptedPassword.setInformativeTooltip(Messages.InformativeTooltipCryptedPassword);
}

/** @return 'bit' property */
Expand Down Expand Up @@ -334,4 +340,10 @@
{
return password;
}

/** @return 'crypted_password' property */
public WidgetProperty<CryptedPassword> propCryptedPassword()
{
return cryptedPassword;
}
}
11 changes: 11 additions & 0 deletions ...isplay/model/src/main/java/org/csstudio/display/builder/model/widgets/CheckBoxWidget.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propBit;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propConfirmDialogOptions;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propConfirmMessage;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propCryptedPassword;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propEnabled;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propFont;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propForegroundColor;
Expand All @@ -30,6 +31,7 @@
import org.csstudio.display.builder.model.persist.NamedWidgetFonts;
import org.csstudio.display.builder.model.persist.WidgetFontService;
import org.csstudio.display.builder.model.properties.ConfirmDialog;
import org.csstudio.display.builder.model.properties.CryptedPassword;
import org.csstudio.display.builder.model.properties.WidgetFont;
import org.phoebus.ui.color.NamedWidgetColors;
import org.phoebus.ui.color.WidgetColor;
Expand Down Expand Up @@ -73,6 +75,7 @@
private volatile WidgetProperty<ConfirmDialog> confirm_dialog;
private volatile WidgetProperty<String> confirm_message;
private volatile WidgetProperty<String> password;
private volatile WidgetProperty<CryptedPassword> cryptedPassword;

@Override
protected void defineProperties(final List<WidgetProperty<?>> properties)
Expand All @@ -87,6 +90,8 @@
properties.add(confirm_dialog = propConfirmDialogOptions.createProperty(this, ConfirmDialog.NONE));
properties.add(confirm_message = propConfirmMessage.createProperty(this, "Are your sure you want to do this?"));
properties.add(password = propPassword.createProperty(this, ""));
properties.add(cryptedPassword = propCryptedPassword.createProperty(this, CryptedPassword.NONE));

Check warning on line 93 in app/display/model/src/main/java/org/csstudio/display/builder/model/widgets/CheckBoxWidget.java

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Extract the assignment out of this expression. 


See more on https://sonarcloud.io/project/issues?id=ControlSystemStudio_phoebus&issues=AaCqbOybuC9m43L7o7sg&open=AaCqbOybuC9m43L7o7sg&pullRequest=3924
cryptedPassword.setInformativeTooltip(Messages.InformativeTooltipCryptedPassword);
}

/** Constructor */
Expand Down Expand Up @@ -148,4 +153,10 @@
{
return password;
}

/** @return 'crypted_password' property */
public WidgetProperty<CryptedPassword> propCryptedPassword()
{
return cryptedPassword;
}
}
11 changes: 11 additions & 0 deletions ...ay/model/src/main/java/org/csstudio/display/builder/model/widgets/ChoiceButtonWidget.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propBackgroundColor;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propConfirmDialog;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propConfirmMessage;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propCryptedPassword;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propEnabled;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propFont;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propForegroundColor;
Expand All @@ -34,6 +35,7 @@
import org.csstudio.display.builder.model.persist.NamedWidgetFonts;
import org.csstudio.display.builder.model.persist.WidgetFontService;
import org.csstudio.display.builder.model.properties.CommonWidgetProperties;
import org.csstudio.display.builder.model.properties.CryptedPassword;
import org.csstudio.display.builder.model.properties.HorizontalAlignment;
import org.csstudio.display.builder.model.properties.VerticalAlignment;
import org.csstudio.display.builder.model.properties.WidgetFont;
Expand Down Expand Up @@ -77,6 +79,7 @@
private volatile WidgetProperty<Boolean> confirm_dialog;
private volatile WidgetProperty<String> confirm_message;
private volatile WidgetProperty<String> password;
private volatile WidgetProperty<CryptedPassword> cryptedPassword;

/** Constructor */
public ChoiceButtonWidget()
Expand Down Expand Up @@ -110,6 +113,8 @@
properties.add(confirm_dialog = propConfirmDialog.createProperty(this, false));
properties.add(confirm_message = propConfirmMessage.createProperty(this, "Are your sure you want to do this?"));
properties.add(password = propPassword.createProperty(this, ""));
properties.add(cryptedPassword = propCryptedPassword.createProperty(this, CryptedPassword.NONE));

Check warning on line 116 in app/display/model/src/main/java/org/csstudio/display/builder/model/widgets/ChoiceButtonWidget.java

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Extract the assignment out of this expression. 


See more on https://sonarcloud.io/project/issues?id=ControlSystemStudio_phoebus&issues=AaCqbOwwuC9m43L7o7sd&open=AaCqbOwwuC9m43L7o7sd&pullRequest=3924
cryptedPassword.setInformativeTooltip(Messages.InformativeTooltipCryptedPassword);
}

/** @return 'foreground_color' property */
Expand Down Expand Up @@ -189,4 +194,10 @@
{
return password;
}

/** @return 'crypted_password' property */
public WidgetProperty<CryptedPassword> propCryptedPassword()
{
return cryptedPassword;
}
}
11 changes: 11 additions & 0 deletions app/display/model/src/main/java/org/csstudio/display/builder/model/widgets/ComboWidget.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propBackgroundColor;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propConfirmDialog;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propConfirmMessage;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propCryptedPassword;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propEnabled;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propFont;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propForegroundColor;
Expand All @@ -36,6 +37,7 @@
import org.csstudio.display.builder.model.persist.NamedWidgetFonts;
import org.csstudio.display.builder.model.persist.WidgetFontService;
import org.csstudio.display.builder.model.properties.CommonWidgetProperties;
import org.csstudio.display.builder.model.properties.CryptedPassword;
import org.csstudio.display.builder.model.properties.StringWidgetProperty;
import org.csstudio.display.builder.model.properties.WidgetFont;
import org.phoebus.ui.color.NamedWidgetColors;
Expand Down Expand Up @@ -132,6 +134,7 @@
private volatile WidgetProperty<Boolean> confirm_dialog;
private volatile WidgetProperty<String> confirm_message;
private volatile WidgetProperty<String> password;
private volatile WidgetProperty<CryptedPassword> cryptedPassword;

/** Constructor */
public ComboWidget()
Expand All @@ -153,6 +156,8 @@
properties.add(confirm_dialog = propConfirmDialog.createProperty(this, false));
properties.add(confirm_message = propConfirmMessage.createProperty(this, "Are your sure you want to do this?"));
properties.add(password = propPassword.createProperty(this, ""));
properties.add(cryptedPassword = propCryptedPassword.createProperty(this, CryptedPassword.NONE));

Check warning on line 159 in app/display/model/src/main/java/org/csstudio/display/builder/model/widgets/ComboWidget.java

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Extract the assignment out of this expression. 


See more on https://sonarcloud.io/project/issues?id=ControlSystemStudio_phoebus&issues=AaCqbOwKuC9m43L7o7sc&open=AaCqbOwKuC9m43L7o7sc&pullRequest=3924
cryptedPassword.setInformativeTooltip(Messages.InformativeTooltipCryptedPassword);
}

/** @return 'foreground_color' property */
Expand Down Expand Up @@ -234,4 +239,10 @@
{
return password;
}

/** @return 'crypted_password' property */
public WidgetProperty<CryptedPassword> propCryptedPassword()
{
return cryptedPassword;
}
}
12 changes: 12 additions & 0 deletions app/display/model/src/main/java/org/csstudio/display/builder/model/widgets/RadioWidget.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,14 @@

import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propConfirmDialog;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propConfirmMessage;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propCryptedPassword;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propEnabled;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propFont;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propForegroundColor;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propHorizontal;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propItemsFromPV;
import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propPassword;

import static org.csstudio.display.builder.model.widgets.ComboWidget.propItem;

import java.util.Arrays;
Expand All @@ -30,6 +32,7 @@
import org.csstudio.display.builder.model.persist.NamedWidgetFonts;
import org.csstudio.display.builder.model.persist.WidgetFontService;
import org.csstudio.display.builder.model.properties.CommonWidgetProperties;
import org.csstudio.display.builder.model.properties.CryptedPassword;
import org.csstudio.display.builder.model.properties.WidgetFont;
import org.phoebus.ui.color.NamedWidgetColors;
import org.phoebus.ui.color.WidgetColor;
Expand Down Expand Up @@ -65,6 +68,7 @@
private volatile WidgetProperty<Boolean> confirm_dialog;
private volatile WidgetProperty<String> confirm_message;
private volatile WidgetProperty<String> password;
private volatile WidgetProperty<CryptedPassword> cryptedPassword;

private static ArrayWidgetProperty.Descriptor<WidgetProperty<String>> radioItemDescriptor =
new ArrayWidgetProperty.Descriptor<>(WidgetPropertyCategory.BEHAVIOR, "items", "Items",
Expand Down Expand Up @@ -95,6 +99,8 @@
properties.add(confirm_dialog = propConfirmDialog.createProperty(this, false));
properties.add(confirm_message = propConfirmMessage.createProperty(this, "Are your sure you want to do this?"));
properties.add(password = propPassword.createProperty(this, ""));
properties.add(cryptedPassword = propCryptedPassword.createProperty(this, CryptedPassword.NONE));

Check warning on line 102 in app/display/model/src/main/java/org/csstudio/display/builder/model/widgets/RadioWidget.java

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Extract the assignment out of this expression. 


See more on https://sonarcloud.io/project/issues?id=ControlSystemStudio_phoebus&issues=AaCqbOzKuC9m43L7o7sh&open=AaCqbOzKuC9m43L7o7sh&pullRequest=3924
cryptedPassword.setInformativeTooltip(Messages.InformativeTooltipCryptedPassword);
}

/** @return 'foreground_color' property */
Expand Down Expand Up @@ -151,6 +157,12 @@
return password;
}

/** @return 'crypted_password' property */
public WidgetProperty<CryptedPassword> propCryptedPassword()
{
return cryptedPassword;
}

// TODO: CR: Changing the name of a radio button item has no immediate effect,
// only after a resize the name is changed.
}
Loading
Loading