Skip to content

Commit 397cc01

Browse files
authored
[fix](function) fix AES/SM3/SM4 encrypt/ decrypt algorithm initialization vector bug (#17420)
ECB algorithm, block_encryption_mode does not take effect, it only takes effect when init vector is provided. Solved: 192/256 supports calculation without init vector For other algorithms, an error should be reported when there is no init vector Initialization Vector. The default value for the block_encryption_mode system variable is aes-128-ecb, or ECB mode, which does not require an initialization vector. The alternative permitted block encryption modes CBC, CFB1, CFB8, CFB128, and OFB all require an initialization vector. Reference: https://dev.mysql.com/doc/refman/8.0/en/encryption-functions.html#function_aes-decrypt Note: This fix does not support smooth upgrades. during upgrade process, query may report error: funciton not found
1 parent 8a6a4b8 commit 397cc01

16 files changed

Lines changed: 232 additions & 195 deletions

File tree

‎be/src/vec/functions/function_encryption.cpp‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,8 @@ static void exectue_result(std::vector<const ColumnString::Offsets*>& offsets_li
154154
template <typename Impl, EncryptionMode mode, bool is_encrypt>
155155
struct EncryptionAndDecryptTwoImpl {
156156
static DataTypes get_variadic_argument_types_impl() {
157-
return {std::make_shared<DataTypeString>(), std::make_shared<DataTypeString>()};
157+
return {std::make_shared<DataTypeString>(), std::make_shared<DataTypeString>(),
158+
std::make_shared<DataTypeString>()};
158159
}
159160

160161
static Status vector_vector(std::vector<const ColumnString::Offsets*>& offsets_list,
@@ -167,6 +168,17 @@ struct EncryptionAndDecryptTwoImpl {
167168
continue;
168169
}
169170
EncryptionMode encryption_mode = mode;
171+
int mode_size = (*offsets_list[2])[i] - (*offsets_list[2])[i - 1];
172+
const auto mode_raw =
173+
reinterpret_cast<const char*>(&(*chars_list[2])[(*offsets_list[2])[i - 1]]);
174+
if (mode_size != 0) {
175+
std::string mode_str(mode_raw, mode_size);
176+
if (aes_mode_map.count(mode_str) == 0) {
177+
StringOP::push_null_string(i, result_data, result_offset, null_map);
178+
continue;
179+
}
180+
encryption_mode = aes_mode_map.at(mode_str);
181+
}
170182
exectue_result<Impl, is_encrypt>(offsets_list, chars_list, i, encryption_mode, nullptr,
171183
0, result_data, result_offset, null_map);
172184
}

‎be/test/vec/function/function_string_test.cpp‎

Lines changed: 59 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -676,8 +676,9 @@ TEST(function_string_test, function_sm3sum_test) {
676676
TEST(function_string_test, function_aes_encrypt_test) {
677677
std::string func_name = "aes_encrypt";
678678
{
679-
InputTypeSet input_types = {TypeIndex::String, TypeIndex::String};
679+
InputTypeSet input_types = {TypeIndex::String, TypeIndex::String, TypeIndex::String};
680680

681+
const char* mode = "AES_128_ECB";
681682
const char* key = "doris";
682683
const char* src[6] = {"aaaaaa", "bbbbbb", "cccccc", "dddddd", "eeeeee", ""};
683684
std::string r[5];
@@ -692,13 +693,13 @@ TEST(function_string_test, function_aes_encrypt_test) {
692693
r[i] = std::string(p, outlen);
693694
}
694695

695-
DataSet data_set = {{{std::string(src[0]), std::string(key)}, r[0]},
696-
{{std::string(src[1]), std::string(key)}, r[1]},
697-
{{std::string(src[2]), std::string(key)}, r[2]},
698-
{{std::string(src[3]), std::string(key)}, r[3]},
699-
{{std::string(src[4]), std::string(key)}, r[4]},
700-
{{std::string(src[5]), std::string(key)}, Null()},
701-
{{Null(), std::string(key)}, Null()}};
696+
DataSet data_set = {{{std::string(src[0]), std::string(key), std::string(mode)}, r[0]},
697+
{{std::string(src[1]), std::string(key), std::string(mode)}, r[1]},
698+
{{std::string(src[2]), std::string(key), std::string(mode)}, r[2]},
699+
{{std::string(src[3]), std::string(key), std::string(mode)}, r[3]},
700+
{{std::string(src[4]), std::string(key), std::string(mode)}, r[4]},
701+
{{std::string(src[5]), std::string(key), std::string(mode)}, Null()},
702+
{{Null(), std::string(key), std::string(mode)}, Null()}};
702703

703704
check_function<DataTypeString, true>(func_name, input_types, data_set);
704705
}
@@ -743,8 +744,9 @@ TEST(function_string_test, function_aes_encrypt_test) {
743744
TEST(function_string_test, function_aes_decrypt_test) {
744745
std::string func_name = "aes_decrypt";
745746
{
746-
InputTypeSet input_types = {TypeIndex::String, TypeIndex::String};
747+
InputTypeSet input_types = {TypeIndex::String, TypeIndex::String, TypeIndex::String};
747748

749+
const char* mode = "AES_128_ECB";
748750
const char* key = "doris";
749751
const char* src[5] = {"aaaaaa", "bbbbbb", "cccccc", "dddddd", "eeeeee"};
750752
std::string r[5];
@@ -759,12 +761,12 @@ TEST(function_string_test, function_aes_decrypt_test) {
759761
r[i] = std::string(p, outlen);
760762
}
761763

762-
DataSet data_set = {{{r[0], std::string(key)}, std::string(src[0])},
763-
{{r[1], std::string(key)}, std::string(src[1])},
764-
{{r[2], std::string(key)}, std::string(src[2])},
765-
{{r[3], std::string(key)}, std::string(src[3])},
766-
{{r[4], std::string(key)}, std::string(src[4])},
767-
{{Null(), std::string(key)}, Null()}};
764+
DataSet data_set = {{{r[0], std::string(key), std::string(mode)}, std::string(src[0])},
765+
{{r[1], std::string(key), std::string(mode)}, std::string(src[1])},
766+
{{r[2], std::string(key), std::string(mode)}, std::string(src[2])},
767+
{{r[3], std::string(key), std::string(mode)}, std::string(src[3])},
768+
{{r[4], std::string(key), std::string(mode)}, std::string(src[4])},
769+
{{Null(), std::string(key), std::string(mode)}, Null()}};
768770

769771
check_function<DataTypeString, true>(func_name, input_types, data_set);
770772
}
@@ -806,29 +808,39 @@ TEST(function_string_test, function_aes_decrypt_test) {
806808
TEST(function_string_test, function_sm4_encrypt_test) {
807809
std::string func_name = "sm4_encrypt";
808810
{
809-
InputTypeSet input_types = {TypeIndex::String, TypeIndex::String};
811+
InputTypeSet input_types = {TypeIndex::String, TypeIndex::String, TypeIndex::String,
812+
TypeIndex::String};
810813

811814
const char* key = "doris";
815+
const char* iv = "0123456789abcdef";
816+
const char* mode = "SM4_128_ECB";
812817
const char* src[6] = {"aaaaaa", "bbbbbb", "cccccc", "dddddd", "eeeeee", ""};
813818
std::string r[5];
814819

815820
for (int i = 0; i < 5; i++) {
816821
int cipher_len = strlen(src[i]) + 16;
817822
char p[cipher_len];
818-
819-
int outlen = EncryptionUtil::encrypt(
820-
EncryptionMode::SM4_128_ECB, (unsigned char*)src[i], strlen(src[i]),
821-
(unsigned char*)key, strlen(key), nullptr, 0, true, (unsigned char*)p);
823+
int iv_len = 32;
824+
std::unique_ptr<char[]> init_vec;
825+
init_vec.reset(new char[iv_len]);
826+
std::memset(init_vec.get(), 0, strlen(iv) + 1);
827+
memcpy(init_vec.get(), iv, strlen(iv));
828+
int outlen =
829+
EncryptionUtil::encrypt(EncryptionMode::SM4_128_ECB, (unsigned char*)src[i],
830+
strlen(src[i]), (unsigned char*)key, strlen(key),
831+
init_vec.get(), strlen(iv), true, (unsigned char*)p);
822832
r[i] = std::string(p, outlen);
823833
}
824834

825-
DataSet data_set = {{{std::string(src[0]), std::string(key)}, r[0]},
826-
{{std::string(src[1]), std::string(key)}, r[1]},
827-
{{std::string(src[2]), std::string(key)}, r[2]},
828-
{{std::string(src[3]), std::string(key)}, r[3]},
829-
{{std::string(src[4]), std::string(key)}, r[4]},
830-
{{std::string(src[5]), std::string(key)}, Null()},
831-
{{Null(), std::string(key)}, Null()}};
835+
DataSet data_set = {
836+
{{std::string(src[0]), std::string(key), std::string(iv), std::string(mode)}, r[0]},
837+
{{std::string(src[1]), std::string(key), std::string(iv), std::string(mode)}, r[1]},
838+
{{std::string(src[2]), std::string(key), std::string(iv), std::string(mode)}, r[2]},
839+
{{std::string(src[3]), std::string(key), std::string(iv), std::string(mode)}, r[3]},
840+
{{std::string(src[4]), std::string(key), std::string(iv), std::string(mode)}, r[4]},
841+
{{std::string(src[5]), std::string(key), std::string(iv), std::string(mode)},
842+
Null()},
843+
{{Null(), std::string(key), std::string(iv), std::string(mode)}, Null()}};
832844

833845
check_function<DataTypeString, true>(func_name, input_types, data_set);
834846
}
@@ -875,28 +887,37 @@ TEST(function_string_test, function_sm4_encrypt_test) {
875887
TEST(function_string_test, function_sm4_decrypt_test) {
876888
std::string func_name = "sm4_decrypt";
877889
{
878-
InputTypeSet input_types = {TypeIndex::String, TypeIndex::String};
890+
InputTypeSet input_types = {TypeIndex::String, TypeIndex::String, TypeIndex::String,
891+
TypeIndex::String};
879892

880893
const char* key = "doris";
894+
const char* iv = "0123456789abcdef";
895+
const char* mode = "SM4_128_ECB";
881896
const char* src[5] = {"aaaaaa", "bbbbbb", "cccccc", "dddddd", "eeeeee"};
882897
std::string r[5];
883898

884899
for (int i = 0; i < 5; i++) {
885900
int cipher_len = strlen(src[i]) + 16;
886901
char p[cipher_len];
887-
888-
int outlen = EncryptionUtil::encrypt(
889-
EncryptionMode::SM4_128_ECB, (unsigned char*)src[i], strlen(src[i]),
890-
(unsigned char*)key, strlen(key), nullptr, 0, true, (unsigned char*)p);
902+
int iv_len = 32;
903+
std::unique_ptr<char[]> init_vec;
904+
init_vec.reset(new char[iv_len]);
905+
std::memset(init_vec.get(), 0, strlen(iv) + 1);
906+
memcpy(init_vec.get(), iv, strlen(iv));
907+
int outlen =
908+
EncryptionUtil::encrypt(EncryptionMode::SM4_128_ECB, (unsigned char*)src[i],
909+
strlen(src[i]), (unsigned char*)key, strlen(key),
910+
init_vec.get(), strlen(iv), true, (unsigned char*)p);
891911
r[i] = std::string(p, outlen);
892912
}
893913

894-
DataSet data_set = {{{r[0], std::string(key)}, std::string(src[0])},
895-
{{r[1], std::string(key)}, std::string(src[1])},
896-
{{r[2], std::string(key)}, std::string(src[2])},
897-
{{r[3], std::string(key)}, std::string(src[3])},
898-
{{r[4], std::string(key)}, std::string(src[4])},
899-
{{Null(), std::string(key)}, Null()}};
914+
DataSet data_set = {
915+
{{r[0], std::string(key), std::string(iv), std::string(mode)}, std::string(src[0])},
916+
{{r[1], std::string(key), std::string(iv), std::string(mode)}, std::string(src[1])},
917+
{{r[2], std::string(key), std::string(iv), std::string(mode)}, std::string(src[2])},
918+
{{r[3], std::string(key), std::string(iv), std::string(mode)}, std::string(src[3])},
919+
{{r[4], std::string(key), std::string(iv), std::string(mode)}, std::string(src[4])},
920+
{{Null(), std::string(key), std::string(iv), std::string(mode)}, Null()}};
900921

901922
check_function<DataTypeString, true>(func_name, input_types, data_set);
902923
}

‎docs/en/docs/sql-manual/sql-functions/encrypt-digest-functions/aes.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ AES_ENCRYPT
3131
### description
3232

3333
Encryption of data using the OpenSSL. This function is consistent with the `AES_ENCRYPT` function in MySQL. Using AES_128_ECB algorithm by default, and the padding mode is PKCS7.
34+
Reference: https://dev.mysql.com/doc/refman/8.0/en/encryption-functions.html#function_aes-decrypt
3435

3536
#### Syntax
3637

@@ -42,7 +43,7 @@ AES_ENCRYPT(str,key_str[,init_vector])
4243

4344
- `str`: Content to be encrypted
4445
- `key_str`: Secret key
45-
- `init_vector`: Initialization Vector
46+
- `init_vector`: Initialization Vector. The default value for the block_encryption_mode system variable is aes ecb mode, which does not require an initialization vector. The alternative permitted block encryption modes CBC, CFB1, CFB8, CFB128, and OFB all require an initialization vector.
4647

4748
#### Return Type
4849

‎docs/zh-CN/docs/sql-manual/sql-functions/encrypt-digest-functions/aes.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ AES_ENCRYPT
3131
### Description
3232

3333
Aes 加密函数。该函数与 MySQL 中的 `AES_ENCRYPT` 函数行为一致。默认采用 AES_128_ECB 算法,padding 模式为 PKCS7。底层使用 OpenSSL 库进行加密。
34+
Reference: https://dev.mysql.com/doc/refman/8.0/en/encryption-functions.html#function_aes-decrypt
3435

3536
#### Syntax
3637

@@ -42,7 +43,7 @@ AES_ENCRYPT(str,key_str[,init_vector])
4243

4344
- `str`: 待加密的内容
4445
- `key_str`: 密钥
45-
- `init_vector`: 初始向量
46+
- `init_vector`: 初始向量。block_encryption_mode 默认值为 aes-128-ecb,它不需要初始向量,可选的块加密模式 CBC、CFB1、CFB8、CFB128 和 OFB 都需要一个初始向量。
4647

4748
#### Return Type
4849

‎fe/fe-core/src/main/java/org/apache/doris/analysis/FunctionCallExpr.java‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -939,7 +939,7 @@ private void analyzeBuiltinAggFunction(Analyzer analyzer) throws AnalysisExcepti
939939
|| fnName.getFunction().equalsIgnoreCase("aes_encrypt")
940940
|| fnName.getFunction().equalsIgnoreCase("sm4_decrypt")
941941
|| fnName.getFunction().equalsIgnoreCase("sm4_encrypt"))
942-
&& children.size() == 3) {
942+
&& (children.size() == 2 || children.size() == 3)) {
943943
String blockEncryptionMode = "";
944944
Set<String> aesModes = new HashSet<>(Arrays.asList(
945945
"AES_128_ECB",
@@ -985,6 +985,12 @@ private void analyzeBuiltinAggFunction(Analyzer analyzer) throws AnalysisExcepti
985985
throw new AnalysisException("session variable block_encryption_mode is invalid with aes");
986986

987987
}
988+
if (children.size() == 2 && !blockEncryptionMode.toUpperCase().equals("AES_128_ECB")
989+
&& !blockEncryptionMode.toUpperCase().equals("AES_192_ECB")
990+
&& !blockEncryptionMode.toUpperCase().equals("AES_256_ECB")) {
991+
throw new AnalysisException("Incorrect parameter count in the call to native function "
992+
+ "'aes_encrypt' or 'aes_decrypt'");
993+
}
988994
}
989995
if (fnName.getFunction().equalsIgnoreCase("sm4_decrypt")
990996
|| fnName.getFunction().equalsIgnoreCase("sm4_encrypt")) {
@@ -995,6 +1001,10 @@ private void analyzeBuiltinAggFunction(Analyzer analyzer) throws AnalysisExcepti
9951001
throw new AnalysisException("session variable block_encryption_mode is invalid with sm4");
9961002

9971003
}
1004+
if (children.size() == 2) {
1005+
throw new AnalysisException("Incorrect parameter count in the call to native function "
1006+
+ "'sm4_encrypt' or 'sm4_decrypt'");
1007+
}
9981008
}
9991009
}
10001010
children.add(new StringLiteral(blockEncryptionMode));

‎fe/fe-core/src/main/java/org/apache/doris/nereids/trees/expressions/functions/FunctionBuilder.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ public BoundFunction build(String name, List<? extends Object> arguments) {
107107
})
108108
.collect(Collectors.joining(", ", "(", ")"));
109109
throw new IllegalStateException("Can not build function: '" + name
110-
+ "', expression: " + name + argString, t);
110+
+ "', expression: " + name + argString + ", " + t.getCause().getMessage(), t);
111111
}
112112
}
113113

‎fe/fe-core/src/main/java/org/apache/doris/nereids/trees/expressions/functions/scalar/AesDecrypt.java‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,18 @@ public class AesDecrypt extends AesCryptoFunction {
5454
.args(StringType.INSTANCE, StringType.INSTANCE, StringType.INSTANCE, StringType.INSTANCE)
5555
);
5656

57+
/**
58+
* Some javadoc for checkstyle...
59+
*/
5760
public AesDecrypt(Expression arg0, Expression arg1) {
58-
super("aes_decrypt", arg0, arg1);
61+
super("aes_decrypt", arg0, arg1, getDefaultBlockEncryptionMode());
62+
String blockEncryptionMode = String.valueOf(getDefaultBlockEncryptionMode());
63+
if (!blockEncryptionMode.toUpperCase().equals("'AES_128_ECB'")
64+
&& !blockEncryptionMode.toUpperCase().equals("'AES_192_ECB'")
65+
&& !blockEncryptionMode.toUpperCase().equals("'AES_256_ECB'")) {
66+
throw new AnalysisException("Incorrect parameter count in the call to native function "
67+
+ "'aes_encrypt' or 'aes_decrypt'");
68+
}
5969
}
6070

6171
public AesDecrypt(Expression arg0, Expression arg1, Expression arg2) {

‎fe/fe-core/src/main/java/org/apache/doris/nereids/trees/expressions/functions/scalar/AesEncrypt.java‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,18 @@ public class AesEncrypt extends AesCryptoFunction {
5454
.args(StringType.INSTANCE, StringType.INSTANCE, StringType.INSTANCE, StringType.INSTANCE)
5555
);
5656

57+
/**
58+
* Some javadoc for checkstyle...
59+
*/
5760
public AesEncrypt(Expression arg0, Expression arg1) {
58-
super("aes_encrypt", arg0, arg1);
61+
super("aes_encrypt", arg0, arg1, getDefaultBlockEncryptionMode());
62+
String blockEncryptionMode = String.valueOf(getDefaultBlockEncryptionMode());
63+
if (!blockEncryptionMode.toUpperCase().equals("'AES_128_ECB'")
64+
&& !blockEncryptionMode.toUpperCase().equals("'AES_192_ECB'")
65+
&& !blockEncryptionMode.toUpperCase().equals("'AES_256_ECB'")) {
66+
throw new AnalysisException("Incorrect parameter count in the call to native function "
67+
+ "'aes_encrypt' or 'aes_decrypt'");
68+
}
5969
}
6070

6171
public AesEncrypt(Expression arg0, Expression arg1, Expression arg2) {

‎fe/fe-core/src/main/java/org/apache/doris/nereids/trees/expressions/functions/scalar/Sm4Decrypt.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,8 @@ public class Sm4Decrypt extends Sm4CryptoFunction {
6464
*/
6565
public Sm4Decrypt(Expression arg0, Expression arg1) {
6666
super("sm4_decrypt", arg0, arg1);
67+
throw new AnalysisException("Incorrect parameter count in the call to native function "
68+
+ "'sm4_encrypt' or 'sm4_decrypt'");
6769
}
6870

6971
/**

‎fe/fe-core/src/main/java/org/apache/doris/nereids/trees/expressions/functions/scalar/Sm4Encrypt.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ public class Sm4Encrypt extends Sm4CryptoFunction {
5959
*/
6060
public Sm4Encrypt(Expression arg0, Expression arg1) {
6161
super("sm4_encrypt", arg0, arg1);
62+
throw new AnalysisException("Incorrect parameter count in the call to native function "
63+
+ "'sm4_encrypt' or 'sm4_decrypt'");
6264
}
6365

6466
/**

0 commit comments

Comments
 (0)