blob: 2bf3f3d64d5fcbe62776b3a998401ecc215bfcdb [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> import org.apache.shiro.util.ByteSource;<a name="line.21"></a>
<FONT color="green">022</FONT> <a name="line.22"></a>
<FONT color="green">023</FONT> import java.security.SecureRandom;<a name="line.23"></a>
<FONT color="green">024</FONT> <a name="line.24"></a>
<FONT color="green">025</FONT> /**<a name="line.25"></a>
<FONT color="green">026</FONT> * Default implementation of the {@link RandomNumberGenerator RandomNumberGenerator} interface, backed by a<a name="line.26"></a>
<FONT color="green">027</FONT> * {@link SecureRandom SecureRandom} instance.<a name="line.27"></a>
<FONT color="green">028</FONT> * &lt;p/&gt;<a name="line.28"></a>
<FONT color="green">029</FONT> * This class is a little easier to use than using the JDK's {@code SecureRandom} class directly. It also<a name="line.29"></a>
<FONT color="green">030</FONT> * allows for JavaBeans-style of customization, convenient for Shiro's INI configuration or other IoC configuration<a name="line.30"></a>
<FONT color="green">031</FONT> * mechanism.<a name="line.31"></a>
<FONT color="green">032</FONT> *<a name="line.32"></a>
<FONT color="green">033</FONT> * @since 1.1<a name="line.33"></a>
<FONT color="green">034</FONT> */<a name="line.34"></a>
<FONT color="green">035</FONT> public class SecureRandomNumberGenerator implements RandomNumberGenerator {<a name="line.35"></a>
<FONT color="green">036</FONT> <a name="line.36"></a>
<FONT color="green">037</FONT> protected static final int DEFAULT_NEXT_BYTES_SIZE = 16; //16 bytes == 128 bits (a common number in crypto)<a name="line.37"></a>
<FONT color="green">038</FONT> <a name="line.38"></a>
<FONT color="green">039</FONT> private int defaultNextBytesSize;<a name="line.39"></a>
<FONT color="green">040</FONT> private SecureRandom secureRandom;<a name="line.40"></a>
<FONT color="green">041</FONT> <a name="line.41"></a>
<FONT color="green">042</FONT> /**<a name="line.42"></a>
<FONT color="green">043</FONT> * Creates a new instance with a default backing {@link SecureRandom SecureRandom} and a<a name="line.43"></a>
<FONT color="green">044</FONT> * {@link #getDefaultNextBytesSize() defaultNextBytesSize} of {@code 16}, which equals 128 bits, a size commonly<a name="line.44"></a>
<FONT color="green">045</FONT> * used in cryptographic algorithms.<a name="line.45"></a>
<FONT color="green">046</FONT> */<a name="line.46"></a>
<FONT color="green">047</FONT> public SecureRandomNumberGenerator() {<a name="line.47"></a>
<FONT color="green">048</FONT> this.defaultNextBytesSize = DEFAULT_NEXT_BYTES_SIZE;<a name="line.48"></a>
<FONT color="green">049</FONT> this.secureRandom = new SecureRandom();<a name="line.49"></a>
<FONT color="green">050</FONT> }<a name="line.50"></a>
<FONT color="green">051</FONT> <a name="line.51"></a>
<FONT color="green">052</FONT> /**<a name="line.52"></a>
<FONT color="green">053</FONT> * Seeds the backing {@link SecureRandom SecureRandom} instance with additional seed data.<a name="line.53"></a>
<FONT color="green">054</FONT> *<a name="line.54"></a>
<FONT color="green">055</FONT> * @param bytes the seed bytes<a name="line.55"></a>
<FONT color="green">056</FONT> * @see SecureRandom#setSeed(byte[])<a name="line.56"></a>
<FONT color="green">057</FONT> */<a name="line.57"></a>
<FONT color="green">058</FONT> public void setSeed(byte[] bytes) {<a name="line.58"></a>
<FONT color="green">059</FONT> this.secureRandom.setSeed(bytes);<a name="line.59"></a>
<FONT color="green">060</FONT> }<a name="line.60"></a>
<FONT color="green">061</FONT> <a name="line.61"></a>
<FONT color="green">062</FONT> /**<a name="line.62"></a>
<FONT color="green">063</FONT> * Returns the {@link SecureRandom SecureRandom} backing this instance.<a name="line.63"></a>
<FONT color="green">064</FONT> *<a name="line.64"></a>
<FONT color="green">065</FONT> * @return the {@link SecureRandom SecureRandom} backing this instance.<a name="line.65"></a>
<FONT color="green">066</FONT> */<a name="line.66"></a>
<FONT color="green">067</FONT> public SecureRandom getSecureRandom() {<a name="line.67"></a>
<FONT color="green">068</FONT> return secureRandom;<a name="line.68"></a>
<FONT color="green">069</FONT> }<a name="line.69"></a>
<FONT color="green">070</FONT> <a name="line.70"></a>
<FONT color="green">071</FONT> /**<a name="line.71"></a>
<FONT color="green">072</FONT> * Sets the {@link SecureRandom SecureRandom} to back this instance.<a name="line.72"></a>
<FONT color="green">073</FONT> *<a name="line.73"></a>
<FONT color="green">074</FONT> * @param random the {@link SecureRandom SecureRandom} to back this instance.<a name="line.74"></a>
<FONT color="green">075</FONT> * @throws NullPointerException if the method argument is null<a name="line.75"></a>
<FONT color="green">076</FONT> */<a name="line.76"></a>
<FONT color="green">077</FONT> public void setSecureRandom(SecureRandom random) throws NullPointerException {<a name="line.77"></a>
<FONT color="green">078</FONT> if (random == null) {<a name="line.78"></a>
<FONT color="green">079</FONT> throw new NullPointerException("SecureRandom argument cannot be null.");<a name="line.79"></a>
<FONT color="green">080</FONT> }<a name="line.80"></a>
<FONT color="green">081</FONT> this.secureRandom = random;<a name="line.81"></a>
<FONT color="green">082</FONT> }<a name="line.82"></a>
<FONT color="green">083</FONT> <a name="line.83"></a>
<FONT color="green">084</FONT> /**<a name="line.84"></a>
<FONT color="green">085</FONT> * Returns the size of the generated byte array for calls to {@link #nextBytes() nextBytes()}. Defaults to<a name="line.85"></a>
<FONT color="green">086</FONT> * {@code 16}, which equals 128 bits, a size commonly used in cryptographic algorithms.<a name="line.86"></a>
<FONT color="green">087</FONT> *<a name="line.87"></a>
<FONT color="green">088</FONT> * @return the size of the generated byte array for calls to {@link #nextBytes() nextBytes()}.<a name="line.88"></a>
<FONT color="green">089</FONT> */<a name="line.89"></a>
<FONT color="green">090</FONT> public int getDefaultNextBytesSize() {<a name="line.90"></a>
<FONT color="green">091</FONT> return defaultNextBytesSize;<a name="line.91"></a>
<FONT color="green">092</FONT> }<a name="line.92"></a>
<FONT color="green">093</FONT> <a name="line.93"></a>
<FONT color="green">094</FONT> /**<a name="line.94"></a>
<FONT color="green">095</FONT> * Sets the size of the generated byte array for calls to {@link #nextBytes() nextBytes()}. Defaults to<a name="line.95"></a>
<FONT color="green">096</FONT> * {@code 16}, which equals 128 bits, a size commonly used in cryptographic algorithms.<a name="line.96"></a>
<FONT color="green">097</FONT> *<a name="line.97"></a>
<FONT color="green">098</FONT> * @param defaultNextBytesSize the size of the generated byte array for calls to {@link #nextBytes() nextBytes()}.<a name="line.98"></a>
<FONT color="green">099</FONT> * @throws IllegalArgumentException if the argument is 0 or negative<a name="line.99"></a>
<FONT color="green">100</FONT> */<a name="line.100"></a>
<FONT color="green">101</FONT> public void setDefaultNextBytesSize(int defaultNextBytesSize) throws IllegalArgumentException {<a name="line.101"></a>
<FONT color="green">102</FONT> if ( defaultNextBytesSize &lt;= 0) {<a name="line.102"></a>
<FONT color="green">103</FONT> throw new IllegalArgumentException("size value must be a positive integer (1 or larger)");<a name="line.103"></a>
<FONT color="green">104</FONT> }<a name="line.104"></a>
<FONT color="green">105</FONT> this.defaultNextBytesSize = defaultNextBytesSize;<a name="line.105"></a>
<FONT color="green">106</FONT> }<a name="line.106"></a>
<FONT color="green">107</FONT> <a name="line.107"></a>
<FONT color="green">108</FONT> public ByteSource nextBytes() {<a name="line.108"></a>
<FONT color="green">109</FONT> return nextBytes(getDefaultNextBytesSize());<a name="line.109"></a>
<FONT color="green">110</FONT> }<a name="line.110"></a>
<FONT color="green">111</FONT> <a name="line.111"></a>
<FONT color="green">112</FONT> public ByteSource nextBytes(int numBytes) {<a name="line.112"></a>
<FONT color="green">113</FONT> if (numBytes &lt;= 0) {<a name="line.113"></a>
<FONT color="green">114</FONT> throw new IllegalArgumentException("numBytes argument must be a positive integer (1 or larger)");<a name="line.114"></a>
<FONT color="green">115</FONT> }<a name="line.115"></a>
<FONT color="green">116</FONT> byte[] bytes = new byte[numBytes];<a name="line.116"></a>
<FONT color="green">117</FONT> this.secureRandom.nextBytes(bytes);<a name="line.117"></a>
<FONT color="green">118</FONT> return ByteSource.Util.bytes(bytes);<a name="line.118"></a>
<FONT color="green">119</FONT> }<a name="line.119"></a>
<FONT color="green">120</FONT> }<a name="line.120"></a>
</PRE>
</BODY>
</HTML>