Google Git
Sign in
apache / mina-site / refs/heads/mina-gen-docs / . / 2.0.19 / xref / org / apache / mina / proxy / handlers / socks / Socks4LogicHandler.html
blob: bbb3fc9acb9eae19727ccd0bdddccb2a8064c0ef [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>Socks4LogicHandler xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/mina/proxy/handlers/socks/Socks4LogicHandler.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em>
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em>
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">package</strong> org.apache.mina.proxy.handlers.socks;
<a class="jxr_linenumber" name="L21" href="#L21">21</a>
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.util.Arrays;
<a class="jxr_linenumber" name="L23" href="#L23">23</a>
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.mina.core.buffer.IoBuffer;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.mina.core.filterchain.IoFilter.NextFilter;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.mina.proxy.session.ProxyIoSession;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.mina.proxy.utils.ByteUtilities;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a class="jxr_linenumber" name="L30" href="#L30">30</a>
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * Socks4LogicHandler.java - SOCKS4/SOCKS4a authentication mechanisms logic handler.</em>
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * @author &lt;a href="<a href="http://mina.apache.org" target="alexandria_uri">http://mina.apache.org</a>"&gt;Apache MINA Project&lt;/a&gt;</em>
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * @since MINA 2.0.0-M3</em>
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/mina/proxy/handlers/socks/Socks4LogicHandler.html">Socks4LogicHandler</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/mina/proxy/handlers/socks/AbstractSocksLogicHandler.html">AbstractSocksLogicHandler</a> {
<a class="jxr_linenumber" name="L38" href="#L38">38</a>
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger logger = LoggerFactory.getLogger(Socks4LogicHandler.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="L40" href="#L40">40</a>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * @see AbstractSocksLogicHandler#AbstractSocksLogicHandler(ProxyIoSession)</em>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * @param proxyIoSession The original session</em>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/mina/proxy/handlers/socks/Socks4LogicHandler.html">Socks4LogicHandler</a>(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/mina/proxy/session/ProxyIoSession.html">ProxyIoSession</a> proxyIoSession) {
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">super</strong>(proxyIoSession);
<a class="jxr_linenumber" name="L48" href="#L48">48</a> }
<a class="jxr_linenumber" name="L49" href="#L49">49</a>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * Perform the handshake.</em>
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * @param nextFilter the next filter</em>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> @Override
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> doHandshake(<strong class="jxr_keyword">final</strong> NextFilter nextFilter) {
<a class="jxr_linenumber" name="L57" href="#L57">57</a> logger.debug(<span class="jxr_string">" doHandshake()"</span>);
<a class="jxr_linenumber" name="L58" href="#L58">58</a>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_comment">// Send request</em>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> writeRequest(nextFilter, request);
<a class="jxr_linenumber" name="L61" href="#L61">61</a> }
<a class="jxr_linenumber" name="L62" href="#L62">62</a>
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * Encode a SOCKS4/SOCKS4a request and writes it to the next filter</em>
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * so it can be sent to the proxy server.</em>
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * @param nextFilter the next filter</em>
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * @param request the request to send.</em>
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> writeRequest(<strong class="jxr_keyword">final</strong> NextFilter nextFilter, <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/mina/proxy/handlers/socks/SocksProxyRequest.html">SocksProxyRequest</a> request) {
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">boolean</strong> isV4ARequest = Arrays.equals(request.getIpAddress(), SocksProxyConstants.FAKE_IP);
<a class="jxr_linenumber" name="L73" href="#L73">73</a> byte[] userID = request.getUserName().getBytes(<span class="jxr_string">"ASCII"</span>);
<a class="jxr_linenumber" name="L74" href="#L74">74</a> byte[] host = isV4ARequest ? request.getHost().getBytes(<span class="jxr_string">"ASCII"</span>) : <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L75" href="#L75">75</a>
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">int</strong> len = 9 + userID.length;
<a class="jxr_linenumber" name="L77" href="#L77">77</a>
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">if</strong> (isV4ARequest) {
<a class="jxr_linenumber" name="L79" href="#L79">79</a> len += host.length + 1;
<a class="jxr_linenumber" name="L80" href="#L80">80</a> }
<a class="jxr_linenumber" name="L81" href="#L81">81</a>
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <a href="../../../../../../org/apache/mina/core/buffer/IoBuffer.html">IoBuffer</a> buf = IoBuffer.allocate(len);
<a class="jxr_linenumber" name="L83" href="#L83">83</a>
<a class="jxr_linenumber" name="L84" href="#L84">84</a> buf.put(request.getProtocolVersion());
<a class="jxr_linenumber" name="L85" href="#L85">85</a> buf.put(request.getCommandCode());
<a class="jxr_linenumber" name="L86" href="#L86">86</a> buf.put(request.getPort());
<a class="jxr_linenumber" name="L87" href="#L87">87</a> buf.put(request.getIpAddress());
<a class="jxr_linenumber" name="L88" href="#L88">88</a> buf.put(userID);
<a class="jxr_linenumber" name="L89" href="#L89">89</a> buf.put(SocksProxyConstants.TERMINATOR);
<a class="jxr_linenumber" name="L90" href="#L90">90</a>
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">if</strong> (isV4ARequest) {
<a class="jxr_linenumber" name="L92" href="#L92">92</a> buf.put(host);
<a class="jxr_linenumber" name="L93" href="#L93">93</a> buf.put(SocksProxyConstants.TERMINATOR);
<a class="jxr_linenumber" name="L94" href="#L94">94</a> }
<a class="jxr_linenumber" name="L95" href="#L95">95</a>
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">if</strong> (isV4ARequest) {
<a class="jxr_linenumber" name="L97" href="#L97">97</a> logger.debug(<span class="jxr_string">" sending SOCKS4a request"</span>);
<a class="jxr_linenumber" name="L98" href="#L98">98</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L99" href="#L99">99</a> logger.debug(<span class="jxr_string">" sending SOCKS4 request"</span>);
<a class="jxr_linenumber" name="L100" href="#L100">100</a> }
<a class="jxr_linenumber" name="L101" href="#L101">101</a>
<a class="jxr_linenumber" name="L102" href="#L102">102</a> buf.flip();
<a class="jxr_linenumber" name="L103" href="#L103">103</a> writeData(nextFilter, buf);
<a class="jxr_linenumber" name="L104" href="#L104">104</a> } <strong class="jxr_keyword">catch</strong> (Exception ex) {
<a class="jxr_linenumber" name="L105" href="#L105">105</a> closeSession(<span class="jxr_string">"Unable to send Socks request: "</span>, ex);
<a class="jxr_linenumber" name="L106" href="#L106">106</a> }
<a class="jxr_linenumber" name="L107" href="#L107">107</a> }
<a class="jxr_linenumber" name="L108" href="#L108">108</a>
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * Handle incoming data during the handshake process. Should consume only the</em>
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * handshake data from the buffer, leaving any extra data in place.</em>
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * @param nextFilter the next filter</em>
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * @param buf the server response data buffer</em>
<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L116" href="#L116">116</a> @Override
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> messageReceived(<strong class="jxr_keyword">final</strong> NextFilter nextFilter, <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/mina/core/buffer/IoBuffer.html">IoBuffer</a> buf) {
<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">if</strong> (buf.remaining() &gt;= SocksProxyConstants.SOCKS_4_RESPONSE_SIZE) {
<a class="jxr_linenumber" name="L120" href="#L120">120</a> handleResponse(buf);
<a class="jxr_linenumber" name="L121" href="#L121">121</a> }
<a class="jxr_linenumber" name="L122" href="#L122">122</a> } <strong class="jxr_keyword">catch</strong> (Exception ex) {
<a class="jxr_linenumber" name="L123" href="#L123">123</a> closeSession(<span class="jxr_string">"Proxy handshake failed: "</span>, ex);
<a class="jxr_linenumber" name="L124" href="#L124">124</a> }
<a class="jxr_linenumber" name="L125" href="#L125">125</a> }
<a class="jxr_linenumber" name="L126" href="#L126">126</a>
<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * Handle a SOCKS4/SOCKS4a response from the proxy server. Test</em>
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * the response buffer reply code and call {@link #setHandshakeComplete()}</em>
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * if access is granted.</em>
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * @param buf the buffer holding the server response data.</em>
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * @throws Exception if server response is malformed or if request is rejected</em>
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * by the proxy server.</em>
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> handleResponse(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/mina/core/buffer/IoBuffer.html">IoBuffer</a> buf) <strong class="jxr_keyword">throws</strong> Exception {
<a class="jxr_linenumber" name="L137" href="#L137">137</a> byte first = buf.get(0);
<a class="jxr_linenumber" name="L138" href="#L138">138</a>
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">if</strong> (first != 0) {
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> Exception(<span class="jxr_string">"Socks response seems to be malformed"</span>);
<a class="jxr_linenumber" name="L141" href="#L141">141</a> }
<a class="jxr_linenumber" name="L142" href="#L142">142</a>
<a class="jxr_linenumber" name="L143" href="#L143">143</a> byte status = buf.get(1);
<a class="jxr_linenumber" name="L144" href="#L144">144</a>
<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_comment">// Consumes all the response data from the buffer</em>
<a class="jxr_linenumber" name="L146" href="#L146">146</a> buf.position(buf.position() + SocksProxyConstants.SOCKS_4_RESPONSE_SIZE);
<a class="jxr_linenumber" name="L147" href="#L147">147</a>
<a class="jxr_linenumber" name="L148" href="#L148">148</a> <strong class="jxr_keyword">if</strong> (status == SocksProxyConstants.V4_REPLY_REQUEST_GRANTED) {
<a class="jxr_linenumber" name="L149" href="#L149">149</a> setHandshakeComplete();
<a class="jxr_linenumber" name="L150" href="#L150">150</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> Exception(<span class="jxr_string">"Proxy handshake failed - Code: 0x"</span> + ByteUtilities.asHex(<strong class="jxr_keyword">new</strong> byte[] { status }) + <span class="jxr_string">" ("</span>
<a class="jxr_linenumber" name="L152" href="#L152">152</a> + SocksProxyConstants.getReplyCodeAsString(status) + <span class="jxr_string">")"</span>);
<a class="jxr_linenumber" name="L153" href="#L153">153</a> }
<a class="jxr_linenumber" name="L154" href="#L154">154</a> }
<a class="jxr_linenumber" name="L155" href="#L155">155</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2004&#x2013;2018 <a href="http://mina.apache.org/">Apache MINA Project</a>. All rights reserved.</div>
</body>
</html>