blob: 9608d61fabd095ad6d445879c230c53adc8d2fc8 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Source code</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="source: package: org.apache.hadoop.hbase, class: IntegrationTestIngestWithACL">
<meta name="generator" content="javadoc/SourceToHTMLConverter">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body class="source-page">
<main role="main">
<div class="source-container">
<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span>
<span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span>
<span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span>
<span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span>
<span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span>
<span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span>
<span class="source-line-no">009</span><span id="line-9"> *</span>
<span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="source-line-no">011</span><span id="line-11"> *</span>
<span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span>
<span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span>
<span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span>
<span class="source-line-no">017</span><span id="line-17"> */</span>
<span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase;</span>
<span class="source-line-no">019</span><span id="line-19"></span>
<span class="source-line-no">020</span><span id="line-20">import java.util.ArrayList;</span>
<span class="source-line-no">021</span><span id="line-21">import java.util.Arrays;</span>
<span class="source-line-no">022</span><span id="line-22">import java.util.List;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.commons.lang3.StringUtils;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.io.hfile.HFile;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.security.User;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.security.access.AccessController;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.testclassification.IntegrationTests;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.util.LoadTestTool;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.util.test.LoadTestDataGeneratorWithACL;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.util.ToolRunner;</span>
<span class="source-line-no">032</span><span id="line-32">import org.junit.experimental.categories.Category;</span>
<span class="source-line-no">033</span><span id="line-33"></span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLine;</span>
<span class="source-line-no">035</span><span id="line-35"></span>
<span class="source-line-no">036</span><span id="line-36">/**</span>
<span class="source-line-no">037</span><span id="line-37"> * /** An Integration class for tests that does something with the cluster while running</span>
<span class="source-line-no">038</span><span id="line-38"> * {@link LoadTestTool} to write and verify some data. Verifies whether cells for users with only</span>
<span class="source-line-no">039</span><span id="line-39"> * WRITE permissions are not read back and cells with READ permissions are read back. Every</span>
<span class="source-line-no">040</span><span id="line-40"> * operation happens in the user's specific context</span>
<span class="source-line-no">041</span><span id="line-41"> */</span>
<span class="source-line-no">042</span><span id="line-42">@Category(IntegrationTests.class)</span>
<span class="source-line-no">043</span><span id="line-43">public class IntegrationTestIngestWithACL extends IntegrationTestIngest {</span>
<span class="source-line-no">044</span><span id="line-44"></span>
<span class="source-line-no">045</span><span id="line-45"> private static final char COLON = ':';</span>
<span class="source-line-no">046</span><span id="line-46"> public static final char HYPHEN = '-';</span>
<span class="source-line-no">047</span><span id="line-47"> private static final int SPECIAL_PERM_CELL_INSERTION_FACTOR = 100;</span>
<span class="source-line-no">048</span><span id="line-48"> public static final String OPT_SUPERUSER = "superuser";</span>
<span class="source-line-no">049</span><span id="line-49"> public static final String OPT_USERS = "userlist";</span>
<span class="source-line-no">050</span><span id="line-50"> public static final String OPT_AUTHN = "authinfo";</span>
<span class="source-line-no">051</span><span id="line-51"> private String superUser = "owner";</span>
<span class="source-line-no">052</span><span id="line-52"> private String userNames = "user1,user2,user3,user4";</span>
<span class="source-line-no">053</span><span id="line-53"> private String authnFileName;</span>
<span class="source-line-no">054</span><span id="line-54"></span>
<span class="source-line-no">055</span><span id="line-55"> @Override</span>
<span class="source-line-no">056</span><span id="line-56"> public void setUpCluster() throws Exception {</span>
<span class="source-line-no">057</span><span id="line-57"> util = getTestingUtil(null);</span>
<span class="source-line-no">058</span><span id="line-58"> Configuration conf = util.getConfiguration();</span>
<span class="source-line-no">059</span><span id="line-59"> conf.setInt(HFile.FORMAT_VERSION_KEY, 3);</span>
<span class="source-line-no">060</span><span id="line-60"> conf.set("hbase.coprocessor.master.classes", AccessController.class.getName());</span>
<span class="source-line-no">061</span><span id="line-61"> conf.set("hbase.coprocessor.region.classes", AccessController.class.getName());</span>
<span class="source-line-no">062</span><span id="line-62"> conf.setBoolean("hbase.security.access.early_out", false);</span>
<span class="source-line-no">063</span><span id="line-63"> // conf.set("hbase.superuser", "admin");</span>
<span class="source-line-no">064</span><span id="line-64"> super.setUpCluster();</span>
<span class="source-line-no">065</span><span id="line-65"> }</span>
<span class="source-line-no">066</span><span id="line-66"></span>
<span class="source-line-no">067</span><span id="line-67"> @Override</span>
<span class="source-line-no">068</span><span id="line-68"> protected String[] getArgsForLoadTestTool(String mode, String modeSpecificArg, long startKey,</span>
<span class="source-line-no">069</span><span id="line-69"> long numKeys) {</span>
<span class="source-line-no">070</span><span id="line-70"> String[] args = super.getArgsForLoadTestTool(mode, modeSpecificArg, startKey, numKeys);</span>
<span class="source-line-no">071</span><span id="line-71"> List&lt;String&gt; tmp = new ArrayList&lt;&gt;(Arrays.asList(args));</span>
<span class="source-line-no">072</span><span id="line-72"> tmp.add(HYPHEN + LoadTestTool.OPT_GENERATOR);</span>
<span class="source-line-no">073</span><span id="line-73"> StringBuilder sb = new StringBuilder(LoadTestDataGeneratorWithACL.class.getName());</span>
<span class="source-line-no">074</span><span id="line-74"> sb.append(COLON);</span>
<span class="source-line-no">075</span><span id="line-75"> if (User.isHBaseSecurityEnabled(getConf())) {</span>
<span class="source-line-no">076</span><span id="line-76"> sb.append(authnFileName);</span>
<span class="source-line-no">077</span><span id="line-77"> sb.append(COLON);</span>
<span class="source-line-no">078</span><span id="line-78"> }</span>
<span class="source-line-no">079</span><span id="line-79"> sb.append(superUser);</span>
<span class="source-line-no">080</span><span id="line-80"> sb.append(COLON);</span>
<span class="source-line-no">081</span><span id="line-81"> sb.append(userNames);</span>
<span class="source-line-no">082</span><span id="line-82"> sb.append(COLON);</span>
<span class="source-line-no">083</span><span id="line-83"> sb.append(Integer.toString(SPECIAL_PERM_CELL_INSERTION_FACTOR));</span>
<span class="source-line-no">084</span><span id="line-84"> tmp.add(sb.toString());</span>
<span class="source-line-no">085</span><span id="line-85"> return tmp.toArray(new String[tmp.size()]);</span>
<span class="source-line-no">086</span><span id="line-86"> }</span>
<span class="source-line-no">087</span><span id="line-87"></span>
<span class="source-line-no">088</span><span id="line-88"> @Override</span>
<span class="source-line-no">089</span><span id="line-89"> protected void addOptions() {</span>
<span class="source-line-no">090</span><span id="line-90"> super.addOptions();</span>
<span class="source-line-no">091</span><span id="line-91"> super.addOptWithArg(OPT_SUPERUSER, "Super user name used to add the ACL permissions");</span>
<span class="source-line-no">092</span><span id="line-92"> super.addOptWithArg(OPT_USERS,</span>
<span class="source-line-no">093</span><span id="line-93"> "List of users to be added with the ACLs. Should be comma seperated.");</span>
<span class="source-line-no">094</span><span id="line-94"> super.addOptWithArg(OPT_AUTHN,</span>
<span class="source-line-no">095</span><span id="line-95"> "The name of the properties file that contains"</span>
<span class="source-line-no">096</span><span id="line-96"> + " kerberos key tab file and principal definitions. The principal key in the file"</span>
<span class="source-line-no">097</span><span id="line-97"> + " should be of the form hbase.&lt;username&gt;.kerberos.principal. The keytab key in the"</span>
<span class="source-line-no">098</span><span id="line-98"> + " file should be of the form hbase.&lt;username&gt;.keytab.file. Example:"</span>
<span class="source-line-no">099</span><span id="line-99"> + " hbase.user1.kerberos.principal=user1/fully.qualified.domain.name@YOUR-REALM.COM,"</span>
<span class="source-line-no">100</span><span id="line-100"> + " hbase.user1.keytab.file=&lt;filelocation&gt;.");</span>
<span class="source-line-no">101</span><span id="line-101"> }</span>
<span class="source-line-no">102</span><span id="line-102"></span>
<span class="source-line-no">103</span><span id="line-103"> @Override</span>
<span class="source-line-no">104</span><span id="line-104"> protected void processOptions(CommandLine cmd) {</span>
<span class="source-line-no">105</span><span id="line-105"> super.processOptions(cmd);</span>
<span class="source-line-no">106</span><span id="line-106"> if (cmd.hasOption(OPT_SUPERUSER)) {</span>
<span class="source-line-no">107</span><span id="line-107"> superUser = cmd.getOptionValue(OPT_SUPERUSER);</span>
<span class="source-line-no">108</span><span id="line-108"> }</span>
<span class="source-line-no">109</span><span id="line-109"> if (cmd.hasOption(OPT_USERS)) {</span>
<span class="source-line-no">110</span><span id="line-110"> userNames = cmd.getOptionValue(OPT_USERS);</span>
<span class="source-line-no">111</span><span id="line-111"> }</span>
<span class="source-line-no">112</span><span id="line-112"> if (User.isHBaseSecurityEnabled(getConf())) {</span>
<span class="source-line-no">113</span><span id="line-113"> boolean authFileNotFound = false;</span>
<span class="source-line-no">114</span><span id="line-114"> if (cmd.hasOption(OPT_AUTHN)) {</span>
<span class="source-line-no">115</span><span id="line-115"> authnFileName = cmd.getOptionValue(OPT_AUTHN);</span>
<span class="source-line-no">116</span><span id="line-116"> if (StringUtils.isEmpty(authnFileName)) {</span>
<span class="source-line-no">117</span><span id="line-117"> authFileNotFound = true;</span>
<span class="source-line-no">118</span><span id="line-118"> }</span>
<span class="source-line-no">119</span><span id="line-119"> } else {</span>
<span class="source-line-no">120</span><span id="line-120"> authFileNotFound = true;</span>
<span class="source-line-no">121</span><span id="line-121"> }</span>
<span class="source-line-no">122</span><span id="line-122"> if (authFileNotFound) {</span>
<span class="source-line-no">123</span><span id="line-123"> super.printUsage();</span>
<span class="source-line-no">124</span><span id="line-124"> System.exit(EXIT_FAILURE);</span>
<span class="source-line-no">125</span><span id="line-125"> }</span>
<span class="source-line-no">126</span><span id="line-126"> }</span>
<span class="source-line-no">127</span><span id="line-127"> }</span>
<span class="source-line-no">128</span><span id="line-128"></span>
<span class="source-line-no">129</span><span id="line-129"> public static void main(String[] args) throws Exception {</span>
<span class="source-line-no">130</span><span id="line-130"> Configuration conf = HBaseConfiguration.create();</span>
<span class="source-line-no">131</span><span id="line-131"> IntegrationTestingUtility.setUseDistributedCluster(conf);</span>
<span class="source-line-no">132</span><span id="line-132"> int ret = ToolRunner.run(conf, new IntegrationTestIngestWithACL(), args);</span>
<span class="source-line-no">133</span><span id="line-133"> System.exit(ret);</span>
<span class="source-line-no">134</span><span id="line-134"> }</span>
<span class="source-line-no">135</span><span id="line-135">}</span>
</pre>
</div>
</main>
</body>
</html>