| <!DOCTYPE HTML> |
| <html lang="en"> |
| <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">/*</a> |
| <span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one</a> |
| <span class="sourceLineNo">003</span><a id="line.3"> * or more contributor license agreements. See the NOTICE file</a> |
| <span class="sourceLineNo">004</span><a id="line.4"> * distributed with this work for additional information</a> |
| <span class="sourceLineNo">005</span><a id="line.5"> * regarding copyright ownership. The ASF licenses this file</a> |
| <span class="sourceLineNo">006</span><a id="line.6"> * to you under the Apache License, Version 2.0 (the</a> |
| <span class="sourceLineNo">007</span><a id="line.7"> * "License"); you may not use this file except in compliance</a> |
| <span class="sourceLineNo">008</span><a id="line.8"> * with the License. You may obtain a copy of the License at</a> |
| <span class="sourceLineNo">009</span><a id="line.9"> *</a> |
| <span class="sourceLineNo">010</span><a id="line.10"> * http://www.apache.org/licenses/LICENSE-2.0</a> |
| <span class="sourceLineNo">011</span><a id="line.11"> *</a> |
| <span class="sourceLineNo">012</span><a id="line.12"> * Unless required by applicable law or agreed to in writing,</a> |
| <span class="sourceLineNo">013</span><a id="line.13"> * software distributed under the License is distributed on an</a> |
| <span class="sourceLineNo">014</span><a id="line.14"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a> |
| <span class="sourceLineNo">015</span><a id="line.15"> * KIND, either express or implied. See the License for the</a> |
| <span class="sourceLineNo">016</span><a id="line.16"> * specific language governing permissions and limitations</a> |
| <span class="sourceLineNo">017</span><a id="line.17"> * under the License.</a> |
| <span class="sourceLineNo">018</span><a id="line.18"> */</a> |
| <span class="sourceLineNo">019</span><a id="line.19">package org.apache.shiro.crypto;</a> |
| <span class="sourceLineNo">020</span><a id="line.20"></a> |
| <span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.util.ByteSource;</a> |
| <span class="sourceLineNo">022</span><a id="line.22"></a> |
| <span class="sourceLineNo">023</span><a id="line.23">import java.security.SecureRandom;</a> |
| <span class="sourceLineNo">024</span><a id="line.24"></a> |
| <span class="sourceLineNo">025</span><a id="line.25">/**</a> |
| <span class="sourceLineNo">026</span><a id="line.26"> * Default implementation of the {@link RandomNumberGenerator RandomNumberGenerator} interface, backed by a</a> |
| <span class="sourceLineNo">027</span><a id="line.27"> * {@link SecureRandom SecureRandom} instance.</a> |
| <span class="sourceLineNo">028</span><a id="line.28"> * <p/></a> |
| <span class="sourceLineNo">029</span><a id="line.29"> * This class is a little easier to use than using the JDK's {@code SecureRandom} class directly. It also</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> * allows for JavaBeans-style of customization, convenient for Shiro's INI configuration or other IoC configuration</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * mechanism.</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> *</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> * @since 1.1</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> */</a> |
| <span class="sourceLineNo">035</span><a id="line.35">public class SecureRandomNumberGenerator implements RandomNumberGenerator {</a> |
| <span class="sourceLineNo">036</span><a id="line.36"></a> |
| <span class="sourceLineNo">037</span><a id="line.37"> protected static final int DEFAULT_NEXT_BYTES_SIZE = 16; //16 bytes == 128 bits (a common number in crypto)</a> |
| <span class="sourceLineNo">038</span><a id="line.38"></a> |
| <span class="sourceLineNo">039</span><a id="line.39"> private int defaultNextBytesSize;</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> private SecureRandom secureRandom;</a> |
| <span class="sourceLineNo">041</span><a id="line.41"></a> |
| <span class="sourceLineNo">042</span><a id="line.42"> /**</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> * Creates a new instance with a default backing {@link SecureRandom SecureRandom} and a</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> * {@link #getDefaultNextBytesSize() defaultNextBytesSize} of {@code 16}, which equals 128 bits, a size commonly</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> * used in cryptographic algorithms.</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> */</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> public SecureRandomNumberGenerator() {</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> this.defaultNextBytesSize = DEFAULT_NEXT_BYTES_SIZE;</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> this.secureRandom = new SecureRandom();</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> }</a> |
| <span class="sourceLineNo">051</span><a id="line.51"></a> |
| <span class="sourceLineNo">052</span><a id="line.52"> /**</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> * Seeds the backing {@link SecureRandom SecureRandom} instance with additional seed data.</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> *</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> * @param bytes the seed bytes</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> * @see SecureRandom#setSeed(byte[])</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> */</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> public void setSeed(byte[] bytes) {</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> this.secureRandom.setSeed(bytes);</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"> * Returns the {@link SecureRandom SecureRandom} backing this instance.</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> *</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> * @return the {@link SecureRandom SecureRandom} backing this instance.</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> */</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> public SecureRandom getSecureRandom() {</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> return secureRandom;</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> }</a> |
| <span class="sourceLineNo">070</span><a id="line.70"></a> |
| <span class="sourceLineNo">071</span><a id="line.71"> /**</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> * Sets the {@link SecureRandom SecureRandom} to back this instance.</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> *</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> * @param random the {@link SecureRandom SecureRandom} to back this instance.</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> * @throws NullPointerException if the method argument is null</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> */</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> public void setSecureRandom(SecureRandom random) throws NullPointerException {</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> if (random == null) {</a> |
| <span class="sourceLineNo">079</span><a id="line.79"> throw new NullPointerException("SecureRandom argument cannot be null.");</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> }</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> this.secureRandom = random;</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> }</a> |
| <span class="sourceLineNo">083</span><a id="line.83"></a> |
| <span class="sourceLineNo">084</span><a id="line.84"> /**</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> * Returns the size of the generated byte array for calls to {@link #nextBytes() nextBytes()}. Defaults to</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> * {@code 16}, which equals 128 bits, a size commonly used in cryptographic algorithms.</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> *</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> * @return the size of the generated byte array for calls to {@link #nextBytes() nextBytes()}.</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> */</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> public int getDefaultNextBytesSize() {</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> return defaultNextBytesSize;</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> }</a> |
| <span class="sourceLineNo">093</span><a id="line.93"></a> |
| <span class="sourceLineNo">094</span><a id="line.94"> /**</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> * Sets the size of the generated byte array for calls to {@link #nextBytes() nextBytes()}. Defaults to</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> * {@code 16}, which equals 128 bits, a size commonly used in cryptographic algorithms.</a> |
| <span class="sourceLineNo">097</span><a id="line.97"> *</a> |
| <span class="sourceLineNo">098</span><a id="line.98"> * @param defaultNextBytesSize the size of the generated byte array for calls to {@link #nextBytes() nextBytes()}.</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> * @throws IllegalArgumentException if the argument is 0 or negative</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> */</a> |
| <span class="sourceLineNo">101</span><a id="line.101"> public void setDefaultNextBytesSize(int defaultNextBytesSize) throws IllegalArgumentException {</a> |
| <span class="sourceLineNo">102</span><a id="line.102"> if ( defaultNextBytesSize <= 0) {</a> |
| <span class="sourceLineNo">103</span><a id="line.103"> throw new IllegalArgumentException("size value must be a positive integer (1 or larger)");</a> |
| <span class="sourceLineNo">104</span><a id="line.104"> }</a> |
| <span class="sourceLineNo">105</span><a id="line.105"> this.defaultNextBytesSize = defaultNextBytesSize;</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> }</a> |
| <span class="sourceLineNo">107</span><a id="line.107"></a> |
| <span class="sourceLineNo">108</span><a id="line.108"> public ByteSource nextBytes() {</a> |
| <span class="sourceLineNo">109</span><a id="line.109"> return nextBytes(getDefaultNextBytesSize());</a> |
| <span class="sourceLineNo">110</span><a id="line.110"> }</a> |
| <span class="sourceLineNo">111</span><a id="line.111"></a> |
| <span class="sourceLineNo">112</span><a id="line.112"> public ByteSource nextBytes(int numBytes) {</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> if (numBytes <= 0) {</a> |
| <span class="sourceLineNo">114</span><a id="line.114"> throw new IllegalArgumentException("numBytes argument must be a positive integer (1 or larger)");</a> |
| <span class="sourceLineNo">115</span><a id="line.115"> }</a> |
| <span class="sourceLineNo">116</span><a id="line.116"> byte[] bytes = new byte[numBytes];</a> |
| <span class="sourceLineNo">117</span><a id="line.117"> this.secureRandom.nextBytes(bytes);</a> |
| <span class="sourceLineNo">118</span><a id="line.118"> return ByteSource.Util.bytes(bytes);</a> |
| <span class="sourceLineNo">119</span><a id="line.119"> }</a> |
| <span class="sourceLineNo">120</span><a id="line.120">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
