Error Handling

Errors are reported in several ways in SecureBlackbox.

Some methods return the error code as a result of method execution. This approach is taken when the returned error can be expected often and the error is not something unusual.

When the extraordinary situation happens, most SecureBlackbox methods throw (raise) an exception. Exception must be handled using try/catch or try/except (depending on the programming language) statement. The exceptions are reported using one of the exception classes listed below. Use those classes to distinguish between different types of errors.

The next approach is to report the error via OnError event of the component. The OnError event is used to report SSL/TLS, SSH and SFTP errors which happen during data transfer. This event can be treated as informational/notification, because the exception usually occurs too after the event is fired.

Exception classes:

Exception class Description ESecureBlackboxError The base class for all exception classes in SecureBlackbox EElArcError currently not used EElCertificateError currently not used EElCertStorageError this exception may be thrown by different certificate storages. For example, if you are trying to remove a non-existing certificate using TElWinCertStorage.Remove method. EElCryptoProviderError reports crypto providers errors EElCryptoKeyError reports errors which occur during processing of crypto keys EElCertNotFoundError currently not used EElCMSError this exception is thrown in case of error by CMS-related components. EElDomainKeysError reports errors occuring during Domain Keys operations EElDuplicateCertError this exception is thrown when application tries to add to storage a certificate, which is already present in the storage. EElFTPSError reports errors occuring during communication with FTPS server EElFTPSUnacceptedReplyError this exception is thrown if an unaccepted reply was received from FTPS server EElHTTPSClientError this exception is thrown in case of error by TElHTTPSClient. EElMessageException this exception is thrown when an error occurs during MIME message processing. EElMessageUserCancelledException this exception is thrown when an operation is cancelled by user during processing of a MIME message. EElMIMEError reports errors which occur during MIME messages operations EElOCSPParseError this exception is thrown when an error occurs during request processing by OCSPServer. EElOIDError this exception is thrown when the string is not a valid OID. EElOperationCancelledError this exception is thrown when an operation was cancelled by user. EElPDFError this exception is thrown in case of eror by different PDF security components. It is a base class for all PDF-related exceptions. EElPDFParseError occurs if an error occured during parsing of PDF documents EElPDFTypeError signals typing errors during PDF file processing EElPEMError this exception signals errors that occur during PEM files processing EElPKCS11Error signals various erorrs which occur during communication with crypto tokens EElPKCS12Error signals errors which occur during reading/writing data in PFX (PKCS12) format EElPKCS7Error signals errors which occur during reading/writing data in PKCS7 (P7B) format EElPKCS8Error signals errors which occur during reading private key data in NET format (based on PKCS8 format) EElPublicKeyAsyncCalculatorError reports errors which occur during asynchronous operations in PKI EElPublicKeyCryptoError reports errors occuring during operations with public keys EElPublicKeyCryptoAsyncError reports errors occuring during asynchronous operations with public keys EElSFTPTimeout currently not used EElSimpleSSHClientException this exception is thrown in case of error by TElSimpleSSHClient. EElSimpleSSLClientException reports errors occured during communication of TElSimpleSSLClient with SSL server EElSocketError reports socket errors EElSSHForwardingException this exception is thrown in case of error by SSH forwarding components in. EElSSLCmdClientException reports errors in commands received by SSL client EElSSLClientConnectionLostError this exception is thrown when a connection to SSL server was lost EElSymmetricCryptoError reports errors occuring during symmetric encryption/decryption EElTarError reports errors occuring during TAR compression/decompression EElUnicodeError signals various problems with unicode and charset handling EElX509Error reports errors occuring X.509 certificates reading/writing EElXMLEncError reports encryption errors which occur during XML documents processing EElXMLError The base class for all XML-related exceptions. Reports errors occuring during XML documents processing EElXMLSecurityError reports errors occuring during signing/verifying of XML electronic signatures EElXMLAdESError reports errors occuring during XML Advanced Electronic Signatures (XAdES) operations EElXMLPathError reports path errors during XML security operations EElXMLTransformError reports errors occuring during XML transforms

Error Codes:

• Authenticode Error Codes
• CRL Error Codes
• Domain Keys DNS Error Codes
• Domain Key Signer Error Codes
• Domain Key Verifier Error Codes
• Message Error Codes
• MS Key Blob Error Codes
• PEM Error Codes
• PKCS12 Error Codes
• PVK Error Codes
• SFTP Error Codes
• S/MIME Error Codes
• S/MIME Message Error Codes
• SPC Error Codes
• SSH Error Codes
• SSH Key Error Codes
• SSH Tunnel Error Codes