数据加密

背景信息

数据加密 YAML 配置方式具有非凡的可读性，通过 YAML 格式，能够快速地理解加密规则之间的依赖关系，ShardingSphere 会根据 YAML 配置，自动完成 ShardingSphereDataSource 对象的创建，减少用户不必要的编码工作。

参数解释

  1. rules:
  2. - !ENCRYPT
  3.   tables:
  4.     <table_name> (+): # 加密表名称
  5.       columns:
  6.         <column_name> (+): # 加密列名称
  7.           cipher:
  8.             name: # 密文列名称
  9.             encryptorName: # 密文列加密算法名称
  10.           assistedQuery (?):  
  11.             name: # 查询辅助列名称
  12.             encryptorName:  # 查询辅助列加密算法名称
  13.           likeQuery (?):
  14.             name: # 模糊查询列名称
  15.             encryptorName:  # 模糊查询列加密算法名称
  17.   # 加密算法配置
  18.   encryptors:
  19.     <encrypt_algorithm_name> (+): # 加解密算法名称
  20.       type: # 加解密算法类型
  21.       props: # 加解密算法属性配置
  22.         # ...

算法类型的详情，请参见内置加密算法列表。

操作步骤

  1. 在 YAML 文件中配置数据加密规则，包含数据源、加密规则、全局属性等配置项；
  2. 调用 YamlShardingSphereDataSourceFactory 对象的 createDataSource 方法，根据 YAML 文件中的配置信息创建 ShardingSphereDataSource。

配置示例

数据加密 YAML 配置如下：

  1. dataSources:
  2.   unique_ds:
  3.     dataSourceClassName: com.zaxxer.hikari.HikariDataSource
  4.     driverClassName: com.mysql.jdbc.Driver
  5.     jdbcUrl: jdbc:mysql://localhost:3306/demo_ds?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
  6.     username: root
  7.     password:
  9. rules:
  10. - !ENCRYPT
  11.   tables:
  12.     t_user:
  13.       columns:
  14.         username:
  15.           cipher:
  16.             name: username
  17.             encryptorName: aes_encryptor
  18.           assistedQuery:
  19.             name: assisted_query_username
  20.             encryptorName: assisted_encryptor
  21.           likeQuery:
  22.             name: like_query_username
  23.             encryptorName: like_encryptor
  24.         pwd:
  25.           cipher:
  26.             name: pwd
  27.             encryptorName: aes_encryptor
  28.           assistedQuery:
  29.             name: assisted_query_pwd
  30.             encryptorName: assisted_encryptor
  31.   encryptors:
  32.     aes_encryptor:
  33.       type: AES
  34.       props:
  35.         aes-key-value: 123456abc
  36.     assisted_encryptor:
  37.       type: MD5
  38.     like_encryptor:
  39.       type: CHAR_DIGEST_LIKE

然后通过 YamlShardingSphereDataSourceFactory 的 createDataSource 方法创建数据源。

  1. YamlShardingSphereDataSourceFactory.createDataSource(getFile());

为了保持对低版本 YAML 配置的兼容，ShardingSphere 通过 COMPATIBLE_ENCRYPT 提供了如下的兼容配置，该配置会在后续版本中删除，建议及时升级最新 YAML 配置。

  1. dataSources:
  2.   unique_ds:
  3.     dataSourceClassName: com.zaxxer.hikari.HikariDataSource
  4.     driverClassName: com.mysql.jdbc.Driver
  5.     jdbcUrl: jdbc:mysql://localhost:3306/demo_ds?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
  6.     username: root
  7.     password:
  9. rules:
  10. - !COMPATIBLE_ENCRYPT
  11.   tables:
  12.     t_user:
  13.       columns:
  14.         username:
  15.           cipherColumn: username
  16.           encryptorName: aes_encryptor
  17.           assistedQueryColumn: assisted_query_username
  18.           assistedQueryEncryptorName: assisted_encryptor
  19.           likeQueryColumn: like_query_username
  20.           likeQueryEncryptorName: like_encryptor
  21.         pwd:
  22.           cipherColumn: pwd
  23.           encryptorName: aes_encryptor
  24.           assistedQueryColumn: assisted_query_pwd
  25.           assistedQueryEncryptorName: assisted_encryptor
  26.   encryptors:
  27.     aes_encryptor:
  28.       type: AES
  29.       props:
  30.         aes-key-value: 123456abc
  31.     assisted_encryptor:
  32.       type: MD5
  33.     like_encryptor:
  34.       type: CHAR_DIGEST_LIKE

相关参考