Google Git
Sign in
apache / hbase-site / 8ac68d4b7a8449d1b079203ac526389e2358d31e / . / devapidocs / src-html / org / apache / hadoop / hbase / security / HBaseSaslRpcServer.html
blob: 8f0360665f7cad6ed2450f3cfa9e12afaaa49a72 [file] [log] [blame]
<!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.ByteArrayInputStream;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.io.DataInputStream;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.io.IOException;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.security.PrivilegedExceptionAction;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.Map;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>import javax.security.auth.callback.Callback;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import javax.security.auth.callback.CallbackHandler;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import javax.security.auth.callback.NameCallback;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import javax.security.auth.callback.PasswordCallback;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import javax.security.auth.callback.UnsupportedCallbackException;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import javax.security.sasl.AuthorizeCallback;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import javax.security.sasl.RealmCallback;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import javax.security.sasl.Sasl;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import javax.security.sasl.SaslException;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import javax.security.sasl.SaslServer;<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.slf4j.Logger;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.slf4j.LoggerFactory;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.apache.hadoop.security.UserGroupInformation;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.apache.hadoop.security.token.SecretManager;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.apache.hadoop.security.token.SecretManager.InvalidToken;<a name="line.42"></a>
<span class="sourceLineNo">043</span>import org.apache.hadoop.security.token.TokenIdentifier;<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> * A utility class that encapsulates SASL logic for RPC server. Copied from<a name="line.46"></a>
<span class="sourceLineNo">047</span> * &lt;code&gt;org.apache.hadoop.security&lt;/code&gt;<a name="line.47"></a>
<span class="sourceLineNo">048</span> */<a name="line.48"></a>
<span class="sourceLineNo">049</span>@InterfaceAudience.Private<a name="line.49"></a>
<span class="sourceLineNo">050</span>public class HBaseSaslRpcServer {<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> private static final Logger LOG = LoggerFactory.getLogger(HBaseSaslRpcServer.class);<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span> private final SaslServer saslServer;<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> private UserGroupInformation attemptingUser; // user name before auth<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> public HBaseSaslRpcServer(AuthMethod method, Map&lt;String, String&gt; saslProps,<a name="line.58"></a>
<span class="sourceLineNo">059</span> SecretManager&lt;TokenIdentifier&gt; secretManager) throws IOException {<a name="line.59"></a>
<span class="sourceLineNo">060</span> switch (method) {<a name="line.60"></a>
<span class="sourceLineNo">061</span> case DIGEST:<a name="line.61"></a>
<span class="sourceLineNo">062</span> if (secretManager == null) {<a name="line.62"></a>
<span class="sourceLineNo">063</span> throw new AccessDeniedException("Server is not configured to do DIGEST authentication.");<a name="line.63"></a>
<span class="sourceLineNo">064</span> }<a name="line.64"></a>
<span class="sourceLineNo">065</span> saslServer = Sasl.createSaslServer(AuthMethod.DIGEST.getMechanismName(), null,<a name="line.65"></a>
<span class="sourceLineNo">066</span> SaslUtil.SASL_DEFAULT_REALM, saslProps, new SaslDigestCallbackHandler(secretManager));<a name="line.66"></a>
<span class="sourceLineNo">067</span> break;<a name="line.67"></a>
<span class="sourceLineNo">068</span> case KERBEROS:<a name="line.68"></a>
<span class="sourceLineNo">069</span> UserGroupInformation current = UserGroupInformation.getCurrentUser();<a name="line.69"></a>
<span class="sourceLineNo">070</span> String fullName = current.getUserName();<a name="line.70"></a>
<span class="sourceLineNo">071</span> if (LOG.isDebugEnabled()) {<a name="line.71"></a>
<span class="sourceLineNo">072</span> LOG.debug("Kerberos principal name is " + fullName);<a name="line.72"></a>
<span class="sourceLineNo">073</span> }<a name="line.73"></a>
<span class="sourceLineNo">074</span> String[] names = SaslUtil.splitKerberosName(fullName);<a name="line.74"></a>
<span class="sourceLineNo">075</span> if (names.length != 3) {<a name="line.75"></a>
<span class="sourceLineNo">076</span> throw new AccessDeniedException(<a name="line.76"></a>
<span class="sourceLineNo">077</span> "Kerberos principal name does NOT have the expected " + "hostname part: " + fullName);<a name="line.77"></a>
<span class="sourceLineNo">078</span> }<a name="line.78"></a>
<span class="sourceLineNo">079</span> try {<a name="line.79"></a>
<span class="sourceLineNo">080</span> saslServer = current.doAs(new PrivilegedExceptionAction&lt;SaslServer&gt;() {<a name="line.80"></a>
<span class="sourceLineNo">081</span> @Override<a name="line.81"></a>
<span class="sourceLineNo">082</span> public SaslServer run() throws SaslException {<a name="line.82"></a>
<span class="sourceLineNo">083</span> return Sasl.createSaslServer(AuthMethod.KERBEROS.getMechanismName(), names[0],<a name="line.83"></a>
<span class="sourceLineNo">084</span> names[1], saslProps, new SaslGssCallbackHandler());<a name="line.84"></a>
<span class="sourceLineNo">085</span> }<a name="line.85"></a>
<span class="sourceLineNo">086</span> });<a name="line.86"></a>
<span class="sourceLineNo">087</span> } catch (InterruptedException e) {<a name="line.87"></a>
<span class="sourceLineNo">088</span> // should not happen<a name="line.88"></a>
<span class="sourceLineNo">089</span> throw new AssertionError(e);<a name="line.89"></a>
<span class="sourceLineNo">090</span> }<a name="line.90"></a>
<span class="sourceLineNo">091</span> break;<a name="line.91"></a>
<span class="sourceLineNo">092</span> default:<a name="line.92"></a>
<span class="sourceLineNo">093</span> throw new IOException("Unknown authentication method " + method);<a name="line.93"></a>
<span class="sourceLineNo">094</span> }<a name="line.94"></a>
<span class="sourceLineNo">095</span> }<a name="line.95"></a>
<span class="sourceLineNo">096</span><a name="line.96"></a>
<span class="sourceLineNo">097</span> public boolean isComplete() {<a name="line.97"></a>
<span class="sourceLineNo">098</span> return saslServer.isComplete();<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> public byte[] evaluateResponse(byte[] response) throws SaslException {<a name="line.101"></a>
<span class="sourceLineNo">102</span> return saslServer.evaluateResponse(response);<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>
<span class="sourceLineNo">105</span> /** Release resources used by wrapped saslServer */<a name="line.105"></a>
<span class="sourceLineNo">106</span> public void dispose() {<a name="line.106"></a>
<span class="sourceLineNo">107</span> SaslUtil.safeDispose(saslServer);<a name="line.107"></a>
<span class="sourceLineNo">108</span> }<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span> public UserGroupInformation getAttemptingUser() {<a name="line.110"></a>
<span class="sourceLineNo">111</span> return attemptingUser;<a name="line.111"></a>
<span class="sourceLineNo">112</span> }<a name="line.112"></a>
<span class="sourceLineNo">113</span><a name="line.113"></a>
<span class="sourceLineNo">114</span> public byte[] wrap(byte[] buf, int off, int len) throws SaslException {<a name="line.114"></a>
<span class="sourceLineNo">115</span> return saslServer.wrap(buf, off, len);<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span> public byte[] unwrap(byte[] buf, int off, int len) throws SaslException {<a name="line.118"></a>
<span class="sourceLineNo">119</span> return saslServer.unwrap(buf, off, len);<a name="line.119"></a>
<span class="sourceLineNo">120</span> }<a name="line.120"></a>
<span class="sourceLineNo">121</span><a name="line.121"></a>
<span class="sourceLineNo">122</span> public String getNegotiatedQop() {<a name="line.122"></a>
<span class="sourceLineNo">123</span> return (String) saslServer.getNegotiatedProperty(Sasl.QOP);<a name="line.123"></a>
<span class="sourceLineNo">124</span> }<a name="line.124"></a>
<span class="sourceLineNo">125</span><a name="line.125"></a>
<span class="sourceLineNo">126</span> public String getAuthorizationID() {<a name="line.126"></a>
<span class="sourceLineNo">127</span> return saslServer.getAuthorizationID();<a name="line.127"></a>
<span class="sourceLineNo">128</span> }<a name="line.128"></a>
<span class="sourceLineNo">129</span><a name="line.129"></a>
<span class="sourceLineNo">130</span> public static &lt;T extends TokenIdentifier&gt; T getIdentifier(String id,<a name="line.130"></a>
<span class="sourceLineNo">131</span> SecretManager&lt;T&gt; secretManager) throws InvalidToken {<a name="line.131"></a>
<span class="sourceLineNo">132</span> byte[] tokenId = SaslUtil.decodeIdentifier(id);<a name="line.132"></a>
<span class="sourceLineNo">133</span> T tokenIdentifier = secretManager.createIdentifier();<a name="line.133"></a>
<span class="sourceLineNo">134</span> try {<a name="line.134"></a>
<span class="sourceLineNo">135</span> tokenIdentifier.readFields(new DataInputStream(new ByteArrayInputStream(tokenId)));<a name="line.135"></a>
<span class="sourceLineNo">136</span> } catch (IOException e) {<a name="line.136"></a>
<span class="sourceLineNo">137</span> throw (InvalidToken) new InvalidToken("Can't de-serialize tokenIdentifier").initCause(e);<a name="line.137"></a>
<span class="sourceLineNo">138</span> }<a name="line.138"></a>
<span class="sourceLineNo">139</span> return tokenIdentifier;<a name="line.139"></a>
<span class="sourceLineNo">140</span> }<a name="line.140"></a>
<span class="sourceLineNo">141</span><a name="line.141"></a>
<span class="sourceLineNo">142</span> /** CallbackHandler for SASL DIGEST-MD5 mechanism */<a name="line.142"></a>
<span class="sourceLineNo">143</span> private class SaslDigestCallbackHandler implements CallbackHandler {<a name="line.143"></a>
<span class="sourceLineNo">144</span> private SecretManager&lt;TokenIdentifier&gt; secretManager;<a name="line.144"></a>
<span class="sourceLineNo">145</span><a name="line.145"></a>
<span class="sourceLineNo">146</span> public SaslDigestCallbackHandler(SecretManager&lt;TokenIdentifier&gt; secretManager) {<a name="line.146"></a>
<span class="sourceLineNo">147</span> this.secretManager = secretManager;<a name="line.147"></a>
<span class="sourceLineNo">148</span> }<a name="line.148"></a>
<span class="sourceLineNo">149</span><a name="line.149"></a>
<span class="sourceLineNo">150</span> private char[] getPassword(TokenIdentifier tokenid) throws InvalidToken {<a name="line.150"></a>
<span class="sourceLineNo">151</span> return SaslUtil.encodePassword(secretManager.retrievePassword(tokenid));<a name="line.151"></a>
<span class="sourceLineNo">152</span> }<a name="line.152"></a>
<span class="sourceLineNo">153</span><a name="line.153"></a>
<span class="sourceLineNo">154</span> /** {@inheritDoc} */<a name="line.154"></a>
<span class="sourceLineNo">155</span> @Override<a name="line.155"></a>
<span class="sourceLineNo">156</span> public void handle(Callback[] callbacks) throws InvalidToken, UnsupportedCallbackException {<a name="line.156"></a>
<span class="sourceLineNo">157</span> NameCallback nc = null;<a name="line.157"></a>
<span class="sourceLineNo">158</span> PasswordCallback pc = null;<a name="line.158"></a>
<span class="sourceLineNo">159</span> AuthorizeCallback ac = null;<a name="line.159"></a>
<span class="sourceLineNo">160</span> for (Callback callback : callbacks) {<a name="line.160"></a>
<span class="sourceLineNo">161</span> if (callback instanceof AuthorizeCallback) {<a name="line.161"></a>
<span class="sourceLineNo">162</span> ac = (AuthorizeCallback) callback;<a name="line.162"></a>
<span class="sourceLineNo">163</span> } else if (callback instanceof NameCallback) {<a name="line.163"></a>
<span class="sourceLineNo">164</span> nc = (NameCallback) callback;<a name="line.164"></a>
<span class="sourceLineNo">165</span> } else if (callback instanceof PasswordCallback) {<a name="line.165"></a>
<span class="sourceLineNo">166</span> pc = (PasswordCallback) callback;<a name="line.166"></a>
<span class="sourceLineNo">167</span> } else if (callback instanceof RealmCallback) {<a name="line.167"></a>
<span class="sourceLineNo">168</span> continue; // realm is ignored<a name="line.168"></a>
<span class="sourceLineNo">169</span> } else {<a name="line.169"></a>
<span class="sourceLineNo">170</span> throw new UnsupportedCallbackException(callback, "Unrecognized SASL DIGEST-MD5 Callback");<a name="line.170"></a>
<span class="sourceLineNo">171</span> }<a name="line.171"></a>
<span class="sourceLineNo">172</span> }<a name="line.172"></a>
<span class="sourceLineNo">173</span> if (pc != null) {<a name="line.173"></a>
<span class="sourceLineNo">174</span> TokenIdentifier tokenIdentifier = getIdentifier(nc.getDefaultName(), secretManager);<a name="line.174"></a>
<span class="sourceLineNo">175</span> char[] password = getPassword(tokenIdentifier);<a name="line.175"></a>
<span class="sourceLineNo">176</span> UserGroupInformation user = tokenIdentifier.getUser(); // may throw exception<a name="line.176"></a>
<span class="sourceLineNo">177</span> attemptingUser = user;<a name="line.177"></a>
<span class="sourceLineNo">178</span> if (LOG.isTraceEnabled()) {<a name="line.178"></a>
<span class="sourceLineNo">179</span> LOG.trace("SASL server DIGEST-MD5 callback: setting password " + "for client: " +<a name="line.179"></a>
<span class="sourceLineNo">180</span> tokenIdentifier.getUser());<a name="line.180"></a>
<span class="sourceLineNo">181</span> }<a name="line.181"></a>
<span class="sourceLineNo">182</span> pc.setPassword(password);<a name="line.182"></a>
<span class="sourceLineNo">183</span> }<a name="line.183"></a>
<span class="sourceLineNo">184</span> if (ac != null) {<a name="line.184"></a>
<span class="sourceLineNo">185</span> String authid = ac.getAuthenticationID();<a name="line.185"></a>
<span class="sourceLineNo">186</span> String authzid = ac.getAuthorizationID();<a name="line.186"></a>
<span class="sourceLineNo">187</span> if (authid.equals(authzid)) {<a name="line.187"></a>
<span class="sourceLineNo">188</span> ac.setAuthorized(true);<a name="line.188"></a>
<span class="sourceLineNo">189</span> } else {<a name="line.189"></a>
<span class="sourceLineNo">190</span> ac.setAuthorized(false);<a name="line.190"></a>
<span class="sourceLineNo">191</span> }<a name="line.191"></a>
<span class="sourceLineNo">192</span> if (ac.isAuthorized()) {<a name="line.192"></a>
<span class="sourceLineNo">193</span> if (LOG.isTraceEnabled()) {<a name="line.193"></a>
<span class="sourceLineNo">194</span> String username = getIdentifier(authzid, secretManager).getUser().getUserName();<a name="line.194"></a>
<span class="sourceLineNo">195</span> LOG.trace(<a name="line.195"></a>
<span class="sourceLineNo">196</span> "SASL server DIGEST-MD5 callback: setting " + "canonicalized client ID: " + username);<a name="line.196"></a>
<span class="sourceLineNo">197</span> }<a name="line.197"></a>
<span class="sourceLineNo">198</span> ac.setAuthorizedID(authzid);<a name="line.198"></a>
<span class="sourceLineNo">199</span> }<a name="line.199"></a>
<span class="sourceLineNo">200</span> }<a name="line.200"></a>
<span class="sourceLineNo">201</span> }<a name="line.201"></a>
<span class="sourceLineNo">202</span> }<a name="line.202"></a>
<span class="sourceLineNo">203</span><a name="line.203"></a>
<span class="sourceLineNo">204</span> /** CallbackHandler for SASL GSSAPI Kerberos mechanism */<a name="line.204"></a>
<span class="sourceLineNo">205</span> private static class SaslGssCallbackHandler implements CallbackHandler {<a name="line.205"></a>
<span class="sourceLineNo">206</span><a name="line.206"></a>
<span class="sourceLineNo">207</span> /** {@inheritDoc} */<a name="line.207"></a>
<span class="sourceLineNo">208</span> @Override<a name="line.208"></a>
<span class="sourceLineNo">209</span> public void handle(Callback[] callbacks) throws UnsupportedCallbackException {<a name="line.209"></a>
<span class="sourceLineNo">210</span> AuthorizeCallback ac = null;<a name="line.210"></a>
<span class="sourceLineNo">211</span> for (Callback callback : callbacks) {<a name="line.211"></a>
<span class="sourceLineNo">212</span> if (callback instanceof AuthorizeCallback) {<a name="line.212"></a>
<span class="sourceLineNo">213</span> ac = (AuthorizeCallback) callback;<a name="line.213"></a>
<span class="sourceLineNo">214</span> } else {<a name="line.214"></a>
<span class="sourceLineNo">215</span> throw new UnsupportedCallbackException(callback, "Unrecognized SASL GSSAPI Callback");<a name="line.215"></a>
<span class="sourceLineNo">216</span> }<a name="line.216"></a>
<span class="sourceLineNo">217</span> }<a name="line.217"></a>
<span class="sourceLineNo">218</span> if (ac != null) {<a name="line.218"></a>
<span class="sourceLineNo">219</span> String authid = ac.getAuthenticationID();<a name="line.219"></a>
<span class="sourceLineNo">220</span> String authzid = ac.getAuthorizationID();<a name="line.220"></a>
<span class="sourceLineNo">221</span> if (authid.equals(authzid)) {<a name="line.221"></a>
<span class="sourceLineNo">222</span> ac.setAuthorized(true);<a name="line.222"></a>
<span class="sourceLineNo">223</span> } else {<a name="line.223"></a>
<span class="sourceLineNo">224</span> ac.setAuthorized(false);<a name="line.224"></a>
<span class="sourceLineNo">225</span> }<a name="line.225"></a>
<span class="sourceLineNo">226</span> if (ac.isAuthorized()) {<a name="line.226"></a>
<span class="sourceLineNo">227</span> if (LOG.isDebugEnabled()) {<a name="line.227"></a>
<span class="sourceLineNo">228</span> LOG.debug(<a name="line.228"></a>
<span class="sourceLineNo">229</span> "SASL server GSSAPI callback: setting " + "canonicalized client ID: " + authzid);<a name="line.229"></a>
<span class="sourceLineNo">230</span> }<a name="line.230"></a>
<span class="sourceLineNo">231</span> ac.setAuthorizedID(authzid);<a name="line.231"></a>
<span class="sourceLineNo">232</span> }<a name="line.232"></a>
<span class="sourceLineNo">233</span> }<a name="line.233"></a>
<span class="sourceLineNo">234</span> }<a name="line.234"></a>
<span class="sourceLineNo">235</span> }<a name="line.235"></a>
<span class="sourceLineNo">236</span>}<a name="line.236"></a>
</pre>
</div>
</body>
</html>