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.context.AlgorithmSQLContext;
22
23 /**
24 * Encrypt algorithm.
25 */
26 public interface EncryptAlgorithm extends ShardingSphereAlgorithm {
27
28 /**
29 * Encrypt.
30 *
31 * @param plainValue plain value
32 * @param algorithmSQLContext algorithm SQL context
33 * @return cipher value
34 */
35 Object encrypt(Object plainValue, AlgorithmSQLContext algorithmSQLContext);
36
37 /**
38 * Decrypt.
39 *
40 * @param cipherValue cipher value
41 * @param algorithmSQLContext algorithm SQL context
42 * @return plain value
43 */
44 Object decrypt(Object cipherValue, AlgorithmSQLContext algorithmSQLContext);
45
46 /**
47 * Get encrypt algorithm meta data.
48 *
49 * @return encrypt algorithm meta data
50 */
51 EncryptAlgorithmMetaData getMetaData();
52 }