blob: 83a0de7ae9eacde1060aed16d273467e1e12e7cf [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a>
<FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<FONT color="green">007</FONT> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<FONT color="green">008</FONT> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<FONT color="green">009</FONT> *<a name="line.9"></a>
<FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<FONT color="green">011</FONT> *<a name="line.11"></a>
<FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<FONT color="green">013</FONT> * software distributed under the License is distributed on an<a name="line.13"></a>
<FONT color="green">014</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<FONT color="green">015</FONT> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<FONT color="green">016</FONT> * specific language governing permissions and limitations<a name="line.16"></a>
<FONT color="green">017</FONT> * under the License.<a name="line.17"></a>
<FONT color="green">018</FONT> */<a name="line.18"></a>
<FONT color="green">019</FONT> package org.apache.shiro.crypto;<a name="line.19"></a>
<FONT color="green">020</FONT> <a name="line.20"></a>
<FONT color="green">021</FONT> /**<a name="line.21"></a>
<FONT color="green">022</FONT> * {@code CipherService} using the {@code Blowfish} cipher algorithm for all encryption, decryption, and key operations.<a name="line.22"></a>
<FONT color="green">023</FONT> * &lt;p/&gt;<a name="line.23"></a>
<FONT color="green">024</FONT> * The Blowfish algorithm can support key sizes between {@code 32} and {@code 448} bits&lt;b&gt;*&lt;/b&gt;, inclusive. However,<a name="line.24"></a>
<FONT color="green">025</FONT> * modern cryptanalysis techniques render keys of 80 bits or less mostly worthless - use {@code 128} or more whenever<a name="line.25"></a>
<FONT color="green">026</FONT> * possible.<a name="line.26"></a>
<FONT color="green">027</FONT> * &lt;p/&gt;<a name="line.27"></a>
<FONT color="green">028</FONT> * Note that this class retains the parent class's default {@link OperationMode#CBC CBC} mode of operation<a name="line.28"></a>
<FONT color="green">029</FONT> * instead of the typical JDK default of {@link OperationMode#ECB ECB}. {@code ECB} should not be used in<a name="line.29"></a>
<FONT color="green">030</FONT> * security-sensitive environments because {@code ECB} does not allow for initialization vectors, which are<a name="line.30"></a>
<FONT color="green">031</FONT> * considered necessary for strong encryption. See the {@link DefaultBlockCipherService parent class}'s JavaDoc and the<a name="line.31"></a>
<FONT color="green">032</FONT> * {@link JcaCipherService JcaCipherService} JavaDoc for more on why the JDK default should not be used and is not<a name="line.32"></a>
<FONT color="green">033</FONT> * used in this implementation.<a name="line.33"></a>
<FONT color="green">034</FONT> * &lt;p/&gt;<a name="line.34"></a>
<FONT color="green">035</FONT> * &lt;b&gt;*&lt;/b&gt; Generating and using Blowfish key sizes greater than 128 require installation of the<a name="line.35"></a>
<FONT color="green">036</FONT> * &lt;a href="http://java.sun.com/javase/downloads/index.jsp"&gt;Java Cryptography Extension (JCE) Unlimited Strength<a name="line.36"></a>
<FONT color="green">037</FONT> * Jurisdiction Policy files&lt;/a&gt;.<a name="line.37"></a>
<FONT color="green">038</FONT> *<a name="line.38"></a>
<FONT color="green">039</FONT> * @since 1.0<a name="line.39"></a>
<FONT color="green">040</FONT> */<a name="line.40"></a>
<FONT color="green">041</FONT> public class BlowfishCipherService extends DefaultBlockCipherService {<a name="line.41"></a>
<FONT color="green">042</FONT> <a name="line.42"></a>
<FONT color="green">043</FONT> private static final String ALGORITHM_NAME = "Blowfish";<a name="line.43"></a>
<FONT color="green">044</FONT> private static final int BLOCK_SIZE = 64;<a name="line.44"></a>
<FONT color="green">045</FONT> <a name="line.45"></a>
<FONT color="green">046</FONT> /**<a name="line.46"></a>
<FONT color="green">047</FONT> * Creates a new {@link CipherService} instance using the {@code Blowfish} cipher algorithm with the following<a name="line.47"></a>
<FONT color="green">048</FONT> * important cipher default attributes:<a name="line.48"></a>
<FONT color="green">049</FONT> * &lt;table&gt;<a name="line.49"></a>
<FONT color="green">050</FONT> * &lt;tr&gt;<a name="line.50"></a>
<FONT color="green">051</FONT> * &lt;th&gt;Attribute&lt;/th&gt;<a name="line.51"></a>
<FONT color="green">052</FONT> * &lt;th&gt;Value&lt;/th&gt;<a name="line.52"></a>
<FONT color="green">053</FONT> * &lt;/tr&gt;<a name="line.53"></a>
<FONT color="green">054</FONT> * &lt;tr&gt;<a name="line.54"></a>
<FONT color="green">055</FONT> * &lt;td&gt;{@link #setKeySize keySize}&lt;/td&gt;<a name="line.55"></a>
<FONT color="green">056</FONT> * &lt;td&gt;{@code 128} bits&lt;/td&gt;<a name="line.56"></a>
<FONT color="green">057</FONT> * &lt;/tr&gt;<a name="line.57"></a>
<FONT color="green">058</FONT> * &lt;tr&gt;<a name="line.58"></a>
<FONT color="green">059</FONT> * &lt;td&gt;{@link #setBlockSize blockSize}&lt;/td&gt;<a name="line.59"></a>
<FONT color="green">060</FONT> * &lt;td&gt;{@code 64} bits (required for {@code Blowfish})&lt;/td&gt;<a name="line.60"></a>
<FONT color="green">061</FONT> * &lt;/tr&gt;<a name="line.61"></a>
<FONT color="green">062</FONT> * &lt;tr&gt;<a name="line.62"></a>
<FONT color="green">063</FONT> * &lt;td&gt;{@link #setMode mode}&lt;/td&gt;<a name="line.63"></a>
<FONT color="green">064</FONT> * &lt;td&gt;{@link OperationMode#CBC CBC}&lt;b&gt;*&lt;/b&gt;&lt;/td&gt;<a name="line.64"></a>
<FONT color="green">065</FONT> * &lt;/tr&gt;<a name="line.65"></a>
<FONT color="green">066</FONT> * &lt;tr&gt;<a name="line.66"></a>
<FONT color="green">067</FONT> * &lt;td&gt;{@link #setPaddingScheme paddingScheme}&lt;/td&gt;<a name="line.67"></a>
<FONT color="green">068</FONT> * &lt;td&gt;{@link PaddingScheme#PKCS5 PKCS5}&lt;/td&gt;<a name="line.68"></a>
<FONT color="green">069</FONT> * &lt;/tr&gt;<a name="line.69"></a>
<FONT color="green">070</FONT> * &lt;tr&gt;<a name="line.70"></a>
<FONT color="green">071</FONT> * &lt;td&gt;{@link #setInitializationVectorSize(int) initializationVectorSize}&lt;/td&gt;<a name="line.71"></a>
<FONT color="green">072</FONT> * &lt;td&gt;{@code 64} bits&lt;/td&gt;<a name="line.72"></a>
<FONT color="green">073</FONT> * &lt;/tr&gt;<a name="line.73"></a>
<FONT color="green">074</FONT> * &lt;tr&gt;<a name="line.74"></a>
<FONT color="green">075</FONT> * &lt;td&gt;{@link #setGenerateInitializationVectors(boolean) generateInitializationVectors}&lt;/td&gt;<a name="line.75"></a>
<FONT color="green">076</FONT> * &lt;td&gt;{@code true}&lt;b&gt;**&lt;/b&gt;&lt;/td&gt;<a name="line.76"></a>
<FONT color="green">077</FONT> * &lt;/tr&gt;<a name="line.77"></a>
<FONT color="green">078</FONT> * &lt;/table&gt;<a name="line.78"></a>
<FONT color="green">079</FONT> * &lt;p/&gt;<a name="line.79"></a>
<FONT color="green">080</FONT> * &lt;b&gt;*&lt;/b&gt; The {@link OperationMode#CBC CBC} operation mode is used instead of the JDK default {@code ECB} to<a name="line.80"></a>
<FONT color="green">081</FONT> * ensure strong encryption. {@code ECB} should not be used in security-sensitive environments - see the<a name="line.81"></a>
<FONT color="green">082</FONT> * {@link DefaultBlockCipherService DefaultBlockCipherService} class JavaDoc's &amp;quot;Operation Mode&amp;quot; section<a name="line.82"></a>
<FONT color="green">083</FONT> * for more.<a name="line.83"></a>
<FONT color="green">084</FONT> * &lt;p/&gt;<a name="line.84"></a>
<FONT color="green">085</FONT> * &lt;b&gt;**&lt;/b&gt;In conjunction with the default {@code CBC} operation mode, initialization vectors are generated by<a name="line.85"></a>
<FONT color="green">086</FONT> * default to ensure strong encryption. See the {@link JcaCipherService JcaCipherService} class JavaDoc for more.<a name="line.86"></a>
<FONT color="green">087</FONT> */<a name="line.87"></a>
<FONT color="green">088</FONT> public BlowfishCipherService() {<a name="line.88"></a>
<FONT color="green">089</FONT> super(ALGORITHM_NAME);<a name="line.89"></a>
<FONT color="green">090</FONT> setInitializationVectorSize(BLOCK_SIZE); //like most block ciphers, the IV size is the same as the block size<a name="line.90"></a>
<FONT color="green">091</FONT> }<a name="line.91"></a>
<FONT color="green">092</FONT> }<a name="line.92"></a>
</PRE>
</BODY>
</HTML>