OfficeQuickSigner Class

Properties   Methods   Events   Config Settings   Errors  

The OfficeQuickSigner class signs Office documents in a quick-and-easy manner.

Syntax

OfficeQuickSigner

Remarks

OfficeQuickSigner provides digital signing capabilities of Office documents.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

DocumentFormat Property (OfficeQuickSigner Class)

Defines the format of the Office document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDocumentFormat();

Unicode (Windows)
INT GetDocumentFormat();

ODF_UNKNOWN(0), 
ODF_BINARY(1), 
ODF_OPEN_XML(2), 
ODF_OPEN_XPS(3), 
ODF_OPEN_DOCUMENT(4)

int secureblackbox_officequicksigner_getdocumentformat(void* lpObj);

int GetDocumentFormat();

Default Value

0

Remarks

This property contains the Office document format.

This property is read-only and not available at design time.

Data Type

Integer

DocumentType Property (OfficeQuickSigner Class)

Defines the type of the Office document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDocumentType();

Unicode (Windows)
LPWSTR GetDocumentType();

char* secureblackbox_officequicksigner_getdocumenttype(void* lpObj);

QString GetDocumentType();

Default Value

""

Remarks

This property contains the Office document type.

This property is read-only and not available at design time.

Data Type

String

ExternalCrypto Property (OfficeQuickSigner Class)

Provides access to external signing and DC parameters.

Syntax

• C++
• C
• Qt

SecureBlackboxExternalCrypto* GetExternalCrypto();

char* secureblackbox_officequicksigner_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_officequicksigner_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);

char* secureblackbox_officequicksigner_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_officequicksigner_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);

char* secureblackbox_officequicksigner_getexternalcryptodata(void* lpObj);
int secureblackbox_officequicksigner_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);

int secureblackbox_officequicksigner_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_officequicksigner_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);

char* secureblackbox_officequicksigner_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_officequicksigner_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);

char* secureblackbox_officequicksigner_getexternalcryptokeyid(void* lpObj);
int secureblackbox_officequicksigner_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);

char* secureblackbox_officequicksigner_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_officequicksigner_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);

int secureblackbox_officequicksigner_getexternalcryptomethod(void* lpObj);
int secureblackbox_officequicksigner_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);

int secureblackbox_officequicksigner_getexternalcryptomode(void* lpObj);
int secureblackbox_officequicksigner_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);

char* secureblackbox_officequicksigner_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_officequicksigner_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);

QString GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(QString qsExternalCryptoAsyncDocumentID);

QString GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(QString qsExternalCryptoCustomParams);

QString GetExternalCryptoData();
int SetExternalCryptoData(QString qsExternalCryptoData);

bool GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(bool bExternalCryptoExternalHashCalculation);

QString GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(QString qsExternalCryptoHashAlgorithm);

QString GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(QString qsExternalCryptoKeyID);

QString GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(QString qsExternalCryptoKeySecret);

int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);

int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);

QString GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(QString qsExternalCryptoPublicKeyAlgorithm);

Remarks

Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).

This property is read-only.

Data Type

SecureBlackboxExternalCrypto

FIPSMode Property (OfficeQuickSigner Class)

Reserved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFIPSMode();
int SetFIPSMode(int bFIPSMode);

Unicode (Windows)
BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);

int secureblackbox_officequicksigner_getfipsmode(void* lpObj);
int secureblackbox_officequicksigner_setfipsmode(void* lpObj, int bFIPSMode);

bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);

Default Value

FALSE

Remarks

This property is reserved for future use.

Data Type

Boolean

HashAlgorithm Property (OfficeQuickSigner Class)

Specifies the hash algorithm to be used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHashAlgorithm();
int SetHashAlgorithm(const char* lpszHashAlgorithm);

Unicode (Windows)
LPWSTR GetHashAlgorithm();
INT SetHashAlgorithm(LPCWSTR lpszHashAlgorithm);

char* secureblackbox_officequicksigner_gethashalgorithm(void* lpObj);
int secureblackbox_officequicksigner_sethashalgorithm(void* lpObj, const char* lpszHashAlgorithm);

QString GetHashAlgorithm();
int SetHashAlgorithm(QString qsHashAlgorithm);

Default Value

"SHA256"

Remarks

Use this property to set the hash algorithm for signature calculation.

Supported values:

Data Type

String

InputBytes Property (OfficeQuickSigner Class)

