blob: 661d4f8d860fabc15ebfc0526bcf501f351ed9b9 [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,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a>
<span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a>
<span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> *<a name="line.18"></a>
<span class="sourceLineNo">019</span> */<a name="line.19"></a>
<span class="sourceLineNo">020</span>package org.apache.mina.proxy.handlers.http.ntlm;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.io.BufferedReader;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.io.ByteArrayOutputStream;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.io.IOException;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.io.InputStreamReader;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.io.PrintWriter;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.io.UnsupportedEncodingException;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.StringTokenizer;<a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.mina.proxy.utils.ByteUtilities;<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>/**<a name="line.32"></a>
<span class="sourceLineNo">033</span> * NTLMUtilities.java - NTLM functions used for authentication and unit testing.<a name="line.33"></a>
<span class="sourceLineNo">034</span> * <a name="line.34"></a>
<span class="sourceLineNo">035</span> * @author &lt;a href="http://mina.apache.org"&gt;Apache MINA Project&lt;/a&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> * @since MINA 2.0.0-M3<a name="line.36"></a>
<span class="sourceLineNo">037</span> */<a name="line.37"></a>
<span class="sourceLineNo">038</span>public class NTLMUtilities implements NTLMConstants {<a name="line.38"></a>
<span class="sourceLineNo">039</span> /**<a name="line.39"></a>
<span class="sourceLineNo">040</span> * @see #writeSecurityBuffer(short, short, int, byte[], int)<a name="line.40"></a>
<span class="sourceLineNo">041</span> * <a name="line.41"></a>
<span class="sourceLineNo">042</span> * @param length The length of the security buffer<a name="line.42"></a>
<span class="sourceLineNo">043</span> * @param bufferOffset The offset in the security buffer<a name="line.43"></a>
<span class="sourceLineNo">044</span> * @return Th created buffer<a name="line.44"></a>
<span class="sourceLineNo">045</span> */<a name="line.45"></a>
<span class="sourceLineNo">046</span> public final static byte[] writeSecurityBuffer(short length, int bufferOffset) {<a name="line.46"></a>
<span class="sourceLineNo">047</span> byte[] b = new byte[8];<a name="line.47"></a>
<span class="sourceLineNo">048</span> writeSecurityBuffer(length, length, bufferOffset, b, 0);<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span> return b;<a name="line.50"></a>
<span class="sourceLineNo">051</span> }<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span> /**<a name="line.53"></a>
<span class="sourceLineNo">054</span> * Writes a security buffer to the given array &lt;code&gt;b&lt;/code&gt; at offset<a name="line.54"></a>
<span class="sourceLineNo">055</span> * &lt;code&gt;offset&lt;/code&gt;. A security buffer defines a pointer to an area<a name="line.55"></a>
<span class="sourceLineNo">056</span> * in the data that defines some data with a variable length. This allows<a name="line.56"></a>
<span class="sourceLineNo">057</span> * to have a semi-fixed length header thus making a little bit easier<a name="line.57"></a>
<span class="sourceLineNo">058</span> * the decoding process in the NTLM protocol.<a name="line.58"></a>
<span class="sourceLineNo">059</span> * <a name="line.59"></a>
<span class="sourceLineNo">060</span> * @param length the length of the security buffer<a name="line.60"></a>
<span class="sourceLineNo">061</span> * @param allocated the allocated space for the security buffer (should be<a name="line.61"></a>
<span class="sourceLineNo">062</span> * greater or equal to &lt;code&gt;length&lt;/code&gt;<a name="line.62"></a>
<span class="sourceLineNo">063</span> * @param bufferOffset the offset from the main array where the currently<a name="line.63"></a>
<span class="sourceLineNo">064</span> * defined security buffer will be written<a name="line.64"></a>
<span class="sourceLineNo">065</span> * @param b the buffer in which we write the security buffer<a name="line.65"></a>
<span class="sourceLineNo">066</span> * @param offset the offset at which to write to the b buffer<a name="line.66"></a>
<span class="sourceLineNo">067</span> */<a name="line.67"></a>
<span class="sourceLineNo">068</span> public final static void writeSecurityBuffer(short length, short allocated, int bufferOffset, byte[] b, int offset) {<a name="line.68"></a>
<span class="sourceLineNo">069</span> ByteUtilities.writeShort(length, b, offset);<a name="line.69"></a>
<span class="sourceLineNo">070</span> ByteUtilities.writeShort(allocated, b, offset + 2);<a name="line.70"></a>
<span class="sourceLineNo">071</span> ByteUtilities.writeInt(bufferOffset, b, offset + 4);<a name="line.71"></a>
<span class="sourceLineNo">072</span> }<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span> /**<a name="line.74"></a>
<span class="sourceLineNo">075</span> * Writes the Windows OS version passed in as three byte values<a name="line.75"></a>
<span class="sourceLineNo">076</span> * (majorVersion.minorVersion.buildNumber) to the given byte array<a name="line.76"></a>
<span class="sourceLineNo">077</span> * at &lt;code&gt;offset&lt;/code&gt;.<a name="line.77"></a>
<span class="sourceLineNo">078</span> * <a name="line.78"></a>
<span class="sourceLineNo">079</span> * @param majorVersion the major version number<a name="line.79"></a>
<span class="sourceLineNo">080</span> * @param minorVersion the minor version number<a name="line.80"></a>
<span class="sourceLineNo">081</span> * @param buildNumber the build number<a name="line.81"></a>
<span class="sourceLineNo">082</span> * @param b the target byte array<a name="line.82"></a>
<span class="sourceLineNo">083</span> * @param offset the offset at which to write in the array<a name="line.83"></a>
<span class="sourceLineNo">084</span> */<a name="line.84"></a>
<span class="sourceLineNo">085</span> public final static void writeOSVersion(byte majorVersion, byte minorVersion, short buildNumber, byte[] b,<a name="line.85"></a>
<span class="sourceLineNo">086</span> int offset) {<a name="line.86"></a>
<span class="sourceLineNo">087</span> b[offset] = majorVersion;<a name="line.87"></a>
<span class="sourceLineNo">088</span> b[offset + 1] = minorVersion;<a name="line.88"></a>
<span class="sourceLineNo">089</span> b[offset + 2] = (byte) buildNumber;<a name="line.89"></a>
<span class="sourceLineNo">090</span> b[offset + 3] = (byte) (buildNumber &gt;&gt; 8);<a name="line.90"></a>
<span class="sourceLineNo">091</span> b[offset + 4] = 0;<a name="line.91"></a>
<span class="sourceLineNo">092</span> b[offset + 5] = 0;<a name="line.92"></a>
<span class="sourceLineNo">093</span> b[offset + 6] = 0;<a name="line.93"></a>
<span class="sourceLineNo">094</span> b[offset + 7] = 0x0F;<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> /**<a name="line.97"></a>
<span class="sourceLineNo">098</span> * Tries to return a valid OS version on Windows systems. If it fails to<a name="line.98"></a>
<span class="sourceLineNo">099</span> * do so or if we're running on another OS then a fake Windows XP OS<a name="line.99"></a>
<span class="sourceLineNo">100</span> * version is returned because the protocol uses it.<a name="line.100"></a>
<span class="sourceLineNo">101</span> * <a name="line.101"></a>
<span class="sourceLineNo">102</span> * @return a NTLM OS version byte buffer<a name="line.102"></a>
<span class="sourceLineNo">103</span> */<a name="line.103"></a>
<span class="sourceLineNo">104</span> public final static byte[] getOsVersion() {<a name="line.104"></a>
<span class="sourceLineNo">105</span> String os = System.getProperty("os.name");<a name="line.105"></a>
<span class="sourceLineNo">106</span><a name="line.106"></a>
<span class="sourceLineNo">107</span> if ((os == null) || !os.toUpperCase().contains("WINDOWS")) {<a name="line.107"></a>
<span class="sourceLineNo">108</span> return DEFAULT_OS_VERSION;<a name="line.108"></a>
<span class="sourceLineNo">109</span> }<a name="line.109"></a>
<span class="sourceLineNo">110</span><a name="line.110"></a>
<span class="sourceLineNo">111</span> byte[] osVer = new byte[8];<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span> // Let's enclose the code by a try...catch in order to<a name="line.113"></a>
<span class="sourceLineNo">114</span> // manage incorrect strings. In this case, we will generate<a name="line.114"></a>
<span class="sourceLineNo">115</span> // an exception and deal with the special cases.<a name="line.115"></a>
<span class="sourceLineNo">116</span> try {<a name="line.116"></a>
<span class="sourceLineNo">117</span> Process pr = Runtime.getRuntime().exec("cmd /C ver");<a name="line.117"></a>
<span class="sourceLineNo">118</span> BufferedReader reader = new BufferedReader(new InputStreamReader(pr.getInputStream()));<a name="line.118"></a>
<span class="sourceLineNo">119</span> pr.waitFor();<a name="line.119"></a>
<span class="sourceLineNo">120</span><a name="line.120"></a>
<span class="sourceLineNo">121</span> String line;<a name="line.121"></a>
<span class="sourceLineNo">122</span><a name="line.122"></a>
<span class="sourceLineNo">123</span> // We loop as we may have blank lines.<a name="line.123"></a>
<span class="sourceLineNo">124</span> do {<a name="line.124"></a>
<span class="sourceLineNo">125</span> line = reader.readLine();<a name="line.125"></a>
<span class="sourceLineNo">126</span> } while ((line != null) &amp;&amp; (line.length() != 0));<a name="line.126"></a>
<span class="sourceLineNo">127</span><a name="line.127"></a>
<span class="sourceLineNo">128</span> reader.close();<a name="line.128"></a>
<span class="sourceLineNo">129</span><a name="line.129"></a>
<span class="sourceLineNo">130</span> // If line is null, we must not go any farther<a name="line.130"></a>
<span class="sourceLineNo">131</span> if (line == null) {<a name="line.131"></a>
<span class="sourceLineNo">132</span> // Throw an exception to jump into the catch() part<a name="line.132"></a>
<span class="sourceLineNo">133</span> throw new Exception();<a name="line.133"></a>
<span class="sourceLineNo">134</span> }<a name="line.134"></a>
<span class="sourceLineNo">135</span><a name="line.135"></a>
<span class="sourceLineNo">136</span> // The command line should return a response like :<a name="line.136"></a>
<span class="sourceLineNo">137</span> // Microsoft Windows XP [version 5.1.2600]<a name="line.137"></a>
<span class="sourceLineNo">138</span> int pos = line.toLowerCase().indexOf("version");<a name="line.138"></a>
<span class="sourceLineNo">139</span><a name="line.139"></a>
<span class="sourceLineNo">140</span> if (pos == -1) {<a name="line.140"></a>
<span class="sourceLineNo">141</span> // Throw an exception to jump into the catch() part<a name="line.141"></a>
<span class="sourceLineNo">142</span> throw new Exception();<a name="line.142"></a>
<span class="sourceLineNo">143</span> }<a name="line.143"></a>
<span class="sourceLineNo">144</span><a name="line.144"></a>
<span class="sourceLineNo">145</span> pos += 8;<a name="line.145"></a>
<span class="sourceLineNo">146</span> line = line.substring(pos, line.indexOf(']'));<a name="line.146"></a>
<span class="sourceLineNo">147</span> StringTokenizer tk = new StringTokenizer(line, ".");<a name="line.147"></a>
<span class="sourceLineNo">148</span><a name="line.148"></a>
<span class="sourceLineNo">149</span> if (tk.countTokens() != 3) {<a name="line.149"></a>
<span class="sourceLineNo">150</span> // Throw an exception to jump into the catch() part<a name="line.150"></a>
<span class="sourceLineNo">151</span> throw new Exception();<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> writeOSVersion(Byte.parseByte(tk.nextToken()), Byte.parseByte(tk.nextToken()),<a name="line.154"></a>
<span class="sourceLineNo">155</span> Short.parseShort(tk.nextToken()), osVer, 0);<a name="line.155"></a>
<span class="sourceLineNo">156</span> } catch (Exception ex) {<a name="line.156"></a>
<span class="sourceLineNo">157</span> try {<a name="line.157"></a>
<span class="sourceLineNo">158</span> String version = System.getProperty("os.version");<a name="line.158"></a>
<span class="sourceLineNo">159</span> writeOSVersion(Byte.parseByte(version.substring(0, 1)), Byte.parseByte(version.substring(2, 3)),<a name="line.159"></a>
<span class="sourceLineNo">160</span> (short) 0, osVer, 0);<a name="line.160"></a>
<span class="sourceLineNo">161</span> } catch (Exception ex2) {<a name="line.161"></a>
<span class="sourceLineNo">162</span> return DEFAULT_OS_VERSION;<a name="line.162"></a>
<span class="sourceLineNo">163</span> }<a name="line.163"></a>
<span class="sourceLineNo">164</span> }<a name="line.164"></a>
<span class="sourceLineNo">165</span><a name="line.165"></a>
<span class="sourceLineNo">166</span> return osVer;<a name="line.166"></a>
<span class="sourceLineNo">167</span> }<a name="line.167"></a>
<span class="sourceLineNo">168</span><a name="line.168"></a>
<span class="sourceLineNo">169</span> /**<a name="line.169"></a>
<span class="sourceLineNo">170</span> * see http://davenport.sourceforge.net/ntlm.html#theType1Message<a name="line.170"></a>
<span class="sourceLineNo">171</span> * <a name="line.171"></a>
<span class="sourceLineNo">172</span> * @param workStation the workstation name<a name="line.172"></a>
<span class="sourceLineNo">173</span> * @param domain the domain name<a name="line.173"></a>
<span class="sourceLineNo">174</span> * @param customFlags custom flags, if null then<a name="line.174"></a>
<span class="sourceLineNo">175</span> * &lt;code&gt;NTLMConstants.DEFAULT_CONSTANTS&lt;/code&gt; is used<a name="line.175"></a>
<span class="sourceLineNo">176</span> * @param osVersion the os version of the client, if null then<a name="line.176"></a>
<span class="sourceLineNo">177</span> * &lt;code&gt;NTLMConstants.DEFAULT_OS_VERSION&lt;/code&gt; is used<a name="line.177"></a>
<span class="sourceLineNo">178</span> * @return the type 1 message<a name="line.178"></a>
<span class="sourceLineNo">179</span> */<a name="line.179"></a>
<span class="sourceLineNo">180</span> public final static byte[] createType1Message(String workStation, String domain, Integer customFlags,<a name="line.180"></a>
<span class="sourceLineNo">181</span> byte[] osVersion) {<a name="line.181"></a>
<span class="sourceLineNo">182</span> byte[] msg = null;<a name="line.182"></a>
<span class="sourceLineNo">183</span><a name="line.183"></a>
<span class="sourceLineNo">184</span> if (osVersion != null &amp;&amp; osVersion.length != 8) {<a name="line.184"></a>
<span class="sourceLineNo">185</span> throw new IllegalArgumentException("osVersion parameter should be a 8 byte wide array");<a name="line.185"></a>
<span class="sourceLineNo">186</span> }<a name="line.186"></a>
<span class="sourceLineNo">187</span><a name="line.187"></a>
<span class="sourceLineNo">188</span> if (workStation == null || domain == null) {<a name="line.188"></a>
<span class="sourceLineNo">189</span> throw new IllegalArgumentException("workStation and domain must be non null");<a name="line.189"></a>
<span class="sourceLineNo">190</span> }<a name="line.190"></a>
<span class="sourceLineNo">191</span><a name="line.191"></a>
<span class="sourceLineNo">192</span> int flags = customFlags != null ? customFlags | FLAG_NEGOTIATE_WORKSTATION_SUPPLIED<a name="line.192"></a>
<span class="sourceLineNo">193</span> | FLAG_NEGOTIATE_DOMAIN_SUPPLIED : DEFAULT_FLAGS;<a name="line.193"></a>
<span class="sourceLineNo">194</span><a name="line.194"></a>
<span class="sourceLineNo">195</span> ByteArrayOutputStream baos = new ByteArrayOutputStream();<a name="line.195"></a>
<span class="sourceLineNo">196</span><a name="line.196"></a>
<span class="sourceLineNo">197</span> try {<a name="line.197"></a>
<span class="sourceLineNo">198</span> baos.write(NTLM_SIGNATURE);<a name="line.198"></a>
<span class="sourceLineNo">199</span> baos.write(ByteUtilities.writeInt(MESSAGE_TYPE_1));<a name="line.199"></a>
<span class="sourceLineNo">200</span> baos.write(ByteUtilities.writeInt(flags));<a name="line.200"></a>
<span class="sourceLineNo">201</span><a name="line.201"></a>
<span class="sourceLineNo">202</span> byte[] domainData = ByteUtilities.getOEMStringAsByteArray(domain);<a name="line.202"></a>
<span class="sourceLineNo">203</span> byte[] workStationData = ByteUtilities.getOEMStringAsByteArray(workStation);<a name="line.203"></a>
<span class="sourceLineNo">204</span><a name="line.204"></a>
<span class="sourceLineNo">205</span> int pos = (osVersion != null) ? 40 : 32;<a name="line.205"></a>
<span class="sourceLineNo">206</span> baos.write(writeSecurityBuffer((short) domainData.length, pos + workStationData.length));<a name="line.206"></a>
<span class="sourceLineNo">207</span> baos.write(writeSecurityBuffer((short) workStationData.length, pos));<a name="line.207"></a>
<span class="sourceLineNo">208</span><a name="line.208"></a>
<span class="sourceLineNo">209</span> if (osVersion != null) {<a name="line.209"></a>
<span class="sourceLineNo">210</span> baos.write(osVersion);<a name="line.210"></a>
<span class="sourceLineNo">211</span> }<a name="line.211"></a>
<span class="sourceLineNo">212</span><a name="line.212"></a>
<span class="sourceLineNo">213</span> // Order is not mandatory since a pointer is given in the security buffers<a name="line.213"></a>
<span class="sourceLineNo">214</span> baos.write(workStationData);<a name="line.214"></a>
<span class="sourceLineNo">215</span> baos.write(domainData);<a name="line.215"></a>
<span class="sourceLineNo">216</span><a name="line.216"></a>
<span class="sourceLineNo">217</span> msg = baos.toByteArray();<a name="line.217"></a>
<span class="sourceLineNo">218</span> baos.close();<a name="line.218"></a>
<span class="sourceLineNo">219</span> } catch (IOException e) {<a name="line.219"></a>
<span class="sourceLineNo">220</span> return null;<a name="line.220"></a>
<span class="sourceLineNo">221</span> }<a name="line.221"></a>
<span class="sourceLineNo">222</span><a name="line.222"></a>
<span class="sourceLineNo">223</span> return msg;<a name="line.223"></a>
<span class="sourceLineNo">224</span> }<a name="line.224"></a>
<span class="sourceLineNo">225</span><a name="line.225"></a>
<span class="sourceLineNo">226</span> /**<a name="line.226"></a>
<span class="sourceLineNo">227</span> * Writes a security buffer and returns the pointer of the position<a name="line.227"></a>
<span class="sourceLineNo">228</span> * where to write the next security buffer.<a name="line.228"></a>
<span class="sourceLineNo">229</span> * <a name="line.229"></a>
<span class="sourceLineNo">230</span> * @param baos the stream where the security buffer is written<a name="line.230"></a>
<span class="sourceLineNo">231</span> * @param len the length of the security buffer<a name="line.231"></a>
<span class="sourceLineNo">232</span> * @param pointer the position where the security buffer can be written<a name="line.232"></a>
<span class="sourceLineNo">233</span> * @return the position where the next security buffer will be written<a name="line.233"></a>
<span class="sourceLineNo">234</span> * @throws IOException if writing to the ByteArrayOutputStream fails<a name="line.234"></a>
<span class="sourceLineNo">235</span> */<a name="line.235"></a>
<span class="sourceLineNo">236</span> public final static int writeSecurityBufferAndUpdatePointer(ByteArrayOutputStream baos, short len, int pointer)<a name="line.236"></a>
<span class="sourceLineNo">237</span> throws IOException {<a name="line.237"></a>
<span class="sourceLineNo">238</span> baos.write(writeSecurityBuffer(len, pointer));<a name="line.238"></a>
<span class="sourceLineNo">239</span><a name="line.239"></a>
<span class="sourceLineNo">240</span> return pointer + len;<a name="line.240"></a>
<span class="sourceLineNo">241</span> }<a name="line.241"></a>
<span class="sourceLineNo">242</span><a name="line.242"></a>
<span class="sourceLineNo">243</span> /**<a name="line.243"></a>
<span class="sourceLineNo">244</span> * Extracts the NTLM challenge from the type 2 message as an 8 byte array.<a name="line.244"></a>
<span class="sourceLineNo">245</span> * <a name="line.245"></a>
<span class="sourceLineNo">246</span> * @param msg the type 2 message byte array<a name="line.246"></a>
<span class="sourceLineNo">247</span> * @return the challenge<a name="line.247"></a>
<span class="sourceLineNo">248</span> */<a name="line.248"></a>
<span class="sourceLineNo">249</span> public final static byte[] extractChallengeFromType2Message(byte[] msg) {<a name="line.249"></a>
<span class="sourceLineNo">250</span> byte[] challenge = new byte[8];<a name="line.250"></a>
<span class="sourceLineNo">251</span> System.arraycopy(msg, 24, challenge, 0, 8);<a name="line.251"></a>
<span class="sourceLineNo">252</span><a name="line.252"></a>
<span class="sourceLineNo">253</span> return challenge;<a name="line.253"></a>
<span class="sourceLineNo">254</span> }<a name="line.254"></a>
<span class="sourceLineNo">255</span><a name="line.255"></a>
<span class="sourceLineNo">256</span> /**<a name="line.256"></a>
<span class="sourceLineNo">257</span> * Extracts the NTLM flags from the type 2 message.<a name="line.257"></a>
<span class="sourceLineNo">258</span> * <a name="line.258"></a>
<span class="sourceLineNo">259</span> * @param msg the type 2 message byte array<a name="line.259"></a>
<span class="sourceLineNo">260</span> * @return the proxy flags as an int<a name="line.260"></a>
<span class="sourceLineNo">261</span> */<a name="line.261"></a>
<span class="sourceLineNo">262</span> public final static int extractFlagsFromType2Message(byte[] msg) {<a name="line.262"></a>
<span class="sourceLineNo">263</span> byte[] flagsBytes = new byte[4];<a name="line.263"></a>
<span class="sourceLineNo">264</span><a name="line.264"></a>
<span class="sourceLineNo">265</span> System.arraycopy(msg, 20, flagsBytes, 0, 4);<a name="line.265"></a>
<span class="sourceLineNo">266</span> ByteUtilities.changeWordEndianess(flagsBytes, 0, 4);<a name="line.266"></a>
<span class="sourceLineNo">267</span><a name="line.267"></a>
<span class="sourceLineNo">268</span> return ByteUtilities.makeIntFromByte4(flagsBytes);<a name="line.268"></a>
<span class="sourceLineNo">269</span> }<a name="line.269"></a>
<span class="sourceLineNo">270</span><a name="line.270"></a>
<span class="sourceLineNo">271</span> /**<a name="line.271"></a>
<span class="sourceLineNo">272</span> * Reads the byte array described by the security buffer stored at the<a name="line.272"></a>
<span class="sourceLineNo">273</span> * &lt;code&gt;securityBufferOffset&lt;/code&gt; offset.<a name="line.273"></a>
<span class="sourceLineNo">274</span> * <a name="line.274"></a>
<span class="sourceLineNo">275</span> * @param msg the message where to read the security buffer and it's value<a name="line.275"></a>
<span class="sourceLineNo">276</span> * @param securityBufferOffset the offset at which to read the security buffer<a name="line.276"></a>
<span class="sourceLineNo">277</span> * @return a new byte array holding the data pointed by the security buffer<a name="line.277"></a>
<span class="sourceLineNo">278</span> */<a name="line.278"></a>
<span class="sourceLineNo">279</span> public final static byte[] readSecurityBufferTarget(byte[] msg, int securityBufferOffset) {<a name="line.279"></a>
<span class="sourceLineNo">280</span> byte[] securityBuffer = new byte[8];<a name="line.280"></a>
<span class="sourceLineNo">281</span><a name="line.281"></a>
<span class="sourceLineNo">282</span> System.arraycopy(msg, securityBufferOffset, securityBuffer, 0, 8);<a name="line.282"></a>
<span class="sourceLineNo">283</span> ByteUtilities.changeWordEndianess(securityBuffer, 0, 8);<a name="line.283"></a>
<span class="sourceLineNo">284</span> int length = ByteUtilities.makeIntFromByte2(securityBuffer);<a name="line.284"></a>
<span class="sourceLineNo">285</span> int offset = ByteUtilities.makeIntFromByte4(securityBuffer, 4);<a name="line.285"></a>
<span class="sourceLineNo">286</span><a name="line.286"></a>
<span class="sourceLineNo">287</span> byte[] secBufValue = new byte[length];<a name="line.287"></a>
<span class="sourceLineNo">288</span> System.arraycopy(msg, offset, secBufValue, 0, length);<a name="line.288"></a>
<span class="sourceLineNo">289</span><a name="line.289"></a>
<span class="sourceLineNo">290</span> return secBufValue;<a name="line.290"></a>
<span class="sourceLineNo">291</span> }<a name="line.291"></a>
<span class="sourceLineNo">292</span><a name="line.292"></a>
<span class="sourceLineNo">293</span> /**<a name="line.293"></a>
<span class="sourceLineNo">294</span> * Extracts the target name from the type 2 message.<a name="line.294"></a>
<span class="sourceLineNo">295</span> * <a name="line.295"></a>
<span class="sourceLineNo">296</span> * @param msg the type 2 message byte array<a name="line.296"></a>
<span class="sourceLineNo">297</span> * @param msgFlags the flags if null then flags are extracted from the<a name="line.297"></a>
<span class="sourceLineNo">298</span> * type 2 message<a name="line.298"></a>
<span class="sourceLineNo">299</span> * @return the target name<a name="line.299"></a>
<span class="sourceLineNo">300</span> * @throws UnsupportedEncodingException if unable to use the<a name="line.300"></a>
<span class="sourceLineNo">301</span> * needed UTF-16LE or ASCII charsets<a name="line.301"></a>
<span class="sourceLineNo">302</span> */<a name="line.302"></a>
<span class="sourceLineNo">303</span> public final static String extractTargetNameFromType2Message(byte[] msg, Integer msgFlags)<a name="line.303"></a>
<span class="sourceLineNo">304</span> throws UnsupportedEncodingException {<a name="line.304"></a>
<span class="sourceLineNo">305</span> // Read the security buffer to determine where the target name<a name="line.305"></a>
<span class="sourceLineNo">306</span> // is stored and what it's length is<a name="line.306"></a>
<span class="sourceLineNo">307</span> byte[] targetName = readSecurityBufferTarget(msg, 12);<a name="line.307"></a>
<span class="sourceLineNo">308</span><a name="line.308"></a>
<span class="sourceLineNo">309</span> // now we convert it to a string<a name="line.309"></a>
<span class="sourceLineNo">310</span> int flags = msgFlags == null ? extractFlagsFromType2Message(msg) : msgFlags;<a name="line.310"></a>
<span class="sourceLineNo">311</span><a name="line.311"></a>
<span class="sourceLineNo">312</span> if (ByteUtilities.isFlagSet(flags, FLAG_NEGOTIATE_UNICODE)) {<a name="line.312"></a>
<span class="sourceLineNo">313</span> return new String(targetName, "UTF-16LE");<a name="line.313"></a>
<span class="sourceLineNo">314</span> }<a name="line.314"></a>
<span class="sourceLineNo">315</span><a name="line.315"></a>
<span class="sourceLineNo">316</span> return new String(targetName, "ASCII");<a name="line.316"></a>
<span class="sourceLineNo">317</span> }<a name="line.317"></a>
<span class="sourceLineNo">318</span><a name="line.318"></a>
<span class="sourceLineNo">319</span> /**<a name="line.319"></a>
<span class="sourceLineNo">320</span> * Extracts the target information block from the type 2 message.<a name="line.320"></a>
<span class="sourceLineNo">321</span> * <a name="line.321"></a>
<span class="sourceLineNo">322</span> * @param msg the type 2 message byte array<a name="line.322"></a>
<span class="sourceLineNo">323</span> * @param msgFlags the flags if null then flags are extracted from the<a name="line.323"></a>
<span class="sourceLineNo">324</span> * type 2 message<a name="line.324"></a>
<span class="sourceLineNo">325</span> * @return the target info<a name="line.325"></a>
<span class="sourceLineNo">326</span> */<a name="line.326"></a>
<span class="sourceLineNo">327</span> public final static byte[] extractTargetInfoFromType2Message(byte[] msg, Integer msgFlags) {<a name="line.327"></a>
<span class="sourceLineNo">328</span> int flags = msgFlags == null ? extractFlagsFromType2Message(msg) : msgFlags;<a name="line.328"></a>
<span class="sourceLineNo">329</span><a name="line.329"></a>
<span class="sourceLineNo">330</span> if (!ByteUtilities.isFlagSet(flags, FLAG_NEGOTIATE_TARGET_INFO)) {<a name="line.330"></a>
<span class="sourceLineNo">331</span> return null;<a name="line.331"></a>
<span class="sourceLineNo">332</span> }<a name="line.332"></a>
<span class="sourceLineNo">333</span><a name="line.333"></a>
<span class="sourceLineNo">334</span> int pos = 40;<a name="line.334"></a>
<span class="sourceLineNo">335</span><a name="line.335"></a>
<span class="sourceLineNo">336</span> return readSecurityBufferTarget(msg, pos);<a name="line.336"></a>
<span class="sourceLineNo">337</span> }<a name="line.337"></a>
<span class="sourceLineNo">338</span><a name="line.338"></a>
<span class="sourceLineNo">339</span> /**<a name="line.339"></a>
<span class="sourceLineNo">340</span> * Prints to the {@link PrintWriter} the target information block extracted<a name="line.340"></a>
<span class="sourceLineNo">341</span> * from the type 2 message.<a name="line.341"></a>
<span class="sourceLineNo">342</span> * <a name="line.342"></a>
<span class="sourceLineNo">343</span> * @param msg the type 2 message<a name="line.343"></a>
<span class="sourceLineNo">344</span> * @param msgFlags the flags if null then flags are extracted from the<a name="line.344"></a>
<span class="sourceLineNo">345</span> * type 2 message<a name="line.345"></a>
<span class="sourceLineNo">346</span> * @param out the output target for the information<a name="line.346"></a>
<span class="sourceLineNo">347</span> * @throws UnsupportedEncodingException if unable to use the<a name="line.347"></a>
<span class="sourceLineNo">348</span> * needed UTF-16LE or ASCII charsets<a name="line.348"></a>
<span class="sourceLineNo">349</span> */<a name="line.349"></a>
<span class="sourceLineNo">350</span> public final static void printTargetInformationBlockFromType2Message(byte[] msg, Integer msgFlags, PrintWriter out)<a name="line.350"></a>
<span class="sourceLineNo">351</span> throws UnsupportedEncodingException {<a name="line.351"></a>
<span class="sourceLineNo">352</span> int flags = msgFlags == null ? extractFlagsFromType2Message(msg) : msgFlags;<a name="line.352"></a>
<span class="sourceLineNo">353</span><a name="line.353"></a>
<span class="sourceLineNo">354</span> byte[] infoBlock = extractTargetInfoFromType2Message(msg, flags);<a name="line.354"></a>
<span class="sourceLineNo">355</span><a name="line.355"></a>
<span class="sourceLineNo">356</span> if (infoBlock == null) {<a name="line.356"></a>
<span class="sourceLineNo">357</span> out.println("No target information block found !");<a name="line.357"></a>
<span class="sourceLineNo">358</span> } else {<a name="line.358"></a>
<span class="sourceLineNo">359</span> int pos = 0;<a name="line.359"></a>
<span class="sourceLineNo">360</span><a name="line.360"></a>
<span class="sourceLineNo">361</span> while (infoBlock[pos] != 0) {<a name="line.361"></a>
<span class="sourceLineNo">362</span> out.print("---\nType " + infoBlock[pos] + ": ");<a name="line.362"></a>
<span class="sourceLineNo">363</span><a name="line.363"></a>
<span class="sourceLineNo">364</span> switch (infoBlock[pos]) {<a name="line.364"></a>
<span class="sourceLineNo">365</span> case 1:<a name="line.365"></a>
<span class="sourceLineNo">366</span> out.println("Server name");<a name="line.366"></a>
<span class="sourceLineNo">367</span> break;<a name="line.367"></a>
<span class="sourceLineNo">368</span> case 2:<a name="line.368"></a>
<span class="sourceLineNo">369</span> out.println("Domain name");<a name="line.369"></a>
<span class="sourceLineNo">370</span> break;<a name="line.370"></a>
<span class="sourceLineNo">371</span> case 3:<a name="line.371"></a>
<span class="sourceLineNo">372</span> out.println("Fully qualified DNS hostname");<a name="line.372"></a>
<span class="sourceLineNo">373</span> break;<a name="line.373"></a>
<span class="sourceLineNo">374</span> case 4:<a name="line.374"></a>
<span class="sourceLineNo">375</span> out.println("DNS domain name");<a name="line.375"></a>
<span class="sourceLineNo">376</span> break;<a name="line.376"></a>
<span class="sourceLineNo">377</span> case 5:<a name="line.377"></a>
<span class="sourceLineNo">378</span> out.println("Parent DNS domain name");<a name="line.378"></a>
<span class="sourceLineNo">379</span> break;<a name="line.379"></a>
<span class="sourceLineNo">380</span> }<a name="line.380"></a>
<span class="sourceLineNo">381</span><a name="line.381"></a>
<span class="sourceLineNo">382</span> byte[] len = new byte[2];<a name="line.382"></a>
<span class="sourceLineNo">383</span> System.arraycopy(infoBlock, pos + 2, len, 0, 2);<a name="line.383"></a>
<span class="sourceLineNo">384</span> ByteUtilities.changeByteEndianess(len, 0, 2);<a name="line.384"></a>
<span class="sourceLineNo">385</span><a name="line.385"></a>
<span class="sourceLineNo">386</span> int length = ByteUtilities.makeIntFromByte2(len, 0);<a name="line.386"></a>
<span class="sourceLineNo">387</span> out.println("Length: " + length + " bytes");<a name="line.387"></a>
<span class="sourceLineNo">388</span> out.print("Data: ");<a name="line.388"></a>
<span class="sourceLineNo">389</span><a name="line.389"></a>
<span class="sourceLineNo">390</span> if (ByteUtilities.isFlagSet(flags, FLAG_NEGOTIATE_UNICODE)) {<a name="line.390"></a>
<span class="sourceLineNo">391</span> out.println(new String(infoBlock, pos + 4, length, "UTF-16LE"));<a name="line.391"></a>
<span class="sourceLineNo">392</span> } else {<a name="line.392"></a>
<span class="sourceLineNo">393</span> out.println(new String(infoBlock, pos + 4, length, "ASCII"));<a name="line.393"></a>
<span class="sourceLineNo">394</span> }<a name="line.394"></a>
<span class="sourceLineNo">395</span><a name="line.395"></a>
<span class="sourceLineNo">396</span> pos += 4 + length;<a name="line.396"></a>
<span class="sourceLineNo">397</span> out.flush();<a name="line.397"></a>
<span class="sourceLineNo">398</span> }<a name="line.398"></a>
<span class="sourceLineNo">399</span> }<a name="line.399"></a>
<span class="sourceLineNo">400</span> }<a name="line.400"></a>
<span class="sourceLineNo">401</span><a name="line.401"></a>
<span class="sourceLineNo">402</span> /**<a name="line.402"></a>
<span class="sourceLineNo">403</span> * @see &lt;a<a name="line.403"></a>
<span class="sourceLineNo">404</span> * href="http://davenport.sourceforge.net/ntlm.html#theType3Message"&gt;NTLM<a name="line.404"></a>
<span class="sourceLineNo">405</span> * message type&lt;/a&gt;<a name="line.405"></a>
<span class="sourceLineNo">406</span> * <a name="line.406"></a>
<span class="sourceLineNo">407</span> * @param user<a name="line.407"></a>
<span class="sourceLineNo">408</span> * the user name<a name="line.408"></a>
<span class="sourceLineNo">409</span> * @param password<a name="line.409"></a>
<span class="sourceLineNo">410</span> * the user password<a name="line.410"></a>
<span class="sourceLineNo">411</span> * @param challenge<a name="line.411"></a>
<span class="sourceLineNo">412</span> * the challenge response<a name="line.412"></a>
<span class="sourceLineNo">413</span> * @param target<a name="line.413"></a>
<span class="sourceLineNo">414</span> * the target name<a name="line.414"></a>
<span class="sourceLineNo">415</span> * @param workstation<a name="line.415"></a>
<span class="sourceLineNo">416</span> * the client workstation's name<a name="line.416"></a>
<span class="sourceLineNo">417</span> * @param serverFlags<a name="line.417"></a>
<span class="sourceLineNo">418</span> * the flags set by the client<a name="line.418"></a>
<span class="sourceLineNo">419</span> * @param osVersion<a name="line.419"></a>
<span class="sourceLineNo">420</span> * the os version of the client<a name="line.420"></a>
<span class="sourceLineNo">421</span> * @return the type 3 message<a name="line.421"></a>
<span class="sourceLineNo">422</span> */<a name="line.422"></a>
<span class="sourceLineNo">423</span> public final static byte[] createType3Message(String user, String password, byte[] challenge, String target,<a name="line.423"></a>
<span class="sourceLineNo">424</span> String workstation, Integer serverFlags, byte[] osVersion) {<a name="line.424"></a>
<span class="sourceLineNo">425</span> byte[] msg = null;<a name="line.425"></a>
<span class="sourceLineNo">426</span><a name="line.426"></a>
<span class="sourceLineNo">427</span> if (challenge == null || challenge.length != 8) {<a name="line.427"></a>
<span class="sourceLineNo">428</span> throw new IllegalArgumentException("challenge[] should be a 8 byte wide array");<a name="line.428"></a>
<span class="sourceLineNo">429</span> }<a name="line.429"></a>
<span class="sourceLineNo">430</span><a name="line.430"></a>
<span class="sourceLineNo">431</span> if (osVersion != null &amp;&amp; osVersion.length != 8) {<a name="line.431"></a>
<span class="sourceLineNo">432</span> throw new IllegalArgumentException("osVersion should be a 8 byte wide array");<a name="line.432"></a>
<span class="sourceLineNo">433</span> }<a name="line.433"></a>
<span class="sourceLineNo">434</span><a name="line.434"></a>
<span class="sourceLineNo">435</span> int flags = serverFlags != null ? serverFlags : DEFAULT_FLAGS;<a name="line.435"></a>
<span class="sourceLineNo">436</span><a name="line.436"></a>
<span class="sourceLineNo">437</span> ByteArrayOutputStream baos = new ByteArrayOutputStream();<a name="line.437"></a>
<span class="sourceLineNo">438</span><a name="line.438"></a>
<span class="sourceLineNo">439</span> try {<a name="line.439"></a>
<span class="sourceLineNo">440</span> baos.write(NTLM_SIGNATURE);<a name="line.440"></a>
<span class="sourceLineNo">441</span> baos.write(ByteUtilities.writeInt(MESSAGE_TYPE_3));<a name="line.441"></a>
<span class="sourceLineNo">442</span><a name="line.442"></a>
<span class="sourceLineNo">443</span> byte[] dataLMResponse = NTLMResponses.getLMResponse(password, challenge);<a name="line.443"></a>
<span class="sourceLineNo">444</span> byte[] dataNTLMResponse = NTLMResponses.getNTLMResponse(password, challenge);<a name="line.444"></a>
<span class="sourceLineNo">445</span><a name="line.445"></a>
<span class="sourceLineNo">446</span> boolean useUnicode = ByteUtilities.isFlagSet(flags, FLAG_NEGOTIATE_UNICODE);<a name="line.446"></a>
<span class="sourceLineNo">447</span> byte[] targetName = ByteUtilities.encodeString(target, useUnicode);<a name="line.447"></a>
<span class="sourceLineNo">448</span> byte[] userName = ByteUtilities.encodeString(user, useUnicode);<a name="line.448"></a>
<span class="sourceLineNo">449</span> byte[] workstationName = ByteUtilities.encodeString(workstation, useUnicode);<a name="line.449"></a>
<span class="sourceLineNo">450</span><a name="line.450"></a>
<span class="sourceLineNo">451</span> int pos = osVersion != null ? 72 : 64;<a name="line.451"></a>
<span class="sourceLineNo">452</span> int responsePos = pos + targetName.length + userName.length + workstationName.length;<a name="line.452"></a>
<span class="sourceLineNo">453</span> responsePos = writeSecurityBufferAndUpdatePointer(baos, (short) dataLMResponse.length, responsePos);<a name="line.453"></a>
<span class="sourceLineNo">454</span> writeSecurityBufferAndUpdatePointer(baos, (short) dataNTLMResponse.length, responsePos);<a name="line.454"></a>
<span class="sourceLineNo">455</span> pos = writeSecurityBufferAndUpdatePointer(baos, (short) targetName.length, pos);<a name="line.455"></a>
<span class="sourceLineNo">456</span> pos = writeSecurityBufferAndUpdatePointer(baos, (short) userName.length, pos);<a name="line.456"></a>
<span class="sourceLineNo">457</span> writeSecurityBufferAndUpdatePointer(baos, (short) workstationName.length, pos);<a name="line.457"></a>
<span class="sourceLineNo">458</span><a name="line.458"></a>
<span class="sourceLineNo">459</span> /**<a name="line.459"></a>
<span class="sourceLineNo">460</span> LM/LMv2 Response security buffer<a name="line.460"></a>
<span class="sourceLineNo">461</span> 20 NTLM/NTLMv2 Response security buffer<a name="line.461"></a>
<span class="sourceLineNo">462</span> 28 Target Name security buffer<a name="line.462"></a>
<span class="sourceLineNo">463</span> 36 User Name security buffer<a name="line.463"></a>
<span class="sourceLineNo">464</span> 44 Workstation Name security buffer<a name="line.464"></a>
<span class="sourceLineNo">465</span> (52) Session Key (optional) security buffer<a name="line.465"></a>
<span class="sourceLineNo">466</span> (60) Flags (optional) long<a name="line.466"></a>
<span class="sourceLineNo">467</span> (64) OS Version Structure (Optional) 8 bytes<a name="line.467"></a>
<span class="sourceLineNo">468</span> **/<a name="line.468"></a>
<span class="sourceLineNo">469</span><a name="line.469"></a>
<span class="sourceLineNo">470</span> // Session Key Security Buffer ??!<a name="line.470"></a>
<span class="sourceLineNo">471</span> baos.write(new byte[] { 0, 0, 0, 0, (byte) 0x9a, 0, 0, 0 });<a name="line.471"></a>
<span class="sourceLineNo">472</span><a name="line.472"></a>
<span class="sourceLineNo">473</span> baos.write(ByteUtilities.writeInt(flags));<a name="line.473"></a>
<span class="sourceLineNo">474</span><a name="line.474"></a>
<span class="sourceLineNo">475</span> if (osVersion != null) {<a name="line.475"></a>
<span class="sourceLineNo">476</span> baos.write(osVersion);<a name="line.476"></a>
<span class="sourceLineNo">477</span> }<a name="line.477"></a>
<span class="sourceLineNo">478</span><a name="line.478"></a>
<span class="sourceLineNo">479</span> // Order is not mandatory since a pointer is given in the security buffers<a name="line.479"></a>
<span class="sourceLineNo">480</span> baos.write(targetName);<a name="line.480"></a>
<span class="sourceLineNo">481</span> baos.write(userName);<a name="line.481"></a>
<span class="sourceLineNo">482</span> baos.write(workstationName);<a name="line.482"></a>
<span class="sourceLineNo">483</span><a name="line.483"></a>
<span class="sourceLineNo">484</span> baos.write(dataLMResponse);<a name="line.484"></a>
<span class="sourceLineNo">485</span> baos.write(dataNTLMResponse);<a name="line.485"></a>
<span class="sourceLineNo">486</span><a name="line.486"></a>
<span class="sourceLineNo">487</span> msg = baos.toByteArray();<a name="line.487"></a>
<span class="sourceLineNo">488</span> baos.close();<a name="line.488"></a>
<span class="sourceLineNo">489</span> } catch (Exception e) {<a name="line.489"></a>
<span class="sourceLineNo">490</span> e.printStackTrace();<a name="line.490"></a>
<span class="sourceLineNo">491</span> return null;<a name="line.491"></a>
<span class="sourceLineNo">492</span> }<a name="line.492"></a>
<span class="sourceLineNo">493</span><a name="line.493"></a>
<span class="sourceLineNo">494</span> return msg;<a name="line.494"></a>
<span class="sourceLineNo">495</span> }<a name="line.495"></a>
<span class="sourceLineNo">496</span>}<a name="line.496"></a>
</pre>
</div>
</body>
</html>