blob: 9066c8fcef7b9d5c93ba6d004ea61e7a4963a305 [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.provider;</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.MessageDigest;</a>
<span class="sourceLineNo">023</span><a id="line.23"></a>
<span class="sourceLineNo">024</span><a id="line.24">import org.apache.commons.codec.binary.Base64;</a>
<span class="sourceLineNo">025</span><a id="line.25">import org.apache.fulcrum.crypto.CryptoAlgorithm;</a>
<span class="sourceLineNo">026</span><a id="line.26"></a>
<span class="sourceLineNo">027</span><a id="line.27">/**</a>
<span class="sourceLineNo">028</span><a id="line.28"> * Implements the normal java.security.MessageDigest stream cipers. Base64</a>
<span class="sourceLineNo">029</span><a id="line.29"> * strings returned by this provider are correctly padded to multiples of four</a>
<span class="sourceLineNo">030</span><a id="line.30"> * bytes. If you run into interoperability problems with other languages,</a>
<span class="sourceLineNo">031</span><a id="line.31"> * especially perl and the Digest::MD5 module, note that the md5_base64 function</a>
<span class="sourceLineNo">032</span><a id="line.32"> * from this package incorrectly drops the pad bytes. Use the MIME::Base64</a>
<span class="sourceLineNo">033</span><a id="line.33"> * package instead.</a>
<span class="sourceLineNo">034</span><a id="line.34"> *</a>
<span class="sourceLineNo">035</span><a id="line.35"> * If you upgrade from Turbine 2.1 and suddently your old stored passwords no</a>
<span class="sourceLineNo">036</span><a id="line.36"> * longer work, please take a look at the OldJavaCrypt provider for bug-to-bug</a>
<span class="sourceLineNo">037</span><a id="line.37"> * compatibility.</a>
<span class="sourceLineNo">038</span><a id="line.38"> *</a>
<span class="sourceLineNo">039</span><a id="line.39"> * This provider can be used as the default crypto algorithm provider.</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:hps@intermeta.de"&gt;Henning P. Schmiedehausen&lt;/a&gt;</a>
<span class="sourceLineNo">042</span><a id="line.42"> * @version $Id$</a>
<span class="sourceLineNo">043</span><a id="line.43"> */</a>
<span class="sourceLineNo">044</span><a id="line.44">public class JavaCrypt implements CryptoAlgorithm </a>
<span class="sourceLineNo">045</span><a id="line.45">{</a>
<span class="sourceLineNo">046</span><a id="line.46"></a>
<span class="sourceLineNo">047</span><a id="line.47"> /** The default cipher */</a>
<span class="sourceLineNo">048</span><a id="line.48"> public static final String DEFAULT_CIPHER = "SHA";</a>
<span class="sourceLineNo">049</span><a id="line.49"></a>
<span class="sourceLineNo">050</span><a id="line.50"> /** The cipher to use for encryption */</a>
<span class="sourceLineNo">051</span><a id="line.51"> private String cipher = null;</a>
<span class="sourceLineNo">052</span><a id="line.52"></a>
<span class="sourceLineNo">053</span><a id="line.53"> /**</a>
<span class="sourceLineNo">054</span><a id="line.54"> * Constructor</a>
<span class="sourceLineNo">055</span><a id="line.55"> *</a>
<span class="sourceLineNo">056</span><a id="line.56"> */</a>
<span class="sourceLineNo">057</span><a id="line.57"> public JavaCrypt() </a>
<span class="sourceLineNo">058</span><a id="line.58"> {</a>
<span class="sourceLineNo">059</span><a id="line.59"> this.cipher = DEFAULT_CIPHER;</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"> /**</a>
<span class="sourceLineNo">063</span><a id="line.63"> * Setting the actual cipher requested. If not called, then the default cipher</a>
<span class="sourceLineNo">064</span><a id="line.64"> * (SHA) is used.</a>
<span class="sourceLineNo">065</span><a id="line.65"> *</a>
<span class="sourceLineNo">066</span><a id="line.66"> * This will never throw an error even if there is no provider for this cipher.</a>
<span class="sourceLineNo">067</span><a id="line.67"> * The error will be thrown by encrypt() (Fixme?)</a>
<span class="sourceLineNo">068</span><a id="line.68"> *</a>
<span class="sourceLineNo">069</span><a id="line.69"> * @see org.apache.fulcrum.crypto.CryptoAlgorithm#setCipher(java.lang.String)</a>
<span class="sourceLineNo">070</span><a id="line.70"> *</a>
<span class="sourceLineNo">071</span><a id="line.71"> * @param cipher The cipher to use.</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 void setCipher(String cipher) </a>
<span class="sourceLineNo">075</span><a id="line.75"> {</a>
<span class="sourceLineNo">076</span><a id="line.76"> this.cipher = cipher;</a>
<span class="sourceLineNo">077</span><a id="line.77"> }</a>
<span class="sourceLineNo">078</span><a id="line.78"></a>
<span class="sourceLineNo">079</span><a id="line.79"> /**</a>
<span class="sourceLineNo">080</span><a id="line.80"> * This class never uses a seed, so this is just a dummy.</a>
<span class="sourceLineNo">081</span><a id="line.81"> *</a>
<span class="sourceLineNo">082</span><a id="line.82"> * @see org.apache.fulcrum.crypto.CryptoAlgorithm#setSeed(java.lang.String)</a>
<span class="sourceLineNo">083</span><a id="line.83"> * </a>
<span class="sourceLineNo">084</span><a id="line.84"> * @param seed Seed (ignored)</a>
<span class="sourceLineNo">085</span><a id="line.85"> *</a>
<span class="sourceLineNo">086</span><a id="line.86"> */</a>
<span class="sourceLineNo">087</span><a id="line.87"> public void setSeed(String seed) </a>
<span class="sourceLineNo">088</span><a id="line.88"> {</a>
<span class="sourceLineNo">089</span><a id="line.89"> /* dummy */</a>
<span class="sourceLineNo">090</span><a id="line.90"> }</a>
<span class="sourceLineNo">091</span><a id="line.91"></a>
<span class="sourceLineNo">092</span><a id="line.92"> /**</a>
<span class="sourceLineNo">093</span><a id="line.93"> * Encrypt the supplied string with the requested cipher</a>
<span class="sourceLineNo">094</span><a id="line.94"> *</a>
<span class="sourceLineNo">095</span><a id="line.95"> * @see org.apache.fulcrum.crypto.CryptoAlgorithm#encrypt(java.lang.String)</a>
<span class="sourceLineNo">096</span><a id="line.96"> *</a>
<span class="sourceLineNo">097</span><a id="line.97"> * @param value The value to be encrypted</a>
<span class="sourceLineNo">098</span><a id="line.98"> * @return The encrypted value</a>
<span class="sourceLineNo">099</span><a id="line.99"> * @throws Exception An Exception of the underlying implementation.</a>
<span class="sourceLineNo">100</span><a id="line.100"> */</a>
<span class="sourceLineNo">101</span><a id="line.101"> public String encrypt(String value) throws Exception </a>
<span class="sourceLineNo">102</span><a id="line.102"> {</a>
<span class="sourceLineNo">103</span><a id="line.103"> MessageDigest md = MessageDigest.getInstance(cipher);</a>
<span class="sourceLineNo">104</span><a id="line.104"></a>
<span class="sourceLineNo">105</span><a id="line.105"> // We need to use unicode here, to be independent of platform's</a>
<span class="sourceLineNo">106</span><a id="line.106"> // default encoding. Thanks to SGawin for spotting this.</a>
<span class="sourceLineNo">107</span><a id="line.107"> byte[] digest = md.digest(value.getBytes("UTF-8"));</a>
<span class="sourceLineNo">108</span><a id="line.108"></a>
<span class="sourceLineNo">109</span><a id="line.109"> // Base64-encode the digest.</a>
<span class="sourceLineNo">110</span><a id="line.110"> byte[] encodedDigest = Base64.encodeBase64(digest);</a>
<span class="sourceLineNo">111</span><a id="line.111"> return (encodedDigest == null ? null : new String(encodedDigest, "UTF-8"));</a>
<span class="sourceLineNo">112</span><a id="line.112"> }</a>
<span class="sourceLineNo">113</span><a id="line.113">}</a>
</pre>
</div>
</main>
</body>
</html>