CryptoKey Features

Features of the xml.CryptoKey class.

Table 1. CryptoKey Features
Name Description

KeyName

See W3C KeyName specification for details.

Defines or returns whether a user-defined key name is added during a XML signature or encryption in order to identify it to other applications, or by the xml.key store.

The default value is NULL, meaning that no key name is used.

KeyValue

See W3C KeyValue specification for details.

Defines or returns whether the public part of the asymmetric key is added during a XML signature or encryption.

Only for RSA and DSA keys.

The default value is FALSE, meaning that no key value is used.

RetrievalMethod

See W3C RetrievalMethod specification for details.

Defines or returns the URL where the XML form of:

  • a DSA or RSA public key will be set during a XML signature, and loaded during a XML verification process.

  • a RSA public key will be set and used to encrypt a XML node during XML encryption

  • a symmetric key with encryption usage will be used to encrypt a XML node or decrypt it back

The default value is NULL, meaning that no retrieval method is used.

The XML form of a DSA or RSA public key can be obtained by the xml.CryptoKey.savePublic method.

The XML form of a symmetric key can be obtained by the xml.Encryption.encryptKey method.