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 MD5 Hash (RFC 1321) from a given input <tt>source</tt> with an optional <tt>salt</tt> and
26   * hash iterations.
27   * <p/>
28   * See the {@link SimpleHash SimpleHash} parent class JavaDoc for a detailed explanation of Hashing
29   * techniques and how the overloaded constructors function.
30   *
31   * @since 0.9
32   */
33  public class Md5Hash extends SimpleHash {
34  
35      //TODO - complete JavaDoc
36  
37      public static final String ALGORITHM_NAME = "MD5";
38  
39      public Md5Hash() {
40          super(ALGORITHM_NAME);
41      }
42  
43      public Md5Hash(Object source) {
44          super(ALGORITHM_NAME, source);
45      }
46  
47      public Md5Hash(Object source, Object salt) {
48          super(ALGORITHM_NAME, source, salt);
49      }
50  
51      public Md5Hash(Object source, Object salt, int hashIterations) {
52          super(ALGORITHM_NAME, source, salt, hashIterations);
53      }
54  
55      public static Md5Hash fromHexString(String hex) {
56          Md5Hash hash = new Md5Hash();
57          hash.setBytes(Hex.decode(hex));
58          return hash;
59      }
60  
61      public static Md5Hash fromBase64String(String base64) {
62          Md5Hash hash = new Md5Hash();
63          hash.setBytes(Base64.decode(base64));
64          return hash;
65      }
66  }