Feat: crypted password property

app/display/editor/src/main/java/org/csstudio/display/builder/editor/Messages.java

@@ -54,6 +54,7 @@ public class Messages
                          FindWidget,
                          Grid,
                          InstallExampleDisplays,
+                         HashPassword_button,
                          LoadDisplay,
                          LoadDisplay_TT,
                          MacroEditButton,

app/display/editor/src/main/java/org/csstudio/display/builder/editor/properties/PropertyPanelSection.java

@@ -6,6 +6,7 @@
  * http://www.eclipse.org/legal/epl-v10.html
  *******************************************************************************/
 package org.csstudio.display.builder.editor.properties;
+import org.csstudio.display.builder.model.properties.HashPasswordProperty;
 
 import javafx.event.ActionEvent;
 import javafx.event.EventHandler;
@@ -545,6 +546,31 @@ public void bind() {
 
             field = points_field;
         }
+        else if (property instanceof HashPasswordProperty) {
+            final Button hashButton = new Button(Messages.HashPassword_button);
+            hashButton.setMnemonicParsing(false);
+            hashButton.setMaxWidth(Double.MAX_VALUE);
+
+            hashButton.setOnAction(event -> {
+                final WidgetProperty<String> passwordProperty =
+                        (WidgetProperty<String>) widget.getProperty("password");
+
+                if (passwordProperty == null)
+                    return;
+
+                final String password = passwordProperty.getValue();
+
+                if (password == null || password.isEmpty())
+                    return;
+
+                undo.execute(new SetMacroizedWidgetPropertyAction(
+                        (MacroizedWidgetProperty<String>) passwordProperty,
+                        HashPasswordProperty.crypt(password)
+                ));
+            });
+
+            field = hashButton;
+        }
         return field;
     }
 

app/display/editor/src/main/resources/org/csstudio/display/builder/editor/messages.properties

@@ -36,6 +36,7 @@ FilePath=File Path
 FindWidget=Find Widget...
 Grid=Align widgets to Grid
 InstallExampleDisplays=Install Example Displays
+HashPassword_button=Compute hash
 LoadDisplay=Load display
 LoadDisplay_TT=Load display
 MacroEditButton=Edit Macros

app/display/editor/src/main/resources/org/csstudio/display/builder/editor/messages_fr.properties

@@ -36,6 +36,7 @@ FilePath=Chemin du fichier
 FindWidget=Trouver un widget...
 Grid=Aligner les widgets sur la grille
 InstallExampleDisplays=Installer exemples d'affichages
+HashPassword_button=Calculer hash
 LoadDisplay=Charger l'affichage
 LoadDisplay_TT=Charger l'affichage
 MacroEditButton=Modifier les macros

app/display/model/src/main/java/org/csstudio/display/builder/model/Messages.java

@@ -61,6 +61,7 @@ public class Messages
                          GroupWidget_Description,
                          GroupWidget_Name,
                          HighlightActiveRegion,
+                         InformativeTooltipHashPassword,
                          InformativeTooltipActions,
                          InformativeTooltipAlarmBorder,
                          InformativeTooltipHeight,
@@ -236,6 +237,7 @@ public class Messages
                          WidgetProperties_GridStepX,
                          WidgetProperties_GridStepY,
                          WidgetProperties_GridVisible,
+                         WidgetProperties_HashPassword,
                          WidgetProperties_Height,
                          WidgetProperties_HeightPVName,
                          WidgetProperties_HighlightBar,

app/display/model/src/main/java/org/csstudio/display/builder/model/properties/CommonWidgetProperties.java

