blob: 88813f122a0df6e2328034f31c1f536e9a77b592 [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.example.proxy;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.net.InetSocketAddress;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.net.URL;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.ArrayList;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.HashMap;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.List;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.mina.core.RuntimeIoException;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.mina.core.future.ConnectFuture;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.mina.core.session.IdleStatus;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.mina.core.session.IoSession;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.mina.filter.logging.LoggingFilter;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.mina.proxy.ProxyConnector;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.mina.proxy.handlers.ProxyRequest;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.mina.proxy.handlers.http.HttpAuthenticationMethods;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.mina.proxy.handlers.http.HttpProxyConstants;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.mina.proxy.handlers.http.HttpProxyRequest;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.mina.proxy.handlers.socks.SocksProxyConstants;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.mina.proxy.handlers.socks.SocksProxyRequest;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.apache.mina.proxy.session.ProxyIoSession;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.apache.mina.transport.socket.nio.NioSocketConnector;<a name="line.41"></a>
<span class="sourceLineNo">042</span><a name="line.42"></a>
<span class="sourceLineNo">043</span>/**<a name="line.43"></a>
<span class="sourceLineNo">044</span> * ProxyTestClient.java - Base test class for mina proxy<a name="line.44"></a>
<span class="sourceLineNo">045</span> * <a name="line.45"></a>
<span class="sourceLineNo">046</span> * @author &lt;a href="http://mina.apache.org"&gt;Apache MINA Project&lt;/a&gt;<a name="line.46"></a>
<span class="sourceLineNo">047</span> * @since MINA 2.0.0-M3<a name="line.47"></a>
<span class="sourceLineNo">048</span> */<a name="line.48"></a>
<span class="sourceLineNo">049</span>public class ProxyTestClient {<a name="line.49"></a>
<span class="sourceLineNo">050</span> <a name="line.50"></a>
<span class="sourceLineNo">051</span> /**<a name="line.51"></a>
<span class="sourceLineNo">052</span> * The global variables used when creating the HTTP proxy connection.<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> /**<a name="line.55"></a>
<span class="sourceLineNo">056</span> * The user login.<a name="line.56"></a>
<span class="sourceLineNo">057</span> */<a name="line.57"></a>
<span class="sourceLineNo">058</span> public final static String USER = "TED_KODS";<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span> /**<a name="line.60"></a>
<span class="sourceLineNo">061</span> * The user password.<a name="line.61"></a>
<span class="sourceLineNo">062</span> */<a name="line.62"></a>
<span class="sourceLineNo">063</span> public final static String PWD = "EDOUARD";<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> /**<a name="line.65"></a>
<span class="sourceLineNo">066</span> * The domain name. (used in NTLM connections)<a name="line.66"></a>
<span class="sourceLineNo">067</span> */<a name="line.67"></a>
<span class="sourceLineNo">068</span> public final static String DOMAIN = "MYDOMAIN";<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span> /**<a name="line.70"></a>
<span class="sourceLineNo">071</span> * The workstation name. (used in NTLM connections)<a name="line.71"></a>
<span class="sourceLineNo">072</span> */ <a name="line.72"></a>
<span class="sourceLineNo">073</span> public final static String WORKSTATION = "MYWORKSTATION";<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span> /**<a name="line.75"></a>
<span class="sourceLineNo">076</span> * Set this variable to true in order to generate HTTP/1.1 requests.<a name="line.76"></a>
<span class="sourceLineNo">077</span> */<a name="line.77"></a>
<span class="sourceLineNo">078</span> private final static boolean USE_HTTP_1_1 = false;<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span> /**<a name="line.80"></a>
<span class="sourceLineNo">081</span> * Creates a connection to the endpoint through a proxy server using the specified<a name="line.81"></a>
<span class="sourceLineNo">082</span> * authentication method.<a name="line.82"></a>
<span class="sourceLineNo">083</span> * <a name="line.83"></a>
<span class="sourceLineNo">084</span> * Command line arguments: <a name="line.84"></a>
<span class="sourceLineNo">085</span> * ProxyTestClient &lt;proxy-hostname&gt; &lt;proxy-port&gt; &lt;url&gt; &lt;proxy-method&gt; <a name="line.85"></a>
<span class="sourceLineNo">086</span> * <a name="line.86"></a>
<span class="sourceLineNo">087</span> * Note that &lt;proxy-method&gt; is OPTIONNAL a HTTP proxy connection will be used if not <a name="line.87"></a>
<span class="sourceLineNo">088</span> * specified.<a name="line.88"></a>
<span class="sourceLineNo">089</span> * <a name="line.89"></a>
<span class="sourceLineNo">090</span> * Examples:<a name="line.90"></a>
<span class="sourceLineNo">091</span> * ProxyTestClient myproxy 8080 http://mina.apache.org SOCKS4<a name="line.91"></a>
<span class="sourceLineNo">092</span> * ProxyTestClient squidsrv 3128 http://mina.apache.org:80<a name="line.92"></a>
<span class="sourceLineNo">093</span> * <a name="line.93"></a>
<span class="sourceLineNo">094</span> * @param args parse arguments to get proxy hostaname, proxy port, the url to connect to <a name="line.94"></a>
<span class="sourceLineNo">095</span> * and optionnaly the proxy authentication method <a name="line.95"></a>
<span class="sourceLineNo">096</span> * @throws Exception<a name="line.96"></a>
<span class="sourceLineNo">097</span> */<a name="line.97"></a>
<span class="sourceLineNo">098</span> public ProxyTestClient(String[] args) throws Exception {<a name="line.98"></a>
<span class="sourceLineNo">099</span> if (args.length &lt; 3) {<a name="line.99"></a>
<span class="sourceLineNo">100</span> System.out<a name="line.100"></a>
<span class="sourceLineNo">101</span> .println(ProxyTestClient.class.getName()<a name="line.101"></a>
<span class="sourceLineNo">102</span> + " &lt;proxy-hostname&gt; &lt;proxy-port&gt; &lt;url&gt; &lt;proxy-method&gt; (&lt;proxy-method&gt; is OPTIONNAL)");<a name="line.102"></a>
<span class="sourceLineNo">103</span> return;<a name="line.103"></a>
<span class="sourceLineNo">104</span> }<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span> // Create proxy connector.<a name="line.106"></a>
<span class="sourceLineNo">107</span> NioSocketConnector socketConnector = new NioSocketConnector(Runtime<a name="line.107"></a>
<span class="sourceLineNo">108</span> .getRuntime().availableProcessors() + 1);<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span> ProxyConnector connector = new ProxyConnector(socketConnector);<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span> // Set connect timeout.<a name="line.112"></a>
<span class="sourceLineNo">113</span> connector.setConnectTimeoutMillis(5000);<a name="line.113"></a>
<span class="sourceLineNo">114</span><a name="line.114"></a>
<span class="sourceLineNo">115</span> URL url = new URL(args[2]);<a name="line.115"></a>
<span class="sourceLineNo">116</span> int port = url.getPort() == -1 ? url.getDefaultPort() : url.getPort();<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span> ProxyRequest req = null;<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span> if (args.length == 4) {<a name="line.120"></a>
<span class="sourceLineNo">121</span> if ("SOCKS4".equals(args[3])) {<a name="line.121"></a>
<span class="sourceLineNo">122</span> req = new SocksProxyRequest(<a name="line.122"></a>
<span class="sourceLineNo">123</span> SocksProxyConstants.SOCKS_VERSION_4,<a name="line.123"></a>
<span class="sourceLineNo">124</span> SocksProxyConstants.ESTABLISH_TCPIP_STREAM,<a name="line.124"></a>
<span class="sourceLineNo">125</span> new InetSocketAddress(url.getHost(), port), USER);<a name="line.125"></a>
<span class="sourceLineNo">126</span> } else if ("SOCKS4a".equals(args[3])) {<a name="line.126"></a>
<span class="sourceLineNo">127</span> req = new SocksProxyRequest(<a name="line.127"></a>
<span class="sourceLineNo">128</span> SocksProxyConstants.ESTABLISH_TCPIP_STREAM, url<a name="line.128"></a>
<span class="sourceLineNo">129</span> .getHost(), port, USER);<a name="line.129"></a>
<span class="sourceLineNo">130</span> } else if ("SOCKS5".equals(args[3])) {<a name="line.130"></a>
<span class="sourceLineNo">131</span> req = new SocksProxyRequest(<a name="line.131"></a>
<span class="sourceLineNo">132</span> SocksProxyConstants.SOCKS_VERSION_5,<a name="line.132"></a>
<span class="sourceLineNo">133</span> SocksProxyConstants.ESTABLISH_TCPIP_STREAM,<a name="line.133"></a>
<span class="sourceLineNo">134</span> new InetSocketAddress(url.getHost(), port), USER);<a name="line.134"></a>
<span class="sourceLineNo">135</span> ((SocksProxyRequest) req).setPassword(PWD);<a name="line.135"></a>
<span class="sourceLineNo">136</span> ((SocksProxyRequest) req)<a name="line.136"></a>
<span class="sourceLineNo">137</span> .setServiceKerberosName(Socks5GSSAPITestServer.SERVICE_NAME);<a name="line.137"></a>
<span class="sourceLineNo">138</span> } else {<a name="line.138"></a>
<span class="sourceLineNo">139</span> req = createHttpProxyRequest(args[2]);<a name="line.139"></a>
<span class="sourceLineNo">140</span> }<a name="line.140"></a>
<span class="sourceLineNo">141</span> } else {<a name="line.141"></a>
<span class="sourceLineNo">142</span> req = createHttpProxyRequest(args[2]);<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> ProxyIoSession proxyIoSession = new ProxyIoSession(<a name="line.145"></a>
<span class="sourceLineNo">146</span> new InetSocketAddress(args[0], Integer.parseInt(args[1])), req);<a name="line.146"></a>
<span class="sourceLineNo">147</span><a name="line.147"></a>
<span class="sourceLineNo">148</span> // Tests modifying authentication order preferences. First algorithm in list available on server <a name="line.148"></a>
<span class="sourceLineNo">149</span> // will be used for authentication.<a name="line.149"></a>
<span class="sourceLineNo">150</span> List&lt;HttpAuthenticationMethods&gt; l = new ArrayList&lt;HttpAuthenticationMethods&gt;();<a name="line.150"></a>
<span class="sourceLineNo">151</span> l.add(HttpAuthenticationMethods.DIGEST);<a name="line.151"></a>
<span class="sourceLineNo">152</span> l.add(HttpAuthenticationMethods.BASIC);<a name="line.152"></a>
<span class="sourceLineNo">153</span> proxyIoSession.setPreferedOrder(l);<a name="line.153"></a>
<span class="sourceLineNo">154</span><a name="line.154"></a>
<span class="sourceLineNo">155</span> connector.setProxyIoSession(proxyIoSession);<a name="line.155"></a>
<span class="sourceLineNo">156</span><a name="line.156"></a>
<span class="sourceLineNo">157</span> socketConnector.getSessionConfig().setIdleTime(IdleStatus.BOTH_IDLE, 5);<a name="line.157"></a>
<span class="sourceLineNo">158</span><a name="line.158"></a>
<span class="sourceLineNo">159</span> connector.getFilterChain().addLast("logger", new LoggingFilter());<a name="line.159"></a>
<span class="sourceLineNo">160</span><a name="line.160"></a>
<span class="sourceLineNo">161</span> // This command is sent when using a socks proxy to request a page from the web server.<a name="line.161"></a>
<span class="sourceLineNo">162</span> String cmd = "GET " + url.toExternalForm() + " HTTP/1.0"<a name="line.162"></a>
<span class="sourceLineNo">163</span> + HttpProxyConstants.CRLF + HttpProxyConstants.CRLF;<a name="line.163"></a>
<span class="sourceLineNo">164</span><a name="line.164"></a>
<span class="sourceLineNo">165</span> connector.setHandler(new ClientSessionHandler(cmd));<a name="line.165"></a>
<span class="sourceLineNo">166</span><a name="line.166"></a>
<span class="sourceLineNo">167</span> IoSession session;<a name="line.167"></a>
<span class="sourceLineNo">168</span> for (;;) {<a name="line.168"></a>
<span class="sourceLineNo">169</span> try {<a name="line.169"></a>
<span class="sourceLineNo">170</span> ConnectFuture future = connector.connect();<a name="line.170"></a>
<span class="sourceLineNo">171</span> future.awaitUninterruptibly();<a name="line.171"></a>
<span class="sourceLineNo">172</span> session = future.getSession();<a name="line.172"></a>
<span class="sourceLineNo">173</span> break;<a name="line.173"></a>
<span class="sourceLineNo">174</span> } catch (RuntimeIoException e) {<a name="line.174"></a>
<span class="sourceLineNo">175</span> System.err.println("Failed to connect. Retrying in 5 secs ...");<a name="line.175"></a>
<span class="sourceLineNo">176</span> Thread.sleep(5000);<a name="line.176"></a>
<span class="sourceLineNo">177</span> }<a name="line.177"></a>
<span class="sourceLineNo">178</span> }<a name="line.178"></a>
<span class="sourceLineNo">179</span><a name="line.179"></a>
<span class="sourceLineNo">180</span> // Wait until done<a name="line.180"></a>
<span class="sourceLineNo">181</span> if (session != null) {<a name="line.181"></a>
<span class="sourceLineNo">182</span> session.getCloseFuture().awaitUninterruptibly();<a name="line.182"></a>
<span class="sourceLineNo">183</span> }<a name="line.183"></a>
<span class="sourceLineNo">184</span> connector.dispose();<a name="line.184"></a>
<span class="sourceLineNo">185</span> System.exit(0);<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> /**<a name="line.188"></a>
<span class="sourceLineNo">189</span> * Creates a {@link HttpProxyRequest} from the provided &lt;i&gt;uri&lt;/i&gt; parameter.<a name="line.189"></a>
<span class="sourceLineNo">190</span> * It uses the global variables defined at the top of the class to fill the <a name="line.190"></a>
<span class="sourceLineNo">191</span> * connection properties of the request. If the global variable &lt;i&gt;useHttp1_1&lt;/i&gt; <a name="line.191"></a>
<span class="sourceLineNo">192</span> * is set to true, it will create a HTTP/1.1 request.<a name="line.192"></a>
<span class="sourceLineNo">193</span> * <a name="line.193"></a>
<span class="sourceLineNo">194</span> * @param uri the requested uri to connect to through the HTTP proxy<a name="line.194"></a>
<span class="sourceLineNo">195</span> * @return the fully initialized {@link HttpProxyRequest} object<a name="line.195"></a>
<span class="sourceLineNo">196</span> */<a name="line.196"></a>
<span class="sourceLineNo">197</span> private HttpProxyRequest createHttpProxyRequest(String uri) {<a name="line.197"></a>
<span class="sourceLineNo">198</span> HttpProxyRequest req = new HttpProxyRequest(uri);<a name="line.198"></a>
<span class="sourceLineNo">199</span> HashMap&lt;String, String&gt; props = new HashMap&lt;String, String&gt;();<a name="line.199"></a>
<span class="sourceLineNo">200</span> props.put(HttpProxyConstants.USER_PROPERTY, USER);<a name="line.200"></a>
<span class="sourceLineNo">201</span> props.put(HttpProxyConstants.PWD_PROPERTY, PWD);<a name="line.201"></a>
<span class="sourceLineNo">202</span> props.put(HttpProxyConstants.DOMAIN_PROPERTY, DOMAIN);<a name="line.202"></a>
<span class="sourceLineNo">203</span> props.put(HttpProxyConstants.WORKSTATION_PROPERTY, WORKSTATION);<a name="line.203"></a>
<span class="sourceLineNo">204</span><a name="line.204"></a>
<span class="sourceLineNo">205</span> req.setProperties(props);<a name="line.205"></a>
<span class="sourceLineNo">206</span> if (USE_HTTP_1_1) {<a name="line.206"></a>
<span class="sourceLineNo">207</span> req.setHttpVersion(HttpProxyConstants.HTTP_1_1);<a name="line.207"></a>
<span class="sourceLineNo">208</span> }<a name="line.208"></a>
<span class="sourceLineNo">209</span><a name="line.209"></a>
<span class="sourceLineNo">210</span> return req;<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> /**<a name="line.213"></a>
<span class="sourceLineNo">214</span> * {@inheritDoc}<a name="line.214"></a>
<span class="sourceLineNo">215</span> */<a name="line.215"></a>
<span class="sourceLineNo">216</span> public static void main(String[] args) throws Exception {<a name="line.216"></a>
<span class="sourceLineNo">217</span> new ProxyTestClient(args);<a name="line.217"></a>
<span class="sourceLineNo">218</span> }<a name="line.218"></a>
<span class="sourceLineNo">219</span>}<a name="line.219"></a>
</pre>
</div>
</body>
</html>