Use this property to pass the input to class in byte array form.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInputBytes(char* &lpInputBytes, int &lenInputBytes);
int SetInputBytes(const char* lpInputBytes, int lenInputBytes);

Unicode (Windows)
INT GetInputBytes(LPSTR &lpInputBytes, INT &lenInputBytes);
INT SetInputBytes(LPCSTR lpInputBytes, INT lenInputBytes);

int secureblackbox_officequicksigner_getinputbytes(void* lpObj, char** lpInputBytes, int* lenInputBytes);
int secureblackbox_officequicksigner_setinputbytes(void* lpObj, const char* lpInputBytes, int lenInputBytes);

QByteArray GetInputBytes();
int SetInputBytes(QByteArray qbaInputBytes);

Remarks

Assign a byte array containing the data to be processed to this property.

This property is not available at design time.

Data Type

Byte Array

InputFile Property (OfficeQuickSigner Class)

The file to be signed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInputFile();
int SetInputFile(const char* lpszInputFile);

Unicode (Windows)
LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);

char* secureblackbox_officequicksigner_getinputfile(void* lpObj);
int secureblackbox_officequicksigner_setinputfile(void* lpObj, const char* lpszInputFile);

QString GetInputFile();
int SetInputFile(QString qsInputFile);

Default Value

""

Remarks

Provide the path to the Office document to be signed.

Data Type

String

OutputBytes Property (OfficeQuickSigner Class)

Use this property to read the output the class object has produced.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOutputBytes(char* &lpOutputBytes, int &lenOutputBytes);

Unicode (Windows)
INT GetOutputBytes(LPSTR &lpOutputBytes, INT &lenOutputBytes);

int secureblackbox_officequicksigner_getoutputbytes(void* lpObj, char** lpOutputBytes, int* lenOutputBytes);

QByteArray GetOutputBytes();

Remarks

Read the contents of this property after the operation has completed to read the produced output. This property will only be set if the OutputFile and OutputStream properties had not been assigned.

This property is read-only and not available at design time.

Data Type

Byte Array

OutputFile Property (OfficeQuickSigner Class)

Defines where to save the signed document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile);

Unicode (Windows)
LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);

char* secureblackbox_officequicksigner_getoutputfile(void* lpObj);
int secureblackbox_officequicksigner_setoutputfile(void* lpObj, const char* lpszOutputFile);

QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);

Default Value

""

Remarks

Specifies the path where the signed Office document should be saved.

Data Type

String

SignatureType Property (OfficeQuickSigner Class)

Specifies the type of the signature to be made.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignatureType();
int SetSignatureType(int iSignatureType);

Unicode (Windows)
INT GetSignatureType();
INT SetSignatureType(INT iSignatureType);

OST_DEFAULT(0), 
OST_BINARY_CRYPTO_API(1), 
OST_BINARY_XML(2), 
OST_OPEN_XML(3), 
OST_OPEN_XPS(4), 
OST_OPEN_DOCUMENT(5)

int secureblackbox_officequicksigner_getsignaturetype(void* lpObj);
int secureblackbox_officequicksigner_setsignaturetype(void* lpObj, int iSignatureType);

int GetSignatureType();
int SetSignatureType(int iSignatureType);

Default Value

0

Remarks

Use this property to define what kind of signature should be made over the document.

Data Type

Integer

SignCoreProperties Property (OfficeQuickSigner Class)

Whether to sign the core properties of the document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignCoreProperties();
int SetSignCoreProperties(int bSignCoreProperties);

Unicode (Windows)
BOOL GetSignCoreProperties();
INT SetSignCoreProperties(BOOL bSignCoreProperties);

int secureblackbox_officequicksigner_getsigncoreproperties(void* lpObj);
int secureblackbox_officequicksigner_setsigncoreproperties(void* lpObj, int bSignCoreProperties);

bool GetSignCoreProperties();
int SetSignCoreProperties(bool bSignCoreProperties);

Default Value

FALSE

Remarks

The core properties are a set of elements that describe common and well-known properties of the Office document package such as creator, version, revision, etc.

Data Type

Boolean

SignDocument Property (OfficeQuickSigner Class)

Whether to sign the document itself.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignDocument();
int SetSignDocument(int bSignDocument);

Unicode (Windows)
BOOL GetSignDocument();
INT SetSignDocument(BOOL bSignDocument);

