OfficeEncryptor Component
Properties Methods Events Config Settings Errors
The OfficeEncryptor component encrypts Office documents.
Syntax
TsbxOfficeEncryptor
Remarks
OfficeEncryptor encrypts Office documents.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
DocumentFormat | Defines the format of the Office document. |
DocumentType | Defines the type of the Office document. |
EncryptionAlgorithm | The encryption algorithm used to encrypt the document. |
EncryptionType | The encryption type used to encrypt the document. |
FIPSMode | Reserved. |
InputBytes | Use this property to pass the input to component in byte array form. |
InputFile | The Office file to be encrypted. |
OutputBytes | Use this property to read the output the component object has produced. |
OutputFile | Defines where to save the encrypted document. |
Password | The password used for decryption. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
DoAction | Performs an additional action. |
Encrypt | Encrypts the whole document. |
Reset | Resets the component settings. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
Error | Information about errors during signing. |
Notification | This event notifies the application about an underlying control flow event. |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
ChecksumAlgorithm | Specifies checksum algorithm that should be used. |
EncryptDocumentProperties | Specifies if document properties should be encrypted. |
HardenedKeyGeneration | Specifies if hardened Key generation should be used. |
HashAlgorithm | Specifies hash algorithm that should be used. |
RC4KeyBits | Specifies the number of key bits used for RC4 algorithm. |
SaltSize | Specifies salt size that should be used. |
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. |
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. |
SpinCount | Specifies spin count that should be used. |
StartKeyGenerationAlgorithm | Specifies start key generation algorithm that should be used. |
TempPath | Path for storing temporary files. |
ASN1UseGlobalTagCache | Controls whether ASN.1 module should use a global object cache. |
AssignSystemSmartCardPins | Specifies whether CSP-level PINs should be assigned to CNG keys. |
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 component. |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
DNSLocalSuffix | The suffix to assign for TLD names. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HardwareCryptoUsePolicy | The hardware crypto usage policy. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
HttpVersion | The HTTP version to use in any inner HTTP client components created. |
IgnoreExpiredMSCTLSigningCert | Whether to tolerate the expired Windows Update signing certificate. |
ListDelimiter | The delimiter character for multi-element lists. |
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. |
OldClientSideRSAFallback | Specifies whether the SSH client should use a SHA1 fallback. |
PKICache | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. |
PKICachePath | Specifies the file system path where cached PKI data is stored. |
ProductVersion | Returns the version of the SecureBlackbox library. |
ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
StaticDNS | Specifies whether static DNS rules should be used. |
StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
StaticIPAddresses | Gets or sets all the static DNS rules. |
Tag | Allows to store any custom data. |
TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
UseCRLObjectCaching | Specifies whether reuse of loaded CRL objects is enabled. |
UseInternalRandom | Switches between SecureBlackbox-own and platform PRNGs. |
UseLegacyAdESValidation | Enables legacy AdES validation mode. |
UseOCSPResponseObjectCaching | Specifies whether reuse of loaded OCSP response objects is enabled. |
UseOwnDNSResolver | Specifies whether the client components should use own DNS resolver. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemNativeSizeCalculation | An internal CryptoAPI access tweak. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |
XMLRDNDescriptorName[OID] | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. |
XMLRDNDescriptorPriority[OID] | Specifies the priority of descriptor names associated with a specific OID. |
XMLRDNDescriptorReverseOrder | Specifies whether to reverse the order of descriptors in RDN. |
XMLRDNDescriptorSeparator | Specifies the separator used between descriptors in RDN. |
DocumentFormat Property (OfficeEncryptor Component)
Defines the format of the Office document.
Syntax
__property TsbxOfficeEncryptorDocumentFormats DocumentFormat = { read=FDocumentFormat };
enum TsbxOfficeEncryptorDocumentFormats { odfUnknown=0, odfBinary=1, odfOpenXML=2, odfOpenXPS=3, odfOpenDocument=4 };
Default Value
odfUnknown
Remarks
This property contains the Office document format.
odfUnknown | 0 | Unknown document format |
odfBinary | 1 | Binary Office document |
odfOpenXML | 2 | OpenXML Office document |
odfOpenXPS | 3 | OpenXPS document |
odfOpenDocument | 4 | OpenOffice document |
This property is read-only and not available at design time.
Data Type
Integer
DocumentType Property (OfficeEncryptor Component)
Defines the type of the Office document.
Syntax
__property String DocumentType = { read=FDocumentType };
Default Value
""
Remarks
This property contains the Office document type.
This property is read-only and not available at design time.
Data Type
String
EncryptionAlgorithm Property (OfficeEncryptor Component)
The encryption algorithm used to encrypt the document.
Syntax
__property String EncryptionAlgorithm = { read=FEncryptionAlgorithm, write=FSetEncryptionAlgorithm };
Default Value
"Default"
Remarks
This property contains the encryption algorithm used to encrypt the Office document.
Supported values:
For Binary Office documents
SB_SYMMETRIC_ALGORITHM_RC4 | RC4 |
For OpenXML Office documents (default = SB_SYMMETRIC_ALGORITHM_AES256)
SB_SYMMETRIC_ALGORITHM_RC2 | RC2 | |
SB_SYMMETRIC_ALGORITHM_RC4 | RC4 | |
SB_SYMMETRIC_ALGORITHM_DES | DES | |
SB_SYMMETRIC_ALGORITHM_3DES | 3DES | |
SB_SYMMETRIC_ALGORITHM_AES128 | AES128 | |
SB_SYMMETRIC_ALGORITHM_AES192 | AES192 | |
SB_SYMMETRIC_ALGORITHM_AES256 | AES256 |
For OpenOffice documents (default = SB_SYMMETRIC_ALGORITHM_BLOWFISH)
SB_SYMMETRIC_ALGORITHM_AES128 | AES128 | |
SB_SYMMETRIC_ALGORITHM_AES192 | AES192 | |
SB_SYMMETRIC_ALGORITHM_AES256 | AES256 | |
SB_SYMMETRIC_ALGORITHM_BLOWFISH | Blowfish |
Data Type
String
EncryptionType Property (OfficeEncryptor Component)
The encryption type used to encrypt the document.
Syntax
__property TsbxOfficeEncryptorEncryptionTypes EncryptionType = { read=FEncryptionType, write=FSetEncryptionType };
enum TsbxOfficeEncryptorEncryptionTypes { oetDefault=0, oetBinaryRC4=1, oetBinaryRC4CryptoAPI=2, oetOpenXMLStandard=3, oetOpenXMLAgile=4, oetOpenDocument=5 };
Default Value
oetDefault
Remarks
This property contains the encryption type used to encrypt the Office document.
Supported values:
oetDefault uses default encryption depending on Office document format.
oetBinaryRC4 uses RC4 encryption for Binary Office documents.
oetBinaryRC4CryptoAPI uses RC4 Crypto API encryption for Binary Office documents.
oetOpenXMLStandard uses standard encryption for OpenXML Office documents.
oetOpenXMLAgile uses agile encryption for OpenXML Office documents.
oetOpenDocument uses standard encryption for OpenOffice documents.
Data Type
Integer
FIPSMode Property (OfficeEncryptor Component)
Reserved.
Syntax
__property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode };
Default Value
false
Remarks
This property is reserved for future use.
Data Type
Boolean
InputBytes Property (OfficeEncryptor Component)
Use this property to pass the input to component in byte array form.
Syntax
__property DynamicArrayInputBytes = { read=FInputBytes, write=FSetInputBytes };
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 (OfficeEncryptor Component)
The Office file to be encrypted.
Syntax
__property String InputFile = { read=FInputFile, write=FSetInputFile };
Default Value
""
Remarks
Provide the path to the Office document to be encrypted.
Data Type
String
OutputBytes Property (OfficeEncryptor Component)
Use this property to read the output the component object has produced.
Syntax
__property DynamicArrayOutputBytes = { read=FOutputBytes };
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 (OfficeEncryptor Component)
Defines where to save the encrypted document.
Syntax
__property String OutputFile = { read=FOutputFile, write=FSetOutputFile };
Default Value
""
Remarks
Specifies the path where the encrypted Office document should be saved.
Data Type
String
Password Property (OfficeEncryptor Component)
The password used for decryption.
Syntax
__property String Password = { read=FPassword, write=FSetPassword };
Default Value
""
Remarks
Use this property to provide the decryption password.
Data Type
String
Config Method (OfficeEncryptor Component)
Sets or retrieves a configuration setting.
Syntax
String __fastcall Config(String ConfigurationString);
Remarks
Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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.
DoAction Method (OfficeEncryptor Component)
Performs an additional action.
Syntax
String __fastcall DoAction(String ActionID, String ActionParams);
Remarks
DoAction is a generic method available in every component. 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;....
Common ActionIDs:
Action | Parameters | Returned value | Description |
ResetTrustedListCache | none | none | Clears the cached list of trusted lists. |
ResetCertificateCache | none | none | Clears the cached certificates. |
ResetCRLCache | none | none | Clears the cached CRLs. |
ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. |
Encrypt Method (OfficeEncryptor Component)
Encrypts the whole document.
Syntax
void __fastcall Encrypt();
Remarks
Call this method to encrypt the document.
Reset Method (OfficeEncryptor Component)
Resets the component settings.
Syntax
void __fastcall Reset();
Remarks
Reset is a generic method available in every component.
Error Event (OfficeEncryptor Component)
Information about errors during signing.
Syntax
typedef struct { int ErrorCode; String Description; } TsbxOfficeEncryptorErrorEventParams; typedef void __fastcall (__closure *TsbxOfficeEncryptorErrorEvent)(System::TObject* Sender, TsbxOfficeEncryptorErrorEventParams *e); __property TsbxOfficeEncryptorErrorEvent OnError = { read=FOnError, write=FOnError };
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.
Notification Event (OfficeEncryptor Component)
This event notifies the application about an underlying control flow event.
Syntax
typedef struct { String EventID; String EventParam; } TsbxOfficeEncryptorNotificationEventParams; typedef void __fastcall (__closure *TsbxOfficeEncryptorNotificationEvent)(System::TObject* Sender, TsbxOfficeEncryptorNotificationEventParams *e); __property TsbxOfficeEncryptorNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification };
Remarks
The component fires this event to let the application know about some event, occurrence, or milestone in the component. 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 component, the exact action it is performing, or the document being processed, one or both may be omitted.
This component can fire this event with the following EventID values:
DocumentLoaded | Reports the completion of Office document processing by the component. Use the event handler to access document-related information. The EventParam value passed with this EventID is empty. |
SignatureLoaded | Reports the completion of signature loading. When this event fires, you can expect the signatures to be fully loaded. The EventParam value passed with this EventID is empty. |
Config Settings (OfficeEncryptor Component)
The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.OfficeEncryptor Config Settings
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
off | No caching (default) | |
local | Local caching | |
global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported values are:
file | File | |
console | Console | |
systemlog | System Log (supported for Android only) | |
debugger | Debugger (supported for VCL for Windows and .Net) |
Supported values are:
time | Current time | |
level | Level | |
package | Package name | |
module | Module name | |
class | Class name | |
method | Method name | |
threadid | Thread Id | |
contenttype | Content type | |
content | Content | |
all | All details |
Supported filter names are:
exclude-package | Exclude a package specified in the value | |
exclude-module | Exclude a module specified in the value | |
exclude-class | Exclude a class specified in the value | |
exclude-method | Exclude a method specified in the value | |
include-package | Include a package specified in the value | |
include-module | Include a module specified in the value | |
include-class | Include a class specified in the value | |
include-method | Include a method specified in the value |
none | No flush (caching only) | |
immediate | Immediate flush (real-time logging) | |
maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
Supported values are:
none | None (by default) | |
fatal | Severe errors that cause premature termination. | |
error | Other runtime errors or unexpected conditions. | |
warning | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | |
info | Interesting runtime events (startup/shutdown). | |
debug | Detailed information on flow of through the system. | |
trace | More detailed information. |
The default value of this setting is 100.
none | No rotation | |
deleteolder | Delete older entries from the cache upon reaching LogMaxEventCount | |
keepolder | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |
Supported Values:
certificate | Enables caching of certificates. |
crl | Enables caching of Certificate Revocation Lists (CRLs). |
ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. |
Example (default value):
PKICache=certificate,crl,ocsp
In this example, the component caches certificates, CRLs, and OCSP responses.
The default value is an empty string - no cached PKI data is stored on disk.
Example:
PKICachePath=C:\Temp\cache
In this example, the cached PKI data is stored in the C:\Temp\cache directory.
Supported values are:
none | No static DNS rules (default) | |
local | Local static DNS rules | |
global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.
Syntax:
Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");
Where:
OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.
PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.
Alias1, Alias2, ...: Optional alternative names recognized during parsing.
Usage Examples:
Map OID 2.5.4.5 to SERIALNUMBER:
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");
Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS:
Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");
Trappable Errors (OfficeEncryptor Component)
OfficeEncryptor Errors
1048577 | Invalid parameter (SB_ERROR_INVALID_PARAMETER) |
1048578 | Invalid configuration (SB_ERROR_INVALID_SETUP) |
1048579 | Invalid state (SB_ERROR_INVALID_STATE) |
1048580 | Invalid value (SB_ERROR_INVALID_VALUE) |
1048581 | Private key not found (SB_ERROR_NO_PRIVATE_KEY) |
1048582 | Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |
1048583 | The file was not found (SB_ERROR_NO_SUCH_FILE) |
1048584 | Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE) |
1048585 | General error (SB_ERROR_GENERAL_ERROR) |
24117249 | The input file does not exist (SB_ERROR_OFFICE_INPUTFILE_NOT_EXISTS) |
24117250 | Unsupported document format (SB_ERROR_OFFICE_UNSUPPORTED_DOCUMENT_FORMAT) |
24117251 | The document cannot be signed (SB_ERROR_OFFICE_DOCUMENT_NOT_SIGNABLE) |
24117253 | The document is already encrypted (SB_ERROR_OFFICE_DOCUMENT_ENCRYPTED) |
24117254 | The document cannot be encrypted (SB_ERROR_OFFICE_DOCUMENT_NOT_ENCRYPTABLE) |
24117255 | The document is not encrypted (SB_ERROR_OFFICE_DOCUMENT_NOT_ENCRYPTED) |
24117256 | Unsupported encryption type (SB_ERROR_OFFICE_DOCUMENT_UNKNOWN_ENCRYPTION) |
24117257 | Invalid password (SB_ERROR_OFFICE_INVALID_PASSWORD) |
24117258 | No signature found to complete the asynchronous signing (SB_ERROR_OFFICE_SIGNATURE_NOT_FOUND) |