@@ -771,6 +771,22 @@ public EnumWidgetProperty<ConfirmDialog> createProperty(final Widget widget, fin
     public static final WidgetPropertyDescriptor<String> propPassword =
             newStringPropertyDescriptor(WidgetPropertyCategory.BEHAVIOR, "password", Messages.WidgetProperties_Password);
 
+
+    public static final WidgetPropertyDescriptor<String> propHashPassword =
+            new WidgetPropertyDescriptor<>(WidgetPropertyCategory.BEHAVIOR, "hash_password", Messages.WidgetProperties_HashPassword)
+            {
+                @Override
+                public WidgetProperty<String> createProperty(
+                        final Widget widget,
+                        final String default_value)
+                {
+                    return new HashPasswordProperty(
+                            this,
+                            widget,
+                            default_value);
+                }
+            };
+
     /**
      * Runtime 'pv_value' property: Typically read from primary PV
      */

app/display/model/src/main/java/org/csstudio/display/builder/model/properties/HashPasswordProperty.java

@@ -0,0 +1,73 @@
+package org.csstudio.display.builder.model.properties;
+
+import java.nio.charset.StandardCharsets;
+import java.security.MessageDigest;
+
+import org.csstudio.display.builder.model.Widget;
+import org.csstudio.display.builder.model.WidgetProperty;
+import org.csstudio.display.builder.model.WidgetPropertyDescriptor;
+import org.csstudio.display.builder.model.persist.ModelReader;
+import org.csstudio.display.builder.model.persist.ModelWriter;
+import org.phoebus.framework.persistence.XMLUtil;
+import org.w3c.dom.Element;
+
+import javax.xml.stream.XMLStreamWriter;
+
+@SuppressWarnings("nls")
+public class HashPasswordProperty extends WidgetProperty<String>
+{
+    public HashPasswordProperty(
+            final WidgetPropertyDescriptor<String> descriptor,
+            final Widget widget,
+            final String default_value)
+    {
+        super(descriptor, widget, default_value);
+    }
+
+    @Override
+    public void setValueFromObject(final Object value)
+    {
+        if (value == null)
+            setValue("");
+        else
+            setValue(value.toString());
+    }
+
+    @Override
+    public void writeToXML(final ModelWriter model_writer,
+                           final XMLStreamWriter writer) throws Exception
+    {
+        writer.writeCharacters(value);
+    }
+
+    @Override
+    public void readFromXML(final ModelReader model_reader,
+                            final Element property_xml) throws Exception
+    {
+        setValue(XMLUtil.getString(property_xml));
+    }
+
+    public static String crypt(final String password)
+    {
+        if (password == null || password.isEmpty())
+            return password;
+
+        try
+        {
+            final MessageDigest md = MessageDigest.getInstance("SHA-256");
+            final byte[] hash =
+                    md.digest(password.getBytes(StandardCharsets.UTF_8));
+
+            final StringBuilder hex = new StringBuilder(hash.length * 2);
+
+            for (final byte b : hash)
+                hex.append(String.format("%02x", b));
+
+            return hex.toString();
+        }
+        catch (Exception e)
+        {
+            throw new RuntimeException("Unable to hash password", e);
+        }
+    }
+}

app/display/model/src/main/java/org/csstudio/display/builder/model/rules/RuleInfo.java

@@ -13,6 +13,7 @@
 import org.csstudio.display.builder.model.properties.MacrosWidgetProperty;
 import org.csstudio.display.builder.model.properties.ActionsWidgetProperty;
 import org.csstudio.display.builder.model.properties.RulesWidgetProperty;
+import org.csstudio.display.builder.model.properties.HashPasswordProperty;
 import org.csstudio.display.builder.model.properties.ScriptPV;
 import org.csstudio.display.builder.model.properties.ScriptsWidgetProperty;
 
@@ -213,7 +214,8 @@ static public List<PropInfo> getTargettableProperties(final Widget attached_widg
             if ((prop instanceof MacrosWidgetProperty) ||
                     (prop instanceof ActionsWidgetProperty) ||
                     (prop instanceof ScriptsWidgetProperty) ||
-                    (prop instanceof RulesWidgetProperty))
+                    (prop instanceof RulesWidgetProperty) ||
+                    (prop instanceof HashPasswordProperty))
                 continue;
 
             for (String name : Widget.expandPropertyNames(prop))

app/display/model/src/main/java/org/csstudio/display/builder/model/widgets/ActionButtonWidget.java

@@ -13,6 +13,7 @@
 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.propHashPassword;
 import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propHorizontalAlignment;
 import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propVerticalAlignment;
 import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propPassword;
@@ -25,6 +26,7 @@
 import java.util.List;
 
 import org.csstudio.display.builder.model.MacroizedWidgetProperty;
+import org.csstudio.display.builder.model.Messages;
 import org.csstudio.display.builder.model.Version;
 import org.csstudio.display.builder.model.Widget;
 import org.csstudio.display.builder.model.WidgetCategory;
@@ -237,7 +239,7 @@
     private volatile WidgetProperty<Boolean> confirm_dialog;
     private volatile WidgetProperty<String> confirm_message;
     private volatile WidgetProperty<String> password;
-
+    private volatile WidgetProperty<String> hash_password;
     /** Constructor */
     public ActionButtonWidget()
     {
@@ -271,6 +273,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(hash_password = propHashPassword.createProperty(this, ""));
+        hash_password.setInformativeTooltip(Messages.InformativeTooltipHashPassword);
     }
 
     @Override
@@ -310,13 +314,13 @@
     {
         return transparent;
     }
-    
+
     /** @return 'horizontal_alignment' property */
     public WidgetProperty<HorizontalAlignment> propHorizontalAlignment()
     {
         return horizontal_alignment;
     }
-    
+
     /** @return 'vertical_alignment' property */
     public WidgetProperty<VerticalAlignment> propVerticalAlignment()
     {
@@ -353,9 +357,16 @@
         return confirm_message;
     }
 
+    /** @return 'hash_password' property */
+    public WidgetProperty<String> propHashPassword()
+    {
+        return hash_password;
+    }
+
     /** @return 'password' property */
     public WidgetProperty<String> propPassword()
     {
         return password;
     }
+
 }