int secureblackbox_officequicksigner_getsigndocument(void* lpObj);
int secureblackbox_officequicksigner_setsigndocument(void* lpObj, int bSignDocument);

bool GetSignDocument();
int SetSignDocument(bool bSignDocument);

Default Value

TRUE

Remarks

Use this property to specify whether the signature should be computed over the document itself.

Data Type

Boolean

SigningCertificate Property (OfficeQuickSigner Class)

The certificate to be used for signing.

Syntax

• C++
• C
• Qt

SecureBlackboxCertificate* GetSigningCertificate();
int SetSigningCertificate(SecureBlackboxCertificate* val);

int secureblackbox_officequicksigner_getsigningcertbytes(void* lpObj, char** lpSigningCertBytes, int* lenSigningCertBytes);

int64 secureblackbox_officequicksigner_getsigningcerthandle(void* lpObj);
int secureblackbox_officequicksigner_setsigningcerthandle(void* lpObj, int64 lSigningCertHandle);

QByteArray GetSigningCertBytes();

qint64 GetSigningCertHandle();
int SetSigningCertHandle(qint64 lSigningCertHandle);

Remarks

Use this property to specify the certificate that shall be used for signing the data. Note that this certificate should have a private key associated with it. Use SigningChain to supply the rest of the certificate chain for inclusion into the signature.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

SigningChain Property (OfficeQuickSigner Class)

The signing certificate chain.

Syntax

• C++
• C
• Qt

SecureBlackboxList<SecureBlackboxCertificate>* GetSigningChain();
int SetSigningChain(SecureBlackboxList<SecureBlackboxCertificate>* val);

int secureblackbox_officequicksigner_getsigningchaincount(void* lpObj);
int secureblackbox_officequicksigner_setsigningchaincount(void* lpObj, int iSigningChainCount);

int secureblackbox_officequicksigner_getsigningchainbytes(void* lpObj, int signingchainindex, char** lpSigningChainBytes, int* lenSigningChainBytes);

int64 secureblackbox_officequicksigner_getsigningchainhandle(void* lpObj, int signingchainindex);
int secureblackbox_officequicksigner_setsigningchainhandle(void* lpObj, int signingchainindex, int64 lSigningChainHandle);

int GetSigningChainCount();
int SetSigningChainCount(int iSigningChainCount);

QByteArray GetSigningChainBytes(int iSigningChainIndex);

qint64 GetSigningChainHandle(int iSigningChainIndex);
int SetSigningChainHandle(int iSigningChainIndex, qint64 lSigningChainHandle);

Remarks

Use this property to provide the chain for the signing certificate. Use the SigningCertificate property, if it is available, to provide the signing certificate itself.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

SignSignatureOrigin Property (OfficeQuickSigner Class)

Whether to sign the signature origin.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignSignatureOrigin();
int SetSignSignatureOrigin(int bSignSignatureOrigin);

Unicode (Windows)
BOOL GetSignSignatureOrigin();
INT SetSignSignatureOrigin(BOOL bSignSignatureOrigin);

int secureblackbox_officequicksigner_getsignsignatureorigin(void* lpObj);
int secureblackbox_officequicksigner_setsignsignatureorigin(void* lpObj, int bSignSignatureOrigin);

bool GetSignSignatureOrigin();
int SetSignSignatureOrigin(bool bSignSignatureOrigin);

Default Value

FALSE

Remarks

Specifies whether to sign the XPS document's signature origin.

Data Type

Boolean

Config Method (OfficeQuickSigner Class)

This method sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* secureblackbox_officequicksigner_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DoAction Method (OfficeQuickSigner Class)

Performs an additional action.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* DoAction(const char* lpszActionID, const char* lpszActionParams);

Unicode (Windows)
LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);

char* secureblackbox_officequicksigner_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);

