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 gwt-commons-codec Show documentation

The Apache Commons Codec component contains encoders and decoders for various formats such as Base16, Base32, Base64, digest, and Hexadecimal. In addition to these widely used encoders and decoders, the codec package also maintains a collection of phonetic encoding utilities. This is a port for GWT, which enables program, to use Apache Commons Codec also in the frontend compiled by the gwt compiler to java-script.

There is a newer version: 1.17.1-1

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 supports all algorithms in this enum.
 * 
 *
 * @see Java Cryptography
 *      Architecture Standard Algorithm Name Documentation
 * @since 1.10
 * @version $Id: HmacAlgorithms.java 1634405 2014-10-26 23:07:26Z 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 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.
     * 
     * Every implementation of the Java platform is not required to support this Mac algorithm.
     * 
     */
    HMAC_SHA_384("HmacSHA384"),

    /**
     * The HmacSHA512 Message Authentication Code (MAC) algorithm specified in RFC 2104 and FIPS PUB 180-2.
     * 
     * Every implementation of the Java platform is not required to support this Mac algorithm.
     * 
     */
    HMAC_SHA_512("HmacSHA512");

    private final String algorithm;

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

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

}