| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> */<a name="line.17"></a> |
| <span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.util;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.File;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.io.IOException;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.net.BindException;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.net.InetAddress;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.function.Supplier;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.net.BoundSocketMaker;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.kerby.kerberos.kerb.KrbException;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.kerby.kerberos.kerb.server.SimpleKdcServer;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.slf4j.Logger;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.slf4j.LoggerFactory;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span><a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span><a name="line.32"></a> |
| <span class="sourceLineNo">033</span>/**<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * Utility for running {@link SimpleKdcServer}. Kerby KDC server is favored over Hadoop<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * org.apache.hadoop.minikdc server which has support in the HBaseTestingUtility at #setupMiniKdc.<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * The Kerby KDC Server came in with HBASE-5291. Its preferred. Less baggage.<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * @see #getRunningSimpleKdcServer(File, Supplier)<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> */<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>public final class SimpleKdcServerUtil {<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> static final Logger LOG = LoggerFactory.getLogger(SimpleKdcServerUtil.class);<a name="line.40"></a> |
| <span class="sourceLineNo">041</span><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> private SimpleKdcServerUtil() {<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> }<a name="line.43"></a> |
| <span class="sourceLineNo">044</span><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> /**<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * Returns a running kdc server. Use this method rather than start the SimpleKdcServer yourself<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * because it takes care of BindExceptions which can happen even though port-picking is random<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * (between the choice of port number and bind, it could have been used elsewhere).<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * @return A SimpleKdcServer on which 'start' has been called; be sure to call stop on this<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * instance when done.<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> */<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> public static SimpleKdcServer getRunningSimpleKdcServer(File testDir,<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> Supplier<Integer> randomPortGenerator) throws KrbException, IOException {<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> return getRunningSimpleKdcServer(testDir, randomPortGenerator, false);<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> }<a name="line.55"></a> |
| <span class="sourceLineNo">056</span><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> /**<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * Internal method for testing.<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * @param portClash True if we want to generate BindException (for testing).<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * @return A running SimpleKdcServer on loopback/'localhost' on a random port<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * @see #getRunningSimpleKdcServer(File, Supplier)<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> */<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> static SimpleKdcServer getRunningSimpleKdcServer(File testDir,<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> Supplier<Integer> randomPortGenerator, final boolean portClash)<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> throws KrbException, IOException {<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> File kdcDir = new File(testDir, SimpleKdcServer.class.getSimpleName());<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> Preconditions.checkArgument(kdcDir.mkdirs(), "Failed create of " + kdcDir);<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> String hostName = InetAddress.getLoopbackAddress().getHostName();<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> BoundSocketMaker bsm = portClash ? new BoundSocketMaker(randomPortGenerator) : null;<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> final int retries = 10;<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> for (int i = 0; i < retries; i++) {<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> SimpleKdcServer kdc = new SimpleKdcServer();<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> kdc.setWorkDir(kdcDir);<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> kdc.setKdcHost(hostName);<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> kdc.setAllowTcp(true);<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> kdc.setAllowUdp(false);<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> int kdcPort = bsm != null ? bsm.getPort() : randomPortGenerator.get();<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> try {<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> kdc.setKdcTcpPort(kdcPort);<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> LOG.info("Starting KDC server at {}:{}", hostName, kdcPort);<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> kdc.init();<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> kdc.start();<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> return kdc;<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> } catch (KrbException ke) {<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> if (kdc != null) {<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> kdc.stop();<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> }<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> if (ke.getCause() != null && ke.getCause() instanceof BindException) {<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> LOG.info("Clashed using port {}; getting a new random port", kdcPort);<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> continue;<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> } else {<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> throw ke;<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> }<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> } finally {<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> if (bsm != null) {<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> bsm.close();<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> bsm = null;<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> }<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> }<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> }<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> // If we get here, we exhausted our retries. Fail.<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> throw new KrbException("Failed create of SimpleKdcServer after " + retries + " attempts");<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> }<a name="line.103"></a> |
| <span class="sourceLineNo">104</span>}<a name="line.104"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
