Discuss this help topic in SecureBlackbox Forum

XMLBlackbox package

XMLBlackbox includes the components and functions, related to XML security, including SOAP security.

XMLBlackbox includes classes that let you sign, encrypt, timestamp, decrypt and verify the XML documents or their parts using X.509 certificates or OpenPGP keys. Security operations are conformant to XMLDSig, XMLEnc and XAdES specifications.

SOAP security includes options to sign and verify SOAP messages and to send SOAP requests and receive SOAP responses.

Besides XML support, XMLBlackbox also includes OpenPGPBlackbox to perform OpenPGP operations.

XMLBlackbox includes the following SOAP components:

Component/class name Summary TElXMLEncryptor This class performs encryption of XML nodes or documents. TElXMLDecryptor This class performs decryption of XML nodes or documents. TElXMLSigner This component provides a simple interface to digitally sign XML data. TElXMLVerifier This component provides a simple interface to verify the digitally signed XML data. TElXAdESSigner This class is used for signing documents with XML Advanced Electronic Signatures (XAdES). TElXAdESVerifier This class is used for verifying XML Advanced Electronic Signatures (XAdES). TElXMLDOMDocument This class represents an XML document node.

SOAP security components included with XMLBlackbox are:

Component/class name Summary TElXMLSOAPClient This high-level class lets you secure and send SOAP requests and handle SOAP responses using HTTPS protocol TElXMLSOAPMessage This high-level class lets you sign SOAP messages and responses and validate signatures of signed SOAP messages and responses

Supplementary XML security classes included into XMLBlackbox are

