javax.xml.crypto.dsig.keyinfo.KeyValue 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: KeyValue.java 1333869 2012-05-04 10:42:44Z coheigea $
*/
package javax.xml.crypto.dsig.keyinfo;
import java.security.KeyException;
import java.security.PublicKey;
import java.security.interfaces.DSAPublicKey;
import java.security.interfaces.RSAPublicKey;
import javax.xml.crypto.XMLStructure;
/**
* A representation of the XML KeyValue element as defined
* in the
* W3C Recommendation for XML-Signature Syntax and Processing. A
* KeyValue object contains a single public key that may be
* useful in validating the signature. The XML schema definition is defined as:
*
*
* <element name="KeyValue" type="ds:KeyValueType"/>
* <complexType name="KeyValueType" mixed="true">
* <choice>
* <element ref="ds:DSAKeyValue"/>
* <element ref="ds:RSAKeyValue"/>
* <any namespace="##other" processContents="lax"/>
* </choice>
* </complexType>
*
* <element name="DSAKeyValue" type="ds:DSAKeyValueType"/>
* <complexType name="DSAKeyValueType">
* <sequence>
* <sequence minOccurs="0">
* <element name="P" type="ds:CryptoBinary"/>
* <element name="Q" type="ds:CryptoBinary"/>
* </sequence>
* <element name="G" type="ds:CryptoBinary" minOccurs="0"/>
* <element name="Y" type="ds:CryptoBinary"/>
* <element name="J" type="ds:CryptoBinary" minOccurs="0"/>
* <sequence minOccurs="0">
* <element name="Seed" type="ds:CryptoBinary"/>
* <element name="PgenCounter" type="ds:CryptoBinary"/>
* </sequence>
* </sequence>
* </complexType>
*
* <element name="RSAKeyValue" type="ds:RSAKeyValueType"/>
* <complexType name="RSAKeyValueType">
* <sequence>
* <element name="Modulus" type="ds:CryptoBinary"/>
* <element name="Exponent" type="ds:CryptoBinary"/>
* </sequence>
* </complexType>
*
* A KeyValue instance may be created by invoking the
* {@link KeyInfoFactory#newKeyValue newKeyValue} method of the
* {@link KeyInfoFactory} class, and passing it a {@link
* java.security.PublicKey} representing the value of the public key. Here is
* an example of creating a KeyValue from a {@link DSAPublicKey}
* of a {@link java.security.cert.Certificate} stored in a
* {@link java.security.KeyStore}:
*
* KeyStore keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
* PublicKey dsaPublicKey = keyStore.getCertificate("myDSASigningCert").getPublicKey();
* KeyInfoFactory factory = KeyInfoFactory.getInstance("DOM");
* KeyValue keyValue = factory.newKeyValue(dsaPublicKey);
*
*
* This class returns the DSAKeyValue and
* RSAKeyValue elements as objects of type
* {@link DSAPublicKey} and {@link RSAPublicKey}, respectively. Note that not
* all of the fields in the schema are accessible as parameters of these
* types.
*
* @author Sean Mullan
* @author JSR 105 Expert Group
* @see KeyInfoFactory#newKeyValue(PublicKey)
*/
public interface KeyValue extends XMLStructure {
/**
* URI identifying the DSA KeyValue KeyInfo type:
* http://www.w3.org/2000/09/xmldsig#DSAKeyValue. This can be specified as
* the value of the type parameter of the
* {@link RetrievalMethod} class to describe a remote
* DSAKeyValue structure.
*/
String DSA_TYPE =
"http://www.w3.org/2000/09/xmldsig#DSAKeyValue";
/**
* URI identifying the RSA KeyValue KeyInfo type:
* http://www.w3.org/2000/09/xmldsig#RSAKeyValue. This can be specified as
* the value of the type parameter of the
* {@link RetrievalMethod} class to describe a remote
* RSAKeyValue structure.
*/
String RSA_TYPE =
"http://www.w3.org/2000/09/xmldsig#RSAKeyValue";
/**
* Returns the public key of this KeyValue.
*
* @return the public key of this KeyValue
* @throws KeyException if this KeyValue cannot be converted
* to a PublicKey
*/
PublicKey getPublicKey() throws KeyException;
}