blob: 63a9aa80cef841bbd33a055fa24a1514a6ebbefe [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 or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span>package org.apache.logging.log4j.core.net;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.io.IOException;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.OutputStream;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.io.Serializable;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.net.InetAddress;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.net.InetSocketAddress;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.net.Socket;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.List;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>import javax.net.ssl.SSLSocket;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import javax.net.ssl.SSLSocketFactory;<a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.Layout;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.net.ssl.SslConfiguration;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.logging.log4j.util.Strings;<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span>/**<a name="line.34"></a>
<span class="sourceLineNo">035</span> *<a name="line.35"></a>
<span class="sourceLineNo">036</span> */<a name="line.36"></a>
<span class="sourceLineNo">037</span>public class SslSocketManager extends TcpSocketManager {<a name="line.37"></a>
<span class="sourceLineNo">038</span> public static final int DEFAULT_PORT = 6514;<a name="line.38"></a>
<span class="sourceLineNo">039</span> private static final SslSocketManagerFactory FACTORY = new SslSocketManagerFactory();<a name="line.39"></a>
<span class="sourceLineNo">040</span> private final SslConfiguration sslConfig;<a name="line.40"></a>
<span class="sourceLineNo">041</span><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> *<a name="line.44"></a>
<span class="sourceLineNo">045</span> * @param name The unique name of this connection.<a name="line.45"></a>
<span class="sourceLineNo">046</span> * @param os The OutputStream.<a name="line.46"></a>
<span class="sourceLineNo">047</span> * @param sock The Socket.<a name="line.47"></a>
<span class="sourceLineNo">048</span> * @param inetAddress The Internet address of the host.<a name="line.48"></a>
<span class="sourceLineNo">049</span> * @param host The name of the host.<a name="line.49"></a>
<span class="sourceLineNo">050</span> * @param port The port number on the host.<a name="line.50"></a>
<span class="sourceLineNo">051</span> * @param connectTimeoutMillis the connect timeout in milliseconds.<a name="line.51"></a>
<span class="sourceLineNo">052</span> * @param reconnectionDelayMillis Reconnection interval.<a name="line.52"></a>
<span class="sourceLineNo">053</span> * @param immediateFail<a name="line.53"></a>
<span class="sourceLineNo">054</span> * @param layout The Layout.<a name="line.54"></a>
<span class="sourceLineNo">055</span> * @param bufferSize The buffer size.<a name="line.55"></a>
<span class="sourceLineNo">056</span> * @deprecated Use {@link #SslSocketManager(String, OutputStream, Socket, SslConfiguration, InetAddress, String, int, int, int, boolean, Layout, int, SocketOptions)}.<a name="line.56"></a>
<span class="sourceLineNo">057</span> */<a name="line.57"></a>
<span class="sourceLineNo">058</span> @Deprecated<a name="line.58"></a>
<span class="sourceLineNo">059</span> public SslSocketManager(final String name, final OutputStream os, final Socket sock,<a name="line.59"></a>
<span class="sourceLineNo">060</span> final SslConfiguration sslConfig, final InetAddress inetAddress, final String host, final int port,<a name="line.60"></a>
<span class="sourceLineNo">061</span> final int connectTimeoutMillis, final int reconnectionDelayMillis, final boolean immediateFail,<a name="line.61"></a>
<span class="sourceLineNo">062</span> final Layout&lt;? extends Serializable&gt; layout, final int bufferSize) {<a name="line.62"></a>
<span class="sourceLineNo">063</span> super(name, os, sock, inetAddress, host, port, connectTimeoutMillis, reconnectionDelayMillis, immediateFail, layout, bufferSize, null);<a name="line.63"></a>
<span class="sourceLineNo">064</span> this.sslConfig = sslConfig;<a name="line.64"></a>
<span class="sourceLineNo">065</span> }<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span> /**<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> * @param name The unique name of this connection.<a name="line.70"></a>
<span class="sourceLineNo">071</span> * @param os The OutputStream.<a name="line.71"></a>
<span class="sourceLineNo">072</span> * @param sock The Socket.<a name="line.72"></a>
<span class="sourceLineNo">073</span> * @param inetAddress The Internet address of the host.<a name="line.73"></a>
<span class="sourceLineNo">074</span> * @param host The name of the host.<a name="line.74"></a>
<span class="sourceLineNo">075</span> * @param port The port number on the host.<a name="line.75"></a>
<span class="sourceLineNo">076</span> * @param connectTimeoutMillis the connect timeout in milliseconds.<a name="line.76"></a>
<span class="sourceLineNo">077</span> * @param reconnectionDelayMillis Reconnection interval.<a name="line.77"></a>
<span class="sourceLineNo">078</span> * @param immediateFail<a name="line.78"></a>
<span class="sourceLineNo">079</span> * @param layout The Layout.<a name="line.79"></a>
<span class="sourceLineNo">080</span> * @param bufferSize The buffer size.<a name="line.80"></a>
<span class="sourceLineNo">081</span> */<a name="line.81"></a>
<span class="sourceLineNo">082</span> public SslSocketManager(final String name, final OutputStream os, final Socket sock,<a name="line.82"></a>
<span class="sourceLineNo">083</span> final SslConfiguration sslConfig, final InetAddress inetAddress, final String host, final int port,<a name="line.83"></a>
<span class="sourceLineNo">084</span> final int connectTimeoutMillis, final int reconnectionDelayMillis, final boolean immediateFail,<a name="line.84"></a>
<span class="sourceLineNo">085</span> final Layout&lt;? extends Serializable&gt; layout, final int bufferSize, final SocketOptions socketOptions) {<a name="line.85"></a>
<span class="sourceLineNo">086</span> super(name, os, sock, inetAddress, host, port, connectTimeoutMillis, reconnectionDelayMillis, immediateFail, layout, bufferSize, socketOptions);<a name="line.86"></a>
<span class="sourceLineNo">087</span> this.sslConfig = sslConfig;<a name="line.87"></a>
<span class="sourceLineNo">088</span> }<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span> private static class SslFactoryData extends FactoryData {<a name="line.90"></a>
<span class="sourceLineNo">091</span> protected SslConfiguration sslConfiguration;<a name="line.91"></a>
<span class="sourceLineNo">092</span><a name="line.92"></a>
<span class="sourceLineNo">093</span> public SslFactoryData(final SslConfiguration sslConfiguration, final String host, final int port,<a name="line.93"></a>
<span class="sourceLineNo">094</span> final int connectTimeoutMillis, final int reconnectDelayMillis, final boolean immediateFail,<a name="line.94"></a>
<span class="sourceLineNo">095</span> final Layout&lt;? extends Serializable&gt; layout, final int bufferSize, final SocketOptions socketOptions) {<a name="line.95"></a>
<span class="sourceLineNo">096</span> super(host, port, connectTimeoutMillis, reconnectDelayMillis, immediateFail, layout, bufferSize,<a name="line.96"></a>
<span class="sourceLineNo">097</span> socketOptions);<a name="line.97"></a>
<span class="sourceLineNo">098</span> this.sslConfiguration = sslConfiguration;<a name="line.98"></a>
<span class="sourceLineNo">099</span> }<a name="line.99"></a>
<span class="sourceLineNo">100</span><a name="line.100"></a>
<span class="sourceLineNo">101</span> @Override<a name="line.101"></a>
<span class="sourceLineNo">102</span> public String toString() {<a name="line.102"></a>
<span class="sourceLineNo">103</span> return "SslFactoryData [sslConfiguration=" + sslConfiguration + ", host=" + host + ", port=" + port<a name="line.103"></a>
<span class="sourceLineNo">104</span> + ", connectTimeoutMillis=" + connectTimeoutMillis + ", reconnectDelayMillis="<a name="line.104"></a>
<span class="sourceLineNo">105</span> + reconnectDelayMillis + ", immediateFail=" + immediateFail + ", layout=" + layout + ", bufferSize="<a name="line.105"></a>
<span class="sourceLineNo">106</span> + bufferSize + ", socketOptions=" + socketOptions + "]";<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><a name="line.109"></a>
<span class="sourceLineNo">110</span> /**<a name="line.110"></a>
<span class="sourceLineNo">111</span> * @deprecated Use {@link SslSocketManager#getSocketManager(SslConfiguration, String, int, int, int, boolean, Layout, int, SocketOptions)}.<a name="line.111"></a>
<span class="sourceLineNo">112</span> */<a name="line.112"></a>
<span class="sourceLineNo">113</span> @Deprecated<a name="line.113"></a>
<span class="sourceLineNo">114</span> public static SslSocketManager getSocketManager(final SslConfiguration sslConfig, final String host, final int port,<a name="line.114"></a>
<span class="sourceLineNo">115</span> final int connectTimeoutMillis, final int reconnectDelayMillis, final boolean immediateFail,<a name="line.115"></a>
<span class="sourceLineNo">116</span> final Layout&lt;? extends Serializable&gt; layout, final int bufferSize) {<a name="line.116"></a>
<span class="sourceLineNo">117</span> return getSocketManager(sslConfig, host, port, connectTimeoutMillis, reconnectDelayMillis, immediateFail, layout, bufferSize, null);<a name="line.117"></a>
<span class="sourceLineNo">118</span> }<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span> public static SslSocketManager getSocketManager(final SslConfiguration sslConfig, final String host, int port,<a name="line.120"></a>
<span class="sourceLineNo">121</span> final int connectTimeoutMillis, int reconnectDelayMillis, final boolean immediateFail,<a name="line.121"></a>
<span class="sourceLineNo">122</span> final Layout&lt;? extends Serializable&gt; layout, final int bufferSize, final SocketOptions socketOptions) {<a name="line.122"></a>
<span class="sourceLineNo">123</span> if (Strings.isEmpty(host)) {<a name="line.123"></a>
<span class="sourceLineNo">124</span> throw new IllegalArgumentException("A host name is required");<a name="line.124"></a>
<span class="sourceLineNo">125</span> }<a name="line.125"></a>
<span class="sourceLineNo">126</span> if (port &lt;= 0) {<a name="line.126"></a>
<span class="sourceLineNo">127</span> port = DEFAULT_PORT;<a name="line.127"></a>
<span class="sourceLineNo">128</span> }<a name="line.128"></a>
<span class="sourceLineNo">129</span> if (reconnectDelayMillis == 0) {<a name="line.129"></a>
<span class="sourceLineNo">130</span> reconnectDelayMillis = DEFAULT_RECONNECTION_DELAY_MILLIS;<a name="line.130"></a>
<span class="sourceLineNo">131</span> }<a name="line.131"></a>
<span class="sourceLineNo">132</span> final String name = "TLS:" + host + ':' + port;<a name="line.132"></a>
<span class="sourceLineNo">133</span> return (SslSocketManager) getManager(name, new SslFactoryData(sslConfig, host, port, connectTimeoutMillis,<a name="line.133"></a>
<span class="sourceLineNo">134</span> reconnectDelayMillis, immediateFail, layout, bufferSize, socketOptions), FACTORY);<a name="line.134"></a>
<span class="sourceLineNo">135</span> }<a name="line.135"></a>
<span class="sourceLineNo">136</span><a name="line.136"></a>
<span class="sourceLineNo">137</span> @Override<a name="line.137"></a>
<span class="sourceLineNo">138</span> protected Socket createSocket(final InetSocketAddress socketAddress) throws IOException {<a name="line.138"></a>
<span class="sourceLineNo">139</span> final SSLSocketFactory socketFactory = createSslSocketFactory(sslConfig);<a name="line.139"></a>
<span class="sourceLineNo">140</span> final Socket newSocket = socketFactory.createSocket();<a name="line.140"></a>
<span class="sourceLineNo">141</span> newSocket.connect(socketAddress, getConnectTimeoutMillis());<a name="line.141"></a>
<span class="sourceLineNo">142</span> return newSocket;<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> private static SSLSocketFactory createSslSocketFactory(final SslConfiguration sslConf) {<a name="line.145"></a>
<span class="sourceLineNo">146</span> SSLSocketFactory socketFactory;<a name="line.146"></a>
<span class="sourceLineNo">147</span><a name="line.147"></a>
<span class="sourceLineNo">148</span> if (sslConf != null) {<a name="line.148"></a>
<span class="sourceLineNo">149</span> socketFactory = sslConf.getSslSocketFactory();<a name="line.149"></a>
<span class="sourceLineNo">150</span> } else {<a name="line.150"></a>
<span class="sourceLineNo">151</span> socketFactory = (SSLSocketFactory) SSLSocketFactory.getDefault();<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> return socketFactory;<a name="line.154"></a>
<span class="sourceLineNo">155</span> }<a name="line.155"></a>
<span class="sourceLineNo">156</span><a name="line.156"></a>
<span class="sourceLineNo">157</span><a name="line.157"></a>
<span class="sourceLineNo">158</span> private static class SslSocketManagerFactory extends TcpSocketManagerFactory&lt;SslSocketManager, SslFactoryData&gt; {<a name="line.158"></a>
<span class="sourceLineNo">159</span><a name="line.159"></a>
<span class="sourceLineNo">160</span> @Override<a name="line.160"></a>
<span class="sourceLineNo">161</span> SslSocketManager createManager(final String name, final OutputStream os, final Socket socket, final InetAddress inetAddress,<a name="line.161"></a>
<span class="sourceLineNo">162</span> final SslFactoryData data) {<a name="line.162"></a>
<span class="sourceLineNo">163</span> return new SslSocketManager(name, os, socket, data.sslConfiguration, inetAddress, data.host, data.port,<a name="line.163"></a>
<span class="sourceLineNo">164</span> data.connectTimeoutMillis, data.reconnectDelayMillis, data.immediateFail, data.layout, data.bufferSize,<a name="line.164"></a>
<span class="sourceLineNo">165</span> data.socketOptions);<a name="line.165"></a>
<span class="sourceLineNo">166</span> }<a name="line.166"></a>
<span class="sourceLineNo">167</span><a name="line.167"></a>
<span class="sourceLineNo">168</span> @Override<a name="line.168"></a>
<span class="sourceLineNo">169</span> Socket createSocket(final SslFactoryData data) throws IOException {<a name="line.169"></a>
<span class="sourceLineNo">170</span> List&lt;InetSocketAddress&gt; socketAddresses = resolver.resolveHost(data.host, data.port);<a name="line.170"></a>
<span class="sourceLineNo">171</span> IOException ioe = null;<a name="line.171"></a>
<span class="sourceLineNo">172</span> for (InetSocketAddress socketAddress : socketAddresses) {<a name="line.172"></a>
<span class="sourceLineNo">173</span> try {<a name="line.173"></a>
<span class="sourceLineNo">174</span> return SslSocketManager.createSocket(socketAddress, data.connectTimeoutMillis,<a name="line.174"></a>
<span class="sourceLineNo">175</span> data.sslConfiguration, data.socketOptions);<a name="line.175"></a>
<span class="sourceLineNo">176</span> } catch (IOException ex) {<a name="line.176"></a>
<span class="sourceLineNo">177</span> ioe = ex;<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> throw new IOException(errorMessage(data, socketAddresses) , ioe);<a name="line.180"></a>
<span class="sourceLineNo">181</span> }<a name="line.181"></a>
<span class="sourceLineNo">182</span> }<a name="line.182"></a>
<span class="sourceLineNo">183</span><a name="line.183"></a>
<span class="sourceLineNo">184</span> static Socket createSocket(final InetSocketAddress socketAddress, final int connectTimeoutMillis,<a name="line.184"></a>
<span class="sourceLineNo">185</span> final SslConfiguration sslConfiguration, final SocketOptions socketOptions) throws IOException {<a name="line.185"></a>
<span class="sourceLineNo">186</span> final SSLSocketFactory socketFactory = createSslSocketFactory(sslConfiguration);<a name="line.186"></a>
<span class="sourceLineNo">187</span> final SSLSocket socket = (SSLSocket) socketFactory.createSocket();<a name="line.187"></a>
<span class="sourceLineNo">188</span> if (socketOptions != null) {<a name="line.188"></a>
<span class="sourceLineNo">189</span> // Not sure which options must be applied before or after the connect() call.<a name="line.189"></a>
<span class="sourceLineNo">190</span> socketOptions.apply(socket);<a name="line.190"></a>
<span class="sourceLineNo">191</span> }<a name="line.191"></a>
<span class="sourceLineNo">192</span> socket.connect(socketAddress, connectTimeoutMillis);<a name="line.192"></a>
<span class="sourceLineNo">193</span> if (socketOptions != null) {<a name="line.193"></a>
<span class="sourceLineNo">194</span> // Not sure which options must be applied before or after the connect() call.<a name="line.194"></a>
<span class="sourceLineNo">195</span> socketOptions.apply(socket);<a name="line.195"></a>
<span class="sourceLineNo">196</span> }<a name="line.196"></a>
<span class="sourceLineNo">197</span> return socket;<a name="line.197"></a>
<span class="sourceLineNo">198</span> }<a name="line.198"></a>
<span class="sourceLineNo">199</span>}<a name="line.199"></a>
</pre>
</div>
</body>
</html>