| <!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">/**</a> |
| <span class="sourceLineNo">024</span><a id="line.24"> * A component that can generate random number/byte values as needed. Useful in cryptography or security scenarios</a> |
| <span class="sourceLineNo">025</span><a id="line.25"> * where random byte arrays are needed, such as for password salts, nonces, initialization vectors and other seeds.</a> |
| <span class="sourceLineNo">026</span><a id="line.26"> * <p/></a> |
| <span class="sourceLineNo">027</span><a id="line.27"> * This is essentially the same as a {@link java.security.SecureRandom SecureRandom}, and indeed implementations</a> |
| <span class="sourceLineNo">028</span><a id="line.28"> * of this interface will probably all use {@link java.security.SecureRandom SecureRandom} instances, but this</a> |
| <span class="sourceLineNo">029</span><a id="line.29"> * interface provides a few additional benefits to end-users:</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> * <ul></a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * <li>It is an interface rather than the JDK's {@code SecureRandom} concrete implementation. Implementation details</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * can be customized as necessary based on the application's needs</li></a> |
| <span class="sourceLineNo">033</span><a id="line.33"> * <li>Default per-instance behavior can be customized on implementations, typically via JavaBeans mutators.</li></a> |
| <span class="sourceLineNo">034</span><a id="line.34"> * <li>Perhaps most important for Shiro end-users, tt can more easily be used as a source of cryptographic seed data,</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * and the data returned is already in a more convenient {@link ByteSource ByteSource} format in case that data needs</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * to be {@link org.apache.shiro.util.ByteSource#toHex() hex} or</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * {@link org.apache.shiro.util.ByteSource#toBase64() base64}-encoded.</li></a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * </ul></a> |
| <span class="sourceLineNo">039</span><a id="line.39"> * For example, consider the following example generating password salts for new user accounts:</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> * <pre></a> |
| <span class="sourceLineNo">041</span><a id="line.41"> * RandomNumberGenerator saltGenerator = new {@link org.apache.shiro.crypto.SecureRandomNumberGenerator SecureRandomNumberGenerator}();</a> |
| <span class="sourceLineNo">042</span><a id="line.42"> * User user = new User();</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> * user.setPasswordSalt(saltGenerator.nextBytes().toBase64());</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> * userDAO.save(user);</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> * </pre></a> |
| <span class="sourceLineNo">046</span><a id="line.46"> *</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> * @since 1.1</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> */</a> |
| <span class="sourceLineNo">049</span><a id="line.49">public interface RandomNumberGenerator {</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"> * Generates a byte array of fixed length filled with random data, often useful for generating salts,</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> * initialization vectors or other seed data. The length is specified as a configuration</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> * value on the underlying implementation.</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> * <p/></a> |
| <span class="sourceLineNo">056</span><a id="line.56"> * If you'd like per-invocation control the number of bytes generated, use the</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> * {@link #nextBytes(int) nextBytes(int)} method instead.</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> *</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> * @return a byte array of fixed length filled with random data.</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> * @see #nextBytes(int)</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> */</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> ByteSource nextBytes();</a> |
| <span class="sourceLineNo">063</span><a id="line.63"></a> |
| <span class="sourceLineNo">064</span><a id="line.64"> /**</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> * Generates a byte array of the specified length filled with random data.</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> *</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> * @param numBytes the number of bytes to be populated with random data.</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> * @return a byte array of the specified length filled with random data.</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> * @see #nextBytes()</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> */</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> ByteSource nextBytes(int numBytes);</a> |
| <span class="sourceLineNo">072</span><a id="line.72">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