QString DoAction(const QString& qsActionID, const QString& qsActionParams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ExtractAsyncData Method (OfficeQuickSigner Class)

Extracts user data from the DC signing service response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* ExtractAsyncData(const char* lpszAsyncReply);

Unicode (Windows)
LPWSTR ExtractAsyncData(LPCWSTR lpszAsyncReply);

char* secureblackbox_officequicksigner_extractasyncdata(void* lpObj, const char* lpszAsyncReply);

QString ExtractAsyncData(const QString& qsAsyncReply);

Remarks

Call this method before finalizing the asynchronous signing process to extract the data passed to the ExternalCrypto.Data property on the pre-signing stage.

The Data parameter can be used to pass some state or document identifier along with the signing request from the pre-signing to the completion async stage.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Reset Method (OfficeQuickSigner Class)

Resets the class settings.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int secureblackbox_officequicksigner_reset(void* lpObj);

int Reset();

Remarks

Reset is a generic method available in every class.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Sign Method (OfficeQuickSigner Class)

Calculates the signature value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Sign();

Unicode (Windows)
INT Sign();

int secureblackbox_officequicksigner_sign(void* lpObj);

int Sign();

Remarks

Call this method to generate a signature over the document.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SignAsyncBegin Method (OfficeQuickSigner Class)

Initiates the asynchronous signing operation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* SignAsyncBegin();

Unicode (Windows)
LPWSTR SignAsyncBegin();

char* secureblackbox_officequicksigner_signasyncbegin(void* lpObj);

QString SignAsyncBegin();

Remarks

When using the DC framework, call this method to initiate the asynchronous signing process. Upon completion, a pre-signed copy of the document will be saved in OutputFile (or OutputStream). Keep the pre-signed copy somewhere local, and pass the returned string ('the request state') to the DC processor for handling.

Upon receiving the response state from the DC processor, assign the path to the pre-signed copy to InputFile (or InputStream), and call SignAsyncEnd to finalize the signing.

Note that depending on the signing method and DC configuration used, you may still need to provide the public part of the signing certificate via the SigningCertificate property.

Use the ExternalCrypto.AsyncDocumentID property to supply a unique document ID to include in the request. This is helpful when creating batches of multiple async requests, as it allows you to pass the whole response batch to SignAsyncEnd and expect it to recover the correct response from the batch automatically.

AsyncState is a message of the distributed cryptography (DC) protocol. The DC protocol is based on the exchange of async states between a DC client (an application that wants to sign a PDF, XML, or Office document) and a DC server (an application that controls access to the private key). An async state can carry one or more signing requests, comprised of document hashes, or one or more signatures produced over those hashes.

In a typical scenario you get a client-side async state from the SignAsyncBegin method. This state contains document hashes to be signed on the DC server side. You then send the async state to the DC server (often represented by the DCAuth class), which processes it and produces a matching signature state. The async state produced by the server is then passed to the SignAsyncEnd method.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

SignAsyncEnd Method (OfficeQuickSigner Class)

Completes the asynchronous signing operation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SignAsyncEnd(const char* lpszAsyncReply);

Unicode (Windows)
INT SignAsyncEnd(LPCWSTR lpszAsyncReply);

int secureblackbox_officequicksigner_signasyncend(void* lpObj, const char* lpszAsyncReply);

int SignAsyncEnd(const QString& qsAsyncReply);

Remarks

When using the DC framework, call this method upon receiving the response state from the DC processor to complete the asynchronous signing process.

Before calling this method, assign the path to the pre-signed copy of the document obtained from the prior SignAsyncBegin call to InputFile (or InputStream). The method will embed the signature into the pre-signed document, and save the complete signed document to OutputFile (or OutputStream).

Note that depending on the signing method and DC configuration used, you may still need to provide the public part of the signing certificate via the SigningCertificate property.

Use the ExternalCrypto.AsyncDocumentID parameter to pass a specific document ID if using batched AsyncReply. If used, it should match the value provided on the pre-signing (SignAsyncBegin) stage.

AsyncState is a message of the distributed cryptography (DC) protocol. The DC protocol is based on the exchange of async states between a DC client (an application that wants to sign a PDF, XML, or Office document) and a DC server (an application that controls access to the private key). An async state can carry one or more signing requests, comprised of document hashes, or one or more signatures produced over those hashes.

In a typical scenario you get a client-side async state from the SignAsyncBegin method. This state contains document hashes to be signed on the DC server side. You then send the async state to the DC server (often represented by the DCAuth class), which processes it and produces a matching signature state. The async state produced by the server is then passed to the SignAsyncEnd method.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SignExternal Method (OfficeQuickSigner Class)

Signs the document using an external signing facility.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SignExternal();

Unicode (Windows)
INT SignExternal();

int secureblackbox_officequicksigner_signexternal(void* lpObj);

int SignExternal();

Remarks

Call this method to delegate the low-level signing operation to an external, remote, or custom signing engine. This method is useful if the signature has to be made by a device accessible through a custom or non-standard signing interface.

When all preparations are done and hash is computed, the class fires ExternalSign event which allows to pass the hash value for signing.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Error Event (OfficeQuickSigner Class)

Information about errors during signing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(OfficeQuickSignerErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} OfficeQuickSignerErrorEventParams;


Unicode (Windows)
virtual INT FireError(OfficeQuickSignerErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} OfficeQuickSignerErrorEventParams;

#define EID_OFFICEQUICKSIGNER_ERROR 1

virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class OfficeQuickSignerErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(OfficeQuickSignerErrorEventParams *e);

// Or, subclass OfficeQuickSigner and override this emitter function.
virtual int FireError(OfficeQuickSignerErrorEventParams *e) {...}

Remarks

This event is fired in case of exceptional conditions during the office document processing.

ErrorCode contains an error code and Description contains a textual description of the error.

ExternalSign Event (OfficeQuickSigner Class)

Handles remote or external signing initiated by the SignExternal method or other source.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireExternalSign(OfficeQuickSignerExternalSignEventParams *e);

typedef struct {
  const char *OperationId;
  const char *HashAlgorithm;
  const char *Pars;
  const char *Data;
  char *SignedData;
  int reserved;
} OfficeQuickSignerExternalSignEventParams;


Unicode (Windows)
virtual INT FireExternalSign(OfficeQuickSignerExternalSignEventParams *e);

typedef struct {
  LPCWSTR OperationId;
  LPCWSTR HashAlgorithm;
  LPCWSTR Pars;
  LPCWSTR Data;
  LPWSTR SignedData;
  INT reserved;
} OfficeQuickSignerExternalSignEventParams;

#define EID_OFFICEQUICKSIGNER_EXTERNALSIGN 2

virtual INT SECUREBLACKBOX_CALL FireExternalSign(LPSTR &lpszOperationId, LPSTR &lpszHashAlgorithm, LPSTR &lpszPars, LPSTR &lpszData, LPSTR &lpszSignedData);

class OfficeQuickSignerExternalSignEventParams {
public:
  const QString &OperationId();

  const QString &HashAlgorithm();

  const QString &Pars();

  const QString &Data();

  const QString &SignedData();
  void SetSignedData(const QString &qsSignedData);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ExternalSign(OfficeQuickSignerExternalSignEventParams *e);

// Or, subclass OfficeQuickSigner and override this emitter function.
virtual int FireExternalSign(OfficeQuickSignerExternalSignEventParams *e) {...}

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the class via the SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.

The class uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

Notification Event (OfficeQuickSigner Class)

This event notifies the application about an underlying control flow event.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireNotification(OfficeQuickSignerNotificationEventParams *e);

typedef struct {
  const char *EventID;
  const char *EventParam;
  int reserved;
} OfficeQuickSignerNotificationEventParams;


Unicode (Windows)
virtual INT FireNotification(OfficeQuickSignerNotificationEventParams *e);

typedef struct {
  LPCWSTR EventID;
  LPCWSTR EventParam;
  INT reserved;
} OfficeQuickSignerNotificationEventParams;

#define EID_OFFICEQUICKSIGNER_NOTIFICATION 3

virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);

class OfficeQuickSignerNotificationEventParams {
public:
  const QString &EventID();

  const QString &EventParam();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Notification(OfficeQuickSignerNotificationEventParams *e);

// Or, subclass OfficeQuickSigner and override this emitter function.
virtual int FireNotification(OfficeQuickSignerNotificationEventParams *e) {...}

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

This class can fire this event with the following EventID values:

Certificate Type

Encapsulates an individual X.509 certificate.

Syntax

SecureBlackboxCertificate (declared in secureblackbox.h)

Remarks

This type keeps and provides access to X.509 certificate details.

Fields

Constructors

Certificate()

Creates a new object with default field values.

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Syntax

SecureBlackboxExternalCrypto (declared in secureblackbox.h)

Remarks

External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.

Fields

Constructors

ExternalCrypto()

Creates a new ExternalCrypto object with default field values.

SecureBlackboxList Type

Syntax

SecureBlackboxList<T> (declared in secureblackbox.h)

Remarks

SecureBlackboxList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the OfficeQuickSigner class.

int GetCount() {}

int SetCount() {}

T* Get(int index) {}

T* Set(int index, T* value) {}

Config Settings (OfficeQuickSigner Class)

OfficeQuickSigner Config Settings

Base Config Settings

Trappable Errors (OfficeQuickSigner Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

OfficeQuickSigner Errors