org.apache.commons.codec.digest.HmacAlgorithms Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wildfly-client-all

This artifact provides a single jar that contains all classes required to use remote Jakarta Enterprise Beans and Jakarta Messaging, including all dependencies. It is intended for use by those not using maven, maven users should just import the Jakarta Enterprise Beans and Jakarta Messaging BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up with different versions on classes on the class path).

There is a newer version: 35.0.0.Beta1

Show newest version

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.commons.codec.digest;

/**
 * Standard {@link HmacUtils} algorithm names from the Java Cryptography Architecture Standard Algorithm Name
 * Documentation.
 *
 * 
 * Note: Not all JCE implementations support all the algorithms in this enum.
 * 
 *
 * @see  Java
 *      6 Cryptography Architecture Sun Providers Documentation
 * @see  Java
 *      7 Cryptography Architecture Sun Providers Documentation
 * @see  Java
 *      8 Cryptography Architecture Sun Providers Documentation
 * @see 
 *      Java 9 Cryptography Architecture Sun Providers Documentation
 * @since 1.10
 * @version $Id: HmacAlgorithms.java 1811624 2017-10-09 23:07:49Z ggregory $
 */
public enum HmacAlgorithms {

    /**
     * The HmacMD5 Message Authentication Code (MAC) algorithm specified in RFC 2104 and RFC 1321.
     * 
     * Every implementation of the Java platform is required to support this standard MAC algorithm.
     * 
     */
    HMAC_MD5("HmacMD5"),

    /**
     * The HmacSHA1 Message Authentication Code (MAC) algorithm specified in RFC 2104 and FIPS PUB 180-2.
     * 
     * Every implementation of the Java platform is required to support this standard MAC algorithm.
     * 
     */
    HMAC_SHA_1("HmacSHA1"),

    /**
     * The HmacSHA224 Message Authentication Code (MAC) algorithm specified in RFC 2104 and FIPS PUB 180-2.
     * 
     * Every implementation of the Java 8+ platform is required to support this standard MAC algorithm.
     * 
     * @since 1.11
     */
    HMAC_SHA_224("HmacSHA224"),

    /**
     * The HmacSHA256 Message Authentication Code (MAC) algorithm specified in RFC 2104 and FIPS PUB 180-2.
     * 
     * Every implementation of the Java platform is required to support this standard MAC algorithm.
     * 
     */
    HMAC_SHA_256("HmacSHA256"),

    /**
     * The HmacSHA384 Message Authentication Code (MAC) algorithm specified in RFC 2104 and FIPS PUB 180-2.
     * 
     * This MAC algorithm is optional; not all implementations support it.
     * 
     */
    HMAC_SHA_384("HmacSHA384"),

    /**
     * The HmacSHA512 Message Authentication Code (MAC) algorithm specified in RFC 2104 and FIPS PUB 180-2.
     * 
     * This MAC algorithm is optional; not all implementations support it.
     * 
     */
    HMAC_SHA_512("HmacSHA512");

    private final String name;

    private HmacAlgorithms(final String algorithm) {
        this.name = algorithm;
    }

    /**
     * Gets the algorithm name.
     *
     * @return the algorithm name.
     * @since 1.11
     */
    public String getName() {
        return name;
    }

    /**
     * The algorithm name
     *
     * @see 
     *      Java 6 Cryptography Architecture Sun Providers Documentation
     * @see 
     *      Java 7 Cryptography Architecture Sun Providers Documentation
     * @see 
     *      Java 8 Cryptography Architecture Sun Providers Documentation
     * @see 
     *      Java 9 Cryptography Architecture Sun Providers Documentation
     * @return The algorithm name ("HmacSHA512" for example)
     */
    @Override
    public String toString() {
        return name;
    }

}