HADOOP-10583. bin/hadoop key throws NPE with no args and assorted other fixups. (clamb via tucu)
git-svn-id: https://svn.apache.org/repos/asf/hadoop/common/trunk@1594320 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Alejandro Abdelnur
parent
4bc3371824
commit
c54a4bb666
|
|
@ -326,6 +326,8 @@ Trunk (Unreleased)
|
|||
|
||||
HADOOP-10431. Change visibility of KeyStore.Options getter methods to public. (tucu)
|
||||
|
||||
HADOOP-10583. bin/hadoop key throws NPE with no args and assorted other fixups. (clamb via tucu)
|
||||
|
||||
OPTIMIZATIONS
|
||||
|
||||
HADOOP-7761. Improve the performance of raw comparisons. (todd)
|
||||
|
|
|
|||
|
|
@ -27,9 +27,7 @@ import java.net.URI;
|
|||
import java.security.NoSuchAlgorithmException;
|
||||
import java.text.MessageFormat;
|
||||
import java.util.Date;
|
||||
import java.util.LinkedHashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
import com.google.gson.stream.JsonReader;
|
||||
import com.google.gson.stream.JsonWriter;
|
||||
|
|
@ -176,6 +174,7 @@ public abstract class KeyProvider {
|
|||
protected byte[] serialize() throws IOException {
|
||||
ByteArrayOutputStream buffer = new ByteArrayOutputStream();
|
||||
JsonWriter writer = new JsonWriter(new OutputStreamWriter(buffer));
|
||||
try {
|
||||
writer.beginObject();
|
||||
if (cipher != null) {
|
||||
writer.name(CIPHER_FIELD).value(cipher);
|
||||
|
|
@ -192,6 +191,9 @@ public abstract class KeyProvider {
|
|||
writer.name(VERSIONS_FIELD).value(versions);
|
||||
writer.endObject();
|
||||
writer.flush();
|
||||
} finally {
|
||||
writer.close();
|
||||
}
|
||||
return buffer.toByteArray();
|
||||
}
|
||||
|
||||
|
|
@ -208,6 +210,7 @@ public abstract class KeyProvider {
|
|||
String description = null;
|
||||
JsonReader reader = new JsonReader(new InputStreamReader
|
||||
(new ByteArrayInputStream(bytes)));
|
||||
try {
|
||||
reader.beginObject();
|
||||
while (reader.hasNext()) {
|
||||
String field = reader.nextName();
|
||||
|
|
@ -224,6 +227,9 @@ public abstract class KeyProvider {
|
|||
}
|
||||
}
|
||||
reader.endObject();
|
||||
} finally {
|
||||
reader.close();
|
||||
}
|
||||
this.cipher = cipher;
|
||||
this.bitLength = bitLength;
|
||||
this.created = created;
|
||||
|
|
@ -310,7 +316,6 @@ public abstract class KeyProvider {
|
|||
*/
|
||||
public abstract List<String> getKeys() throws IOException;
|
||||
|
||||
|
||||
/**
|
||||
* Get key metadata in bulk.
|
||||
* @param names the names of the keys to get
|
||||
|
|
|
|||
|
|
@ -23,9 +23,6 @@ import java.io.PrintStream;
|
|||
import java.security.InvalidParameterException;
|
||||
import java.security.NoSuchAlgorithmException;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
import javax.crypto.KeyGenerator;
|
||||
|
||||
import org.apache.hadoop.conf.Configuration;
|
||||
import org.apache.hadoop.conf.Configured;
|
||||
|
|
@ -93,41 +90,54 @@ public class KeyShell extends Configured implements Tool {
|
|||
*/
|
||||
private int init(String[] args) throws IOException {
|
||||
for (int i = 0; i < args.length; i++) { // parse command line
|
||||
boolean moreTokens = (i < args.length - 1);
|
||||
if (args[i].equals("create")) {
|
||||
String keyName = args[++i];
|
||||
String keyName = "--help";
|
||||
if (moreTokens) {
|
||||
keyName = args[++i];
|
||||
}
|
||||
|
||||
command = new CreateCommand(keyName);
|
||||
if (keyName.equals("--help")) {
|
||||
if ("--help".equals(keyName)) {
|
||||
printKeyShellUsage();
|
||||
return -1;
|
||||
}
|
||||
} else if (args[i].equals("delete")) {
|
||||
String keyName = args[++i];
|
||||
String keyName = "--help";
|
||||
if (moreTokens) {
|
||||
keyName = args[++i];
|
||||
}
|
||||
|
||||
command = new DeleteCommand(keyName);
|
||||
if (keyName.equals("--help")) {
|
||||
if ("--help".equals(keyName)) {
|
||||
printKeyShellUsage();
|
||||
return -1;
|
||||
}
|
||||
} else if (args[i].equals("roll")) {
|
||||
String keyName = args[++i];
|
||||
String keyName = "--help";
|
||||
if (moreTokens) {
|
||||
keyName = args[++i];
|
||||
}
|
||||
|
||||
command = new RollCommand(keyName);
|
||||
if (keyName.equals("--help")) {
|
||||
if ("--help".equals(keyName)) {
|
||||
printKeyShellUsage();
|
||||
return -1;
|
||||
}
|
||||
} else if (args[i].equals("list")) {
|
||||
} else if ("list".equals(args[i])) {
|
||||
command = new ListCommand();
|
||||
} else if (args[i].equals("--size")) {
|
||||
} else if ("--size".equals(args[i]) && moreTokens) {
|
||||
getConf().set(KeyProvider.DEFAULT_BITLENGTH_NAME, args[++i]);
|
||||
} else if (args[i].equals("--cipher")) {
|
||||
} else if ("--cipher".equals(args[i]) && moreTokens) {
|
||||
getConf().set(KeyProvider.DEFAULT_CIPHER_NAME, args[++i]);
|
||||
} else if (args[i].equals("--provider")) {
|
||||
} else if ("--provider".equals(args[i]) && moreTokens) {
|
||||
userSuppliedProvider = true;
|
||||
getConf().set(KeyProviderFactory.KEY_PROVIDER_PATH, args[++i]);
|
||||
} else if (args[i].equals("--metadata")) {
|
||||
} else if ("--metadata".equals(args[i])) {
|
||||
getConf().setBoolean(LIST_METADATA, true);
|
||||
} else if (args[i].equals("-i") || (args[i].equals("--interactive"))) {
|
||||
} else if ("-i".equals(args[i]) || ("--interactive".equals(args[i]))) {
|
||||
interactive = true;
|
||||
} else if (args[i].equals("--help")) {
|
||||
} else if ("--help".equals(args[i])) {
|
||||
printKeyShellUsage();
|
||||
return -1;
|
||||
} else {
|
||||
|
|
@ -136,6 +146,12 @@ public class KeyShell extends Configured implements Tool {
|
|||
return -1;
|
||||
}
|
||||
}
|
||||
|
||||
if (command == null) {
|
||||
printKeyShellUsage();
|
||||
return -1;
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
|
|
@ -143,8 +159,7 @@ public class KeyShell extends Configured implements Tool {
|
|||
out.println(USAGE_PREFIX + COMMANDS);
|
||||
if (command != null) {
|
||||
out.println(command.getUsage());
|
||||
}
|
||||
else {
|
||||
} else {
|
||||
out.println("=========================================================" +
|
||||
"======");
|
||||
out.println(CreateCommand.USAGE + ":\n\n" + CreateCommand.DESC);
|
||||
|
|
@ -174,8 +189,7 @@ public class KeyShell extends Configured implements Tool {
|
|||
providers = KeyProviderFactory.getProviders(getConf());
|
||||
if (userSuppliedProvider) {
|
||||
provider = providers.get(0);
|
||||
}
|
||||
else {
|
||||
} else {
|
||||
for (KeyProvider p : providers) {
|
||||
if (!p.isTransient()) {
|
||||
provider = p;
|
||||
|
|
@ -190,7 +204,7 @@ public class KeyShell extends Configured implements Tool {
|
|||
}
|
||||
|
||||
protected void printProviderWritten() {
|
||||
out.println(provider.getClass().getName() + " has been updated.");
|
||||
out.println(provider + " has been updated.");
|
||||
}
|
||||
|
||||
protected void warnIfTransientProvider() {
|
||||
|
|
@ -206,12 +220,12 @@ public class KeyShell extends Configured implements Tool {
|
|||
|
||||
private class ListCommand extends Command {
|
||||
public static final String USAGE =
|
||||
"list [--provider] [--metadata] [--help]";
|
||||
"list [--provider <provider>] [--metadata] [--help]";
|
||||
public static final String DESC =
|
||||
"The list subcommand displays the keynames contained within\n" +
|
||||
"a particular provider - as configured in core-site.xml or " +
|
||||
"indicated\nthrough the --provider argument.\n" +
|
||||
"If the --metadata option is used, the keys metadata will be printed";
|
||||
"a particular provider as configured in core-site.xml or\n" +
|
||||
"specified with the --provider argument. --metadata displays\n" +
|
||||
"the metadata.";
|
||||
|
||||
private boolean metadata = false;
|
||||
|
||||
|
|
@ -220,9 +234,9 @@ public class KeyShell extends Configured implements Tool {
|
|||
provider = getKeyProvider();
|
||||
if (provider == null) {
|
||||
out.println("There are no non-transient KeyProviders configured.\n"
|
||||
+ "Consider using the --provider option to indicate the provider\n"
|
||||
+ "to use. If you want to list a transient provider then you\n"
|
||||
+ "you MUST use the --provider argument.");
|
||||
+ "Use the --provider option to specify a provider. If you\n"
|
||||
+ "want to list a transient provider then you must use the\n"
|
||||
+ "--provider argument.");
|
||||
rc = false;
|
||||
}
|
||||
metadata = getConf().getBoolean(LIST_METADATA, false);
|
||||
|
|
@ -231,10 +245,10 @@ public class KeyShell extends Configured implements Tool {
|
|||
|
||||
public void execute() throws IOException {
|
||||
try {
|
||||
List<String> keys = provider.getKeys();
|
||||
out.println("Listing keys for KeyProvider: " + provider.toString());
|
||||
final List<String> keys = provider.getKeys();
|
||||
out.println("Listing keys for KeyProvider: " + provider);
|
||||
if (metadata) {
|
||||
Metadata[] meta =
|
||||
final Metadata[] meta =
|
||||
provider.getKeysMetadata(keys.toArray(new String[keys.size()]));
|
||||
for (int i = 0; i < meta.length; ++i) {
|
||||
out.println(keys.get(i) + " : " + meta[i]);
|
||||
|
|
@ -245,7 +259,7 @@ public class KeyShell extends Configured implements Tool {
|
|||
}
|
||||
}
|
||||
} catch (IOException e) {
|
||||
out.println("Cannot list keys for KeyProvider: " + provider.toString()
|
||||
out.println("Cannot list keys for KeyProvider: " + provider
|
||||
+ ": " + e.getMessage());
|
||||
throw e;
|
||||
}
|
||||
|
|
@ -258,11 +272,10 @@ public class KeyShell extends Configured implements Tool {
|
|||
}
|
||||
|
||||
private class RollCommand extends Command {
|
||||
public static final String USAGE = "roll <keyname> [--provider] [--help]";
|
||||
public static final String USAGE = "roll <keyname> [--provider <provider>] [--help]";
|
||||
public static final String DESC =
|
||||
"The roll subcommand creates a new version of the key specified\n" +
|
||||
"through the <keyname> argument within the provider indicated using\n" +
|
||||
"the --provider argument";
|
||||
"The roll subcommand creates a new version for the specified key\n" +
|
||||
"within the provider indicated using the --provider argument\n";
|
||||
|
||||
String keyName = null;
|
||||
|
||||
|
|
@ -274,15 +287,14 @@ public class KeyShell extends Configured implements Tool {
|
|||
boolean rc = true;
|
||||
provider = getKeyProvider();
|
||||
if (provider == null) {
|
||||
out.println("There are no valid KeyProviders configured.\n"
|
||||
+ "Key will not be rolled.\n"
|
||||
+ "Consider using the --provider option to indicate the provider"
|
||||
+ " to use.");
|
||||
out.println("There are no valid KeyProviders configured. The key\n" +
|
||||
"has not been rolled. Use the --provider option to specify\n" +
|
||||
"a provider.");
|
||||
rc = false;
|
||||
}
|
||||
if (keyName == null) {
|
||||
out.println("There is no keyName specified. Please provide the" +
|
||||
"mandatory <keyname>. See the usage description with --help.");
|
||||
out.println("Please provide a <keyname>.\n" +
|
||||
"See the usage description by using --help.");
|
||||
rc = false;
|
||||
}
|
||||
return rc;
|
||||
|
|
@ -290,10 +302,9 @@ public class KeyShell extends Configured implements Tool {
|
|||
|
||||
public void execute() throws NoSuchAlgorithmException, IOException {
|
||||
try {
|
||||
Metadata md = provider.getMetadata(keyName);
|
||||
warnIfTransientProvider();
|
||||
out.println("Rolling key version from KeyProvider: "
|
||||
+ provider.toString() + " for key name: " + keyName);
|
||||
+ provider + "\n for key name: " + keyName);
|
||||
try {
|
||||
provider.rollNewVersion(keyName);
|
||||
out.println(keyName + " has been successfully rolled.");
|
||||
|
|
@ -301,12 +312,12 @@ public class KeyShell extends Configured implements Tool {
|
|||
printProviderWritten();
|
||||
} catch (NoSuchAlgorithmException e) {
|
||||
out.println("Cannot roll key: " + keyName + " within KeyProvider: "
|
||||
+ provider.toString());
|
||||
+ provider);
|
||||
throw e;
|
||||
}
|
||||
} catch (IOException e1) {
|
||||
out.println("Cannot roll key: " + keyName + " within KeyProvider: "
|
||||
+ provider.toString());
|
||||
+ provider);
|
||||
throw e1;
|
||||
}
|
||||
}
|
||||
|
|
@ -318,11 +329,11 @@ public class KeyShell extends Configured implements Tool {
|
|||
}
|
||||
|
||||
private class DeleteCommand extends Command {
|
||||
public static final String USAGE = "delete <keyname> [--provider] [--help]";
|
||||
public static final String USAGE = "delete <keyname> [--provider <provider>] [--help]";
|
||||
public static final String DESC =
|
||||
"The delete subcommand deletes all of the versions of the key\n" +
|
||||
"specified as the <keyname> argument from within the provider\n" +
|
||||
"indicated through the --provider argument";
|
||||
"The delete subcommand deletes all versions of the key\n" +
|
||||
"specified by the <keyname> argument from within the\n" +
|
||||
"provider specified --provider.";
|
||||
|
||||
String keyName = null;
|
||||
boolean cont = true;
|
||||
|
|
@ -335,23 +346,21 @@ public class KeyShell extends Configured implements Tool {
|
|||
public boolean validate() {
|
||||
provider = getKeyProvider();
|
||||
if (provider == null) {
|
||||
out.println("There are no valid KeyProviders configured.\n"
|
||||
+ "Nothing will be deleted.\n"
|
||||
+ "Consider using the --provider option to indicate the provider"
|
||||
+ " to use.");
|
||||
out.println("There are no valid KeyProviders configured. Nothing\n"
|
||||
+ "was deleted. Use the --provider option to specify a provider.");
|
||||
return false;
|
||||
}
|
||||
if (keyName == null) {
|
||||
out.println("There is no keyName specified. Please provide the" +
|
||||
"mandatory <keyname>. See the usage description with --help.");
|
||||
out.println("There is no keyName specified. Please specify a " +
|
||||
"<keyname>. See the usage description with --help.");
|
||||
return false;
|
||||
}
|
||||
if (interactive) {
|
||||
try {
|
||||
cont = ToolRunner
|
||||
.confirmPrompt("You are about to DELETE all versions of "
|
||||
+ "the key: " + keyName + " from KeyProvider "
|
||||
+ provider.toString() + ". Continue?:");
|
||||
+ " key: " + keyName + " from KeyProvider "
|
||||
+ provider + ". Continue?:");
|
||||
if (!cont) {
|
||||
out.println("Nothing has been be deleted.");
|
||||
}
|
||||
|
|
@ -367,7 +376,7 @@ public class KeyShell extends Configured implements Tool {
|
|||
public void execute() throws IOException {
|
||||
warnIfTransientProvider();
|
||||
out.println("Deleting key: " + keyName + " from KeyProvider: "
|
||||
+ provider.toString());
|
||||
+ provider);
|
||||
if (cont) {
|
||||
try {
|
||||
provider.deleteKey(keyName);
|
||||
|
|
@ -375,7 +384,7 @@ public class KeyShell extends Configured implements Tool {
|
|||
provider.flush();
|
||||
printProviderWritten();
|
||||
} catch (IOException e) {
|
||||
out.println(keyName + "has NOT been deleted.");
|
||||
out.println(keyName + " has not been deleted.");
|
||||
throw e;
|
||||
}
|
||||
}
|
||||
|
|
@ -388,16 +397,16 @@ public class KeyShell extends Configured implements Tool {
|
|||
}
|
||||
|
||||
private class CreateCommand extends Command {
|
||||
public static final String USAGE = "create <keyname> [--cipher] " +
|
||||
"[--size] [--provider] [--help]";
|
||||
public static final String USAGE =
|
||||
"create <keyname> [--cipher <cipher>] [--size <size>]\n" +
|
||||
" [--provider <provider>] [--help]";
|
||||
public static final String DESC =
|
||||
"The create subcommand creates a new key for the name specified\n" +
|
||||
"as the <keyname> argument within the provider indicated through\n" +
|
||||
"the --provider argument. You may also indicate the specific\n" +
|
||||
"cipher through the --cipher argument. The default for cipher is\n" +
|
||||
"currently \"AES/CTR/NoPadding\". The default keysize is \"256\".\n" +
|
||||
"You may also indicate the requested key length through the --size\n" +
|
||||
"argument.";
|
||||
"by the <keyname> argument within the provider specified by the\n" +
|
||||
"--provider argument. You may specify a cipher with the --cipher\n" +
|
||||
"argument. The default cipher is currently \"AES/CTR/NoPadding\".\n" +
|
||||
"The default keysize is 256. You may specify the requested key\n" +
|
||||
"length using the --size argument.\n";
|
||||
|
||||
String keyName = null;
|
||||
|
||||
|
|
@ -409,15 +418,14 @@ public class KeyShell extends Configured implements Tool {
|
|||
boolean rc = true;
|
||||
provider = getKeyProvider();
|
||||
if (provider == null) {
|
||||
out.println("There are no valid KeyProviders configured.\nKey" +
|
||||
" will not be created.\n"
|
||||
+ "Consider using the --provider option to indicate the provider" +
|
||||
" to use.");
|
||||
out.println("There are no valid KeyProviders configured. No key\n" +
|
||||
" was created. You can use the --provider option to specify\n" +
|
||||
" a provider to use.");
|
||||
rc = false;
|
||||
}
|
||||
if (keyName == null) {
|
||||
out.println("There is no keyName specified. Please provide the" +
|
||||
"mandatory <keyname>. See the usage description with --help.");
|
||||
out.println("Please provide a <keyname>. See the usage description" +
|
||||
" with --help.");
|
||||
rc = false;
|
||||
}
|
||||
return rc;
|
||||
|
|
@ -432,13 +440,13 @@ public class KeyShell extends Configured implements Tool {
|
|||
provider.flush();
|
||||
printProviderWritten();
|
||||
} catch (InvalidParameterException e) {
|
||||
out.println(keyName + " has NOT been created. " + e.getMessage());
|
||||
out.println(keyName + " has not been created. " + e.getMessage());
|
||||
throw e;
|
||||
} catch (IOException e) {
|
||||
out.println(keyName + " has NOT been created. " + e.getMessage());
|
||||
out.println(keyName + " has not been created. " + e.getMessage());
|
||||
throw e;
|
||||
} catch (NoSuchAlgorithmException e) {
|
||||
out.println(keyName + " has NOT been created. " + e.getMessage());
|
||||
out.println(keyName + " has not been created. " + e.getMessage());
|
||||
throw e;
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -126,7 +126,6 @@ public class KMSClientProvider extends KeyProvider {
|
|||
return o;
|
||||
}
|
||||
|
||||
|
||||
public static String checkNotEmpty(String s, String name)
|
||||
throws IllegalArgumentException {
|
||||
checkNotNull(s, name);
|
||||
|
|
@ -140,6 +139,13 @@ public class KMSClientProvider extends KeyProvider {
|
|||
private String kmsUrl;
|
||||
private SSLFactory sslFactory;
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
final StringBuilder sb = new StringBuilder("KMSClientProvider[");
|
||||
sb.append(kmsUrl).append("]");
|
||||
return sb.toString();
|
||||
}
|
||||
|
||||
public KMSClientProvider(URI uri, Configuration conf) throws IOException {
|
||||
Path path = unnestUri(uri);
|
||||
URL url = path.toUri().toURL();
|
||||
|
|
@ -515,5 +521,4 @@ public class KMSClientProvider extends KeyProvider {
|
|||
public static String buildVersionName(String name, int version) {
|
||||
return KeyProvider.buildVersionName(name, version);
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
|||
|
|
@ -121,7 +121,7 @@ public class TestKeyShell {
|
|||
ks.setConf(new Configuration());
|
||||
rc = ks.run(args1);
|
||||
assertEquals(-1, rc);
|
||||
assertTrue(outContent.toString().contains("key1 has NOT been created."));
|
||||
assertTrue(outContent.toString().contains("key1 has not been created."));
|
||||
}
|
||||
|
||||
@Test
|
||||
|
|
@ -134,7 +134,7 @@ public class TestKeyShell {
|
|||
ks.setConf(new Configuration());
|
||||
rc = ks.run(args1);
|
||||
assertEquals(-1, rc);
|
||||
assertTrue(outContent.toString().contains("key1 has NOT been created."));
|
||||
assertTrue(outContent.toString().contains("key1 has not been created."));
|
||||
}
|
||||
|
||||
@Test
|
||||
|
|
|
|||
Loading…
Reference in New Issue