第44章 用户密码实体及其约束规则的定义实现

1 说明：

    由当前程序需要兼容实现多种用户密码的加密操作，所以必须把“CustomerPassword”定义为实体类，该类用于用于把加密方式、密钥及其加密后的密码持久化到“CustomerPassword”表中，以便用为用户登录操作提供验证支撑。

    如果是程序中使用哈西加密方式，且密钥由用户注册或密码修改时随机生成的以增加用户密码的安全性。由于1个指定用户的密钥是随机生成的，且会通过该随机生成的密钥来生成相应的密码，这样做会增加用户密码的安全性，但是在用户用户登录时依然需要该密钥与生成的密码与持久化密码进行匹配，从而实现用户的登录操作，这也是需要把“CustomerPassword”定义为实体类的主要原因。

    如果程序中不定义“CustomerPassword” 实体类，且只使用哈西加密方式，那么就需要把属性成员:

public string Password { get; set; }

public string PasswordSalt { get; set; }

public static int PasswordSaltKeySize => 5;

    public static string DefaultHashedPasswordFormat => "SHA512";

定义到用户实体中，以便把随机生成的密钥持久化到用户表中，以便为1个指定用户使用哈西加密方式执行登录操作时保证同1个密钥，从而保证对明码哈西加密后密码的相等性。

2 Core.Domain.Users.CustomerPassword

namespace Core.Domain.Users

{

    /// <summary>

    /// 【用户密码--类】

    /// <remarks>

    /// 摘要：

    ///     该类中的属性成员实例存储着指定的加密方式及其密钥，为用户输入密码的加密操作提供实例支撑，最后还把加密后的密码字符串存储到该类的属性成员实例中。

    /// </remarks>

    /// </summary>

    public class CustomerPassword : BaseEntity

    {

        #region 拷贝构造方法

        /// <summary>

        /// 【拷贝构造方法】

        /// <remarks>

        /// 摘要：

        ///     通过拷贝构造方法设定当前对用户密码的默认加密方式为明码，即不加密。

        /// </remarks>

        /// </summary>

        public CustomerPassword()

        {

            PasswordFormat = PasswordFormat.Clear;

        }

        #endregion

        #region 属性

        /// <summary>

        /// 【用户编号】

        /// <remarks>

        /// 摘要：

        ///     获取/设置用户实体1个指定实例的长整型编号值。

        /// </remarks>

        /// </summary>

        public long UserId { get; set; }

       

        /// <summary>

        /// 【密码】

        /// <remarks>

        /// 摘要：

        ///    获取/设置经过指定加密方式加密后的密码字符串。

        /// </remarks>

        /// </summary>

        public string Password { get; set; }

        /*

        可逆加密(Encryption)方式和哈希(Hash)加密方式的区别：

           1、可逆加密(Encryption)是可逆的，即明码和加密码之间通过操作是可以相互转换；哈希(Hash)加密方式是不可逆的，哈希(Hash)加密方式一般会导致信息熵减小，即使用哈希(Hash)加密方式转换后可能导致，转换明码是原明码中的一段。

           2、可逆加密(Encryption)的密码会随着明码的长度进行改变；而哈希(Hash)加密方式密码的长度是固定的，且只取决于所使用的算法，当明码的长度大于算法中所规则的长度时，哈希(Hash)加密方式会把明码截断后进行加密操作，这也是导致哈希(Hash)加密方式不可逆的与信息熵减小的根本原因。

           3、应用场景：一般情况下用户密码加密操作使用可逆加密(Encryption)方式；哈希(Hash)加密方式(一般用于数字签名、数据校验（CRC、SHA、MD5），据说HTTPS协议运行所需要的CA证书就是使用哈希(Hash)算法生成的。

           4、哈希(Hash)加密方式无解密操作，即哈希(Hash)加密方式是不能被解密的，如果用户输入的密码经过哈希(Hash)加密方式加密后的加密字符串与原加密字符相等，则用户通过验证，可以登录了。

        */

        /// <summary>

        /// 【哈希密钥】

        /// <remarks>

        /// 摘要：

        ///     获取/设置哈希(Hash)加密方式所需的密钥字符串(默认：5个字符的字符串)。

        ///  说明：

        ///     使用哈希加密方式对用户的密进行加密操作时,所使用的密钥字符串。

        /// </remarks>

        /// </summary>

        public string PasswordSalt { get; set; }

        /// <summary>

        /// 【哈希密钥长度】

        /// <remarks>

        /// 摘要：

        ///     设定哈希(Hash)加密方式所需密钥字符串长度的整型值。

        ///  说明：

        ///     当使用哈希方式对用户的密进行加密操作进行加密操作时，设定密钥字符串的长度值为:5个字符。

        /// </remarks>

        /// </summary>

        public static int PasswordSaltKeySize => 5;

        /// <summary>

