javax.xml.crypto.dsig.keyinfo
Interface KeyValue
All Superinterfaces:
- public interface KeyValue
- extends XMLStructure
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
newKeyValue method of the
KeyInfoFactory class, and passing it a PublicKey representing the value of the public key. Here is
an example of creating a KeyValue from a DSAPublicKey
of a Certificate stored in a
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
DSAPublicKey and RSAPublicKey, respectively. Note that not
all of the fields in the schema are accessible as parameters of these
types.
See Also:
Field Summary
| Modifier and Type | Field and Description |
|---|---|
|
DSA_TYPE
URI identifying the DSA KeyValue KeyInfo type:
http://www.w3.org/2000/09/xmldsig#DSAKeyValue.
|
|
RSA_TYPE
URI identifying the RSA KeyValue KeyInfo type:
http://www.w3.org/2000/09/xmldsig#RSAKeyValue.
|
Method Summary
| Modifier and Type | Method and Description |
|---|---|
|
getPublicKey()
Returns the public key of this
KeyValue.
|
| Methods inherited from interface javax.xml.crypto.XMLStructure |
|---|
isFeatureSupported |
Field Detail
DSA_TYPE
- static final java.lang.String DSA_TYPE
See Also:
RSA_TYPE
- static final java.lang.String RSA_TYPE
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
RetrievalMethod class to describe a remote
RSAKeyValue structure.
See Also:
Method Detail
getPublicKey
- java.security.PublicKey getPublicKey( )
- throws java.security.KeyException
Returns the public key of this
KeyValue.
Returns:
the public key of this
KeyValue Throws:
java.security.KeyException - if this KeyValue cannot be converted
to a PublicKey
typeparameter of theRetrievalMethodclass to describe a remoteDSAKeyValuestructure.