app/display/model/src/main/java/org/csstudio/display/builder/model/widgets/BoolButtonWidget.java

@@ -16,6 +16,7 @@
 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.propHashPassword;
 import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propHorizontalAlignment;
 import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propVerticalAlignment;
 import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propLabelsFromPV;
@@ -182,6 +183,7 @@
     private volatile WidgetProperty<ConfirmDialog> confirm_dialog;
     private volatile WidgetProperty<String> confirm_message;
     private volatile WidgetProperty<String> password;
+    private volatile WidgetProperty<String> hash_password;
 
     /** Constructor */
     public BoolButtonWidget()
@@ -200,6 +202,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)));
@@ -219,6 +222,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(hash_password = propHashPassword.createProperty(this, ""));
+        hash_password.setInformativeTooltip(Messages.InformativeTooltipHashPassword);
     }
 
     /** @return 'bit' property */
@@ -286,13 +291,13 @@
     {
         return foreground;
     }
-    
+
     /** @return 'horizontal_alignment' property */
     public WidgetProperty<HorizontalAlignment> propHorizontalAlignment()
     {
         return horizontal_alignment;
     }
-    
+
     /** @return 'vertical_alignment' property */
     public WidgetProperty<VerticalAlignment> propVerticalAlignment()
     {
@@ -334,4 +339,10 @@
     {
         return password;
     }
+
+    /** @return 'hash_password' property */
+    public WidgetProperty<String> propHashPassword()
+    {
+        return hash_password;
+    }
 }

app/display/model/src/main/java/org/csstudio/display/builder/model/widgets/CheckBoxWidget.java

@@ -15,6 +15,7 @@
 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.propHashPassword;
 import static org.csstudio.display.builder.model.properties.CommonWidgetProperties.propPassword;
 
 import java.util.Arrays;
@@ -73,6 +74,7 @@
     private volatile WidgetProperty<ConfirmDialog> confirm_dialog;
     private volatile WidgetProperty<String> confirm_message;
     private volatile WidgetProperty<String> password;
+    private volatile WidgetProperty<String> hash_password;
 
     @Override
     protected void defineProperties(final List<WidgetProperty<?>> properties)
@@ -87,6 +89,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(hash_password = propHashPassword.createProperty(this, ""));
+        hash_password.setInformativeTooltip(Messages.InformativeTooltipHashPassword);
     }
 
     /** Constructor */
@@ -148,4 +152,11 @@
     {
         return password;
     }
+
+    /** @return 'hash_password' property */
+    public WidgetProperty<String> propHashPassword()
+    {
+        return hash_password;
+    }
+
 }