View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.shiro.crypto.hash;
20  
21  import org.apache.shiro.codec.Base64;
22  import org.apache.shiro.codec.Hex;
23  
24  /**
25   * Generates an SHA-256 Hash from a given input <tt>source</tt> with an optional <tt>salt</tt> and hash iterations.
26   * <p/>
27   * See the {@link SimpleHash SimpleHash} parent class JavaDoc for a detailed explanation of Hashing
28   * techniques and how the overloaded constructors function.
29   * <p/>
30   * <b>JDK Version Note</b> - Attempting to instantiate this class on JREs prior to version 1.4.0 will throw
31   * an {@link IllegalStateException IllegalStateException}
32   *
33   * @since 0.9
34   */
35  public class Sha256Hash extends SimpleHash {
36  
37      //TODO - complete JavaDoc
38  
39      public static final String ALGORITHM_NAME = "SHA-256";
40  
41      public Sha256Hash() {
42          super(ALGORITHM_NAME);
43      }
44  
45      public Sha256Hash(Object source) {
46          super(ALGORITHM_NAME, source);
47      }
48  
49      public Sha256Hash(Object source, Object salt) {
50          super(ALGORITHM_NAME, source, salt);
51      }
52  
53      public Sha256Hash(Object source, Object salt, int hashIterations) {
54          super(ALGORITHM_NAME, source, salt, hashIterations);
55      }
56  
57      public static Sha256Hash fromHexString(String hex) {
58          Sha256Hash hash = new Sha256Hash();
59          hash.setBytes(Hex.decode(hex));
60          return hash;
61      }
62  
63      public static Sha256Hash fromBase64String(String base64) {
64          Sha256Hash hash = new Sha256Hash();
65          hash.setBytes(Base64.decode(base64));
66          return hash;
67      }
68  }