blob: 1bb66dc4299dc07553647cf4422fdb16755a4316 [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>package org.apache.fulcrum.crypto.provider;<a name="line.1"></a>
<span class="sourceLineNo">002</span><a name="line.2"></a>
<span class="sourceLineNo">003</span>/*<a name="line.3"></a>
<span class="sourceLineNo">004</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.4"></a>
<span class="sourceLineNo">005</span> * or more contributor license agreements. See the NOTICE file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * distributed with this work for additional information<a name="line.6"></a>
<span class="sourceLineNo">007</span> * regarding copyright ownership. The ASF licenses this file<a name="line.7"></a>
<span class="sourceLineNo">008</span> * to you under the Apache License, Version 2.0 (the<a name="line.8"></a>
<span class="sourceLineNo">009</span> * "License"); you may not use this file except in compliance<a name="line.9"></a>
<span class="sourceLineNo">010</span> * with the License. You may obtain a copy of the License at<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.12"></a>
<span class="sourceLineNo">013</span> *<a name="line.13"></a>
<span class="sourceLineNo">014</span> * Unless required by applicable law or agreed to in writing,<a name="line.14"></a>
<span class="sourceLineNo">015</span> * software distributed under the License is distributed on an<a name="line.15"></a>
<span class="sourceLineNo">016</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.16"></a>
<span class="sourceLineNo">017</span> * KIND, either express or implied. See the License for the<a name="line.17"></a>
<span class="sourceLineNo">018</span> * specific language governing permissions and limitations<a name="line.18"></a>
<span class="sourceLineNo">019</span> * under the License.<a name="line.19"></a>
<span class="sourceLineNo">020</span> */<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.security.MessageDigest;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.commons.codec.binary.Base64;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.fulcrum.crypto.CryptoAlgorithm;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>/**<a name="line.27"></a>
<span class="sourceLineNo">028</span> * Implements the normal java.security.MessageDigest stream cipers. Base64<a name="line.28"></a>
<span class="sourceLineNo">029</span> * strings returned by this provider are correctly padded to multiples of four<a name="line.29"></a>
<span class="sourceLineNo">030</span> * bytes. If you run into interoperability problems with other languages,<a name="line.30"></a>
<span class="sourceLineNo">031</span> * especially perl and the Digest::MD5 module, note that the md5_base64 function<a name="line.31"></a>
<span class="sourceLineNo">032</span> * from this package incorrectly drops the pad bytes. Use the MIME::Base64<a name="line.32"></a>
<span class="sourceLineNo">033</span> * package instead.<a name="line.33"></a>
<span class="sourceLineNo">034</span> *<a name="line.34"></a>
<span class="sourceLineNo">035</span> * If you upgrade from Turbine 2.1 and suddently your old stored passwords no<a name="line.35"></a>
<span class="sourceLineNo">036</span> * longer work, please take a look at the OldJavaCrypt provider for bug-to-bug<a name="line.36"></a>
<span class="sourceLineNo">037</span> * compatibility.<a name="line.37"></a>
<span class="sourceLineNo">038</span> *<a name="line.38"></a>
<span class="sourceLineNo">039</span> * This provider can be used as the default crypto algorithm provider.<a name="line.39"></a>
<span class="sourceLineNo">040</span> *<a name="line.40"></a>
<span class="sourceLineNo">041</span> * @author &lt;a href="mailto:hps@intermeta.de"&gt;Henning P. Schmiedehausen&lt;/a&gt;<a name="line.41"></a>
<span class="sourceLineNo">042</span> * @version $Id$<a name="line.42"></a>
<span class="sourceLineNo">043</span> */<a name="line.43"></a>
<span class="sourceLineNo">044</span>public class JavaCrypt implements CryptoAlgorithm <a name="line.44"></a>
<span class="sourceLineNo">045</span>{<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span> /** The default cipher */<a name="line.47"></a>
<span class="sourceLineNo">048</span> public static final String DEFAULT_CIPHER = "SHA";<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span> /** The cipher to use for encryption */<a name="line.50"></a>
<span class="sourceLineNo">051</span> private String cipher = null;<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> * Constructor<a name="line.54"></a>
<span class="sourceLineNo">055</span> *<a name="line.55"></a>
<span class="sourceLineNo">056</span> */<a name="line.56"></a>
<span class="sourceLineNo">057</span> public JavaCrypt() <a name="line.57"></a>
<span class="sourceLineNo">058</span> {<a name="line.58"></a>
<span class="sourceLineNo">059</span> this.cipher = DEFAULT_CIPHER;<a name="line.59"></a>
<span class="sourceLineNo">060</span> }<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span> /**<a name="line.62"></a>
<span class="sourceLineNo">063</span> * Setting the actual cipher requested. If not called, then the default cipher<a name="line.63"></a>
<span class="sourceLineNo">064</span> * (SHA) is used.<a name="line.64"></a>
<span class="sourceLineNo">065</span> *<a name="line.65"></a>
<span class="sourceLineNo">066</span> * This will never throw an error even if there is no provider for this cipher.<a name="line.66"></a>
<span class="sourceLineNo">067</span> * The error will be thrown by encrypt() (Fixme?)<a name="line.67"></a>
<span class="sourceLineNo">068</span> *<a name="line.68"></a>
<span class="sourceLineNo">069</span> * @see org.apache.fulcrum.crypto.CryptoAlgorithm#setCipher(java.lang.String)<a name="line.69"></a>
<span class="sourceLineNo">070</span> *<a name="line.70"></a>
<span class="sourceLineNo">071</span> * @param cipher The cipher to use.<a name="line.71"></a>
<span class="sourceLineNo">072</span> *<a name="line.72"></a>
<span class="sourceLineNo">073</span> */<a name="line.73"></a>
<span class="sourceLineNo">074</span> public void setCipher(String cipher) <a name="line.74"></a>
<span class="sourceLineNo">075</span> {<a name="line.75"></a>
<span class="sourceLineNo">076</span> this.cipher = cipher;<a name="line.76"></a>
<span class="sourceLineNo">077</span> }<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> * This class never uses a seed, so this is just a dummy.<a name="line.80"></a>
<span class="sourceLineNo">081</span> *<a name="line.81"></a>
<span class="sourceLineNo">082</span> * @see org.apache.fulcrum.crypto.CryptoAlgorithm#setSeed(java.lang.String)<a name="line.82"></a>
<span class="sourceLineNo">083</span> * <a name="line.83"></a>
<span class="sourceLineNo">084</span> * @param seed Seed (ignored)<a name="line.84"></a>
<span class="sourceLineNo">085</span> *<a name="line.85"></a>
<span class="sourceLineNo">086</span> */<a name="line.86"></a>
<span class="sourceLineNo">087</span> public void setSeed(String seed) <a name="line.87"></a>
<span class="sourceLineNo">088</span> {<a name="line.88"></a>
<span class="sourceLineNo">089</span> /* dummy */<a name="line.89"></a>
<span class="sourceLineNo">090</span> }<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span> /**<a name="line.92"></a>
<span class="sourceLineNo">093</span> * Encrypt the supplied string with the requested cipher<a name="line.93"></a>
<span class="sourceLineNo">094</span> *<a name="line.94"></a>
<span class="sourceLineNo">095</span> * @see org.apache.fulcrum.crypto.CryptoAlgorithm#encrypt(java.lang.String)<a name="line.95"></a>
<span class="sourceLineNo">096</span> *<a name="line.96"></a>
<span class="sourceLineNo">097</span> * @param value The value to be encrypted<a name="line.97"></a>
<span class="sourceLineNo">098</span> * @return The encrypted value<a name="line.98"></a>
<span class="sourceLineNo">099</span> * @throws Exception An Exception of the underlying implementation.<a name="line.99"></a>
<span class="sourceLineNo">100</span> */<a name="line.100"></a>
<span class="sourceLineNo">101</span> public String encrypt(String value) throws Exception <a name="line.101"></a>
<span class="sourceLineNo">102</span> {<a name="line.102"></a>
<span class="sourceLineNo">103</span> MessageDigest md = MessageDigest.getInstance(cipher);<a name="line.103"></a>
<span class="sourceLineNo">104</span><a name="line.104"></a>
<span class="sourceLineNo">105</span> // We need to use unicode here, to be independent of platform's<a name="line.105"></a>
<span class="sourceLineNo">106</span> // default encoding. Thanks to SGawin for spotting this.<a name="line.106"></a>
<span class="sourceLineNo">107</span> byte[] digest = md.digest(value.getBytes("UTF-8"));<a name="line.107"></a>
<span class="sourceLineNo">108</span><a name="line.108"></a>
<span class="sourceLineNo">109</span> // Base64-encode the digest.<a name="line.109"></a>
<span class="sourceLineNo">110</span> byte[] encodedDigest = Base64.encodeBase64(digest);<a name="line.110"></a>
<span class="sourceLineNo">111</span> return (encodedDigest == null ? null : new String(encodedDigest, "UTF-8"));<a name="line.111"></a>
<span class="sourceLineNo">112</span> }<a name="line.112"></a>
<span class="sourceLineNo">113</span>}<a name="line.113"></a>
</pre>
</div>
</body>
</html>