OfficeQuickSigner Class
Properties Methods Events Configuration Settings Errors
The OfficeQuickSigner class signs Office documents in a quick-and-easy manner.
Syntax
class secureblackbox.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.
| document_format | Defines the format of the Office document. |
| external_crypto_custom_params | Custom parameters to be passed to the signing service (uninterpreted). |
| external_crypto_data | Additional data to be included in the async state and mirrored back by the requestor. |
| external_crypto_external_hash_calculation | Specifies whether the message hash is to be calculated at the external endpoint. |
| external_crypto_hash_algorithm | Specifies the request's signature hash algorithm. |
| external_crypto_key_id | The ID of the pre-shared key used for DC request authentication. |
| external_crypto_key_secret | The pre-shared key used for DC request authentication. |
| external_crypto_method | Specifies the asynchronous signing method. |
| external_crypto_mode | Specifies the external cryptography mode. |
| external_crypto_public_key_algorithm | Provide public key algorithm here if the certificate is not available on the pre-signing stage. |
| hash_algorithm | Specifies the hash algorithm to be used. |
| input_bytes | Use this property to pass the input to class in the byte array form. |
| input_file | The file to be signed. |
| output_bytes | Use this property to read the output the class object has produced. |
| output_file | Defines where to save the signed document. |
| signature_type | Specifies the type of the signature to be made. |
| sign_core_properties | Whether to sign the core properties of the document. |
| sign_document | Whether to sign the document itself. |
| signing_cert_bytes | Returns raw certificate data in DER format. |
| signing_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| signing_chain_count | The number of records in the SigningChain arrays. |
| signing_chain_bytes | Returns raw certificate data in DER format. |
| signing_chain_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| sign_signature_origin | Whether to sign the signature origin. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| config | Sets or retrieves a configuration setting. |
| extract_async_data | Extracts user data from the DC signing service response. |
| sign | Calculates the signature value. |
| sign_async_begin | Initiates the asynchronous signing operation. |
| sign_async_end | Completes the asynchronous signing operation. |
| sign_external | Signs the document using an external signing facility. |
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.
| on_error | Information about errors during signing. |
| on_external_sign | Handles remote or external signing initiated by the SignExternal method or other source. |
| on_notification | This event notifies the application about an underlying control flow event. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| ExpireTime | Signature expiration time in UTC. |
| SignatureInfoAddress1 | Specifies the location at which the signature was created. |
| SignatureInfoAddress2 | Specifies the location at which the signature was created. |
| SignatureInfoComments | Comments to the signature info text. |
| SignatureInfoDelegateSuggestedSigner | Specifies the name of a person. |
| SignatureInfoDelegateSuggestedSigner2 | Specifies the title of a person. |
| SignatureInfoDelegateSuggestedSignerEmail | Specifies the e-mail address of a person. |
| SignatureInfoImage | Specifies an image for the digital signature. |
| SignatureInfoIncluded | Whether to include the signature info. |
| SignatureInfoInvalidLnImage | Specifies the image of an invalid signature. |
| SignatureInfoSignatureType | Specifies the type of the digital signature. |
| SignatureInfoText | The text to be displayed as the signature info. |
| SignatureInfoValidLnImage | Specifies the image of a valid signature. |
| SignatureLineAdditionalSignatureInfo[Index] | Contains additional signature information. |
| SignatureLineAllowComments[Index] | Indicates if comments are allowed. |
| SignatureLineCount | The number of signature lines. |
| SignatureLineId[Index] | Contains signature unique ID. |
| SignatureLineImageData[Index] | Contains signature image. |
| SignatureLineIndex | Specifies the index of the signature line to sign. |
| SignatureLineShowSignDate[Index] | Indicates if signing date should be shown. |
| SignatureLineSignatureIndex[Index] | The index of the signature that signs signature line. |
| SignatureLineSignatureProviderId[Index] | Contains signature provider ID. |
| SignatureLineSignatureProviderUrl[Index] | Contains signature provider URL. |
| SignatureLineSigned[Index] | Indicates if signature line is signed. |
| SignatureLineSigningInstructions[Index] | Contains signing instructions. |
| SignatureLineSuggestedSigner2[Index] | Suggested signer line two. |
| SignatureLineSuggestedSigner[Index] | Suggested signer line one. |
| SignatureLineSuggestedSignerEmail[Index] | Suggested signer email address. |
| SignTime | Specifies the signing time in UTC. |
| TempPath | Location where the temporary files are stored. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only). |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |