TElXMLSOAPBaseSignatureHandler.Sign method

Discuss this help topic in SecureBlackbox Forum

TElXMLSOAPBaseSignatureHandler.Sign

Generates the signature and signs the message.

Declaration

[C#]
    void Sign(TElXMLDOMElement ParentElement, TElX509Certificate Certificate);
    void Sign(TElXMLDOMElement ParentElement, TElX509Certificate Certificate, bool IncludeKey);
    void Sign(TElXMLDOMElement ParentElement, TElX509Certificate Certificate, bool IncludeKey, bool IncludeKeyValue, TElXMLKeyInfoX509DataParams IncludeDataParams);
    void Sign(TElXMLDOMElement ParentElement, TElCustomCertStorage CertStorage);
    void Sign(TElXMLDOMElement ParentElement, TElCustomCertStorage CertStorage, bool IncludeKey);
    void Sign(TElXMLDOMElement ParentElement, TElCustomCertStorage CertStorage, bool IncludeKey, bool IncludeKeyValue, TElXMLKeyInfoX509DataParams IncludeDataParams);
    void Sign(TElXMLDOMElement ParentElement, TElXMLKeyInfoData KeyData, TElXMLSignatureMethod SignatureMethod, bool IncludeKey);

[VB.NET]
    Sub Sign(ByVal ParentElement As TElXMLDOMElement, ByVal Certificate As TElX509Certificate)
    Sub Sign(ByVal ParentElement As TElXMLDOMElement, ByVal Certificate As TElX509Certificate, ByVal IncludeKey As Boolean)
    Sub Sign(ByVal ParentElement As TElXMLDOMElement, ByVal Certificate As TElX509Certificate, ByVal IncludeKey As Boolean, ByVal IncludeKeyValue As Boolean, ByVal IncludeDataParams As TElXMLKeyInfoX509DataParams)
    Sub Sign(ByVal ParentElement As TElXMLDOMElement, ByVal CertStorage As TElCustomCertStorage)
    Sub Sign(ByVal ParentElement As TElXMLDOMElement, ByVal CertStorage As TElCustomCertStorage, ByVal IncludeKey As Boolean)
    Sub Sign(ByVal ParentElement As TElXMLDOMElement, ByVal CertStorage As TElCustomCertStorage, ByVal IncludeKey As Boolean, ByVal IncludeKeyValue As Boolean, ByVal IncludeDataParams As TElXMLKeyInfoX509DataParams)
    Sub Sign(ByVal ParentElement As TElXMLDOMElement, ByVal KeyData As TElXMLKeyInfoData, ByVal SignatureMethod As TElXMLSignatureMethod, ByVal IncludeKey As Boolean)

[Pascal]
    procedure Sign(ParentElement : TElXMLDOMElement; Certificate : TElX509Certificate); overload;
    procedure Sign(ParentElement : TElXMLDOMElement; Certificate : TElX509Certificate; IncludeKey : Boolean); overload;
    procedure Sign(ParentElement : TElXMLDOMElement; Certificate : TElX509Certificate; IncludeKey, IncludeKeyValue : Boolean; IncludeDataParams : TElXMLKeyInfoX509DataParams); overload; virtual;
    procedure Sign(ParentElement : TElXMLDOMElement; CertStorage : TElCustomCertStorage); overload;
    procedure Sign(ParentElement : TElXMLDOMElement; CertStorage : TElCustomCertStorage; IncludeKey : Boolean); overload;
    procedure Sign(ParentElement : TElXMLDOMElement; CertStorage : TElCustomCertStorage; IncludeKey, IncludeKeyValue : Boolean; IncludeDataParams : TElXMLKeyInfoX509DataParams); overload; virtual;
    procedure Sign(ParentElement : TElXMLDOMElement; KeyData : TElXMLKeyInfoData; SignatureMethod : TElXMLSignatureMethod; IncludeKey : Boolean); overload; virtual;

[PHP]
    void Sign(TElXMLDOMElement $ParentElement, TElX509Certificate $Certificate)
    void Sign(TElXMLDOMElement $ParentElement, TElX509Certificate $Certificate, bool $IncludeKey)
    void Sign(TElXMLDOMElement $ParentElement, TElX509Certificate $Certificate, bool $IncludeKey, bool $IncludeKeyValue, integer $IncludeDataParams)
    void Sign(TElXMLDOMElement $ParentElement, TElCustomCertStorage $CertStorage)
    void Sign(TElXMLDOMElement $ParentElement, TElCustomCertStorage $CertStorage, bool $IncludeKey)
    void Sign(TElXMLDOMElement $ParentElement, TElCustomCertStorage $CertStorage, bool $IncludeKey, bool $IncludeKeyValue, integer $IncludeDataParams)
    void Sign(TElXMLDOMElement $ParentElement, TElXMLKeyInfoData $KeyData, integer $SignatureMethod, bool $IncludeKey)

[Java]
    void sign(TElXMLDOMElement ParentElement, TElCustomCertStorage CertStorage, boolean IncludeKey);
    void sign(TElXMLDOMElement ParentElement, TElX509Certificate Certificate, boolean IncludeKey, boolean IncludeKeyValue, TElXMLKeyInfoX509DataParams IncludeDataParams);
    void sign(TElXMLDOMElement ParentElement, TElCustomCertStorage CertStorage);
    void sign(TElXMLDOMElement ParentElement, TElXMLKeyInfoData KeyData, TElXMLSignatureMethod SignatureMethod, boolean IncludeKey);
    void sign(TElXMLDOMElement ParentElement, TElCustomCertStorage CertStorage, boolean IncludeKey, boolean IncludeKeyValue, TElXMLKeyInfoX509DataParams IncludeDataParams);
    void sign(TElXMLDOMElement ParentElement, TElX509Certificate Certificate);
    void sign(TElXMLDOMElement ParentElement, TElX509Certificate Certificate, boolean IncludeKey);

Parameters

Certificate - the signing certificate.
CertStorage - the storage with signing certificates.
IncludeDataParams - specifies whether data params should be included.
IncludeKey - specifies whether the key should be included to the signature.
IncludeKeyValue - specifies whether key value should be included.
KeyData - contains the signing key data.
ParentElement - the XML node to which the signature should be attached.
SignatureMethod - specifies the signature method to be used.

TElXMLKeyInfoX509DataParams values

[.NET][C++]	[Pascal]	[PHP]	Description
f_xkidX509IssuerSerial = 1	xkidX509IssuerSerial	xkidX509IssuerSerial = 1	...
f_xkidX509SKI = 2	xkidX509SKI	xkidX509SKI = 2	...
f_xkidX509SubjectName = 4	xkidX509SubjectName	xkidX509SubjectName = 4	...
f_xkidX509Certificate = 8	xkidX509Certificate	xkidX509Certificate = 8	...
f_xkidX509CRL = 16	xkidX509CRL	xkidX509CRL = 16	...

TElXMLSignatureMethod values

[.NET] [C++]	[Pascal]	Description
xsmDSS = 0	xsmDSS	DSA (DSS) is used
xsmRSA_MD5 = 1	xsmRSA_MD5	RSA with MD5 is used
xsmRSA_SHA1 = 2	xsmRSA_SHA1	RSA with SHA1 is used
xsmRSA_SHA256 = 3	xsmRSA_SHA256	RSA with SHA 256-bit is used
xsmRSA_SHA384 = 4	xsmRSA_SHA384	RSA with SHA 384-bit is used
xsmRSA_SHA512 = 5	xsmRSA_SHA512	RSA with SHA 512-bit is used
xsmRSA_RIPEMD160 = 6	xsmRSA_RIPEMD160	RSA with RIPEMD160-bit is used
xsmECDSA_SHA1 = 7	xsmECDSA_SHA1	ECDSA with SHA1 digest
xsmGOST1994 = 8	xsmGOST1994	GOST R34.10-94
xsmGOST2001 = 9	xsmGOST2001	GOST R 34.10-2001
xsmRSA_SHA224 = 10	xsmRSA_SHA224	RSA with SHA224 digest
xsmRSA_Whirlpool = 11	xsmRSA_Whirlpool	RSA with Whirlpool digest
xsmDSA_SHA256 = 12	xsmDSA_SHA256	DSA with SHA256 digest
xsmECDSA_SHA224 = 13	xsmECDSA_SHA224	ECDSA with SHA224 digest
xsmECDSA_SHA256 = 14	xsmECDSA_SHA256	ECDSA with SHA 256 digest
xsmECDSA_SHA384 = 15	xsmECDSA_SHA384	ECDSA with SHA384 digest
xsmECDSA_SHA512 = 16	xsmECDSA_SHA512	ECDSA with SHA512 digest
xsmECDSA_RIPEMD160 = 17	xsmECDSA_RIPEMD160	ECDSA with RIPEMD160 digest
xsmECDSA_Whirlpool = 18	xsmECDSA_Whirlpool	ECDSA with Whirlpool digest
xsmRSA_PSS = 19	xsmRSA_PSS	RSA-PSS algorithm
xsmRSA_PSS_MD5_MGF1 = 20	xsmRSA_PSS_MD5_MGF1	RSA-PSS with MD5 digest and MGF1 mask
xsmRSA_PSS_SHA1_MGF1 = 21	xsmRSA_PSS_SHA1_MGF1	RSA-PSS with SHA1 digest and MGF1 mask
xsmRSA_PSS_SHA224_MGF1 = 22	xsmRSA_PSS_SHA224_MGF1	RSA-PSS with SHA224 digest and MGF1 mask
xsmRSA_PSS_SHA256_MGF1 = 23	xsmRSA_PSS_SHA256_MGF1	RSA-PSS with SHA256 digest and MGF1 mask
xsmRSA_PSS_SHA384_MGF1 = 24	xsmRSA_PSS_SHA384_MGF1	RSA-PSS with SHA384 digest and MGF1 mask
xsmRSA_PSS_SHA512_MGF1 = 25	xsmRSA_PSS_SHA512_MGF1	RSA-PSS with SHA512 digest and MGF1 mask
xsmRSA_PSS_RIPEMD160_MGF1 = 26	xsmRSA_PSS_RIPEMD160_MGF1	RSA-PSS with RIPEMD160 digest and MGF1 mask
xsmRSA_PSS_Whirlpool_MGF1 = 27	xsmRSA_PSS_Whirlpool_MGF1	RSA-PSS with Whirlpool digest and MGF1 mask

Description

Use this method to sign the message.