| <!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.ssl;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.security.KeyStoreException;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.security.NoSuchAlgorithmException;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.security.UnrecoverableKeyException;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.Arrays;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span><a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import javax.net.ssl.KeyManagerFactory;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span><a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.Core;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.config.plugins.PluginAttribute;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.config.plugins.PluginFactory;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span><a name="line.30"></a> |
| <span class="sourceLineNo">031</span>/**<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * Configuration of the KeyStore<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> */<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>@Plugin(name = "KeyStore", category = Core.CATEGORY_NAME, printObject = true)<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>public class KeyStoreConfiguration extends AbstractKeyStoreConfiguration {<a name="line.35"></a> |
| <span class="sourceLineNo">036</span><a name="line.36"></a> |
| <span class="sourceLineNo">037</span> private final String keyManagerFactoryAlgorithm;<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> *<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * @throws StoreConfigurationException Thrown if this instance cannot load the KeyStore.<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> */<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> public KeyStoreConfiguration(final String location,<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> final PasswordProvider passwordProvider,<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> final String keyStoreType,<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> final String keyManagerFactoryAlgorithm) throws StoreConfigurationException {<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> super(location, passwordProvider, keyStoreType);<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> this.keyManagerFactoryAlgorithm = keyManagerFactoryAlgorithm == null ? KeyManagerFactory.getDefaultAlgorithm()<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> : keyManagerFactoryAlgorithm;<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> /**<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> *<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * @throws StoreConfigurationException Thrown if this instance cannot load the KeyStore.<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * @deprecated use {@link #KeyStoreConfiguration(String, PasswordProvider, String, String)} instead<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> */<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> @Deprecated<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> public KeyStoreConfiguration(final String location,<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> final char[] password,<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> final String keyStoreType,<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> final String keyManagerFactoryAlgorithm) throws StoreConfigurationException {<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> this(location, new MemoryPasswordProvider(password), keyStoreType, keyManagerFactoryAlgorithm);<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> if (password != null) {<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> Arrays.fill(password, '\0');<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> * @throws StoreConfigurationException Thrown if this instance cannot load the KeyStore.<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * @deprecated Use {@link #KeyStoreConfiguration(String, PasswordProvider, String, String)} instead<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> */<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> @Deprecated<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> public KeyStoreConfiguration(final String location, final String password, final String keyStoreType,<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> final String keyManagerFactoryAlgorithm) throws StoreConfigurationException {<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> this(location, new MemoryPasswordProvider(password == null ? null : password.toCharArray()), keyStoreType,<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> keyManagerFactoryAlgorithm);<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> /**<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * Creates a KeyStoreConfiguration.<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> *<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * @param location<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * The location of the KeyStore, a file path, URL or resource.<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * @param password<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * The password to access the KeyStore.<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * @param keyStoreType<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * The KeyStore type, null defaults to {@code "JKS"}.<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * @param keyManagerFactoryAlgorithm<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * The standard name of the requested algorithm. See the Java Secure Socket Extension Reference Guide for information about these names.<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * @return a new KeyStoreConfiguration<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * @throws StoreConfigurationException Thrown if this call cannot load the KeyStore.<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> */<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> @PluginFactory<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> public static KeyStoreConfiguration createKeyStoreConfiguration(<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> // @formatter:off<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> @PluginAttribute("location") final String location,<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> @PluginAttribute(value = "password", sensitive = true) final char[] password,<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> @PluginAttribute("passwordEnvironmentVariable") final String passwordEnvironmentVariable,<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> @PluginAttribute("passwordFile") final String passwordFile,<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> @PluginAttribute("type") final String keyStoreType,<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> @PluginAttribute("keyManagerFactoryAlgorithm") final String keyManagerFactoryAlgorithm) throws StoreConfigurationException {<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> // @formatter:on<a name="line.103"></a> |
| <span class="sourceLineNo">104</span><a name="line.104"></a> |
| <span class="sourceLineNo">105</span> if (password != null && passwordEnvironmentVariable != null && passwordFile != null) {<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> throw new StoreConfigurationException("You MUST set only one of 'password', 'passwordEnvironmentVariable' or 'passwordFile'.");<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> }<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> try {<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> // @formatter:off<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> final PasswordProvider provider = passwordFile != null<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> ? new FilePasswordProvider(passwordFile)<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> : passwordEnvironmentVariable != null<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> ? new EnvironmentPasswordProvider(passwordEnvironmentVariable)<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> // the default is memory char[] array, which may be null<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> : new MemoryPasswordProvider(password);<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> // @formatter:on<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> if (password != null) {<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> Arrays.fill(password, '\0');<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> }<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> return new KeyStoreConfiguration(location, provider, keyStoreType, keyManagerFactoryAlgorithm);<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> } catch (final Exception ex) {<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> throw new StoreConfigurationException("Could not configure KeyStore", ex);<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> }<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> }<a name="line.124"></a> |
| <span class="sourceLineNo">125</span><a name="line.125"></a> |
| <span class="sourceLineNo">126</span> /**<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> * @deprecated use {@link #createKeyStoreConfiguration(String, char[], String, String, String, String)}<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> */<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> @Deprecated<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> public static KeyStoreConfiguration createKeyStoreConfiguration(<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> // @formatter:off<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> final String location,<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> final char[] password,<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> final String keyStoreType,<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> final String keyManagerFactoryAlgorithm) throws StoreConfigurationException {<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> // @formatter:on<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> return createKeyStoreConfiguration(location, password, null, null, keyStoreType, keyManagerFactoryAlgorithm);<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> * Creates a KeyStoreConfiguration.<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> *<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> * @param location The location of the KeyStore, a file path, URL or resource.<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> * @param password The password to access the KeyStore.<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * @param keyStoreType The KeyStore type, null defaults to {@code "JKS"}.<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> * @param keyManagerFactoryAlgorithm The standard name of the requested algorithm. See the Java Secure Socket<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * Extension Reference Guide for information about these names.<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> * @return a new KeyStoreConfiguration<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> * @throws StoreConfigurationException Thrown if this call cannot load the KeyStore.<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> * @deprecated Use createKeyStoreConfiguration(String, char[], String, String)<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> */<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> @Deprecated<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> public static KeyStoreConfiguration createKeyStoreConfiguration(<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> // @formatter:off<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> final String location,<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> final String password,<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> final String keyStoreType,<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> final String keyManagerFactoryAlgorithm) throws StoreConfigurationException {<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> // @formatter:on<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> return createKeyStoreConfiguration(location,<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> (password == null ? null : password.toCharArray()),<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> keyStoreType,<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> keyManagerFactoryAlgorithm);<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> }<a name="line.164"></a> |
| <span class="sourceLineNo">165</span><a name="line.165"></a> |
| <span class="sourceLineNo">166</span> public KeyManagerFactory initKeyManagerFactory() throws NoSuchAlgorithmException, UnrecoverableKeyException,<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> KeyStoreException {<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> final KeyManagerFactory kmFactory = KeyManagerFactory.getInstance(this.keyManagerFactoryAlgorithm);<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> final char[] password = this.getPasswordAsCharArray();<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> try {<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> kmFactory.init(this.getKeyStore(), password);<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> } finally {<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> if (password != null) {<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> Arrays.fill(password, '\0');<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> }<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> }<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> return kmFactory;<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> @Override<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> public int hashCode() {<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> final int prime = 31;<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> int result = super.hashCode();<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> result = prime * result + ((keyManagerFactoryAlgorithm == null) ? 0 : keyManagerFactoryAlgorithm.hashCode());<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> return result;<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> @Override<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> public boolean equals(final Object obj) {<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> if (this == obj) {<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> return true;<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> }<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> if (!super.equals(obj)) {<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> return false;<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> }<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> if (getClass() != obj.getClass()) {<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> return false;<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> }<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> final KeyStoreConfiguration other = (KeyStoreConfiguration) obj;<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> if (keyManagerFactoryAlgorithm == null) {<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> if (other.keyManagerFactoryAlgorithm != null) {<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> return false;<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> }<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> } else if (!keyManagerFactoryAlgorithm.equals(other.keyManagerFactoryAlgorithm)) {<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> return false;<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> }<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> return true;<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> public String getKeyManagerFactoryAlgorithm() {<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> return keyManagerFactoryAlgorithm;<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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
