1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18 package org.apache.hadoop.hbase.io.crypto;
19
20 import java.io.OutputStream;
21 import java.security.Key;
22
23 import org.apache.hadoop.hbase.classification.InterfaceAudience;
24 import org.apache.hadoop.hbase.classification.InterfaceStability;
25
26 /**
27 * Encryptors apply a cipher to an OutputStream to produce ciphertext.
28 */
29 @InterfaceAudience.Public
30 @InterfaceStability.Evolving
31 public interface Encryptor {
32
33 /**
34 * Set the secret key
35 * @param key
36 */
37 public void setKey(Key key);
38
39 /**
40 * Get the expected length for the initialization vector
41 * @return the expected length for the initialization vector
42 */
43 public int getIvLength();
44
45 /**
46 * Get the cipher's internal block size
47 * @return the cipher's internal block size
48 */
49 public int getBlockSize();
50
51 /**
52 * Get the initialization vector
53 */
54 public byte[] getIv();
55
56 /**
57 * Set the initialization vector
58 * @param iv
59 */
60 public void setIv(byte[] iv);
61
62 /**
63 * Create a stream for encryption
64 * @param out
65 */
66 public OutputStream createEncryptionStream(OutputStream out);
67
68 /**
69 * Reset state, reinitialize with the key and iv
70 */
71 void reset();
72 }