#include <XENCEncryptedType.hpp>
Inheritance diagram for XENCEncryptedType:
The <EncryptedType> element is an abstract type on which EncryptedData and EncryptedKey objects are built.
This is the base class on which most of the XML Encryption standard is built. Using classes derived from this, calling programs can decrypt the content, determine KeyInfo references etc.
In general derived objects should not be used directly. The XENCCipher class should be used to operate on them.
The schema definition for EncryptedType is as follows :
<complexType name='EncryptedType' abstract='true'> <sequence> <element name='EncryptionMethod' type='xenc:EncryptionMethodType' minOccurs='0'/> <element ref='ds:KeyInfo' minOccurs='0'/> <element ref='xenc:CipherData'/> <element ref='xenc:EncryptionProperties' minOccurs='0'/> </sequence> <attribute name='Id' type='ID' use='optional'/> <attribute name='Type' type='anyURI' use='optional'/> <attribute name='MimeType' type='string' use='optional'/> <attribute name='Encoding' type='anyURI' use='optional'/> </complexType>
Constructors and Destructors | |
virtual | ~XENCEncryptedType () |
XENCEncryptedType () | |
Public Member Functions | |
Basic Interface Methods | |
virtual XENCCipherData * | getCipherData (void) const =0 |
Retrieve the CipherData element. | |
virtual XENCEncryptionMethod * | getEncryptionMethod (void) const =0 |
Retrieve the EncryptionMethod element. | |
virtual XERCES_CPP_NAMESPACE_QUALIFIER DOMElement * | getElement (void) const =0 |
Get the DOM Element Node of this structure. | |
Getter interface Methods | |
virtual const XMLCh * | getType (void) const =0 |
Get the Type URI for the EncryptedType. | |
virtual const XMLCh * | getMimeType (void) const =0 |
Get the MimeType of the EncryptedType. | |
virtual const XMLCh * | getEncoding (void) const =0 |
Get the Encoding of the EncryptedType. | |
Setter interface methods | |
virtual void | setType (const XMLCh *uri)=0 |
Set the Type URI for the EncryptedType. | |
virtual void | setMimeType (const XMLCh *mimeType)=0 |
Set the MimeType of the EncryptedType. | |
virtual void | setEncoding (const XMLCh *uri)=0 |
Set the Encoding of the EncryptedType. | |
KeyInfo Element Manipulation | |
virtual DSIGKeyInfoList * | getKeyInfoList (void)=0 |
Get the list of <KeyInfo> elements. | |
virtual void | clearKeyInfo (void)=0 |
Clear out all KeyInfo elements in the signature. | |
virtual DSIGKeyInfoValue * | appendDSAKeyValue (const XMLCh *P, const XMLCh *Q, const XMLCh *G, const XMLCh *Y)=0 |
Append a DSA KeyValue element. | |
virtual DSIGKeyInfoValue * | appendRSAKeyValue (const XMLCh *modulus, const XMLCh *exponent)=0 |
Append a RSA KeyValue element. | |
virtual DSIGKeyInfoX509 * | appendX509Data (void)=0 |
Append a X509Data element. | |
virtual DSIGKeyInfoName * | appendKeyName (const XMLCh *name, bool isDName=false)=0 |
Append a KeyName element. | |
virtual void | appendEncryptedKey (XENCEncryptedKey *encryptedKey)=0 |
Append an already created EncryptedKey. |
|
|
|
|
|
Append a DSA KeyValue element. Add a new KeyInfo element for a DSA Value
|
|
Append an already created EncryptedKey. Add an already created EncryptedKey.
|
|
Append a KeyName element. Add a new KeyInfo element for a key name.
|
|
Append a RSA KeyValue element. Add a new KeyInfo element for a RSA Value
|
|
Append a X509Data element. Add a new KeyInfo element for X509 data.
|
|
Clear out all KeyInfo elements in the signature. This function will delete all KeyInfo elements from both the EncryptedType object and the associated DOM. |
|
Retrieve the CipherData element. CipherData elements are the sub part of the EncryptedData that hold the actual enciphered information.
|
|
Get the DOM Element Node of this structure.
|
|
Get the Encoding of the EncryptedType. If this object is an EncryptedData, it may have an encoding attribute that describes how the data has been encoded prior to encryption. (E.g. http://www.w3.org/2000/09/xmldsig#base64) The XML-Security-C library makes no use of this attribute, but it provides these functions to allow applications to set and get.
|
|
Retrieve the EncryptionMethod element. The EncryptionMethod element holds information about the encryption algorithm to be used to encrypt/decrypt the data This method provides a means to extract the EncryptionMethod element from the EncryptedType
|
|
Get the list of <KeyInfo> elements. This function recovers list that contains the KeyInfo elements read in from the DOM document. This list should be used by calling applications to determine what key is appropriate for decrypting the document.
|
|
Get the MimeType of the EncryptedType. If this object is an EncryptedData, it may have a MimeType attribute that "describes the media type of the data which has been encrypted" (from the XML Encryption spec). The XML-Security-C library makes no use of this attribute, but it provides these functions to allow applications to set and get.
|
|
Get the Type URI for the EncryptedType. If this object is an EncryptedData, it may have a Type attribute that defines whether it is an encrypted Element or Element Content. This method allows the caller to see this type URI.
|
|
Set the Encoding of the EncryptedType. If this object is an EncryptedData, it may have an encoding attribute that describes how the data has been encoded prior to encryption. (E.g. http://www.w3.org/2000/09/xmldsig#base64) The XML-Security-C library makes no use of this attribute, but it provides these functions to allow applications to set and get.
|
|
Set the MimeType of the EncryptedType. If this object is an EncryptedData, it may have a MimeType attribute that "describes the media type of the data which has been encrypted" (from the XML Encryption spec). The XML-Security-C library makes no use of this attribute, but it provides these functions to allow applications to set and get.
|
|
Set the Type URI for the EncryptedType. Allows a calling application to set a particular Type URI for the EncryptedType.
|