View Javadoc
1   /**
2    * This file Copyright (c) 2003-2018 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.cms.security;
35  
36  import java.security.NoSuchAlgorithmException;
37  
38  import org.slf4j.Logger;
39  import org.slf4j.LoggerFactory;
40  
41  
42  /**
43   * Encryption helper.
44   *
45   * Supported algorithm:
46   * <ul>
47   * <li>SHA-1 </li>
48   * <li>MD5 </li>
49   * </ul>
50   * Future:
51   * <ul>
52   * <li>SHA-256 </li>
53   * <li>SHA-384 </li>
54   * <li>SHA-512 </li>
55   * </ul>
56   *
57   * @deprecated since 4.5.3 - use SecurityUtil instead.
58   */
59  @Deprecated
60  public final class Digester {
61  
62      public static final String SHA1 = "SHA-1";
63  
64      public static final String MD5 = "MD5";
65  
66      /**
67       * There are five (5) FIPS-approved* algorithms for generating a condensed representation of a message (message
68       * digest): SHA-1, SHA-224, SHA-256,SHA-384, and SHA-512. <strong>Not supported yet </strong>
69       */
70      public static final String SHA256 = "SHA-256";
71  
72      public static final String SHA384 = "SHA-384";
73  
74      public static final String SHA512 = "SHA-512";
75  
76      private static Logger log = LoggerFactory.getLogger(Digester.class);
77  
78      /**
79       * Utility class, don't instantiate.
80       */
81      private Digester() {
82          // unused
83      }
84  
85      public static String getDigest(String data, String algorithm) throws NoSuchAlgorithmException {
86          return SecurityUtil.getDigest(data, algorithm);
87      }
88  
89      public static byte[] getDigest(byte[] data, String algorithm) throws NoSuchAlgorithmException {
90          return SecurityUtil.getDigest(data, algorithm);
91      }
92  
93      /**
94       * Gets SHA-1 encoded -> hex string.
95       */
96      public static String getSHA1Hex(String data) {
97          return SecurityUtil.getSHA1Hex(data);
98      }
99  
100     /**
101      * Gets MD5 encoded -> hex string.
102      */
103     public static String getMD5Hex(String data) {
104         return SecurityUtil.getMD5Hex(data);
105     }
106 
107     /**
108      * Converts a byte array to a string Hex.
109      *
110      * @param data to be converted
111      * @return string representing hex values of the byte array
112      */
113     public static String toHEX(String data) {
114         return toHEX(data.getBytes());
115     }
116 
117     /**
118      * Converts a byte array to a string Hex.
119      *
120      * @param data to be converted
121      * @return string representing hex values of the byte array
122      */
123     public static String toHEX(byte[] data) {
124         return SecurityUtil.byteArrayToHex(data);
125     }
126 
127     public static String getBCrypt(String text) {
128         return SecurityUtil.getBCrypt(text);
129     }
130 
131     public static boolean matchBCrypted(String candidate, String hash) {
132         return SecurityUtil.matchBCrypted(candidate, hash);
133     }
134 }