XMLBlackbox package

XMLBlackbox includes the components and functions, related to XML 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.

Besides XML support, SFTPBlackbox also includes OpenBlackbox to perform OpenPGP operations.

XMLBlackbox includes the following components:

Component name Summary ElXMLEncryptor This class performs encryption of XML nodes or documents. ElXMLDecryptor This class performs decryption of XML nodes or documents. ElXMLSigner This component provides a simple interface to digitally sign XML data. ElXMLVerifier This component provides a simple interface to verify the digitally signed XML data. ElXAdESSigner This class is used for signing documents with XML Advanced Electronic Signatures (XAdES). ElXAdESVerifier This class is used for verifying XML Advanced Electronic Signatures (XAdES). ElXMLDOMDocument This class represents an XML document node.

Supplementary classes included into XMLBlackbox are

Class name Summary XML Charsets ElXMLCodec Represents an encoding processor for XML parser and writer. ElXML8BitCodec Represents an encoding processor for 8-bit encodings. ElXMLUnicodeCodec Represents an encoding processor for UTF-16 (Unicode 16-bit) encoding. ElXMLUTF8Codec Represents an encoding processor for UTF-8 encoding. XML Document Object Model ElXMLDOMAttr Represents a single attribute of the XML element. ElXMLDOMCDATASection Represents a data XML node. ElXMLDOMCharacterData Represents an XML node which contains character data. ElXMLDOMComment Represents an XML comment. ElXMLDOMDocumentType Contains information about the type of an XML document. ElXMLDOMDocumentFragment Represents a lightweight object that is useful for tree insert operations. ElXMLDOMElement Represents a single XML element. ElXMLDOMEntity Represents an entity declaration: <!ENTITY ... >. ElXMLDOMEntityReference Represents an entity reference node. ElXMLDOMNamedNodeMap Represents a collection of nodes that can be accessed by name or index. ElXMLDOMNode Represents an abstract XML node. ElXMLDOMNodeList Represents a list of XML nodes (XML tags). ElXMLDOMNotation represents a notation declaration: <!NOTATION ... >. ElXMLDOMProcessingInstruction Represents a processing instruction as defined by Document Object Model specification. ElXMLDOMText Represents a text XML node. XML Security Supplementary Classes ElXMLBase64Transform Performs Base64 encoding of the XML node. ElXMLBinaryDecryptionTransform Performs an XML decryption transform in the binary mode as it is specified in the W3C Recommendation "Decryption Transform for XML Signature". ElXMLC14NTransform Performs canonicalization of the XML node according to XML-Signature Syntax and Processing specification. ElXMLCipherData Contains CipherData XML element. ElXMLCipherReference Contains CipherReference XML element. ElXMLCustomDecryptionTransform The base class for XML decryption transforms. ElXMLCustomElement The base class for all XML elements. ElXMLDecryptionExcept This element identifies the input-node elements which should not be processed by the decryption transform. ElXMLDecryptionTransform Performs an XML decryption transform in the XML mode. ElXMLEncryptedData This class is a holder of the XML information about encrypted data. ElXMLEncryptedKey This class is a holder of the XML information about encrypted key. ElXMLEncryptedType Implements common functionality and is a base class for ElXMLEncryptedData and ElXMLEncryptedKey. ElXMLEncryptionMethodType Represents contents of EncryptionMethod XML element. ElXMLEncryptionProperties Provides functionality to store and manage the list of XML properties. ElXMLEnvelopedSignatureTransform Excludes the enveloped signature from the XML node. ElXMLKeyInfo Represents a KeyInfo XML element, which contains information about the encryption key. ElXMLKeyInfoData The base class for all classes, that describe a key for XML encryption. ElXMLKeyInfoDSAData This class is a container for DSA keypair. ElXMLKeyInfoHMACData This class is a container for HMAC key. ElXMLKeyInfoItem This abstract class represents an item in a KeyInfo XML element. ElXMLKeyInfoNode Contains additional data, which may appear in KeyInfo XML element. ElXMLKeyInfoPGPData This class is a container for PGP key pair. ElXMLKeyInfoRetrievalMethod Represents RetrievalMethod XML element. ElXMLKeyInfoRSAData This class is a container for RSA keypair. ElXMLKeyInfoSymmetricData This class is a container for symmetric key. ElXMLKeyInfoX509Data This class is a container for X.509 certificate. ElXMLManifest This class is a placeholder for information about manifest (see XMLDSIG specification for details). ElXMLNamespaceMap Represents a namespace map for the XPath expression. ElXMLProperties Provides functionality to store and manage a list of XML properties. ElXMLProperty Represents a single XML property. ElXMLReference 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. ElXMLReferenceList Provides functionality to store and manage a list of XMLReference elements. ElXMLTransform The base class for specific XML transformation classes. ElXMLTransformChain Contains the list of XML transforms. ElXMLXPathTransform This transform performs XPath filtering. XAdES ElXMLSignature This class is a representation of the Signature XML node as defined in XML-Signature Syntax and Processing specification. ElXMLAdESElement Represents a basic element of the XML Advanced Electronic Signature (XAdES). ElXMLAnyType The AnyType element represents an arbitrary XML element of unrestricted length. ElXMLAnyTypeList Provides functionality to store and manage a list of AnyType XML elements. ElXMLCertID The CertID element identifies a certificate. ElXMLCertIDList Provides functionality to store and manage a list of CertID XML elements. ElXMLGenericTimestamp Represents a base container type for timestamp tokens. ElXMLGenericTimestampList Provides functionality to store and manage a list of generic timestamps. ElXMLQualifyingPropertiesReference QualifyingPropertiesReference element contains information about a QualifyingProperties element that is stored in place different from the signature. ElXMLQualifyingPropertiesReferenceList Provides functionality to store and manage a list of QualifyingPropertiesReference XML elements. ElXMLQualifyingProperties The QualifyingProperties element acts as a container element for all the qualifying information that should be added to an XML signature. ElXMLSignedProperties The SignedProperties element contains a number of properties that are collectively signed by the [XMLDSIG] signature. ElXMLUnsignedProperties The UnsignedProperties element contains a number of properties that are not signed by the [XMLDSIG] signature. ElXMLSignedSignatureProperties The SignedSignatureProperties element contains properties that qualify the XML signature itself or the signer. ElXMLSignedDataObjectProperties The SignedDataObjectProperties element contains properties that qualify some of the signed data objects. ElXMLUnsignedSignatureProperties The UnsignedSignatureProperties element contains properties that qualify the XML signature, and are not covered by the signature. ElXMLSignaturePolicyIdentifier This element contins the identifier of the policy, under which the signature was issued. ElXMLSignaturePolicyID This element contains unique identifier, hash algorithm and hash value, and some additional information related to the signature policy. ElXMLSignatureProductionPlace The SignatureProductionPlace XML property serves to identify the place, where the signature was created. ElXMLSignerRole The SignerRole element identifies the role (i.e., the position in a company or organization) of the signer. ElXMLCustomTimestamp The base class for all XML timestamps. ElXMLCustomTimestampList Provides functionality to store and manage a list of XML timestamps. ElXMLTimestamp This element represents the timestamps which are used with XML Advanced Electronic Signatures (XAdES). ElXMLTimestampList Provides functionality to store and manage a list of ElXMLTimestamp elements. ElXMLObjectIdentifier Identifies a particular data object in XAdES. ElXMLDigestAlgAndValue The DigestAlgAndValue element containes a digest value computed on some data set and specifies the digest algorithm. ElXMLIssuerSerial The IssuerSerial element contains the identifier of one of the certificates referenced in the sequence of the SigningCertificate element. ElXMLEncapsulatedPKIData This class is used to incorporate a piece of PKI data into an XML structure. ElXMLEncapsulatedPKIDataList Provides functionality to store and manage a list of ElXMLEncapsulatedPKIData elements. ElXMLHashDataInfo The HashDataInfo element containes data for hash computations which results are used in time-stamping. ElXMLHashDataInfoList Provides functionality to store and manage a list of HashDataInfo elements. ElXMLDataObjectFormat The DataObjectFormat element provides information for the description of a signed data object. ElXMLDataObjectFormatList Provides functionality to store and manage a list of DataObjectFormat elements. ElXMLCommitmentTypeIndication The CommitmentTypeIndication element explicitly defines the commitment type of the electronic signature. ElXMLCommitmentTypeIndicationList Provides functionality to store and manage a list of CommitmentTypeIndication elements. ElXMLCounterSignature The CounterSignature element represents an embedded signature. ElXMLCounterSignatureList Provides functionality to store and manage a list of counter signatures. ElXMLCompleteCertificateRefs The CompleteCertificateRefs XML element carries references to the certificates. ElXMLCRLRef Contains an identifier of the CRL (Certificate revocation List). ElXMLCRLRefs Provides functionality to store and manage a list of CRL identifiers. ElXMLCRLIdentifier The CRLIdentifier element represents a set of data which identifies a CRL. ElXMLOCSPRef The OCSPRef element identifies an OCSP response. ElXMLOCSPRefs Provides functionality to store and manage a list of OCSPRef elements. ElXMLOCSPIdentifier The OCSPIdentifier element containes data identifying an OCSP response for the OCSPRef element. ElXMLCertificateValues The CertificateValues element containes the certificates which have been used for signature validation. ElXMLRevocationValues The RevocationValues element contains values of different revocation information used within the Advanced Electronic Signature with Extended Validation Data (XAdES-X-Long) standard. ElXMLSignatureValue The SignatureValue element contains the actual value of the digital signature. ElXMLObject Represents an XML object that can be included into the digital signature. ElXMLObjectList Provides functionality to store and manage a list of ElXMLObject elements. ElXMLSignedInfo The SignedInfo XML element represents information which is actually signed by the digital signature. ElXMLInclude 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. ElXMLIncludeList Provides functionality to store and manage a list of Include elements. ElXMLTimestamp_v1_2_2 Represents a timestamp which is used with XML Advanced Electronic Signatures version 1.2.2 . ElXMLTimestampList_v1_2_2 Provides functionality to store and manage a list of ElXMLTimestamp_v1_2_2 elements. ElCustomTSPClientList Provides functionality to store and manage a list of TSP clients. Each element of the list is represented by ElCustomTSPClient instance.