DigestUtils

1. /*
2. * Copyright 2001-2004 The Apache Software Foundation.
3. *
4. * Licensed under the Apache License, Version 2.0 (the "License");
5. * you may not use this file except in compliance with the License.
6. * You may obtain a copy of the License at
7. *
8. * http://www.apache.org/licenses/LICENSE-2.0
9. *
10. * Unless required by applicable law or agreed to in writing, software
11. * distributed under the License is distributed on an "AS IS" BASIS,
12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13. * See the License for the specific language governing permissions and
14. * limitations under the License.
15. */
17. package org1.apache.commons.codec.digest;
19. import java.security.MessageDigest;
20. import java.security.NoSuchAlgorithmException;
22. import org1.apache.commons.codec.binary.Hex;
24. /**
25. * Operations to simplifiy common {@link java.security.MessageDigest} tasks. This
26. * class is thread safe.
27. *
28. * @author Apache Software Foundation
29. */
30. public class DigestUtils{
32. /**
33. * Returns a MessageDigest for the given <code>algorithm</code>.
34. *
35. * @param algorithm The MessageDigest algorithm name.
36. * @return An MD5 digest instance.
37. * @throws RuntimeException when a {@link java.security.NoSuchAlgorithmException} is caught,
38. */
39. static MessageDigest getDigest(String algorithm){
40. try {
41. return MessageDigest.getInstance(algorithm);
42. } catch (NoSuchAlgorithmException e){
43. throw newRuntimeException(e.getMessage());
44. }
45. }
47. /**
48. * Returns an MD5 MessageDigest.
49. *
50. * @return An MD5 digest instance.
51. * @throws RuntimeException when a {@link java.security.NoSuchAlgorithmException} is caught,
52. */
53. private staticMessageDigest getMd5Digest(){
54. return getDigest("MD5");
55. }
57. /**
58. * Returns an SHA digest.
59. *
60. * @return An SHA digest instance.
61. * @throws RuntimeException when a {@link java.security.NoSuchAlgorithmException} is caught,
62. */
63. private staticMessageDigest getShaDigest(){
64. return getDigest("SHA");
65. }
67. /**
68. * Calculates the MD5 digest and returns the value as a 16 element
69. * <code>byte[]</code>.
70. *
71. * @param data Data to digest
72. * @return MD5 digest
73. */
74. public staticbyte[] md5(byte[] data) {
75. return getMd5Digest().digest(data);
76. }
78. /**
79. * Calculates the MD5 digest and returns the value as a 16 element
80. * <code>byte[]</code>.
81. *
82. * @param data Data to digest
83. * @return MD5 digest
84. */
85. public staticbyte[] md5(String data){
86. return md5(data.getBytes());
87. }
89. /**
90. * Calculates the MD5 digest and returns the value as a 32 character
91. * hex string.
92. *
93. * @param data Data to digest
94. * @return MD5 digest as a hex string
95. */
96. public staticString md5Hex(byte[] data){
97. return newString(Hex.encodeHex(md5(data)));
98. }
100. /**
101. * Calculates the MD5 digest and returns the value as a 32 character
102. * hex string.
103. *
104. * @param data Data to digest
105. * @return MD5 digest as a hex string
106. */
107. public staticString md5Hex(String data){
108. return newString(Hex.encodeHex(md5(data)));
109. }
111. /**
112. * Calculates the SHA digest and returns the value as a
113. * <code>byte[]</code>.
114. *
115. * @param data Data to digest
116. * @return SHA digest
117. */
118. public staticbyte[] sha(byte[] data) {
119. return getShaDigest().digest(data);
120. }
122. /**
123. * Calculates the SHA digest and returns the value as a
124. * <code>byte[]</code>.
125. *
126. * @param data Data to digest
127. * @return SHA digest
128. */
129. public staticbyte[] sha(String data){
130. return sha(data.getBytes());
131. }
133. /**
134. * Calculates the SHA digest and returns the value as a hex string.
135. *
136. * @param data Data to digest
137. * @return SHA digest as a hex string
138. */
139. public staticString shaHex(byte[] data){
140. return newString(Hex.encodeHex(sha(data)));
141. }
143. /**
144. * Calculates the SHA digest and returns the value as a hex string.
145. *
146. * @param data Data to digest
147. * @return SHA digest as a hex string
148. */
149. public staticString shaHex(String data){
150. return newString(Hex.encodeHex(sha(data)));
151. }
153. }