Encryption #

Configuration Entry #

Class name: org.apache.shardingsphere.encrypt.api.config.EncryptRuleConfiguration

Attributes:

Name	DataType	Description	Default Value
tables (+)	Collection<EncryptTableRuleConfiguration>	Encrypt table rule configurations
encryptors (+)	Map<String, ShardingSphereAlgorithmConfiguration>	Encrypt algorithm name and configurations
queryWithCipherColumn (?)	boolean	Whether query with cipher column for data encrypt. User you can use plaintext to query if have	true

Class name: org.apache.shardingsphere.encrypt.api.config.rule.EncryptTableRuleConfiguration

Attributes:

Name	DataType	Description
name	String	Table name
columns (+)	Collection<EncryptColumnRuleConfiguration>	Encrypt column rule configurations
queryWithCipherColumn (?)	boolean	The current table whether query with cipher column for data encrypt.

Class name: org.apache.shardingsphere.encrypt.api.config.rule.EncryptColumnRuleConfiguration

Attributes:

Name	DataType	Description
logicColumn	String	Required field. Logic column name.
dataType	String	Logical column type, optional (required if other encrypted column, auxiliary query column or plain text column types are configured)
cipherColumn	String	Required field. Cipher column name.
cipherDataType	String	Encrypted column type, optional (required if logical column type is configured)
assistedQueryColumn	String	Auxiliary query column name, optional
assistedQueryDataType	String	Auxiliary query column type, optional (required if auxiliary query column and logical column types are configured)
plainColumn	String	Name in plain text, optional
plainDataType	String	Plain text column type, optional (required if plain text column and logical column types are configured)
encryptorName	String	Encryption algorithm name, required

Class name: org.apache.shardingsphere.infra.config.algorithm.ShardingSphereAlgorithmConfiguration

Attributes:

Name	DataType	Description
name	String	Encrypt algorithm name
type	String	Encrypt algorithm type
properties	Properties	Encrypt algorithm properties

Please refer to Built-in Encrypt Algorithm List for more details about type of algorithm.