-
Notifications
You must be signed in to change notification settings - Fork 507
Expand file tree
/
Copy pathEncryptionVariant.java
More file actions
68 lines (60 loc) · 2.14 KB
/
EncryptionVariant.java
File metadata and controls
68 lines (60 loc) · 2.14 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.orc;
import java.io.IOException;
import java.security.Key;
/**
* Information about a column encryption variant.
* <p>
* Column encryption is done by encoding multiple variants of the same column.
* Each encrypted column ends up in two variants:
* <ul>
* <li>Encrypted original</li>
* <li>Unencrypted masked</li>
* </ul>
* @since 1.6.0
*/
public interface EncryptionVariant extends Comparable<EncryptionVariant> {
/**
* Get the key description for this column. This description is global to the
* file and is passed to the KeyProvider along with various encrypted local
* keys for the stripes or file footer so that it can decrypt them.
* @return the encryption key description
*/
EncryptionKey getKeyDescription();
/**
* Get the root column for this variant.
* @return the root column type
*/
TypeDescription getRoot();
/**
* Get the encryption variant id within the file.
*/
int getVariantId();
/**
* Get the local key for the footer.
* @return the local decrypted key or null if it isn't available
*/
Key getFileFooterKey() throws IOException;
/**
* Get the local key for a stripe's data or footer.
* @param stripe the stripe within the file (0 to N-1)
* @return the local decrypted key or null if it isn't available
*/
Key getStripeKey(long stripe) throws IOException;
}