        /// 【哈希加密默认编码格式】

        /// <remarks>

        /// 摘要：

        ///     设定哈希加密算法名称的字符串常量(默认：以最高安全性及其最大长度的"SHA512"加密算法，对用户的密码进行加密操作。)。

        /// </remarks>

        /// </summary>

        public static string DefaultHashedPasswordFormat => "SHA512";

        /// <summary>

        /// 【可逆加密(Encryption)密钥】

        /// <remarks>

        /// 摘要：

        ///     设定可逆加密密钥的字符串常量(默认：16个字符的高安全性数字型字符串)。

        ///  说明：

        ///     使用可逆加密(Encryption)方式对用户的密进行加密操作时,所使用的密钥字符串。

        /// </remarks>

        /// </summary>

        public static string EncryptionKey => CommonHelper.GenerateRandomDigitCode(16);

        /// <summary>

        /// 【加密方式编号】

        /// <remarks>

        /// 摘要：

        ///     1个指定编号值，通过该编号值获取/设置加密方式枚举的1个指定实例。

        /// </remarks>

        /// </summary>

        public int PasswordFormatId { get; set; }

        /// <summary>

        /// 【加密方式】

        /// <remarks>

        /// 摘要：

        ///     获取/设置加密方式枚举的1个指定实例。

        /// </remarks>

        /// </summary>

        public PasswordFormat PasswordFormat

        {

            get => (PasswordFormat)PasswordFormatId;

            set => PasswordFormatId = (int)value;

        }

        /// <summary>

        /// 【默认加密方式】

        /// <remarks>

        /// 摘要：

        ///     设定哈希加密方式对用户密码进行加/解密操作。

        /// </remarks>

        /// </summary>

        public static PasswordFormat DefaultPasswordFormat => PasswordFormat.Hashed;

        #endregion

        #region 属性--映射和级联构建

        /// <summary>

        /// 【单个用户】

        /// <remarks>

        /// 摘要：

        ///     获取/设置1个指定用户实例所对应的1个用户密码实例。

        /// 说明：

        ///     构建用户与用户密码实体及其表之间的1:1映射关系，但在实现和逻辑定义实现上以用户为主。

        /// </remarks>

        /// </summary>

        public virtual User UserSingle { get; set; }

        #endregion

    }

}

3 Data.Mapping.Users.CustomerPasswordBuilder

//Nuget

//Nuget--Microsoft.EntityFrameworkCore.SqlServer

using Microsoft.EntityFrameworkCore;

using Microsoft.EntityFrameworkCore.Metadata.Builders;

//项目

using Core.Domain.Users;

using System.Reflection.Emit;

using System;

namespace Data.Mapping.Users

{

    /// <summary>

    /// 【用户密码生成器--类】

    /// <remarks>

    /// 摘要：

    ///     该类通过对“EntityFrameworkCore”中间件“IEntityTypeConfiguration<TEntity/>”泛型接口的“Configure”方法的定义，以实现把用户密码映射实体类及其属性成员相关约束规则及其级联关系定义，映射到用户密码表及其的相应字段上。

    /// </remarks>

    /// </summary>

    public class CustomerPasswordBuilder : IEntityTypeConfiguration<CustomerPassword>

    {

        #region 方法--IEntityTypeConfiguration<>

        ///<param name="builder">实体类型生成器实例，用于把当前程序中指定实体和属性所定义的约束规则，映射到数据库指定表及其字段上。</param>

        /// <summary>

        /// 【配置】

        /// <remarks>

        /// 摘要：

        ///     该方法通过对“EntityFrameworkCore”中间件“IEntityTypeConfiguration<TEntity/>”泛型接口的“Configure”方法的定义，以实现把用户密码实体类及其属性成员相关约束规则及其级联关系定义，映射到用户密码表及其的相应字段上。

        /// </remarks>

        /// </summary>

        public void Configure(EntityTypeBuilder<CustomerPassword> builder)

        {

            //由于“EntityTypeBuilder<CustomerPassword>”的参数已经泛型实例化，因此builder后不能再定义为：“builder.Entity<CustomerPassword>().HasKey(customerPassword => customerPassword.Id);”。

            //用户表及其字段约束规则，映射定义。

            builder.HasKey(customerPassword => customerPassword.Id);

            //构建用户表与用户密码表1:1映射关系，但在际应用中用户表与用户密码表最多被应用的映射方式为1:n映射关系。

            builder.HasOne(customerPassword => customerPassword.UserSingle)

                .WithOne(user => user.CustomerPasswordSingle)

                .HasForeignKey<CustomerPassword>(customerPassword => customerPassword.UserId)

                .IsRequired();

            builder.Ignore(customerPassword => customerPassword.PasswordFormat);

        }

        #endregion

    }

}

对以上功能更为具体实现和注释见：230211_038shopDemo(用户密码实体及其约束规则的定义实现)。