Encrypted properties

docs/_pages/02-api-04-collections.md

@@ -211,6 +211,19 @@ Adds the given property to the searchable properties collection. Property must b
 collectionConfig.AddSearchableProperty(p => p.FirstName);
 ````
 
+### Defining encrypted properties
+{: .mt}
+
+#### AddEncryptedProperty(Lambda encryptedPropertyExpression) *: FluidityCollectionConfig<TEntityType>*
+{: .signature}
+
+Adds the given property to the encrypted properties collection. Property must be of type `String`. When set, the property will be encrypted/decrypted on write/read respectively.
+
+````csharp
+// Example
+collectionConfig.AddEncryptedProperty(p => p.Email);
+````
+
 ### Applying a global filter
 {: .mt}
 

src/Fluidity/Configuration/FluidityCollectionConfig.cs

@@ -92,6 +92,9 @@ public abstract class FluidityCollectionConfig : FluidityTreeItemConfig
         protected List<FluidityPropertyConfig> _searchableProperties;
         internal IEnumerable<FluidityPropertyConfig> SearchableProperties => _searchableProperties;
 
+        protected List<FluidityPropertyConfig> _encryptedProperties;
+        internal IEnumerable<FluidityPropertyConfig> EncryptedProperties => _encryptedProperties;
+
         protected LambdaExpression _filterExpression;
         internal LambdaExpression FilterExpression => _filterExpression;
 
@@ -120,6 +123,7 @@ protected FluidityCollectionConfig(Type entityType, LambdaExpression idPropertyE
             _containerMenuItems = new List<MenuItem>();
             _entityMenuItems = new List<MenuItem>();
             _searchableProperties = new List<FluidityPropertyConfig>();
+            _encryptedProperties = new List<FluidityPropertyConfig>();
         }
     }
 }

src/Fluidity/Configuration/FluidityCollectionConfig`T.cs

@@ -292,6 +292,17 @@ public FluidityCollectionConfig<TEntityType> AddSearchableProperty(Expression<Fu
             return this;
         }
 
+        /// <summary>
+        /// Adds a property that will be encrypted / decrypted when retrived from the repository.
+        /// </summary>
+        /// <param name="encryptedPropertyExpression">The encrypted property expression.</param>
+        /// <returns>The collection configuration.</returns>
+        public FluidityCollectionConfig<TEntityType> AddEncryptedProperty(Expression<Func<TEntityType, string>> encryptedPropertyExpression)
+        {
+            _encryptedProperties.Add(encryptedPropertyExpression);
+            return this;
+        }
+
         /// <summary>
         /// Sets which property to use as the Date Created property.
         /// </summary>

src/Fluidity/Fluidity.csproj

@@ -282,6 +282,7 @@
     <Compile Include="Extensions\FluidityPropertyConfigExtensions.cs" />
     <Compile Include="Extensions\SqlExtensions.cs" />
     <Compile Include="Events\FluidityStartingEventArgs.cs" />
+    <Compile Include="Helpers\SecurityHelper.cs" />
     <Compile Include="Helpers\UmbracoPublishedPropertyTypeHelper.cs" />
     <Compile Include="ListViewLayouts\FluidityListViewLayout.cs" />
     <Compile Include="Extensions\FluidityEditorFieldConfigExtensions.cs" />

src/Fluidity/Helpers/SecurityHelper.cs

@@ -0,0 +1,33 @@
+// <copyright file="SecurityHelper.cs" company="Matt Brailsford">
+// Copyright (c) 2017 Matt Brailsford and contributors.
+// Licensed under the Apache License, Version 2.0.
+// </copyright>
+
+using System;
+using Umbraco.Core;
+
+namespace Fluidity.Helpers
+{
+    internal static class SecurityHelper
+    {
+        internal static string Encrypt(string input)
+        {
+            return input.EncryptWithMachineKey();
+        }
+
+        internal static string Decrypt(string input)
+        {
+            try
+            {
+                return input.DecryptWithMachineKey();
+            }
+            catch (ArgumentException ex)
+            {
+                if (!ex.Message.Contains("encryptedTicket"))
+                    throw ex;
+
+                return input;
+            }
+        }
+    }
+}

src/Fluidity/Web/Models/Mappers/FluidityEntityMapper.cs

@@ -77,6 +77,12 @@ public FluidityEntityDisplayModel ToDisplayModel(FluiditySectionConfig section,
                 {
                     var value = entity?.GetPropertyValue(field.Property);
 
+                    var encryptedProp = collection.EncryptedProperties?.FirstOrDefault(x => x.Name == field.Property.Name);
+                    if (encryptedProp != null)
+                    {
+                        value = SecurityHelper.Decrypt(value.ToString());
+                    }
+
                     if (field.Format != null)
                     {
                         value = field.Format(value, entity);
@@ -157,6 +163,12 @@ public FluidityEntityEditModel ToEditModel(FluiditySectionConfig section, Fluidi
                                 ? entity?.GetPropertyValue(field.Property)
                                 : field.DefaultValueFunc != null ? field.DefaultValueFunc() : field.Property.Type.GetDefaultValue();
 
+                            var encryptedProp = collection.EncryptedProperties?.FirstOrDefault(x => x.Name == field.Property.Name);
+                            if (encryptedProp != null)
+                            {
+                                value = SecurityHelper.Decrypt(value.ToString());
+                            }
+
                             if (field.ValueMapper != null)
                             {
                                 value = field.ValueMapper.ModelToEditor(value);
@@ -264,6 +276,13 @@ public object FromPostModel(FluiditySectionConfig section, FluidityCollectionCon
 
                     if (!dataTypeInfo.PropertyEditor.ValueEditor.IsReadOnly) {
                         var currentValue = entity.GetPropertyValue(propConfig.Property);
+
+                        var encryptedProp = collection.EncryptedProperties?.FirstOrDefault(x => x.Name == propConfig.Property.Name);
+                        if (encryptedProp != null)
+                        {
+                            currentValue = SecurityHelper.Decrypt(currentValue.ToString());
+                        }
+
                         if (propConfig.ValueMapper != null) {
                             currentValue = propConfig.ValueMapper.ModelToEditor(currentValue);
                         }
@@ -282,6 +301,11 @@ public object FromPostModel(FluiditySectionConfig section, FluidityCollectionCon
                             propVal = propConfig.ValueMapper.EditorToModel(propVal);
                         }
 
+                        if (encryptedProp != null)
+                        {
+                            propVal = SecurityHelper.Encrypt(propVal.ToString());
+                        }
+
                         if (propVal != null && propVal.GetType() != propConfig.Property.Type) {
                             var convert = propVal.TryConvertTo(propConfig.Property.Type);
                             if (convert.Success) {