blob: a136cebd570c4e8cdc50cfa915f31449d8233127 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<main role="main">
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a id="line.1">package org.apache.fulcrum.crypto;</a>
<span class="sourceLineNo">002</span><a id="line.2"></a>
<span class="sourceLineNo">003</span><a id="line.3">/*</a>
<span class="sourceLineNo">004</span><a id="line.4"> * Licensed to the Apache Software Foundation (ASF) under one</a>
<span class="sourceLineNo">005</span><a id="line.5"> * or more contributor license agreements. See the NOTICE file</a>
<span class="sourceLineNo">006</span><a id="line.6"> * distributed with this work for additional information</a>
<span class="sourceLineNo">007</span><a id="line.7"> * regarding copyright ownership. The ASF licenses this file</a>
<span class="sourceLineNo">008</span><a id="line.8"> * to you under the Apache License, Version 2.0 (the</a>
<span class="sourceLineNo">009</span><a id="line.9"> * "License"); you may not use this file except in compliance</a>
<span class="sourceLineNo">010</span><a id="line.10"> * with the License. You may obtain a copy of the License at</a>
<span class="sourceLineNo">011</span><a id="line.11"> *</a>
<span class="sourceLineNo">012</span><a id="line.12"> * http://www.apache.org/licenses/LICENSE-2.0</a>
<span class="sourceLineNo">013</span><a id="line.13"> *</a>
<span class="sourceLineNo">014</span><a id="line.14"> * Unless required by applicable law or agreed to in writing,</a>
<span class="sourceLineNo">015</span><a id="line.15"> * software distributed under the License is distributed on an</a>
<span class="sourceLineNo">016</span><a id="line.16"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a>
<span class="sourceLineNo">017</span><a id="line.17"> * KIND, either express or implied. See the License for the</a>
<span class="sourceLineNo">018</span><a id="line.18"> * specific language governing permissions and limitations</a>
<span class="sourceLineNo">019</span><a id="line.19"> * under the License.</a>
<span class="sourceLineNo">020</span><a id="line.20"> */</a>
<span class="sourceLineNo">021</span><a id="line.21"></a>
<span class="sourceLineNo">022</span><a id="line.22">import java.security.NoSuchAlgorithmException;</a>
<span class="sourceLineNo">023</span><a id="line.23">import java.util.HashMap;</a>
<span class="sourceLineNo">024</span><a id="line.24"></a>
<span class="sourceLineNo">025</span><a id="line.25">import org.apache.avalon.framework.activity.Initializable;</a>
<span class="sourceLineNo">026</span><a id="line.26">import org.apache.avalon.framework.configuration.Configurable;</a>
<span class="sourceLineNo">027</span><a id="line.27">import org.apache.avalon.framework.configuration.Configuration;</a>
<span class="sourceLineNo">028</span><a id="line.28">import org.apache.avalon.framework.configuration.ConfigurationException;</a>
<span class="sourceLineNo">029</span><a id="line.29">import org.apache.avalon.framework.logger.AbstractLogEnabled;</a>
<span class="sourceLineNo">030</span><a id="line.30">import org.apache.avalon.framework.thread.ThreadSafe;</a>
<span class="sourceLineNo">031</span><a id="line.31"></a>
<span class="sourceLineNo">032</span><a id="line.32">/**</a>
<span class="sourceLineNo">033</span><a id="line.33"> * An implementation of CryptoService that uses either supplied crypto</a>
<span class="sourceLineNo">034</span><a id="line.34"> * Algorithms (provided in the component config xml file) or tries to get them</a>
<span class="sourceLineNo">035</span><a id="line.35"> * via the normal java mechanisms if this fails.</a>
<span class="sourceLineNo">036</span><a id="line.36"> *</a>
<span class="sourceLineNo">037</span><a id="line.37"> * avalon.component name="crypto" lifestyle="singleton" avalon.service</a>
<span class="sourceLineNo">038</span><a id="line.38"> * type="org.apache.fulcrum.crypto.CryptoService"</a>
<span class="sourceLineNo">039</span><a id="line.39"> *</a>
<span class="sourceLineNo">040</span><a id="line.40"> *</a>
<span class="sourceLineNo">041</span><a id="line.41"> * @author &lt;a href="mailto:epugh@upstate.com"&gt;Eric Pugh&lt;/a&gt;</a>
<span class="sourceLineNo">042</span><a id="line.42"> * @author &lt;a href="mailto:hps@intermeta.de"&gt;Henning P. Schmiedehausen&lt;/a&gt;</a>
<span class="sourceLineNo">043</span><a id="line.43"> * @version $Id$</a>
<span class="sourceLineNo">044</span><a id="line.44"> */</a>
<span class="sourceLineNo">045</span><a id="line.45">public class DefaultCryptoService extends AbstractLogEnabled</a>
<span class="sourceLineNo">046</span><a id="line.46"> implements CryptoService, Configurable, Initializable, ThreadSafe {</a>
<span class="sourceLineNo">047</span><a id="line.47"></a>
<span class="sourceLineNo">048</span><a id="line.48"> </a>
<span class="sourceLineNo">049</span><a id="line.49"> /** Key Prefix for our algorithms */</a>
<span class="sourceLineNo">050</span><a id="line.50"> private static final String ALGORITHM = "algorithm";</a>
<span class="sourceLineNo">051</span><a id="line.51"></a>
<span class="sourceLineNo">052</span><a id="line.52"> /** Default Key */</a>
<span class="sourceLineNo">053</span><a id="line.53"> private static final String DEFAULT_KEY = "default";</a>
<span class="sourceLineNo">054</span><a id="line.54"></a>
<span class="sourceLineNo">055</span><a id="line.55"> /** Default Encryption Class */</a>
<span class="sourceLineNo">056</span><a id="line.56"> private static final String DEFAULT_CLASS = "org.apache.fulcrum.crypto.provider.JavaCrypt";</a>
<span class="sourceLineNo">057</span><a id="line.57"></a>
<span class="sourceLineNo">058</span><a id="line.58"> /** Names of the registered algorithms and the wanted classes */</a>
<span class="sourceLineNo">059</span><a id="line.59"> private HashMap&lt;String, String&gt; algos = new HashMap&lt;&gt;();</a>
<span class="sourceLineNo">060</span><a id="line.60"></a>
<span class="sourceLineNo">061</span><a id="line.61"> /**</a>
<span class="sourceLineNo">062</span><a id="line.62"> * Returns a CryptoAlgorithm Object which represents the requested crypto</a>
<span class="sourceLineNo">063</span><a id="line.63"> * algorithm.</a>
<span class="sourceLineNo">064</span><a id="line.64"> *</a>
<span class="sourceLineNo">065</span><a id="line.65"> * @see org.apache.fulcrum.crypto.CryptoService#getCryptoAlgorithm(java.lang.String)</a>
<span class="sourceLineNo">066</span><a id="line.66"> *</a>
<span class="sourceLineNo">067</span><a id="line.67"> * @param algo Name of the requested algorithm</a>
<span class="sourceLineNo">068</span><a id="line.68"> *</a>
<span class="sourceLineNo">069</span><a id="line.69"> * @return An Object representing the algorithm</a>
<span class="sourceLineNo">070</span><a id="line.70"> *</a>
<span class="sourceLineNo">071</span><a id="line.71"> * @throws NoSuchAlgorithmException Requested algorithm is not available</a>
<span class="sourceLineNo">072</span><a id="line.72"> *</a>
<span class="sourceLineNo">073</span><a id="line.73"> */</a>
<span class="sourceLineNo">074</span><a id="line.74"> public CryptoAlgorithm getCryptoAlgorithm(String algo) throws NoSuchAlgorithmException </a>
<span class="sourceLineNo">075</span><a id="line.75"> {</a>
<span class="sourceLineNo">076</span><a id="line.76"> String cryptoClass = (String) algos.get(algo);</a>
<span class="sourceLineNo">077</span><a id="line.77"> CryptoAlgorithm ca = null;</a>
<span class="sourceLineNo">078</span><a id="line.78"> if (cryptoClass == null) {</a>
<span class="sourceLineNo">079</span><a id="line.79"> cryptoClass = (String) algos.get(DEFAULT_KEY);</a>
<span class="sourceLineNo">080</span><a id="line.80"> }</a>
<span class="sourceLineNo">081</span><a id="line.81"> if (cryptoClass == null || cryptoClass.equalsIgnoreCase("none")) {</a>
<span class="sourceLineNo">082</span><a id="line.82"> throw new NoSuchAlgorithmException("TurbineCryptoService: No Algorithm for " + algo + " found");</a>
<span class="sourceLineNo">083</span><a id="line.83"> }</a>
<span class="sourceLineNo">084</span><a id="line.84"> try {</a>
<span class="sourceLineNo">085</span><a id="line.85"> ca = (CryptoAlgorithm) Class.forName(cryptoClass).newInstance();</a>
<span class="sourceLineNo">086</span><a id="line.86"> } catch (Exception e) {</a>
<span class="sourceLineNo">087</span><a id="line.87"> throw new NoSuchAlgorithmException(</a>
<span class="sourceLineNo">088</span><a id="line.88"> "TurbineCryptoService: Error instantiating " + cryptoClass + " for " + algo);</a>
<span class="sourceLineNo">089</span><a id="line.89"> }</a>
<span class="sourceLineNo">090</span><a id="line.90"> ca.setCipher(algo);</a>
<span class="sourceLineNo">091</span><a id="line.91"> return ca;</a>
<span class="sourceLineNo">092</span><a id="line.92"> }</a>
<span class="sourceLineNo">093</span><a id="line.93"></a>
<span class="sourceLineNo">094</span><a id="line.94"></a>
<span class="sourceLineNo">095</span><a id="line.95"> // ---------------- Avalon Lifecycle Methods ---------------------</a>
<span class="sourceLineNo">096</span><a id="line.96"></a>
<span class="sourceLineNo">097</span><a id="line.97"> /**</a>
<span class="sourceLineNo">098</span><a id="line.98"> * Avalon component lifecycle method</a>
<span class="sourceLineNo">099</span><a id="line.99"> * </a>
<span class="sourceLineNo">100</span><a id="line.100"> * @param conf the configuration</a>
<span class="sourceLineNo">101</span><a id="line.101"> * @throws ConfigurationException if not found</a>
<span class="sourceLineNo">102</span><a id="line.102"> */</a>
<span class="sourceLineNo">103</span><a id="line.103"> public void configure(Configuration conf) throws ConfigurationException </a>
<span class="sourceLineNo">104</span><a id="line.104"> {</a>
<span class="sourceLineNo">105</span><a id="line.105"> // Initialize the hash and setup default</a>
<span class="sourceLineNo">106</span><a id="line.106"> // Can be overriden by default key from properties</a>
<span class="sourceLineNo">107</span><a id="line.107"> this.algos = new HashMap&lt;&gt;();</a>
<span class="sourceLineNo">108</span><a id="line.108"> this.algos.put(DEFAULT_KEY, DEFAULT_CLASS);</a>
<span class="sourceLineNo">109</span><a id="line.109"> </a>
<span class="sourceLineNo">110</span><a id="line.110"> final Configuration algorithms = conf.getChild(ALGORITHM, false);</a>
<span class="sourceLineNo">111</span><a id="line.111"> if (algorithms != null) {</a>
<span class="sourceLineNo">112</span><a id="line.112"> Configuration[] nameVal = algorithms.getChildren();</a>
<span class="sourceLineNo">113</span><a id="line.113"> for ( Configuration entry : nameVal )</a>
<span class="sourceLineNo">114</span><a id="line.114"> {</a>
<span class="sourceLineNo">115</span><a id="line.115"> algos.put(entry.getName(), entry.getValue());</a>
<span class="sourceLineNo">116</span><a id="line.116"> }</a>
<span class="sourceLineNo">117</span><a id="line.117"> }</a>
<span class="sourceLineNo">118</span><a id="line.118"> }</a>
<span class="sourceLineNo">119</span><a id="line.119"> </a>
<span class="sourceLineNo">120</span><a id="line.120"> /**</a>
<span class="sourceLineNo">121</span><a id="line.121"> * Initialize the service</a>
<span class="sourceLineNo">122</span><a id="line.122"> * </a>
<span class="sourceLineNo">123</span><a id="line.123"> * @see org.apache.avalon.framework.activity.Initializable#initialize()</a>
<span class="sourceLineNo">124</span><a id="line.124"> * </a>
<span class="sourceLineNo">125</span><a id="line.125"> * @throws Exception if initialization fails</a>
<span class="sourceLineNo">126</span><a id="line.126"> */</a>
<span class="sourceLineNo">127</span><a id="line.127"> public void initialize() throws Exception </a>
<span class="sourceLineNo">128</span><a id="line.128"> {</a>
<span class="sourceLineNo">129</span><a id="line.129"> getLogger().debug("initialize()");</a>
<span class="sourceLineNo">130</span><a id="line.130"> }</a>
<span class="sourceLineNo">131</span><a id="line.131"></a>
<span class="sourceLineNo">132</span><a id="line.132"> /**</a>
<span class="sourceLineNo">133</span><a id="line.133"> * Avalon component lifecycle method</a>
<span class="sourceLineNo">134</span><a id="line.134"> */</a>
<span class="sourceLineNo">135</span><a id="line.135"> public void dispose() </a>
<span class="sourceLineNo">136</span><a id="line.136"> {</a>
<span class="sourceLineNo">137</span><a id="line.137"> algos = null;</a>
<span class="sourceLineNo">138</span><a id="line.138"> }</a>
<span class="sourceLineNo">139</span><a id="line.139"></a>
<span class="sourceLineNo">140</span><a id="line.140">}</a>
</pre>
</div>
</main>
</body>
</html>