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