| <!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.security;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.security.GeneralSecurityException;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.ArrayList;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.List;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.hadoop.conf.Configuration;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.HBaseClassTestRule;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.io.crypto.tls.X509KeyType;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.io.crypto.tls.X509Util;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.testclassification.MediumTests;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.testclassification.RPCTests;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.bouncycastle.operator.OperatorCreationException;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.junit.ClassRule;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.junit.experimental.categories.Category;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.junit.runner.RunWith;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.junit.runners.Parameterized;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span><a name="line.35"></a> |
| <span class="sourceLineNo">036</span>/**<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * Comprehensively tests all permutations of ClientAuth modes and host verification<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * enabled/disabled. Tests each permutation of that against each relevant value of<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * {@link CertConfig}, i.e. passing no cert, a bad cert, etc. See inline comments in {@link #data()}<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * below for what the expectations are<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> */<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>@RunWith(Parameterized.class)<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>@Category({ RPCTests.class, MediumTests.class })<a name="line.43"></a> |
| <span class="sourceLineNo">044</span>public class TestMutualTlsServerSide extends AbstractTestMutualTls {<a name="line.44"></a> |
| <span class="sourceLineNo">045</span><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> @ClassRule<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> public static final HBaseClassTestRule CLASS_RULE =<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> HBaseClassTestRule.forClass(TestMutualTlsServerSide.class);<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> @Parameterized.Parameter(6)<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> public X509Util.ClientAuth clientAuthMode;<a name="line.50"></a> |
| <span class="sourceLineNo">051</span><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> @Parameterized.Parameters(name = "{index}: caKeyType={0}, certKeyType={1}, keyPassword={2}, "<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> + "validateClientHostnames={3}, testCase={4}, clientAuthMode={5}")<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> public static List<Object[]> data() {<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> List<Object[]> params = new ArrayList<>();<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> for (X509KeyType caKeyType : X509KeyType.values()) {<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> for (X509KeyType certKeyType : X509KeyType.values()) {<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> for (String keyPassword : new String[] { "", "pa$$w0rd" }) {<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> // we want to run with and without validating hostnames. we encode the expected success<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> // criteria<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> // in the TestCase config. See below.<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> for (boolean validateClientHostnames : new Boolean[] { true, false }) {<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> // ClientAuth.NONE should succeed in all cases, because it never requests the<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> // certificate for verification<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> params.add(new Object[] { caKeyType, certKeyType, keyPassword, true,<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> validateClientHostnames, CertConfig.NO_CLIENT_CERT, X509Util.ClientAuth.NONE });<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> params.add(new Object[] { caKeyType, certKeyType, keyPassword, true,<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> validateClientHostnames, CertConfig.NON_VERIFIABLE_CERT, X509Util.ClientAuth.NONE });<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> params.add(<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> new Object[] { caKeyType, certKeyType, keyPassword, true, validateClientHostnames,<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> CertConfig.VERIFIABLE_CERT_WITH_BAD_HOST, X509Util.ClientAuth.NONE });<a name="line.71"></a> |
| <span class="sourceLineNo">072</span><a name="line.72"></a> |
| <span class="sourceLineNo">073</span> // ClientAuth.WANT should succeed if no cert, but if the cert is provided it is<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> // validated. So should fail on bad cert or good cert with bad host when host<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> // verification is enabled<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> params.add(new Object[] { caKeyType, certKeyType, keyPassword, true,<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> validateClientHostnames, CertConfig.NO_CLIENT_CERT, X509Util.ClientAuth.WANT });<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> params.add(new Object[] { caKeyType, certKeyType, keyPassword, false,<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> validateClientHostnames, CertConfig.NON_VERIFIABLE_CERT, X509Util.ClientAuth.WANT });<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> params.add(new Object[] { caKeyType, certKeyType, keyPassword, !validateClientHostnames,<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> validateClientHostnames, CertConfig.VERIFIABLE_CERT_WITH_BAD_HOST,<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> X509Util.ClientAuth.WANT });<a name="line.82"></a> |
| <span class="sourceLineNo">083</span><a name="line.83"></a> |
| <span class="sourceLineNo">084</span> // ClientAuth.NEED is most restrictive, failing in all cases except "good cert/bad host"<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> // when host verification is disabled<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> params.add(new Object[] { caKeyType, certKeyType, keyPassword, false,<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> validateClientHostnames, CertConfig.NO_CLIENT_CERT, X509Util.ClientAuth.NEED });<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> params.add(new Object[] { caKeyType, certKeyType, keyPassword, false,<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> validateClientHostnames, CertConfig.NON_VERIFIABLE_CERT, X509Util.ClientAuth.NEED });<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> params.add(new Object[] { caKeyType, certKeyType, keyPassword, !validateClientHostnames,<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> validateClientHostnames, CertConfig.VERIFIABLE_CERT_WITH_BAD_HOST,<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> X509Util.ClientAuth.NEED });<a name="line.92"></a> |
| <span class="sourceLineNo">093</span><a name="line.93"></a> |
| <span class="sourceLineNo">094</span> // additionally ensure that all modes succeed when a good cert is presented<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> for (X509Util.ClientAuth mode : X509Util.ClientAuth.values()) {<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> params.add(new Object[] { caKeyType, certKeyType, keyPassword, true,<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> validateClientHostnames, CertConfig.GOOD_CERT, mode });<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> }<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> }<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> return params;<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> }<a name="line.104"></a> |
| <span class="sourceLineNo">105</span><a name="line.105"></a> |
| <span class="sourceLineNo">106</span> @Override<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> protected void initialize(Configuration serverConf, Configuration clientConf)<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> throws IOException, GeneralSecurityException, OperatorCreationException {<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> // server enables client auth mode and verifies client host names<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> // inject bad certs into client side<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> serverConf.set(X509Util.HBASE_SERVER_NETTY_TLS_CLIENT_AUTH_MODE, clientAuthMode.name());<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> serverConf.setBoolean(X509Util.HBASE_SERVER_NETTY_TLS_VERIFY_CLIENT_HOSTNAME,<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> validateHostnames);<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> handleCertConfig(clientConf);<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> }<a name="line.115"></a> |
| <span class="sourceLineNo">116</span>}<a name="line.116"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
