1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.shardingsphere.encrypt.spi;
19
20 import org.apache.shardingsphere.infra.algorithm.core.ShardingSphereAlgorithm;
21 import org.apache.shardingsphere.infra.algorithm.core.config.AlgorithmConfiguration;
22 import org.apache.shardingsphere.infra.algorithm.core.context.AlgorithmSQLContext;
23
24 /**
25 * Encrypt algorithm.
26 */
27 public interface EncryptAlgorithm extends ShardingSphereAlgorithm {
28
29 /**
30 * Encrypt.
31 *
32 * @param plainValue plain value
33 * @param algorithmSQLContext algorithm SQL context
34 * @return cipher value
35 */
36 Object encrypt(Object plainValue, AlgorithmSQLContext algorithmSQLContext);
37
38 /**
39 * Decrypt.
40 *
41 * @param cipherValue cipher value
42 * @param algorithmSQLContext algorithm SQL context
43 * @return plain value
44 */
45 Object decrypt(Object cipherValue, AlgorithmSQLContext algorithmSQLContext);
46
47 /**
48 * Get encrypt algorithm meta data.
49 *
50 * @return encrypt algorithm meta data
51 */
52 EncryptAlgorithmMetaData getMetaData();
53
54 /**
55 * convert to encryptor configuration.
56 *
57 * @return converted configuration
58 */
59 AlgorithmConfiguration toConfiguration();
60 }