javax.xml.crypto.dsig.spec.HMACParameterSpec Maven / Gradle / Ivy
/**
* 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.
*/
/*
* Copyright 2005 Sun Microsystems, Inc. All rights reserved.
*/
/*
* $Id: HMACParameterSpec.java 1092655 2011-04-15 10:24:18Z coheigea $
*/
package javax.xml.crypto.dsig.spec;
import javax.xml.crypto.dsig.SignatureMethod;
/**
* Parameters for the
* XML Signature HMAC Algorithm. The parameters include an optional output
* length which specifies the MAC truncation length in bits. The resulting
* HMAC will be truncated to the specified number of bits. If the parameter is
* not specified, then this implies that all the bits of the hash are to be
* output. The XML Schema Definition of the HMACOutputLength
* element is defined as:
*
* <element name="HMACOutputLength" minOccurs="0" type="ds:HMACOutputLengthType"/>
* <simpleType name="HMACOutputLengthType">
* <restriction base="integer"/>
* </simpleType>
*
*
* @author Sean Mullan
* @author JSR 105 Expert Group
* @see SignatureMethod
* @see RFC 2104
*/
public final class HMACParameterSpec implements SignatureMethodParameterSpec {
private int outputLength;
/**
* Creates an HMACParameterSpec with the specified truncation
* length.
*
* @param outputLength the truncation length in number of bits
*/
public HMACParameterSpec(int outputLength) {
this.outputLength = outputLength;
}
/**
* Returns the truncation length.
*
* @return the truncation length in number of bits
*/
public int getOutputLength() {
return outputLength;
}
}