blob: 97773d90528d2ef8dbd06f43e1bb2142e0bd26fb [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.socks;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.io.UnsupportedEncodingException;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.net.Inet4Address;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.net.Inet6Address;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.net.InetSocketAddress;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.mina.core.buffer.IoBuffer;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.mina.core.filterchain.IoFilter.NextFilter;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.mina.proxy.session.ProxyIoSession;<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>import org.ietf.jgss.GSSContext;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.ietf.jgss.GSSException;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.ietf.jgss.GSSManager;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.ietf.jgss.GSSName;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.ietf.jgss.Oid;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.slf4j.Logger;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.slf4j.LoggerFactory;<a name="line.37"></a>
<span class="sourceLineNo">038</span><a name="line.38"></a>
<span class="sourceLineNo">039</span>/**<a name="line.39"></a>
<span class="sourceLineNo">040</span> * Socks5LogicHandler.java - SOCKS5 authentication mechanisms logic handler.<a name="line.40"></a>
<span class="sourceLineNo">041</span> * <a name="line.41"></a>
<span class="sourceLineNo">042</span> * @author &lt;a href="http://mina.apache.org"&gt;Apache MINA Project&lt;/a&gt;<a name="line.42"></a>
<span class="sourceLineNo">043</span> * @since MINA 2.0.0-M3<a name="line.43"></a>
<span class="sourceLineNo">044</span> */<a name="line.44"></a>
<span class="sourceLineNo">045</span>public class Socks5LogicHandler extends AbstractSocksLogicHandler {<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span> private final static Logger LOGGER = LoggerFactory.getLogger(Socks5LogicHandler.class);<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span> /**<a name="line.49"></a>
<span class="sourceLineNo">050</span> * The selected authentication method attribute key.<a name="line.50"></a>
<span class="sourceLineNo">051</span> */<a name="line.51"></a>
<span class="sourceLineNo">052</span> private final static String SELECTED_AUTH_METHOD = Socks5LogicHandler.class.getName() + ".SelectedAuthMethod";<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span> /**<a name="line.54"></a>
<span class="sourceLineNo">055</span> * The current step in the handshake attribute key.<a name="line.55"></a>
<span class="sourceLineNo">056</span> */<a name="line.56"></a>
<span class="sourceLineNo">057</span> private final static String HANDSHAKE_STEP = Socks5LogicHandler.class.getName() + ".HandshakeStep";<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span> /**<a name="line.59"></a>
<span class="sourceLineNo">060</span> * The Java GSS-API context attribute key.<a name="line.60"></a>
<span class="sourceLineNo">061</span> */<a name="line.61"></a>
<span class="sourceLineNo">062</span> private final static String GSS_CONTEXT = Socks5LogicHandler.class.getName() + ".GSSContext";<a name="line.62"></a>
<span class="sourceLineNo">063</span><a name="line.63"></a>
<span class="sourceLineNo">064</span> /**<a name="line.64"></a>
<span class="sourceLineNo">065</span> * Last GSS token received attribute key.<a name="line.65"></a>
<span class="sourceLineNo">066</span> */<a name="line.66"></a>
<span class="sourceLineNo">067</span> private final static String GSS_TOKEN = Socks5LogicHandler.class.getName() + ".GSSToken";<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span> /**<a name="line.69"></a>
<span class="sourceLineNo">070</span> * @see AbstractSocksLogicHandler#AbstractSocksLogicHandler(ProxyIoSession)<a name="line.70"></a>
<span class="sourceLineNo">071</span> * <a name="line.71"></a>
<span class="sourceLineNo">072</span> * @param proxyIoSession The original session<a name="line.72"></a>
<span class="sourceLineNo">073</span> */<a name="line.73"></a>
<span class="sourceLineNo">074</span> public Socks5LogicHandler(final ProxyIoSession proxyIoSession) {<a name="line.74"></a>
<span class="sourceLineNo">075</span> super(proxyIoSession);<a name="line.75"></a>
<span class="sourceLineNo">076</span> getSession().setAttribute(HANDSHAKE_STEP, SocksProxyConstants.SOCKS5_GREETING_STEP);<a name="line.76"></a>
<span class="sourceLineNo">077</span> }<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span> /**<a name="line.79"></a>
<span class="sourceLineNo">080</span> * Performs the handshake process.<a name="line.80"></a>
<span class="sourceLineNo">081</span> * <a name="line.81"></a>
<span class="sourceLineNo">082</span> * @param nextFilter the next filter<a name="line.82"></a>
<span class="sourceLineNo">083</span> */<a name="line.83"></a>
<span class="sourceLineNo">084</span> public synchronized void doHandshake(final NextFilter nextFilter) {<a name="line.84"></a>
<span class="sourceLineNo">085</span> LOGGER.debug(" doHandshake()");<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span> // Send request<a name="line.87"></a>
<span class="sourceLineNo">088</span> writeRequest(nextFilter, request, ((Integer) getSession().getAttribute(HANDSHAKE_STEP)).intValue());<a name="line.88"></a>
<span class="sourceLineNo">089</span> }<a name="line.89"></a>
<span class="sourceLineNo">090</span><a name="line.90"></a>
<span class="sourceLineNo">091</span> /**<a name="line.91"></a>
<span class="sourceLineNo">092</span> * Encodes the initial greeting packet.<a name="line.92"></a>
<span class="sourceLineNo">093</span> * <a name="line.93"></a>
<span class="sourceLineNo">094</span> * @param request the socks proxy request data<a name="line.94"></a>
<span class="sourceLineNo">095</span> * @return the encoded buffer<a name="line.95"></a>
<span class="sourceLineNo">096</span> */<a name="line.96"></a>
<span class="sourceLineNo">097</span> private IoBuffer encodeInitialGreetingPacket(final SocksProxyRequest request) {<a name="line.97"></a>
<span class="sourceLineNo">098</span> byte nbMethods = (byte) SocksProxyConstants.SUPPORTED_AUTH_METHODS.length;<a name="line.98"></a>
<span class="sourceLineNo">099</span> IoBuffer buf = IoBuffer.allocate(2 + nbMethods);<a name="line.99"></a>
<span class="sourceLineNo">100</span><a name="line.100"></a>
<span class="sourceLineNo">101</span> buf.put(request.getProtocolVersion());<a name="line.101"></a>
<span class="sourceLineNo">102</span> buf.put(nbMethods);<a name="line.102"></a>
<span class="sourceLineNo">103</span> buf.put(SocksProxyConstants.SUPPORTED_AUTH_METHODS);<a name="line.103"></a>
<span class="sourceLineNo">104</span><a name="line.104"></a>
<span class="sourceLineNo">105</span> return buf;<a name="line.105"></a>
<span class="sourceLineNo">106</span> }<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span> /**<a name="line.108"></a>
<span class="sourceLineNo">109</span> * Encodes the proxy authorization request packet.<a name="line.109"></a>
<span class="sourceLineNo">110</span> * <a name="line.110"></a>
<span class="sourceLineNo">111</span> * @param request the socks proxy request data<a name="line.111"></a>
<span class="sourceLineNo">112</span> * @return the encoded buffer<a name="line.112"></a>
<span class="sourceLineNo">113</span> * @throws UnsupportedEncodingException if request's hostname charset <a name="line.113"></a>
<span class="sourceLineNo">114</span> * can't be converted to ASCII. <a name="line.114"></a>
<span class="sourceLineNo">115</span> */<a name="line.115"></a>
<span class="sourceLineNo">116</span> private IoBuffer encodeProxyRequestPacket(final SocksProxyRequest request) throws UnsupportedEncodingException {<a name="line.116"></a>
<span class="sourceLineNo">117</span> int len = 6;<a name="line.117"></a>
<span class="sourceLineNo">118</span> InetSocketAddress adr = request.getEndpointAddress();<a name="line.118"></a>
<span class="sourceLineNo">119</span> byte addressType = 0;<a name="line.119"></a>
<span class="sourceLineNo">120</span> byte[] host = null;<a name="line.120"></a>
<span class="sourceLineNo">121</span><a name="line.121"></a>
<span class="sourceLineNo">122</span> if (adr != null &amp;&amp; !adr.isUnresolved()) {<a name="line.122"></a>
<span class="sourceLineNo">123</span> if (adr.getAddress() instanceof Inet6Address) {<a name="line.123"></a>
<span class="sourceLineNo">124</span> len += 16;<a name="line.124"></a>
<span class="sourceLineNo">125</span> addressType = SocksProxyConstants.IPV6_ADDRESS_TYPE;<a name="line.125"></a>
<span class="sourceLineNo">126</span> } else if (adr.getAddress() instanceof Inet4Address) {<a name="line.126"></a>
<span class="sourceLineNo">127</span> len += 4;<a name="line.127"></a>
<span class="sourceLineNo">128</span> addressType = SocksProxyConstants.IPV4_ADDRESS_TYPE;<a name="line.128"></a>
<span class="sourceLineNo">129</span> }<a name="line.129"></a>
<span class="sourceLineNo">130</span> } else {<a name="line.130"></a>
<span class="sourceLineNo">131</span> host = request.getHost() != null ? request.getHost().getBytes("ASCII") : null;<a name="line.131"></a>
<span class="sourceLineNo">132</span><a name="line.132"></a>
<span class="sourceLineNo">133</span> if (host != null) {<a name="line.133"></a>
<span class="sourceLineNo">134</span> len += 1 + host.length;<a name="line.134"></a>
<span class="sourceLineNo">135</span> addressType = SocksProxyConstants.DOMAIN_NAME_ADDRESS_TYPE;<a name="line.135"></a>
<span class="sourceLineNo">136</span> } else {<a name="line.136"></a>
<span class="sourceLineNo">137</span> throw new IllegalArgumentException("SocksProxyRequest object " + "has no suitable endpoint information");<a name="line.137"></a>
<span class="sourceLineNo">138</span> }<a name="line.138"></a>
<span class="sourceLineNo">139</span> }<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span> IoBuffer buf = IoBuffer.allocate(len);<a name="line.141"></a>
<span class="sourceLineNo">142</span><a name="line.142"></a>
<span class="sourceLineNo">143</span> buf.put(request.getProtocolVersion());<a name="line.143"></a>
<span class="sourceLineNo">144</span> buf.put(request.getCommandCode());<a name="line.144"></a>
<span class="sourceLineNo">145</span> buf.put((byte) 0x00); // Reserved<a name="line.145"></a>
<span class="sourceLineNo">146</span> buf.put(addressType);<a name="line.146"></a>
<span class="sourceLineNo">147</span><a name="line.147"></a>
<span class="sourceLineNo">148</span> if (host == null) {<a name="line.148"></a>
<span class="sourceLineNo">149</span> buf.put(request.getIpAddress());<a name="line.149"></a>
<span class="sourceLineNo">150</span> } else {<a name="line.150"></a>
<span class="sourceLineNo">151</span> buf.put((byte) host.length);<a name="line.151"></a>
<span class="sourceLineNo">152</span> buf.put(host);<a name="line.152"></a>
<span class="sourceLineNo">153</span> }<a name="line.153"></a>
<span class="sourceLineNo">154</span><a name="line.154"></a>
<span class="sourceLineNo">155</span> buf.put(request.getPort());<a name="line.155"></a>
<span class="sourceLineNo">156</span><a name="line.156"></a>
<span class="sourceLineNo">157</span> return buf;<a name="line.157"></a>
<span class="sourceLineNo">158</span> }<a name="line.158"></a>
<span class="sourceLineNo">159</span><a name="line.159"></a>
<span class="sourceLineNo">160</span> /**<a name="line.160"></a>
<span class="sourceLineNo">161</span> * Encodes the authentication packet for supported authentication methods.<a name="line.161"></a>
<span class="sourceLineNo">162</span> * <a name="line.162"></a>
<span class="sourceLineNo">163</span> * @param request the socks proxy request data<a name="line.163"></a>
<span class="sourceLineNo">164</span> * @return the encoded buffer, if null then authentication step is over <a name="line.164"></a>
<span class="sourceLineNo">165</span> * and handshake process can jump immediately to the next step without waiting<a name="line.165"></a>
<span class="sourceLineNo">166</span> * for a server reply.<a name="line.166"></a>
<span class="sourceLineNo">167</span> * @throws UnsupportedEncodingException if some string charset convertion fails<a name="line.167"></a>
<span class="sourceLineNo">168</span> * @throws GSSException when something fails while using GSSAPI<a name="line.168"></a>
<span class="sourceLineNo">169</span> */<a name="line.169"></a>
<span class="sourceLineNo">170</span> private IoBuffer encodeAuthenticationPacket(final SocksProxyRequest request) throws UnsupportedEncodingException,<a name="line.170"></a>
<span class="sourceLineNo">171</span> GSSException {<a name="line.171"></a>
<span class="sourceLineNo">172</span> byte method = ((Byte) getSession().getAttribute(Socks5LogicHandler.SELECTED_AUTH_METHOD)).byteValue();<a name="line.172"></a>
<span class="sourceLineNo">173</span><a name="line.173"></a>
<span class="sourceLineNo">174</span> switch (method) {<a name="line.174"></a>
<span class="sourceLineNo">175</span> case SocksProxyConstants.NO_AUTH:<a name="line.175"></a>
<span class="sourceLineNo">176</span> // In this case authentication is immediately considered as successfull<a name="line.176"></a>
<span class="sourceLineNo">177</span> // Next writeRequest() call will send the proxy request<a name="line.177"></a>
<span class="sourceLineNo">178</span> getSession().setAttribute(HANDSHAKE_STEP, SocksProxyConstants.SOCKS5_REQUEST_STEP);<a name="line.178"></a>
<span class="sourceLineNo">179</span> break;<a name="line.179"></a>
<span class="sourceLineNo">180</span><a name="line.180"></a>
<span class="sourceLineNo">181</span> case SocksProxyConstants.GSSAPI_AUTH:<a name="line.181"></a>
<span class="sourceLineNo">182</span> return encodeGSSAPIAuthenticationPacket(request);<a name="line.182"></a>
<span class="sourceLineNo">183</span><a name="line.183"></a>
<span class="sourceLineNo">184</span> case SocksProxyConstants.BASIC_AUTH:<a name="line.184"></a>
<span class="sourceLineNo">185</span> // The basic auth scheme packet is sent<a name="line.185"></a>
<span class="sourceLineNo">186</span> byte[] user = request.getUserName().getBytes("ASCII");<a name="line.186"></a>
<span class="sourceLineNo">187</span> byte[] pwd = request.getPassword().getBytes("ASCII");<a name="line.187"></a>
<span class="sourceLineNo">188</span> IoBuffer buf = IoBuffer.allocate(3 + user.length + pwd.length);<a name="line.188"></a>
<span class="sourceLineNo">189</span><a name="line.189"></a>
<span class="sourceLineNo">190</span> buf.put(SocksProxyConstants.BASIC_AUTH_SUBNEGOTIATION_VERSION);<a name="line.190"></a>
<span class="sourceLineNo">191</span> buf.put((byte) user.length);<a name="line.191"></a>
<span class="sourceLineNo">192</span> buf.put(user);<a name="line.192"></a>
<span class="sourceLineNo">193</span> buf.put((byte) pwd.length);<a name="line.193"></a>
<span class="sourceLineNo">194</span> buf.put(pwd);<a name="line.194"></a>
<span class="sourceLineNo">195</span><a name="line.195"></a>
<span class="sourceLineNo">196</span> return buf;<a name="line.196"></a>
<span class="sourceLineNo">197</span> }<a name="line.197"></a>
<span class="sourceLineNo">198</span><a name="line.198"></a>
<span class="sourceLineNo">199</span> return null;<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> * Encodes the authentication packet for supported authentication methods.<a name="line.203"></a>
<span class="sourceLineNo">204</span> * <a name="line.204"></a>
<span class="sourceLineNo">205</span> * @param request the socks proxy request data<a name="line.205"></a>
<span class="sourceLineNo">206</span> * @return the encoded buffer<a name="line.206"></a>
<span class="sourceLineNo">207</span> * @throws GSSException when something fails while using GSSAPI<a name="line.207"></a>
<span class="sourceLineNo">208</span> */<a name="line.208"></a>
<span class="sourceLineNo">209</span> private IoBuffer encodeGSSAPIAuthenticationPacket(final SocksProxyRequest request) throws GSSException {<a name="line.209"></a>
<span class="sourceLineNo">210</span> GSSContext ctx = (GSSContext) getSession().getAttribute(GSS_CONTEXT);<a name="line.210"></a>
<span class="sourceLineNo">211</span> if (ctx == null) {<a name="line.211"></a>
<span class="sourceLineNo">212</span> // first step in the authentication process<a name="line.212"></a>
<span class="sourceLineNo">213</span> GSSManager manager = GSSManager.getInstance();<a name="line.213"></a>
<span class="sourceLineNo">214</span> GSSName serverName = manager.createName(request.getServiceKerberosName(), null);<a name="line.214"></a>
<span class="sourceLineNo">215</span> Oid krb5OID = new Oid(SocksProxyConstants.KERBEROS_V5_OID);<a name="line.215"></a>
<span class="sourceLineNo">216</span><a name="line.216"></a>
<span class="sourceLineNo">217</span> if (LOGGER.isDebugEnabled()) {<a name="line.217"></a>
<span class="sourceLineNo">218</span> LOGGER.debug("Available mechs:");<a name="line.218"></a>
<span class="sourceLineNo">219</span> for (Oid o : manager.getMechs()) {<a name="line.219"></a>
<span class="sourceLineNo">220</span> if (o.equals(krb5OID)) {<a name="line.220"></a>
<span class="sourceLineNo">221</span> LOGGER.debug("Found Kerberos V OID available");<a name="line.221"></a>
<span class="sourceLineNo">222</span> }<a name="line.222"></a>
<span class="sourceLineNo">223</span> LOGGER.debug("{} with oid = {}", manager.getNamesForMech(o), o);<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> ctx = manager.createContext(serverName, krb5OID, null, GSSContext.DEFAULT_LIFETIME);<a name="line.227"></a>
<span class="sourceLineNo">228</span><a name="line.228"></a>
<span class="sourceLineNo">229</span> ctx.requestMutualAuth(true); // Mutual authentication<a name="line.229"></a>
<span class="sourceLineNo">230</span> ctx.requestConf(false);<a name="line.230"></a>
<span class="sourceLineNo">231</span> ctx.requestInteg(false);<a name="line.231"></a>
<span class="sourceLineNo">232</span><a name="line.232"></a>
<span class="sourceLineNo">233</span> getSession().setAttribute(GSS_CONTEXT, ctx);<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> byte[] token = (byte[]) getSession().getAttribute(GSS_TOKEN);<a name="line.236"></a>
<span class="sourceLineNo">237</span> if (token != null) {<a name="line.237"></a>
<span class="sourceLineNo">238</span> LOGGER.debug(" Received Token[{}] = {}", token.length, ByteUtilities.asHex(token));<a name="line.238"></a>
<span class="sourceLineNo">239</span> }<a name="line.239"></a>
<span class="sourceLineNo">240</span> IoBuffer buf = null;<a name="line.240"></a>
<span class="sourceLineNo">241</span><a name="line.241"></a>
<span class="sourceLineNo">242</span> if (!ctx.isEstablished()) {<a name="line.242"></a>
<span class="sourceLineNo">243</span> // token is ignored on the first call<a name="line.243"></a>
<span class="sourceLineNo">244</span> if (token == null) {<a name="line.244"></a>
<span class="sourceLineNo">245</span> token = new byte[32];<a name="line.245"></a>
<span class="sourceLineNo">246</span> }<a name="line.246"></a>
<span class="sourceLineNo">247</span><a name="line.247"></a>
<span class="sourceLineNo">248</span> token = ctx.initSecContext(token, 0, token.length);<a name="line.248"></a>
<span class="sourceLineNo">249</span><a name="line.249"></a>
<span class="sourceLineNo">250</span> // Send a token to the server if one was generated by<a name="line.250"></a>
<span class="sourceLineNo">251</span> // initSecContext<a name="line.251"></a>
<span class="sourceLineNo">252</span> if (token != null) {<a name="line.252"></a>
<span class="sourceLineNo">253</span> LOGGER.debug(" Sending Token[{}] = {}", token.length, ByteUtilities.asHex(token));<a name="line.253"></a>
<span class="sourceLineNo">254</span><a name="line.254"></a>
<span class="sourceLineNo">255</span> getSession().setAttribute(GSS_TOKEN, token);<a name="line.255"></a>
<span class="sourceLineNo">256</span> buf = IoBuffer.allocate(4 + token.length);<a name="line.256"></a>
<span class="sourceLineNo">257</span> buf.put(new byte[] { SocksProxyConstants.GSSAPI_AUTH_SUBNEGOTIATION_VERSION,<a name="line.257"></a>
<span class="sourceLineNo">258</span> SocksProxyConstants.GSSAPI_MSG_TYPE });<a name="line.258"></a>
<span class="sourceLineNo">259</span><a name="line.259"></a>
<span class="sourceLineNo">260</span> buf.put(ByteUtilities.intToNetworkByteOrder(token.length, 2));<a name="line.260"></a>
<span class="sourceLineNo">261</span> buf.put(token);<a name="line.261"></a>
<span class="sourceLineNo">262</span> }<a name="line.262"></a>
<span class="sourceLineNo">263</span> }<a name="line.263"></a>
<span class="sourceLineNo">264</span><a name="line.264"></a>
<span class="sourceLineNo">265</span> return buf;<a name="line.265"></a>
<span class="sourceLineNo">266</span> }<a name="line.266"></a>
<span class="sourceLineNo">267</span><a name="line.267"></a>
<span class="sourceLineNo">268</span> /**<a name="line.268"></a>
<span class="sourceLineNo">269</span> * Encodes a SOCKS5 request and writes it to the next filter<a name="line.269"></a>
<span class="sourceLineNo">270</span> * so it can be sent to the proxy server.<a name="line.270"></a>
<span class="sourceLineNo">271</span> * <a name="line.271"></a>
<span class="sourceLineNo">272</span> * @param nextFilter the next filter<a name="line.272"></a>
<span class="sourceLineNo">273</span> * @param request the request to send.<a name="line.273"></a>
<span class="sourceLineNo">274</span> * @param step the current step in the handshake process<a name="line.274"></a>
<span class="sourceLineNo">275</span> */<a name="line.275"></a>
<span class="sourceLineNo">276</span> private void writeRequest(final NextFilter nextFilter, final SocksProxyRequest request, int step) {<a name="line.276"></a>
<span class="sourceLineNo">277</span> try {<a name="line.277"></a>
<span class="sourceLineNo">278</span> IoBuffer buf = null;<a name="line.278"></a>
<span class="sourceLineNo">279</span><a name="line.279"></a>
<span class="sourceLineNo">280</span> if (step == SocksProxyConstants.SOCKS5_GREETING_STEP) {<a name="line.280"></a>
<span class="sourceLineNo">281</span> buf = encodeInitialGreetingPacket(request);<a name="line.281"></a>
<span class="sourceLineNo">282</span> } else if (step == SocksProxyConstants.SOCKS5_AUTH_STEP) {<a name="line.282"></a>
<span class="sourceLineNo">283</span> // This step can happen multiple times like in GSSAPI auth for instance<a name="line.283"></a>
<span class="sourceLineNo">284</span> buf = encodeAuthenticationPacket(request);<a name="line.284"></a>
<span class="sourceLineNo">285</span> // If buf is null then go to the next step<a name="line.285"></a>
<span class="sourceLineNo">286</span> if (buf == null) {<a name="line.286"></a>
<span class="sourceLineNo">287</span> step = SocksProxyConstants.SOCKS5_REQUEST_STEP;<a name="line.287"></a>
<span class="sourceLineNo">288</span> }<a name="line.288"></a>
<span class="sourceLineNo">289</span> }<a name="line.289"></a>
<span class="sourceLineNo">290</span><a name="line.290"></a>
<span class="sourceLineNo">291</span> if (step == SocksProxyConstants.SOCKS5_REQUEST_STEP) {<a name="line.291"></a>
<span class="sourceLineNo">292</span> buf = encodeProxyRequestPacket(request);<a name="line.292"></a>
<span class="sourceLineNo">293</span> }<a name="line.293"></a>
<span class="sourceLineNo">294</span><a name="line.294"></a>
<span class="sourceLineNo">295</span> buf.flip();<a name="line.295"></a>
<span class="sourceLineNo">296</span> writeData(nextFilter, buf);<a name="line.296"></a>
<span class="sourceLineNo">297</span><a name="line.297"></a>
<span class="sourceLineNo">298</span> } catch (Exception ex) {<a name="line.298"></a>
<span class="sourceLineNo">299</span> closeSession("Unable to send Socks request: ", ex);<a name="line.299"></a>
<span class="sourceLineNo">300</span> }<a name="line.300"></a>
<span class="sourceLineNo">301</span> }<a name="line.301"></a>
<span class="sourceLineNo">302</span><a name="line.302"></a>
<span class="sourceLineNo">303</span> /**<a name="line.303"></a>
<span class="sourceLineNo">304</span> * Handles incoming data during the handshake process. Should consume only the<a name="line.304"></a>
<span class="sourceLineNo">305</span> * handshake data from the buffer, leaving any extra data in place.<a name="line.305"></a>
<span class="sourceLineNo">306</span> * <a name="line.306"></a>
<span class="sourceLineNo">307</span> * @param nextFilter the next filter<a name="line.307"></a>
<span class="sourceLineNo">308</span> * @param buf the buffered data received <a name="line.308"></a>
<span class="sourceLineNo">309</span> */<a name="line.309"></a>
<span class="sourceLineNo">310</span> public synchronized void messageReceived(final NextFilter nextFilter, final IoBuffer buf) {<a name="line.310"></a>
<span class="sourceLineNo">311</span> try {<a name="line.311"></a>
<span class="sourceLineNo">312</span> int step = ((Integer) getSession().getAttribute(HANDSHAKE_STEP)).intValue();<a name="line.312"></a>
<span class="sourceLineNo">313</span><a name="line.313"></a>
<span class="sourceLineNo">314</span> if (step == SocksProxyConstants.SOCKS5_GREETING_STEP &amp;&amp; buf.get(0) != SocksProxyConstants.SOCKS_VERSION_5) {<a name="line.314"></a>
<span class="sourceLineNo">315</span> throw new IllegalStateException("Wrong socks version running on server");<a name="line.315"></a>
<span class="sourceLineNo">316</span> }<a name="line.316"></a>
<span class="sourceLineNo">317</span><a name="line.317"></a>
<span class="sourceLineNo">318</span> if ((step == SocksProxyConstants.SOCKS5_GREETING_STEP || step == SocksProxyConstants.SOCKS5_AUTH_STEP)<a name="line.318"></a>
<span class="sourceLineNo">319</span> &amp;&amp; buf.remaining() &gt;= 2) {<a name="line.319"></a>
<span class="sourceLineNo">320</span> handleResponse(nextFilter, buf, step);<a name="line.320"></a>
<span class="sourceLineNo">321</span> } else if (step == SocksProxyConstants.SOCKS5_REQUEST_STEP &amp;&amp; buf.remaining() &gt;= 5) {<a name="line.321"></a>
<span class="sourceLineNo">322</span> handleResponse(nextFilter, buf, step);<a name="line.322"></a>
<span class="sourceLineNo">323</span> }<a name="line.323"></a>
<span class="sourceLineNo">324</span> } catch (Exception ex) {<a name="line.324"></a>
<span class="sourceLineNo">325</span> closeSession("Proxy handshake failed: ", ex);<a name="line.325"></a>
<span class="sourceLineNo">326</span> }<a name="line.326"></a>
<span class="sourceLineNo">327</span> }<a name="line.327"></a>
<span class="sourceLineNo">328</span><a name="line.328"></a>
<span class="sourceLineNo">329</span> /**<a name="line.329"></a>
<span class="sourceLineNo">330</span> * Handle a SOCKS v5 response from the proxy server.<a name="line.330"></a>
<span class="sourceLineNo">331</span> * <a name="line.331"></a>
<span class="sourceLineNo">332</span> * @param nextFilter the next filter<a name="line.332"></a>
<span class="sourceLineNo">333</span> * @param buf the buffered data received <a name="line.333"></a>
<span class="sourceLineNo">334</span> * @param step the current step in the authentication process<a name="line.334"></a>
<span class="sourceLineNo">335</span> * @throws Exception If something went wrong<a name="line.335"></a>
<span class="sourceLineNo">336</span> */<a name="line.336"></a>
<span class="sourceLineNo">337</span> protected void handleResponse(final NextFilter nextFilter, final IoBuffer buf, int step) throws Exception {<a name="line.337"></a>
<span class="sourceLineNo">338</span> int len = 2;<a name="line.338"></a>
<span class="sourceLineNo">339</span> if (step == SocksProxyConstants.SOCKS5_GREETING_STEP) {<a name="line.339"></a>
<span class="sourceLineNo">340</span> // Send greeting message<a name="line.340"></a>
<span class="sourceLineNo">341</span> byte method = buf.get(1);<a name="line.341"></a>
<span class="sourceLineNo">342</span><a name="line.342"></a>
<span class="sourceLineNo">343</span> if (method == SocksProxyConstants.NO_ACCEPTABLE_AUTH_METHOD) {<a name="line.343"></a>
<span class="sourceLineNo">344</span> throw new IllegalStateException("No acceptable authentication method to use with "<a name="line.344"></a>
<span class="sourceLineNo">345</span> + "the socks proxy server");<a name="line.345"></a>
<span class="sourceLineNo">346</span> }<a name="line.346"></a>
<span class="sourceLineNo">347</span><a name="line.347"></a>
<span class="sourceLineNo">348</span> getSession().setAttribute(SELECTED_AUTH_METHOD, Byte.valueOf(method));<a name="line.348"></a>
<span class="sourceLineNo">349</span><a name="line.349"></a>
<span class="sourceLineNo">350</span> } else if (step == SocksProxyConstants.SOCKS5_AUTH_STEP) {<a name="line.350"></a>
<span class="sourceLineNo">351</span> // Authentication to the SOCKS server <a name="line.351"></a>
<span class="sourceLineNo">352</span> byte method = ((Byte) getSession().getAttribute(Socks5LogicHandler.SELECTED_AUTH_METHOD)).byteValue();<a name="line.352"></a>
<span class="sourceLineNo">353</span><a name="line.353"></a>
<span class="sourceLineNo">354</span> if (method == SocksProxyConstants.GSSAPI_AUTH) {<a name="line.354"></a>
<span class="sourceLineNo">355</span> int oldPos = buf.position();<a name="line.355"></a>
<span class="sourceLineNo">356</span><a name="line.356"></a>
<span class="sourceLineNo">357</span> if (buf.get(0) != 0x01) {<a name="line.357"></a>
<span class="sourceLineNo">358</span> throw new IllegalStateException("Authentication failed");<a name="line.358"></a>
<span class="sourceLineNo">359</span> }<a name="line.359"></a>
<span class="sourceLineNo">360</span> if ((buf.get(1) &amp; 0x00FF) == 0x00FF) {<a name="line.360"></a>
<span class="sourceLineNo">361</span> throw new IllegalStateException("Authentication failed: GSS API Security Context Failure");<a name="line.361"></a>
<span class="sourceLineNo">362</span> }<a name="line.362"></a>
<span class="sourceLineNo">363</span><a name="line.363"></a>
<span class="sourceLineNo">364</span> if (buf.remaining() &gt;= 2) {<a name="line.364"></a>
<span class="sourceLineNo">365</span> byte[] size = new byte[2];<a name="line.365"></a>
<span class="sourceLineNo">366</span> buf.get(size);<a name="line.366"></a>
<span class="sourceLineNo">367</span> int s = ByteUtilities.makeIntFromByte2(size);<a name="line.367"></a>
<span class="sourceLineNo">368</span> if (buf.remaining() &gt;= s) {<a name="line.368"></a>
<span class="sourceLineNo">369</span> byte[] token = new byte[s];<a name="line.369"></a>
<span class="sourceLineNo">370</span> buf.get(token);<a name="line.370"></a>
<span class="sourceLineNo">371</span> getSession().setAttribute(GSS_TOKEN, token);<a name="line.371"></a>
<span class="sourceLineNo">372</span> len = 0;<a name="line.372"></a>
<span class="sourceLineNo">373</span> } else {<a name="line.373"></a>
<span class="sourceLineNo">374</span> return;<a name="line.374"></a>
<span class="sourceLineNo">375</span> }<a name="line.375"></a>
<span class="sourceLineNo">376</span> } else {<a name="line.376"></a>
<span class="sourceLineNo">377</span> buf.position(oldPos);<a name="line.377"></a>
<span class="sourceLineNo">378</span> return;<a name="line.378"></a>
<span class="sourceLineNo">379</span> }<a name="line.379"></a>
<span class="sourceLineNo">380</span> } else if (buf.get(1) != SocksProxyConstants.V5_REPLY_SUCCEEDED) {<a name="line.380"></a>
<span class="sourceLineNo">381</span> throw new IllegalStateException("Authentication failed");<a name="line.381"></a>
<span class="sourceLineNo">382</span> }<a name="line.382"></a>
<span class="sourceLineNo">383</span><a name="line.383"></a>
<span class="sourceLineNo">384</span> } else if (step == SocksProxyConstants.SOCKS5_REQUEST_STEP) {<a name="line.384"></a>
<span class="sourceLineNo">385</span> // Send the request<a name="line.385"></a>
<span class="sourceLineNo">386</span> byte addressType = buf.get(3);<a name="line.386"></a>
<span class="sourceLineNo">387</span> len = 6;<a name="line.387"></a>
<span class="sourceLineNo">388</span> if (addressType == SocksProxyConstants.IPV6_ADDRESS_TYPE) {<a name="line.388"></a>
<span class="sourceLineNo">389</span> len += 16;<a name="line.389"></a>
<span class="sourceLineNo">390</span> } else if (addressType == SocksProxyConstants.IPV4_ADDRESS_TYPE) {<a name="line.390"></a>
<span class="sourceLineNo">391</span> len += 4;<a name="line.391"></a>
<span class="sourceLineNo">392</span> } else if (addressType == SocksProxyConstants.DOMAIN_NAME_ADDRESS_TYPE) {<a name="line.392"></a>
<span class="sourceLineNo">393</span> len += 1 + (buf.get(4));<a name="line.393"></a>
<span class="sourceLineNo">394</span> } else {<a name="line.394"></a>
<span class="sourceLineNo">395</span> throw new IllegalStateException("Unknwon address type");<a name="line.395"></a>
<span class="sourceLineNo">396</span> }<a name="line.396"></a>
<span class="sourceLineNo">397</span><a name="line.397"></a>
<span class="sourceLineNo">398</span> if (buf.remaining() &gt;= len) {<a name="line.398"></a>
<span class="sourceLineNo">399</span> // handle response<a name="line.399"></a>
<span class="sourceLineNo">400</span> byte status = buf.get(1);<a name="line.400"></a>
<span class="sourceLineNo">401</span> LOGGER.debug(" response status: {}", SocksProxyConstants.getReplyCodeAsString(status));<a name="line.401"></a>
<span class="sourceLineNo">402</span><a name="line.402"></a>
<span class="sourceLineNo">403</span> if (status == SocksProxyConstants.V5_REPLY_SUCCEEDED) {<a name="line.403"></a>
<span class="sourceLineNo">404</span> buf.position(buf.position() + len);<a name="line.404"></a>
<span class="sourceLineNo">405</span> setHandshakeComplete();<a name="line.405"></a>
<span class="sourceLineNo">406</span> return;<a name="line.406"></a>
<span class="sourceLineNo">407</span> }<a name="line.407"></a>
<span class="sourceLineNo">408</span><a name="line.408"></a>
<span class="sourceLineNo">409</span> throw new Exception("Proxy handshake failed - Code: 0x" + ByteUtilities.asHex(new byte[] { status }));<a name="line.409"></a>
<span class="sourceLineNo">410</span> }<a name="line.410"></a>
<span class="sourceLineNo">411</span><a name="line.411"></a>
<span class="sourceLineNo">412</span> return;<a name="line.412"></a>
<span class="sourceLineNo">413</span> }<a name="line.413"></a>
<span class="sourceLineNo">414</span><a name="line.414"></a>
<span class="sourceLineNo">415</span> if (len &gt; 0) {<a name="line.415"></a>
<span class="sourceLineNo">416</span> buf.position(buf.position() + len);<a name="line.416"></a>
<span class="sourceLineNo">417</span> }<a name="line.417"></a>
<span class="sourceLineNo">418</span><a name="line.418"></a>
<span class="sourceLineNo">419</span> // Move to the handshaking next step if not in the middle of<a name="line.419"></a>
<span class="sourceLineNo">420</span> // the authentication process<a name="line.420"></a>
<span class="sourceLineNo">421</span> boolean isAuthenticating = false;<a name="line.421"></a>
<span class="sourceLineNo">422</span> if (step == SocksProxyConstants.SOCKS5_AUTH_STEP) {<a name="line.422"></a>
<span class="sourceLineNo">423</span> byte method = ((Byte) getSession().getAttribute(Socks5LogicHandler.SELECTED_AUTH_METHOD)).byteValue();<a name="line.423"></a>
<span class="sourceLineNo">424</span> if (method == SocksProxyConstants.GSSAPI_AUTH) {<a name="line.424"></a>
<span class="sourceLineNo">425</span> GSSContext ctx = (GSSContext) getSession().getAttribute(GSS_CONTEXT);<a name="line.425"></a>
<span class="sourceLineNo">426</span> if (ctx == null || !ctx.isEstablished()) {<a name="line.426"></a>
<span class="sourceLineNo">427</span> isAuthenticating = true;<a name="line.427"></a>
<span class="sourceLineNo">428</span> }<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><a name="line.431"></a>
<span class="sourceLineNo">432</span> if (!isAuthenticating) {<a name="line.432"></a>
<span class="sourceLineNo">433</span> getSession().setAttribute(HANDSHAKE_STEP, ++step);<a name="line.433"></a>
<span class="sourceLineNo">434</span> }<a name="line.434"></a>
<span class="sourceLineNo">435</span><a name="line.435"></a>
<span class="sourceLineNo">436</span> doHandshake(nextFilter);<a name="line.436"></a>
<span class="sourceLineNo">437</span> }<a name="line.437"></a>
<span class="sourceLineNo">438</span><a name="line.438"></a>
<span class="sourceLineNo">439</span> /**<a name="line.439"></a>
<span class="sourceLineNo">440</span> * Closes the session. If any {@link GSSContext} is present in the session <a name="line.440"></a>
<span class="sourceLineNo">441</span> * then it is closed.<a name="line.441"></a>
<span class="sourceLineNo">442</span> * <a name="line.442"></a>
<span class="sourceLineNo">443</span> * @param message the error message<a name="line.443"></a>
<span class="sourceLineNo">444</span> */<a name="line.444"></a>
<span class="sourceLineNo">445</span> @Override<a name="line.445"></a>
<span class="sourceLineNo">446</span> protected void closeSession(String message) {<a name="line.446"></a>
<span class="sourceLineNo">447</span> GSSContext ctx = (GSSContext) getSession().getAttribute(GSS_CONTEXT);<a name="line.447"></a>
<span class="sourceLineNo">448</span> if (ctx != null) {<a name="line.448"></a>
<span class="sourceLineNo">449</span> try {<a name="line.449"></a>
<span class="sourceLineNo">450</span> ctx.dispose();<a name="line.450"></a>
<span class="sourceLineNo">451</span> } catch (GSSException e) {<a name="line.451"></a>
<span class="sourceLineNo">452</span> e.printStackTrace();<a name="line.452"></a>
<span class="sourceLineNo">453</span> super.closeSession(message, e);<a name="line.453"></a>
<span class="sourceLineNo">454</span> return;<a name="line.454"></a>
<span class="sourceLineNo">455</span> }<a name="line.455"></a>
<span class="sourceLineNo">456</span> }<a name="line.456"></a>
<span class="sourceLineNo">457</span> super.closeSession(message);<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>
</pre>
</div>
</body>
</html>