ALTER ENCRYPT RULE

Description

The ALTER ENCRYPT RULE syntax is used to alter an encryption rule.

Syntax

Grammar Railroad diagram

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

Example

  • Alter an encrypt rule
  1. ALTER 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);

Reserved words

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