Class name Summary XML Charsets TElXMLCodec Represents an encoding processor for XML parser and writer. TElXML8BitCodec Represents an encoding processor for 8-bit encodings. TElXMLUnicodeCodec Represents an encoding processor for UTF-16 (Unicode 16-bit) encoding. TElXMLUTF8Codec Represents an encoding processor for UTF-8 encoding. XML Document Object Model TElXMLDOMAttr Represents a single attribute of the XML element. TElXMLDOMCDATASection Represents a data XML node. TElXMLDOMCharacterData Represents an XML node which contains character data. TElXMLDOMComment Represents an XML comment. TElXMLDOMDocumentType Contains information about the type of an XML document. TElXMLDOMDocumentFragment Represents a lightweight object that is useful for tree insert operations. TElXMLDOMElement Represents a single XML element. TElXMLDOMEntity Represents an entity declaration: <!ENTITY ... >. TElXMLDOMEntityReference Represents an entity reference node. TElXMLDOMNamedNodeMap Represents a collection of nodes that can be accessed by name or index. TElXMLDOMNode Represents an abstract XML node. TElXMLDOMNodeList Represents a list of XML nodes (XML tags). TElXMLDOMNotation represents a notation declaration: <!NOTATION ... >. TElXMLDOMProcessingInstruction Represents a processing instruction as defined by Document Object Model specification. TElXMLDOMText Represents a text XML node. XML Security Supplementary Classes TElXMLBase64Transform Performs Base64 encoding of the XML node. TElXMLBinaryDecryptionTransform Performs an XML decryption transform in the binary mode as it is specified in the W3C Recommendation "Decryption Transform for XML Signature". TElXMLC14NTransform Performs canonicalization of the XML node according to XML-Signature Syntax and Processing specification. TElXMLCipherData Contains CipherData XML element. TElXMLCipherReference Contains CipherReference XML element. TElXMLCustomDecryptionTransform The base class for XML decryption transforms. TElXMLCustomElement The base class for all XML elements. TElXMLDecryptionExcept This element identifies the input-node elements which should not be processed by the decryption transform. TElXMLDecryptionTransform Performs an XML decryption transform in the XML mode. TElXMLEncryptedData This class is a holder of the XML information about encrypted data. TElXMLEncryptedKey This class is a holder of the XML information about encrypted key. TElXMLEncryptedType Implements common functionality and is a base class for TElXMLEncryptedData and TElXMLEncryptedKey. TElXMLEncryptionMethodType Represents contents of EncryptionMethod XML element. TElXMLEncryptionProperties Provides functionality to store and manage the list of XML properties. TElXMLEnvelopedSignatureTransform Excludes the enveloped signature from the XML node. TElXMLKeyInfo Represents a KeyInfo XML element, which contains information about the encryption key. TElXMLKeyInfoData The base class for all classes, that describe a key for XML encryption. TElXMLKeyInfoDSAData This class is a container for DSA keypair. TElXMLKeyInfoHMACData This class is a container for HMAC key. TElXMLKeyInfoItem This abstract class represents an item in a KeyInfo XML element. TElXMLKeyInfoNode Contains additional data, which may appear in KeyInfo XML element. TElXMLKeyInfoPGPData This class is a container for PGP key pair. TElXMLKeyInfoRetrievalMethod Represents RetrievalMethod XML element. TElXMLKeyInfoRSAData This class is a container for RSA keypair. TElXMLKeyInfoSymmetricData This class is a container for symmetric key. TElXMLKeyInfoX509Data This class is a container for X.509 certificate. TElXMLManifest This class is a placeholder for information about manifest (see XMLDSIG specification for details). TElXMLNamespaceMap Represents a namespace map for the XPath expression. TElXMLProperties Provides functionality to store and manage a list of XML properties. TElXMLProperty Represents a single XML property. TElXMLReference Specifies a digest algorithm and digest value, and optionally an identifier of the object being signed, the type of the object, and/or a list of transforms to be applied prior to digesting. TElXMLReferenceList Provides functionality to store and manage a list of XMLReference elements. TElXMLTransform The base class for specific XML transformation classes. TElXMLTransformChain Contains the list of XML transforms. TElXMLXPathTransform This transform performs XPath filtering. XAdES TElXMLSignature This class is a representation of the Signature XML node as defined in XML-Signature Syntax and Processing specification. TElXMLAdESElement Represents a basic element of the XML Advanced Electronic Signature (XAdES). TElXMLAnyType The AnyType element represents an arbitrary XML element of unrestricted length. TElXMLAnyTypeList Provides functionality to store and manage a list of AnyType XML elements. TElXMLCertID The CertID element identifies a certificate. TElXMLCertIDList Provides functionality to store and manage a list of CertID XML elements. TElXMLGenericTimestamp Represents a base container type for timestamp tokens. TElXMLGenericTimestampList Provides functionality to store and manage a list of generic timestamps. TElXMLQualifyingPropertiesReference QualifyingPropertiesReference element contains information about a QualifyingProperties element that is stored in place different from the signature. TElXMLQualifyingPropertiesReferenceList Provides functionality to store and manage a list of QualifyingPropertiesReference XML elements. TElXMLQualifyingProperties The QualifyingProperties element acts as a container element for all the qualifying information that should be added to an XML signature. TElXMLSignedProperties The SignedProperties element contains a number of properties that are collectively signed by the [XMLDSIG] signature. TElXMLUnsignedProperties The UnsignedProperties element contains a number of properties that are not signed by the [XMLDSIG] signature. TElXMLSignedSignatureProperties The SignedSignatureProperties element contains properties that qualify the XML signature itself or the signer. TElXMLSignedDataObjectProperties The SignedDataObjectProperties element contains properties that qualify some of the signed data objects. TElXMLUnsignedSignatureProperties The UnsignedSignatureProperties element contains properties that qualify the XML signature, and are not covered by the signature. TElXMLSignaturePolicyIdentifier This element contins the identifier of the policy, under which the signature was issued. TElXMLSignaturePolicyId This element contains unique identifier, hash algorithm and hash value, and some additional information related to the signature policy. TElXMLSignatureProductionPlace The SignatureProductionPlace XML property serves to identify the place, where the signature was created. TElXMLSignerRole The SignerRole element identifies the role (i.e., the position in a company or organization) of the signer. TElXMLCustomTimestamp The base class for all XML timestamps. TElXMLCustomTimestampList Provides functionality to store and manage a list of XML timestamps. TElXMLTimestamp This element represents the timestamps which are used with XML Advanced Electronic Signatures (XAdES). TElXMLTimestampList Provides functionality to store and manage a list of TElXMLTimestamp elements. TElXMLObjectIdentifier Identifies a particular data object in XAdES. TElXMLDigestAlgAndValue The DigestAlgAndValue element contains a digest value computed on some data set and specifies the digest algorithm. TElXMLIssuerSerial The IssuerSerial element contains the identifier of one of the certificates referenced in the sequence of the SigningCertificate element. TElXMLEncapsulatedPKIData This class is used to incorporate a piece of PKI data into an XML structure. TElXMLEncapsulatedPKIDataList Provides functionality to store and manage a list of TElXMLEncapsulatedPKIData elements. TElXMLHashDataInfo The HashDataInfo element contains data for hash computations which results are used in time-stamping. TElXMLHashDataInfoList Provides functionality to store and manage a list of HashDataInfo elements. TElXMLDataObjectFormat The DataObjectFormat element provides information for the description of a signed data object. TElXMLDataObjectFormatList Provides functionality to store and manage a list of DataObjectFormat elements. TElXMLCommitmentTypeIndication The CommitmentTypeIndication element explicitly defines the commitment type of the electronic signature. TElXMLCommitmentTypeIndicationList Provides functionality to store and manage a list of CommitmentTypeIndication elements. TElXMLCounterSignature The CounterSignature element represents an embedded signature. TElXMLCounterSignatureList Provides functionality to store and manage a list of counter signatures. TElXMLCompleteCertificateRefs The CompleteCertificateRefs XML element carries references to the certificates. TElXMLCRLRef Contains an identifier of the CRL (Certificate revocation List). TElXMLCRLRefs Provides functionality to store and manage a list of CRL identifiers. TElXMLCRLIdentifier The CRLIdentifier element represents a set of data which identifies a CRL. TElXMLOCSPRef The OCSPRef element identifies an OCSP response. TElXMLOCSPRefs Provides functionality to store and manage a list of OCSPRef elements. TElXMLOCSPIdentifier The OCSPIdentifier element contains data identifying an OCSP response for the OCSPRef element. TElXMLCertificateValues The CertificateValues element contains the certificates which have been used for signature validation. TElXMLRevocationValues The RevocationValues element contains values of different revocation information used within the Advanced Electronic Signature with Extended Validation Data (XAdES-X-Long) standard. TElXMLSignatureValue The SignatureValue element contains the actual value of the digital signature. TElXMLObject Represents an XML object that can be included into the digital signature. TElXMLObjectList Provides functionality to store and manage a list of TElXMLObject elements. TElXMLSignedInfo The SignedInfo XML element represents information which is actually signed by the digital signature. TElXMLInclude This class represents an individual Include XML element, sequence of which is used in XAdES V1.2.2 as input for digest calculation for timestamping. TElXMLIncludeList Provides functionality to store and manage a list of Include elements. TElXMLTimestamp_v1_2_2 Represents a timestamp which is used with XML Advanced Electronic Signatures version 1.2.2 . TElXMLTimestampList_v1_2_2 Provides functionality to store and manage a list of TElXMLTimestamp_v1_2_2 elements. TElCustomTSPClientList Provides functionality to store and manage a list of TSP clients. Each element of the list is represented by TElCustomTSPClient instance.

Supplementary SOAP security classes included with XMLBlackbox are:

Class name Summary TElXMLSOAPSignatureHandler This helper class lets you sign SOAP messages using SOAP-DSig standard TElXMLWSSSignatureHandler This helper class lets you sign SOAP messages using WSS-DSig standard

Discuss this help topic in SecureBlackbox Forum