TElMessageSigner.Sign method

TElMessageSigner.Sign

Signs the block of data.

Declaration

[C#]
    int Sign(byte[] InBuffer, ref byte[] OutBuffer, ref int OutSize, bool Detached);
    int Sign(byte[] InBuffer, int InStartIndex, int InSize, byte[] OutBuffer, int OutStartIndex, ref int OutSize, bool Detached);
    int Sign(System.IO.Stream InStream, System.IO.Stream OutStream, bool Detached, long InCount);

[VB.NET]
    Function Sign(ByVal InBuffer As Byte(), ByRef OutBuffer As Byte(), ByRef OutSize As Integer, ByVal Detached As Boolean) As Integer
    Function Sign(ByVal InBuffer As Byte(), ByVal InStartIndex As Integer, ByVal InSize As Integer, ByVal OutBuffer As Byte(), ByVal OutStartIndex As Integer, ByRef OutSize As Integer, ByVal Detached As Boolean) As Integer
    Function Sign(ByVal InStream As System.IO.Stream, ByVal OutStream As System.IO.Stream, ByVal Detached As Boolean, ByVal InCount As Long) As Integer

[Pascal]
function Sign(InBuffer : pointer; InSize : integer; OutBuffer : pointer; var OutSize : integer; Detached : boolean = false) : integer;
function Sign(InStream, OutStream : TStream; Detached : boolean = false; InCount : Int64 = 0) : integer;

[C++]
    int32_t Sign(void * InBuffer, int32_t InSize, void * OutBuffer, int32_t &OutSize, bool Detached);
    int32_t Sign(TStream &InStream, TStream &OutStream, bool Detached, int64_t InCount);
    int32_t Sign(TStream *InStream, TStream *OutStream, bool Detached, int64_t InCount);

[Java]
    int sign(byte[] InBuffer, int InStartIndex, int InSize, byte[] OutBuffer, int OutStartIndex, TSBInteger OutSize, boolean Detached);
    int sign(TElStream InStream, TElStream OutStream, boolean Detached, long InCount);
    int sign(byte[] InBuffer, byte[] OutBuffer, TSBInteger OutSize, boolean Detached);

Parameters

InBuffer - Pointer to the data to be signed
InStartIndex - Starting index of the data to be signed in the InBuffer.
InSize - Size of input data in bytes
OutBuffer - Pointer to the buffer where signed data should be written
OutStartIndex - Starting index of the signed data in the OutBuffer.
OutSize - Size of OutBuffer in bytes
Detached - Specifies whether the detached signature should be created instead of «normal» one
InStream - Stream to be signed.
OutStream - Resulting signed stream.
InCount - Number of bytes to be read from InStream. If this parameter is 0 the data is read till the end of the stream.
Default value is 0.

Return value

0 if the signing process was completed successfully, and an error code otherwise.

Possible values:

[.NET] [Pascal] [C++]	Value	Description
SB_MESSAGE_ERROR_NO_ENCRYPTED_DATA	8193 (0x2001)	Message doesn't contain encrypted data
SB_MESSAGE_ERROR_NO_CERTIFICATE	8194 (0x2002)	Decryption/Signature verification: Certificate which was used to encrypt/sign message was not found. Encryption/Signing: Certificate storage is empty. Signing: Certificate storage doesn't contain any certificate with corresponding private key. Decryption: The required certificate is found but it doesn't contain the corresponding private key.
SB_MESSAGE_ERROR_KEY_DECRYPTION_FAILED	8195 (0x2003)	TElMessageDecryptor was unable to decrypt the content encryption key. The high possibility thatmessage is corrupted.
SB_MESSAGE_ERROR_BUFFER_TOO_SMALL	8196 (0x2004)	The buffer for output data is too small. Check the OutSize property to obtain the required buffer size.
SB_MESSAGE_ERROR_CONTENT_DECRYPTION_FAILED	8197 (0x2005)	TElMessageDecryptor was unable to decrypt the content. The high possibility thatmessage is corrupted.
SB_MESSAGE_ERROR_INVALID_FORMAT	8198 (0x2006)	The message passed to Decrypt/Verify routine is not valid PKCS7 message.
SB_MESSAGE_ERROR_NO_RECIPIENTS	8199 (0x2007)	CertStorage is empty or contains invalid certificates.
SB_MESSAGE_ERROR_UNSUPPORTED_ALGORITHM	8200 (0x2008)	TElMessageDecryptor/ElMessageVerifier: The incoming message contains data encrypted using unsupported algorithm. TElMessageEncryptor/ElMessageSigner: Algorithm or DigestAlgorithm property is set to invalid value
SB_MESSAGE_ERROR_ENCRYPTION_FAILED	8201 (0x2009)	TElMessageEncryptor was unable to encrypt message due to internal error
SB_MESSAGE_ERROR_INVALID_KEY_LENGTH	8202 (0x200A)	Property BitsInKey is set to invalid value.
SB_MESSAGE_ERROR_NO_SIGNED_DATA	8203 (0x200B)	No signed data was found.
SB_MESSAGE_ERROR_INVALID_SIGNATURE	8204 (0x200C)	Signed message contains invalid digital signature. Likely, the signature was corrupted.
SB_MESSAGE_ERROR_INVALID_DIGEST	8205 (0x200D)	Signed message contains invalid message digest. The high possibility that original message was tampered.
SB_MESSAGE_ERROR_SIGNING_FAILED	8206 (0x200E)	TElMessageSigner was unable to sign message due to internal error
SB_MESSAGE_ERROR_INTERNAL_ERROR	8207 (0x200F)	Internal error occured. Please contact SecureBlackbox support.
SB_MESSAGE_ERROR_INVALID_MAC	8208 (0x2010)	Signed message contains invalid MAC signature. The possibility is high that signature was tampered.
SB_MESSAGE_ERROR_UNSUPPORTED_SIGNATURE_TYPE	8209 (0x2011)	Message signature is of an unsupported type.
SB_MESSAGE_ERROR_INVALID_COUNTERSIGNATURE	8210 (0x2012)	The countersignature is not valid.
SB_MESSAGE_ERROR_DIGEST_NOT_FOUND	8211 (0x2013)	Cannot obtain message digest.
SB_MESSAGE_ERROR_UNSUPPORTED_DIGEST_ALGORITHM	8212 (0x2014)	Digest value is computed via an unsupported digest algorithm
SB_MESSAGE_ERROR_CANCELLED_BY_USER	8213 (0x2015)	The action is cancelled by user.
SB_MESSAGE_ERROR_VERIFICATION_FAILED	8214 (0x2016)	This error is reported if any exception is rised during message verification.
SB_MESSAGE_ERROR_DIGEST_CALCULATION_FAILED	8215 (0x2017)	This error is reported if any exception is rised during digest calculation.
SB_MESSAGE_ERROR_MAC_CALCULATION_FAILED	8216 (0x2018)	This error is reported, when MAC calculation is failed.
SB_MESSAGE_ERROR_TSPCLIENT_NOT_FOUND	8217 (0x2019)	This error is reported, when there is no object associated with TSP client
SB_MESSAGE_ERROR_BAD_TIMESTAMP	8218 (0x201A)	This error is reported, if message time stamp does not succeed verification
SB_MESSAGE_ERROR_KEYOP_FAILED_RSA	8219 (0x201B)	This error is reported, when operation with RSA key has failed
SB_MESSAGE_ERROR_KEYOP_FAILED_DSA	8220 (0x201C)	This error is reported, when operation with DSA key has failed
SB_MESSAGE_ERROR_KEYOP_FAILED_RSA_PSS	8221 (0x201D)	This error is reported, when operation with RSA PSS key has failed
SB_MESSAGE_ERROR_NO_COMPRESSED_DATA	8222 (0x201E)	Compressed data was not found.
SB_MESSAGE_ERROR_KEYOP_FAILED_EC	8223 (0x201F)	EC key operation failed.
SB_MESSAGE_ERROR_DC_BAD_ASYNC_STATE	8224 (0x2020)	Wrong Distributed Cryptography asynchronous operation state.
SB_MESSAGE_ERROR_DC_SERVER_ERROR	8225 (0x2021)	A remote servere reported error during Distributed Cryptography asynchronous operation.
SB_MESSAGE_ERROR_DC_MODULE_UNAVAILABLE	8226 (0x2022)	Distributed Cryptography module is unavailable.
SB_MESSAGE_ERROR_KEYOP_FAILED_GOST	8227 (0x2023)	GOST key operation failed.
SB_MESSAGE_ERROR_NO_CONTENT_OR_DATA_URI	8228 (0x2024)	This error is reported when trying to timestamp a message which content could not be found.
SB_MESSAGE_ERROR_TIMESTAMPING_FAILED	8229 (0x2025)	Message timestamping has failed.
SB_MESSAGE_ERROR_NO_TIMESTAMPED_DATA	8230 (0x2026)	Timestamped data was not found.
SB_MESSAGE_ERROR_ASN_LIMIT_EXCEEDED	8231 (0x2027)	An ASN.1 counter-DoS limitation was exceeded due to the size/depth of the provided ASN.1 structure. Please consider switching to the stream-based methods or increase the values assigned to the G_MaxASN1TreeDepth and G_MaxASN1BufferLength global settings (SBASN1Tree unit/namespace).

Description

Use this method to sign blocks of data. Block of data is signed using each certificate from CertStorage, which has the corresponding private key. When Detached parameter is false, the signature is merged with data and the resulting block is returned. If Detached is true, only the signature is returned. Unless IncludeCertificates property is set to false, all certificates from storage are included into the signature. If IncludeCertificates is false, then the signature contains only certificate IDs.

Note, that some certificates from storage may not have the corresponding private keys. These certificates are included in signed message too. This is done to create certificate chains and make validation of signing certificate easier.

Discuss this help topic in SecureBlackbox Forum