1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * https://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.commons.codec.digest;
19
20 import java.security.MessageDigest;
21
22 /**
23 * Standard {@link MessageDigest} algorithm names from the <cite>Java Cryptography Architecture Standard Algorithm Name
24 * Documentation</cite>.
25 * <p>
26 * This class is immutable and thread-safe.
27 * </p>
28 * <ul>
29 * <li>Java 8 and up: SHA-224.</li>
30 * <li>Java 9 and up: SHA3-224, SHA3-256, SHA3-384, SHA3-512.</li>
31 * </ul>
32 *
33 * @see <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#MessageDigest">
34 * Java 8 Cryptography Architecture Standard Algorithm Name Documentation</a>
35 * @see <a href="https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#messagedigest-algorithms">
36 * Java 11 Cryptography Architecture Standard Algorithm Name Documentation</a>
37 * @see <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/security/standard-names.html#messagedigest-algorithms">
38 * Java 17 Cryptography Architecture Standard Algorithm Name Documentation</a>
39 * @see <a href="https://docs.oracle.com/en/java/javase/21/docs/specs/security/standard-names.html#messagedigest-algorithms">
40 * Java 21 Cryptography Architecture Standard Algorithm Name Documentation</a>
41 * @see <a href="https://docs.oracle.com/en/java/javase/25/docs/specs/security/standard-names.html#messagedigest-algorithms">
42 * Java 25 Cryptography Architecture Standard Algorithm Name Documentation</a>
43 *
44 * @see <a href="https://dx.doi.org/10.6028/NIST.FIPS.180-4">FIPS PUB 180-4</a>
45 * @see <a href="https://dx.doi.org/10.6028/NIST.FIPS.202">FIPS PUB 202</a>
46 * @since 1.7
47 */
48 public class MessageDigestAlgorithms {
49
50 /**
51 * The MD2 message digest algorithm defined in RFC 1319.
52 */
53 public static final String MD2 = "MD2";
54
55 /**
56 * The MD5 message digest algorithm defined in RFC 1321.
57 */
58 public static final String MD5 = "MD5";
59
60 /**
61 * The SHA-1 hash algorithm defined in the FIPS PUB 180-2.
62 */
63 public static final String SHA_1 = "SHA-1";
64
65 /**
66 * The SHA-224 hash algorithm defined in the FIPS PUB 180-3.
67 * <p>
68 * Present in Oracle Java 8.
69 * </p>
70 *
71 * @since 1.11
72 */
73 public static final String SHA_224 = "SHA-224";
74
75 /**
76 * The SHA-256 hash algorithm defined in the FIPS PUB 180-2.
77 */
78 public static final String SHA_256 = "SHA-256";
79
80 /**
81 * The SHA-384 hash algorithm defined in the FIPS PUB 180-2.
82 */
83 public static final String SHA_384 = "SHA-384";
84
85 /**
86 * The SHA-512 hash algorithm defined in the FIPS PUB 180-2.
87 */
88 public static final String SHA_512 = "SHA-512";
89
90 /**
91 * The SHA-512 hash algorithm defined in the FIPS PUB 180-4.
92 * <p>
93 * Included starting in Oracle Java 9.
94 * </p>
95 *
96 * @since 1.14
97 */
98 public static final String SHA_512_224 = "SHA-512/224";
99
100 /**
101 * The SHA-512 hash algorithm defined in the FIPS PUB 180-4.
102 * <p>
103 * Included starting in Oracle Java 9.
104 * </p>
105 *
106 * @since 1.14
107 */
108 public static final String SHA_512_256 = "SHA-512/256";
109
110 /**
111 * The SHA3-224 hash algorithm defined in the <a href="https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.202.pdf">FIPS PUB 202</a>.
112 * <p>
113 * Included starting in Oracle Java 9.
114 * </p>
115 *
116 * @since 1.11
117 */
118 public static final String SHA3_224 = "SHA3-224";
119
120 /**
121 * The SHA3-256 hash algorithm defined in the <a href="https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.202.pdf">FIPS PUB 202</a>.
122 * <p>
123 * Included starting in Oracle Java 9.
124 * </p>
125 *
126 * @since 1.11
127 */
128 public static final String SHA3_256 = "SHA3-256";
129
130 /**
131 * The SHA3-384 hash algorithm defined in the <a href="https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.202.pdf">FIPS PUB 202</a>.
132 * <p>
133 * Included starting in Oracle Java 9.
134 * </p>
135 *
136 * @since 1.11
137 */
138 public static final String SHA3_384 = "SHA3-384";
139
140 /**
141 * The SHA3-512 hash algorithm defined in the <a href="https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.202.pdf">FIPS PUB 202</a>.
142 * <p>
143 * Included starting in Oracle Java 9.
144 * </p>
145 *
146 * @since 1.11
147 */
148 public static final String SHA3_512 = "SHA3-512";
149
150 /**
151 * The SHAKE128-256 hash algorithm defined in the <a href="https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.202.pdf">FIPS PUB 202</a>.
152 * <p>
153 * Included starting in Oracle Java 25.
154 * </p>
155 *
156 * @see <a href="https://docs.oracle.com/en/java/javase/25/docs/specs/security/standard-names.html#messagedigest-algorithms"> Java 25 Cryptography
157 * Architecture Standard Algorithm Name Documentation</a>
158 * @see <a href="https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.202.pdf">FIPS PUB 202 - SHA-3 Standard: Permutation-Based Hash and Extendable-Output
159 * Functions</a>
160 * @since 1.20.0
161 */
162 public static final String SHAKE128_256 = "SHAKE128-256";
163
164 /**
165 * The SHAKE128-512 hash algorithm defined in the <a href="https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.202.pdf">FIPS PUB 202</a>.
166 * <p>
167 * Included starting in Oracle Java 25.
168 * </p>
169 *
170 * @see <a href="https://docs.oracle.com/en/java/javase/25/docs/specs/security/standard-names.html#messagedigest-algorithms"> Java 25 Cryptography
171 * Architecture Standard Algorithm Name Documentation</a>
172 * @see <a href="https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.202.pdf">FIPS PUB 202 - SHA-3 Standard: Permutation-Based Hash and Extendable-Output
173 * Functions</a>
174 * @since 1.20.0
175 */
176 public static final String SHAKE256_512 = "SHAKE256-512";
177
178 /**
179 * Gets all constant values defined in this class.
180 *
181 * @return all constant values defined in this class.
182 * @since 1.11
183 */
184 public static String[] values() {
185 // Do not use a constant array here as that can be changed externally by accident or design
186 return new String[] { MD2, MD5, SHA_1, SHA_224, SHA_256, SHA_384, SHA_512, SHA_512_224, SHA_512_256, SHA3_224, SHA3_256, SHA3_384, SHA3_512,
187 SHAKE128_256, SHAKE256_512 };
188 }
189
190 private MessageDigestAlgorithms() {
191 // cannot be instantiated.
192 }
193
194 }