TElOfficeBinaryXMLSignatureHandler.Sign method

TElOfficeBinaryXMLSignatureHandler.Sign

TElOfficeBinaryXMLSignatureHandler See also

This method generates a signature.

Declaration

[C#]
    void Sign(TElX509Certificate Certificate);
    void Sign(TElX509Certificate Certificate, bool EmbedCertificate);
    void Sign(TElCustomCertStorage CertStorage);
    void Sign(TElXMLKeyInfoData KeyData, TElXMLSignatureMethod SignatureMethod, bool EmbedKeyInSignature);

[VB.NET]
    Sub Sign(ByVal Certificate As TElX509Certificate)
    Sub Sign(ByVal Certificate As TElX509Certificate, ByVal EmbedCertificate As Boolean)
    Sub Sign(ByVal CertStorage As TElCustomCertStorage)
    Sub Sign(ByVal KeyData As TElXMLKeyInfoData, ByVal SignatureMethod As TElXMLSignatureMethod, ByVal EmbedKeyInSignature As Boolean)

[Pascal]
    procedure Sign(Certificate : TElX509Certificate); overload;
    procedure Sign(Certificate : TElX509Certificate; EmbedCertificate : Boolean); overload;
    procedure Sign(CertStorage : TElCustomCertStorage); overload;
    procedure Sign(KeyData : TElXMLKeyInfoData; SignatureMethod : TElXMLSignatureMethod; EmbedKeyInSignature : Boolean); overload;

[C++]
    void Sign(TElX509Certificate &Certificate);
    void Sign(TElX509Certificate *Certificate);
    void Sign(TElX509Certificate &Certificate, bool EmbedCertificate);
    void Sign(TElX509Certificate *Certificate, bool EmbedCertificate);
    void Sign(TElCustomCertStorage &CertStorage);
    void Sign(TElCustomCertStorage *CertStorage);
    void Sign(TElXMLKeyInfoData &KeyData, TElXMLSignatureMethod SignatureMethod, bool EmbedKeyInSignature);
    void Sign(TElXMLKeyInfoData *KeyData, TElXMLSignatureMethod SignatureMethod, bool EmbedKeyInSignature);

[PHP]
    void Sign(TElX509Certificate $Certificate)
    void Sign(TElX509Certificate $Certificate, bool $EmbedCertificate)
    void Sign(TElCustomCertStorage $CertStorage)
    void Sign(TElXMLKeyInfoData $KeyData, integer $SignatureMethod, bool $EmbedKeyInSignature)

[Java]
    void sign(TElCustomCertStorage CertStorage);
    void sign(TElX509Certificate Certificate, boolean EmbedCertificate);
    void sign(TElXMLKeyInfoData KeyData, TElXMLSignatureMethod SignatureMethod, boolean EmbedKeyInSignature);
    void sign(TElX509Certificate Certificate);

Parameters

CertStorage - the storage with signing certificates
Certificate - signing certificate
EmbedCertificate - set this parameter to True to embed the certificate in the signature
EmbedKeyInSignature - set this parameter to True to embed the key in the signature
KeyData - contains XML key data
SignatureMethod - specifies signature method

SignatureMethod 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

Call this method to produce a signature over the document.