hadoop-hdfs-project/hadoop-hdfs/src/main/java/org/apache/hadoop/hdfs/tools/CryptoAdmin.java - hadoop-common - Git at Google

 /**
  * 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.hadoop.hdfs.tools;

 import java.io.IOException;
 import java.util.LinkedList;
 import java.util.List;

 import org.apache.hadoop.classification.InterfaceAudience;
 import org.apache.hadoop.conf.Configuration;
 import org.apache.hadoop.conf.Configured;
 import org.apache.hadoop.fs.FileSystem;
 import org.apache.hadoop.fs.Path;
 import org.apache.hadoop.fs.RemoteIterator;
 import org.apache.hadoop.hdfs.DistributedFileSystem;
 import org.apache.hadoop.hdfs.protocol.EncryptionZone;
 import org.apache.hadoop.tools.TableListing;
 import org.apache.hadoop.util.StringUtils;
 import org.apache.hadoop.util.Tool;

 /**
  * This class implements crypto command-line operations.
  */
 @InterfaceAudience.Private
 public class CryptoAdmin extends Configured implements Tool {

   /**
    * Maximum length for printed lines
    */
   private static final int MAX_LINE_WIDTH = 80;

   public CryptoAdmin() {
     this(null);
   }

   public CryptoAdmin(Configuration conf) {
     super(conf);
   }

   @Override
   public int run(String[] args) throws IOException {
     if (args.length == 0) {
       printUsage(false);
       return 1;
     }
     final Command command = determineCommand(args[0]);
     if (command == null) {
       System.err.println("Can't understand command '" + args[0] + "'");
       if (!args[0].startsWith("-")) {
         System.err.println("Command names must start with dashes.");
       }
       printUsage(false);
       return 1;
     }
     final List<String> argsList = new LinkedList<String>();
     for (int j = 1; j < args.length; j++) {
       argsList.add(args[j]);
     }
     try {
       return command.run(getConf(), argsList);
     } catch (IllegalArgumentException e) {
       System.err.println(prettifyException(e));
       return -1;
     }
   }

   public static void main(String[] argsArray) throws IOException {
     final CryptoAdmin cryptoAdmin = new CryptoAdmin(new Configuration());
     System.exit(cryptoAdmin.run(argsArray));
   }

   private static DistributedFileSystem getDFS(Configuration conf)
       throws IOException {
     final FileSystem fs = FileSystem.get(conf);
     if (!(fs instanceof DistributedFileSystem)) {
       throw new IllegalArgumentException("FileSystem " + fs.getUri() +
       " is not an HDFS file system");
     }
     return (DistributedFileSystem) fs;
   }

   /**
    * NN exceptions contain the stack trace as part of the exception message.
    * When it's a known error, pretty-print the error and squish the stack trace.
    */
   private static String prettifyException(Exception e) {
     return e.getClass().getSimpleName() + ": " +
       e.getLocalizedMessage().split("\n")[0];
   }

   private static TableListing getOptionDescriptionListing() {
     final TableListing listing = new TableListing.Builder()
       .addField("").addField("", true)
       .wrapWidth(MAX_LINE_WIDTH).hideHeaders().build();
     return listing;
   }

   interface Command {
     String getName();
     String getShortUsage();
     String getLongUsage();
     int run(Configuration conf, List<String> args) throws IOException;
   }

   private static class CreateZoneCommand implements Command {
     @Override
     public String getName() {
       return "-createZone";
     }

     @Override
     public String getShortUsage() {
       return "[" + getName() + " -keyName <keyName> -path <path>]\n";
     }

     @Override
     public String getLongUsage() {
       final TableListing listing = getOptionDescriptionListing();
       listing.addRow("<path>", "The path of the encryption zone to create. " +
         "It must be an empty directory.");
       listing.addRow("<keyName>", "Name of the key to use for the " +
           "encryption zone.");
       return getShortUsage() + "\n" +
         "Create a new encryption zone.\n\n" +
         listing.toString();
     }

     @Override
     public int run(Configuration conf, List<String> args) throws IOException {
       final String path = StringUtils.popOptionWithArgument("-path", args);
       if (path == null) {
         System.err.println("You must specify a path with -path.");
         return 1;
       }

       final String keyName =
           StringUtils.popOptionWithArgument("-keyName", args);
       if (keyName == null) {
         System.err.println("You must specify a key name with -keyName.");
         return 1;
       }

       if (!args.isEmpty()) {
         System.err.println("Can't understand argument: " + args.get(0));
         return 1;
       }

       final DistributedFileSystem dfs = getDFS(conf);
       try {
         dfs.createEncryptionZone(new Path(path), keyName);
         System.out.println("Added encryption zone " + path);
       } catch (IOException e) {
         System.err.println(prettifyException(e));
         return 2;
       }

       return 0;
     }
   }

   private static class ListZonesCommand implements Command {
     @Override
     public String getName() {
       return "-listZones";
     }

     @Override
     public String getShortUsage() {
       return "[" + getName()+ "]\n";
     }

     @Override
     public String getLongUsage() {
       return getShortUsage() + "\n" +
         "List all encryption zones. Requires superuser permissions.\n\n";
     }

     @Override
     public int run(Configuration conf, List<String> args) throws IOException {
       if (!args.isEmpty()) {
         System.err.println("Can't understand argument: " + args.get(0));
         return 1;
       }

       final DistributedFileSystem dfs = getDFS(conf);
       try {
         final TableListing listing = new TableListing.Builder()
           .addField("").addField("", true)
           .wrapWidth(MAX_LINE_WIDTH).hideHeaders().build();
         final RemoteIterator<EncryptionZone> it = dfs.listEncryptionZones();
         while (it.hasNext()) {
           EncryptionZone ez = it.next();
           listing.addRow(ez.getPath(), ez.getKeyName());
         }
         System.out.println(listing.toString());
       } catch (IOException e) {
         System.err.println(prettifyException(e));
         return 2;
       }

       return 0;
     }
   }

   private static class HelpCommand implements Command {
     @Override
     public String getName() {
       return "-help";
     }

     @Override
     public String getShortUsage() {
       return "[-help <command-name>]\n";
     }

     @Override
     public String getLongUsage() {
       final TableListing listing = getOptionDescriptionListing();
       listing.addRow("<command-name>", "The command for which to get " +
           "detailed help. If no command is specified, print detailed help for " +
           "all commands");
       return getShortUsage() + "\n" +
         "Get detailed help about a command.\n\n" +
         listing.toString();
     }

     @Override
     public int run(Configuration conf, List<String> args) throws IOException {
       if (args.size() == 0) {
         for (Command command : COMMANDS) {
           System.err.println(command.getLongUsage());
         }
         return 0;
       }
       if (args.size() != 1) {
         System.out.println("You must give exactly one argument to -help.");
         return 0;
       }
       final String commandName = args.get(0);
       // prepend a dash to match against the command names
       final Command command = determineCommand("-"+commandName);
       if (command == null) {
         System.err.print("Sorry, I don't know the command '" +
           commandName + "'.\n");
         System.err.print("Valid help command names are:\n");
         String separator = "";
         for (Command c : COMMANDS) {
           System.err.print(separator + c.getName().substring(1));
           separator = ", ";
         }
         System.err.print("\n");
         return 1;
       }
       System.err.print(command.getLongUsage());
       return 0;
     }
   }

   private static final Command[] COMMANDS = {
     new CreateZoneCommand(),
     new ListZonesCommand(),
     new HelpCommand(),
   };

   private static void printUsage(boolean longUsage) {
     System.err.println(
         "Usage: bin/hdfs crypto [COMMAND]");
     for (Command command : COMMANDS) {
       if (longUsage) {
         System.err.print(command.getLongUsage());
       } else {
         System.err.print("          " + command.getShortUsage());
       }
     }
     System.err.println();
   }

   private static Command determineCommand(String commandName) {
     for (int i = 0; i < COMMANDS.length; i++) {
       if (COMMANDS[i].getName().equals(commandName)) {
         return COMMANDS[i];
       }
     }
     return null;
   }
 }
	/**
	* 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.hadoop.hdfs.tools;

	import java.io.IOException;
	import java.util.LinkedList;
	import java.util.List;

	import org.apache.hadoop.classification.InterfaceAudience;
	import org.apache.hadoop.conf.Configuration;
	import org.apache.hadoop.conf.Configured;
	import org.apache.hadoop.fs.FileSystem;
	import org.apache.hadoop.fs.Path;
	import org.apache.hadoop.fs.RemoteIterator;
	import org.apache.hadoop.hdfs.DistributedFileSystem;
	import org.apache.hadoop.hdfs.protocol.EncryptionZone;
	import org.apache.hadoop.tools.TableListing;
	import org.apache.hadoop.util.StringUtils;
	import org.apache.hadoop.util.Tool;

	/**
	* This class implements crypto command-line operations.
	*/
	@InterfaceAudience.Private
	public class CryptoAdmin extends Configured implements Tool {

	/**
	* Maximum length for printed lines
	*/
	private static final int MAX_LINE_WIDTH = 80;

	public CryptoAdmin() {
	this(null);
	}

	public CryptoAdmin(Configuration conf) {
	super(conf);
	}

	@Override
	public int run(String[] args) throws IOException {
	if (args.length == 0) {
	printUsage(false);
	return 1;
	}
	final Command command = determineCommand(args[0]);
	if (command == null) {
	System.err.println("Can't understand command '" + args[0] + "'");
	if (!args[0].startsWith("-")) {
	System.err.println("Command names must start with dashes.");
	}
	printUsage(false);
	return 1;
	}
	final List<String> argsList = new LinkedList<String>();
	for (int j = 1; j < args.length; j++) {
	argsList.add(args[j]);
	}
	try {
	return command.run(getConf(), argsList);
	} catch (IllegalArgumentException e) {
	System.err.println(prettifyException(e));
	return -1;
	}
	}

	public static void main(String[] argsArray) throws IOException {
	final CryptoAdmin cryptoAdmin = new CryptoAdmin(new Configuration());
	System.exit(cryptoAdmin.run(argsArray));
	}

	private static DistributedFileSystem getDFS(Configuration conf)
	throws IOException {
	final FileSystem fs = FileSystem.get(conf);
	if (!(fs instanceof DistributedFileSystem)) {
	throw new IllegalArgumentException("FileSystem " + fs.getUri() +
	" is not an HDFS file system");
	}
	return (DistributedFileSystem) fs;
	}

	/**
	* NN exceptions contain the stack trace as part of the exception message.
	* When it's a known error, pretty-print the error and squish the stack trace.
	*/
	private static String prettifyException(Exception e) {
	return e.getClass().getSimpleName() + ": " +
	e.getLocalizedMessage().split("\n")[0];
	}

	private static TableListing getOptionDescriptionListing() {
	final TableListing listing = new TableListing.Builder()
	.addField("").addField("", true)
	.wrapWidth(MAX_LINE_WIDTH).hideHeaders().build();
	return listing;
	}

	interface Command {
	String getName();
	String getShortUsage();
	String getLongUsage();
	int run(Configuration conf, List<String> args) throws IOException;
	}

	private static class CreateZoneCommand implements Command {
	@Override
	public String getName() {
	return "-createZone";
	}

	@Override
	public String getShortUsage() {
	return "[" + getName() + " -keyName <keyName> -path <path>]\n";
	}

	@Override
	public String getLongUsage() {
	final TableListing listing = getOptionDescriptionListing();
	listing.addRow("<path>", "The path of the encryption zone to create. " +
	"It must be an empty directory.");
	listing.addRow("<keyName>", "Name of the key to use for the " +
	"encryption zone.");
	return getShortUsage() + "\n" +
	"Create a new encryption zone.\n\n" +
	listing.toString();
	}

	@Override
	public int run(Configuration conf, List<String> args) throws IOException {
	final String path = StringUtils.popOptionWithArgument("-path", args);
	if (path == null) {
	System.err.println("You must specify a path with -path.");
	return 1;
	}

	final String keyName =
	StringUtils.popOptionWithArgument("-keyName", args);
	if (keyName == null) {
	System.err.println("You must specify a key name with -keyName.");
	return 1;
	}

	if (!args.isEmpty()) {
	System.err.println("Can't understand argument: " + args.get(0));
	return 1;
	}

	final DistributedFileSystem dfs = getDFS(conf);
	try {
	dfs.createEncryptionZone(new Path(path), keyName);
	System.out.println("Added encryption zone " + path);
	} catch (IOException e) {
	System.err.println(prettifyException(e));
	return 2;
	}

	return 0;
	}
	}

	private static class ListZonesCommand implements Command {
	@Override
	public String getName() {
	return "-listZones";
	}

	@Override
	public String getShortUsage() {
	return "[" + getName()+ "]\n";
	}

	@Override
	public String getLongUsage() {
	return getShortUsage() + "\n" +
	"List all encryption zones. Requires superuser permissions.\n\n";
	}

	@Override
	public int run(Configuration conf, List<String> args) throws IOException {
	if (!args.isEmpty()) {
	System.err.println("Can't understand argument: " + args.get(0));
	return 1;
	}

	final DistributedFileSystem dfs = getDFS(conf);
	try {
	final TableListing listing = new TableListing.Builder()
	.addField("").addField("", true)
	.wrapWidth(MAX_LINE_WIDTH).hideHeaders().build();
	final RemoteIterator<EncryptionZone> it = dfs.listEncryptionZones();
	while (it.hasNext()) {
	EncryptionZone ez = it.next();
	listing.addRow(ez.getPath(), ez.getKeyName());
	}
	System.out.println(listing.toString());
	} catch (IOException e) {
	System.err.println(prettifyException(e));
	return 2;
	}

	return 0;
	}
	}

	private static class HelpCommand implements Command {
	@Override
	public String getName() {
	return "-help";
	}

	@Override
	public String getShortUsage() {
	return "[-help <command-name>]\n";
	}

	@Override
	public String getLongUsage() {
	final TableListing listing = getOptionDescriptionListing();
	listing.addRow("<command-name>", "The command for which to get " +
	"detailed help. If no command is specified, print detailed help for " +
	"all commands");
	return getShortUsage() + "\n" +
	"Get detailed help about a command.\n\n" +
	listing.toString();
	}

	@Override
	public int run(Configuration conf, List<String> args) throws IOException {
	if (args.size() == 0) {
	for (Command command : COMMANDS) {
	System.err.println(command.getLongUsage());
	}
	return 0;
	}
	if (args.size() != 1) {
	System.out.println("You must give exactly one argument to -help.");
	return 0;
	}
	final String commandName = args.get(0);
	// prepend a dash to match against the command names
	final Command command = determineCommand("-"+commandName);
	if (command == null) {
	System.err.print("Sorry, I don't know the command '" +
	commandName + "'.\n");
	System.err.print("Valid help command names are:\n");
	String separator = "";
	for (Command c : COMMANDS) {
	System.err.print(separator + c.getName().substring(1));
	separator = ", ";
	}
	System.err.print("\n");
	return 1;
	}
	System.err.print(command.getLongUsage());
	return 0;
	}
	}

	private static final Command[] COMMANDS = {
	new CreateZoneCommand(),
	new ListZonesCommand(),
	new HelpCommand(),
	};

	private static void printUsage(boolean longUsage) {
	System.err.println(
	"Usage: bin/hdfs crypto [COMMAND]");
	for (Command command : COMMANDS) {
	if (longUsage) {
	System.err.print(command.getLongUsage());
	} else {
	System.err.print(" " + command.getShortUsage());
	}
	}
	System.err.println();
	}

	private static Command determineCommand(String commandName) {
	for (int i = 0; i < COMMANDS.length; i++) {
	if (COMMANDS[i].getName().equals(commandName)) {
	return COMMANDS[i];
	}
	}
	return null;
	}
	}