1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with this
4 * work for additional information regarding copyright ownership. The ASF
5 * licenses this file to you under the Apache License, Version 2.0 (the
6 * "License"); you may not use this file except in compliance with the License.
7 * 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, WITHOUT
13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 * License for the specific language governing permissions and limitations under
15 * the License.
16 */
17 package org.apache.hadoop.hbase.io.crypto;
18
19 import java.security.Key;
20
21 import org.apache.hadoop.hbase.classification.InterfaceAudience;
22 import org.apache.hadoop.hbase.classification.InterfaceStability;
23
24 /**
25 * KeyProvider is a interface to abstract the different methods of retrieving
26 * key material from key storage such as Java key store.
27 *
28 */
29 @InterfaceAudience.Public
30 @InterfaceStability.Evolving
31 public interface KeyProvider {
32
33 public static final String PASSWORD = "password";
34 public static final String PASSWORDFILE = "passwordfile";
35
36 /**
37 * Initialize the key provider
38 * @param params
39 */
40 public void init(String params);
41
42 /**
43 * Retrieve the key for a given key aliase
44 * @param alias
45 * @return the keys corresponding to the supplied alias, or null if a key is
46 * not found
47 */
48 public Key getKey(String alias);
49
50 /**
51 * Retrieve keys for a given set of key aliases
52 * @param aliases an array of aliases
53 * @return an array of keys corresponding to the supplied aliases, an
54 * entry will be null if a key is not found
55 */
56 public Key[] getKeys(String[] aliases);
57
58 }