| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> |
| <title>RandomNumberGenerator xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../apidocs/org/apache/shiro/crypto/RandomNumberGenerator.html">View Javadoc</a></div><pre> |
| |
| <a name="1" href="#1">1</a> <em class="jxr_comment">/*</em> |
| <a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> |
| <a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> |
| <a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> |
| <a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> |
| <a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> |
| <a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> |
| <a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> |
| <a name="9" href="#9">9</a> <em class="jxr_comment"> *</em> |
| <a name="10" href="#10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> |
| <a name="11" href="#11">11</a> <em class="jxr_comment"> *</em> |
| <a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> |
| <a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> |
| <a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> |
| <a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> |
| <a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> |
| <a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em> |
| <a name="18" href="#18">18</a> <em class="jxr_comment"> */</em> |
| <a name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.crypto; |
| <a name="20" href="#20">20</a> |
| <a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.ByteSource; |
| <a name="22" href="#22">22</a> |
| <a name="23" href="#23">23</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="24" href="#24">24</a> <em class="jxr_javadoccomment"> * A component that can generate random number/byte values as needed. Useful in cryptography or security scenarios</em> |
| <a name="25" href="#25">25</a> <em class="jxr_javadoccomment"> * where random byte arrays are needed, such as for password salts, nonces, initialization vectors and other seeds.</em> |
| <a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * This is essentially the same as a {@link java.security.SecureRandom SecureRandom}, and indeed implementations</em> |
| <a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * of this interface will probably all use {@link java.security.SecureRandom SecureRandom} instances, but this</em> |
| <a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * interface provides a few additional benefits to end-users:</em> |
| <a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * <ul></em> |
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * <li>It is an interface rather than the JDK's {@code SecureRandom} concrete implementation. Implementation details</em> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * can be customized as necessary based on the application's needs</li></em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * <li>Default per-instance behavior can be customized on implementations, typically via JavaBeans mutators.</li></em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * <li>Perhaps most important for Shiro end-users, tt can more easily be used as a source of cryptographic seed data,</em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * and the data returned is already in a more convenient {@link ByteSource ByteSource} format in case that data needs</em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * to be {@link org.apache.shiro.util.ByteSource#toHex() hex} or</em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.util.ByteSource#toBase64() base64}-encoded.</li></em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * </ul></em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * For example, consider the following example generating password salts for new user accounts:</em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * RandomNumberGenerator saltGenerator = new {@link org.apache.shiro.crypto.SecureRandomNumberGenerator SecureRandomNumberGenerator}();</em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * User user = new User();</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * user.setPasswordSalt(saltGenerator.nextBytes().toBase64());</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * userDAO.save(user);</em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * @since 1.1</em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="49" href="#49">49</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../org/apache/shiro/crypto/RandomNumberGenerator.html">RandomNumberGenerator</a> { |
| <a name="50" href="#50">50</a> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * Generates a byte array of fixed length filled with random data, often useful for generating salts,</em> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * initialization vectors or other seed data. The length is specified as a configuration</em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * value on the underlying implementation.</em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * If you'd like per-invocation control the number of bytes generated, use the</em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * {@link #nextBytes(int) nextBytes(int)} method instead.</em> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * @return a byte array of fixed length filled with random data.</em> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * @see #nextBytes(int)</em> |
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="62" href="#62">62</a> <a href="../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> nextBytes(); |
| <a name="63" href="#63">63</a> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * Generates a byte array of the specified length filled with random data.</em> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * @param numBytes the number of bytes to be populated with random data.</em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * @return a byte array of the specified length filled with random data.</em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * @see #nextBytes()</em> |
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="71" href="#71">71</a> <a href="../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> nextBytes(<strong class="jxr_keyword">int</strong> numBytes); |
| <a name="72" href="#72">72</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
