CREATE ENCRYPT RULE

Description

The CREATE ENCRYPT RULE syntax is used to create a encrypt rule.

Syntax

Grammar Railroad diagram

  1. CreateEncryptRule ::=
  2.   'CREATE' 'ENCRYPT' 'RULE' ifNotExists? encryptDefinition (',' encryptDefinition)*
  4. ifNotExists ::=
  5.   'IF' 'NOT' 'EXISTS'
  7. encryptDefinition ::=
  8.   ruleName '(' 'COLUMNS' '(' columnDefinition (',' columnDefinition)*  ')' (',' 'QUERY_WITH_CIPHER_COLUMN' '=' ('TRUE' | 'FALSE'))? ')'
  10. columnDefinition ::=
  11.   '(' 'NAME' '=' columnName (',' 'PLAIN' '=' plainColumnName)? ',' 'CIPHER' '=' cipherColumnName (',' 'ASSISTED_QUERY_COLUMN' '=' assistedQueryColumnName)? (',' 'LIKE_QUERY_COLUMN' '=' likeQueryColumnName)? ',' encryptAlgorithmDefinition (',' assistedQueryAlgorithmDefinition)? (',' likeQueryAlgorithmDefinition)? ')' 
  13. encryptAlgorithmDefinition ::=
  14.   'ENCRYPT_ALGORITHM' '(' 'TYPE' '(' 'NAME' '=' encryptAlgorithmType (',' propertiesDefinition)? ')'
  16. assistedQueryAlgorithmDefinition ::=
  17.   'ASSISTED_QUERY_ALGORITHM' '(' 'TYPE' '(' 'NAME' '=' encryptAlgorithmType (',' propertiesDefinition)? ')'
  19. likeQueryAlgorithmDefinition ::=
  20.   'LIKE_QUERY_ALGORITHM' '(' 'TYPE' '(' 'NAME' '=' encryptAlgorithmType (',' propertiesDefinition)? ')'
  22. propertiesDefinition ::=
  23.   'PROPERTIES' '(' key '=' value (',' key '=' value)* ')'
  25. tableName ::=
  26.   identifier
  28. columnName ::=
  29.   identifier
  31. plainColumnName ::=
  32.   identifier
  34. cipherColumnName ::=
  35.   identifier
  37. assistedQueryColumnName ::=
  38.   identifier
  40. likeQueryColumnName ::=
  41.   identifier
  43. encryptAlgorithmType ::=
  44.   string
  46. key ::=
  47.   string
  49. value ::=
  50.   literal

Supplement

  • PLAIN specifies the plain column, CIPHER specifies the cipher column, ASSISTED_QUERY_COLUMN specifies the assisted query column，LIKE_QUERY_COLUMN specifies the like query column;
  • encryptAlgorithmType specifies the encryption algorithm type, please refer to Encryption Algorithm;
  • Duplicate ruleName will not be created;
  • ifNotExists clause used for avoid Duplicate encrypt rule error.

Example

Create a encrypt rule

  1. CREATE ENCRYPT RULE t_encrypt (
  2. COLUMNS(
  3. (NAME=user_id,PLAIN=user_plain,CIPHER=user_cipher,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc')))),
  4. (NAME=order_id, CIPHER =order_cipher,ENCRYPT_ALGORITHM(TYPE(NAME='MD5')))
  5. ),QUERY_WITH_CIPHER_COLUMN=true),
  6. t_encrypt_2 (
  7. COLUMNS(
  8. (NAME=user_id,PLAIN=user_plain,CIPHER=user_cipher,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc')))),
  9. (NAME=order_id, CIPHER=order_cipher,ENCRYPT_ALGORITHM(TYPE(NAME='MD5')))
  10. ), QUERY_WITH_CIPHER_COLUMN=FALSE);

Create a encrypt rule with ifNotExists clause

  1. CREATE ENCRYPT RULE t_encrypt IF NOT EXISTS (
  2. COLUMNS(
  3. (NAME=user_id,PLAIN=user_plain,CIPHER=user_cipher,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc')))),
  4. (NAME=order_id, CIPHER =order_cipher,ENCRYPT_ALGORITHM(TYPE(NAME='MD5')))
  5. ),QUERY_WITH_CIPHER_COLUMN=true),
  6. t_encrypt_2 (
  7. COLUMNS(
  8. (NAME=user_id,PLAIN=user_plain,CIPHER=user_cipher,ENCRYPT_ALGORITHM(TYPE(NAME='AES',PROPERTIES('aes-key-value'='123456abc')))),
  9. (NAME=order_id, CIPHER=order_cipher,ENCRYPT_ALGORITHM(TYPE(NAME='MD5')))
  10. ), QUERY_WITH_CIPHER_COLUMN=FALSE);

Reserved words

CREATE, ENCRYPT, RULE, COLUMNS, NAME, CIPHER, PLAIN, ENCRYPT_ALGORITHM, QUERY_WITH_CIPHER_COLUMN, TYPE, TRUE, FALSE