<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /**<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<FONT color="green">003</FONT>     * or more contributor license agreements.  See the NOTICE file<a name="line.3"></a>
<FONT color="green">004</FONT>     * distributed with this work for additional information<a name="line.4"></a>
<FONT color="green">005</FONT>     * regarding copyright ownership.  The ASF licenses this file<a name="line.5"></a>
<FONT color="green">006</FONT>     * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<FONT color="green">007</FONT>     * "License"); you may not use this file except in compliance<a name="line.7"></a>
<FONT color="green">008</FONT>     * with the License.  You may obtain a copy of the License at<a name="line.8"></a>
<FONT color="green">009</FONT>     *<a name="line.9"></a>
<FONT color="green">010</FONT>     *     http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<FONT color="green">011</FONT>     *<a name="line.11"></a>
<FONT color="green">012</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<FONT color="green">013</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<FONT color="green">014</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<FONT color="green">015</FONT>     * See the License for the specific language governing permissions and<a name="line.15"></a>
<FONT color="green">016</FONT>     * limitations under the License.<a name="line.16"></a>
<FONT color="green">017</FONT>     */<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    package org.apache.hadoop.mapreduce.security;<a name="line.19"></a>
<FONT color="green">020</FONT>    <a name="line.20"></a>
<FONT color="green">021</FONT>    import java.io.IOException;<a name="line.21"></a>
<FONT color="green">022</FONT>    import java.util.HashSet;<a name="line.22"></a>
<FONT color="green">023</FONT>    import java.util.List;<a name="line.23"></a>
<FONT color="green">024</FONT>    import java.util.Set;<a name="line.24"></a>
<FONT color="green">025</FONT>    <a name="line.25"></a>
<FONT color="green">026</FONT>    import org.apache.commons.logging.Log;<a name="line.26"></a>
<FONT color="green">027</FONT>    import org.apache.commons.logging.LogFactory;<a name="line.27"></a>
<FONT color="green">028</FONT>    import org.apache.hadoop.classification.InterfaceAudience;<a name="line.28"></a>
<FONT color="green">029</FONT>    import org.apache.hadoop.classification.InterfaceStability;<a name="line.29"></a>
<FONT color="green">030</FONT>    import org.apache.hadoop.conf.Configuration;<a name="line.30"></a>
<FONT color="green">031</FONT>    import org.apache.hadoop.fs.FileSystem;<a name="line.31"></a>
<FONT color="green">032</FONT>    import org.apache.hadoop.fs.Path;<a name="line.32"></a>
<FONT color="green">033</FONT>    import org.apache.hadoop.hdfs.security.token.delegation.DelegationTokenIdentifier;<a name="line.33"></a>
<FONT color="green">034</FONT>    import org.apache.hadoop.io.Text;<a name="line.34"></a>
<FONT color="green">035</FONT>    import org.apache.hadoop.mapred.JobConf;<a name="line.35"></a>
<FONT color="green">036</FONT>    import org.apache.hadoop.mapred.Master;<a name="line.36"></a>
<FONT color="green">037</FONT>    import org.apache.hadoop.mapreduce.MRJobConfig;<a name="line.37"></a>
<FONT color="green">038</FONT>    import org.apache.hadoop.mapreduce.security.token.JobTokenIdentifier;<a name="line.38"></a>
<FONT color="green">039</FONT>    import org.apache.hadoop.security.Credentials;<a name="line.39"></a>
<FONT color="green">040</FONT>    import org.apache.hadoop.security.UserGroupInformation;<a name="line.40"></a>
<FONT color="green">041</FONT>    import org.apache.hadoop.security.token.Token;<a name="line.41"></a>
<FONT color="green">042</FONT>    import org.apache.hadoop.security.token.TokenIdentifier;<a name="line.42"></a>
<FONT color="green">043</FONT>    <a name="line.43"></a>
<FONT color="green">044</FONT>    <a name="line.44"></a>
<FONT color="green">045</FONT>    /**<a name="line.45"></a>
<FONT color="green">046</FONT>     * This class provides user facing APIs for transferring secrets from<a name="line.46"></a>
<FONT color="green">047</FONT>     * the job client to the tasks.<a name="line.47"></a>
<FONT color="green">048</FONT>     * The secrets can be stored just before submission of jobs and read during<a name="line.48"></a>
<FONT color="green">049</FONT>     * the task execution.  <a name="line.49"></a>
<FONT color="green">050</FONT>     */<a name="line.50"></a>
<FONT color="green">051</FONT>    @InterfaceAudience.Public<a name="line.51"></a>
<FONT color="green">052</FONT>    @InterfaceStability.Evolving<a name="line.52"></a>
<FONT color="green">053</FONT>    public class TokenCache {<a name="line.53"></a>
<FONT color="green">054</FONT>      <a name="line.54"></a>
<FONT color="green">055</FONT>      private static final Log LOG = LogFactory.getLog(TokenCache.class);<a name="line.55"></a>
<FONT color="green">056</FONT>    <a name="line.56"></a>
<FONT color="green">057</FONT>      <a name="line.57"></a>
<FONT color="green">058</FONT>      /**<a name="line.58"></a>
<FONT color="green">059</FONT>       * auxiliary method to get user's secret keys..<a name="line.59"></a>
<FONT color="green">060</FONT>       * @param alias<a name="line.60"></a>
<FONT color="green">061</FONT>       * @return secret key from the storage<a name="line.61"></a>
<FONT color="green">062</FONT>       */<a name="line.62"></a>
<FONT color="green">063</FONT>      public static byte[] getSecretKey(Credentials credentials, Text alias) {<a name="line.63"></a>
<FONT color="green">064</FONT>        if(credentials == null)<a name="line.64"></a>
<FONT color="green">065</FONT>          return null;<a name="line.65"></a>
<FONT color="green">066</FONT>        return credentials.getSecretKey(alias);<a name="line.66"></a>
<FONT color="green">067</FONT>      }<a name="line.67"></a>
<FONT color="green">068</FONT>      <a name="line.68"></a>
<FONT color="green">069</FONT>      /**<a name="line.69"></a>
<FONT color="green">070</FONT>       * Convenience method to obtain delegation tokens from namenodes <a name="line.70"></a>
<FONT color="green">071</FONT>       * corresponding to the paths passed.<a name="line.71"></a>
<FONT color="green">072</FONT>       * @param credentials<a name="line.72"></a>
<FONT color="green">073</FONT>       * @param ps array of paths<a name="line.73"></a>
<FONT color="green">074</FONT>       * @param conf configuration<a name="line.74"></a>
<FONT color="green">075</FONT>       * @throws IOException<a name="line.75"></a>
<FONT color="green">076</FONT>       */<a name="line.76"></a>
<FONT color="green">077</FONT>      public static void obtainTokensForNamenodes(Credentials credentials,<a name="line.77"></a>
<FONT color="green">078</FONT>          Path[] ps, Configuration conf) throws IOException {<a name="line.78"></a>
<FONT color="green">079</FONT>        if (!UserGroupInformation.isSecurityEnabled()) {<a name="line.79"></a>
<FONT color="green">080</FONT>          return;<a name="line.80"></a>
<FONT color="green">081</FONT>        }<a name="line.81"></a>
<FONT color="green">082</FONT>        obtainTokensForNamenodesInternal(credentials, ps, conf);<a name="line.82"></a>
<FONT color="green">083</FONT>      }<a name="line.83"></a>
<FONT color="green">084</FONT>    <a name="line.84"></a>
<FONT color="green">085</FONT>      /**<a name="line.85"></a>
<FONT color="green">086</FONT>       * Remove jobtoken referrals which don't make sense in the context<a name="line.86"></a>
<FONT color="green">087</FONT>       * of the task execution.<a name="line.87"></a>
<FONT color="green">088</FONT>       *<a name="line.88"></a>
<FONT color="green">089</FONT>       * @param conf<a name="line.89"></a>
<FONT color="green">090</FONT>       */<a name="line.90"></a>
<FONT color="green">091</FONT>      public static void cleanUpTokenReferral(Configuration conf) {<a name="line.91"></a>
<FONT color="green">092</FONT>        conf.unset(MRJobConfig.MAPREDUCE_JOB_CREDENTIALS_BINARY);<a name="line.92"></a>
<FONT color="green">093</FONT>      }<a name="line.93"></a>
<FONT color="green">094</FONT>    <a name="line.94"></a>
<FONT color="green">095</FONT>      static void obtainTokensForNamenodesInternal(Credentials credentials,<a name="line.95"></a>
<FONT color="green">096</FONT>          Path[] ps, Configuration conf) throws IOException {<a name="line.96"></a>
<FONT color="green">097</FONT>        Set&lt;FileSystem&gt; fsSet = new HashSet&lt;FileSystem&gt;();<a name="line.97"></a>
<FONT color="green">098</FONT>        for(Path p: ps) {<a name="line.98"></a>
<FONT color="green">099</FONT>          fsSet.add(p.getFileSystem(conf));<a name="line.99"></a>
<FONT color="green">100</FONT>        }<a name="line.100"></a>
<FONT color="green">101</FONT>        for (FileSystem fs : fsSet) {<a name="line.101"></a>
<FONT color="green">102</FONT>          obtainTokensForNamenodesInternal(fs, credentials, conf);<a name="line.102"></a>
<FONT color="green">103</FONT>        }<a name="line.103"></a>
<FONT color="green">104</FONT>      }<a name="line.104"></a>
<FONT color="green">105</FONT>    <a name="line.105"></a>
<FONT color="green">106</FONT>      /**<a name="line.106"></a>
<FONT color="green">107</FONT>       * get delegation token for a specific FS<a name="line.107"></a>
<FONT color="green">108</FONT>       * @param fs<a name="line.108"></a>
<FONT color="green">109</FONT>       * @param credentials<a name="line.109"></a>
<FONT color="green">110</FONT>       * @param p<a name="line.110"></a>
<FONT color="green">111</FONT>       * @param conf<a name="line.111"></a>
<FONT color="green">112</FONT>       * @throws IOException<a name="line.112"></a>
<FONT color="green">113</FONT>       */<a name="line.113"></a>
<FONT color="green">114</FONT>      @SuppressWarnings("deprecation")<a name="line.114"></a>
<FONT color="green">115</FONT>      static void obtainTokensForNamenodesInternal(FileSystem fs, <a name="line.115"></a>
<FONT color="green">116</FONT>          Credentials credentials, Configuration conf) throws IOException {<a name="line.116"></a>
<FONT color="green">117</FONT>        String delegTokenRenewer = Master.getMasterPrincipal(conf);<a name="line.117"></a>
<FONT color="green">118</FONT>        if (delegTokenRenewer == null || delegTokenRenewer.length() == 0) {<a name="line.118"></a>
<FONT color="green">119</FONT>          throw new IOException(<a name="line.119"></a>
<FONT color="green">120</FONT>              "Can't get Master Kerberos principal for use as renewer");<a name="line.120"></a>
<FONT color="green">121</FONT>        }<a name="line.121"></a>
<FONT color="green">122</FONT>        mergeBinaryTokens(credentials, conf);<a name="line.122"></a>
<FONT color="green">123</FONT>    <a name="line.123"></a>
<FONT color="green">124</FONT>        String fsName = fs.getCanonicalServiceName();<a name="line.124"></a>
<FONT color="green">125</FONT>        if (TokenCache.getDelegationToken(credentials, fsName) == null) {<a name="line.125"></a>
<FONT color="green">126</FONT>          List&lt;Token&lt;?&gt;&gt; tokens =<a name="line.126"></a>
<FONT color="green">127</FONT>              fs.getDelegationTokens(delegTokenRenewer, credentials);<a name="line.127"></a>
<FONT color="green">128</FONT>          if (tokens != null) {<a name="line.128"></a>
<FONT color="green">129</FONT>            for (Token&lt;?&gt; token : tokens) {<a name="line.129"></a>
<FONT color="green">130</FONT>              credentials.addToken(token.getService(), token);<a name="line.130"></a>
<FONT color="green">131</FONT>              LOG.info("Got dt for " + fs.getUri() + ";uri="+ fsName + <a name="line.131"></a>
<FONT color="green">132</FONT>                  ";t.service="+token.getService());<a name="line.132"></a>
<FONT color="green">133</FONT>            }<a name="line.133"></a>
<FONT color="green">134</FONT>          }<a name="line.134"></a>
<FONT color="green">135</FONT>          //Call getDelegationToken as well for now - for FS implementations<a name="line.135"></a>
<FONT color="green">136</FONT>          // which may not have implmented getDelegationTokens (hftp)<a name="line.136"></a>
<FONT color="green">137</FONT>          if (tokens == null || tokens.size() == 0) {<a name="line.137"></a>
<FONT color="green">138</FONT>            Token&lt;?&gt; token = fs.getDelegationToken(delegTokenRenewer);<a name="line.138"></a>
<FONT color="green">139</FONT>            if (token != null) {<a name="line.139"></a>
<FONT color="green">140</FONT>              credentials.addToken(token.getService(), token);<a name="line.140"></a>
<FONT color="green">141</FONT>              LOG.info("Got dt for " + fs.getUri() + ";uri=" + fsName<a name="line.141"></a>
<FONT color="green">142</FONT>                  + ";t.service=" + token.getService());<a name="line.142"></a>
<FONT color="green">143</FONT>            }<a name="line.143"></a>
<FONT color="green">144</FONT>          }<a name="line.144"></a>
<FONT color="green">145</FONT>        }<a name="line.145"></a>
<FONT color="green">146</FONT>      }<a name="line.146"></a>
<FONT color="green">147</FONT>    <a name="line.147"></a>
<FONT color="green">148</FONT>      private static void mergeBinaryTokens(Credentials creds, Configuration conf) {<a name="line.148"></a>
<FONT color="green">149</FONT>        String binaryTokenFilename =<a name="line.149"></a>
<FONT color="green">150</FONT>            conf.get(MRJobConfig.MAPREDUCE_JOB_CREDENTIALS_BINARY);<a name="line.150"></a>
<FONT color="green">151</FONT>        if (binaryTokenFilename != null) {<a name="line.151"></a>
<FONT color="green">152</FONT>          Credentials binary;<a name="line.152"></a>
<FONT color="green">153</FONT>          try {<a name="line.153"></a>
<FONT color="green">154</FONT>            binary = Credentials.readTokenStorageFile(<a name="line.154"></a>
<FONT color="green">155</FONT>                new Path("file:///" +  binaryTokenFilename), conf);<a name="line.155"></a>
<FONT color="green">156</FONT>          } catch (IOException e) {<a name="line.156"></a>
<FONT color="green">157</FONT>            throw new RuntimeException(e);<a name="line.157"></a>
<FONT color="green">158</FONT>          }<a name="line.158"></a>
<FONT color="green">159</FONT>          // supplement existing tokens with the tokens in the binary file<a name="line.159"></a>
<FONT color="green">160</FONT>          creds.mergeAll(binary);<a name="line.160"></a>
<FONT color="green">161</FONT>        }<a name="line.161"></a>
<FONT color="green">162</FONT>      }<a name="line.162"></a>
<FONT color="green">163</FONT>      <a name="line.163"></a>
<FONT color="green">164</FONT>      /**<a name="line.164"></a>
<FONT color="green">165</FONT>       * file name used on HDFS for generated job token<a name="line.165"></a>
<FONT color="green">166</FONT>       */<a name="line.166"></a>
<FONT color="green">167</FONT>      @InterfaceAudience.Private<a name="line.167"></a>
<FONT color="green">168</FONT>      public static final String JOB_TOKEN_HDFS_FILE = "jobToken";<a name="line.168"></a>
<FONT color="green">169</FONT>    <a name="line.169"></a>
<FONT color="green">170</FONT>      /**<a name="line.170"></a>
<FONT color="green">171</FONT>       * conf setting for job tokens cache file name<a name="line.171"></a>
<FONT color="green">172</FONT>       */<a name="line.172"></a>
<FONT color="green">173</FONT>      @InterfaceAudience.Private<a name="line.173"></a>
<FONT color="green">174</FONT>      public static final String JOB_TOKENS_FILENAME = "mapreduce.job.jobTokenFile";<a name="line.174"></a>
<FONT color="green">175</FONT>      private static final Text JOB_TOKEN = new Text("ShuffleAndJobToken");<a name="line.175"></a>
<FONT color="green">176</FONT>      <a name="line.176"></a>
<FONT color="green">177</FONT>      /**<a name="line.177"></a>
<FONT color="green">178</FONT>       * <a name="line.178"></a>
<FONT color="green">179</FONT>       * @param namenode<a name="line.179"></a>
<FONT color="green">180</FONT>       * @return delegation token<a name="line.180"></a>
<FONT color="green">181</FONT>       */<a name="line.181"></a>
<FONT color="green">182</FONT>      @SuppressWarnings("unchecked")<a name="line.182"></a>
<FONT color="green">183</FONT>      @InterfaceAudience.Private<a name="line.183"></a>
<FONT color="green">184</FONT>      public static Token&lt;DelegationTokenIdentifier&gt; getDelegationToken(<a name="line.184"></a>
<FONT color="green">185</FONT>          Credentials credentials, String namenode) {<a name="line.185"></a>
<FONT color="green">186</FONT>        //No fs specific tokens issues by this fs. It may however issue tokens<a name="line.186"></a>
<FONT color="green">187</FONT>        // for other filesystems - which would be keyed by that filesystems name.<a name="line.187"></a>
<FONT color="green">188</FONT>        if (namenode == null)  <a name="line.188"></a>
<FONT color="green">189</FONT>          return null;<a name="line.189"></a>
<FONT color="green">190</FONT>        return (Token&lt;DelegationTokenIdentifier&gt;) credentials.getToken(new Text(<a name="line.190"></a>
<FONT color="green">191</FONT>            namenode));<a name="line.191"></a>
<FONT color="green">192</FONT>      }<a name="line.192"></a>
<FONT color="green">193</FONT>    <a name="line.193"></a>
<FONT color="green">194</FONT>      /**<a name="line.194"></a>
<FONT color="green">195</FONT>       * load job token from a file<a name="line.195"></a>
<FONT color="green">196</FONT>       * @param conf<a name="line.196"></a>
<FONT color="green">197</FONT>       * @throws IOException<a name="line.197"></a>
<FONT color="green">198</FONT>       */<a name="line.198"></a>
<FONT color="green">199</FONT>      @InterfaceAudience.Private<a name="line.199"></a>
<FONT color="green">200</FONT>      public static Credentials loadTokens(String jobTokenFile, JobConf conf) <a name="line.200"></a>
<FONT color="green">201</FONT>      throws IOException {<a name="line.201"></a>
<FONT color="green">202</FONT>        Path localJobTokenFile = new Path ("file:///" + jobTokenFile);<a name="line.202"></a>
<FONT color="green">203</FONT>    <a name="line.203"></a>
<FONT color="green">204</FONT>        Credentials ts = Credentials.readTokenStorageFile(localJobTokenFile, conf);<a name="line.204"></a>
<FONT color="green">205</FONT>    <a name="line.205"></a>
<FONT color="green">206</FONT>        if(LOG.isDebugEnabled()) {<a name="line.206"></a>
<FONT color="green">207</FONT>          LOG.debug("Task: Loaded jobTokenFile from: "+<a name="line.207"></a>
<FONT color="green">208</FONT>              localJobTokenFile.toUri().getPath() <a name="line.208"></a>
<FONT color="green">209</FONT>              +"; num of sec keys  = " + ts.numberOfSecretKeys() +<a name="line.209"></a>
<FONT color="green">210</FONT>              " Number of tokens " +  ts.numberOfTokens());<a name="line.210"></a>
<FONT color="green">211</FONT>        }<a name="line.211"></a>
<FONT color="green">212</FONT>        return ts;<a name="line.212"></a>
<FONT color="green">213</FONT>      }<a name="line.213"></a>
<FONT color="green">214</FONT>      /**<a name="line.214"></a>
<FONT color="green">215</FONT>       * store job token<a name="line.215"></a>
<FONT color="green">216</FONT>       * @param t<a name="line.216"></a>
<FONT color="green">217</FONT>       */<a name="line.217"></a>
<FONT color="green">218</FONT>      @InterfaceAudience.Private<a name="line.218"></a>
<FONT color="green">219</FONT>      public static void setJobToken(Token&lt;? extends TokenIdentifier&gt; t, <a name="line.219"></a>
<FONT color="green">220</FONT>          Credentials credentials) {<a name="line.220"></a>
<FONT color="green">221</FONT>        credentials.addToken(JOB_TOKEN, t);<a name="line.221"></a>
<FONT color="green">222</FONT>      }<a name="line.222"></a>
<FONT color="green">223</FONT>      /**<a name="line.223"></a>
<FONT color="green">224</FONT>       * <a name="line.224"></a>
<FONT color="green">225</FONT>       * @return job token<a name="line.225"></a>
<FONT color="green">226</FONT>       */<a name="line.226"></a>
<FONT color="green">227</FONT>      @SuppressWarnings("unchecked")<a name="line.227"></a>
<FONT color="green">228</FONT>      @InterfaceAudience.Private<a name="line.228"></a>
<FONT color="green">229</FONT>      public static Token&lt;JobTokenIdentifier&gt; getJobToken(Credentials credentials) {<a name="line.229"></a>
<FONT color="green">230</FONT>        return (Token&lt;JobTokenIdentifier&gt;) credentials.getToken(JOB_TOKEN);<a name="line.230"></a>
<FONT color="green">231</FONT>      }<a name="line.231"></a>
<FONT color="green">232</FONT>    }<a name="line.232"></a>




























































</PRE>
</BODY>
</HTML>
